|
| 1 | +@file:Suppress("DEPRECATION") |
| 2 | +@file:OptIn(ExperimentalCoroutinesApi::class) |
| 3 | + |
| 4 | +package com.squareup.workflow1.testing |
| 5 | + |
| 6 | +import com.squareup.workflow1.Worker |
| 7 | +import com.squareup.workflow1.Workflow |
| 8 | +import com.squareup.workflow1.action |
| 9 | +import com.squareup.workflow1.runningWorker |
| 10 | +import com.squareup.workflow1.stateful |
| 11 | +import kotlinx.coroutines.ExperimentalCoroutinesApi |
| 12 | +import kotlinx.coroutines.TimeoutCancellationException |
| 13 | +import kotlinx.coroutines.delay |
| 14 | +import kotlin.test.Test |
| 15 | +import kotlin.test.assertEquals |
| 16 | +import kotlin.test.assertFailsWith |
| 17 | +import kotlin.test.assertTrue |
| 18 | + |
| 19 | +/** |
| 20 | + * Tests verifying the [DeprecatedLaunchSchedulerMode] migration bridge for the deprecated |
| 21 | + * `launchForTesting*` APIs. |
| 22 | + * |
| 23 | + * These tests lock the semantics of each mode to prevent regressions during phased migration. |
| 24 | + */ |
| 25 | +internal class DeprecatedLaunchSchedulerModeTest { |
| 26 | + |
| 27 | + // -- LEGACY_UNCONFINED mode tests -- |
| 28 | + |
| 29 | + @Test fun `legacy mode - side effects are immediately observable`() { |
| 30 | + var renderCount = 0 |
| 31 | + val workflow = Workflow.stateful<Unit, String, Nothing, () -> Unit>( |
| 32 | + initialState = { "initial" }, |
| 33 | + render = { _, _ -> |
| 34 | + renderCount++ |
| 35 | + eventHandler("update") { |
| 36 | + state = "updated" |
| 37 | + } |
| 38 | + } |
| 39 | + ) |
| 40 | + |
| 41 | + workflow.launchForTestingFromStartWith( |
| 42 | + testParams = WorkflowTestParams( |
| 43 | + checkRenderIdempotence = false, |
| 44 | + deprecatedLaunchSchedulerMode = DeprecatedLaunchSchedulerMode.LEGACY_UNCONFINED |
| 45 | + ) |
| 46 | + ) { |
| 47 | + val onUpdate = awaitNextRendering() |
| 48 | + val countBeforeAction = renderCount |
| 49 | + // Invoke the event handler — with UnconfinedTestDispatcher the action dispatches |
| 50 | + // immediately, so the render count increases synchronously without advanceUntilSettled(). |
| 51 | + onUpdate() |
| 52 | + assertTrue(renderCount > countBeforeAction) |
| 53 | + } |
| 54 | + } |
| 55 | + |
| 56 | + @Test fun `legacy mode - delay worker does not auto-complete`() { |
| 57 | + val workflow = Workflow.stateful<Unit, String, String, Unit>( |
| 58 | + initialState = { "waiting" }, |
| 59 | + render = { _, _ -> |
| 60 | + runningWorker( |
| 61 | + Worker.from { |
| 62 | + delay(5_000) |
| 63 | + "done" |
| 64 | + } |
| 65 | + ) { |
| 66 | + action("workerResult") { setOutput(it) } |
| 67 | + } |
| 68 | + } |
| 69 | + ) |
| 70 | + |
| 71 | + workflow.launchForTestingFromStartWith( |
| 72 | + testParams = WorkflowTestParams( |
| 73 | + deprecatedLaunchSchedulerMode = DeprecatedLaunchSchedulerMode.LEGACY_UNCONFINED |
| 74 | + ) |
| 75 | + ) { |
| 76 | + // The delay-based worker should NOT have completed — virtual time is not auto-advanced. |
| 77 | + assertFailsWith<TimeoutCancellationException> { |
| 78 | + awaitNextOutput(timeoutMs = 100) |
| 79 | + } |
| 80 | + } |
| 81 | + } |
| 82 | + |
| 83 | + // -- VIRTUAL_TIME_STANDARD mode tests -- |
| 84 | + |
| 85 | + @Test fun `virtual time mode - side effects require advanceUntilSettled`() { |
| 86 | + var renderCount = 0 |
| 87 | + val workflow = Workflow.stateful<Unit, String, Nothing, () -> Unit>( |
| 88 | + initialState = { "initial" }, |
| 89 | + render = { _, _ -> |
| 90 | + renderCount++ |
| 91 | + eventHandler("update") { |
| 92 | + state = "updated" |
| 93 | + } |
| 94 | + } |
| 95 | + ) |
| 96 | + |
| 97 | + workflow.launchForTestingFromStartWith( |
| 98 | + testParams = WorkflowTestParams( |
| 99 | + checkRenderIdempotence = false, |
| 100 | + deprecatedLaunchSchedulerMode = DeprecatedLaunchSchedulerMode.VIRTUAL_TIME_STANDARD |
| 101 | + ) |
| 102 | + ) { |
| 103 | + val onUpdate = awaitNextRendering() |
| 104 | + val countBeforeAction = renderCount |
| 105 | + onUpdate() |
| 106 | + // With StandardTestDispatcher, the action is queued but not yet processed. |
| 107 | + assertEquals(countBeforeAction, renderCount) |
| 108 | + // advanceUntilSettled() processes the queued action and triggers a new render. |
| 109 | + advanceUntilSettled() |
| 110 | + assertTrue(renderCount > countBeforeAction) |
| 111 | + assertTrue(hasRendering) |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + @Test fun `virtual time mode - delay worker completes with advance`() { |
| 116 | + val workflow = Workflow.stateful<Unit, String, String, Unit>( |
| 117 | + initialState = { "waiting" }, |
| 118 | + render = { _, _ -> |
| 119 | + runningWorker( |
| 120 | + Worker.from { |
| 121 | + delay(5_000) |
| 122 | + "done" |
| 123 | + } |
| 124 | + ) { |
| 125 | + action("workerResult") { setOutput(it) } |
| 126 | + } |
| 127 | + } |
| 128 | + ) |
| 129 | + |
| 130 | + workflow.launchForTestingFromStartWith( |
| 131 | + testParams = WorkflowTestParams( |
| 132 | + deprecatedLaunchSchedulerMode = DeprecatedLaunchSchedulerMode.VIRTUAL_TIME_STANDARD |
| 133 | + ) |
| 134 | + ) { |
| 135 | + // After advancing (done internally by awaitNextOutput -> advanceUntilSettled), |
| 136 | + // the delay completes and the worker emits output. |
| 137 | + val output = awaitNextOutput() |
| 138 | + assertEquals("done", output) |
| 139 | + } |
| 140 | + } |
| 141 | +} |
0 commit comments