Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Clean up DB sessions consistently #702

Closed
wants to merge 24 commits into from

Conversation

AndreasAlbertQC
Copy link
Collaborator

@AndreasAlbertQC AndreasAlbertQC commented Jul 10, 2024

Context / original problem

In our deployment, we have recently started seeing quetz crashes with the following error message:

sqlalchemy.exc.TimeoutError: QueuePool limit of size 5 overflow 10 reached, connection timed out, timeout 30.00 (Background on this error at: https://sqlalche.me/e/20/3o7r)

This struck me as odd because we configure the pool / overflow sizes manually via the quetz settings / environment variables. The values in the error message neither match our settings nor the quetz default settings, indicating that both sets of settings are ignored.

Diagnosis

I have traced this to the fact that our main entrypoints for connecting to the database (get_engine and get_session) are used inconsistently in the code base. Effectively, it is currently up to the caller to make sure that the right settings are propagated from the configuration to the kwargs for these functions, which often does not happen. Therefore, some connections are configured correctly, some are not.

While looking through the code, I also noticed that we also treat session management inconsistently throughout the code base. Sometimes we protect sessions via a contextmanager that closes the session after use, sometimes we do it manually, sometimes we never close the session.

Proposed solution / changes

  • Bumped sqlalchemy to version 2. In sqlalchemy 2, Session objects offer the context manager protocol and automatically handle cleanup.
  • Refactored all session obtaining code to go through a single function: get_session(config: Config | None) -> Session. By default, if config is not provided, get_session will use the default global Config object. Sessions obtained in this way are guaranteed to respect the config settings. It is now easy to grok if sessions are handled correctly: If you see with get_session(...) as db:, everything is good. If you see get_session used in any other way, it's bad.
  • Added type hints in / near code I touched

@AndreasAlbertQC AndreasAlbertQC added bug Something isn't working dependencies Pull requests that update a dependency file maintenance labels Jul 15, 2024
@ivergara ivergara deleted the 2024-07-10-clean-up-session branch November 6, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dependencies Pull requests that update a dependency file maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant