@argos-ci/core 0.11.1 → 0.12.1-alpha.4

package/dist/index.d.ts

@@ -24,6 +24,10 @@ interface UploadParameters {
         /** The number of parallel nodes being ran */
         total: number;
     } | false;
+    /** Branch used as baseline for screenshot comparison */
+    referenceBranch?: string;
+    /** Commit used as baseline for screenshot comparison */
+    referenceCommit?: string;
 }
 /**
  * Upload screenshots to argos-ci.com.
@@ -34,11 +38,11 @@ declare const upload: (params: UploadParameters) => Promise<{
         url: string;
     };
     screenshots: {
+        metadata: import("@argos-ci/util").ScreenshotMetadata | null;
         optimizedPath: string;
         hash: string;
         name: string;
         path: string;
     }[];
 }>;
-
-export { type UploadParameters, upload };
+export { UploadParameters, upload };

package/dist/index.mjs

@@ -11,6 +11,7 @@ import tmp from 'tmp';
 import { createHash } from 'node:crypto';
 import axios from 'axios';
 import { readFile } from 'node:fs/promises';
+import { readMetadata } from '@argos-ci/util';
 
 const mustBeApiBaseUrl = (value)=>{
     const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
@@ -89,6 +90,18 @@ const schema = {
         default: null,
         nullable: true
     },
+    referenceBranch: {
+        env: "ARGOS_REFERENCE_BRANCH",
+        format: String,
+        default: null,
+        nullable: true
+    },
+    referenceCommit: {
+        env: "ARGOS_REFERENCE_COMMIT",
+        format: String,
+        default: null,
+        nullable: true
+    },
     ciService: {
         format: String,
         default: null,
@@ -201,12 +214,13 @@ const service$3 = {
     name: "GitHub Actions",
     detect: ({ env })=>Boolean(env.GITHUB_ACTIONS),
     config: ({ env })=>{
+        var _payload_pull_request, _payload_pull_request1, _payload_pull_request2;
         const payload = readEventPayload({
             env
         });
         return {
             commit: process.env.GITHUB_SHA || null,
-            branch: payload?.pull_request?.head.ref || getBranch({
+            branch: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request = payload.pull_request) === null || _payload_pull_request === void 0 ? void 0 : _payload_pull_request.head.ref) || getBranch({
                 env
             }) || null,
             owner: env.GITHUB_REPOSITORY_OWNER || null,
@@ -215,8 +229,8 @@ const service$3 = {
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
-            prNumber: payload?.pull_request?.number || null,
-            prHeadCommit: payload?.pull_request?.head.sha ?? null
+            prNumber: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request1 = payload.pull_request) === null || _payload_pull_request1 === void 0 ? void 0 : _payload_pull_request1.number) || null,
+            prHeadCommit: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request2 = payload.pull_request) === null || _payload_pull_request2 === void 0 ? void 0 : _payload_pull_request2.head.sha) ?? null
         };
     }
 };
@@ -375,10 +389,13 @@ const discoverScreenshots = async (patterns, { root = process.cwd(), ignore } =
         ignore,
         cwd: root
     });
-    return matches.map((match)=>({
+    return matches.map((match)=>{
+        const path = resolve(root, match);
+        return {
             name: match,
-            path: resolve(root, match)
-        }));
+            path
+        };
+    });
 };
 
 const tmpFile = promisify(tmp.file);
@@ -453,7 +470,8 @@ const createArgosApiClient = (options)=>{
             });
             return response.data;
         } catch (error) {
-            if (error?.response?.data?.error?.message) {
+            var _error_response_data_error, _error_response_data, _error_response;
+            if (error === null || error === void 0 ? void 0 : (_error_response = error.response) === null || _error_response === void 0 ? void 0 : (_error_response_data = _error_response.data) === null || _error_response_data === void 0 ? void 0 : (_error_response_data_error = _error_response_data.error) === null || _error_response_data_error === void 0 ? void 0 : _error_response_data_error.message) {
                 // @ts-ignore
                 throw new Error(error.response.data.error.message, {
                     cause: error
@@ -506,17 +524,19 @@ const getConfigFromOptions = (options)=>{
     const ciEnv = getCiEnvironment();
     config.load({
         apiBaseUrl: options.apiBaseUrl ?? config.get("apiBaseUrl"),
-        commit: options.commit ?? config.get("commit") ?? ciEnv?.commit ?? null,
-        branch: options.branch ?? config.get("branch") ?? ciEnv?.branch ?? null,
+        commit: options.commit ?? config.get("commit") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.commit) ?? null,
+        branch: options.branch ?? config.get("branch") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.branch) ?? null,
         token: options.token ?? config.get("token") ?? null,
         buildName: options.buildName ?? config.get("buildName") ?? null,
-        prNumber: options.prNumber ?? config.get("prNumber") ?? ciEnv?.prNumber ?? null,
-        prHeadCommit: config.get("prHeadCommit") ?? ciEnv?.prHeadCommit ?? null,
-        ciService: ciEnv?.name ?? null,
-        owner: ciEnv?.owner ?? null,
-        repository: ciEnv?.repository ?? null,
-        jobId: ciEnv?.jobId ?? null,
-        runId: ciEnv?.runId ?? null
+        prNumber: options.prNumber ?? config.get("prNumber") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.prNumber) ?? null,
+        prHeadCommit: config.get("prHeadCommit") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.prHeadCommit) ?? null,
+        referenceBranch: options.referenceBranch ?? config.get("referenceBranch") ?? null,
+        referenceCommit: options.referenceCommit ?? config.get("referenceCommit") ?? null,
+        ciService: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.name) ?? null,
+        owner: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.owner) ?? null,
+        repository: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.repository) ?? null,
+        jobId: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.jobId) ?? null,
+        runId: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.runId) ?? null
     });
     if (options.parallel) {
         config.load({
@@ -550,10 +570,14 @@ const getConfigFromOptions = (options)=>{
     debug("Found screenshots", foundScreenshots);
     // Optimize & compute hashes
     const screenshots = await Promise.all(foundScreenshots.map(async (screenshot)=>{
-        const optimizedPath = await optimizeScreenshot(screenshot.path);
+        const [metadata, optimizedPath] = await Promise.all([
+            readMetadata(screenshot.path),
+            optimizeScreenshot(screenshot.path)
+        ]);
         const hash = await hashFile(optimizedPath);
         return {
             ...screenshot,
+            metadata,
             optimizedPath,
             hash
         };
@@ -568,7 +592,9 @@ const getConfigFromOptions = (options)=>{
         parallelNonce: config.parallelNonce,
         screenshotKeys: Array.from(new Set(screenshots.map((screenshot)=>screenshot.hash))),
         prNumber: config.prNumber,
-        prHeadCommit: config.prHeadCommit
+        prHeadCommit: config.prHeadCommit,
+        referenceBranch: config.referenceBranch,
+        referenceCommit: config.referenceCommit
     });
     debug("Got screenshots", result);
     debug(`Split screenshots in chunks of ${CHUNK_SIZE}`);
@@ -596,7 +622,8 @@ const getConfigFromOptions = (options)=>{
         buildId: result.build.id,
         screenshots: screenshots.map((screenshot)=>({
                 key: screenshot.hash,
-                name: screenshot.name
+                name: screenshot.name,
+                metadata: screenshot.metadata
             })),
         parallel: config.parallel,
         parallelTotal: config.parallelTotal

package/package.json

@@ -1,12 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Visual testing solution to avoid visual regression. The core component of Argos SDK that handles build creation.",
-  "version": "0.11.1",
-  "scripts": {
-    "prebuild": "rm -rf dist",
-    "build": "rollup -c",
-    "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
-  },
+  "version": "0.12.1-alpha.4+8a2e9db",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -45,6 +40,7 @@
     "access": "public"
   },
   "dependencies": {
+    "@argos-ci/util": "0.0.1-alpha.182+8a2e9db",
     "axios": "^1.5.0",
     "convict": "^6.2.4",
     "debug": "^4.3.4",
@@ -55,11 +51,14 @@
   },
   "devDependencies": {
     "@types/convict": "^6.1.4",
+    "@types/debug": "^4.1.9",
     "@types/tmp": "^0.2.3",
-    "msw": "^1.3.0",
-    "rollup": "^3.29.0",
-    "rollup-plugin-dts": "^6.0.1",
-    "rollup-plugin-swc3": "^0.10.1"
+    "msw": "^1.3.0"
+  },
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "rollup -c",
+    "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "8e3c44d658f3abd5ce3ac1bc829e2754974a2125"
+  "gitHead": "8a2e9db6427071708c3d701a3230f228b1216893"
 }