@qawolf/ci-sdk 2.0.0 → 2.2.0

package/dist/index.d.ts

@@ -134,6 +134,12 @@ type GenerateSignedUrlStatus = {
 type GenerateSignedUrlAbortReason$1 = "client-network-error" | "sdk-argument-validation-failed" | "400-invalid-request" | "401-invalid-credentials" | "403-forbidden" | "5XX-server-error" | "XXX-other-http-code";
 type GenerateSignedUrlConfig = {
     destinationFilePath: string;
+    /**
+     * The workspace to generate the URL for. Required when authenticating with an
+     * organization API key, which is not tied to a single workspace. Omit it when
+     * authenticating with a workspace API key, which already implies one.
+     */
+    workspaceId?: string;
 };
 type GenerateSignedUrlResponse = {
     errorMessage?: string;
@@ -144,41 +150,6 @@ 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;
@@ -187,6 +158,12 @@ type BaseDeployConfig = {
     deploymentUrl: string | undefined;
     sha: string | undefined;
     variables: Record<string, string> | undefined;
+    /**
+     * The workspace this deployment belongs to. Required when authenticating with
+     * an organization API key, which is not tied to a single workspace. Omit it
+     * when authenticating with a workspace API key, which already implies one.
+     */
+    workspaceId?: string;
 };
 type GitHubDeployConfig = BaseDeployConfig & {
     hostingService: "GitHub" | undefined;
@@ -209,6 +186,39 @@ type EphemeralDeployConfig = BaseDeployConfig & {
     ephemeralEnvironment: true;
 };
 type DeployConfig = GitHubDeployConfig | GitLabDeployConfig | EphemeralDeployConfig;
+
+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;
+} | {
+    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;
+    }[];
+};
+
 type DeploySuccessSuiteCreatedResult = {
     createdSuiteId: string;
     triggerId: string;
@@ -222,7 +232,11 @@ type DeploySuccessSuiteAlreadyExistsResult = {
     skipReason: string;
     triggerId: string;
 };
-type DeploySuccessSuiteResult = DeploySuccessSuiteCreatedResult | DeploySuccessSuiteCreationFailureResult | DeploySuccessSuiteAlreadyExistsResult;
+type DeploySuccessSuiteUnrecognizedResult = {
+    triggerId: string;
+    unrecognized: true;
+};
+type DeploySuccessSuiteResult = DeploySuccessSuiteCreatedResult | DeploySuccessSuiteCreationFailureResult | DeploySuccessSuiteAlreadyExistsResult | DeploySuccessSuiteUnrecognizedResult;
 type DeploySuccessSkippedTrigger = {
     environmentId: string;
     message: string;
@@ -255,7 +269,7 @@ type DeployStatusErrorResponse = {
 };
 type DeployStatusResponse = DeployStatusSuccessResponse | DeployStatusErrorResponse;
 type AttemptDeployHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "5XX-server-error" | "network-error";
-type AttemptDeployNonHttpAbortReason = "network-error";
+type AttemptDeployNonHttpAbortReason = "network-error" | "invalid-response-body";
 type AttemptDeployAbortReason = AttemptDeployHttpAbortReason | AttemptDeployNonHttpAbortReason;
 type NotifyDeployStatus = {
     /**
@@ -293,7 +307,12 @@ type NotifyDeployStatus = {
     outcome: "skipped";
     skippedDeployment: DeploySuccessDeploymentSkipped | undefined;
 } | {
-    failReason: "no-environment" | "run-could-not-be-created";
+    /**
+     * `unknown-result` means the response carried a result arm this SDK
+     * version does not recognize (the backend is newer). The caller should
+     * upgrade the SDK; the outcome could not be classified.
+     */
+    failReason: "no-environment" | "run-could-not-be-created" | "unknown-result";
     /**
      * A run could not be created.
      */
@@ -317,13 +336,24 @@ type AttemptDeployFailedReason = Extract<NotifyDeployStatus, {
     outcome: "failed";
 }>["failReason"];
 
+/**
+ * The workspace that owns the environment. Required when authenticating with an
+ * organization API key, which is not tied to a single workspace. Omit it when
+ * authenticating with a workspace API key, which already implies one.
+ *
+ * Absent from the `environmentId` lookup, where the environment identifies its
+ * own workspace.
+ */
+type WorkspaceLookup = {
+    workspaceId?: string;
+};
 type NotifyTerminatedEphemeralEnvironmentInput = {
     environmentId: string;
-} | {
+} | ({
     deploymentUrl: string;
-} | {
+} & WorkspaceLookup) | ({
     environmentAlias: string;
-};
+} & WorkspaceLookup);
 type NotifyTerminatedEphemeralEnvironmentFailedReason = "environmentNotFound" | "missingLookup" | "alreadyTerminated";
 type NotifyTerminatedEphemeralEnvironmentHttpAbortReason = "4XX-client-error" | "401-unauthorized" | "403-forbidden" | "409-conflict" | "5XX-server-error" | "network-error";
 type NotifyTerminatedEphemeralEnvironmentNonHttpAbortReason = "network-error";
@@ -524,4 +554,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 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 };
+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 DeploySuccessSuiteUnrecognizedResult, 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: "2.0.0"};
+  version: "2.2.0"};
 
 // src/lib/sdk/defaults/userAgent.ts
 var defaultUserAgent = `ci-sdk/${package_default.version}`;
