-
-
Notifications
You must be signed in to change notification settings - Fork 826
feat(vercel): support queues in local dev #4264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3a82754
feat(vercel): support queues in local dev
RihanArfan a1152e0
refactor: env-runner vercel queue async
RihanArfan 000ec3c
chore: apply automated updates
autofix-ci[bot] 6e527b0
Merge branch 'main' into feat/vercel-queues-local-dev
pi0x c6e33ea
update env runner
pi0x 176046e
up
pi0x File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import type { Nitro } from "nitro/types"; | ||
| import { presetsDir } from "nitro/meta"; | ||
| import { resolveModulePath } from "exsolve"; | ||
|
|
||
| /** | ||
| * Configure local development emulation for the Vercel preset. | ||
| * | ||
| * When `vercel.queues.triggers` is configured, propagates the trigger list | ||
| * to runtime config and injects a runtime plugin that binds each topic to | ||
| * the `vercel:queue` hook through env-runner's queue dev bridge. | ||
| * | ||
| */ | ||
| export async function vercelDevModule(nitro: Nitro) { | ||
| if (!nitro.options.dev) { | ||
| return; | ||
| } | ||
|
|
||
| const triggers = nitro.options.vercel?.queues?.triggers; | ||
| if (!triggers?.length) { | ||
| return; | ||
| } | ||
|
|
||
| if (nitro.options.devServer.runner !== "vercel") { | ||
| throw new Error( | ||
| `[vercel:queue] Local queue delivery requires the \`vercel\` dev runner, but \`devServer.runner\` is set to "${nitro.options.devServer.runner}". Remove the \`devServer.runner\` override in your \`nitro.config.ts\` or set it explicitly to \`"vercel"\`.` | ||
| ); | ||
| } | ||
|
|
||
| // Propagate triggers to the runtime plugin via runtimeConfig. | ||
| nitro.options.runtimeConfig.vercel = { | ||
| ...nitro.options.runtimeConfig.vercel, | ||
| queues: { | ||
| triggers: triggers.map((t) => ({ ...t })), | ||
| }, | ||
| }; | ||
|
|
||
| nitro.options.plugins = nitro.options.plugins || []; | ||
| nitro.options.plugins.unshift( | ||
| resolveModulePath("./vercel/runtime/queue.dev", { | ||
| from: presetsDir, | ||
| extensions: [".mjs", ".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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| import { send } from "@vercel/queue"; | ||
| import { useRuntimeConfig } from "nitro/runtime-config"; | ||
| import { registerVercelQueueConsumer } from "env-runner/runners/vercel/queue-dev"; | ||
|
|
||
| import type { MessageMetadata } from "@vercel/queue"; | ||
| import type { NitroAppPlugin } from "nitro/types"; | ||
|
|
||
| interface DevTrigger { | ||
| topic: string; | ||
| retryAfterSeconds?: number; | ||
| initialDelaySeconds?: number; | ||
| } | ||
|
|
||
| const queueDevPlugin: NitroAppPlugin = (nitroApp) => { | ||
| const triggers = | ||
| (useRuntimeConfig() as { vercel?: { queues?: { triggers?: DevTrigger[] } } }).vercel?.queues | ||
| ?.triggers || []; | ||
|
|
||
| if (triggers.length === 0) { | ||
| return; | ||
| } | ||
|
|
||
| const unregisters: Array<() => void> = []; | ||
|
|
||
| const ready = Promise.all( | ||
| triggers.map((trigger) => | ||
| registerVercelQueueConsumer({ | ||
| topic: trigger.topic, | ||
| retryAfterSeconds: trigger.retryAfterSeconds, | ||
| handler: async (message: unknown, metadata: unknown) => { | ||
| try { | ||
| await nitroApp.hooks.callHook("vercel:queue", { | ||
| message, | ||
| metadata: metadata as MessageMetadata, | ||
| send, | ||
| }); | ||
| } catch (error) { | ||
| console.error("[vercel:queue]", error); | ||
| nitroApp.captureError?.(error as Error, { | ||
| tags: ["vercel:queue"], | ||
| }); | ||
| // Rethrow so @vercel/queue schedules a local retry. | ||
| throw error; | ||
| } | ||
| }, | ||
| }).then((unregister) => { | ||
| unregisters.push(unregister); | ||
| }) | ||
| ) | ||
| ).catch((error) => { | ||
| console.error("[vercel:queue] failed to register dev consumer:", error); | ||
| }); | ||
|
|
||
| nitroApp.hooks.hook("close", async () => { | ||
| await ready; | ||
| for (const unregister of unregisters) { | ||
| try { | ||
| unregister(); | ||
| } catch {} | ||
| } | ||
| }); | ||
| }; | ||
|
|
||
| export default queueDevPlugin; | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.