Skip to content

Remove obsolete world factory aliases#3112

Draft
NathanColosimo wants to merge 1 commit into
mainfrom
codex/remove-obsolete-aliases
Draft

Remove obsolete world factory aliases#3112
NathanColosimo wants to merge 1 commit into
mainfrom
codex/remove-obsolete-aliases

Conversation

@NathanColosimo

Copy link
Copy Markdown
Contributor

What

  • remove createLocalWorld from @workflow/world-local
  • remove createVercelWorld from @workflow/world-vercel
  • remove core runtime fallback support for those factory names
  • require custom world modules to export createWorld or a default factory

Why

The aliases were deprecated after world factories standardized on createWorld, have no production callers in the repository, and keep compatibility branches in the runtime loader.

Impact

Breaking API cleanup with major changesets for @workflow/core, @workflow/world-local, and @workflow/world-vercel. Consumers should rename imports/calls to createWorld.

The v4 docs intentionally retain the v4 API names; v5 docs already use createWorld.

Verification

  • dependency-aware builds for core/local/vercel world packages
  • typechecks for all three affected packages
  • core world-loader tests (2 passed)
  • local world tag tests (18 passed)
  • Vercel world tests (296 passed)
  • focused Biome checks and git diff --check

@vercel

vercel Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
example-nextjs-workflow-turbopack Ready Ready Preview, Comment Jul 25, 2026 12:43am
example-nextjs-workflow-webpack Ready Ready Preview, Comment Jul 25, 2026 12:43am
example-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-astro-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-express-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-fastify-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-hono-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-nestjs-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-nitro-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-nuxt-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-sveltekit-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-tanstack-start-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workbench-vite-workflow Ready Ready Preview, Comment Jul 25, 2026 12:43am
workflow-docs Ready Ready Preview, Comment, Open in v0 Jul 25, 2026 12:43am
workflow-swc-playground Ready Ready Preview, Comment Jul 25, 2026 12:43am
workflow-tarballs Ready Ready Preview, Comment Jul 25, 2026 12:43am
workflow-web Ready Ready Preview, Comment Jul 25, 2026 12:43am

@changeset-bot

changeset-bot Bot commented Jul 25, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1e3d2af

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

This PR includes changesets to release 19 packages
Name Type
@workflow/core Major
@workflow/world-local Major
@workflow/world-vercel Major
@workflow/builders Patch
@workflow/cli Patch
@workflow/next Patch
@workflow/nitro Patch
@workflow/vitest Patch
@workflow/web-shared Patch
@workflow/web Patch
workflow Major
@workflow/world-testing Patch
@workflow/world-postgres Patch
@workflow/astro Patch
@workflow/nest Patch
@workflow/nuxt Patch
@workflow/rollup Patch
@workflow/sveltekit Patch
@workflow/vite Patch

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 Jul 25, 2026

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

All tests passed

E2E Test Summary

Summary
Passed Failed Skipped Total
✅ ▲ Vercel Production 1455 0 239 1694
✅ 💻 Local Development 1621 0 227 1848
✅ 📦 Local Production 1621 0 227 1848
✅ 🐘 Local Postgres 1621 0 227 1848
✅ 🪟 Windows 154 0 0 154
✅ 📋 Other 1020 0 212 1232
✅ vercel-multi-region 27 0 0 27
Total 7519 0 1132 8651
Details by Category

✅ ▲ Vercel Production

App Passed Failed Skipped
✅ astro 126 0 28
✅ example 126 0 28
✅ express 126 0 28
✅ fastify 126 0 28
✅ hono 126 0 28
✅ nextjs-turbopack 151 0 3
✅ nextjs-webpack 151 0 3
✅ nitro 126 0 28
✅ nuxt 126 0 28
✅ sveltekit 145 0 9
✅ vite 126 0 28

✅ 💻 Local Development

App Passed Failed Skipped
✅ astro-stable 128 0 26
✅ express-stable 128 0 26
✅ fastify-stable 128 0 26
✅ hono-stable 128 0 26
✅ nextjs-turbopack-canary 135 0 19
✅ nextjs-turbopack-stable 154 0 0
✅ nextjs-webpack-canary 135 0 19
✅ nextjs-webpack-stable 154 0 0
✅ nitro-stable 128 0 26
✅ nuxt-stable 128 0 26
✅ sveltekit-stable 147 0 7
✅ vite-stable 128 0 26

✅ 📦 Local Production

App Passed Failed Skipped
✅ astro-stable 128 0 26
✅ express-stable 128 0 26
✅ fastify-stable 128 0 26
✅ hono-stable 128 0 26
✅ nextjs-turbopack-canary 135 0 19
✅ nextjs-turbopack-stable 154 0 0
✅ nextjs-webpack-canary 135 0 19
✅ nextjs-webpack-stable 154 0 0
✅ nitro-stable 128 0 26
✅ nuxt-stable 128 0 26
✅ sveltekit-stable 147 0 7
✅ vite-stable 128 0 26

✅ 🐘 Local Postgres

App Passed Failed Skipped
✅ astro-stable 128 0 26
✅ express-stable 128 0 26
✅ fastify-stable 128 0 26
✅ hono-stable 128 0 26
✅ nextjs-turbopack-canary 135 0 19
✅ nextjs-turbopack-stable 154 0 0
✅ nextjs-webpack-canary 135 0 19
✅ nextjs-webpack-stable 154 0 0
✅ nitro-stable 128 0 26
✅ nuxt-stable 128 0 26
✅ sveltekit-stable 147 0 7
✅ vite-stable 128 0 26

✅ 🪟 Windows

App Passed Failed Skipped
✅ nextjs-turbopack 154 0 0

