Skip to content

Eager Workflow Start #1757

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Eager Workflow Start #1757

wants to merge 4 commits into from

Conversation

THardy98
Copy link
Contributor

@THardy98 THardy98 commented Aug 8, 2025

What was changed

The main change to accommodate eager workflow start was adding startWithDetails to WorkflowClientInterceptor to support a (new) return type of WorkflowStartOutput. This allows us to return an object, giving us the ability to add new fields without issue - we add eagerlyStarted in this PR. This new interceptor method is injected if not defined at the internal _start call, and adapts the existing start interceptor method to use startWithDetails. We also define a new handle called WorkflowHandleWithStartDetails which extends the existing WorkflowHandleWithFirstExecutionRunId, which now includes whether the workflow was started eagerly or not. Adding fields to the handle is an adopted pattern in the TS SDK.

Why?

Support eager workflow start.

  1. Closes [Feature Request] Eager Workflow Start #1348

  2. How was this tested:
    Existing integration tests and 2 new integration tests.

  3. Any docs updates needed?
    Probably

- add startWithDetails to WorkflowClientInterceptor to support return type of WorkflowStartOutput, inject if not defined at _start call
@THardy98 THardy98 requested a review from a team as a code owner August 8, 2025 21:13
@THardy98 THardy98 force-pushed the eager_workflow_start branch from 24a1314 to 9d137ac Compare August 11, 2025 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Eager Workflow Start
1 participant