🎨Ensure all DB clients have a sensible name #8220
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #8220 +/- ##
==========================================
- Coverage 88.08% 88.02% -0.07%
==========================================
Files 1910 1522 -388
Lines 73492 61803 -11689
Branches 1301 688 -613
==========================================
- Hits 64734 54399 -10335
+ Misses 8371 7162 -1209
+ Partials 387 242 -145
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
sanderegg
added
a:webserver
sanderegg
requested review from
GitHK,
matusdrobuliak66 and
pcrespov
as code owners
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes database client naming conventions across all microservices by ensuring that every DB connection includes a descriptive application name and database driver suffix. The naming convention follows the pattern APP_NAME-HOST_NAME-TASK_SLOT-TYPE, which improves observability by making database connections easily identifiable in admin tools like Adminer.
Key changes include:
- Updating all database connection methods to accept and use
application_nameparameter - Modifying
PostgresSettingsto generate client names with configurable suffixes - Ensuring backward compatibility while making application names mandatory for new connections
Reviewed Changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
packages/settings-library/src/settings_library/postgres.py |
Enhanced PostgresSettings with new methods for generating client names with suffixes |
packages/service-library/src/servicelib/db_asyncpg_utils.py |
Updated async engine creation functions to require and use application names |
packages/service-library/src/servicelib/fastapi/db_asyncpg_engine.py |
Modified FastAPI DB connection to pass application names through |
packages/simcore-sdk/src/simcore_sdk/node_ports_common/dbmanager.py |
Updated DBManager and DBContextManager to require application names |
services/*/src/*/modules/db/*.py |
Updated all service DB modules to provide APP_NAME when connecting |
services/*/src/*/*.py |
Various service files updated to pass application names to DB connections |
Comments suppressed due to low confidence (1)
services/director-v2/tests/integration/02/test_dynamic_sidecar_nodeports_integration.py:36
- The removal of the unused import
ProjectIDStris good, but this change appears unrelated to the main purpose of this PR which is about database client naming.
ProjectID,
GitHK
reviewed
Aug 15, 2025
...dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/user_services_preferences/_db.py
Outdated
Show resolved
Hide resolved
...dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/user_services_preferences/_db.py
Outdated
Show resolved
Hide resolved
services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/database.py
Outdated
Show resolved
Hide resolved
Contributor
🧪 CI InsightsHere's what we observed from your CI run for 12a8d97. ✅ Passed Jobs With Interesting Signals
|
bisgaard-itis
approved these changes
Aug 15, 2025
Contributor
bisgaard-itis
left a comment
bisgaard-itis
left a comment
There was a problem hiding this comment.
Thanks. I suggest to use a symbol different from - to separate the different components of the name because it seems we already use - within our names a lot.
matusdrobuliak66
approved these changes
Aug 15, 2025
sanderegg
force-pushed
the
db/ensure-app-name
branch
from
2588e4e to
88c8e65
Compare
GitHK
approved these changes
Aug 15, 2025
Contributor
GitHK
left a comment
GitHK
left a comment
There was a problem hiding this comment.
Thanks, just a minor thing
...ic-sidecar/src/simcore_service_dynamic_sidecar/modules/user_services_preferences/_manager.py
Outdated
Show resolved
Hide resolved
...ic-sidecar/src/simcore_service_dynamic_sidecar/modules/user_services_preferences/_manager.py
Outdated
Show resolved
Hide resolved
sanderegg
force-pushed
the
db/ensure-app-name
branch
from
4014201 to
12a8d97
Compare
|
GitHK
pushed a commit
to GitHK/osparc-simcore-forked
that referenced
this pull request
Aug 18, 2025
17 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
This PR ensures that all DB clients are registering themselves with the application name, and a suffix as to which library is used to connect (e.g. aiopg or asyncpg). These client names are visible in the process list in adminer for example.
Typical connection is
APP_NAME-HOST_NAME-TASK_SLOT-TYPERelated issue/s
How to test
Dev-ops