@argos-ci/core 1.0.0 → 1.2.0

package/dist/index.d.ts

@@ -38,11 +38,34 @@ declare const upload: (params: UploadParameters) => Promise<{
         url: string;
     };
     screenshots: {
-        metadata: import("@argos-ci/util").ScreenshotMetadata | null;
-        optimizedPath: string;
         hash: string;
+        optimizedPath: string;
+        metadata: import("@argos-ci/util").ScreenshotMetadata | null;
+        pwTrace: {
+            path: string;
+            hash: string;
+        } | null;
         name: string;
         path: string;
     }[];
 }>;
-export { UploadParameters, upload };
+interface Config {
+    apiBaseUrl: string;
+    commit: string;
+    branch: string;
+    token: string | null;
+    buildName: string | null;
+    parallel: boolean;
+    parallelNonce: string | null;
+    parallelTotal: number | null;
+    referenceBranch: string | null;
+    referenceCommit: string | null;
+    owner: string | null;
+    repository: string | null;
+    jobId: string | null;
+    runId: string | null;
+    prNumber: number | null;
+    prHeadCommit: string | null;
+}
+declare const readConfig: (options?: Partial<Config>) => Config;
+export { UploadParameters, upload, Config, readConfig };

package/dist/index.mjs

@@ -10,128 +10,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()@:%_\+.~#?&//=]*)/;
-    if (!URL_REGEX.test(value)) {
-        throw new Error("Invalid Argos API base URL");
-    }
-};
-const mustBeCommit = (value)=>{
-    const SHA1_REGEX = /^[0-9a-f]{40}$/;
-    if (!SHA1_REGEX.test(value)) {
-        const SHA1_SHORT_REGEX = /^[0-9a-f]{7}$/;
-        if (SHA1_SHORT_REGEX.test(value)) {
-            throw new Error("Short SHA1 is not allowed");
-        }
-        throw new Error("Invalid commit");
-    }
-};
-const mustBeArgosToken = (value)=>{
-    if (value && value.length !== 40) {
-        throw new Error("Invalid Argos repository token (must be 40 characters)");
-    }
-};
-const schema = {
-    apiBaseUrl: {
-        env: "ARGOS_API_BASE_URL",
-        default: "https://api.argos-ci.com/v2/",
-        format: mustBeApiBaseUrl
-    },
-    commit: {
-        env: "ARGOS_COMMIT",
-        default: null,
-        format: mustBeCommit
-    },
-    branch: {
-        env: "ARGOS_BRANCH",
-        default: null,
-        format: String
-    },
-    token: {
-        env: "ARGOS_TOKEN",
-        default: null,
-        format: mustBeArgosToken
-    },
-    buildName: {
-        env: "ARGOS_BUILD_NAME",
-        default: null,
-        format: String,
-        nullable: true
-    },
-    prNumber: {
-        env: "ARGOS_PR_NUMBER",
-        format: Number,
-        default: null,
-        nullable: true
-    },
-    prHeadCommit: {
-        env: "ARGOS_PR_HEAD_COMMIT",
-        format: String,
-        default: null,
-        nullable: true
-    },
-    parallel: {
-        env: "ARGOS_PARALLEL",
-        default: false,
-        format: Boolean
-    },
-    parallelNonce: {
-        env: "ARGOS_PARALLEL_NONCE",
-        format: String,
-        default: null,
-        nullable: true
-    },
-    parallelTotal: {
-        env: "ARGOS_PARALLEL_TOTAL",
-        format: "nat",
-        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,
-        nullable: true
-    },
-    jobId: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    runId: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    owner: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    repository: {
-        format: String,
-        default: null,
-        nullable: true
-    }
-};
-const createConfig = ()=>{
-    return convict(schema, {
-        args: []
-    });
-};
+import { readMetadata, getPlaywrightTracePath } from '@argos-ci/util';
 
 /**
  * Check if the current directory is a git repository.
@@ -178,7 +57,8 @@ const service$6 = {
             jobId: null,
             runId: null,
             prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null,
-            prHeadCommit: null
+            prHeadCommit: null,
+            nonce: env.BUILDKITE_BUILD_ID || null
         };
     }
 };
@@ -194,7 +74,8 @@ const service$5 = {
             jobId: null,
             runId: null,
             prNumber: null,
-            prHeadCommit: null
+            prHeadCommit: null,
+            nonce: env.HEROKU_TEST_RUN_ID || null
         })
 };
 
@@ -238,7 +119,8 @@ const service$4 = {
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || 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
+            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,
+            nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null
         };
     }
 };
@@ -265,7 +147,8 @@ const service$3 = {
             prNumber: getPrNumber$1({
                 env
             }),
-            prHeadCommit: null
+            prHeadCommit: null,
+            nonce: env.CIRCLE_WORKFLOW_ID || env.CIRCLE_BUILD_NUM || null
         };
     }
 };
@@ -295,7 +178,8 @@ const service$2 = {
             jobId: null,
             runId: null,
             prNumber: getPrNumber(ctx),
-            prHeadCommit: null
+            prHeadCommit: null,
+            nonce: env.TRAVIS_BUILD_ID || null
         };
     }
 };
@@ -312,7 +196,8 @@ const service$1 = {
             jobId: null,
             runId: null,
             prNumber: null,
-            prHeadCommit: null
+            prHeadCommit: null,
+            nonce: env.CI_PIPELINE_ID || null
         };
     }
 };
@@ -330,7 +215,8 @@ const service = {
             jobId: null,
             runId: null,
             prNumber: null,
-            prHeadCommit: null
+            prHeadCommit: null,
+            nonce: null
         };
     }
 };
@@ -381,6 +267,152 @@ const getCiEnvironment = ({ env = process.env } = {})=>{
     return null;
 };
 
+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()@:%_\+.~#?&//=]*)/;
+    if (!URL_REGEX.test(value)) {
+        throw new Error("Invalid Argos API base URL");
+    }
+};
+const mustBeCommit = (value)=>{
+    const SHA1_REGEX = /^[0-9a-f]{40}$/;
+    if (!SHA1_REGEX.test(value)) {
+        const SHA1_SHORT_REGEX = /^[0-9a-f]{7}$/;
+        if (SHA1_SHORT_REGEX.test(value)) {
+            throw new Error("Short SHA1 is not allowed");
+        }
+        throw new Error("Invalid commit");
+    }
+};
+const mustBeArgosToken = (value)=>{
+    if (value && value.length !== 40) {
+        throw new Error("Invalid Argos repository token (must be 40 characters)");
+    }
+};
+const schema = {
+    apiBaseUrl: {
+        env: "ARGOS_API_BASE_URL",
+        default: "https://api.argos-ci.com/v2/",
+        format: mustBeApiBaseUrl
+    },
+    commit: {
+        env: "ARGOS_COMMIT",
+        default: null,
+        format: mustBeCommit
+    },
+    branch: {
+        env: "ARGOS_BRANCH",
+        default: null,
+        format: String
+    },
+    token: {
+        env: "ARGOS_TOKEN",
+        default: null,
+        format: mustBeArgosToken
+    },
+    buildName: {
+        env: "ARGOS_BUILD_NAME",
+        default: null,
+        format: String,
+        nullable: true
+    },
+    prNumber: {
+        env: "ARGOS_PR_NUMBER",
+        format: Number,
+        default: null,
+        nullable: true
+    },
+    prHeadCommit: {
+        env: "ARGOS_PR_HEAD_COMMIT",
+        format: String,
+        default: null,
+        nullable: true
+    },
+    parallel: {
+        env: "ARGOS_PARALLEL",
+        default: false,
+        format: Boolean
+    },
+    parallelNonce: {
+        env: "ARGOS_PARALLEL_NONCE",
+        format: String,
+        default: null,
+        nullable: true
+    },
+    parallelTotal: {
+        env: "ARGOS_PARALLEL_TOTAL",
+        format: "nat",
+        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,
+        nullable: true
+    },
+    jobId: {
+        format: String,
+        default: null,
+        nullable: true
+    },
+    runId: {
+        format: String,
+        default: null,
+        nullable: true
+    },
+    owner: {
+        format: String,
+        default: null,
+        nullable: true
+    },
+    repository: {
+        format: String,
+        default: null,
+        nullable: true
+    }
+};
+const createConfig = ()=>{
+    return convict(schema, {
+        args: []
+    });
+};
+const readConfig = (options = {})=>{
+    const config = createConfig();
+    const ciEnv = getCiEnvironment();
+    config.load({
+        apiBaseUrl: options.apiBaseUrl ?? config.get("apiBaseUrl"),
+        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 === 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,
+        parallel: options.parallel ?? config.get("parallel") ?? false,
+        parallelNonce: options.parallelNonce ?? config.get("parallelNonce") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.nonce) ?? null,
+        parallelTotal: options.parallelTotal ?? config.get("parallelTotal") ?? null
+    });
+    config.validate();
+    return config.get();
+};
+
 const discoverScreenshots = async (patterns, { root = process.cwd(), ignore } = {})=>{
     const matches = await glob(patterns, {
         onlyFiles: true,
@@ -496,7 +528,7 @@ const upload$1 = async (input)=>{
         url: input.url,
         data: file,
         headers: {
-            "Content-Type": "image/png"
+            "Content-Type": input.contentType
         }
     });
 };
@@ -517,34 +549,14 @@ const upload$1 = async (input)=>{
 /**
  * Size of the chunks used to upload screenshots to Argos.
  */ const CHUNK_SIZE = 10;
