@vercel/queue 0.1.2 → 0.1.4

package/dist/index.mjs

@@ -79,6 +79,7 @@ import * as fs from "fs";
 import * as net from "net";
 import * as path from "path";
 import { minimatch } from "minimatch";
+import pc from "picocolors";
 
 // src/types.ts
 var MessageNotFoundError = class extends Error {
@@ -708,6 +709,10 @@ async function handleCallback(handler, request, options) {
 }
 
 // src/dev.ts
+var PREFIX = pc.cyan("[queue]");
+var OK = pc.green("\u2713");
+var FAIL = pc.red("\u2717");
+var RETRY = pc.yellow("\u21BB");
 function isDevMode() {
   return process.env.NODE_ENV === "development";
 }
@@ -752,7 +757,7 @@ function getDevRouteMappings() {
         if (!trigger.type?.startsWith("queue/") || !trigger.topic) continue;
         if (trigger.type !== "queue/v2beta") {
           console.warn(
-            `[Dev Mode] Unsupported trigger type "${trigger.type}" for topic "${trigger.topic}" in ${filePath}. Use "queue/v2beta" instead.`
+            `${PREFIX} Unsupported trigger type "${trigger.type}" for topic "${trigger.topic}" in ${filePath}. Use "queue/v2beta" instead.`
           );
           continue;
         }
@@ -767,7 +772,7 @@ function getDevRouteMappings() {
     g[ROUTE_MAPPINGS_KEY] = mappings.length > 0 ? mappings : null;
     return g[ROUTE_MAPPINGS_KEY];
   } catch (error) {
-    console.warn("[Dev Mode] Failed to read vercel.json:", error);
+    console.warn(`${PREFIX} Failed to read vercel.json:`, error);
     g[ROUTE_MAPPINGS_KEY] = null;
     return null;
   }
@@ -904,7 +909,7 @@ function registerDevHandler(handler, client, options, _testCallerPath) {
   const callerPath = _testCallerPath ?? extractCallerFilePath();
   if (!callerPath) {
     console.warn(
-      "[Dev Mode] Could not determine caller file path for handler registration."
+      `${PREFIX} Could not determine caller file path for handler registration.`
     );
     return;
   }
@@ -927,7 +932,7 @@ function registerDevHandler(handler, client, options, _testCallerPath) {
       relative2 = callerPath;
     }
     console.warn(
-      `[Dev Mode] handleCallback() in ${relative2} has no matching experimentalTriggers in vercel.json. This handler won't receive messages.
+      `${PREFIX} handleCallback() in ${relative2} has no matching experimentalTriggers in vercel.json. This handler won't receive messages.
 
 Add a trigger to vercel.json:
   "${relative2}": {
@@ -1144,7 +1149,7 @@ function buildNoHandlerWarning(topicName, routes, diagnostics) {
 Import failures: ` + diagnostics.importFailures.slice(0, 2).map((f) => `${f.filePath} (${f.reason})`).join("; ") : "";
   const primeSummary = diagnostics.primeFailures.length > 0 ? `
 Prime failures: ` + diagnostics.primeFailures.slice(0, 3).map((f) => `${f.url} (${f.reason})`).join("; ") : "";
-  return `[Dev Mode] No registered handler for topic "${topicName}". vercel.json maps this topic to [${files.join(", ")}] but auto-loading failed.
+  return `${PREFIX} No registered handler for topic "${topicName}". vercel.json maps this topic to [${files.join(", ")}] but auto-loading failed.
 ${portSummary}${importSummary}${primeSummary}
 Ensure your dev server is running, set PORT if needed, and confirm mapped route files call handleCallback()/handleNodeCallback() at module scope.
 ` + (suggestedUrls.length > 0 ? `Try opening: ${suggestedUrls.join(" or ")}` : "Set PORT (or NEXT_PORT/NUXT_PORT/VITE_PORT) and try sending again.");
@@ -1161,7 +1166,7 @@ var DEFAULT_RETENTION_S = 86400;
 function scheduleDevRedelivery(ctx, delayS) {
   const cappedDelay = Math.min(Math.max(delayS, 0), DEV_REDELIVERY_MAX_DELAY_S);
   console.log(
-    `[Dev Mode] \u21BB Scheduling re-delivery in ${cappedDelay}s: topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}"`
+    `${PREFIX} ${RETRY} Scheduling re-delivery in ${cappedDelay}s: topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}"`
   );
   setTimeout(async () => {
     const nextDeliveryCount = ctx.deliveryCount + 1;
@@ -1170,13 +1175,13 @@ function scheduleDevRedelivery(ctx, delayS) {
     );
     if (Date.now() >= expiresAt.getTime()) {
       console.log(
-        `[Dev Mode] Message expired, stopping retries: topic="${ctx.topicName}" messageId="${ctx.messageId}"`
+        `${PREFIX} Message expired, stopping retries: topic="${ctx.topicName}" messageId="${ctx.messageId}"`
       );
       return;
     }
     if (nextDeliveryCount > DEV_REDELIVERY_MAX_ATTEMPTS) {
       console.log(
-        `[Dev Mode] Max re-deliveries (${DEV_REDELIVERY_MAX_ATTEMPTS}) reached: topic="${ctx.topicName}" messageId="${ctx.messageId}"`
+        `${PREFIX} Max re-deliveries (${DEV_REDELIVERY_MAX_ATTEMPTS}) reached: topic="${ctx.topicName}" messageId="${ctx.messageId}"`
       );
       return;
     }
@@ -1190,7 +1195,7 @@ function scheduleDevRedelivery(ctx, delayS) {
       region: ctx.region
     };
     console.log(
-      `[Dev Mode] Re-delivering: topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}" deliveryCount=${nextDeliveryCount}`
+      `${PREFIX} Re-delivering: topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}" deliveryCount=${nextDeliveryCount}`
     );
     let succeeded = true;
     let nextRetryAfterS = null;
@@ -1204,7 +1209,7 @@ function scheduleDevRedelivery(ctx, delayS) {
         try {
           directive = ctx.retry(error, metadata);
         } catch (retryErr) {
-          console.warn("[Dev Mode] retry handler threw:", retryErr);
+          console.warn(`${PREFIX} retry handler threw:`, retryErr);
         }
         if (directive && "afterSeconds" in directive) {
           nextRetryAfterS = directive.afterSeconds;
@@ -1214,18 +1219,18 @@ function scheduleDevRedelivery(ctx, delayS) {
       }
       if (!nextAcknowledged) {
         console.error(
-          `[Dev Mode] \u2717 Handler error on re-delivery: topic="${ctx.topicName}" messageId="${ctx.messageId}"`,
+          `${PREFIX} ${FAIL} Handler error on re-delivery: topic="${ctx.topicName}" messageId="${ctx.messageId}"`,
           error
         );
       }
     }
     if (succeeded) {
       console.log(
-        `[Dev Mode] \u2713 Message processed on re-delivery: topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}"`
+        `${PREFIX} ${OK} Message processed on re-delivery: topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}"`
       );
     } else if (nextAcknowledged) {
       console.log(
-        `[Dev Mode] \u2713 Message acknowledged (will not retry): topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}"`
+        `${PREFIX} ${OK} Message acknowledged (will not retry): topic="${ctx.topicName}" consumer="${ctx.consumerGroup}" messageId="${ctx.messageId}"`
       );
     } else {
       const nextDelay = nextRetryAfterS ?? ctx.defaultRetryDelayS;
@@ -1239,7 +1244,7 @@ function scheduleDevRedelivery(ctx, delayS) {
 function invokeDevHandlers(topicName, messageId, region, delaySeconds, retentionSeconds) {
   if (delaySeconds && delaySeconds > 0) {
     console.log(
-      `[Dev Mode] Message sent with delay: topic="${topicName}" messageId="${messageId}" delay=${delaySeconds}s`
+      `${PREFIX} Message sent with delay: topic="${topicName}" messageId="${messageId}" delay=${delaySeconds}s`
     );
     setTimeout(() => {
       invokeDevHandlers(
@@ -1253,7 +1258,7 @@ function invokeDevHandlers(topicName, messageId, region, delaySeconds, retention
     return;
   }
   console.log(
-    `[Dev Mode] Message sent: topic="${topicName}" messageId="${messageId}"`
+    `${PREFIX} Message sent: topic="${topicName}" messageId="${messageId}"`
   );
   (async () => {
     let handlers = lookupHandlers(topicName);
@@ -1280,7 +1285,7 @@ function invokeDevHandlers(topicName, messageId, region, delaySeconds, retention
         );
       } else {
         console.warn(
-          `[Dev Mode] No registered handler for topic "${topicName}".
+          `${PREFIX} No registered handler for topic "${topicName}".
 Ensure vercel.json has a matching experimentalTriggers entry and the route file calls handleCallback().`
         );
       }
@@ -1288,7 +1293,7 @@ Ensure vercel.json has a matching experimentalTriggers entry and the route file
     }
     const consumerGroups = handlers.map((h) => h.consumerGroup);
     console.log(
-      `[Dev Mode] Invoking handlers for topic="${topicName}" messageId="${messageId}" \u2192 consumers: [${consumerGroups.join(", ")}]`
+      `${PREFIX} Invoking handlers for topic="${topicName}" messageId="${messageId}" \u2192 consumers: [${consumerGroups.join(", ")}]`
     );
     const effectiveRetention = retentionSeconds ?? DEFAULT_RETENTION_S;
     for (const entry of handlers) {
@@ -1350,11 +1355,11 @@ Ensure vercel.json has a matching experimentalTriggers entry and the route file
         await invokeWithRetry(wrappedHandler, request, callbackOptions);
         if (handlerSucceeded) {
           console.log(
-            `[Dev Mode] \u2713 Message processed: topic="${topicName}" consumer="${entry.consumerGroup}" messageId="${messageId}"`
+            `${PREFIX} ${OK} Message processed: topic="${topicName}" consumer="${entry.consumerGroup}" messageId="${messageId}"`
           );
         } else if (retryAcknowledged) {
           console.log(
-            `[Dev Mode] \u2713 Message acknowledged (will not retry): topic="${topicName}" consumer="${entry.consumerGroup}" messageId="${messageId}"`
+            `${PREFIX} ${OK} Message acknowledged (will not retry): topic="${topicName}" consumer="${entry.consumerGroup}" messageId="${messageId}"`
           );
         } else if (retryAfterS !== null) {
           const devDelay = Math.min(retryAfterS, DEV_REDELIVERY_MAX_DELAY_S);
@@ -1362,7 +1367,7 @@ Ensure vercel.json has a matching experimentalTriggers entry and the route file
         }
       } catch (error) {
         console.error(
-          `[Dev Mode] \u2717 Handler failed: topic="${topicName}" consumer="${entry.consumerGroup}" messageId="${messageId}"`,
+          `${PREFIX} ${FAIL} Handler failed: topic="${topicName}" consumer="${entry.consumerGroup}" messageId="${messageId}"`,
           error
         );
         if (!handlerSucceeded) {
@@ -1458,6 +1463,7 @@ var ApiClient = class _ApiClient {
   transport;
   region;
   baseUrlResolver;
+  dispatcher;
   constructor(options) {
     this.region = options.region;
     this.baseUrlResolver = options.resolveBaseUrl;
@@ -1465,6 +1471,7 @@ var ApiClient = class _ApiClient {
     this.customHeaders = options.headers || {};
     this.providedToken = options.token;
     this.transport = options.transport || new JsonTransport();
+    this.dispatcher = options.dispatcher;
     if (options.deploymentId === null) {
       this.pinSends = false;
       this.explicitlyUnpinned = true;
@@ -1487,7 +1494,8 @@ var ApiClient = class _ApiClient {
       token: this.providedToken,
       headers: { ...this.customHeaders },
       deploymentId: this.explicitlyUnpinned ? null : this.resolvedDeploymentId,
-      transport: this.transport
+      transport: this.transport,
+      dispatcher: this.dispatcher
     });
   }
   getRegion() {
@@ -1522,13 +1530,25 @@ var ApiClient = class _ApiClient {
     if (this.providedToken) {
       return this.providedToken;
     }
-    const token = await getVercelOidcToken();
-    if (!token) {
+    try {
+      return await getVercelOidcToken();
+    } catch (err) {
+      const cause = err instanceof Error ? err.message : String(err);
       throw new Error(
-        "Failed to get OIDC token from Vercel Functions. Make sure you are running in a Vercel Function environment, or provide a token explicitly.\n\nTo set up your environment:\n1. Link your project: 'vercel link'\n2. Pull environment variables: 'vercel env pull'\n3. Run with environment: 'dotenv -e .env.local -- your-command'"
+        isDevMode() ? `Failed to get OIDC token for local development.
+
+To fix this, pull your environment variables with Vercel CLI:
+  \`vercel env pull\`
+
+Cause: ${cause}` : `Failed to get OIDC token. This usually means the function is running outside of a Vercel Function environment.
+
+To fix this, either:
+  - Deploy to Vercel (OIDC tokens are provisioned automatically)
+  - Provide a token explicitly: \`new QueueClient({ token: '...' })\`
+
+Cause: ${cause}`
       );
     }
-    return token;
   }
   buildUrl(queueName, ...pathSegments) {
     const encodedQueue = encodeURIComponent(queueName);
@@ -1559,9 +1579,10 @@ var ApiClient = class _ApiClient {
       }
       console.debug("[VQS Debug] Request:", JSON.stringify(logData, null, 2));
     }
-    init.headers.set("User-Agent", `@vercel/queue/${"0.1.2"}`);
+    init.headers.set("User-Agent", `@vercel/queue/${"0.1.4"}`);
     init.headers.set("Vqs-Client-Ts", (/* @__PURE__ */ new Date()).toISOString());
-    const response = await fetch(url, init);
+    const fetchInit = this.dispatcher ? { ...init, dispatcher: this.dispatcher } : init;
+    const response = await fetch(url, fetchInit);
     if (isDebugEnabled()) {
       const logData = {
         method,