Memory leak in PreferenceFragmentCompat adapter handling [121006469]

Fixed

Bug

Status Update

No update yet.

Description

js...@gmail.com

created issue #1

Dec 14, 2018 07:54PM

RecyclerView registers an observer (

https://android.googlesource.com/platform/frameworks/support/+/androidx-master-dev/recyclerview/recyclerview/src/main/java/androidx/recyclerview/widget/RecyclerView.java#1201) that is only unregistered manually, by either setting the adapter again, or calling unregisterAdapterDataObserver externally.

PreferenceFragmentCompat sets this adapter (PreferenceGroupAdapter), which implicitly registers an observer. PreferenceFragmentCompat never sets the adapter to null when the view is destroyed, so the observer keeps references to the RecyclerView and doesn't get gc'ed.

I've worked around this by explicitly setting the adapter to null in an override of onDestroyView, but since my component doesn't explicitly have ownership of the list handling, I'd argue that PreferenceFragmentCompat should do this cleanup.

It would be solved by setting the RecyclerView adapter to null in the fragment's onDestroyView.

Here's a memory dump.

2018-12-14_10-38-54_921.hprof

23 MB

Download

Comments

lp...@google.com <lp...@google.com> #2Jan 10, 2019 11:35PM

Project: platform/frameworks/support
Branch: androidx-main

commit b17204359581a71c427d7519a6cfc1825141ed72
Author: Jeremy Woods <jbwoods@google.com>
Date: Fri Mar 17 21:47:24 2023

Prevent crash when adding unmanaged fragment in nav

Currently, if you attempt to add a fragment to the fragment manager
associated with the FragmentNavigator, navigation crashes as it cannot
find an entry associated with fragment.

While it is strongly recommended to only use navigation APIs to
manipulate the fragment manager, if the back stack is not affected, then
we should not crash.

RelNote: "Adding fragments to the `FragmentNavigator`'s
`FragmentManager` without using navigation will no longer crash."
Test: Added FragmentNavigatorTest
Bug: 274167493

Change-Id: I47d4c75ca46ee7f8282b2a7b97d28d71edd9a07b

M navigation/navigation-fragment/src/androidTest/java/androidx/navigation/fragment/FragmentNavigatorTest.kt
M navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.kt

https://android-review.googlesource.com/2496343

lp...@google.com <lp...@google.com> #3Jan 14, 2019 08:41PM

Marked as fixed.

This has been fixed internally and will be in the Navigation 2.6.0-alpha08 release.

ma...@gmail.com <ma...@gmail.com> #4Feb 28, 2020 01:26PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.navigation:navigation-fragment:2.6.0-alpha08

jb...@google.com <jb...@google.com> #5Feb 28, 2020 05:57PM

Since the Fragment 1.2.0-alpha02 release fragments wait until exit animations are complete before onDestroyView() is called so this should not be an issue in any current Fragment versions.

Please file a bug against Fragments the with a sample project that reproduces this issue and we will be happy to take a look at what's going on.

ma...@gmail.com <ma...@gmail.com> #6Feb 29, 2020 09:16PM

I can confirm that using fragment 1.2.2 resolves the issue, thank you!

Without an explicit dependency declaration version 1.1.0 was still used (transient dependency of appcompat 1.1.0).

Issue 121006469