@qawolf/ci-sdk 1.3.2 → 2.0.0

package/dist/index.d.ts

@@ -63,26 +63,10 @@ type CiGreenlightBugData = {
      * The count of blocking bugs reproduced in the run.
      */
     blockingBugsCount: number;
-    /**
-     * The URLs of the blocking bugs.
-     *
-     * @deprecated This field will be removed in the next major version.
-     * Prefer using `reproducedBugs` filtered by `isBlocking: true`, reading
-     * the `applicationUrl` field.
-     */
-    blockingBugUrls: string[];
     /**
      * The count of non-blocking bugs reproduced in the run.
      */
     nonBlockingBugsCount: number;
-    /**
-     * The URLs of the non-blocking bugs.
-     *
-     * @deprecated This field will be removed in the next major version.
-     * Prefer using `reproducedBugs` filtered by `isBlocking: false`, reading
-     * the `applicationUrl` field.
-     */
-    nonBlockingBugUrls: string[];
     /**
      * Blocking bugs that were not reproduced in this run, but are still
      * opened in the run environment. This may happen when the run only covers a
@@ -91,15 +75,20 @@ type CiGreenlightBugData = {
     otherBlockingBugsInEnvironment: CiGreenlightBugDetails[];
     /**
      * Bugs that were reproduced in this run. This includes newly found bugs.
+     * Filter by `isBlocking` and read `applicationUrl` for blocking /
+     * non-blocking bug URLs.
      */
     reproducedBugs: CiGreenlightBugDetails[];
 };
