@qawolf/ci-sdk 2.8.0 → 3.1.0

package/dist/index.js

@@ -1,7 +1,89 @@
-/* Built with @qawolf/platform-builder@1.2.3 */
+/* Built with @qawolf/platform-builder@1.2.7 */
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
+// src/lib/sdk/domain/detectProviderDeploymentId/index.ts
+var ciSystems = [
+  {
+    ci: "github",
+    isActive: /* @__PURE__ */ __name((env) => env.GITHUB_ACTIONS === "true", "isActive"),
+    // GITHUB_RUN_ID is stable across re-runs and GITHUB_RUN_ATTEMPT increments,
+    // and both are shared by every job in the workflow, so GITHUB_JOB separates
+    // jobs that deploy in parallel. GITHUB_JOB names the job definition, which
+    // every leg of a matrix shares, so those legs need a discriminator.
+    variables: ["GITHUB_RUN_ID", "GITHUB_RUN_ATTEMPT", "GITHUB_JOB"]
+  },
+  {
+    ci: "gitlab",
+    isActive: /* @__PURE__ */ __name((env) => env.GITLAB_CI === "true", "isActive"),
+    // Retrying a job keeps the pipeline id and mints a new job id.
+    variables: ["CI_PIPELINE_ID", "CI_JOB_ID"]
+  },
+  {
+    ci: "circleci",
+    isActive: /* @__PURE__ */ __name((env) => env.CIRCLECI === "true", "isActive"),
+    // A rerun keeps the workflow id and allocates a new build number. A job
+    // run with `parallelism` shares both across its containers, so those need
+    // a discriminator.
+    variables: ["CIRCLE_WORKFLOW_ID", "CIRCLE_BUILD_NUM"]
+  },
+  {
+    ci: "buildkite",
+    isActive: /* @__PURE__ */ __name((env) => env.BUILDKITE === "true", "isActive"),
+    // BUILDKITE_BUILD_ID covers the whole build, so BUILDKITE_JOB_ID separates
+    // the jobs within it and BUILDKITE_RETRY_COUNT separates a job's retries.
+    variables: [
+      "BUILDKITE_BUILD_ID",
+      "BUILDKITE_JOB_ID",
+      "BUILDKITE_RETRY_COUNT"
+    ]
+  },
+  {
+    ci: "jenkins",
+    // JENKINS_URL is unset on some agent configurations.
+    isActive: /* @__PURE__ */ __name((env) => env.JENKINS_URL !== void 0 || env.JENKINS_HOME !== void 0, "isActive"),
+    // BUILD_TAG is `jenkins-${JOB_NAME}-${BUILD_NUMBER}`, and Jenkins allocates
+    // a fresh BUILD_NUMBER for every externally visible re-run — Rebuild,
+    // Naginator, Replay and Restart from Stage — so it needs no attempt
+    // counter. An in-pipeline `retry {}` reuses it, but reports nothing new.
+    // A declarative `matrix` or `parallel` block runs its branches inside one
+    // build and so shares BUILD_TAG; those branches need a discriminator.
+    variables: ["BUILD_TAG"]
+  },
+  {
+    ci: "bitbucket",
+    isActive: /* @__PURE__ */ __name((env) => env.BITBUCKET_WORKSPACE !== void 0 || env.BITBUCKET_BUILD_NUMBER !== void 0, "isActive"),
+    // Rerunning a whole pipeline mints a new build number, but rerunning only
+    // the failed steps keeps it and increments the step's run number instead.
+    // Parallel steps share both, so BITBUCKET_STEP_UUID separates them.
+    variables: [
+      "BITBUCKET_BUILD_NUMBER",
+      "BITBUCKET_STEP_UUID",
+      "BITBUCKET_STEP_RUN_NUMBER"
+    ]
+  }
+];
+function detectProviderDeploymentId({
+  discriminator,
+  env = process.env
+} = {}) {
+  const system = ciSystems.find((candidate) => candidate.isActive(env));
+  if (!system) return { outcome: "unsupported" };
+  const missingVariables = system.variables.filter((name) => !env[name]);
+  if (missingVariables.length > 0)
+    return { ci: system.ci, missingVariables, outcome: "missing-variables" };
+  const composed = system.variables.map((name) => env[name]).join("-");
+  return {
+    ci: system.ci,
+    // A colon separates the discriminator because a job id can itself contain
+    // a hyphen, so joining with one would let job "deploy-web" collide with
+    // job "deploy" discriminated by "web".
+    id: discriminator ? `${composed}:${discriminator}` : composed,
+    outcome: "detected"
+  };
+}
+__name(detectProviderDeploymentId, "detectProviderDeploymentId");
+
 // src/lib/other.ts
 function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
