View.backPressHandler memory leak fix.
#894
Merged
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
We now strictly require that a `ViewTreeLifecycleOwner` can be found so that we can be certain of getting a callback to remove the `OnBackPressedCallback` from the `OnBackPressedDispatcher`. We also null out the guts of the callback while the `View` is detached, to be doubly sure not to leak anything even if the `ViewTreeLifecycleOwner` is misbehaving. Fixes #889.
rjrjr
force-pushed
the
ray/leaky-backhandler
branch
from
90d4cd3 to
f56b3ce
Compare
rjrjr
force-pushed
the
ray/leaky-backhandler
branch
3 times, most recently
from
ef8d100 to
b8ac7ba
Compare
rjrjr
commented
Oct 28, 2022
...low-ui/core-android/src/androidTest/java/com/squareup/workflow1/ui/BackPressedHandlerTest.kt
Show resolved
Hide resolved
rjrjr
force-pushed
the
ray/leaky-backhandler
branch
from
b8ac7ba to
16de577
Compare
pyricau
approved these changes
Oct 31, 2022
helios175
reviewed
Oct 31, 2022
| } | ||
|
|
||
| public ArrayDeque<OnBackPressedCallback> callbacks() { | ||
| return dispatcher.mOnBackPressedCallbacks; |
Collaborator
Author
There was a problem hiding this comment.
I'm exposing the implementation of an Android class for testing purposes, I don't think there's a real need to abstract it.
helios175
reviewed
Oct 31, 2022
Comment on lines
+106
to
+109
| lifecycleOrNull?.let { lifecycle -> | ||
| lifecycle.removeObserver(this) | ||
| lifecycleOrNull = null | ||
| } |
There was a problem hiding this comment.
nit:
lifecycleOrNull?.removeObserver(this)
lifecycleOrNull = null
There was a problem hiding this comment.
In fact you can do
lifecycleOrNull?.removeObserver(this)
lifecycleOrNull = ViewTreeLifecycleOwner.get(view)?.lifecycle
helios175
reviewed
Oct 31, 2022
Comment on lines
-115
to
-117
| /** | ||
| * Weak reference ensures that we don't leak the view. | ||
| */ |
helios175
approved these changes
Oct 31, 2022
helios175
left a comment
helios175
left a comment
There was a problem hiding this comment.
Not exactly sure how this fixes any leak, but looks correct.
Collaborator
Author
The old code would register with |
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.
We now strictly require that a
ViewTreeLifecycleOwnercan be found so that we can be certain of getting a callback to remove theOnBackPressedCallbackfrom theOnBackPressedDispatcher. We also null out the guts of the callback while theViewis detached, to be doubly sure not to leak anything even if theViewTreeLifecycleOwneris misbehaving.Fixes #889.