Improve withinSessionLevelLock: invoke callback only on successful lo…#24
Merged
antonkomarev merged 3 commits intoFeb 9, 2026
Merged
Conversation
…ck acquisition - Change withinSessionLevelLock() to invoke callback only when lock is acquired - Return WithinSessionLevelLockHandle with wasAcquired flag and callback result - Callback no longer receives SessionLevelLockHandle argument - Update all tests to check wasAcquired outside callback - Add test verifying callback is not invoked when lock is not acquired BREAKING CHANGE: withinSessionLevelLock() return type changed from mixed to WithinSessionLevelLockHandle
…nLevelLock - Add docblock warning that LockReleaseException guarantees successful callback but loses return value - Update ADR-003 with 'Known limitation' section explaining PHP finally semantics - Suggest WithinSessionLockReleaseException as potential future improvement - Direct users to low-level API for cases where callback result must be preserved
- Test verifies that LockReleaseException is thrown when callback succeeds but release fails - Confirms callback result is lost in this scenario (documented limitation in ADR-003) - Uses PG_TERMINATE_BACKEND to simulate release failure - All 94 tests pass
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
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.
This PR improves the
withinSessionLevelLock()API by invoking the callback only when the lock is successfully acquired, eliminating the need for manualwasAcquiredchecks inside the callback.Before
Key improvements
Callback only on success — The callback is invoked only when the lock is acquired. If the lock is held by another process, the callback is skipped and
wasAcquired = false.Cleaner API — Consumer checks
wasAcquiredoutside the callback, not inside. The callback can focus solely on the critical section logic.New return type — Returns
WithinSessionLevelLockHandlewith:wasAcquired: bool— Whether the lock was acquiredresult: mixed— Result of the callback (null if lock not acquired)Simpler callback signature — Callback no longer receives
SessionLevelLockHandleargument, since it's only invoked when the lock is held.