Fix a leak in FutureState when a Notifier is dropped un-woken #2233
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
This will allow us to pass in that state to the callbacks in the next commit.
If a `Notifier` has an internal `FutureState` which gathers some sleeper callbacks, but is never actaully woken, those callbacks will leak due to a circular `Arc` reference when the `Notifier` is `drop`'d. Because `Notifier`s are rarely `drop`'d in production this isn't a huge deal, but shows up materially in bindings tests as they spawn many nodes over the course of a short test. Fixes lightningdevkit#2232
Codecov ReportPatch coverage:
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## main #2233 +/- ##
==========================================
- Coverage 91.55% 91.55% -0.01%
==========================================
Files 104 104
Lines 51749 51779 +30
Branches 51749 51779 +30
==========================================
+ Hits 47379 47405 +26
- Misses 4370 4374 +4
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
tnull
approved these changes
Apr 26, 2023
wpaulino
approved these changes
Apr 26, 2023
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.
If a
Notifierhas an internalFutureStatewhich gathers somesleeper callbacks, but is never actaully woken, those callbacks
will leak due to a circular
Arcreference when theNotifierisdrop'd.Because
Notifiers are rarelydrop'd in production this isn't ahuge deal, but shows up materially in bindings tests as they spawn
many nodes over the course of a short test.
Fixes #2232
Note that I'd like to include this in the 115 bindings release just to shut up the leak detection used there, which is quite angry.