Uh oh!
There was an error while loading. Please reload this page.
feat: export semantic error types and add API reference docs - #1447
Conversation
🦋 Changeset detectedLatest commit: 7afb73d 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 |
There was a problem hiding this comment.
Pull request overview
This PR expands the public surface area and documentation around semantic error types by re-exporting them via workflow/internal/errors, adding/standardizing world-level error classes in @workflow/errors, and introducing API reference docs for these errors. It also adds DEBUG-gated request timing logs in the Vercel world client and fixes a CLI env var passthrough.
Changes:
- Re-export semantic error types from
workflow/internal/errorsand add new world-level semantic error classes to@workflow/errors. - Add/standardize TSDoc on error classes and add API reference docs pages for the error types.
- Add DEBUG-gated HTTP timing logs in
@workflow/world-verceland passWORKFLOW_LOCAL_BASE_URLthrough CLI inspect env.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/world-vercel/src/utils.ts | Adds lightweight DEBUG-gated HTTP timing logging around fetch() requests. |
| packages/workflow/src/internal/errors.ts | Re-exports semantic/world error types from @workflow/errors via workflow/internal/errors. |
| packages/errors/src/index.ts | Adds/extends semantic error classes (world-level) and improves TSDoc consistency/examples. |
| packages/core/src/runtime/helpers.ts | Adds runtime debug logs for event pagination load timing during replay. |
| packages/cli/src/lib/inspect/env.ts | Includes WORKFLOW_LOCAL_BASE_URL in env var collection for inspect/health checks. |
| docs/content/docs/api-reference/workflow/workflow-world-error.mdx | New API reference page for WorkflowWorldError. |
| docs/content/docs/api-reference/workflow/workflow-run-not-found-error.mdx | New API reference page for WorkflowRunNotFoundError. |
| docs/content/docs/api-reference/workflow/workflow-run-failed-error.mdx | New API reference page for WorkflowRunFailedError. |
| docs/content/docs/api-reference/workflow/workflow-run-cancelled-error.mdx | New API reference page for WorkflowRunCancelledError. |
| docs/content/docs/api-reference/workflow/too-early-error.mdx | New API reference page for TooEarlyError. |
| docs/content/docs/api-reference/workflow/throttle-error.mdx | New API reference page for ThrottleError. |
| docs/content/docs/api-reference/workflow/run-expired-error.mdx | New API reference page for RunExpiredError. |
| docs/content/docs/api-reference/workflow/hook-not-found-error.mdx | New API reference page for HookNotFoundError. |
| docs/content/docs/api-reference/workflow/entity-conflict-error.mdx | New API reference page for EntityConflictError. |
| docs/content/docs/api-reference/workflow/meta.json | Adds new error reference pages to the workflow API reference sidebar. |
| .changeset/error-docs-and-exports.md | Changeset for workflow + @workflow/errors export/doc updates. |
| .changeset/early-bats-make.md | Changeset for @workflow/world-vercel DEBUG HTTP timing logs. |
| .changeset/bumpy-mice-do.md | Changeset for @workflow/cli env var passthrough fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| /** | ||
| * Lightweight debug logger for HTTP requests. Activated when the DEBUG | ||
| * env var includes "workflow:" (matching the standard `debug` module | ||
| * convention used by @workflow/core). | ||
| */ | ||
| const HTTP_DEBUG_ENABLED = | ||
| typeof process !== 'undefined' && | ||
| typeof process.env.DEBUG === 'string' && | ||
| (process.env.DEBUG.includes('workflow:') || process.env.DEBUG === '*'); | ||
| function httpLog( | ||
| method: string, | ||
| endpoint: string, | ||
| status: number, | ||
| ms: number | ||
| ): void { | ||
| if (HTTP_DEBUG_ENABLED) { | ||
| console.debug( | ||
| `[workflow:world-vercel:http] ${method} ${endpoint} -> ${status} (${ms}ms)` | ||
| ); | ||
| } | ||
| } | ||
| import { | ||
| ErrorType, | ||
| getSpanKind, |
| /** | ||
| * Lightweight debug logger for HTTP requests. Activated when the DEBUG | ||
| * env var includes "workflow:" (matching the standard `debug` module | ||
| * convention used by @workflow/core). | ||
| */ | ||
| const HTTP_DEBUG_ENABLED = | ||
| typeof process !== 'undefined' && | ||
| typeof process.env.DEBUG === 'string' && | ||
| (process.env.DEBUG.includes('workflow:') || process.env.DEBUG === '*'); |
There was a problem hiding this comment.
seems like a correct suggestion
There was a problem hiding this comment.
Acknowledged — the current check is intentionally lightweight and doesn't implement full debug glob/negation semantics. It covers the common cases (DEBUG=workflow:* and DEBUG=*). I've updated the JSDoc comment to say "Activated when the DEBUG env var contains workflow: or is *" to avoid implying full debug module compatibility. A full implementation would add complexity for a debug-only logger.
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 25 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 50 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Promise.all with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Promise.race with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 10 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 25 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 50 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 10 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 25 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) workflow with 50 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) Stream Benchmarks(includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) stream pipeline with 5 transform steps (1MB)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) 10 parallel streams (1MB each)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) fan-out fan-in 10 streams (1MB each)💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
❌ Some benchmark jobs failed:
Check the workflow run for details. |
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests🌍 Community Worlds (56 failed)mongodb (3 failed):
redis (2 failed):
turso (51 failed):
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
✅ 📋 Other
|
- Resolve merge conflict in world-vercel/utils.ts - Add @skip-typecheck markers to all error API reference docs code samples that use placeholder variables (world, runId, run, etc.) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
| // Return timeout to queue so it retries later | ||
| if (TooEarlyError.is(err)) { | ||
| const retryAfter = err.retryAfter ?? new Date(Date.now() + 1000); | ||
| const retryAfter = err.retryAfterDate ?? new Date(Date.now() + 1000); |
There was a problem hiding this comment.
is this real? does this mean that before this PR the retryAfter was not actually working? or did this PR change the type so that it's now correct?
There was a problem hiding this comment.
This was introduced by this PR — not a pre-existing bug. On main, TooEarlyError extends WorkflowError (which has no retryAfter property), so the retryAfter?: Date property worked fine.
This PR changes the class hierarchy so TooEarlyError extends WorkflowWorldError, which already has retryAfter?: number (seconds, from HTTP Retry-After header). TypeScript doesn't allow a subclass to narrow a property from number to Date, so I renamed the TooEarlyError property to retryAfterDate to avoid the clash. The semantics are the same — just the property name changed.
| {/* @skip-typecheck: incomplete snippet with placeholder variables */} | ||
| ```typescript lineNumbers | ||
| import { ThrottleError } from "workflow/internal/errors" |
There was a problem hiding this comment.
use should not import from workflow/internal. it should be workflow/errors directly
There was a problem hiding this comment.
Fixed — all docs now import from workflow/errors and the export was added to workflow/package.json.
… section - Replace @skip-typecheck with proper `declare` + `// @setup` lines so code samples are typechecked but setup lines hidden from readers - Add `workflow/errors` export to package.json (public API, replaces `workflow/internal/errors` in docs) - Add `workflow/errors` path mapping in docs-typecheck type-checker - Add HookConflictError to re-export list - Move all error docs under api-reference/workflow/errors/ subdirectory - Update all internal cross-references and links Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Move semantic error docs to api-reference/workflow-errors/ (matching the workflow/errors import path, like workflow-api for workflow/api) - Keep FatalError and RetryableError in api-reference/workflow/ since they're imported from workflow, not workflow/errors - Fix all cross-reference links Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* origin/main: [ai] Add experimental_context to DurableAgentOptions (#1489) [ai] Expose configured tools on DurableAgent instances (#1488) fix(builders): catch node builtin usage when entry fields diverge (#1455) [web-shared] Fix timeline duration format and precision (#1482) [cli] Add bulk cancel, --status filter, fix step JSON hydration (#1467) [utils] Re-export parseName utilities and add workflow/observability module (#1453) [o11y] Polish display when run data has expired (#1438) Add CommonJS `require()` support for class serialization detection in SWC plugin (#1144) fix(next): stabilize deferred canary e2e in nextjs workbenches (#1468) [web] Support legacy newline-delimited stream format in `useStreamReader` (#1473) Revert "Add support for calling start() inside workflow functions (#1133)" (#1475)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
VaguelySerious
left a comment
There was a problem hiding this comment.
Change retryAfterDate, otherwise LGTM
| export class TooEarlyError extends WorkflowError { | ||
| retryAfter?: Date; | ||
| export class TooEarlyError extends WorkflowWorldError { | ||
| retryAfterDate?: Date; |
There was a problem hiding this comment.
All instances of retryAfterDate should actually be retryAfter. We should also modify the TooEarlyError creation in world-vercel to be retryAfter instead of retryAfterDate
There was a problem hiding this comment.
Fixed — TooEarlyError.retryAfter is now number (seconds), consistent with ThrottleError and WorkflowWorldError. The world-local and world-postgres construction sites convert the DB Date to seconds, and the step-handler consumer uses the seconds value directly.
…owWorldError TooEarlyError.retryAfter is now seconds (number) instead of a Date, consistent with ThrottleError and WorkflowWorldError. The conversion from seconds to Date is done at the consumer site (step-handler) rather than at construction time. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
karthikscale3
left a comment
There was a problem hiding this comment.
Inconsistencies in PR #1447
1. TooEarlyError.retryAfterDate vs WorkflowWorldError.retryAfter -- name collision on the prototype chain
This is the most significant issue. The PR renames TooEarlyError.retryAfter (a Date) to retryAfterDate, but TooEarlyError now extends WorkflowWorldError, which has its own retryAfter property (a number, in seconds). Since TooEarlyError no longer declares retryAfter, it inheritsWorkflowWorldError.retryAfter: number | undefined on its prototype.
This means a TooEarlyError instance will have both:
retryAfterDate?: Date(the new renamed property)retryAfter?: number(inherited fromWorkflowWorldError, alwaysundefinedsinceTooEarlyError's constructor callssuper(message)without passing options)
This isn't broken per se, but it's confusing and makes TooEarlyError inconsistent with ThrottleError, which also extends WorkflowWorldError and does use retryAfter: number directly. And the inherited retryAfter on TooEarlyError will always be undefined, which is misleading.
2. WorkflowWorldError.is() won't match subclasses
The .is() methods check value.name === 'WorkflowWorldError'. But EntityConflictError, RunExpiredError, TooEarlyError, and ThrottleError all set their own this.name (e.g., 'EntityConflictError'). So:
consterr=newEntityConflictError('conflict');WorkflowWorldError.is(err);// false! name is 'EntityConflictError', not 'WorkflowWorldError'The docs claim WorkflowWorldError is "the base error class" and you can "catch any world-related error regardless of the specific backend or error type." But WorkflowWorldError.is() won't actually match any of its subclasses. The docs' WorkflowWorldError.is(error) example is misleading -- it will only match errors that were constructed directly as WorkflowWorldError, not EntityConflictError etc.
This was already true before the PR (for ThrottleError etc.), but the PR makes it worse by re-parenting 4 more errors under WorkflowWorldError and adding docs that imply .is() is a catch-all.
3. Docs say retryAfterDate is non-optional, but it's Date | undefined in code
The too-early-error.mdx TSDoc block declares:
retryAfterDate: Date;
But the actual class definition is:
retryAfterDate?: Date;It's optional. The constructor receives options?: { retryAfter?: Date }, and world-vercel/src/utils.ts only sets it when the Retry-After header is present. If the header is missing, retryAfterDate will be undefined.
4. ThrottleError docs say retryAfter: number is non-optional, but it's number | undefined
Same issue as above -- the throttle-error.mdx TSDoc block shows:
retryAfter: number;
But the actual type is retryAfter?: number.
5. Constructor parameter name mismatch for TooEarlyError
The constructor still takes { retryAfter?: Date } as an option, but stores it as retryAfterDate:
constructor(message: string,options?: {retryAfter?: Date}){// ...this.retryAfterDate=options?.retryAfter;}All existing call sites pass { retryAfter: someDate } which still works, but this is a confusing API: the input parameter is named retryAfter while the property is retryAfterDate. The constructor option should be renamed too for consistency:
constructor(message: string,options?: {retryAfterDate?: Date})6. WorkflowWorldError docs TSDoc omits status, code, url, retryAfter properties
The workflow-world-error.mdx TSDoc block only shows message:
interface WorkflowWorldError {
/** The error message. */
message: string;
}
But WorkflowWorldError actually has status?: number, code?: string, url?: string, and retryAfter?: number. These are important for debugging and are set by world-vercel's makeRequest utility. Omitting them from the docs means users won't know they can inspect HTTP status codes on world errors.
7. Minor: world-vercel/src/utils.ts import reordering is unrelated noise
The diff moves telemetry imports to the top of the file and updates the HTTP debug logger JSDoc. These are cosmetic changes bundled into a PR about error type exports and docs. Not a bug, but adds noise to the review.
Summary: The most actionable issues are (1) the inherited retryAfter: number ghost property on TooEarlyError, (2) the WorkflowWorldError.is() not matching subclasses despite the docs implying it should, (3/4) the docs claiming retryAfterDate/retryAfter are required when they're actually optional, and (5) the constructor param name mismatch.
- WorkflowWorldError docs: add status, code, url, retryAfter properties to TSDoc; clarify that .is() only matches direct instances (not subclasses); use instanceof in catch-all example - TooEarlyError/ThrottleError docs: mark retryAfter as optional (?) to match actual type definitions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
pranaygp
commented
Mar 23, 2026
Addressed all items from @karthikscale3's review (#1447 (review)): 1. retryAfterDate ghost property — Already fixed. 2. WorkflowWorldError.is() vs subclasses — Pre-existing by-design behavior ( 3/4. Optional properties shown as required — Fixed. TSDoc now shows 5. Constructor param mismatch — Already fixed by reverting to 6. WorkflowWorldError docs missing properties — Fixed. TSDoc now includes 7. Import reordering — Acknowledged as cosmetic noise from an earlier review comment. |
Summary
HookNotFoundError,EntityConflictError,RunExpiredError,TooEarlyError,ThrottleError,RunNotSupportedError,WorkflowWorldError) fromworkflow/internal/errors@workflow/errors:WorkflowWorldError,EntityConflictError,RunExpiredError,TooEarlyError,ThrottleError(world-level semantic errors).is()method, key properties)Test plan
pnpm buildpassespnpm typecheckpassesworkflow/internal/errorsexports are accessible at runtime🤖 Generated with Claude Code