@argos-ci/core 4.4.0 → 5.0.0

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"> & {
@@ -145,6 +149,7 @@ interface components {
             key: string;
             name: string;
             baseName?: string | null;
+            parentName?: string | null;
             metadata?: {
                 /**
                  * @description Ignored. Can be set to get completions, validations and documentation in some editors.
@@ -227,6 +232,8 @@ interface components {
             } | null;
             pwTraceKey?: string | null;
             threshold?: number | null;
+            /** @default image/png */
+            contentType: string;
         };
         /** @description Build metadata */
         BuildMetadata: {
@@ -394,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;
@@ -421,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

@@ -66,7 +66,7 @@ function gitMergeBase(input) {
 }
 function gitFetch(input) {
   execSync(
-    `git fetch --update-head-ok --depth ${input.depth} origin ${input.ref}:${input.ref}`
+    `git fetch --force --update-head-ok --depth ${input.depth} origin ${input.ref}:${input.target}`
   );
 }
 function checkIsExecError(error) {
@@ -74,18 +74,23 @@ function checkIsExecError(error) {
 }
 function getMergeBaseCommitSha(input) {
   let depth = 200;
+  const argosBaseRef = `argos/${input.base}`;
+  const argosHeadRef = `argos/${input.head}`;
   while (depth < 1e3) {
-    gitFetch({ ref: input.head, depth });
-    gitFetch({ ref: input.base, depth });
-    const mergeBase = gitMergeBase(input);
+    gitFetch({ ref: input.head, depth, target: argosHeadRef });
+    gitFetch({ ref: input.base, depth, target: argosBaseRef });
+    const mergeBase = gitMergeBase({
+      base: argosBaseRef,
+      head: argosHeadRef
+    });
     if (mergeBase) {
       return mergeBase;
     }
     depth += 200;
   }
   if (isDebugEnabled) {
-    const headShas = listShas(input.head);
-    const baseShas = listShas(input.base);
+    const headShas = listShas(argosHeadRef);
+    const baseShas = listShas(argosBaseRef);
     debug(
       `No merge base found for ${input.head} and ${input.base} with depth ${depth}`
     );
@@ -106,7 +111,13 @@ function listShas(path, maxCount) {
 }
 function listParentCommits(input) {
   const limit = 200;
-  execSync(`git fetch --depth=${limit} origin ${input.sha}`);
+  try {
+    execSync(`git fetch --depth=${limit} origin ${input.sha}`);
+  } catch (error) {
+    if (error instanceof Error && error.message.includes("not our ref")) {
+      return [];
+    }
+  }
   return listShas(input.sha, limit);
 }
 
@@ -140,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,
@@ -190,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,
@@ -215,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
@@ -342,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) {
@@ -373,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 {
@@ -386,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,
@@ -434,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,
@@ -478,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,
@@ -515,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,
@@ -548,7 +564,8 @@ var service8 = {
       prNumber: null,
       prHeadCommit: null,
       prBaseBranch: null,
-      nonce: null
+      nonce: null,
+      mergeQueue: false
     };
   },
   getMergeBaseCommitSha,
@@ -840,7 +857,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(
@@ -926,14 +944,14 @@ 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 { resolve } from "path";
+import { extname, resolve } from "path";
 import glob from "fast-glob";
-var discoverScreenshots = async (patterns, { root = process.cwd(), ignore } = {}) => {
+async function discoverSnapshots(patterns, { root = process.cwd(), ignore } = {}) {
   debug(
-    `Discovering screenshots with patterns: ${Array.isArray(patterns) ? patterns.join(", ") : patterns} in ${root}`
+    `Discovering snapshots with patterns: ${Array.isArray(patterns) ? patterns.join(", ") : patterns} in ${root}`
   );
   const matches = await glob(patterns, { onlyFiles: true, ignore, cwd: root });
   return matches.map((match) => {
@@ -944,7 +962,11 @@ var discoverScreenshots = async (patterns, { root = process.cwd(), ignore } = {}
       path
     };
   });
-};
+}
+function checkIsValidImageFile(filename) {
+  const lowerFilename = extname(filename).toLowerCase();
+  return lowerFilename === ".png" || lowerFilename === ".jpg" || lowerFilename === ".jpeg";
+}
 
 // src/optimize.ts
 import { promisify } from "util";
@@ -954,7 +976,10 @@ import tmp from "tmp";
 var tmpFile = promisify(tmp.file);
 var MAX_PIXELS = 8e7;
 var DEFAULT_MAX_WIDTH = 2048;
-var optimizeScreenshot = async (filepath) => {
+async function optimizeScreenshot(filepath) {
+  if (!checkIsValidImageFile(filepath)) {
+    return filepath;
+  }
   try {
     const [resultFilePath, metadata] = await Promise.all([
       tmpFile(),
@@ -1010,7 +1035,7 @@ var optimizeScreenshot = async (filepath) => {
       cause: error
     });
   }
-};
+}
 
 // src/hashing.ts
 import { createReadStream } from "fs";
@@ -1074,6 +1099,54 @@ async function getArgosCoreSDKIdentifier() {
   return `@argos-ci/core@${version}`;
 }
 
+// src/mime-type.ts
+import mime from "mime-types";
+function getSnapshotMimeType(filepath) {
+  const type = mime.lookup(filepath);
+  if (!type) {
+    throw new Error(`Unable to determine snapshot file type for: ${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) {
@@ -1083,52 +1156,29 @@ 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 files = params.files ?? ["**/*.{png,jpg,jpeg}"];
-  debug("Using config and files", config, files);
-  const foundScreenshots = await discoverScreenshots(files, {
+  const globs = params.files ?? ["**/*.{png,jpg,jpeg}"];
+  debug("Using config and files", config, globs);
+  const files = await discoverSnapshots(globs, {
     root: params.root,
     ignore: params.ignore
   });
-  debug("Found screenshots", foundScreenshots);
-  const screenshots = await Promise.all(
-    foundScreenshots.map(async (screenshot) => {
+  debug("Found snapshots", files);
+  const snapshots = await Promise.all(
+    files.map(async (snapshot) => {
+      const contentType = getSnapshotMimeType(snapshot.path);
       const [metadata, pwTracePath, optimizedPath] = await Promise.all([
-        readMetadata(screenshot.path),
-        getPlaywrightTracePath(screenshot.path),
-        optimizeScreenshot(screenshot.path)
+        readMetadata(snapshot.path),
+        getPlaywrightTracePath(snapshot.path),
+        contentType.startsWith("image/") ? optimizeScreenshot(snapshot.path) : snapshot.path
       ]);
       const [hash, pwTraceHash] = await Promise.all([
         hashFile(optimizedPath),
@@ -1136,6 +1186,7 @@ async function upload(params) {
       ]);
       const threshold = metadata?.transient?.threshold ?? null;
       const baseName = metadata?.transient?.baseName ?? null;
+      const parentName = metadata?.transient?.parentName ?? null;
       if (metadata) {
         delete metadata.transient;
         if (metadata.url && previewUrlFormatter) {
@@ -1146,20 +1197,22 @@ async function upload(params) {
         }
       }
       return {
-        ...screenshot,
+        ...snapshot,
         hash,
         optimizedPath,
         metadata,
         threshold,
         baseName,
-        pwTrace: pwTracePath && pwTraceHash ? { path: pwTracePath, hash: pwTraceHash } : null
+        parentName,
+        pwTrace: pwTracePath && pwTraceHash ? { path: pwTracePath, hash: pwTraceHash } : null,
+        contentType
       };
     })
   );
   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;
@@ -1196,15 +1249,15 @@ async function upload(params) {
     return null;
   })();
   debug("Creating build");
-  const [pwTraceKeys, screenshotKeys] = screenshots.reduce(
-    ([pwTraceKeys2, screenshotKeys2], screenshot) => {
-      if (screenshot.pwTrace && !pwTraceKeys2.includes(screenshot.pwTrace.hash)) {
-        pwTraceKeys2.push(screenshot.pwTrace.hash);
+  const [pwTraceKeys, snapshotKeys] = snapshots.reduce(
+    ([pwTraceKeys2, snapshotKeys2], snapshot) => {
+      if (snapshot.pwTrace && !pwTraceKeys2.includes(snapshot.pwTrace.hash)) {
+        pwTraceKeys2.push(snapshot.pwTrace.hash);
       }
-      if (!screenshotKeys2.includes(screenshot.hash)) {
-        screenshotKeys2.push(screenshot.hash);
+      if (!snapshotKeys2.includes(snapshot.hash)) {
+        snapshotKeys2.push(snapshot.hash);
       }
-      return [pwTraceKeys2, screenshotKeys2];
+      return [pwTraceKeys2, snapshotKeys2];
     },
     [[], []]
   );
@@ -1216,7 +1269,7 @@ async function upload(params) {
       mode: config.mode,
       parallel: config.parallel,
       parallelNonce: config.parallelNonce,
-      screenshotKeys,
+      screenshotKeys: snapshotKeys,
       pwTraceKeys,
       prNumber: config.prNumber,
       prHeadCommit: config.prHeadCommit,
@@ -1226,36 +1279,37 @@ 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);
   const uploadFiles = [
     ...result.screenshots.map(({ key, putUrl }) => {
-      const screenshot = screenshots.find((s) => s.hash === key);
-      if (!screenshot) {
-        throw new Error(`Invariant: screenshot with hash ${key} not found`);
+      const snapshot = snapshots.find((s) => s.hash === key);
+      if (!snapshot) {
+        throw new Error(`Invariant: snapshot with hash ${key} not found`);
       }
       return {
         url: putUrl,
-        path: screenshot.optimizedPath,
-        contentType: "image/png"
+        path: snapshot.optimizedPath,
+        contentType: snapshot.contentType
       };
     }),
     ...result.pwTraces?.map(({ key, putUrl }) => {
-      const screenshot = screenshots.find(
+      const snapshot = snapshots.find(
         (s) => s.pwTrace && s.pwTrace.hash === key
       );
-      if (!screenshot || !screenshot.pwTrace) {
+      if (!snapshot || !snapshot.pwTrace) {
         throw new Error(`Invariant: trace with ${key} not found`);
       }
       return {
         url: putUrl,
-        path: screenshot.pwTrace.path,
+        path: snapshot.pwTrace.path,
         contentType: "application/json"
       };
     }) ?? []
@@ -1269,13 +1323,15 @@ async function upload(params) {
       }
     },
     body: {
-      screenshots: screenshots.map((screenshot) => ({
-        key: screenshot.hash,
-        name: screenshot.name,
-        metadata: screenshot.metadata,
-        pwTraceKey: screenshot.pwTrace?.hash ?? null,
-        threshold: screenshot.threshold ?? config?.threshold ?? null,
-        baseName: screenshot.baseName
+      screenshots: snapshots.map((snapshot) => ({
+        key: snapshot.hash,
+        name: snapshot.name,
+        metadata: snapshot.metadata,
+        pwTraceKey: snapshot.pwTrace?.hash ?? null,
+        threshold: snapshot.threshold ?? config?.threshold ?? null,
+        baseName: snapshot.baseName,
+        parentName: snapshot.parentName,
+        contentType: snapshot.contentType
       })),
       parallel: config.parallel,
       parallelTotal: config.parallelTotal,
@@ -1284,9 +1340,9 @@ async function upload(params) {
     }
   });
   if (uploadBuildResponse.error) {
-    throwAPIError2(uploadBuildResponse.error);
+    throwAPIError3(uploadBuildResponse.error);
   }
-  return { build: uploadBuildResponse.data.build, screenshots };
+  return { build: uploadBuildResponse.data.build, screenshots: snapshots };
 }
 async function uploadFilesToS3(files) {
   debug(`Split files in chunks of ${CHUNK_SIZE}`);
@@ -1326,5 +1382,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.4.0",
+  "version": "5.0.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,21 +40,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.13.0",
-    "@argos-ci/util": "3.1.1",
+    "@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",
-    "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": {
@@ -65,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "7b770d9d0c621980319bd5a195413f96c54d5752"
+  "gitHead": "d460ccc12fe75b1d9389d58647f1906bee7d5e0d"
 }

package/LICENSE

@@ -1,7 +0,0 @@
-Copyright 2022 Smooth Code
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.