@qawolf/ci-sdk 1.3.2 → 2.1.0

package/README.md

@@ -113,8 +113,14 @@ const { attemptNotifyDeploy } = makeQaWolfSdk({
 
 (async () => {
   const result = await attemptNotifyDeploy(deployConfig);
+  if (result.outcome === "skipped") {
+    // No trigger matched this deployment, a deterministic no-op rather than a
+    // failure. Let the job pass (or fail here instead if you would rather
+    // catch a trigger misconfiguration).
+    return;
+  }
   if (result.outcome !== "success") {
-    // Fail the job.
+    // "failed" or "aborted": fail the job.
     process.exit(1);
   }
   const runId = result.runId;
@@ -461,6 +467,21 @@ This package follows the [SemVer](https://semver.org/) versioning scheme. Additi
 
 # Changelog
 
+## v2.1.0
+
+- `attemptNotifyDeploy`: the `deploy_success` response is now validated at runtime instead of being trusted. A response with a non-JSON body, or a body that does not match the expected shape, returns `outcome: "aborted"` with the new `abortReason: "invalid-response-body"`. This is distinct from `"network-error"`, which now covers only transport and body-stream failures rather than also masking unparseable responses. A result the SDK does not recognize (for example a new result kind sent by a newer backend) returns `outcome: "failed"` with the new `failReason: "unknown-result"` instead of being reported as a success. Recognized results are unchanged, and older backends that omit newer fields remain fully supported.
+
+## v2.0.0
+
+- `attemptNotifyDeploy`: the `DeployStatus` response now carries `skippedTriggers` (triggers that matched the deployment but produced no run, each with a `reason` code and human-readable `message`) and `skippedDeployment` (set when no trigger matched at all). The result now distinguishes these cases. A trigger that matched but could not run (e.g. the environment was still syncing) returns `outcome: "failed"` with `failReason: "trigger-skipped"` and a `skippedTriggers` array, since a precondition was not met and retrying may succeed. A deployment that matched no trigger returns `outcome: "skipped"` with `skippedDeployment` (the server's reason, when it provides one). That result is deterministic given the current configuration, so it is reported as a skip rather than a failure and is logged as a warning, not an error. Preview deployments keep `outcome: "success"` but now log the skip reason. `outcome: "success"` results are unchanged.
+- `pollCiGreenlightStatus`: the `canceled` `CiGreenlightStatus` object may now include a `reason` code and a human-readable `message` explaining why the run was canceled. These are read off the status directly (via the `onRunStageChanged` callback or `makePollCiGreenlightStatusIterator`); the top-level `pollCiGreenlightStatus` result and logs are unchanged.
+
+BREAKING CHANGES:
+
+- `attemptNotifyDeploy`: a deployment that matched no trigger now returns `outcome: "skipped"` instead of `outcome: "failed"` / `failReason: "no-matched-trigger"`. Callers that switch on `outcome` must handle the new `"skipped"` case; code that treated a no-trigger-match as a failure should decide whether a deterministic no-op should still fail the deploy step. `AttemptDeployFailedReason` no longer includes `"no-matched-trigger"`.
+- `pollCiGreenlightStatus`: on the `initializing` and `canceled` run stages, the fields `relevantRunWithBugsUrl`, `workflowsDisabledAfterRunCount`, `workflowsInRunCount`, and `workflowsUnderInvestigationCount` are now optional, aligning the types with the greenlight API. Code that reads these fields on those stages must handle `undefined`.
+- Removed the deprecated `blockingBugUrls` and `nonBlockingBugUrls` fields and the `CiGreenlightCompletedSuiteDetails` type. Use `reproducedBugs` filtered by `isBlocking`, reading each bug's `applicationUrl`.
+
 ## v1.3.2
 
 - Bump dependencies to address security alerts.

package/dist/index.cjs

@@ -41,7 +41,7 @@ var defaultServiceBase = "https://app.qawolf.com/";
 
 // package.json
 var package_default = {
-  version: "1.3.2"};
+  version: "2.1.0"};
 
 // src/lib/sdk/defaults/userAgent.ts
 var defaultUserAgent = `ci-sdk/${package_default.version}`;
@@ -76,11 +76,195 @@ async function logFetchError({ log, methodName, response }) {
 }
 __name(logFetchError, "logFetchError");
 
+// src/lib/sdk/domain/attemptDeploy/handleSuccessResponse.ts
+async function handleSuccessResponse(data, log) {
+  const { environment, results } = data;
+  const skippedTriggers = data.skippedTriggers ?? [];
+  const skippedDeployment = data.skippedDeployment;
+  const isPreviewDeployment = environment && !environment.isStatic;
+  if (environment) {
+    const logPrefix = environment.isStatic ? "Static environment" : "Preview environment";
+    log.info(`${logPrefix}: ${environment.alias} (id: ${environment.id})`);
+  }
+  if (results.length === 0) {
+    const skipMessages = [
+      ...skippedTriggers.map((trigger) => trigger.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}`);
+      return {
+        environmentId: environment.id,
+        outcome: "success",
+        runId: void 0
+      };
+    }
+    if (skippedTriggers.length > 0) {
+      log.error(`\u{1F6AB} No run was created for this deployment.${skipDetail}`);
+      return {
+        failReason: "trigger-skipped",
+        outcome: "failed",
+        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.`);
+    return {
+      outcome: "skipped",
+      skippedDeployment
+    };
+  }
+  if (!environment) {
+    log.error(`\u{1F6AB} No environment matched the request. Please contact support.`);
+    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"
+    };
+  }
+  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"
+    };
+  }
+  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.`);
+    return {
+      environmentId: environment.id,
+      outcome: "success",
+      runId: duplicateSuite.duplicateSuiteId
+    };
+  }
+  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"
+    };
+  }
+  log.info(`\u2705 Deployment notification was successful. Run created with ID: ${successfulTrigger.createdSuiteId}`);
+  return {
+    environmentId: environment.id,
+    outcome: "success",
+    runId: successfulTrigger.createdSuiteId
+  };
+}
+__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
+    };
+  }
+  return {
+    triggerId: result.trigger_id,
+    unrecognized: true
+  };
+}
+__name(mapSuiteResult, "mapSuiteResult");
+function mapDeploySuccessResponse(wire) {
+  return {
+    environment: wire.environment,
+    results: wire.results.map(mapSuiteResult),
+    skippedDeployment: wire.skipped_deployment && {
+      message: wire.skipped_deployment.message,
+      reason: wire.skipped_deployment.reason
+    },
+    skippedTriggers: wire.skipped_triggers?.map((trigger) => ({
+      environmentId: trigger.environment_id,
+      message: trigger.message,
+      reason: trigger.reason,
+      triggerId: trigger.trigger_id
+    }))
+  };
+}
+__name(mapDeploySuccessResponse, "mapDeploySuccessResponse");
+
+// src/lib/sdk/domain/attemptDeploy/parseDeploySuccessWireResponse.ts
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+__name(isRecord, "isRecord");
+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";
+  }
+  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;
+  return true;
+}
+__name(isEnvironment, "isEnvironment");
+function isSkippedDeployment(value) {
+  if (!isRecord(value)) return false;
+  return typeof value.message === "string" && typeof value.reason === "string";
+}
+__name(isSkippedDeployment, "isSkippedDeployment");
+function isSkippedTrigger(value) {
+  if (!isRecord(value)) return false;
+  return typeof value.environment_id === "string" && typeof value.message === "string" && typeof value.reason === "string" && typeof value.trigger_id === "string";
+}
+__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;
+  return true;
+}
+__name(isDeploySuccessWireResponse, "isDeploySuccessWireResponse");
+function parseDeploySuccessWireResponse(value) {
+  return isDeploySuccessWireResponse(value) ? value : "invalid";
+}
+__name(parseDeploySuccessWireResponse, "parseDeploySuccessWireResponse");
+
 // src/lib/sdk/domain/attemptDeploy/index.ts
 async function attemptNotifyDeploy(deps, apiConfig, config) {
   const { fetch: localFetch, log } = deps;
+  let response;
+  let bodyText;
   try {
-    const response = await localFetch(new URL("/api/webhooks/deploy_success", apiConfig.serviceBase), {
+    response = await localFetch(new URL("/api/webhooks/deploy_success", apiConfig.serviceBase), {
       body: JSON.stringify({
         branch: config.branch,
         commit_url: config.commitUrl,
@@ -109,8 +293,7 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
       signal: AbortSignal.timeout(5 * 60 * 1e3)
     });
     if (!response.ok) return handleErrorResponse(response, log);
-    const data = await response.json();
-    return handleSuccessResponse(data, log);
+    bodyText = await response.text();
   } catch {
     log.error(`\u{1F6AB} Network error from deploy_success, aborting.`);
     return {
@@ -119,8 +302,29 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
       outcome: "aborted"
     };
   }
+  let rawBody;
+  try {
+    rawBody = JSON.parse(bodyText);
+  } catch {
+    return abortInvalidResponseBody(log, "the response body was not JSON");
+  }
+  const wire = parseDeploySuccessWireResponse(rawBody);
+  if (wire === "invalid") {
+    return abortInvalidResponseBody(log, "the response body did not match the expected shape");
+  }
+  const data = mapDeploySuccessResponse(wire);
+  return handleSuccessResponse(data, log);
 }
 __name(attemptNotifyDeploy, "attemptNotifyDeploy");
+function abortInvalidResponseBody(log, detail) {
+  log.error(`\u{1F6AB} Invalid response from deploy_success (${detail}), aborting.`);
+  return {
+    abortReason: "invalid-response-body",
+    httpStatus: void 0,
+    outcome: "aborted"
+  };
+}
+__name(abortInvalidResponseBody, "abortInvalidResponseBody");
 async function handleErrorResponse(response, log) {
   const status = response.status;
   let abortReason;
@@ -141,68 +345,6 @@ async function handleErrorResponse(response, log) {
   };
 }
 __name(handleErrorResponse, "handleErrorResponse");
-async function handleSuccessResponse(data, log) {
-  const { environment, results } = data;
-  const isPreviewDeployment = environment && !environment.isStatic;
-  if (environment) {
-    const logPrefix = environment.isStatic ? "Static environment" : "Preview environment";
-    log.info(`${logPrefix}: ${environment.alias} (id: ${environment.id})`);
-  }
-  if (results.length === 0) {
-    if (isPreviewDeployment) {
-      log.info(`\u2705 Deployment notification was successful. No run was created for this deployment.`);
-      return {
-        environmentId: environment.id,
-        outcome: "success",
-        runId: void 0
-      };
-    }
-    log.error(`\u{1F6AB} No trigger matched the request. Please make sure there is at least one active test in the QA Wolf environment, or contact support.`);
-    return {
-      failReason: "no-matched-trigger",
-      outcome: "failed"
-    };
-  }
-  if (!environment) {
-    log.error(`\u{1F6AB} No environment matched the request. Please contact support.`);
-    return {
-      failReason: "no-environment",
-      outcome: "failed"
-    };
-  }
-  const failedTrigger = results.find((t) => "failure_reason" in t);
-  if (failedTrigger) {
-    log.error(`\u{1F6AB} Run could not be created. Reason: "${failedTrigger.failure_reason}". Please contact support.`);
-    return {
-      failReason: "run-could-not-be-created",
-      outcome: "failed"
-    };
-  }
-  const duplicateSuite = results.find((t) => "duplicate_suite_id" in t);
-  if (duplicateSuite) {
-    log.info(`\u2705 Deployment notification was successful. Previous run ID: ${duplicateSuite.duplicate_suite_id} already exists for this deployment.`);
-    return {
-      environmentId: environment.id,
-      outcome: "success",
-      runId: duplicateSuite.duplicate_suite_id
-    };
-  }
-  const successfulTrigger = results.find((t) => "created_suite_id" in t);
-  if (!successfulTrigger) {
-    log.error(`\u{1F6AB} No trigger matched the request. Please contact support.`);
-    return {
-      failReason: "no-matched-trigger",
-      outcome: "failed"
-    };
-  }
-  log.info(`\u2705 Deployment notification was successful. Run created with ID: ${successfulTrigger.created_suite_id}`);
-  return {
-    environmentId: environment.id,
-    outcome: "success",
-    runId: successfulTrigger.created_suite_id
-  };
-}
-__name(handleSuccessResponse, "handleSuccessResponse");
 
 // src/lib/api/generate-signed-url-for-run-inputs-executables.ts
 async function callGenerateSignedUrlForRunInputsExecutablesStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath }, { fetch: localFetch, log }) {
@@ -607,7 +749,9 @@ ${urlInfo}`;
 }
 __name(buildSuccessLogMessage, "buildSuccessLogMessage");
 function buildFailedLogMessage(status) {
-  const { blockingBugsCount, blockingBugUrls = [], nonBlockingBugsCount, nonBlockingBugUrls = [], relevantRunWithBugsUrl } = 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) => `
 \u2022 ${url}`).join("");
   const nonBlockingBugList = nonBlockingBugUrls.map((url) => `