forked from square/dagger
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clears Fragment reference in FragmentContextWrapper after Fragment#on…
…Destroy() This CL uses the fragment Lifecycle to clear the fragment instance from the FragmentContextWrapper after onDestroy. Fixes: #2070 See #2070 RELNOTES=Fixes #2070: Clears the Fragment reference in FragmentContextWrapper after Fragment#onDestroy() to prevent leaks if a non-Hilt View outlives the Hilt Fragment that created it. PiperOrigin-RevId: 359775904
- Loading branch information
Showing
16 changed files
with
171 additions
and
5 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
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
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
11 changes: 11 additions & 0 deletions
11
javatests/dagger/hilt/android/internal/managers/AndroidManifest.xml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <manifest xmlns:android="http://schemas.android.com/apk/res/android" | ||
| package="dagger.hilt.android.internal.managers"> | ||
|
|
||
| <uses-sdk android:minSdkVersion="14" /> | ||
|
|
||
| <application> | ||
| <activity | ||
| android:name=".FragmentContextWrapperLeakTest$TestActivity" | ||
| android:exported="false"/> | ||
| </application> | ||
| </manifest> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Copyright (C) 2021 The Dagger Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # Description: | ||
| # Tests for internal code for implementing Hilt processors. | ||
|
|
||
| package(default_visibility = ["//:src"]) | ||
|
|
||
| android_local_test( | ||
| name = "FragmentContextWrapperLeakTest", | ||
| size = "small", | ||
| srcs = ["FragmentContextWrapperLeakTest.java"], | ||
| manifest = "AndroidManifest.xml", | ||
| manifest_values = { | ||
| "minSdkVersion": "14", | ||
| }, | ||
| deps = [ | ||
| "//:android_local_test_exports", | ||
| "//:dagger_with_compiler", | ||
| "@google_bazel_common//third_party/java/jsr330_inject", | ||
| "@maven//:junit_junit", | ||
| "@google_bazel_common//third_party/java/truth", | ||
| "//java/dagger/hilt:entry_point", | ||
| "//java/dagger/hilt:install_in", | ||
| "//java/dagger/hilt/android:android_entry_point", | ||
| "//java/dagger/hilt/android/lifecycle", | ||
| "//java/dagger/hilt/android/testing:hilt_android_test", | ||
| ], | ||
| ) |
74 changes: 74 additions & 0 deletions
74
javatests/dagger/hilt/android/internal/managers/FragmentContextWrapperLeakTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Copyright (C) 2021 The Dagger Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package dagger.hilt.android.internal.managers; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.junit.Assert.assertThrows; | ||
|
|
||
| import androidx.lifecycle.Lifecycle; | ||
| import android.os.Build; | ||
| import androidx.fragment.app.Fragment; | ||
| import androidx.fragment.app.FragmentActivity; | ||
| import androidx.test.core.app.ActivityScenario; | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4; | ||
| import dagger.hilt.android.AndroidEntryPoint; | ||
| import dagger.hilt.android.internal.managers.ViewComponentManager.FragmentContextWrapper; | ||
| import dagger.hilt.android.testing.HiltAndroidRule; | ||
| import dagger.hilt.android.testing.HiltAndroidTest; | ||
| import dagger.hilt.android.testing.HiltTestApplication; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.robolectric.annotation.Config; | ||
|
|
||
| @HiltAndroidTest | ||
| @RunWith(AndroidJUnit4.class) | ||
| // Robolectric requires Java9 to run API 29 and above, so use API 28 instead | ||
| @Config(sdk = Build.VERSION_CODES.P, application = HiltTestApplication.class) | ||
| public final class FragmentContextWrapperLeakTest { | ||
| /** An activity to test injection. */ | ||
| @AndroidEntryPoint(FragmentActivity.class) | ||
| public static final class TestActivity extends Hilt_FragmentContextWrapperLeakTest_TestActivity {} | ||
|
|
||
| /** A fragment to test injection. */ | ||
| @AndroidEntryPoint(Fragment.class) | ||
| public static final class TestFragment extends Hilt_FragmentContextWrapperLeakTest_TestFragment {} | ||
|
|
||
| @Rule public HiltAndroidRule hiltRule = new HiltAndroidRule(this); | ||
|
|
||
| @Test | ||
| public void testFragmentContextWrapperDoesNotLeakFragment() { | ||
| try (ActivityScenario<TestActivity> scenario = ActivityScenario.launch(TestActivity.class)) { | ||
| TestFragment fragment = new TestFragment(); | ||
| scenario.onActivity( | ||
| activity -> | ||
| activity | ||
| .getSupportFragmentManager() | ||
| .beginTransaction() | ||
| .add(fragment, "TestFragment") | ||
| .commitNow()); | ||
|
|
||
| FragmentContextWrapper fragmentContextWrapper = | ||
| (FragmentContextWrapper) fragment.getContext(); | ||
| assertThat(fragmentContextWrapper.getFragment()).isEqualTo(fragment); | ||
| scenario.moveToState(Lifecycle.State.DESTROYED); | ||
| NullPointerException exception = | ||
| assertThrows(NullPointerException.class, fragmentContextWrapper::getFragment); | ||
| assertThat(exception).hasMessageThat().contains("The fragment has already been destroyed"); | ||
| } | ||
| } | ||
| } |