Uh oh!
There was an error while loading. Please reload this page.
feat: add exists getter to Run class - #1336
Merged
Merged
Conversation
Allow checking if a workflow run exists without catching errors. Returns `true` if the run is found, `false` for WorkflowRunNotFoundError, and re-throws any other errors. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
🦋 Changeset detectedLatest commit: 0f9aff5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 16 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
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro workflow with 25 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro workflow with 50 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro | Express Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro | Express Promise.all with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro | Express Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express Promise.race with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Nitro | Next.js (Turbopack) Stream Benchmarks(includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Nitro | Express SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
|
Contributor
🧪 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
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an exists async getter to the Run runtime API to allow checking whether a workflow run is present without treating “not found” as an exception, along with unit tests and documentation updates.
Changes:
- Add
Run.exists: Promise<boolean>that returnsfalseforWorkflowRunNotFoundErrorand rethrows other errors. - Add unit tests covering: run exists, run not found, and unexpected error cases.
- Document the new getter in the
getRunAPI reference and add a changeset.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/core/src/runtime/run.ts | Adds the new exists getter on Run. |
| packages/core/src/runtime/runs.test.ts | Adds unit tests for Run.exists. |
| docs/content/docs/api-reference/workflow-api/get-run.mdx | Adds an example showing how to use run.exists. |
| .changeset/add-run-exists-getter.md | Publishes the API change as a patch changeset. |
💡 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.
Comment on lines
+120
to
+129
| get exists(): Promise<boolean> { | ||
| return this.world.runs | ||
| .get(this.runId) | ||
| .then(() => true) | ||
| .catch((error) => { | ||
| if (WorkflowRunNotFoundError.is(error)) { | ||
| return false; | ||
| } | ||
| throw error; | ||
| }); |
There was a problem hiding this comment.
Run.exists calls world.runs.get(this.runId) without resolveData: 'none'. In this codebase the default resolveData is 'all' (e.g., world-local/world-vercel), so this existence check can unnecessarily fetch potentially large input/output payloads just to determine presence. Consider calling this.world.runs.get(this.runId, { resolveData: 'none' }) here (and anywhere else where only metadata is needed).
ContributorAuthor
There was a problem hiding this comment.
Done — now passing { resolveData: 'none' } to skip fetching input/output payloads since we only need to check existence.
| ### Check if a Run Exists | ||
| Use the `exists` getter to check whether a workflow run exists without throwing an error: |
There was a problem hiding this comment.
The docs say the exists getter checks whether a run exists "without throwing an error", but Run.exists only suppresses WorkflowRunNotFoundError and will still throw for other failures (e.g., transport/500s). Please tweak the wording to clarify it's "without throwing when the run is not found" (or similar) so readers don't assume it never throws.
Suggested change
| Use the `exists` getter to check whether a workflow run exists without throwing an error: | |
| Use the `exists` getter to check whether a workflow run exists without throwing when the run is not found: |
ContributorAuthor
There was a problem hiding this comment.
Updated — now says "without throwing when the run is not found".
VaguelySerious
approved these changes
Mar 11, 2026
VaguelySerious
left a comment
Member
There was a problem hiding this comment.
LGTM aside from the comment about data resolution
Comment on lines
+120
to
+129
| get exists(): Promise<boolean> { | ||
| return this.world.runs | ||
| .get(this.runId) | ||
| .then(() => true) | ||
| .catch((error) => { | ||
| if (WorkflowRunNotFoundError.is(error)) { | ||
| return false; | ||
| } | ||
| throw error; | ||
| }); |
TooTallNate
approved these changes
Mar 11, 2026
…cs wording
Pass { resolveData: 'none' } to world.runs.get() in the exists getter
to skip fetching input/output payloads. Update docs to say "without
throwing when the run is not found" instead of "without throwing an error".
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>Uh oh!
There was an error while loading. Please reload this page.
pranaygp added a commit
that referenced
this pull request
Mar 12, 2026
…ignal * origin/main: (26 commits) Fix flaky streamer test ENOENT when chunks directory does not exist yet (#1330) Version Packages (beta) (#1325) [web-shared] Improve workflow observability event list UX (#1337) feat: add `exists` getter to `Run` class (#1336) Support client-side tools in DurableAgent (#1329) [world-postgres] [world-local] Execute Graphile jobs directly instead of defering to world-local queue (#1334) Merge CLAUDE.md into AGENTS.md and symlink CLAUDE.md (#1326) [web] Polish loading indicators (#1327) Fix flaky webhookWorkflow e2e test by polling instead of fixed sleep (#1328) feat: support `deploymentId: 'latest'` in `start()` to resolve most recent deployment (#1317) Fix bug where the SWC compiler bug prunes step-only imports in the client-mode transformation [web] [world-vercel] Ensure user-passed run IDs are URL encoded and call out self-hosted security (#1322) Version Packages (beta) (#1306) Remove hard-coded VERCEL_DEPLOYMENT_KEY from nextjs-turbopack workbench (#1319) fix(web): move react-router deps to devDependencies (#1265) fix(ai): use workspace:* for workflow peer dependency (#1320) fix(core): pass resolved deploymentId to getEncryptionKeyForRun in start() (#1318) fix: surface 429 rate-limit errors in e2e tests and CLI (#1309) fix(world-local): return HTTP 200 instead of 503 for queue timeout re-enqueue signals (#1307) [web-shared] [cli] Refactor observability data fetching (#1261) ... # Conflicts: # packages/core/e2e/e2e.test.ts # packages/web-shared/src/components/sidebar/attribute-panel.tsx # workbench/example/workflows/99_e2e.ts
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.
Summary
existsasync getter to theRunclass that returnstrueif the run is found,falseforWorkflowRunNotFoundError, and re-throws other errorsgetRunAPI referenceTest plan
pnpm vitest run packages/core/src/runtime/runs.test.ts(8 tests, 3 new)🤖 Generated with Claude Code