@argos-ci/core 4.5.0 → 5.0.1

package/dist/index.d.ts

@@ -116,6 +116,10 @@ interface Config {
      * No screenshots are uploaded, and the commit status is marked as success.
      */
     skipped?: boolean;
+    /**
+     * Whether the environment is a merge queue.
+     */
+    mergeQueue?: boolean;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
 declare function getConfigFromOptions({ parallel, ...options }: Omit<Partial<Config>, "parallel"> & {
@@ -397,11 +401,6 @@ interface UploadParameters {
     previewUrl?: {
         baseUrl: string;
     } | ((url: string) => string);
-    /**
-     * Mark this build as skipped.
-     * No screenshots are uploaded, and the commit status is marked as success.
-     */
-    skipped?: boolean;
 }
 interface Screenshot {
     hash: string;
@@ -424,4 +423,12 @@ declare function upload(params: UploadParameters): Promise<{
     screenshots: Screenshot[];
 }>;
 
-export { type Config, type FinalizeParameters, type UploadParameters, finalize, getConfigFromOptions, readConfig, upload };
+type SkipParameters = Pick<UploadParameters, "apiBaseUrl" | "commit" | "branch" | "token" | "prNumber" | "buildName" | "metadata">;
+/**
+ * Mark a build as skipped.
+ */
+declare function skip(params: SkipParameters): Promise<{
+    build: ArgosAPISchema.components["schemas"]["Build"];
+}>;
+
+export { type Config, type FinalizeParameters, type UploadParameters, finalize, getConfigFromOptions, readConfig, skip, upload };

package/dist/index.js

@@ -151,7 +151,8 @@ var service = {
       prNumber: getPrNumber({ env }),
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: env.BITRISEIO_PIPELINE_ID || null
+      nonce: env.BITRISEIO_PIPELINE_ID || null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -201,7 +202,8 @@ var service2 = {
       prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null,
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: env.BUILDKITE_BUILD_ID || null
+      nonce: env.BUILDKITE_BUILD_ID || null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -226,7 +228,8 @@ var service3 = {
     prNumber: null,
     prHeadCommit: null,
     prBaseBranch: null,
-    nonce: env.HEROKU_TEST_RUN_ID || null
+    nonce: env.HEROKU_TEST_RUN_ID || null,
+    mergeQueue: false
   }),
   getMergeBaseCommitSha,
   listParentCommits
@@ -353,19 +356,16 @@ function getPullRequestFromPayload(payload) {
   return null;
 }
 function getVercelDeploymentPayload(payload) {
-  if (!payload) {
-    return null;
-  }
-  if (process.env.GITHUB_EVENT_NAME !== "repository_dispatch") {
-    return null;
+  if (process.env.GITHUB_EVENT_NAME === "repository_dispatch" && payload && "action" in payload && payload.action === "vercel.deployment.success") {
+    return payload;
   }
-  if (!("client_payload" in payload) || !("action" in payload)) {
-    return null;
-  }
-  if (payload.action !== "vercel.deployment.success") {
-    return null;
+  return null;
+}
+function getMergeGroupPayload(payload) {
+  if (payload && process.env.GITHUB_EVENT_NAME === "merge_group" && "action" in payload && payload.action === "checks_requested") {
+    return payload;
   }
-  return payload;
+  return null;
 }
 function getSha(context, vercelPayload) {
   if (vercelPayload) {
@@ -384,6 +384,7 @@ var service4 = {
     const { env } = context;
     const payload = readEventPayload(context);
     const vercelPayload = getVercelDeploymentPayload(payload);
+    const mergeGroupPayload = getMergeGroupPayload(payload);
     const sha = getSha(context, vercelPayload);
     const pullRequest = payload && !vercelPayload ? getPullRequestFromPayload(payload) : await getPullRequestFromHeadSha(context, sha);
     return {
@@ -397,7 +398,8 @@ var service4 = {
       branch: vercelPayload?.client_payload?.git?.ref || getBranchFromContext(context) || pullRequest?.head.ref || (payload ? getBranchFromPayload(payload) : null) || null,
       prNumber: pullRequest?.number || null,
       prHeadCommit: pullRequest?.head.sha ?? null,
-      prBaseBranch: pullRequest?.base.ref ?? null
+      prBaseBranch: pullRequest?.base.ref ?? null,
+      mergeQueue: mergeGroupPayload?.action === "checks_requested"
     };
   },
   getMergeBaseCommitSha,
@@ -445,7 +447,8 @@ var service5 = {
       prNumber: getPrNumber2({ env }),
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: env.CIRCLE_WORKFLOW_ID || env.CIRCLE_BUILD_NUM || null
+      nonce: env.CIRCLE_WORKFLOW_ID || env.CIRCLE_BUILD_NUM || null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -489,7 +492,8 @@ var service6 = {
       prNumber: getPrNumber3(ctx),
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: env.TRAVIS_BUILD_ID || null
+      nonce: env.TRAVIS_BUILD_ID || null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -526,7 +530,8 @@ var service7 = {
       prNumber: null,
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: env.CI_PIPELINE_ID || null
+      nonce: env.CI_PIPELINE_ID || null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -559,7 +564,8 @@ var service8 = {
       prNumber: null,
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: null
+      nonce: null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -810,6 +816,10 @@ var schema = {
     env: "ARGOS_SKIPPED",
     format: Boolean,
     default: false
+  },
+  mergeQueue: {
+    format: Boolean,
+    default: false
   }
 };
 function createConfig() {
@@ -851,7 +861,8 @@ async function readConfig(options = {}) {
     mode: options.mode || defaultConfig.mode || null,
     ciProvider: ciEnv?.key || null,
     previewBaseUrl: defaultConfig.previewBaseUrl || null,
-    skipped: options.skipped ?? defaultConfig.skipped ?? false
+    skipped: options.skipped ?? defaultConfig.skipped ?? false,
+    mergeQueue: ciEnv?.mergeQueue ?? false
   });
   if (!config.get("branch") || !config.get("commit")) {
     throw new Error(
@@ -937,7 +948,7 @@ async function finalize(params) {
 }
 
 // src/upload.ts
-import { createClient as createClient2, throwAPIError as throwAPIError2 } from "@argos-ci/api-client";
+import { createClient as createClient3, throwAPIError as throwAPIError3 } from "@argos-ci/api-client";
 
 // src/discovery.ts
 import { extname, resolve } from "path";
@@ -1102,6 +1113,44 @@ function getSnapshotMimeType(filepath) {
   return type;
 }
 
+// src/skip.ts
+import { createClient as createClient2, throwAPIError as throwAPIError2 } from "@argos-ci/api-client";
+async function skip(params) {
+  const [config, argosSdk] = await Promise.all([
+    getConfigFromOptions(params),
+    getArgosCoreSDKIdentifier()
+  ]);
+  const authToken = getAuthToken(config);
+  const apiClient = createClient2({
+    baseUrl: config.apiBaseUrl,
+    authToken
+  });
+  const createBuildResponse = await apiClient.POST("/builds", {
+    body: {
+      commit: config.commit,
+      branch: config.branch,
+      name: config.buildName,
+      mode: config.mode,
+      prNumber: config.prNumber,
+      prHeadCommit: config.prHeadCommit,
+      referenceBranch: config.referenceBranch,
+      referenceCommit: config.referenceCommit,
+      argosSdk,
+      ciProvider: config.ciProvider,
+      runId: config.runId,
+      runAttempt: config.runAttempt,
+      skipped: true,
+      screenshotKeys: [],
+      pwTraceKeys: [],
+      parentCommits: []
+    }
+  });
+  if (createBuildResponse.error) {
+    throwAPIError2(createBuildResponse.error);
+  }
+  return { build: createBuildResponse.data.build };
+}
+
 // src/upload.ts
 var CHUNK_SIZE = 10;
 async function upload(params) {
@@ -1111,37 +1160,13 @@ async function upload(params) {
     getArgosCoreSDKIdentifier()
   ]);
   const authToken = getAuthToken(config);
-  const apiClient = createClient2({
+  const apiClient = createClient3({
     baseUrl: config.apiBaseUrl,
     authToken
   });
   if (config.skipped) {
-    const createBuildResponse2 = await apiClient.POST("/builds", {
-      body: {
-        commit: config.commit,
-        branch: config.branch,
-        name: config.buildName,
-        mode: config.mode,
-        parallel: config.parallel,
-        parallelNonce: config.parallelNonce,
-        prNumber: config.prNumber,
-        prHeadCommit: config.prHeadCommit,
-        referenceBranch: config.referenceBranch,
-        referenceCommit: config.referenceCommit,
-        argosSdk,
-        ciProvider: config.ciProvider,
-        runId: config.runId,
-        runAttempt: config.runAttempt,
-        skipped: true,
-        screenshotKeys: [],
-        pwTraceKeys: [],
-        parentCommits: []
-      }
-    });
-    if (createBuildResponse2.error) {
-      throwAPIError2(createBuildResponse2.error);
-    }
-    return { build: createBuildResponse2.data.build, screenshots: [] };
+    const { build } = await skip(params);
+    return { build, screenshots: [] };
   }
   const previewUrlFormatter = params.previewUrl ?? (config.previewBaseUrl ? { baseUrl: config.previewBaseUrl } : void 0);
   const globs = params.files ?? ["**/*.{png,jpg,jpeg}"];
@@ -1191,7 +1216,7 @@ async function upload(params) {
   debug("Fetch project");
   const projectResponse = await apiClient.GET("/project");
   if (projectResponse.error) {
-    throwAPIError2(projectResponse.error);
+    throwAPIError3(projectResponse.error);
   }
   debug("Project fetched", projectResponse.data);
   const { defaultBaseBranch, hasRemoteContentAccess } = projectResponse.data;
@@ -1258,11 +1283,12 @@ async function upload(params) {
       argosSdk,
       ciProvider: config.ciProvider,
       runId: config.runId,
-      runAttempt: config.runAttempt
+      runAttempt: config.runAttempt,
+      mergeQueue: config.mergeQueue
     }
   });
   if (createBuildResponse.error) {
-    throwAPIError2(createBuildResponse.error);
+    throwAPIError3(createBuildResponse.error);
   }
   const result = createBuildResponse.data;
   debug("Got uploads url", result);
@@ -1318,7 +1344,7 @@ async function upload(params) {
     }
   });
   if (uploadBuildResponse.error) {
-    throwAPIError2(uploadBuildResponse.error);
+    throwAPIError3(uploadBuildResponse.error);
   }
   return { build: uploadBuildResponse.data.build, screenshots: snapshots };
 }
@@ -1360,5 +1386,6 @@ export {
   finalize,
   getConfigFromOptions,
   readConfig,
+  skip,
   upload
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "4.5.0",
+  "version": "5.0.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,23 +40,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.14.0",
+    "@argos-ci/api-client": "0.15.0",
     "@argos-ci/util": "3.2.0",
     "convict": "^6.2.4",
     "debug": "^4.4.3",
     "fast-glob": "^3.3.3",
-    "mime-types": "^3.0.1",
-    "sharp": "^0.34.4",
+    "mime-types": "^3.0.2",
+    "sharp": "^0.34.5",
     "tmp": "^0.2.5"
   },
   "devDependencies": {
-    "@octokit/webhooks": "^14.1.3",
+    "@octokit/webhooks": "^14.2.0",
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
     "@types/mime-types": "^3.0.1",
     "@types/tmp": "^0.2.6",
     "@vercel/repository-dispatch": "^0.1.0",
-    "msw": "^2.11.6",
+    "msw": "^2.12.4",
     "vitest": "catalog:"
   },
   "scripts": {
@@ -67,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "fb54cf311b705f214041f18443352577be01e822"
+  "gitHead": "389e8ae7fe5cd4bf74d2627853b8c62e4b09e86a"
 }