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 7b17505c2e3679330cf386efe69f1aa95b6ae9e9
Author: Jeremy Woods <jbwoods@google.com>
Date: Thu Jan 06 14:47:42 2022

Update safeArgs to AGP 7.0.4

Updating safeArgs to depend on AGP 7.0.4.

Removing the use of reflection from the plugin since we no longer
needed.

RelNote: "Safe Args now depends on Android Gradle Plugin version 7.0.4.
This means that Navigation Safe Args will no longer be compatible with
Android Studio versions prior to 7.0."
Test: ./gradlew --rerun-tasks navigation:navigation-safe-args-gradle-plugin:test
Bug: 213086135
Bug: 207670704

Change-Id: I41c88ee06ad827c61cb1bbdc5ba58b3d56155caf

M navigation/navigation-safe-args-gradle-plugin/build.gradle
M navigation/navigation-safe-args-gradle-plugin/src/main/kotlin/androidx/navigation/safeargs/gradle/SafeArgsPlugin.kt

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

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

Marked as fixed.

Do you know if I can try this out in a snapshot or has it been published under a version name? (sorry, things in gerrit still confuse me so maybe its already clear that this is fixed and shipped!)

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

Yes, you can follow the snapshot instruction and try this out with build id #8054565.

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

@jb...@google.com comment#4

Is the snapshot I'm trying to use 2.5.0-SNAPSHOT?

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

Yay. I can confirm that your fix worked. Thanks! And you were able to beat out the firebase perf plugin in getting a fix released. Thank you! This unblocks my team!

Heads up what I had to do. add the maven repo to buildscript repos

buildscript {
  repositories {
    google()
    mavenCentral()
    maven("https://androidx.dev/snapshots/builds/8054565/artifacts/repository")
  }
}

then update the plugin to

classpath("androidx.navigation:navigation-safe-args-gradle-plugin:2.5.0-SNAPSHOT")

I don't know whether I should update the rest of my nav deps to 2.5.0 snapshot, but this'll do for now.

Issue 121006469