1093: Launch Side Effects atomically so they are always started #1102
Conversation
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
steve-the-edwards
force-pushed
the
sedwards/atomic-side-effects
branch
2 times, most recently
from
38f4e05 to
c1b5d1f
Compare
rjrjr
reviewed
Aug 9, 2023
workflow-runtime/src/commonMain/kotlin/com/squareup/workflow1/internal/WorkflowNode.kt
Outdated
Show resolved
Hide resolved
steve-the-edwards
force-pushed
the
sedwards/atomic-side-effects
branch
2 times, most recently
from
bb695ea to
fd02fec
Compare
Comment on lines
-114
to
-118
| * - The dispatcher is always set to [Unconfined][kotlinx.coroutines.Dispatchers.Unconfined] to | ||
| * minimize overhead for workers that don't care which thread they're executed on (e.g. logging | ||
| * side effects, workers that wrap third-party reactive libraries, etc.). If your work cares | ||
| * which thread it runs on, use [withContext][kotlinx.coroutines.withContext] or | ||
| * [flowOn][kotlinx.coroutines.flow.flowOn] to specify a dispatcher. |
There was a problem hiding this comment.
This was just out-dated. Not true for some time (since GUWT and side effects I think), but we hadn't updated documentation.
workflow-runtime/src/commonTest/kotlin/com/squareup/workflow1/RenderWorkflowInTest.kt
Outdated
Show resolved
Hide resolved
workflow-runtime/src/commonMain/kotlin/com/squareup/workflow1/RenderWorkflow.kt
Outdated
Show resolved
Hide resolved
rjrjr
reviewed
Aug 10, 2023
| @@ -543,35 +485,6 @@ class RenderWorkflowInTest { | |||
| } | |||
| } | |||
|
|
|||
| @Test | |||
| fun `side_effects_from_initial_rendering_in_non_root_workflow_are_never_started_when_initial_render_of_non_root_workflow_fails`() { | |||
There was a problem hiding this comment.
Should we repurpose these tests to confirm that they are run?
steve-the-edwards
force-pushed
the
sedwards/atomic-side-effects
branch
from
fd02fec to
1b1acda
Compare
Solves #1093 Add headlessIntegrationTest to use for the new test case
steve-the-edwards
force-pushed
the
sedwards/atomic-side-effects
branch
from
1b1acda to
9f24c0d
Compare
|
This doesn't work because while the wrapped coroutine will be started, the block declared and passed to UPDATE: that will only happen for nested Workflows - but this is actually a lot of them. I'm going to update the test case to be nested to see if it would fail. |
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.
Add headlessIntegrationTest to renderWorkflowIn with a nice Turbine attached.
Check that we do not use the Unconfined dispatcher within the Workflow runtime as it does not provide ordering guarantees. Coroutines are resumed on whatever thread was last suspended. This means we could start sending actions within a side effect into a unfrozen RenderContext as we cannot guarantee the ordering of handling side effects.
Update documentation and tests to note the need to use a Dispatcher other than Dispatchers.Unconfined.