@qawolf/ci-sdk 2.2.0 → 2.6.0

package/dist/index.js

@@ -1,3 +1,4 @@
+/* Built with @qawolf/platform-builder@1.2.2 */
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
@@ -12,10 +13,7 @@ function pluralize(count) {
 __name(pluralize, "pluralize");
 var buildFetchWithTimeout = /* @__PURE__ */ __name((fetch, defaultTimeoutMs) => async (...args) => {
   const signal = args[1]?.signal ?? AbortSignal.timeout(defaultTimeoutMs);
-  return fetch(args[0], {
-    ...args[1],
-    signal
-  });
+  return fetch(args[0], { ...args[1], signal });
 }, "buildFetchWithTimeout");
 
 // src/lib/sdk/defaults/fetch.ts
@@ -39,13 +37,61 @@ var defaultServiceBase = "https://app.qawolf.com/";
 
 // package.json
 var package_default = {
-  version: "2.2.0"};
+  name: "@qawolf/ci-sdk",
+  version: "2.6.0",
+  private: false,
+  description: "A simple SDK for interacting with QAWolf in CI scripts.",
+  keywords: [],
+  license: "MIT",
+  author: "Jules Sam. Randolph<jules@qawolf.com>",
+  files: [
+    "/dist",
+    "/README.md"
+  ],
+  type: "module",
+  sideEffects: false,
+  exports: {
+    ".": {
+      types: "./dist/index.d.ts",
+      require: "./dist/index.cjs",
+      import: "./dist/index.js",
+      default: "./dist/index.js"
+    }
+  },
+  scripts: {
+    build: "platform-builder --config platformBuilder.config.ts --config platformBuilder.cjs.config.ts",
+    "lint:ci": "npm run lint:first-half; FIRST_HALF_EXIT=$?; npm run lint:second-half && exit $FIRST_HALF_EXIT",
+    "lint:dev": "npm run lint:first-half",
+    "lint:first-half": "eslint . --fix --quiet && oxfmt --write .",
+    "lint:second-half": "dpdm --exit-code circular:1 --no-tree --no-warning --transform --include='.*' --exclude='/(dist|node_modules)/' '**/*'",
+    prepublishOnly: "nx run ci-sdk:build",
+    test: 'NODE_OPTIONS="--experimental-vm-modules" NODE_NO_WARNINGS=1 jest',
+    "tsc:check": "tsc --noEmit"
+  },
+  dependencies: {
+    "@qawolf/ci-utils": "^1.1.2",
+    "@sinonjs/fake-timers": "^10.3.0",
+    tslib: "^2.6.2"
+  },
+  devDependencies: {
+    "@qawolf/platform-builder": "^1.2.2",
+    tsx: "^4.19.4",
+    typescript: "^5.9.3"
+  },
+  engines: {
+    node: ">=20"
+  }
+};
 
 // src/lib/sdk/defaults/userAgent.ts
 var defaultUserAgent = `ci-sdk/${package_default.version}`;
 
 // src/lib/api/log.ts
