Skip to content

Conversation

@Quinn-With-Two-Ns
Copy link
Contributor

@Quinn-With-Two-Ns Quinn-With-Two-Ns commented Oct 20, 2025

Add summary to side effect and mutable side effect.

closes #2702


Note

Adds options to set a summary on side effects/mutable side effects and plumbs this metadata through APIs and state machines to be recorded on history markers.

  • Workflow API:
    • Add SideEffectOptions and MutableSideEffectOptions with summary.
    • New overloads: Workflow.sideEffect(.., SideEffectOptions) and Workflow.mutableSideEffect(.., MutableSideEffectOptions) (and type-aware variants).
    • Extend WorkflowOutboundCallsInterceptor (+ base) with overloads for side/mutable side effects.
  • Replay/Sync Contexts:
    • ReplayWorkflowContext.sideEffect/mutableSideEffect signatures accept UserMetadata.
    • SyncWorkflowContext builds UserMetadata from options and passes it through.
  • State Machines:
    • SideEffectStateMachine and MutableSideEffectStateMachine attach UserMetadata to record-marker commands.
    • StateMachineCommandUtils.createRecordMarker accepts optional UserMetadata.
  • Misc/Tests:
    • Update WorkflowInternal, tracing interceptor, dummy/testing contexts to support new overloads.
    • Add HistoryUtils.assertEventMetadata; update tests to assert metadata on side effect, mutable side effect, activities, local activities, child workflows, timers, and Nexus operations.

Written by Cursor Bugbot for commit 7eefa37. This will update automatically on new commits. Configure here.

@Quinn-With-Two-Ns Quinn-With-Two-Ns marked this pull request as ready for review October 20, 2025 17:30
@Quinn-With-Two-Ns Quinn-With-Two-Ns requested a review from a team as a code owner October 20, 2025 17:30
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.

Add support for static summary for side effects and mutable side effects

1 participant