Uh oh!
There was an error while loading. Please reload this page.
Backport #2030: [codex] Guard event consumers during replay - #2042
Merged
Conversation
Contributor
🦋 Changeset detectedLatest commit: ff812fa The changes in this PR will be included in the next version bump. This PR includes changesets to release 20 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests🌍 Community Worlds (69 failed)mongodb-dev (1 failed):
redis-dev (1 failed):
turso-dev (1 failed):
turso (66 failed):
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
✅ 📋 Other
|
Contributor
There was a problem hiding this comment.
Pull request overview
Backports #2030 to stable by adding replay-time “ownership” guards for step, wait, and hook lifecycle events. This helps the runtime detect corrupted/mismatched event logs during replay (so consumers don’t resolve solely by correlationId when guard metadata is present) and fail deterministically.
Changes:
- Extend event schemas to persist optional guard metadata (
stepName, waitresumeAt, hooktoken) on relevant events. - Add replay-time validation in step/sleep/hook consumers to raise
WorkflowRuntimeErroron guard mismatches. - Update runtime emitters to include guard metadata on newly-created events and add focused unit + runtime-entrypoint tests.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/world/src/events.ts | Adds optional guard fields to step/hook/wait event schemas so metadata can be stored and preserved under resolveData: 'none'. |
| packages/core/src/workflow/sleep.ts | Validates wait_completed.eventData.resumeAt against the expected wait during replay. |
| packages/core/src/workflow/sleep.test.ts | Updates existing wait tests and adds coverage for missing/invalid/mismatched resumeAt. |
| packages/core/src/workflow/hook.ts | Validates hook event token ownership during replay. |
| packages/core/src/workflow/hook.test.ts | Updates fixtures to include tokens and adds mismatch coverage for multiple hook event types. |
| packages/core/src/step.ts | Validates step event stepName ownership during replay. |
| packages/core/src/step.test.ts | Adds mismatch coverage for step event stepName. |
| packages/core/src/runtime/suspension-handler.ts | Includes hook disposal token in emitted hook_disposed events. |
| packages/core/src/runtime/step-handler.ts | Includes stepName in emitted step lifecycle events (and refactors queue-derived name extraction). |
| packages/core/src/runtime/runs.ts | Includes resumeAt when emitting wait_completed for wake-up flows (non-legacy). |
| packages/core/src/runtime/runs.test.ts | Updates expectations to include resumeAt on wait_completed. |
| packages/core/src/runtime/resume-hook.ts | Includes hook token in hook_received when not in v1 compatibility mode. |
| packages/core/src/runtime.ts | Includes resumeAt when auto-completing elapsed waits during replay. |
| packages/core/src/runtime.test.ts | Adds runtime-entrypoint coverage for guard mismatches producing run_failed with RUNTIME_ERROR. |
| .changeset/guard-step-consumer-events.md | Adds a changeset for the backported behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+6
| --- | ||
| '@workflow/core': patch | ||
| '@workflow/world': patch | ||
| --- | ||
| Validate step, wait, and hook lifecycle events against replay ownership metadata. |
| } = StepInvokePayloadSchema.parse(message_); | ||
| const { requestId } = metadata; | ||
| const stepNameFromQueue = metadata.queueName.slice('__wkf_step_'.length); | ||
* Guard event consumers during replay * Address event guard review feedback * Update event guard test fixtures
pranaygpforce-pushed
the
backport/pr-2030-to-stable
branch
from
May 20, 2026 20:25
bebbc01 to
ff812faComparepranaygp
enabled auto-merge (squash)
May 20, 2026 22:11
pranaygp
disabled auto-merge
May 20, 2026 22:12
Uh oh!
There was an error while loading. Please reload this page.
Merged
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
Sign up for freeto 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.
Manual backport of #2030 (cherry-pick b124365) to
stable.Conflict resolution notes:
stableruntime/step-handler shape while adding replay guard metadata for step, wait, and hook events.stabledeleted instead of reviving main-only runtime splits.Validation:
pnpm --filter @workflow/errors --filter @workflow/utils --filter @workflow/serde --filter @workflow/world --filter @workflow/world-local --filter @workflow/world-vercel buildpnpm --filter @workflow/core exec vitest run src/workflow/sleep.test.ts src/workflow/hook.test.ts src/step.test.ts src/runtime.test.ts src/runtime/runs.test.tspnpm --filter @workflow/core typecheckpnpm --filter @workflow/core buildpnpm changeset status --since=main-> no changeset neededgit diff --check HEAD~1 HEADNote: local checks were run with Node v25.2.1, which emits the repo engine warning (
^18 || ^20 || ^22 || ^24).