Fix transaction leak when using Session in Scopes #7593
Closed
+66
−2
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.
This PR fixes a transaction leak that occurs when using
SessionwithinScopes. The issue manifests as database connections that are never properly committed or rolled back, leading to connection pool exhaustion.Problem
When using the following pattern:
Transactions would leak because:
Session()setsclone=2for non-NewDB configurationsBeginTransactioncallsInstanceSet("gorm:started_transaction", true)which creates a new cloned instance and stores the transaction flag thereCommitOrRollbackTransactioncallsInstanceGet("gorm:started_transaction")on the original instance, missing the transaction flagRoot Cause
The issue stems from the difference between
InstanceSetandInstanceGetbehavior with cloned instances:InstanceSetcallsgetInstance()which can return a new cloned instance whenclone > 0InstanceGetreads from the current instance directlySolution
Modified the transaction callbacks to use direct
Statement.Settingsaccess instead of theInstanceSet/InstanceGetmethods:BeginTransaction:db.Statement.Settings.Store("gorm:started_transaction", true)CommitOrRollbackTransaction:db.Statement.Settings.Load("gorm:started_transaction")This ensures both callbacks operate on the same Statement instance, preventing the transaction leak.
Testing
Added comprehensive tests that:
Fixes #7592.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.