@@ -121,6 +121,14 @@ async function handleSuccessResponse(data, log) {
       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.`);
@@ -169,10 +177,16 @@ function mapSuiteResult(result) {
       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 {
-    duplicateSuiteId: result.duplicate_suite_id,
-    skipReason: result.skip_reason,
-    triggerId: result.trigger_id
+    triggerId: result.trigger_id,
+    unrecognized: true
   };
 }
 __name(mapSuiteResult, "mapSuiteResult");
@@ -194,11 +208,61 @@ function mapDeploySuccessResponse(wire) {
 }
 __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,
@@ -214,7 +278,8 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
           repository: config.repository
         },
         sha: config.sha,
-        variables: config.variables
+        variables: config.variables,
+        workspaceId: config.workspaceId
       }),
       headers: {
         Authorization: `Bearer ${apiConfig.apiKey}`,
@@ -227,9 +292,7 @@ async function attemptNotifyDeploy(deps, apiConfig, config) {
       signal: AbortSignal.timeout(5 * 60 * 1e3)
     });
     if (!response.ok) return handleErrorResponse(response, log);
-    const wire = await response.json();
-    const data = mapDeploySuccessResponse(wire);
-    return handleSuccessResponse(data, log);
+    bodyText = await response.text();
   } catch {
     log.error(`\u{1F6AB} Network error from deploy_success, aborting.`);
     return {
@@ -238,8 +301,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;
@@ -261,10 +345,28 @@ async function handleErrorResponse(response, log) {
 }
 __name(handleErrorResponse, "handleErrorResponse");
 
+// src/lib/api/signed-url.ts
+var signedUrlPaths = {
+  runInputsExecutables: "/api/v0/run-inputs-executables-signed-urls",
+  teamStorage: "/api/v0/team-storage-signed-url"
+};
+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);
+  return url;
+}
+__name(buildSignedUrl, "buildSignedUrl");
+
 // src/lib/api/generate-signed-url-for-run-inputs-executables.ts
-async function callGenerateSignedUrlForRunInputsExecutablesStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath }, { fetch: localFetch, log }) {
+async function callGenerateSignedUrlForRunInputsExecutablesStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath, workspaceId }, { fetch: localFetch, log }) {
   try {
-    const response = await localFetch(new URL(`${serviceBase}/api/v0/run-inputs-executables-signed-urls?file=${encodeURIComponent(destinationFilePath)}`), {
+    const response = await localFetch(buildSignedUrl({
+      destinationFilePath,
+      endpoint: "runInputsExecutables",
+      serviceBase,
+      workspaceId
+    }), {
       headers: {
         Authorization: `Bearer ${apiKey}`,
         "Content-Type": "application/json",
@@ -342,9 +444,14 @@ async function generateSignedUrlForRunInputsExecutablesStorage(deps, apiConfig,
 __name(generateSignedUrlForRunInputsExecutablesStorage, "generateSignedUrlForRunInputsExecutablesStorage");
 
 // src/lib/api/generate-signed-url-for-team-storage.ts
-async function callGenerateSignedUrlForTempTeamStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath }, { fetch: localFetch, log }) {
+async function callGenerateSignedUrlForTempTeamStorage({ apiKey, serviceBase, userAgent }, { destinationFilePath, workspaceId }, { fetch: localFetch, log }) {
   try {
-    const response = await localFetch(new URL(`${serviceBase}/api/v0/team-storage-signed-url?file=${destinationFilePath}`), {
+    const response = await localFetch(buildSignedUrl({
+      destinationFilePath,
+      endpoint: "teamStorage",
+      serviceBase,
+      workspaceId
+    }), {
       headers: {
         Authorization: `Bearer ${apiKey}`,
         "Content-Type": "application/json",