@argos-ci/core 1.1.0 → 1.2.0

package/dist/index.d.ts

@@ -38,9 +38,13 @@ 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;
     }[];

package/dist/index.mjs

@@ -10,7 +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';
+import { readMetadata, getPlaywrightTracePath } from '@argos-ci/util';
 
 /**
  * Check if the current directory is a git repository.
@@ -528,7 +528,7 @@ const upload$1 = async (input)=>{
         url: input.url,
         data: file,
         headers: {
-            "Content-Type": "image/png"
+            "Content-Type": input.contentType
         }
     });
 };
@@ -580,27 +580,50 @@ const getConfigFromOptions = ({ parallel, ...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,
@@ -611,18 +634,36 @@ const getConfigFromOptions = ({ parallel, ...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);
     }
@@ -630,11 +671,15 @@ const getConfigFromOptions = ({ parallel, ...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
     });

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.1.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": "08246344886ff258fab097c370b4ff29cb1121b0"
+  "gitHead": "47a939474ca0c0d55ca5360dcaa5f8912547ed76"
 }