feat(vercel): support queues in local dev #4264
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
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,57 @@ | ||
| import { send } from "@vercel/queue"; | ||
| import type { MessageMetadata } from "@vercel/queue"; | ||
| import type { NitroAppPlugin } from "nitro/types"; | ||
| import { useRuntimeConfig } from "nitro/runtime-config"; | ||
| import { registerVercelQueueConsumer } from "env-runner/runners/vercel/queue-dev"; | ||
|
|
||
| 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> = []; | ||
|
|
||
| for (const trigger of triggers) { | ||
| const unregister = 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); | ||
|
pi0 marked this conversation as resolved.
Outdated
|
||
| nitroApp.captureError?.(error as Error, { | ||
| tags: ["vercel:queue"], | ||
| }); | ||
| // Rethrow so @vercel/queue schedules a local retry. | ||
| throw error; | ||
| } | ||
| }, | ||
| }); | ||
| unregisters.push(unregister); | ||
| } | ||
|
|
||
| nitroApp.hooks.hook("close", () => { | ||
| 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.