+
 type CiGreenlightStatusBase = {
     relevantRunId: string;
     relevantRunUrl: string;
-    relevantRunWithBugsUrl: string;
     rootRunId: string;
     rootRunUrl: string;
+};
+type CiGreenlightStatusExtended = {
+    relevantRunWithBugsUrl: string;
     workflowsDisabledAfterRunCount: number;
     workflowsInRunCount: number;
     workflowsUnderInvestigationCount: number;
@@ -111,13 +100,26 @@ type CiGreenlightStatusBase = {
 type CiGreenlightStatus = CiGreenlightStatusBase & (({
     greenlight: boolean;
     runStage: "completed";
-} & CiGreenlightBugData) | ({
+} & CiGreenlightBugData & CiGreenlightStatusExtended) | ({
     greenlight: false;
     runStage: "underReview";
-} & CiGreenlightBugData) | {
+} & CiGreenlightBugData & CiGreenlightStatusExtended) | ({
     greenlight: false;
-    runStage: "initializing" | "underReview" | "canceled";
-});
+    runStage: "initializing";
+} & Partial<CiGreenlightStatusExtended>) | ({
+    greenlight: false;
+    /**
+     * Human-readable copy explaining why the run was canceled, when the
+     * server provides it.
+     */
+    message?: string;
+    /**
+     * Stable, machine-readable code for why the run was canceled, when the
+     * server provides it. Treat as an open set of values.
+     */
+    reason?: string;
+    runStage: "canceled";
+} & Partial<CiGreenlightStatusExtended>));
 
 type GenerateSignedUrlStatus = {
     fileLocation?: string;
@@ -142,10 +144,41 @@ type GenerateSignedUrlResponse = {
     success: boolean;
 };
 
+type WireSuiteResult = {
+    created_suite_id: string;
+    trigger_id: string;
+} | {
+    failure_reason: string;
+    trigger_id: string;
+} | {
+    duplicate_suite_id: string;
+    skip_reason: string;
+    trigger_id: string;
+};
+type DeploySuccessWireResponse = {
+    environment: {
+        alias?: string;
+        id: string;
+        isStatic: boolean;
+    } | undefined;
+    results: WireSuiteResult[];
+    skipped_deployment?: {
+        message: string;
+        reason: string;
+    };
+    skipped_triggers?: {
+        environment_id: string;
+        message: string;
+        reason: string;
+        trigger_id: string;
+    }[];
+};
+
 /**
  * Refer to our official documentation for more information:
  * https://qawolf.notion.site/dd72e46ceb7f451dae4e9ef06f64a2cc
  */
+
 type BaseDeployConfig = {
     branch: string | undefined;
     commitUrl: string | undefined;
@@ -177,19 +210,29 @@ type EphemeralDeployConfig = BaseDeployConfig & {
 };
 type DeployConfig = GitHubDeployConfig | GitLabDeployConfig | EphemeralDeployConfig;
 type DeploySuccessSuiteCreatedResult = {
-    created_suite_id: string;
-    trigger_id: string;
+    createdSuiteId: string;
+    triggerId: string;
 };
 type DeploySuccessSuiteCreationFailureResult = {
-    failure_reason: string;
-    trigger_id: string;
+    failureReason: string;
+    triggerId: string;
 };
 type DeploySuccessSuiteAlreadyExistsResult = {
-    duplicate_suite_id: string;
-    skip_reason: string;
-    trigger_id: string;
+    duplicateSuiteId: string;
+    skipReason: string;
+    triggerId: string;
 };
 type DeploySuccessSuiteResult = DeploySuccessSuiteCreatedResult | DeploySuccessSuiteCreationFailureResult | DeploySuccessSuiteAlreadyExistsResult;
+type DeploySuccessSkippedTrigger = {
+    environmentId: string;
+    message: string;
+    reason: string;
+    triggerId: string;
+};
+type DeploySuccessDeploymentSkipped = {
+    message: string;
+    reason: string;
+};
 type DeployStatus = {
     environment: {
         alias?: string;
@@ -197,6 +240,8 @@ type DeployStatus = {
         isStatic: boolean;
     } | undefined;
     results: Array<DeploySuccessSuiteResult>;
+    skippedDeployment?: DeploySuccessDeploymentSkipped;
+    skippedTriggers?: DeploySuccessSkippedTrigger[];
 };
 type DeployStatusSuccessResponse = {
     data: DeployStatus;
@@ -209,7 +254,6 @@ type DeployStatusErrorResponse = {
     status: number | undefined;
 };
 type DeployStatusResponse = DeployStatusSuccessResponse | DeployStatusErrorResponse;
-type AttemptDeployFailedReason = "no-matched-trigger" | "no-environment" | "run-could-not-be-created" | "duplicate-suite";
 type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error" | "network-error";
 type AttemptDeployNonHttpAbortReason = "network-error";
 type AttemptDeployAbortReason = AttemptDeployHttpAbortReason | AttemptDeployNonHttpAbortReason;
@@ -227,7 +271,29 @@ type NotifyDeployStatus = {
      */
     runId: string | undefined;
 } | {
-    failReason: AttemptDeployFailedReason;
+    /**
+     * One or more triggers matched the deployment but could not run (e.g. the
+     * environment was still syncing). A precondition was not met, so this is a
+     * failure rather than a skip: retrying once the environment is ready may
+     * create a run.
+     */
+    failReason: "trigger-skipped";
+    outcome: "failed";
+    skippedTriggers: DeploySuccessSkippedTrigger[];
+} | {
+    /**
+     * No trigger matched the deployment. This is deterministic given the
+     * current configuration (repeating the request with the same config
+     * yields the same result), so it is a skip rather than a failure, and the
+     * caller should not treat it as an error. `skippedDeployment` carries the
+     * server's reason when it provided one (undefined on older servers or the
+     * legacy arm); there is no separate SDK-level reason code, since
+     * `outcome: "skipped"` only ever means no trigger matched.
+     */
+    outcome: "skipped";
+    skippedDeployment: DeploySuccessDeploymentSkipped | undefined;
+} | {
+    failReason: "no-environment" | "run-could-not-be-created";
     /**
      * A run could not be created.
      */
@@ -247,6 +313,9 @@ type NotifyDeployStatus = {
      */
     outcome: "aborted";
 };
+type AttemptDeployFailedReason = Extract<NotifyDeployStatus, {
+    outcome: "failed";
+}>["failReason"];
 
 type NotifyTerminatedEphemeralEnvironmentInput = {
     environmentId: string;
@@ -455,4 +524,4 @@ declare function makeQaWolfSdk({ apiKey, serviceBase, userAgent, }: {
     pollCiGreenlightStatus: (args_0: PollCiGreenlightParams) => Promise<PollCiGreenlightStatus>;
 };
 
-export { type AttemptDeployAbortReason, type AttemptDeployFailedReason, type AttemptDeployHttpAbortReason, type AttemptDeployNonHttpAbortReason, type CiGreenlightStatus, type CiGreenlightStatusBase, type DeployConfig, type DeployStatus, type DeployStatusErrorResponse, type DeployStatusResponse, type DeployStatusSuccessResponse, type DeploySuccessSuiteAlreadyExistsResult, type DeploySuccessSuiteCreatedResult, type DeploySuccessSuiteCreationFailureResult, type DeploySuccessSuiteResult, type EphemeralDeployConfig, type FetchDriver, type GenerateSignedUrlAbortReason$1 as GenerateSignedUrlAbortReason, type GenerateSignedUrlConfig, type GenerateSignedUrlResponse, type GenerateSignedUrlStatus, type GitHubDeployConfig, type GitLabDeployConfig, type MakePollCiGreenlightStatusIteratorParams, type NotifyDeployStatus, type NotifyTerminatedEphemeralEnvironmentAbortReason, type NotifyTerminatedEphemeralEnvironmentFailedReason, type NotifyTerminatedEphemeralEnvironmentHttpAbortReason, type NotifyTerminatedEphemeralEnvironmentInput, type NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason, type NotifyTerminatedEphemeralEnvironmentResult, type PollCiGreenlightAbortReason, type PollCiGreenlightHttpAbortReason, type PollCiGreenlightIteration, type PollCiGreenlightIteratorHttpAborted, type PollCiGreenlightIteratorNonHttpAborted, type PollCiGreenlightNonHttpAbortReason, type PollCiGreenlightParams, type PollCiGreenlightPollConfig, type PollCiGreenlightStatus, type PollCiGreenlightStatusIteration, type SdkDependencies, type TerminatedEphemeralEnvironmentSuccessResult, attemptNotifyDeploy, makeQaWolfSdk };
+export { type AttemptDeployAbortReason, type AttemptDeployFailedReason, type AttemptDeployHttpAbortReason, type AttemptDeployNonHttpAbortReason, type CiGreenlightStatus, type CiGreenlightStatusBase, type DeployConfig, type DeployStatus, type DeployStatusErrorResponse, type DeployStatusResponse, type DeployStatusSuccessResponse, type DeploySuccessDeploymentSkipped, type DeploySuccessSkippedTrigger, type DeploySuccessSuiteAlreadyExistsResult, type DeploySuccessSuiteCreatedResult, type DeploySuccessSuiteCreationFailureResult, type DeploySuccessSuiteResult, type DeploySuccessWireResponse, type EphemeralDeployConfig, type FetchDriver, type GenerateSignedUrlAbortReason$1 as GenerateSignedUrlAbortReason, type GenerateSignedUrlConfig, type GenerateSignedUrlResponse, type GenerateSignedUrlStatus, type GitHubDeployConfig, type GitLabDeployConfig, type MakePollCiGreenlightStatusIteratorParams, type NotifyDeployStatus, type NotifyTerminatedEphemeralEnvironmentAbortReason, type NotifyTerminatedEphemeralEnvironmentFailedReason, type NotifyTerminatedEphemeralEnvironmentHttpAbortReason, type NotifyTerminatedEphemeralEnvironmentInput, type NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason, type NotifyTerminatedEphemeralEnvironmentResult, type PollCiGreenlightAbortReason, type PollCiGreenlightHttpAbortReason, type PollCiGreenlightIteration, type PollCiGreenlightIteratorHttpAborted, type PollCiGreenlightIteratorNonHttpAborted, type PollCiGreenlightNonHttpAbortReason, type PollCiGreenlightParams, type PollCiGreenlightPollConfig, type PollCiGreenlightStatus, type PollCiGreenlightStatusIteration, type SdkDependencies, type TerminatedEphemeralEnvironmentSuccessResult, attemptNotifyDeploy, makeQaWolfSdk };

package/dist/index.js

@@ -39,7 +39,7 @@ var defaultServiceBase = "https://app.qawolf.com/";
 
 // package.json
 var package_default = {
-  version: "1.3.2"};
+  version: "2.0.0"};
 
 // src/lib/sdk/defaults/userAgent.ts
 var defaultUserAgent = `ci-sdk/${package_default.version}`;
@@ -74,6 +74,126 @@ 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 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
+    };
+  }
+  return {
+    duplicateSuiteId: result.duplicate_suite_id,
+    skipReason: result.skip_reason,
+    triggerId: result.trigger_id
+  };
+}
+__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/index.ts
 async function attemptNotifyDeploy(deps, apiConfig, config) {
   const { fetch: localFetch, log } = deps;
@@ -107,7 +227,8 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
       signal: AbortSignal.timeout(5 * 60 * 1e3)
     });
     if (!response.ok) return handleErrorResponse(response, log);
-    const data = await response.json();
+    const wire = await response.json();
+    const data = mapDeploySuccessResponse(wire);
     return handleSuccessResponse(data, log);
   } catch {
     log.error(`\u{1F6AB} Network error from deploy_success, aborting.`);
@@ -139,68 +260,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 }) {
@@ -605,7 +664,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) => `