Pass the workflow's scope into initialState. #286
Conversation
zach-klippenstein
force-pushed
the
zachklipp/initialstate-scope
branch
from
3681e12
to
d12edba
Compare
zach-klippenstein
force-pushed
the
zachklipp/initialstate-scope
branch
from
d12edba
to
1d57b5d
Compare
| */ | ||
| abstract fun initialState( | ||
| input: InputT, | ||
| snapshot: Snapshot? | ||
| snapshot: Snapshot?, | ||
| scope: CoroutineScope |
There was a problem hiding this comment.
@davidapgar @bencochran @timdonnelly Seems like we should be able to come up with a similar object to pass into the analogous method in Swift — basically something that can accept tearDown duties instead of the method on WorkflowContext.
There was a problem hiding this comment.
I'm not suggesting this is a good direction, but if Swift wanted to match this as accurately as possible, it would be a teardown hook plus a scheduler. Having access to a coroutine scope is useful for us, but given the lack of similar concepts in Swift I'm not sure this would be the best API for them. But curious to hear what yall think!
| @@ -71,10 +73,15 @@ abstract class StatefulWorkflow< | |||
| * If the workflow is being restored from a [Snapshot], [snapshot] will be the last value | |||
| * returned from [snapshotState], and implementations that return something other than | |||
| * [Snapshot.EMPTY] should create their initial state by parsing their snapshot. | |||
| * @param scope | |||
| * The [CoroutineScope] in which this workflow lives. The scope will be cancelled when the | |||
There was a problem hiding this comment.
Can we provide an example of how to use it?
There was a problem hiding this comment.
I'm not sure what kind of example would be useful. It's basically only there to support Workers (which users don't need to care about unless they want to look at source directly), or cancellation of some external resource, and I don't even know yet what the best way will be to use this scope to cancel those. I'll file an issue to track improving this doc as we go forward: #290.
Closes #288.