✅ 📋 Other

App Passed Failed Skipped
✅ e2e-local-dev-nest-stable 128 0 26
✅ e2e-local-dev-tanstack-start- 128 0 26
✅ e2e-local-postgres-nest-stable 128 0 26
✅ e2e-local-postgres-tanstack-start- 128 0 26
✅ e2e-local-prod-nest-stable 128 0 26
✅ e2e-local-prod-tanstack-start- 128 0 26
✅ e2e-vercel-prod-nest 126 0 28
✅ e2e-vercel-prod-tanstack-start 126 0 28

✅ vercel-multi-region

App Passed Failed Skipped
✅ nextjs-turbopack 27 0 0

📋 View full workflow run

@github-actions

github-actions Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

📊 Workflow Benchmarks

commit 1e3d2af · Sat, 25 Jul 2026 01:00:46 GMT · run logs

Backend: vercel · app: nextjs-turbopack

Metric Scenario Best (ms) P75 (ms) P90 (ms) P99 (ms) Samples
TTFS step 271 (-62%) 💚 1325 🔴 (+27%) 🔻 1340 🔴 (+21%) 🔻 1380 🔴 (+20%) 🔻 30
TTFS stream 1282 (+30%) 🔻 1347 🔴 (+25%) 🔻 1359 🔴 (+17%) 🔻 1391 🔴 (+8.6%) 30
TTFS hook + stream 1444 (+13%) 1515 🔴 (+7.8%) 1579 🔴 (+9.0%) 1662 🔴 (-0.8%) 30
STSO 1020 steps (1-20) 165 (-17%) 💚 249 🔴 (-9.8%) 310 🔴 (-9.9%) 354 🔴 (-8.5%) 19
STSO 1020 steps (101-120) 172 (-20%) 💚 239 🔴 (-15%) 314 🔴 (+5.4%) 1124 🔴 (+198%) 🔻 19
STSO 1020 steps (1001-1020) 487 (±0%) 683 🔴 (+22%) 🔻 760 🔴 (+28%) 🔻 3556 🔴 (+488%) 🔻 19
WO 1020 steps 376679 (-8.7%) 376679 (-8.7%) 376679 (-8.7%) 376679 (-8.7%) 1
SL stream latency 95 (-4.0%) 155 🔴 (+18%) 🔻 160 🔴 (+8.1%) 188 🔴 (-9.6%) 30
SO stream overhead (text) 101 (-22%) 💚 136 (-37%) 💚 153 (-38%) 💚 192 (-29%) 💚 30
SO stream overhead (structured) 89 (-36%) 💚 161 (-27%) 💚 188 (-24%) 💚 275 (-60%) 💚 30
ℹ️ Metric definitions & methodology

Best/P75/P90/P99 deltas compare against the most recent benchmark run on main at the time of this run. 🔻 flags a delta worse than +15%, 💚 one better than −15%.

Metrics — TTFS: time to first step body (in-deployment start() → first step body, deployment clocks) · STSO: step-to-step overhead (gap between consecutive step bodies) · WO: workflow overhead (whole-run time outside step bodies, in-deployment anchored) · SL: stream latency (in-deployment write → read propagation, readAt - writtenAt) · SO: stream overhead (end-to-end write+consume time beyond the modelled generation window)

Scenarios — step: one trivial no-op step, no stream; no hooks, so the run stays in turbo mode (in-process fast path) · stream: one streaming step; no hooks, so the run stays in turbo mode (in-process fast path) · hook + stream: registers a hook before one step, which exits turbo mode (dispatch path) · 1020 steps: 1020 trivial sequential steps; STSO is measured between consecutive steps in the given step ranges, and WO is the whole-run overhead outside step bodies · stream latency: parallel reader/writer steps on a dedicated stream; SL is the in-deployment write->read propagation (readAt - writtenAt) · stream overhead (text): writer streams 300 variable-length text token deltas paced at 100/s for 3s (a haiku-size LLM's token throughput) while a parallel reader drains the whole stream; SO is the end-to-end write+consume time beyond the 3s generation window (overhead/backpressure) · stream overhead (structured): same workload as stream overhead (text), but each delta is an AI-SDK-style structured object ({ type: 'text-delta', id, text }) instead of a raw string, so the SO gap vs the text scenario is the added serialization cost

🔴 marks a percentile over its target (within target is left unmarked). Targets (p75/p90/p99, ms) — TTFS 200/300/600 · SL 50/60/125 · SO 250/500/1000 · STSO (1-20) 20/30/60 · STSO (101-120) 30/45/90 · STSO (1001-1020) 40/60/120

All metrics are measured from deployment-side timestamps only. Runs are triggered by an in-deployment route that stamps the anchor (clientStart) right before start(), so the CI runner’s request and its path through api.vercel.com sit outside every measured window. TTFS = in-deployment start() → first step body (turbo uses the in-process fast path, non-turbo the dispatch path), and includes the VQS dispatch hop plus any /flow cold start. STSO/WO are measured between step bodies on the deployment. SL is measured inside the workflow (parallel reader/writer steps), so it no longer includes the api.vercel.com read path.

Cold starts are kept in the numbers on purpose — they are part of real bursty-workload latency. The workbench deployment cold-starts the /flow invocation for a large fraction of runs, inflating P75+; the Best column shows the fastest (warm-start) sample for comparison.

@vercel vercel Bot 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.

Additional Suggestions:

  1. Docs reference the removed createVercelWorld export, so the programmatic configuration example fails for users copying it.
  1. Docs reference the removed createLocalWorld export from @workflow/world-local, so the programmatic configuration example fails for users copying it.

Fix on Vercel

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.

1 participant