[2661] Fix BroadcastReceiver ANR at ScreenOffTrigger #2732
+92
−41
Conversation
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
pyricau
reviewed
Dec 19, 2024
| analysisClient.newJob(JobContext(ScreenOffTrigger::class)) | ||
| currentJob = job | ||
| analysisExecutor.execute { | ||
| analysisExecutor.execute { |
There was a problem hiding this comment.
If analysisExecutor.execute runs the task quickly enough, there's a chance that we might dump the heap & freeze the VM before the process has had a chance to report back to system_server, right?
Looks to me like if we want to avoid that, we need to execute with a delay instead"?
There was a problem hiding this comment.
Good point. I just updated it with a delayed executor. So far seems to be working as well and ANR is no longer reproducible internally
Add a delayedScheduledExecutorService
Adding delay Add a delayedScheduledExecutorService Fix BroadcastReceiver ANR
…om/FranAguilera/leakcanary into franjam/fix_broadcast_receiver_anr
Introducing AnalysisJobHandler to share Job execution logic between triggers
|
|
pyricau
reviewed
Jan 15, 2025
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
pyricau
reviewed
Jan 15, 2025
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
pyricau
reviewed
Jan 15, 2025
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
pyricau
reviewed
Jan 15, 2025
| currentJob = null | ||
| analysisCallback(result) | ||
| if(currentJob.compareAndSet(null, job)){ | ||
| delayedScheduledExecutorService.schedule { |
There was a problem hiding this comment.
Couldn't this have been a simple Handler(Looper.getMainLooper()).postDelayed({}, 500) ?
There was a problem hiding this comment.
(you can cancel runnables on handler just fine)
There was a problem hiding this comment.
Good point, simplified to use Handler
pyricau
reviewed
Jan 15, 2025
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
pyricau
reviewed
Jan 16, 2025
| * | ||
| * If not specified, the initial delay is 500 ms | ||
| */ | ||
| private val analysisExecutorDelayMillis: Long = INITIAL_EXECUTOR_DELAY_MILLIS |
There was a problem hiding this comment.
API nit: take in a Duration instead, rename the field to analysisExecutorDelay
pyricau
reviewed
Jan 16, 2025
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
- INITIAL_EXECUTOR_DELAY_IN_MILLI -> INITIAL_EXECUTOR_DELAY_MILLIS - Remove accidental change on viz of analysisExecutor - Rely on Handler.postDelayed instead of DelayedScheduledExecutorService
- Use Duration type for analysisExecutorDelay - Rename to submitAnalysisToExecutor
Adding delay Add a delayedScheduledExecutorService Fix BroadcastReceiver ANR Fix typo PR feedback Add a delayedScheduledExecutorService AnalysisJobHandler Introducing AnalysisJobHandler to share Job execution logic between triggers Reduce scope of changes and go back to original approach of DelayedScheduledExecutorService Revert unwanted changes at docs Update formatting of leak-canary-for-releases.md Revert unwanted indentation Rename shouldStartAnalysis to shouldScheduleAnalysis Rename cancelScheduledAction to cancelScheduledAnalysis
FranAguilera
force-pushed
the
franjam/fix_broadcast_receiver_anr
branch
from
2668668 to
d55327c
Compare
…om/FranAguilera/leakcanary into franjam/fix_broadcast_receiver_anr
FranAguilera
force-pushed
the
franjam/fix_broadcast_receiver_anr
branch
6 times, most recently
from
385e110 to
ac0e425
Compare
FranAguilera
force-pushed
the
franjam/fix_broadcast_receiver_anr
branch
from
c2d8541 to
6146c35
Compare
FranAguilera
force-pushed
the
franjam/fix_broadcast_receiver_anr
branch
5 times, most recently
from
a9147ce to
ba4b3f6
Compare
FranAguilera
force-pushed
the
franjam/fix_broadcast_receiver_anr
branch
from
ba4b3f6 to
51e25f9
Compare
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.
Resolves #2661
Issue
BroadcastReceiver#onReceive runs by default on the main thread. If onReceive doesn't complete in a timely manner, the system will report an Application Not Responding
We've seen instances of this occurring frequently on internal builds
Solution
NOTE: Kudos to @pyricau for the guidance on adding a delay.
Let the broadcast receiver complete immediately and schedule the executor with an initial delay to avoid issues with the broadcast receiver not completing
Verification
Verified that the the ANR no longer occurs and reporting still completes without issues on one of our main apps (internal release build)
This was heavily tested on internal builds