@argos-ci/core 4.4.0 → 4.5.0

package/dist/index.d.ts

@@ -145,6 +145,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 +228,8 @@ interface components {
             } | null;
             pwTraceKey?: string | null;
             threshold?: number | null;
+            /** @default image/png */
+            contentType: string;
         };
         /** @description Build metadata */
         BuildMetadata: {

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);
 }
 
@@ -929,11 +940,11 @@ async function finalize(params) {
 import { createClient as createClient2, throwAPIError as throwAPIError2 } 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 +955,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 +969,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 +1028,7 @@ var optimizeScreenshot = async (filepath) => {
       cause: error
     });
   }
-};
+}
 
 // src/hashing.ts
 import { createReadStream } from "fs";
@@ -1074,6 +1092,16 @@ 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/upload.ts
 var CHUNK_SIZE = 10;
 async function upload(params) {
@@ -1116,19 +1144,20 @@ async function upload(params) {
     return { build: createBuildResponse2.data.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 +1165,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,13 +1176,15 @@ 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
       };
     })
   );
@@ -1196,15 +1228,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 +1248,7 @@ async function upload(params) {
       mode: config.mode,
       parallel: config.parallel,
       parallelNonce: config.parallelNonce,
-      screenshotKeys,
+      screenshotKeys: snapshotKeys,
       pwTraceKeys,
       prNumber: config.prNumber,
       prHeadCommit: config.prHeadCommit,
@@ -1236,26 +1268,26 @@ async function upload(params) {
   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 +1301,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,
@@ -1286,7 +1320,7 @@ async function upload(params) {
   if (uploadBuildResponse.error) {
     throwAPIError2(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}`);

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": "4.5.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,11 +40,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.13.0",
-    "@argos-ci/util": "3.1.1",
+    "@argos-ci/api-client": "0.14.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",
     "tmp": "^0.2.5"
   },
@@ -52,6 +53,7 @@
     "@octokit/webhooks": "^14.1.3",
     "@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",
@@ -65,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "7b770d9d0c621980319bd5a195413f96c54d5752"
+  "gitHead": "fb54cf311b705f214041f18443352577be01e822"
 }