@argos-ci/playwright 1.9.2 → 1.9.4-alpha.1

package/dist/index.mjs

@@ -150,7 +150,7 @@ async function argosScreenshot(page, name, options = {}) {
     const originalViewportSize = getViewportSize(page);
     const fullPage = options.fullPage !== undefined ? options.fullPage : handle === page;
     const teardown = await setup(page, options);
-    async function collectMetadata(testInfo) {
+    const collectMetadata = async (testInfo)=>{
         const [colorScheme, mediaType, libMetadata, testMetadata] = await Promise.all([
             page.evaluate(()=>window.__ARGOS__.getColorScheme()),
             page.evaluate(()=>window.__ARGOS__.getMediaType()),
@@ -177,22 +177,21 @@ async function argosScreenshot(page, name, options = {}) {
             ...libMetadata
         };
         return metadata;
-    }
-    async function stabilizeAndScreenshot(name) {
+    };
+    const stabilizeAndScreenshot = async (name)=>{
         await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
         const metadata = await collectMetadata(testInfo);
-        const screenshotPath = useArgosReporter ? testInfo.outputPath("argos", `${name}.png`) : resolve(screenshotFolder, `${name}.png`);
-        if (screenshotPath) {
-            const dir = dirname(screenshotPath);
-            if (dir !== screenshotFolder) {
-                await mkdir(dirname(screenshotPath), {
-                    recursive: true
-                });
-            }
+        const nameInProject = (testInfo === null || testInfo === void 0 ? void 0 : testInfo.project.name) ? `${testInfo.project.name}/${name}` : name;
+        const screenshotPath = useArgosReporter && testInfo ? testInfo.outputPath("argos", `${nameInProject}.png`) : resolve(screenshotFolder, `${nameInProject}.png`);
+        const dir = dirname(screenshotPath);
+        if (dir !== screenshotFolder) {
+            await mkdir(dirname(screenshotPath), {
+                recursive: true
+            });
         }
         await Promise.all([
             handle.screenshot({
-                path: screenshotPath ?? undefined,
+                path: screenshotPath,
                 type: "png",
                 fullPage,
                 mask: [
@@ -201,21 +200,21 @@ async function argosScreenshot(page, name, options = {}) {
                 animations: "disabled",
                 ...playwrightOptions
             }),
-            screenshotPath ? writeMetadata(screenshotPath, metadata) : null
+            writeMetadata(screenshotPath, metadata)
         ]);
-        if (useArgosReporter) {
+        if (useArgosReporter && testInfo) {
             await Promise.all([
-                testInfo.attach(getAttachmentName(name, "metadata"), {
+                testInfo.attach(getAttachmentName(nameInProject, "metadata"), {
                     path: getMetadataPath(screenshotPath),
                     contentType: "application/json"
                 }),
-                testInfo.attach(getAttachmentName(name, "screenshot"), {
+                testInfo.attach(getAttachmentName(nameInProject, "screenshot"), {
                     path: screenshotPath,
                     contentType: "image/png"
                 })
             ]);
         }
-    }
+    };
     // If no viewports are specified, take a single screenshot
     if (viewports) {
         // Take screenshots for each viewport

package/dist/reporter.mjs

@@ -6,6 +6,7 @@ import { tmpdir } from 'node:os';
 import { relative, dirname, join } from 'node:path';
 import { getGitRepositoryPath, readVersionFromPackage } from '@argos-ci/util';
 import { createRequire } from 'node:module';
+import createDebug from 'debug';
 
 function getOriginalAttachmentName(name) {
     return name.replace(/^argos\/[^/]+___/, "");
@@ -103,6 +104,9 @@ async function getMetadataFromTestCase(testCase, testResult) {
     return metadata;
 }
 
+const KEY = "@argos-ci/playwright";
+const debug = createDebug(KEY);
+
 async function createTempDirectory() {
     const osTmpDirectory = tmpdir();
     const path = join(osTmpDirectory, "argos." + randomBytes(16).toString("hex"));
@@ -139,7 +143,9 @@ class ArgosReporter {
                 recursive: true
             });
         }
+        debug(`Writing file to ${path}`);
         await writeFile(path, body);
+        debug(`File written to ${path}`);
     }
     async copyFile(from, to) {
         const dir = dirname(to);
@@ -148,7 +154,9 @@ class ArgosReporter {
                 recursive: true
             });
         }
+        debug(`Copying file from ${from} to ${to}`);
         await copyFile(from, to);
+        debug(`File copied from ${from} to ${to}`);
     }
     getAutomaticScreenshotName(test, result) {
         let name = test.titlePath().join(" ");
@@ -157,10 +165,14 @@ class ArgosReporter {
         return name;
     }
     async onBegin(config, _suite) {
+        debug("ArgosReporter:onBegin");
         this.playwrightConfig = config;
+        debug(`Creating temporary directory for uploads`);
         this.uploadDir = await createTempDirectory();
+        debug(`Temporary directory created for uploads: ${this.uploadDir}`);
     }
     async onTestEnd(test, result) {
+        debug("ArgosReporter:onTestEnd");
         await Promise.all(result.attachments.map(async (attachment)=>{
             if (checkIsArgosScreenshot(attachment) || checkIsArgosScreenshotMetadata(attachment)) {
                 const path = join(this.uploadDir, getAttachmentFilename(attachment.name));
@@ -183,9 +195,21 @@ class ArgosReporter {
         }));
     }
     async onEnd(_result) {
-        if (!this.uploadToArgos) return;
+        debug("ArgosReporter:onEnd");
+        if (!this.uploadToArgos) {
+            debug("Not uploading to Argos because uploadToArgos is false.");
+            debug(`Upload directory: ${this.uploadDir}`);
+            return;
+        }
+        debug("Getting parallel from config");
         const parallel = await getParallelFromConfig(this.playwrightConfig);
+        if (parallel) {
+            debug(`Using parallel config — total: ${parallel.total}, nonce: "${parallel.nonce}"`);
+        } else {
+            debug("Non-parallel mode");
+        }
         try {
+            debug("Uploading to Argos");
             const res = await upload({
                 files: [
                     "**/*.png"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/playwright",
   "description": "Visual testing solution to avoid visual regression. Playwright commands and utilities for Argos visual testing.",
-  "version": "1.9.2",
+  "version": "1.9.4-alpha.1+f0cee6a",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -42,15 +42,17 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.4.1",
-    "@argos-ci/core": "1.5.4",
+    "@argos-ci/browser": "1.5.0",
+    "@argos-ci/core": "1.5.5-alpha.3+f0cee6a",
     "@argos-ci/util": "1.2.1",
-    "chalk": "^5.3.0"
+    "chalk": "^5.3.0",
+    "debug": "^4.3.4"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.11",
+    "@argos-ci/cli": "1.0.12-alpha.3+f0cee6a",
     "@argos-ci/playwright": "workspace:.",
-    "@playwright/test": "^1.38.1",
+    "@playwright/test": "^1.42.1",
+    "@types/debug": "^4.1.12",
     "@types/node": "^16.0.0"
   },
   "scripts": {
@@ -59,5 +61,5 @@
     "test": "pnpm exec playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "3c0a10a7ec14c294c801491aca79cacb2f07edc2"
+  "gitHead": "f0cee6a09987b4af96e8d6705f958a40ebe2b866"
 }