@vercel/client 17.6.3 → 17.6.5

package/dist/check-deployment-status.js

@@ -42,6 +42,36 @@ const RETRY_DELAY_MAX_MS = 6e4;
 const RETRY_DELAY_MIN_MS = 5e3;
 const RETRY_DELAY_SKEW_MS = 3e4;
 const RETRY_DELAY_DEFAULT_MS = 5e3;
+function getAliasAssignedEvent(signal, deploymentId) {
+  if (!signal?.aborted)
+    return;
+  const event = signal.reason;
+  if (event?.type === "alias-assigned" && event.deploymentId === deploymentId && typeof event.date === "number" && Array.isArray(event.alias) && "aliasError" in event && "aliasWarning" in event) {
+    return event;
+  }
+  return void 0;
+}
+async function sleepUntilAliasAssigned(duration, signal, deploymentId) {
+  if (getAliasAssignedEvent(signal, deploymentId))
+    return;
+  if (!signal || signal.aborted) {
+    await (0, import_sleep_promise.default)(duration);
+    return;
+  }
+  await new Promise((resolve) => {
+    const timeout = setTimeout(finish, duration);
+    function finish() {
+      clearTimeout(timeout);
+      signal?.removeEventListener("abort", onAbort);
+      resolve();
+    }
+    function onAbort() {
+      if (getAliasAssignedEvent(signal, deploymentId))
+        finish();
+    }
+    signal.addEventListener("abort", onAbort, { once: true });
+  });
+}
 function parseRetryAfterMs(response) {
   if (response.status === 429 || response.status === 503) {
     let header = response.headers.get("Retry-After");
@@ -71,6 +101,8 @@ async function* checkDeploymentStatus(deployment, clientOptions) {
   const { token, teamId, apiUrl, userAgent } = clientOptions;
   const debug = (0, import_utils2.createDebug)(clientOptions.debug);
   let deploymentState = deployment;
+  const deploymentId = deployment.id || deployment.deploymentId;
+  let aliasAssignedSignal = clientOptions.aliasAssignedSignal;
   const apiDeployments = (0, import_utils.getApiDeploymentsUrl)();
   if ((0, import_ready_state.isDone)(deploymentState) && (0, import_ready_state.isAliasAssigned)(deploymentState)) {
     debug(
@@ -81,109 +113,172 @@ async function* checkDeploymentStatus(deployment, clientOptions) {
   debug("Waiting for builds and the deployment to complete...");
   const finishedEvents = /* @__PURE__ */ new Set();
   const startTime = Date.now();
-  while (true) {
-    let deploymentResponse;
-    let retriesLeft = RETRY_COUNT;
+  polling:
     while (true) {
-      deploymentResponse = await (0, import_utils.fetchApi)(
-        `${apiDeployments}/${deployment.id || deployment.deploymentId}${teamId ? `?teamId=${teamId}` : ""}`,
-        token,
-        { apiUrl, userAgent, agent: clientOptions.agent }
+      const aliasAssignedEvent = getAliasAssignedEvent(
+        aliasAssignedSignal,
+        deploymentId
       );
-      retriesLeft--;
-      if (retriesLeft == 0) {
+      if (aliasAssignedEvent) {
+        deploymentState = {
+          ...deploymentState,
+          readyState: "READY",
+          aliasAssigned: aliasAssignedEvent.date,
+          alias: aliasAssignedEvent.alias,
+          aliasError: aliasAssignedEvent.aliasError,
+          aliasWarning: aliasAssignedEvent.aliasWarning
+        };
+        if (!finishedEvents.has("ready")) {
+          debug("Deployment state changed to READY");
+          finishedEvents.add("ready");
+          yield { type: "ready", payload: deploymentState };
+        }
+        debug("Deployment alias assigned from event stream");
+        return yield { type: "alias-assigned", payload: deploymentState };
+      }
+      let deploymentResponse;
+      let retriesLeft = RETRY_COUNT;
+      while (true) {
+        try {
+          deploymentResponse = await (0, import_utils.fetchApi)(
+            `${apiDeployments}/${deploymentId}${teamId ? `?teamId=${teamId}` : ""}`,
+            token,
+            {
+              apiUrl,
+              userAgent,
+              agent: clientOptions.agent,
+              // node-fetch's bundled AbortSignal type predates the native one.
+              signal: aliasAssignedSignal
+            }
+          );
+        } catch (error) {
+          if (getAliasAssignedEvent(aliasAssignedSignal, deploymentId)) {
+            continue polling;
+          }
+          if (aliasAssignedSignal?.aborted) {
+            aliasAssignedSignal = void 0;
+            continue polling;
+          }
+          throw error;
+        }
+        if (getAliasAssignedEvent(aliasAssignedSignal, deploymentId)) {
+          continue polling;
+        }
+        retriesLeft--;
+        if (retriesLeft == 0) {
+          break;
+        }
+        const retryAfterMs = parseRetryAfterMs(deploymentResponse);
+        if (retryAfterMs != null) {
+          const randomSkewMs = Math.floor(RETRY_DELAY_SKEW_MS * Math.random());
+          debug(
+            `Received a transient error or rate limit (HTTP ${deploymentResponse.status}) while querying deployment status, retrying after ${retryAfterMs + randomSkewMs}ms (${retryAfterMs} + ${randomSkewMs}ms of random skew)`
+          );
+          await sleepUntilAliasAssigned(
+            retryAfterMs + randomSkewMs,
+            aliasAssignedSignal,
+            deploymentId
+          );
+          if (getAliasAssignedEvent(aliasAssignedSignal, deploymentId)) {
+            continue polling;
+          }
+          continue;
+        }
         break;
       }
-      const retryAfterMs = parseRetryAfterMs(deploymentResponse);
-      if (retryAfterMs != null) {
-        const randomSkewMs = Math.floor(RETRY_DELAY_SKEW_MS * Math.random());
-        debug(
-          `Received a transient error or rate limit (HTTP ${deploymentResponse.status}) while querying deployment status, retrying after ${retryAfterMs + randomSkewMs}ms (${retryAfterMs} + ${randomSkewMs}ms of random skew)`
-        );
-        await (0, import_sleep_promise.default)(retryAfterMs + randomSkewMs);
+      let deploymentUpdate;
+      try {
+        deploymentUpdate = await deploymentResponse.json();
+      } catch (error) {
+        if (getAliasAssignedEvent(aliasAssignedSignal, deploymentId))
+          continue;
+        if (aliasAssignedSignal?.aborted) {
+          aliasAssignedSignal = void 0;
+          continue;
+        }
+        throw error;
+      }
+      if (getAliasAssignedEvent(aliasAssignedSignal, deploymentId))
         continue;
+      if (deploymentUpdate.error) {
+        debug("Deployment status check has errorred");
+        return yield { type: "error", payload: deploymentUpdate.error };
       }
-      break;
-    }
-    const deploymentUpdate = await deploymentResponse.json();
-    if (deploymentUpdate.error) {
-      debug("Deployment status check has errorred");
-      return yield { type: "error", payload: deploymentUpdate.error };
-    }
-    if (deploymentUpdate.readyState === "BUILDING" && !finishedEvents.has("building")) {
-      debug("Deployment state changed to BUILDING");
-      finishedEvents.add("building");
-      yield { type: "building", payload: deploymentUpdate };
-    }
-    if (deploymentUpdate.readyState === "CANCELED" && !finishedEvents.has("canceled")) {
-      debug("Deployment state changed to CANCELED");
-      finishedEvents.add("canceled");
-      yield { type: "canceled", payload: deploymentUpdate };
-    }
-    if ((0, import_ready_state.isReady)(deploymentUpdate) && !finishedEvents.has("ready")) {
-      debug("Deployment state changed to READY");
-      finishedEvents.add("ready");
-      yield { type: "ready", payload: deploymentUpdate };
-    }
-    if (deploymentUpdate.checksState !== void 0) {
-      if (deploymentUpdate.checksState === "completed" && !finishedEvents.has("checks-completed")) {
-        finishedEvents.add("checks-completed");
-        if (deploymentUpdate.checksConclusion === "succeeded") {
-          yield {
-            type: "checks-conclusion-succeeded",
-            payload: deploymentUpdate
-          };
-        } else if (deploymentUpdate.checksConclusion === "failed") {
-          yield { type: "checks-conclusion-failed", payload: deploymentUpdate };
-        } else if (deploymentUpdate.checksConclusion === "skipped") {
-          yield {
-            type: "checks-conclusion-skipped",
-            payload: deploymentUpdate
-          };
-        } else if (deploymentUpdate.checksConclusion === "canceled") {
-          yield {
-            type: "checks-conclusion-canceled",
-            payload: deploymentUpdate
-          };
+      deploymentState = deploymentUpdate;
+      if (deploymentUpdate.readyState === "BUILDING" && !finishedEvents.has("building")) {
+        debug("Deployment state changed to BUILDING");
+        finishedEvents.add("building");
+        yield { type: "building", payload: deploymentUpdate };
+      }
+      if (deploymentUpdate.readyState === "CANCELED" && !finishedEvents.has("canceled")) {
+        debug("Deployment state changed to CANCELED");
+        finishedEvents.add("canceled");
+        yield { type: "canceled", payload: deploymentUpdate };
+      }
+      if ((0, import_ready_state.isReady)(deploymentUpdate) && !finishedEvents.has("ready")) {
+        debug("Deployment state changed to READY");
+        finishedEvents.add("ready");
+        yield { type: "ready", payload: deploymentUpdate };
+      }
+      if (deploymentUpdate.checksState !== void 0) {
+        if (deploymentUpdate.checksState === "completed" && !finishedEvents.has("checks-completed")) {
+          finishedEvents.add("checks-completed");
+          if (deploymentUpdate.checksConclusion === "succeeded") {
+            yield {
+              type: "checks-conclusion-succeeded",
+              payload: deploymentUpdate
+            };
+          } else if (deploymentUpdate.checksConclusion === "failed") {
+            yield { type: "checks-conclusion-failed", payload: deploymentUpdate };
+          } else if (deploymentUpdate.checksConclusion === "skipped") {
+            yield {
+              type: "checks-conclusion-skipped",
+              payload: deploymentUpdate
+            };
+          } else if (deploymentUpdate.checksConclusion === "canceled") {
+            yield {
+              type: "checks-conclusion-canceled",
+              payload: deploymentUpdate
+            };
+          }
+        }
+        if (deploymentUpdate.checksState === "registered" && !finishedEvents.has("checks-registered")) {
+          finishedEvents.add("checks-registered");
+          yield { type: "checks-registered", payload: deploymentUpdate };
+        }
+        if (deploymentUpdate.checksState === "running" && !finishedEvents.has("checks-running")) {
+          finishedEvents.add("checks-running");
+          yield { type: "checks-running", payload: deploymentUpdate };
         }
       }
-      if (deploymentUpdate.checksState === "registered" && !finishedEvents.has("checks-registered")) {
-        finishedEvents.add("checks-registered");
-        yield { type: "checks-registered", payload: deploymentUpdate };
+      if (deploymentUpdate.checks?.["deployment-alias"]?.state === "failed" && !finishedEvents.has("checks-v2-failed")) {
+        debug("v2 deployment-alias check failed");
+        finishedEvents.add("checks-v2-failed");
+        return yield {
+          type: "checks-v2-failed",
+          payload: deploymentUpdate
+        };
       }
-      if (deploymentUpdate.checksState === "running" && !finishedEvents.has("checks-running")) {
-        finishedEvents.add("checks-running");
-        yield { type: "checks-running", payload: deploymentUpdate };
+      if ((0, import_ready_state.isAliasAssigned)(deploymentUpdate)) {
+        debug("Deployment alias assigned");
+        return yield { type: "alias-assigned", payload: deploymentUpdate };
       }
+      if ((0, import_ready_state.isAliasError)(deploymentUpdate)) {
+        return yield { type: "error", payload: deploymentUpdate.aliasError };
+      }
+      if (deploymentUpdate.readyState === "ERROR" && deploymentUpdate.errorCode === "BUILD_FAILED") {
+        return yield { type: "error", payload: deploymentUpdate };
+      }
+      if ((0, import_ready_state.isFailed)(deploymentUpdate)) {
+        return yield {
+          type: "error",
+          payload: deploymentUpdate.error || deploymentUpdate
+        };
+      }
+      const elapsed = Date.now() - startTime;
+      const duration = (0, import_get_polling_delay.getPollingDelay)(elapsed);
+      await sleepUntilAliasAssigned(duration, aliasAssignedSignal, deploymentId);
     }
-    if (deploymentUpdate.checks?.["deployment-alias"]?.state === "failed" && !finishedEvents.has("checks-v2-failed")) {
-      debug("v2 deployment-alias check failed");
-      finishedEvents.add("checks-v2-failed");
-      return yield {
-        type: "checks-v2-failed",
-        payload: deploymentUpdate
-      };
-    }
-    if ((0, import_ready_state.isAliasAssigned)(deploymentUpdate)) {
-      debug("Deployment alias assigned");
-      return yield { type: "alias-assigned", payload: deploymentUpdate };
-    }
-    if ((0, import_ready_state.isAliasError)(deploymentUpdate)) {
-      return yield { type: "error", payload: deploymentUpdate.aliasError };
-    }
-    if (deploymentUpdate.readyState === "ERROR" && deploymentUpdate.errorCode === "BUILD_FAILED") {
-      return yield { type: "error", payload: deploymentUpdate };
-    }
-    if ((0, import_ready_state.isFailed)(deploymentUpdate)) {
-      return yield {
-        type: "error",
-        payload: deploymentUpdate.error || deploymentUpdate
-      };
-    }
-    const elapsed = Date.now() - startTime;
-    const duration = (0, import_get_polling_delay.getPollingDelay)(elapsed);
-    await (0, import_sleep_promise.default)(duration);
-  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/types.d.ts

@@ -7,6 +7,22 @@ export interface Dictionary<T> {
 }
 export declare const VALID_ARCHIVE_FORMATS: readonly ["tgz"];
 export type ArchiveFormat = (typeof VALID_ARCHIVE_FORMATS)[number];
+export interface DeploymentAliasError {
+    code: string;
+    message: string;
+}
+export interface DeploymentAliasWarning extends DeploymentAliasError {
+    link?: string;
+    action?: string;
+}
+export interface DeploymentAliasAssignedEvent {
+    type: 'alias-assigned';
+    deploymentId: string;
+    date: number;
+    alias: string[];
+    aliasError: DeploymentAliasError | null;
+    aliasWarning: DeploymentAliasWarning | null;
+}
 export interface VercelClientOptions {
     token: string;
     path: string | string[];
@@ -35,6 +51,11 @@ export interface VercelClientOptions {
      * that the user later continues the deployment with an API call.
      */
     manual?: boolean;
+    /**
+     * Aborted with a `DeploymentAliasAssignedEvent` when an existing deployment
+     * event stream observes alias assignment.
+     */
+    aliasAssignedSignal?: AbortSignal;
 }
 /** @deprecated Use VercelClientOptions instead. */
 export type NowClientOptions = VercelClientOptions;
@@ -73,8 +94,9 @@ export interface Deployment {
     };
     target: string;
     alias: string[];
-    aliasAssigned: boolean;
-    aliasError: string | null;
+    aliasAssigned: boolean | number | null;
+    aliasError: string | DeploymentAliasError | null;
+    aliasWarning?: DeploymentAliasWarning | null;
     checks?: Record<string, {
         state: 'pending' | 'succeeded' | 'failed';
         startedAt?: string;

package/dist/utils/index.d.ts

@@ -6,7 +6,7 @@ type Ignore = ReturnType<typeof ignore>;
 export declare const API_FILES = "/v2/files";
 declare const EVENTS_ARRAY: readonly ["hashes-calculated", "file-count", "file-uploaded", "all-files-uploaded", "created", "building", "ready", "alias-assigned", "warning", "error", "notice", "tip", "canceled", "checks-registered", "checks-completed", "checks-running", "checks-conclusion-succeeded", "checks-conclusion-failed", "checks-conclusion-skipped", "checks-conclusion-canceled", "checks-v2-failed"];
 export type DeploymentEventType = (typeof EVENTS_ARRAY)[number];
-export declare const EVENTS: Set<"hashes-calculated" | "file-count" | "file-uploaded" | "all-files-uploaded" | "created" | "building" | "ready" | "alias-assigned" | "warning" | "error" | "notice" | "tip" | "canceled" | "checks-registered" | "checks-completed" | "checks-running" | "checks-conclusion-succeeded" | "checks-conclusion-failed" | "checks-conclusion-skipped" | "checks-conclusion-canceled" | "checks-v2-failed">;
+export declare const EVENTS: Set<"alias-assigned" | "hashes-calculated" | "file-count" | "file-uploaded" | "all-files-uploaded" | "created" | "building" | "ready" | "warning" | "error" | "notice" | "tip" | "canceled" | "checks-registered" | "checks-completed" | "checks-running" | "checks-conclusion-succeeded" | "checks-conclusion-failed" | "checks-conclusion-skipped" | "checks-conclusion-canceled" | "checks-v2-failed">;
 export declare function getApiDeploymentsUrl(): string;
 export declare function parseVercelConfig(filePath?: string): Promise<VercelConfig>;
 export declare function buildFileTree(path: string | string[], { isDirectory, prebuilt, vercelOutputDir, rootDirectory, projectName, bulkRedirectsPath, }: Pick<VercelClientOptions, 'isDirectory' | 'prebuilt' | 'vercelOutputDir' | 'rootDirectory' | 'projectName' | 'bulkRedirectsPath'>, debug: Debug): Promise<{

package/dist/utils/index.js

@@ -322,10 +322,13 @@ const fetchApi = async (url, token, opts = {}, debugEnabled) => {
   };
   debug(`${opts.method || "GET"} ${url}`);
   time = Date.now();
-  const res = await (0, import_node_fetch.default)(url, opts);
-  debug(`DONE in ${Date.now() - time}ms: ${opts.method || "GET"} ${url}`);
-  semaphore.release();
-  return res;
+  try {
+    const res = await (0, import_node_fetch.default)(url, opts);
+    debug(`DONE in ${Date.now() - time}ms: ${opts.method || "GET"} ${url}`);
+    return res;
+  } finally {
+    semaphore.release();
+  }
 };
 const isWin = process.platform.includes("win");
 const prepareFiles = (files, clientOptions) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/client",
-  "version": "17.6.3",
+  "version": "17.6.5",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "homepage": "https://vercel.com",
@@ -39,9 +39,9 @@
     "querystring": "^0.2.0",
     "sleep-promise": "8.0.1",
     "tar-fs": "1.16.3",
-    "@vercel/build-utils": "13.32.2",
-    "@vercel/routing-utils": "6.4.0",
-    "@vercel/error-utils": "2.2.0"
+    "@vercel/build-utils": "13.33.0",
+    "@vercel/error-utils": "2.2.0",
+    "@vercel/routing-utils": "6.4.0"
   },
   "scripts": {
     "build": "node ../../utils/build.mjs",