[2661] Fix BroadcastReceiver ANR at ScreenOffTrigger #2732
Conversation
| 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
|
|
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
| 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
leakcanary/leakcanary-android-release/src/main/java/leakcanary/ScreenOffTrigger.kt
Outdated
Show resolved
Hide resolved
| * | ||
| * 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
| private var currentJob: HeapAnalysisJob? = null | ||
| private val currentJob = AtomicReference<HeapAnalysisJob?>() | ||
| private val analysisHandler = Handler(Looper.getMainLooper()) | ||
| private var analysisRunnable: Runnable? = null |
There was a problem hiding this comment.
nit: rename this to submitAnalysisToExecutor?
- 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
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