@@ -38,7 +120,7 @@ var defaultServiceBase = "https://app.qawolf.com/";
 // package.json
 var package_default = {
   name: "@qawolf/ci-sdk",
-  version: "2.8.0",
+  version: "3.1.0",
   private: false,
   description: "A simple SDK for interacting with QAWolf in CI scripts.",
   keywords: [],
@@ -53,33 +135,33 @@ var package_default = {
   exports: {
     ".": {
       types: "./dist/index.d.ts",
-      require: "./dist/index.cjs",
-      import: "./dist/index.js",
-      default: "./dist/index.js"
+      import: "./dist/index.js"
     }
   },
   scripts: {
-    build: "platform-builder --config platformBuilder.config.ts --config platformBuilder.cjs.config.ts",
+    build: "platform-builder --config platformBuilder.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)/' '**/*'",
+    "lint:first-half": "oxlint . --fix --quiet --report-unused-disable-directives --type-aware && oxfmt --write .",
+    "lint:second-half": "rev-dep config run",
     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",
+    "@qawolf/api-contracts": ">=0.68.0",
+    "@qawolf/ci-utils": "^2.0.0",
     "@sinonjs/fake-timers": "^10.3.0",
-    tslib: "^2.6.2"
+    tslib: "^2.6.2",
+    zod: "^4.1.11"
   },
   devDependencies: {
-    "@qawolf/platform-builder": "^1.2.3",
+    "@qawolf/platform-builder": "^1.2.7",
     tsx: "^4.19.4",
     typescript: "^5.9.3"
   },
   engines: {
-    node: ">=20"
+    node: ">=24.14.1 <25"
   }
 };
 
@@ -1113,6 +1195,127 @@ async function pollCiGreenlightStatus(deps, apiConfig, {
 }
 __name(pollCiGreenlightStatus, "pollCiGreenlightStatus");
 
+// src/lib/sdk/domain/reportDeployment/index.ts
+import { publicContractsV1 } from "@qawolf/api-contracts";
+
+// src/lib/sdk/publicApi/callContract.ts
+function isRecord2(value) {
+  return typeof value === "object" && value !== null;
+}
+__name(isRecord2, "isRecord");
+function isSuperJsonEnvelope(data) {
+  return "json" in data && Object.keys(data).every((key) => key === "json" || key === "meta");
+}
+__name(isSuperJsonEnvelope, "isSuperJsonEnvelope");
+function unwrapTrpcEnvelope(body) {
+  if (!isRecord2(body) || !isRecord2(body.result)) return void 0;
+  const data = body.result.data;
+  return isRecord2(data) && isSuperJsonEnvelope(data) ? data.json : data;
+}
+__name(unwrapTrpcEnvelope, "unwrapTrpcEnvelope");
+function readTrpcError(body) {
+  const wrapped = isRecord2(body) ? body.error : void 0;
+  const error = isRecord2(wrapped) && isRecord2(wrapped.json) ? wrapped.json : wrapped;
+  if (!isRecord2(error)) return { eventId: void 0, message: void 0 };
+  const data = isRecord2(error.data) ? error.data : void 0;
+  return {
+    eventId: typeof data?.eventId === "string" ? data.eventId : void 0,
+    message: typeof error.message === "string" ? error.message : void 0
+  };
+}
+__name(readTrpcError, "readTrpcError");
+function parseJson(text) {
+  if (text === void 0) return void 0;
+  try {
+    return JSON.parse(text);
+  } catch {
+    return void 0;
+  }
+}
+__name(parseJson, "parseJson");
+async function readHttpError(response, contractName, log) {
+  const bodyText = await response.text().catch(() => void 0);
+  const { eventId, message } = readTrpcError(parseJson(bodyText));
+  const statusText = response.status >= 500 ? "Server Error" : response.statusText || "Unknown Error";
+  const eventIdSuffix = eventId ? ` (Event ID: ${eventId})` : "";
+  const messageSuffix = message ? `: ${message}` : "";
+  log.error(
+    `\u274C [${contractName}] ${response.status} ${statusText}${eventIdSuffix}${messageSuffix}`
+  );
+  return {
+    eventId,
+    httpStatus: response.status,
+    message,
+    outcome: "http-error"
+  };
+}
+__name(readHttpError, "readHttpError");
+async function callPublicContract({ fetch: localFetch, log }, apiConfig, {
+  contract,
+  input
+}) {
+  const procedurePath = `public.${contract.name}`;
+  let bodyText;
+  try {
+    const response = await localFetch(
+      new URL(`/api/trpc/${procedurePath}`, apiConfig.serviceBase),
+      {
+        // The server's superjson transformer reads the input from `json`.
+        body: JSON.stringify({ json: input }),
+        headers: {
+          Authorization: `Bearer ${apiConfig.apiKey}`,
+          "Content-Type": "application/json",
+          "User-Agent": apiConfig.userAgent
+        },
+        method: "POST"
+      }
+    );
+    if (!response.ok) return readHttpError(response, contract.name, log);
+    bodyText = await response.text();
+  } catch {
+    log.error(`\u{1F6AB} Network error from ${contract.name}, aborting.`);
+    return { outcome: "network-error" };
+  }
+  const parsed = contract.output.safeParse(
+    unwrapTrpcEnvelope(parseJson(bodyText))
+  );
+  if (!parsed.success) {
+    log.error(
+      `\u{1F6AB} Invalid response from ${contract.name} (${parsed.error.issues[0]?.message ?? "the response body did not match the contract"}), aborting.`
+    );
+    return { outcome: "invalid-response-body" };
+  }
+  return { data: parsed.data, outcome: "ok" };
+}
+__name(callPublicContract, "callPublicContract");
+
+// src/lib/sdk/domain/reportDeployment/index.ts
+async function reportDeployment(deps, apiConfig, params) {
+  const result = await callPublicContract(deps, apiConfig, {
+    contract: publicContractsV1.deployment.reportStatus,
+    input: params
+  });
+  if (result.outcome !== "ok") return mapFailure(result);
+  const { deployment } = result.data;
+  deps.log.info(
+    `\u2705 Deployment ${deployment.id} reported as ${deployment.status}: ${deployment.url}`
+  );
+  return { deployment, outcome: "reported" };
+}
+__name(reportDeployment, "reportDeployment");
+function mapFailure(result) {
+  if (result.outcome !== "http-error") return { outcome: result.outcome };
+  const { httpStatus, message } = result;
+  if (httpStatus === 400) return { message, outcome: "invalid-request" };
+  if (httpStatus === 401 || httpStatus === 403)
+    return { message, outcome: "unauthorized" };
+  if (httpStatus === 404) return { message, outcome: "not-found" };
+  if (httpStatus === 409) return { message, outcome: "conflict" };
+  if (httpStatus >= 500) return { httpStatus, outcome: "server-error" };
+  return { httpStatus, message, outcome: "unexpected-status" };
+}
+__name(mapFailure, "mapFailure");
+
 // src/lib/sdk/index.ts
 function makeQaWolfSdk({
   apiKey,
@@ -1137,7 +1340,14 @@ We recommend 'undici' package for that purpose. See the Requirement section of o
   };
   const apiConfig = { apiKey, serviceBase, userAgent };
   return {
+    /**
+     * @deprecated Reports through the legacy `deploy_success` webhook, which
+     * triggers do not see. Use `deployment.reportStatus` instead.
+     */
     attemptNotifyDeploy: attemptNotifyDeploy.bind(null, deps, apiConfig),
+    deployment: {
+      reportStatus: reportDeployment.bind(null, deps, apiConfig)
+    },
     generateSignedUrlForRunInputsExecutablesStorage: generateSignedUrlForRunInputsExecutablesStorage.bind(
       null,
       deps,
@@ -1150,11 +1360,16 @@ We recommend 'undici' package for that purpose. See the Requirement section of o
       apiConfig
     ),
     notifyTerminatedEphemeralEnvironment: notifyTerminatedEphemeralEnvironment.bind(null, deps, apiConfig),
+    /**
+     * @deprecated Polls a run id that only `attemptNotifyDeploy` returns, so it
+     * keeps the pipeline on the legacy `deploy_success` webhook.
+     */
     pollCiGreenlightStatus: pollCiGreenlightStatus.bind(null, deps, apiConfig)
   };
 }
 __name(makeQaWolfSdk, "makeQaWolfSdk");
 export {
+  detectProviderDeploymentId,
   makeQaWolfSdk
 };
 //# sourceMappingURL=index.js.map