-
Notifications
You must be signed in to change notification settings - Fork 47
Move AnyAsyncSequenceWorker into WorkflowConcurrency as AsyncSequenceWorker #353
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
Merged
Merged
Changes from all commits
Commits
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
import Foundation | ||
import Workflow | ||
|
||
/// Workers define a unit of asynchronous work. | ||
/// | ||
/// During a render pass, a workflow can ask the context to await the result of a worker. | ||
/// | ||
/// When this occurs, the context checks to see if there is already a running worker of the same type. | ||
/// If there is, and if the workers are 'equivalent', the context leaves the existing worker running. | ||
/// | ||
/// If there is not an existing worker of this type, the context will kick off the new worker (via `run`). | ||
public protocol AsyncSequenceWorker<Output>: AnyWorkflowConvertible where Rendering == Void, Output: Sendable { | ||
/// The type of output events returned by this worker. | ||
associatedtype Sequence: AsyncSequence where Sequence.Element == Output | ||
|
||
// In iOS 18+ we can do: | ||
// func run() -> any AsyncSequence<Output, Never> | ||
|
||
/// Returns an `AsyncSequence` to execute the work represented by this worker. | ||
func run() -> Sequence | ||
|
||
/// Returns `true` if the other worker should be considered equivalent to `self`. Equivalence should take into | ||
/// account whatever data is meaningful to the task. For example, a worker that loads a user account from a server | ||
/// would not be equivalent to another worker with a different user ID. | ||
func isEquivalent(to otherWorker: Self) -> Bool | ||
} | ||
|
||
extension AsyncSequenceWorker { | ||
public func asAnyWorkflow() -> AnyWorkflow<Void, Output> { | ||
AsyncSequenceWorkerWorkflow(worker: self).asAnyWorkflow() | ||
} | ||
} | ||
|
||
struct AsyncSequenceWorkerWorkflow<WorkerType: AsyncSequenceWorker>: Workflow { | ||
let worker: WorkerType | ||
|
||
typealias Output = WorkerType.Output | ||
typealias Rendering = Void | ||
typealias State = UUID | ||
|
||
func makeInitialState() -> State { UUID() } | ||
|
||
func workflowDidChange(from previousWorkflow: AsyncSequenceWorkerWorkflow<WorkerType>, state: inout UUID) { | ||
if !worker.isEquivalent(to: previousWorkflow.worker) { | ||
state = UUID() | ||
} | ||
} | ||
|
||
func render(state: State, context: RenderContext<AsyncSequenceWorkerWorkflow>) -> Rendering { | ||
let sink = context.makeSink(of: AnyWorkflowAction.self) | ||
context.runSideEffect(key: state) { lifetime in | ||
let sequence = worker.run() | ||
let task = Task { @MainActor in | ||
for try await output in sequence { | ||
sink.send(AnyWorkflowAction(sendingOutput: output)) | ||
} | ||
} | ||
|
||
lifetime.onEnded { | ||
task.cancel() | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.
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.