-const getConfigFromOptions = (options)=>{
-    const config = createConfig();
-    const ciEnv = getCiEnvironment();
-    config.load({
-        apiBaseUrl: options.apiBaseUrl ?? config.get("apiBaseUrl"),
-        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 === 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
+const getConfigFromOptions = ({ parallel, ...options })=>{
+    const config = readConfig({
+        ...options,
+        parallel: Boolean(parallel),
+        parallelNonce: parallel ? parallel.nonce : null,
+        parallelTotal: parallel ? parallel.total : null
     });
-    if (options.parallel) {
-        config.load({
-            parallel: Boolean(options.parallel),
-            parallelNonce: options.parallel ? options.parallel.nonce : null,
-            parallelTotal: options.parallel ? options.parallel.total : null
-        });
-    }
-    config.validate();
-    return config.get();
+    return config;
 };
 /**
  * Upload screenshots to argos-ci.com.
@@ -568,27 +580,50 @@ const getConfigFromOptions = (options)=>{
     debug("Found screenshots", foundScreenshots);
     // Optimize & compute hashes
     const screenshots = await Promise.all(foundScreenshots.map(async (screenshot)=>{
-        const [metadata, optimizedPath] = await Promise.all([
+        const [metadata, pwTracePath, optimizedPath] = await Promise.all([
             readMetadata(screenshot.path),
+            getPlaywrightTracePath(screenshot.path),
             optimizeScreenshot(screenshot.path)
         ]);
-        const hash = await hashFile(optimizedPath);
+        const [hash, pwTraceHash] = await Promise.all([
+            hashFile(optimizedPath),
+            pwTracePath ? hashFile(pwTracePath) : null
+        ]);
         return {
             ...screenshot,
-            metadata,
+            hash,
             optimizedPath,
-            hash
+            metadata,
+            pwTrace: pwTracePath && pwTraceHash ? {
+                path: pwTracePath,
+                hash: pwTraceHash
+            } : null
         };
     }));
     // Create build
     debug("Creating build");
+    const screenshotKeys = Array.from(new Set(screenshots.map((screenshot)=>screenshot.hash)));
+    const pwTraces = screenshotKeys.reduce((pwTraces, key)=>{
+        const screenshot = screenshots.find((screenshot)=>screenshot.hash === key);
+        if (!screenshot) {
+            throw new Error(`Invariant: screenshot with hash ${key} not found`);
+        }
+        if (screenshot.pwTrace) {
+            pwTraces.push({
+                screenshotKey: screenshot.hash,
+                traceKey: screenshot.pwTrace.hash
+            });
+        }
+        return pwTraces;
+    }, []);
     const result = await apiClient.createBuild({
         commit: config.commit,
         branch: config.branch,
         name: config.buildName,
         parallel: config.parallel,
         parallelNonce: config.parallelNonce,
-        screenshotKeys: Array.from(new Set(screenshots.map((screenshot)=>screenshot.hash))),
+        screenshotKeys,
+        pwTraces,
         prNumber: config.prNumber,
         prHeadCommit: config.prHeadCommit,
         referenceBranch: config.referenceBranch,
@@ -599,18 +634,36 @@ const getConfigFromOptions = (options)=>{
     const chunks = chunk(result.screenshots, CHUNK_SIZE);
     debug(`Starting upload of ${chunks.length} chunks`);
     for(let i = 0; i < chunks.length; i++){
+        // Upload screenshots
         debug(`Uploading chunk ${i + 1}/${chunks.length}`);
         const timeLabel = `Chunk ${i + 1}/${chunks.length}`;
         debugTime(timeLabel);
-        await Promise.all(chunks[i].map(async ({ key, putUrl })=>{
+        await Promise.all(chunks[i].map(async ({ key, putUrl, putTraceUrl })=>{
             const screenshot = screenshots.find((s)=>s.hash === key);
             if (!screenshot) {
                 throw new Error(`Invariant: screenshot with hash ${key} not found`);
             }
-            await upload$1({
-                url: putUrl,
-                path: screenshot.optimizedPath
-            });
+            await Promise.all([
+                // Upload screenshot
+                upload$1({
+                    url: putUrl,
+                    path: screenshot.optimizedPath,
+                    contentType: "image/png"
+                }),
+                // Upload trace
+                (async ()=>{
+                    if (putTraceUrl) {
+                        if (!screenshot.pwTrace) {
+                            throw new Error(`Invariant: screenshot with hash ${key} has a putTraceUrl but no pwTrace`);
+                        }
+                        await upload$1({
+                            url: putTraceUrl,
+                            path: screenshot.pwTrace.path,
+                            contentType: "application/zip"
+                        });
+                    }
+                })()
+            ]);
         }));
         debugTimeEnd(timeLabel);
     }
@@ -618,11 +671,15 @@ const getConfigFromOptions = (options)=>{
     debug("Updating build");
     await apiClient.updateBuild({
         buildId: result.build.id,
-        screenshots: screenshots.map((screenshot)=>({
+        screenshots: screenshots.map((screenshot)=>{
+            var _screenshot_pwTrace;
+            return {
                 key: screenshot.hash,
                 name: screenshot.name,
-                metadata: screenshot.metadata
-            })),
+                metadata: screenshot.metadata,
+                pwTraceKey: ((_screenshot_pwTrace = screenshot.pwTrace) === null || _screenshot_pwTrace === void 0 ? void 0 : _screenshot_pwTrace.hash) ?? null
+            };
+        }),
         parallel: config.parallel,
         parallelTotal: config.parallelTotal
     });
@@ -632,4 +689,4 @@ const getConfigFromOptions = (options)=>{
     };
 };
 
-export { upload };
+export { readConfig, upload };

package/package.json

@@ -1,7 +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": "1.0.0",
+  "version": "1.2.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/util": "1.0.0",
+    "@argos-ci/util": "1.1.0",
     "axios": "^1.5.0",
     "convict": "^6.2.4",
     "debug": "^4.3.4",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "f864cced9e48669efab2a35fde612570600b94a7"
+  "gitHead": "47a939474ca0c0d55ca5360dcaa5f8912547ed76"
 }