Skip to content

Fix memory leak when prompt isn't explicitly dismissed #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sjwall merged 2 commits into from
May 5, 2018
Merged

Fix memory leak when prompt isn't explicitly dismissed #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c311d41
Fix memory leak when prompt isn't explicitly dismissed
SUPERCILEX Apr 28, 2018
28f5668
Merge remote-tracking branch 'upstream/master' into leak
SUPERCILEX Apr 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions library/src/main/java/uk/co/samuelwall/materialtaptargetprompt/MaterialTapTargetPrompt.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ public void run()
{
final ResourceFinder resourceFinder = promptOptions.getResourceFinder();
mView = new PromptView(resourceFinder.getContext());
mView.mPrompt = this;
Copy link
Copy Markdown
Owner

@sjwall sjwall May 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this reference be set to null in cleanUpPrompt?

Copy link
Copy Markdown
Contributor Author

@SUPERCILEX SUPERCILEX May 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can, but it isn't necessary. The issue is the prompt holding on to the view, not the other way around.

mView.mPromptOptions = promptOptions;
mView.mPromptTouchedListener = new PromptView.PromptTouchedListener()
{
Expand Down Expand Up @@ -749,6 +750,7 @@ static class PromptView extends View
PromptTouchedListener mPromptTouchedListener;
Rect mClipBounds = new Rect();
View mTargetRenderView;
MaterialTapTargetPrompt mPrompt;
PromptOptions mPromptOptions;
boolean mClipToBounds;

Expand Down Expand Up @@ -887,6 +889,13 @@ else if (event.getAction() == KeyEvent.ACTION_UP
return super.dispatchKeyEventPreIme(event);
}

@Override
protected void onDetachedFromWindow()
{
super.onDetachedFromWindow();
mPrompt.cleanUpAnimation();
Copy link
Copy Markdown
Owner

@sjwall sjwall May 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason that this isn't a call to cleanUpPrompt?

Copy link
Copy Markdown
Contributor Author

@SUPERCILEX SUPERCILEX May 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cleanUpPrompt also notifies state changes which seems like we'd be introducing a race condition... I just realized I didn't share the leak with you, it's just the animator stuff which is leaking:

In com.supercilex.robotscouter.debug:2.3.1-DEBUG:1.
* com.supercilex.robotscouter.HomeActivity has leaked:
* GC ROOT android.widget.Toast$TN.mNextView
* references android.widget.LinearLayout.mParent
* references android.view.ViewRootImpl.mChoreographer
* references android.view.Choreographer.mCallbackQueues
* references array android.view.Choreographer$CallbackQueue[].[1]
* references android.view.Choreographer$CallbackQueue.mHead
* references android.view.Choreographer$CallbackRecord.action
* references android.animation.AnimationHandler$1.this$0 (anonymous implementation of android.view.Choreographer$FrameCallback)
* references android.animation.AnimationHandler.mAnimationCallbacks
* references java.util.ArrayList.elementData
* references array java.lang.Object[].[0]
* references android.animation.ValueAnimator.mUpdateListeners
* references java.util.ArrayList.elementData
* references array java.lang.Object[].[0]
* references uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt$10.this$0 (anonymous implementation of android.animation.ValueAnimator$AnimatorUpdateListener)
* references uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt.mView
* references uk.co.samuelwall.materialtaptargetprompt.MaterialTapTargetPrompt$PromptView.mContext
* leaks com.supercilex.robotscouter.HomeActivity instance

* Retaining: 6.5 kB.
* Reference Key: 8200773e-a087-4f54-8dd7-9fe208a43681
* Device: Google google Pixel 2 XL taimen
* Android Version: 8.1.0 API: 27 LeakCanary: 1.5.4 74837f0
* Durations: watch=5315ms, gc=172ms, heap dump=1438ms, analysis=154338ms

}

/**
* Interface definition for a callback to be invoked when a {@link PromptView} is touched.
*/
Expand Down
5 changes: 4 additions & 1 deletion sample/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ dependencies {

implementation 'com.android.support:design:' + rootProject.supportLibVersion
implementation 'com.android.support:cardview-v7:' + rootProject.supportLibVersion

implementation 'com.android.support.constraint:constraint-layout:1.1.0'

debugImplementation 'com.squareup.leakcanary:leakcanary-android:1.5.4'
releaseImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:1.5.4'

testImplementation 'junit:junit:4.12'
}
1 change: 1 addition & 0 deletions sample/src/main/AndroidManifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package="uk.co.samuelwall.materialtaptargetprompt.sample">

<application
android:name=".Mttp"
android:label="@string/app_name"
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
Expand Down
34 changes: 34 additions & 0 deletions sample/src/main/java/uk/co/samuelwall/materialtaptargetprompt/sample/Mttp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright (C) 2016-2018 Samuel Wall
*
* 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 uk.co.samuelwall.materialtaptargetprompt.sample;

import android.app.Application;

import com.squareup.leakcanary.LeakCanary;

public class Mttp extends Application
{
@Override
public void onCreate()
{
super.onCreate();
if (!LeakCanary.isInAnalyzerProcess(this))
{
LeakCanary.install(this);
}
}
}