fix: prevent memory leak in _redlock_release of SimpleMemoryBackend #807
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
…eMemoryBackend This commit addresses a memory leak issue in the SimpleMemoryBackend class of our Python cache library. Previously, the _redlock_release method directly removed items from the _cache dictionary using the pop method. However, this approach did not account for the cleanup of associated timer handles in the _handlers dictionary. The fix refactors the _redlock_release method to call the __delete method instead of directly popping the key from the _cache. The __delete method handles both the removal of the cache item and the cancellation of any associated timer handle in the _handlers dictionary. This change ensures that when a cache item is released using the _redlock_release method, all related resources are properly cleaned up, preventing potential memory leaks. This change contributes to the overall stability and efficiency of the cache mechanism by ensuring resources are correctly managed and released.
|
Could we have a test that validates the handler is no longer present after release (and ideally that the callback has been cancelled)? |
Done! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #807 +/- ##
=======================================
Coverage 99.76% 99.76%
=======================================
Files 36 36
Lines 3794 3797 +3
=======================================
+ Hits 3785 3788 +3
Misses 9 9
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Sentry.
|
Dreamsorcerer
pushed a commit
that referenced
this pull request
Jan 22, 2024
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.
What do these changes do?
The changes refactor the
_redlock_releasemethod in theSimpleMemoryBackendclass. Instead of directly removing items from the_cachedictionary using thepopmethod, the method now invokes the__deletemethod. This ensures that when an item is released from the cache, associated timer handles in the_handlersdictionary are also properly cancelled, thereby preventing potential memory leaks.Are there changes in behavior for the user?
There are no direct changes in behavior for the end user. This update enhances the internal memory management of the cache system, contributing to improved stability and efficiency without altering the functional interface.
Related issue number
Checklist