mirror of https://github.com/vercel/workflow.git synced 2026-09-14 19:59:43 +08:00

Files

T

History

Peter Wielander 9dcba490b4 Merge remote-tracking branch 'origin/main' into codex/stream-tail-worlds

Conflicts were all in files main also touched:

- packages/world-local/src/streamer.ts: kept main's `globalSingleton` ULID
  factory alongside this branch's `StreamCursorPositionSchema` value import,
  and kept the direct-index page loop (main's side was the `dataIndex` skip
  loop this branch replaced).
- packages/world-vercel/src/streamer.ts: comment only; kept this branch's
  text, which records that chunk snapshots now read v3.
- docs/content/worlds/v{4,5}/building-a-world.mdx: kept main's rewording and
  re-applied this branch's cursor contract sentences.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-08-24 12:05:18 -07:00

src

Merge remote-tracking branch 'origin/main' into codex/stream-tail-worlds

2026-08-24 12:05:18 -07:00

CHANGELOG.md

Version Packages (beta) (#3717 )

2026-08-21 22:17:38 -07:00

LICENSE.md

Switching from MIT to Apache + DCO (#191 )

2025-11-03 12:42:40 -08:00

package.json

Version Packages (beta) (#3717 )

2026-08-21 22:17:38 -07:00

README.md

fix(world-vercel,world-local): hold process-wide state on globalThis (#3728 )

2026-08-21 16:55:24 -07:00

tsconfig.json

Upgrade workspace to TypeScript 6 (#2700 )

2026-06-30 05:37:38 +00:00

README.md

@workflow/world

Core interfaces and types for Workflow SDK storage backends.

This package defines the World interface that abstracts workflow storage, queuing, authentication, and streaming operations. Implementation packages like @workflow/world-local and @workflow/world-vercel provide concrete implementations.

Used internally by @workflow/core and world implementations. Should not be used directly in application code.

Implementation constraint: no mutable module state

A World implementation must not keep mutable state at module scope. Hold it on the World instance, or, when it is genuinely process-wide (an ID generator whose sequence must not fork, a log-once latch), on globalThis via globalSingleton() from @workflow/utils.

@workflow/world-local and @workflow/world-vercel are bundled into the host application's server build, and a bundler keys module identity on (resource, layer): Next.js alone compiles instrument, app-route, ssr and edge as separate module graphs, so one process holds one copy of every module in these packages per layer. A top-level let, or a const holding a Map, is therefore per-copy state rather than the singleton it reads as.

A world loaded at runtime through WORKFLOW_TARGET_WORLD is deduped by Node's module cache and does not have this problem today, but that is a property of how it is loaded, not of how it is written, and it has changed before (vercel/workflow#3493). scripts/lint/module-scope-state.mjs enforces the rule across every published world package; see docs/content/worlds/*/building-a-world.mdx for the author-facing version.