Repository navigation
fix(watcher): guard AlarmReceiver finish() with FinishOnce #362
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.
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
Open
TimeToBuildBob
wants to merge
2
commits into
ActivityWatch:master
Choose a base branch
from
TimeToBuildBob:fix/alarm-receiver-finish-once
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
102 changes: 102 additions & 0 deletions
102
mobile/src/test/java/net/activitywatch/android/watcher/AlarmReceiverFinishOnceTest.kt
This file contains hidden or 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,102 @@ | ||
| package net.activitywatch.android.watcher | ||
|
|
||
| import java.util.concurrent.CopyOnWriteArrayList | ||
| import java.util.concurrent.atomic.AtomicInteger | ||
| import kotlinx.coroutines.CoroutineExceptionHandler | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.SupervisorJob | ||
| import kotlinx.coroutines.launch | ||
| import kotlinx.coroutines.runBlocking | ||
| import net.activitywatch.android.widget.AsyncBroadcast | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Assert.assertTrue | ||
| import org.junit.Test | ||
|
|
||
| /** | ||
| * Regression tests for the AlarmReceiver goAsync + finish pattern after applying FinishOnce. | ||
| * | ||
| * Without FinishOnce, an OEM pre-finishing the broadcast before the coroutine's `finally` block | ||
| * causes `PendingResult.finish()` → `IllegalStateException("Broadcast already finished")`, which | ||
| * escapes the coroutine and kills the process. This is the same crash class fixed for the widget | ||
| * in ActivityWatch/aw-android#360. | ||
| */ | ||
| class AlarmReceiverFinishOnceTest { | ||
|
|
||
| private val uncaught = CopyOnWriteArrayList<Throwable>() | ||
| private val logged = CopyOnWriteArrayList<String>() | ||
| private val log: (String, Throwable?) -> Unit = { msg, _ -> logged.add(msg) } | ||
|
|
||
| private fun scope() = CoroutineScope( | ||
| SupervisorJob() + Dispatchers.IO + CoroutineExceptionHandler { _, e -> uncaught.add(e) } | ||
| ) | ||
|
|
||
| /** | ||
| * OEM pre-finishes the broadcast before the coroutine's finally block; without FinishOnce | ||
| * this would throw IllegalStateException and escape the coroutine. | ||
| */ | ||
| @Test | ||
| fun oemDoubleFinish_doesNotEscapeCoroutine() = runBlocking { | ||
| val finishCalls = AtomicInteger() | ||
| val finish = AsyncBroadcast.FinishOnce( | ||
| finish = { | ||
| finishCalls.incrementAndGet() | ||
| throw IllegalStateException("Broadcast already finished") | ||
| }, | ||
| log = log, | ||
| ) | ||
|
|
||
| val job = scope().launch { | ||
| try { | ||
| // heartbeat work (no-op in test) | ||
| } catch (e: Exception) { | ||
| // logged in production | ||
| } finally { | ||
| finish.finish() | ||
| } | ||
|
TimeToBuildBob marked this conversation as resolved.
Outdated
|
||
| } | ||
| job.join() | ||
|
|
||
| assertEquals("finish() must be attempted exactly once", 1, finishCalls.get()) | ||
| assertTrue("IllegalStateException escaped the coroutine: $uncaught", uncaught.isEmpty()) | ||
| assertTrue("missing 'already finished' log entry", logged.any { it.contains("already finished") }) | ||
| } | ||
|
|
||
| @Test | ||
| fun normalHeartbeat_finishesExactlyOnce() = runBlocking { | ||
| val finishCalls = AtomicInteger() | ||
| val finish = AsyncBroadcast.FinishOnce({ finishCalls.incrementAndGet() }, log) | ||
|
|
||
| val job = scope().launch { | ||
| try { | ||
| // heartbeat work succeeds | ||
| } finally { | ||
| finish.finish() | ||
| } | ||
| } | ||
| job.join() | ||
|
|
||
| assertEquals(1, finishCalls.get()) | ||
| assertTrue(uncaught.isEmpty()) | ||
| } | ||
|
|
||
| @Test | ||
| fun heartbeatException_stillFinishes() = runBlocking { | ||
| val finishCalls = AtomicInteger() | ||
| val finish = AsyncBroadcast.FinishOnce({ finishCalls.incrementAndGet() }, log) | ||
|
|
||
| val job = scope().launch { | ||
| try { | ||
| throw RuntimeException("server unreachable") | ||
| } catch (e: Exception) { | ||
| // logged | ||
| } finally { | ||
| finish.finish() | ||
| } | ||
| } | ||
| job.join() | ||
|
|
||
| assertEquals(1, finishCalls.get()) | ||
| assertTrue(uncaught.isEmpty()) | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.