-async function logFetchError({ log, methodName, response }) {
+async function logFetchError({
+  log,
+  methodName,
+  response
+}) {
   if (response.ok) return;
   const { eventId, failureMessage } = await (async () => {
     try {
@@ -70,7 +116,9 @@ async function logFetchError({ log, methodName, response }) {
   const eventIdSuffix = eventId ? ` (Event ID: ${eventId})` : "";
   const messageSuffix = failureMessage ? `: ${failureMessage}` : "";
   const statusText = response.status >= 500 ? "Server Error" : response.statusText || "Unknown Error";
-  log.error(`\u274C [${methodName}] ${response.status} ${statusText}${eventIdSuffix}${messageSuffix}`);
+  log.error(
+    `\u274C [${methodName}] ${response.status} ${statusText}${eventIdSuffix}${messageSuffix}`
+  );
 }
 __name(logFetchError, "logFetchError");
 
@@ -80,6 +128,7 @@ async function handleSuccessResponse(data, log) {
   const skippedTriggers = data.skippedTriggers ?? [];
   const skippedDeployment = data.skippedDeployment;
   const isPreviewDeployment = environment && !environment.isStatic;
+  if (data.warning) log.warn(`\u26A0\uFE0F ${data.warning}`);
   if (environment) {
     const logPrefix = environment.isStatic ? "Static environment" : "Preview environment";
     log.info(`${logPrefix}: ${environment.alias} (id: ${environment.id})`);
@@ -87,13 +136,13 @@ async function handleSuccessResponse(data, log) {
   if (results.length === 0) {
     const skipMessages = [
       ...skippedTriggers.map((trigger) => trigger.message),
-      ...skippedDeployment ? [
-        skippedDeployment.message
-      ] : []
+      ...skippedDeployment ? [skippedDeployment.message] : []
     ];
     const skipDetail = skipMessages.length > 0 ? ` ${skipMessages.join(" ")}` : "";
     if (isPreviewDeployment) {
-      log.info(`\u2705 Deployment notification was successful. No run was created for this deployment.${skipDetail}`);
+      log.info(
+        `\u2705 Deployment notification was successful. No run was created for this deployment.${skipDetail}`
+      );
       return {
         environmentId: environment.id,
         outcome: "success",
@@ -108,7 +157,9 @@ async function handleSuccessResponse(data, log) {
         skippedTriggers
       };
     }
-    log.warn(skippedDeployment ? `\u26A0\uFE0F No run was created for this deployment.${skipDetail}` : `\u26A0\uFE0F No trigger matched the request. Please make sure there is at least one active test in the QA Wolf environment, or contact support.`);
+    log.warn(
+      skippedDeployment ? `\u26A0\uFE0F No run was created for this deployment.${skipDetail}` : `\u26A0\uFE0F No trigger matched the request. Please make sure there is at least one active test in the QA Wolf environment, or contact support.`
+    );
     return {
       outcome: "skipped",
       skippedDeployment
@@ -116,45 +167,43 @@ async function handleSuccessResponse(data, log) {
   }
   if (!environment) {
     log.error(`\u{1F6AB} No environment matched the request. Please contact support.`);
-    return {
-      failReason: "no-environment",
-      outcome: "failed"
-    };
+    return { failReason: "no-environment", outcome: "failed" };
   }
   const unrecognizedResult = results.find((result) => "unrecognized" in result);
   if (unrecognizedResult) {
-    log.error(`\u{1F6AB} The deployment response contained an unrecognized result. Please upgrade @qawolf/ci-sdk.`);
-    return {
-      failReason: "unknown-result",
-      outcome: "failed"
-    };
+    log.error(
+      `\u{1F6AB} The deployment response contained an unrecognized result. Please upgrade @qawolf/ci-sdk.`
+    );
+    return { failReason: "unknown-result", outcome: "failed" };
   }
   const failedTrigger = results.find((result) => "failureReason" in result);
   if (failedTrigger) {
-    log.error(`\u{1F6AB} Run could not be created. Reason: "${failedTrigger.failureReason}". Please contact support.`);
-    return {
-      failReason: "run-could-not-be-created",
-      outcome: "failed"
-    };
+    log.error(
+      `\u{1F6AB} Run could not be created. Reason: "${failedTrigger.failureMessage ?? failedTrigger.failureReason}". Please contact support.`
+    );
+    return { failReason: "run-could-not-be-created", outcome: "failed" };
   }
   const duplicateSuite = results.find((result) => "duplicateSuiteId" in result);
   if (duplicateSuite) {
-    log.info(`\u2705 Deployment notification was successful. Previous run ID: ${duplicateSuite.duplicateSuiteId} already exists for this deployment.`);
+    log.info(
+      `\u2705 Deployment notification was successful. Previous run ID: ${duplicateSuite.duplicateSuiteId} already exists for this deployment.`
+    );
     return {
       environmentId: environment.id,
       outcome: "success",
       runId: duplicateSuite.duplicateSuiteId
     };
   }
-  const successfulTrigger = results.find((result) => "createdSuiteId" in result);
+  const successfulTrigger = results.find(
+    (result) => "createdSuiteId" in result
+  );
   if (!successfulTrigger) {
     log.error(`\u{1F6AB} Run could not be created. Please contact support.`);
-    return {
-      failReason: "run-could-not-be-created",
-      outcome: "failed"
-    };
+    return { failReason: "run-could-not-be-created", outcome: "failed" };
   }
-  log.info(`\u2705 Deployment notification was successful. Run created with ID: ${successfulTrigger.createdSuiteId}`);
+  log.info(
+    `\u2705 Deployment notification was successful. Run created with ID: ${successfulTrigger.createdSuiteId}`
+  );
   return {
     environmentId: environment.id,
     outcome: "success",
@@ -165,29 +214,28 @@ __name(handleSuccessResponse, "handleSuccessResponse");
 
 // src/lib/sdk/domain/attemptDeploy/mapDeploySuccessResponse.ts
 function mapSuiteResult(result) {
-  if ("created_suite_id" in result) {
-    return {
-      createdSuiteId: result.created_suite_id,
-      triggerId: result.trigger_id
-    };
-  }
-  if ("failure_reason" in result) {
-    return {
-      failureReason: result.failure_reason,
-      triggerId: result.trigger_id
-    };
-  }
-  if ("duplicate_suite_id" in result) {
-    return {
-      duplicateSuiteId: result.duplicate_suite_id,
-      skipReason: result.skip_reason,
-      triggerId: result.trigger_id
-    };
+  switch (result.outcome) {
+    case "created":
+      return {
+        createdSuiteId: result.created_suite_id,
+        triggerId: result.trigger_id
+      };
+    case "failed":
+      return {
+        failureCode: result.failure_code,
+        failureMessage: result.failure_message,
+        failureReason: result.failure_reason,
+        triggerId: result.trigger_id
+      };
+    case "skipped":
+      return {
+        duplicateSuiteId: result.duplicate_suite_id,
+        skipReason: result.skip_reason,
+        triggerId: result.trigger_id
+      };
+    default:
+      return { triggerId: result.trigger_id, unrecognized: true };
   }
-  return {
-    triggerId: result.trigger_id,
-    unrecognized: true
-  };
 }
 __name(mapSuiteResult, "mapSuiteResult");
 function mapDeploySuccessResponse(wire) {
@@ -203,7 +251,8 @@ function mapDeploySuccessResponse(wire) {
       message: trigger.message,
       reason: trigger.reason,
       triggerId: trigger.trigger_id
-    }))
+    })),
+    warning: wire.warning
   };
 }
 __name(mapDeploySuccessResponse, "mapDeploySuccessResponse");
@@ -213,22 +262,32 @@ function isRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
 __name(isRecord, "isRecord");
+function isOptionalString(value) {
+  return value === void 0 || typeof value === "string";
+}
+__name(isOptionalString, "isOptionalString");
 function isWireSuiteResult(value) {
   if (!isRecord(value)) return false;
   if (typeof value.trigger_id !== "string") return false;
-  if ("created_suite_id" in value) return typeof value.created_suite_id === "string";
-  if ("failure_reason" in value) return typeof value.failure_reason === "string";
-  if ("duplicate_suite_id" in value) {
-    return typeof value.duplicate_suite_id === "string" && typeof value.skip_reason === "string";
+  if (!isOptionalString(value.outcome)) return false;
+  switch (value.outcome) {
+    case "created":
+      return typeof value.created_suite_id === "string";
+    case "failed":
+      return typeof value.failure_reason === "string" && isOptionalString(value.failure_code) && isOptionalString(value.failure_message);
+    case "skipped":
+      return typeof value.duplicate_suite_id === "string" && typeof value.skip_reason === "string";
+    default:
+      return true;
   }
-  return true;
 }
 __name(isWireSuiteResult, "isWireSuiteResult");
 function isEnvironment(value) {
   if (!isRecord(value)) return false;
   if (typeof value.id !== "string") return false;
   if (typeof value.isStatic !== "boolean") return false;
-  if (value.alias !== void 0 && typeof value.alias !== "string") return false;
+  if (value.alias !== void 0 && typeof value.alias !== "string")
+    return false;
   return true;
 }
 __name(isEnvironment, "isEnvironment");
@@ -244,10 +303,15 @@ function isSkippedTrigger(value) {
 __name(isSkippedTrigger, "isSkippedTrigger");
 function isDeploySuccessWireResponse(value) {
   if (!isRecord(value)) return false;
-  if (value.environment !== void 0 && !isEnvironment(value.environment)) return false;
-  if (!Array.isArray(value.results) || !value.results.every(isWireSuiteResult)) return false;
-  if (value.skipped_deployment !== void 0 && !isSkippedDeployment(value.skipped_deployment)) return false;
-  if (value.skipped_triggers !== void 0 && (!Array.isArray(value.skipped_triggers) || !value.skipped_triggers.every(isSkippedTrigger))) return false;
+  if (value.environment !== void 0 && !isEnvironment(value.environment))
+    return false;
+  if (!Array.isArray(value.results) || !value.results.every(isWireSuiteResult))
+    return false;
+  if (value.skipped_deployment !== void 0 && !isSkippedDeployment(value.skipped_deployment))
+    return false;
+  if (value.skipped_triggers !== void 0 && (!Array.isArray(value.skipped_triggers) || !value.skipped_triggers.every(isSkippedTrigger)))
+    return false;
+  if (!isOptionalString(value.warning)) return false;
   return true;
 }
 __name(isDeploySuccessWireResponse, "isDeploySuccessWireResponse");
@@ -262,35 +326,38 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
   let response;
   let bodyText;
   try {
-    response = await localFetch(new URL("/api/webhooks/deploy_success", apiConfig.serviceBase), {
-      body: JSON.stringify({
-        branch: config.branch,
-        commit_url: config.commitUrl,
-        deduplication_key: config.deduplicationKey,
-        deployment_type: config.deploymentType,
-        deployment_url: config.deploymentUrl,
-        ..."ephemeralEnvironment" in config ? {
-          ephemeral_environment: config.ephemeralEnvironment
-        } : "hostingService" in config && {
-          hosting_service: config.hostingService,
-          merge_request_number: config.hostingService === "GitLab" ? config.mergeRequestNumber : void 0,
-          pull_request_number: config.hostingService === "GitHub" ? config.pullRequestNumber : void 0,
-          repository: config.repository
+    response = await localFetch(
+      new URL("/api/webhooks/deploy_success", apiConfig.serviceBase),
+      {
+        body: JSON.stringify({
+          branch: config.branch,
+          commit_url: config.commitUrl,
+          deduplication_key: config.deduplicationKey,
+          deployment_type: config.deploymentType,
+          deployment_url: config.deploymentUrl,
+          ..."ephemeralEnvironment" in config ? {
+            ephemeral_environment: config.ephemeralEnvironment
+          } : "hostingService" in config && {
+            hosting_service: config.hostingService,
+            merge_request_number: config.hostingService === "GitLab" ? config.mergeRequestNumber : void 0,
+            pull_request_number: config.hostingService === "GitHub" ? config.pullRequestNumber : void 0,
+            repository: config.repository
+          },
+          sha: config.sha,
+          variables: config.variables,
+          workspaceId: config.workspaceId
+        }),
+        headers: {
+          Authorization: `Bearer ${apiConfig.apiKey}`,
+          "Content-Type": "application/json",
+          "User-Agent": apiConfig.userAgent
         },
-        sha: config.sha,
-        variables: config.variables,
-        workspaceId: config.workspaceId
-      }),
-      headers: {
-        Authorization: `Bearer ${apiConfig.apiKey}`,
-        "Content-Type": "application/json",
-        "User-Agent": apiConfig.userAgent
-      },
-      method: "POST",
-      // Override default timeout to 5 minutes. This gives extra room
-      // for both (1) waiting for reconciliation (2) creating the run.
-      signal: AbortSignal.timeout(5 * 60 * 1e3)
-    });
+        method: "POST",
+        // Override default timeout to 5 minutes. This gives extra room
+        // for both (1) waiting for reconciliation (2) creating the run.
+        signal: AbortSignal.timeout(5 * 60 * 1e3)
+      }
+    );
     if (!response.ok) return handleErrorResponse(response, log);
     bodyText = await response.text();
   } catch {
@@ -309,7 +376,10 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
   }
   const wire = parseDeploySuccessWireResponse(rawBody);
   if (wire === "invalid") {
-    return abortInvalidResponseBody(log, "the response body did not match the expected shape");
+    return abortInvalidResponseBody(
+      log,
+      "the response body did not match the expected shape"
+    );
   }
   const data = mapDeploySuccessResponse(wire);
   return handleSuccessResponse(data, log);
@@ -350,10 +420,17 @@ var signedUrlPaths = {
   runInputsExecutables: "/api/v0/run-inputs-executables-signed-urls",
   teamStorage: "/api/v0/team-storage-signed-url"
 };
-function buildSignedUrl({ destinationFilePath, endpoint, serviceBase, workspaceId }) {
+function buildSignedUrl({
+  destinationFilePath,
+  endpoint,
+  serviceBase,
+  workspaceId
+}) {
   const url = new URL(signedUrlPaths[endpoint], serviceBase);
-  if (destinationFilePath !== void 0) url.searchParams.set("file", destinationFilePath);
-  if (workspaceId !== void 0) url.searchParams.set("workspaceId", workspaceId);
+  if (destinationFilePath !== void 0)
+    url.searchParams.set("file", destinationFilePath);
+  if (workspaceId !== void 0)
+    url.searchParams.set("workspaceId", workspaceId);
   return url;
 }
 __name(buildSignedUrl, "buildSignedUrl");
@@ -361,19 +438,22 @@ __name(buildSignedUrl, "buildSignedUrl");
 // src/lib/api/generate-signed-url-for-run-inputs-executables.ts
 async function callGenerateSignedUrlForRunInputsExecutablesStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath, workspaceId }, { fetch: localFetch, log }) {
   try {
-    const response = await localFetch(buildSignedUrl({
-      destinationFilePath,
-      endpoint: "runInputsExecutables",
-      serviceBase,
-      workspaceId
-    }), {
-      headers: {
-        Authorization: `Bearer ${apiKey}`,
-        "Content-Type": "application/json",
-        "User-Agent": userAgent
-      },
-      method: "GET"
-    });
+    const response = await localFetch(
+      buildSignedUrl({
+        destinationFilePath,
+        endpoint: "runInputsExecutables",
+        serviceBase,
+        workspaceId
+      }),
+      {
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+          "Content-Type": "application/json",
+          "User-Agent": userAgent
+        },
+        method: "GET"
+      }
+    );
     if (response.status === 200) {
       const json = await response.json();
       return {
@@ -414,18 +494,28 @@ async function generateSignedUrlForRunInputsExecutablesStorage(deps, apiConfig,
       success: false
     };
   }
-  const responseState = await callGenerateSignedUrlForRunInputsExecutablesStorage(apiConfig, config, deps);
+  const responseState = await callGenerateSignedUrlForRunInputsExecutablesStorage(
+    apiConfig,
+    config,
+    deps
+  );
   if (!responseState.success) {
     let abortReason = "XXX-other-http-code";
     if (responseState.httpStatus >= 500) {
       abortReason = "5XX-server-error";
-      log.error(`\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: aborting.`);
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: aborting.`
+      );
     } else {
       if (responseState.httpStatus === 400) abortReason = "400-invalid-request";
-      else if (responseState.httpStatus === 401) abortReason = "401-invalid-credentials";
+      else if (responseState.httpStatus === 401)
+        abortReason = "401-invalid-credentials";
       else if (responseState.httpStatus === 403) abortReason = "403-forbidden";
-      else if (responseState.httpStatus === 0) abortReason = "client-network-error";
-      log.error(`\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: ${responseState.errorMessage ? `${responseState.errorMessage}.` : ""} aborting.`);
+      else if (responseState.httpStatus === 0)
+        abortReason = "client-network-error";
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: ${responseState.errorMessage ? `${responseState.errorMessage}.` : ""} aborting.`
+      );
     }
     return {
       abortReason,
@@ -446,19 +536,22 @@ __name(generateSignedUrlForRunInputsExecutablesStorage, "generateSignedUrlForRun
 // src/lib/api/generate-signed-url-for-team-storage.ts
 async function callGenerateSignedUrlForTempTeamStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath, workspaceId }, { fetch: localFetch, log }) {
   try {
-    const response = await localFetch(buildSignedUrl({
-      destinationFilePath,
-      endpoint: "teamStorage",
-      serviceBase,
-      workspaceId
-    }), {
-      headers: {
-        Authorization: `Bearer ${apiKey}`,
-        "Content-Type": "application/json",
-        "User-Agent": userAgent
-      },
-      method: "GET"
-    });
+    const response = await localFetch(
+      buildSignedUrl({
+        destinationFilePath,
+        endpoint: "teamStorage",
+        serviceBase,
+        workspaceId
+      }),
+      {
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+          "Content-Type": "application/json",
+          "User-Agent": userAgent
+        },
+        method: "GET"
+      }
+    );
     if (response.status === 200) {
       const json = await response.json();
       return {
@@ -499,18 +592,28 @@ async function generateSignedUrlForTempTeamStorage(deps, apiConfig, config) {
       success: false
     };
   }
-  const responseState = await callGenerateSignedUrlForTempTeamStorage(apiConfig, config, deps);
+  const responseState = await callGenerateSignedUrlForTempTeamStorage(
+    apiConfig,
+    config,
+    deps
+  );
   if (!responseState.success) {
     let abortReason = "XXX-other-http-code";
     if (responseState.httpStatus >= 500) {
       abortReason = "5XX-server-error";
-      log.error(`\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: aborting.`);
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: aborting.`
+      );
     } else {
       if (responseState.httpStatus === 400) abortReason = "400-invalid-request";
-      else if (responseState.httpStatus === 401) abortReason = "401-invalid-credentials";
+      else if (responseState.httpStatus === 401)
+        abortReason = "401-invalid-credentials";
       else if (responseState.httpStatus === 403) abortReason = "403-forbidden";
-      else if (responseState.httpStatus === 0) abortReason = "client-network-error";
-      log.error(`\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: ${responseState.errorMessage ? `${responseState.errorMessage}.` : ""} aborting.`);
+      else if (responseState.httpStatus === 0)
+        abortReason = "client-network-error";
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${responseState.httpStatus}) when generating signed upload url: ${responseState.errorMessage ? `${responseState.errorMessage}.` : ""} aborting.`
+      );
     }
     return {
       abortReason,
@@ -532,21 +635,22 @@ __name(generateSignedUrlForTempTeamStorage, "generateSignedUrlForTempTeamStorage
 var notifyTerminatedEphemeralEnvironment = /* @__PURE__ */ __name(async (deps, apiConfig, config) => {
   const { fetch: localFetch, log } = deps;
   try {
-    const response = await localFetch(new URL("/api/webhooks/environment_terminated", apiConfig.serviceBase), {
-      body: JSON.stringify(config),
-      headers: {
-        Authorization: `Bearer ${apiConfig.apiKey}`,
-        "Content-Type": "application/json",
-        "User-Agent": apiConfig.userAgent
-      },
-      method: "POST"
-    });
+    const response = await localFetch(
+      new URL("/api/webhooks/environment_terminated", apiConfig.serviceBase),
+      {
+        body: JSON.stringify(config),
+        headers: {
+          Authorization: `Bearer ${apiConfig.apiKey}`,
+          "Content-Type": "application/json",
+          "User-Agent": apiConfig.userAgent
+        },
+        method: "POST"
+      }
+    );
     if (!response.ok) return handleErrorResponse2(response, log);
-    const { environmentId } = await response.json();
-    return {
-      environmentId,
-      outcome: "success"
-    };
+    const { environmentId, warning } = await response.json();
+    if (warning) log.warn(`\u26A0\uFE0F ${warning}`);
+    return { environmentId, outcome: "success" };
   } catch {
     log.error(`\u{1F6AB} Network error from terminate_preview_environment, aborting.`);
     return {
@@ -579,14 +683,9 @@ __name(handleErrorResponse2, "handleErrorResponse");
 
 // src/lib/sdk/domain/pollCiGreenlight/buildCompletedRunResult.ts
 function buildCompletedRunResult(status) {
-  if (status.greenlight) return {
-    greenlightStatus: status,
-    outcome: "success"
-  };
-  else return {
-    greenlightStatus: status,
-    outcome: "failed"
-  };
+  if (status.greenlight)
+    return { greenlightStatus: status, outcome: "success" };
+  else return { greenlightStatus: status, outcome: "failed" };
 }
 __name(buildCompletedRunResult, "buildCompletedRunResult");
 
@@ -595,20 +694,32 @@ var pollCiGreenlightDefaults = {
   abortOnSuperseded: false,
   maxRetries: 10,
   pollTimeout: 120 * 60 * 1e3,
+  // 2 hours
   retryInterval: 10 * 1e3,
+  // 10 seconds
   runInProgressInterval: 30 * 1e3,
+  // 30 seconds
   runUnderReviewInterval: 60 * 1e3
+  // 60 seconds
 };
 
 // src/lib/api/ci-greenlight.ts
-async function fetchCiGreenlightStatus({ apiKey, serviceBase, userAgent }, { runId }, { fetch: localFetch, log }) {
+async function fetchCiGreenlightStatus({ apiKey, serviceBase, userAgent }, {
+  runId
+}, { fetch: localFetch, log }) {
   try {
-    const resp = await localFetch(new URL(`/api/v0/ci-greenlight/${encodeURIComponent(runId)}`, serviceBase), {
-      headers: {
-        Authorization: `Bearer ${apiKey}`,
-        "User-Agent": userAgent
+    const resp = await localFetch(
+      new URL(
+        `/api/v0/ci-greenlight/${encodeURIComponent(runId)}`,
+        serviceBase
+      ),
+      {
+        headers: {
+          Authorization: `Bearer ${apiKey}`,
+          "User-Agent": userAgent
+        }
       }
-    });
+    );
     if (resp.ok) {
       const greenlightStatus = await resp.json();
       return {
@@ -658,14 +769,22 @@ __name(fetchCiGreenlightStatus, "fetchCiGreenlightStatus");
 // src/lib/sdk/domain/pollCiGreenlight/iterator.ts
 async function* makePollCiGreenlightStatusIterator(deps, apiConfig, { runId, ...pollConfig }) {
   const { log } = deps;
-  const { maxRetries = pollCiGreenlightDefaults.maxRetries, pollTimeout = pollCiGreenlightDefaults.pollTimeout, retryInterval = pollCiGreenlightDefaults.retryInterval, runInProgressInterval = pollCiGreenlightDefaults.runInProgressInterval, runUnderReviewInterval = pollCiGreenlightDefaults.runUnderReviewInterval } = pollConfig;
+  const {
+    maxRetries = pollCiGreenlightDefaults.maxRetries,
+    pollTimeout = pollCiGreenlightDefaults.pollTimeout,
+    retryInterval = pollCiGreenlightDefaults.retryInterval,
+    runInProgressInterval = pollCiGreenlightDefaults.runInProgressInterval,
+    runUnderReviewInterval = pollCiGreenlightDefaults.runUnderReviewInterval
+  } = pollConfig;
   let retries = 0;
   let previousStatus = void 0;
   const startedAt = Date.now();
   while (Date.now() - startedAt <= pollTimeout) {
-    const responseState = await fetchCiGreenlightStatus(apiConfig, {
-      runId
-    }, deps);
+    const responseState = await fetchCiGreenlightStatus(
+      apiConfig,
+      { runId },
+      deps
+    );
     const elapsedMs = Date.now() - startedAt;
     if (!responseState.ok && !responseState.canRetry) {
       yield {
@@ -712,7 +831,8 @@ async function* makePollCiGreenlightStatusIterator(deps, apiConfig, { runId, ...
       }
       const retryLabel = `${httpStatus ? ` (status ${httpStatus})` : ""}, will try again... (${retries}/${maxRetries})`;
       if (errorType === "network") log.warn(`\u274C Network error${retryLabel}`);
-      else if (errorType === "not-found") log.info(`\u23F3 Run not found${retryLabel}`);
+      else if (errorType === "not-found")
+        log.info(`\u23F3 Run not found${retryLabel}`);
       else if (errorType === "server") log.warn(`\u274C Server error${retryLabel}`);
       await sleep(retryInterval);
       continue;
@@ -736,7 +856,9 @@ async function* makePollCiGreenlightStatusIterator(deps, apiConfig, { runId, ...
           abortReason: "run-canceled",
           elapsedMs,
           httpStatus: void 0,
-          isAborted: true
+          isAborted: true,
+          message: greenlightStatus.message,
+          reason: greenlightStatus.reason
         };
         return;
       }
@@ -749,7 +871,9 @@ async function* makePollCiGreenlightStatusIterator(deps, apiConfig, { runId, ...
         await sleep(runUnderReviewInterval);
         break;
       default:
-        throw Error(`Unexpected run stage: ${greenlightStatus}`);
+        throw Error(
+          `Unexpected run stage: ${greenlightStatus}`
+        );
     }
   }
   yield {
@@ -766,12 +890,19 @@ __name(makePollCiGreenlightStatusIterator, "makePollCiGreenlightStatusIterator")
 function buildSuccessLogMessage(status) {
   const { nonBlockingBugsCount, relevantRunUrl } = status;
   const urlInfo = `See ${relevantRunUrl}`;
-  return `\u2705 Run passed and no blocking bugs found${nonBlockingBugsCount > 0 ? ` and ${nonBlockingBugsCount} non-blocking bug${pluralize(nonBlockingBugsCount)} found` : ""}.
+  return `\u2705 Run passed and no blocking bugs found${nonBlockingBugsCount > 0 ? ` and ${nonBlockingBugsCount} non-blocking bug${pluralize(
+    nonBlockingBugsCount
+  )} found` : ""}.
 ${urlInfo}`;
 }
 __name(buildSuccessLogMessage, "buildSuccessLogMessage");
 function buildFailedLogMessage(status) {
-  const { blockingBugsCount, nonBlockingBugsCount, relevantRunWithBugsUrl, reproducedBugs } = status;
+  const {
+    blockingBugsCount,
+    nonBlockingBugsCount,
+    relevantRunWithBugsUrl,
+    reproducedBugs
+  } = status;
   const blockingBugUrls = reproducedBugs.filter((bug) => bug.isBlocking).map((bug) => bug.applicationUrl);
   const nonBlockingBugUrls = reproducedBugs.filter((bug) => !bug.isBlocking).map((bug) => bug.applicationUrl);
   const blockingBugList = blockingBugUrls.map((url) => `
@@ -781,7 +912,11 @@ function buildFailedLogMessage(status) {
   const bugsListInText = `${blockingBugUrls.length > 0 ? `
 BLOCKING BUGS:${blockingBugList}` : ""}${nonBlockingBugUrls.length > 0 ? `
 NON BLOCKING BUGS:${nonBlockingBugList}` : ""}`;
-  return `\u274C Run failed and ${blockingBugsCount} blocking bug${pluralize(blockingBugsCount)} found${nonBlockingBugsCount ? ` and ${nonBlockingBugsCount} non-blocking bug${pluralize(nonBlockingBugsCount)}` : ""}.
+  return `\u274C Run failed and ${blockingBugsCount} blocking bug${pluralize(
+    blockingBugsCount
+  )} found${nonBlockingBugsCount ? ` and ${nonBlockingBugsCount} non-blocking bug${pluralize(
+    nonBlockingBugsCount
+  )}` : ""}.
 See ${relevantRunWithBugsUrl}
 You may review the priority of certain bugs to mark these non-blocking and retry the job.
 ` + bugsListInText;
@@ -801,18 +936,17 @@ function buildSupersededContinueLogMessage(rootRunUrl, relevantRunUrl) {
   return `Root run was superseded:${supersedingDetails}`;
 }
 __name(buildSupersededContinueLogMessage, "buildSupersededContinueLogMessage");
-function buildRunStageLogMessage(runStage, relevantRunUrl) {
+function buildRunStageLogMessage(status) {
+  const { relevantRunUrl, runStage } = status;
   const urlInfo = `See ${relevantRunUrl}`;
   switch (runStage) {
     case "canceled":
-      return `\u{1F6AB} Run was canceled. Aborting... Please contact support.
+      return `\u{1F6AB} Run was canceled. ${status.message || "Aborting... Please contact support."}
 ${urlInfo}`;
     case "initializing":
       return `\u23F3 Run is in progress... ${urlInfo}`;
     case "underReview":
       return `\u{1F575}\uFE0F  Run is under review... ${urlInfo}`;
-    case "completed":
-      throw Error("buildRunStageLogMessage should not be called for completed stage");
     default:
       throw Error(`Unexpected run stage: ${runStage}`);
   }
@@ -825,21 +959,27 @@ function mapIteratorAbortToGreenlightStatus(iteration, pollTimeout, deps) {
   const { abortReason, httpStatus } = iteration;
   switch (abortReason) {
     case "4XX-client-error":
-      log.error(`\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`);
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`
+      );
       return {
         abortReason,
         httpStatus,
         outcome: "aborted"
       };
     case "5XX-server-error":
-      log.error(`\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`);
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`
+      );
       return {
         abortReason,
         httpStatus,
         outcome: "aborted"
       };
     case "404-run-not-found":
-      log.error(`\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`);
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`
+      );
       return {
         abortReason,
         httpStatus,
@@ -860,14 +1000,18 @@ function mapIteratorAbortToGreenlightStatus(iteration, pollTimeout, deps) {
         outcome: "aborted"
       };
     case "run-canceled":
-      log.info(`Run was canceled`);
+      log.info(
+        iteration.message ? `Run was canceled. ${iteration.message}` : `Run was canceled`
+      );
       return {
         abortReason,
         httpStatus: void 0,
         outcome: "aborted"
       };
     case "XXX-other-http-code":
-      log.error(`\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`);
+      log.error(
+        `\u{1F6AB} Unrecoverable error (status ${httpStatus}) from CI greenlight, aborting.`
+      );
       return {
         abortReason,
         httpStatus,
@@ -880,15 +1024,23 @@ function mapIteratorAbortToGreenlightStatus(iteration, pollTimeout, deps) {
 __name(mapIteratorAbortToGreenlightStatus, "mapIteratorAbortToGreenlightStatus");
 
 // src/lib/sdk/domain/pollCiGreenlight/index.ts
-async function pollCiGreenlightStatus(deps, apiConfig, { onRunStageChanged = /* @__PURE__ */ __name(() => void 0, "onRunStageChanged"), runId, ...pollConfig }) {
+async function pollCiGreenlightStatus(deps, apiConfig, {
+  onRunStageChanged = /* @__PURE__ */ __name(() => void 0, "onRunStageChanged"),
+  runId,
+  ...pollConfig
+}) {
   const { log } = deps;
-  const { abortOnSuperseded = pollCiGreenlightDefaults.abortOnSuperseded, pollTimeout = pollCiGreenlightDefaults.pollTimeout } = pollConfig;
+  const {
+    abortOnSuperseded = pollCiGreenlightDefaults.abortOnSuperseded,
+    pollTimeout = pollCiGreenlightDefaults.pollTimeout
+  } = pollConfig;
   const iterator = makePollCiGreenlightStatusIterator(deps, apiConfig, {
     runId,
     ...pollConfig
   });
   for await (const lastPoll of iterator) {
-    if (lastPoll.isAborted) return mapIteratorAbortToGreenlightStatus(lastPoll, pollTimeout, deps);
+    if (lastPoll.isAborted)
+      return mapIteratorAbortToGreenlightStatus(lastPoll, pollTimeout, deps);
     const { previousStatus, stageChanged, status } = lastPoll;
     if (stageChanged) {
       try {
@@ -901,7 +1053,10 @@ async function pollCiGreenlightStatus(deps, apiConfig, { onRunStageChanged = /*
     const isSuperseded = rootRunId !== relevantRunId;
     const shouldAbortOnSuperseded = isSuperseded && abortOnSuperseded;
     if (shouldAbortOnSuperseded) {
-      const message = buildSupersededAbortLogMessage(rootRunUrl, relevantRunUrl);
+      const message = buildSupersededAbortLogMessage(
+        rootRunUrl,
+        relevantRunUrl
+      );
       log.warn(message);
       return {
         abortReason: "superseded-run",
@@ -910,14 +1065,17 @@ async function pollCiGreenlightStatus(deps, apiConfig, { onRunStageChanged = /*
       };
     }
     if (isSuperseded) {
-      const message = buildSupersededContinueLogMessage(rootRunUrl, relevantRunUrl);
+      const message = buildSupersededContinueLogMessage(
+        rootRunUrl,
+        relevantRunUrl
+      );
       log.info(message);
     }
     switch (runStage) {
       case "canceled":
       case "initializing":
       case "underReview": {
-        log.info(buildRunStageLogMessage(runStage, relevantRunUrl));
+        log.info(buildRunStageLogMessage(status));
         break;
       }
       case "completed": {
@@ -950,10 +1108,19 @@ async function pollCiGreenlightStatus(deps, apiConfig, { onRunStageChanged = /*
 __name(pollCiGreenlightStatus, "pollCiGreenlightStatus");
 
 // src/lib/sdk/index.ts
-function makeQaWolfSdk({ apiKey, serviceBase = defaultServiceBase, userAgent = defaultUserAgent }, { fetch = defaultFetch, log = defaultLogDriver } = {}) {
+function makeQaWolfSdk({
+  apiKey,
+  serviceBase = defaultServiceBase,
+  userAgent = defaultUserAgent
+}, {
+  fetch = defaultFetch,
+  log = defaultLogDriver
+} = {}) {
   if (typeof fetch !== "function") {
-    throw Error(`QA Wolf CI-SDK requires fetch to be defined. Make sure you are using NodeJS 18+, OR pass a fetch polyfill to the makeQaWolfSdk function.
-We recommend 'undici' package for that purpose. See the Requirement section of our README for more guidance.`);
+    throw Error(
+      `QA Wolf CI-SDK requires fetch to be defined. Make sure you are using NodeJS 18+, OR pass a fetch polyfill to the makeQaWolfSdk function.
+We recommend 'undici' package for that purpose. See the Requirement section of our README for more guidance.`
+    );
   }
   const deps = {
     // Versions of fetch may have different default timeouts. For consistency, we explicitly set it to 2 minutes here.
@@ -962,22 +1129,26 @@ We recommend 'undici' package for that purpose. See the Requirement section of o
     fetch: buildFetchWithTimeout(fetch, 12e4),
     log
   };
-  const apiConfig = {
-    apiKey,
-    serviceBase,
-    userAgent
-  };
+  const apiConfig = { apiKey, serviceBase, userAgent };
   return {
     attemptNotifyDeploy: attemptNotifyDeploy.bind(null, deps, apiConfig),
-    generateSignedUrlForRunInputsExecutablesStorage: generateSignedUrlForRunInputsExecutablesStorage.bind(null, deps, apiConfig),
+    generateSignedUrlForRunInputsExecutablesStorage: generateSignedUrlForRunInputsExecutablesStorage.bind(
+      null,
+      deps,
+      apiConfig
+    ),
     generateSignedUrlForTempTeamStorage: generateSignedUrlForTempTeamStorage.bind(null, deps, apiConfig),
-    makePollCiGreenlightStatusIterator: makePollCiGreenlightStatusIterator.bind(null, deps, apiConfig),
+    makePollCiGreenlightStatusIterator: makePollCiGreenlightStatusIterator.bind(
+      null,
+      deps,
+      apiConfig
+    ),
     notifyTerminatedEphemeralEnvironment: notifyTerminatedEphemeralEnvironment.bind(null, deps, apiConfig),
     pollCiGreenlightStatus: pollCiGreenlightStatus.bind(null, deps, apiConfig)
   };
 }
 __name(makeQaWolfSdk, "makeQaWolfSdk");
-
-export { makeQaWolfSdk };
+export {
+  makeQaWolfSdk
+};
 //# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map