Skip to content

[docs] Note that throttled step-result writes don't re-run the step body - #4632

Merged
VaguelySerious merged 2 commits into
mainfrom
workflow-docs-cleanup-mon-5-oct
Oct 5, 2026
Merged

VaguelySerious merged 2 commits into
mainfrom
workflow-docs-cleanup-mon-5-oct

Conversation

@pranaygp

@pranaygp pranaygp commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Description

Docs cleanup for #4496 (merged Friday), which shipped without docs:

  • Throttled step results don't re-run the step — Errors and retries: on Vercel, a 429 on the write that records a step's result now waits until the invocation's deadline instead of giving up after 30s, so the step body isn't re-run and doesn't burn a retry.
  • afterStepBody — Building a World: documents the new advisory CreateEventParams.afterStepBody flag and which writes record a step body that already ran.

Other PRs merged since the last cleanup (#4588) shipped their own docs (#4589, #4594, #4550, #4618) or have no user-facing doc surface (#4333, #4291, #4595, and the stable backports).

Companion PR in vercel/front: vercel/front#89324

Docs Preview

Page v5
Errors and retries Backend connection failures
Building a World Key implementation details

How did you test your changes?

Prose-only MDX edits; no code samples changed.

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 5, 2026 16:05
@pranaygp
pranaygp requested a review from a team as a code owner October 5, 2026 16:05
@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
example-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-express-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-python-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workflow-docs Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workflow-swc-playground Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workflow-tarballs Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC
workflow-web Ready Ready Preview, v0 Oct 5, 2026 10:57pm UTC

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@changeset-bot

changeset-bot Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: ae78169

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟠 world-sim scenario book — 1 fail of 42 total

fence=per-spec

scenario outcome events virt replay violations
✅ smoke-no-steps completed 3 0ms ok 0
✅ smoke-one-step completed 6 0ms ok 0
✅ hook-at-step-started completed 12 0ms ok 0
✅ hook-at-step-completed completed 12 0ms ok 0
✅ hook-at-hook-created completed 12 0ms ok 0
✅ deadline-hook-wins completed 7 1.0h ok 0
✅ deadline-expires completed 7 1.0h ok 0
✅ step-vs-timer-early-settlement completed 8 1.0h ok 0
✅ long-sleep completed 11 30.0d ok 0
✅ hook-never-arrives stalled 3 0ms skipped 0
✅ step-retries-twice completed 10 2.0s ok 0
✅ parallel-steps completed 9 0ms ok 0
✅ hook-on-execution-state completed 12 0ms ok 0
✅ peek-hook-before-branch completed 12 0ms ok 0
✅ peek-hook-after-branch completed 12 0ms ok 0
✅ peek-hook-at-registration completed 12 0ms ok 0
✅ race-hook-before-probe completed 12 0ms ok 0
✅ race-hook-after-probe completed 12 0ms ok 0
✅ race-duplicate-delivery completed 13 0ms ok 0
✅ attr-hook-before-step completed 11 0ms ok 0
✅ attr-hook-after-step completed 11 0ms ok 0
✅ attr-from-step-body completed 13 0ms ok 0
✅ fork-hook-after-timeout completed 14 1.0m ok 0
✅ fork-hook-before-timeout completed 14 1.0m ok 0
✅ count-hook-after-timeout completed 17 1.0m ok 0
✅ count-hook-before-timeout completed 20 1.0m ok 0
✅ stale-read-step-count-fork completed 20 1.0m ok 0
✅ stale-read-equal-step-counts completed 14 1.0m ok 0
✅ step-vs-step-fork completed 12 0ms ok 0
✅ step-vs-step-fork-fenced completed 12 0ms ok 0
✅ fence-catches-benign-direction completed 12 5ms ok 0
✅ in-flight-before-decision completed 17 1.0m ok 0
❌ in-flight-before-decision-counted completed 17 1.0m ok 0
✅ in-flight-after-decision completed 19 2.0m ok 0
✅ stale-read-step-count-fork-fenced completed 20 1.0m ok 0
✅ fork-hook-wins completed 13 1.0m ok 0
✅ fork-timeout-wins completed 13 1.0m ok 0
✅ unclaimed-payload-under-fork completed 17 1.0m ok 0
✅ claimed-payload-under-fork completed 17 1.0m ok 0
✅ writers-independent-step-bodies completed 12 0ms ok 0
✅ writers-scripted-tempo completed 12 0ms ok 0
✅ cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

Signed-off-by: Peter Wielander <mittgfu@gmail.com>
@VaguelySerious
VaguelySerious merged commit fef0728 into main Oct 5, 2026
44 of 61 checks passed
@VaguelySerious
VaguelySerious deleted the workflow-docs-cleanup-mon-5-oct branch October 5, 2026 22:54
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

No backport to stable for fef0728 (AI decision).

This commit documents new capabilities introduced only on main (the afterStepBody advisory flag and the Vercel world's new deadline-based retry behavior from #4496), which is documentation of new features rather than a correction to content already on stable. It also touches only docs/content/worlds/v5/building-a-world.mdx, and git ls-tree origin/stable -- docs/content/worlds/ confirms that path does not exist on stable (which only carries docs/content/docs), so there is nothing to correct there.

To override, re-run the Backport to stable workflow manually via workflow_dispatch and paste this commit SHA into the ref input:

fef0728c556f47fbb95fccd13bc19afd48927a4a

pranaygp added a commit that referenced this pull request Oct 6, 2026
Catches the docs up with SDK changes that landed on Oct 5 without
(complete) docs updates.

| Change | Source PR | Docs edit |
| --- | --- | --- |
| zstd is only written to runs whose deployment's Node.js can decode it
| #4640 | The encryption page said "gzip, with zstd support in the
format". It now states when zstd vs. gzip is used and links
`WORKFLOW_COMPRESSION_CODEC` |
| Aborting a public writable keeps the accepted prefix and doesn't close
the shared stream | #4605 | Added to the existing `releaseLock()` /
`close()` callout in Streaming |
| Released stream writers retire their WebSocket and continue over HTTP
| #4605 | Short paragraph under `WORKFLOW_STREAMS_TRANSPORT` on the
Vercel World page, including the "hold the lock for a burst" tip from
the `world-vercel` README |

I reviewed the other Oct 5 PRs and they need no further docs: NestJS
(#4604) shipped its own docs, the `@vercel/queue` bump (#4648) and
`world-local` hook fix (#4636) aren't user-facing in the docs, and
#4632/#4618 are docs PRs. The Workflows pages in `vercel/front` were
also checked and need no changes for these.

## Docs Preview

| Page | Preview |
| --- | --- |
| Encryption |
[Compression](https://workflow-docs-git-workflow-docs-cleanup-tue-6-oct.vercel.sh/docs/how-it-works/encryption#compression)
|
| Streaming | [Writing to another run's
stream](https://workflow-docs-git-workflow-docs-cleanup-tue-6-oct.vercel.sh/docs/foundations/streaming#writing-to-another-runs-stream)
|
| Vercel World |
[`WORKFLOW_STREAMS_TRANSPORT`](https://workflow-docs-git-workflow-docs-cleanup-tue-6-oct.vercel.sh/worlds/vercel#workflow_streams_transport)
|

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
Preview – workflow-docs — ae781696 Deployed Oct 5, 2026 by vercel[bot]
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.

3 participants