@qawolf/ci-sdk 0.13.0 → 0.14.0

package/README.md

@@ -101,6 +101,12 @@ an up-to-date API usage version.
 
 # Changelog
 
+## v0.14.0
+
+- New `failReason`, `abortReason` and `httpStatus` fields added to the `attemptNotifyDeploy`
+  function result object to provide more context on why the operation failed or was aborted.
+- Exported missing TypeScript typings describing result objects and fields for both functions.
+
 ## v0.13.0
 
 - New `pollTimeout` parameter for `pollCiGreenlightStatus` to allow for a custom
@@ -138,7 +144,7 @@ BREAKING CHANGES:
 
 BREAKING CHANGES:
 
-- Renamed `attemptDeploy` to `attemptNotifyDeploy`.
+- Renamed `attemptDeploy` to `attemptNotifyDeploy` .
 
 ## v0.10.2
 

package/dist/cjs/lib/api/ci-greenlight.js

@@ -35,6 +35,7 @@ async function fetchCiGreenlightStatus({ serviceBase, apiKey }, { runId, }, { fe
         return {
             canRetry: false,
             httpStatus: resp.status,
+            errorType: "client",
             ok: false,
         };
     }

package/dist/cjs/lib/api/deploy.js

@@ -49,27 +49,27 @@ async function postDeploySuccess({ apiKey, serviceBase }, { branch, commitUrl, d
         else {
             if (response.status >= 500) {
                 return {
-                    failureReason: "server-error",
+                    failureReason: "5XX-server-error",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             if (response.status === 401) {
                 return {
-                    failureReason: "unauthorized",
+                    failureReason: "401-unauthorized",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             if (response.status === 403) {
                 return {
-                    failureReason: "forbidden",
+                    failureReason: "403-forbidden",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             return {
-                failureReason: "unrecoverable-error",
+                failureReason: "4XX-client-error",
                 httpStatus: response.status,
                 success: false,
             };

package/dist/cjs/lib/sdk/domain/attempt-deploy.js

@@ -9,29 +9,40 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
     if (!responseState.success) {
         if (responseState.failureReason === "no-matched-trigger") {
             log.error(`🚫 No trigger matched the request. Please contact support.`);
-            return { outcome: "failed" };
+            return { outcome: "failed", failReason: "no-matched-trigger" };
         }
         else if (responseState.failureReason === "run-could-not-be-created") {
             log.error(`🚫 Run could not be created. Reason: "${responseState.details}". Please contact support.`);
-            return { outcome: "failed" };
+            return { outcome: "failed", failReason: "run-could-not-be-created" };
         }
         if (responseState.failureReason === "network-error")
             log.error(`🚫 Network error from deploy_success, aborting.`);
-        else if (responseState.failureReason === "server-error")
+        else if (responseState.failureReason === "5XX-server-error")
             log.error(`🚫 Server error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
-        else if (responseState.failureReason === "unrecoverable-error") {
+        else if (responseState.failureReason === "4XX-client-error") {
             log.error(`🚫 Unrecoverable error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
-        else if (responseState.failureReason === "forbidden") {
+        else if (responseState.failureReason === "403-forbidden") {
             log.error(`🚫 Forbidden error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
-        else if (responseState.failureReason === "unauthorized") {
+        else if (responseState.failureReason === "401-unauthorized") {
             log.error(`🚫 Unauthorized error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
         else {
             (0, utils_js_1.assertType)(responseState);
         }
-        return { outcome: "aborted" };
+        if (responseState.failureReason === "network-error") {
+            return {
+                outcome: "aborted",
+                abortReason: "network-error",
+                httpStatus: undefined,
+            };
+        }
+        return {
+            outcome: "aborted",
+            abortReason: responseState.failureReason,
+            httpStatus: responseState.httpStatus,
+        };
     }
     log.info(`✅ Run created with ID: ${responseState.runId}`);
     return {

package/dist/esm/lib/api/ci-greenlight.js

@@ -32,6 +32,7 @@ export async function fetchCiGreenlightStatus({ serviceBase, apiKey }, { runId,
         return {
             canRetry: false,
             httpStatus: resp.status,
+            errorType: "client",
             ok: false,
         };
     }

package/dist/esm/lib/api/deploy.js

@@ -46,27 +46,27 @@ export async function postDeploySuccess({ apiKey, serviceBase }, { branch, commi
         else {
             if (response.status >= 500) {
                 return {
-                    failureReason: "server-error",
+                    failureReason: "5XX-server-error",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             if (response.status === 401) {
                 return {
-                    failureReason: "unauthorized",
+                    failureReason: "401-unauthorized",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             if (response.status === 403) {
                 return {
-                    failureReason: "forbidden",
+                    failureReason: "403-forbidden",
                     httpStatus: response.status,
                     success: false,
                 };
             }
             return {
-                failureReason: "unrecoverable-error",
+                failureReason: "4XX-client-error",
                 httpStatus: response.status,
                 success: false,
             };

package/dist/esm/lib/sdk/domain/attempt-deploy.js

@@ -6,29 +6,40 @@ export async function attemptNotifyDeploy(deps, apiConfig, config) {
     if (!responseState.success) {
         if (responseState.failureReason === "no-matched-trigger") {
             log.error(`🚫 No trigger matched the request. Please contact support.`);
-            return { outcome: "failed" };
+            return { outcome: "failed", failReason: "no-matched-trigger" };
         }
         else if (responseState.failureReason === "run-could-not-be-created") {
             log.error(`🚫 Run could not be created. Reason: "${responseState.details}". Please contact support.`);
-            return { outcome: "failed" };
+            return { outcome: "failed", failReason: "run-could-not-be-created" };
         }
         if (responseState.failureReason === "network-error")
             log.error(`🚫 Network error from deploy_success, aborting.`);
-        else if (responseState.failureReason === "server-error")
+        else if (responseState.failureReason === "5XX-server-error")
             log.error(`🚫 Server error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
-        else if (responseState.failureReason === "unrecoverable-error") {
+        else if (responseState.failureReason === "4XX-client-error") {
             log.error(`🚫 Unrecoverable error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
-        else if (responseState.failureReason === "forbidden") {
+        else if (responseState.failureReason === "403-forbidden") {
             log.error(`🚫 Forbidden error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
-        else if (responseState.failureReason === "unauthorized") {
+        else if (responseState.failureReason === "401-unauthorized") {
             log.error(`🚫 Unauthorized error from deploy_success (status ${responseState.httpStatus}), aborting. Please contact support.`);
         }
         else {
             assertType(responseState);
         }
-        return { outcome: "aborted" };
+        if (responseState.failureReason === "network-error") {
+            return {
+                outcome: "aborted",
+                abortReason: "network-error",
+                httpStatus: undefined,
+            };
+        }
+        return {
+            outcome: "aborted",
+            abortReason: responseState.failureReason,
+            httpStatus: responseState.httpStatus,
+        };
     }
     log.info(`✅ Run created with ID: ${responseState.runId}`);
     return {

package/dist/types/lib/api/ci-greenlight.d.ts

@@ -101,9 +101,9 @@ export declare function fetchCiGreenlightStatus({ serviceBase, apiKey }: ApiConf
 } | {
     readonly canRetry: false;
     readonly httpStatus: number;
+    readonly errorType: "client";
     readonly ok: false;
     readonly greenlightStatus?: never;
-    readonly errorType?: never;
 } | {
     readonly canRetry: true;
     readonly errorType: "network";

package/dist/types/lib/api/deploy.d.ts

@@ -39,25 +39,25 @@ export declare function postDeploySuccess({ apiKey, serviceBase }: ApiConfig, {
     readonly details?: never;
     readonly httpStatus?: never;
 } | {
-    readonly failureReason: "server-error";
+    readonly failureReason: "5XX-server-error";
     readonly httpStatus: number;
     readonly success: false;
     readonly details?: never;
     readonly runId?: never;
 } | {
-    readonly failureReason: "unauthorized";
+    readonly failureReason: "401-unauthorized";
     readonly httpStatus: 401;
     readonly success: false;
     readonly details?: never;
     readonly runId?: never;
 } | {
-    readonly failureReason: "forbidden";
+    readonly failureReason: "403-forbidden";
     readonly httpStatus: 403;
     readonly success: false;
     readonly details?: never;
     readonly runId?: never;
 } | {
-    readonly failureReason: "unrecoverable-error";
+    readonly failureReason: "4XX-client-error";
     readonly httpStatus: number;
     readonly success: false;
     readonly details?: never;

package/dist/types/lib/sdk/domain/attempt-deploy.d.ts

@@ -1,6 +1,10 @@
 import { DeployConfig } from "../../api/deploy.js";
 import { SdkDependencies } from "../dependencies.js";
 import { ApiConfig } from "../../api-types.js";
+export type AttemptDeployFailedReason = "no-matched-trigger" | "run-could-not-be-created";
+export type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error";
+export type AttemptDeployNonHttpAbortReason = "network-error";
+export type AttemptDeployAbortReason = AttemptDeployHttpAbortReason | AttemptDeployNonHttpAbortReason;
 export type NotifyDeployStatus = {
     /**
      * A run was successfully created.
@@ -12,10 +16,20 @@ export type NotifyDeployStatus = {
      * A run could not be created.
      */
     outcome: "failed";
+    failReason: AttemptDeployFailedReason;
 } | {
     /**
      * An unrecoverable error occurred.
      */
     outcome: "aborted";
+    abortReason: AttemptDeployNonHttpAbortReason;
+    httpStatus: undefined;
+} | {
+    /**
+     * An unrecoverable HTTP error occurred.
+     */
+    outcome: "aborted";
+    abortReason: AttemptDeployHttpAbortReason;
+    httpStatus: number;
 };
 export declare function attemptNotifyDeploy(deps: SdkDependencies, apiConfig: ApiConfig, config: Partial<DeployConfig>): Promise<NotifyDeployStatus>;

package/dist/types/lib/sdk/domain/poll-ci-greenlight.d.ts

@@ -1,7 +1,7 @@
 import { CiGreenlightStatus } from "../../api/ci-greenlight.js";
 import { ApiConfig } from "../../api-types.js";
 import { SdkDependencies } from "../dependencies.js";
-export type PollConfig = {
+export type PollCiGreenlightPollConfig = {
     /**
      * Maximum number of network operations retries before aborting the job.
      *
@@ -33,9 +33,9 @@ export type PollConfig = {
      */
     pollTimeout: number;
 };
-export type HttpRelatedAbortReason = "4XX-client-error" | "404-run-not-found" | "5XX-server-error" | "XXX-other-http-code";
-export type NonHttpRelatedAbortReason = "poll-timed-out" | "run-canceled" | "network-error";
-export type AbortReason = NonHttpRelatedAbortReason | HttpRelatedAbortReason;
+export type PollCiGreenlightHttpAbortReason = "4XX-client-error" | "404-run-not-found" | "5XX-server-error" | "XXX-other-http-code";
+export type PollCiGreenlightNonHttpAbortReason = "poll-timed-out" | "run-canceled" | "network-error";
+export type PollCiGreenlightAbortReason = PollCiGreenlightNonHttpAbortReason | PollCiGreenlightHttpAbortReason;
 export type PollCiGreenlightStatus = {
     /**
      * No blocking bugs were found in the run.
@@ -57,14 +57,14 @@ export type PollCiGreenlightStatus = {
      * The run was aborted due to an unrecoverable error.
      */
     outcome: "aborted";
-    abortReason: HttpRelatedAbortReason;
+    abortReason: PollCiGreenlightHttpAbortReason;
     httpStatus: number;
 } | {
     /**
      * The run was aborted due to an unrecoverable error.
      */
     outcome: "aborted";
-    abortReason: NonHttpRelatedAbortReason;
+    abortReason: PollCiGreenlightNonHttpAbortReason;
     httpStatus: undefined;
 };
 export type PollCiGreenlightParams = {
@@ -73,5 +73,5 @@ export type PollCiGreenlightParams = {
      * Callback to be called when the lifecycle stage of the run changes.
      */
     onRunStageChanged?: (current: CiGreenlightStatus, previous: CiGreenlightStatus | undefined) => unknown | Promise<unknown>;
-} & Partial<PollConfig>;
+} & Partial<PollCiGreenlightPollConfig>;
 export declare function pollCiGreenlightStatus(deps: SdkDependencies, apiConfig: ApiConfig, { runId, onRunStageChanged: onRunStageChanged, ...pollConfig }: PollCiGreenlightParams): Promise<PollCiGreenlightStatus>;

package/dist/types/lib/sdk/index.d.ts

@@ -6,3 +6,5 @@ export declare function makeQaWolfSdk({ apiKey, serviceBase, }: {
     attemptNotifyDeploy: (config: Partial<import("../api/deploy.js").DeployConfig>) => Promise<import("./domain/attempt-deploy.js").NotifyDeployStatus>;
     pollCiGreenlightStatus: (args_0: import("./domain/poll-ci-greenlight.js").PollCiGreenlightParams) => Promise<import("./domain/poll-ci-greenlight.js").PollCiGreenlightStatus>;
 };
+export type * from "./domain/poll-ci-greenlight.js";
+export type * from "./domain/attempt-deploy.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qawolf/ci-sdk",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "A simple SDK for interacting with QAWolf in CI scripts.",
   "type": "module",
   "private": false,