Make resumeHook() accept a Hook object or string
#773
Merged
+16
−6
Conversation
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
🦋 Changeset detectedLatest commit: 0551fe8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 13 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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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: Next.js (Turbopack) | Express | Nitro Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express Stream Benchmarks (includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro 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 (17 failed)mongodb (1 failed):
redis (1 failed):
starter (14 failed):
turso (1 failed):
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
|
TooTallNate
requested review from
Schniz,
VaguelySerious,
Copilot and
pranaygp
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances the resumeHook() function to accept either a token string (existing behavior) or a Hook object directly (new behavior), providing an optimization for resumeWebhook() by eliminating an unnecessary database lookup when the Hook object is already available.
Changes:
- Modified
resumeHook()parameter fromstringtostring | Hookwith conditional logic to handle both types - Updated
resumeWebhook()to pass the Hook object directly instead of its token - Updated JSDoc parameter documentation to reflect the new signature
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/core/src/runtime/resume-hook.ts | Modified resumeHook signature to accept Hook objects, added type checking logic, and updated resumeWebhook to utilize the optimization |
| .changeset/new-crabs-hope.md | Added changeset documenting the patch-level API enhancement |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| const hook = | ||
| typeof tokenOrHook === 'string' | ||
| ? await getHookByToken(tokenOrHook) | ||
| : tokenOrHook; |
There was a problem hiding this comment.
When a Hook object is passed directly to resumeHook, it bypasses the metadata hydration logic that exists in getHookByToken(). The getHookByToken function hydrates the metadata property using hydrateStepArguments if it was set from within the workflow run. This could lead to bugs when the hook's metadata is used elsewhere in the workflow execution, as it would remain in its serialized/dehydrated form rather than being properly deserialized. Consider either: 1) documenting that callers must ensure the Hook object has already been processed through getHookByToken, or 2) adding metadata hydration logic here to handle Hook objects that haven't been hydrated yet.
Suggested change
| : tokenOrHook; | |
| : (() => { | |
| const directHook = tokenOrHook; | |
| if (typeof directHook.metadata !== 'undefined') { | |
| directHook.metadata = hydrateStepArguments( | |
| directHook.metadata as any, | |
| [], | |
| directHook.runId | |
| ); | |
| } | |
| return directHook; | |
| })(); |
Comment on lines
59
to
+71
| export async function resumeHook<T = any>( | ||
| token: string, | ||
| tokenOrHook: string | Hook, | ||
| payload: T | ||
| ): Promise<Hook> { | ||
| return await waitedUntil(() => { | ||
| return trace('HOOK.resume', async (span) => { | ||
| const world = getWorld(); | ||
|
|
||
| try { | ||
| const hook = await getHookByToken(token); | ||
| const hook = | ||
| typeof tokenOrHook === 'string' | ||
| ? await getHookByToken(tokenOrHook) | ||
| : tokenOrHook; |
There was a problem hiding this comment.
The new functionality allowing resumeHook to accept a Hook object lacks test coverage. Given that the codebase has comprehensive test coverage for similar runtime functions (e.g., start.test.ts), tests should be added to verify: 1) that resumeHook correctly handles Hook objects, 2) that the hook's token is properly extracted for telemetry attributes, and 3) that the optimization in resumeWebhook works as expected. This is especially important because of the metadata hydration concern.
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
Comment on lines
+68
to
+71
| const hook = | ||
| typeof tokenOrHook === 'string' | ||
| ? await getHookByToken(tokenOrHook) | ||
| : tokenOrHook; |
Contributor
There was a problem hiding this comment.
Suggested change
| const hook = | |
| typeof tokenOrHook === 'string' | |
| ? await getHookByToken(tokenOrHook) | |
| : tokenOrHook; | |
| let hook: Hook; | |
| if (typeof tokenOrHook === 'string') { | |
| hook = await getHookByToken(tokenOrHook); | |
| } else { | |
| hook = tokenOrHook; | |
| // Hydrate the metadata if it was set from within the workflow run | |
| // (same as getHookByToken does for consistency) | |
| if (typeof hook.metadata !== 'undefined') { | |
| hook.metadata = hydrateStepArguments(hook.metadata as any, [], hook.runId); | |
| } | |
| } |
When a Hook object is passed directly to resumeHook(), its metadata is not hydrated via hydrateStepArguments() like it is when a token string is passed, causing inconsistent behavior.
TooTallNate
deleted the
01-12-make_resumehook_accept_a_hook_object_or_string
branch
Merged
Sign up for free
to 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.
Why make this change?
Optimization for
resumeWebhook().This change improves efficiency in cases where the caller already has the
Hookobject, eliminating the need to perform an additional database lookup by token. It maintains backward compatibility while providing a more flexible API.