DM-47770: Fix threadsafety of sqlalchemy MetaData access #1132
Conversation
This file contains 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 ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## main #1132 +/- ##
=======================================
Coverage 89.50% 89.50%
=======================================
Files 366 366
Lines 48998 49011 +13
Branches 5943 5941 -2
=======================================
+ Hits 43855 43867 +12
Misses 3729 3729
- Partials 1414 1415 +1 ☔ View full report in Codecov by Sentry. |
dhirving
force-pushed
the
tickets/DM-47770
branch
from
e3b4297 to
56f4854
Compare
dhirving
force-pushed
the
tickets/DM-47770
branch
2 times, most recently
from
0180196 to
4736b46
Compare
Wrap all accesses to sqlalchemy.MetaData with a lock to avoid concurrency issues. sqlalchemy.MetaData is documented to be threadsafe for reads, but not with concurrent modifications. We add tables dynamically at runtime, and the MetaData object is shared by all Database instances sharing the same connection pool. Prior to adding the lock, Butler server database calls that added table definitions dynamically were sometimes failing with InvalidRequestError exceptions complaining about inconsistency of table definitions.
Fix an issue where a test for equality of filenames in the system temp directory were failing. On MacOS, /private/tmp and /tmp refer to the same directory.
dhirving
force-pushed
the
tickets/DM-47770
branch
from
4736b46 to
4c0370c
Compare
andy-slac
approved these changes
Jan 4, 2025
| @@ -164,13 +165,9 @@ def addTable(self, name: str, spec: ddl.TableSpec) -> sqlalchemy.schema.Table: | |||
| to be declared in any order even in the presence of foreign key | |||
| relationships. | |||
| """ | |||
| name = self._db._mangleTableName(name) | |||
There was a problem hiding this comment.
I am confused, do you want DatabaseMetadata to handle table name mangling internally? I do not think it is done consistently now, you call add_table with the original name, but get_table is called with mangled name?
| @@ -1192,7 +1189,7 @@ def getExistingTable(self, name: str, spec: ddl.TableSpec) -> sqlalchemy.schema. | |||
| """ | |||
| assert self._metadata is not None, "Static tables must be declared before dynamic tables." | |||
| name = self._mangleTableName(name) | |||
There was a problem hiding this comment.
Maybe this one needs to be dropped too?
| @@ -1206,10 +1203,7 @@ def getExistingTable(self, name: str, spec: ddl.TableSpec) -> sqlalchemy.schema. | |||
| ) | |||
| if name in inspector.get_table_names(schema=self.namespace): | |||
There was a problem hiding this comment.
Hmm, but this won't work if name is not mangled?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Wrap all accesses to sqlalchemy.MetaData with a lock to avoid concurrency issues.
sqlalchemy.MetaData is documented to be threadsafe for reads, but not with concurrent modifications. We add tables dynamically at runtime, and the MetaData object is shared by all Database instances sharing the same connection pool.
Prior to adding the lock, Butler server database calls that added table definitions dynamically were sometimes failing with InvalidRequestError exceptions complaining about inconsistency of table definitions.
Checklist
doc/changesconfigs/old_dimensions