@argos-ci/playwright 1.9.3 → 2.0.0

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.d.ts

@@ -9,7 +9,7 @@ type ArgosReporterOptions = Omit<UploadParameters, "files" | "root"> & {
     uploadToArgos?: boolean;
 };
 declare class ArgosReporter implements Reporter {
-    uploadDir: string;
+    createUploadDirPromise: null | Promise<string>;
     config: ArgosReporterOptions;
     playwrightConfig: FullConfig;
     uploadToArgos: boolean;
@@ -17,7 +17,8 @@ declare class ArgosReporter implements Reporter {
     writeFile(path: string, body: Buffer | string): Promise<void>;
     copyFile(from: string, to: string): Promise<void>;
     getAutomaticScreenshotName(test: TestCase, result: TestResult): string;
-    onBegin(config: FullConfig, _suite: Suite): Promise<void>;
+    getUploadDir(): Promise<string>;
+    onBegin(config: FullConfig, _suite: Suite): void;
     onTestEnd(test: TestCase, result: TestResult): Promise<void>;
     onEnd(_result: FullResult): Promise<{
         status: "failed";

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,12 +104,17 @@ async function getMetadataFromTestCase(testCase, testResult) {
     return metadata;
 }
 
-async function createTempDirectory() {
+const KEY = "@argos-ci/playwright";
+const debug = createDebug(KEY);
+
+async function createUploadDirectory() {
+    debug("Creating temporary directory for screenshots");
     const osTmpDirectory = tmpdir();
     const path = join(osTmpDirectory, "argos." + randomBytes(16).toString("hex"));
     await mkdir(path, {
         recursive: true
     });
+    debug(`Temporary directory created: ${path}`);
     return path;
 }
 async function getParallelFromConfig(config) {
@@ -124,31 +130,38 @@ async function getParallelFromConfig(config) {
     };
 }
 class ArgosReporter {
-    uploadDir;
+    createUploadDirPromise;
     config;
     playwrightConfig;
     uploadToArgos;
     constructor(config){
         this.config = config;
         this.uploadToArgos = config.uploadToArgos ?? true;
+        this.createUploadDirPromise = null;
     }
     async writeFile(path, body) {
+        const uploadDir = await this.getUploadDir();
         const dir = dirname(path);
-        if (dir !== this.uploadDir) {
+        if (dir !== uploadDir) {
             await mkdir(dir, {
                 recursive: true
             });
         }
+        debug(`Writing file to ${path}`);
         await writeFile(path, body);
+        debug(`File written to ${path}`);
     }
     async copyFile(from, to) {
+        const uploadDir = await this.getUploadDir();
         const dir = dirname(to);
-        if (dir !== this.uploadDir) {
+        if (dir !== uploadDir) {
             await mkdir(dir, {
                 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(" ");
@@ -156,14 +169,22 @@ class ArgosReporter {
         name += result.status === "failed" || result.status === "timedOut" ? " (failed)" : "";
         return name;
     }
-    async onBegin(config, _suite) {
+    getUploadDir() {
+        if (!this.createUploadDirPromise) {
+            this.createUploadDirPromise = createUploadDirectory();
+        }
+        return this.createUploadDirPromise;
+    }
+    onBegin(config, _suite) {
+        debug("ArgosReporter:onBegin");
         this.playwrightConfig = config;
-        this.uploadDir = await createTempDirectory();
     }
     async onTestEnd(test, result) {
+        const uploadDir = await this.getUploadDir();
+        debug("ArgosReporter:onTestEnd");
         await Promise.all(result.attachments.map(async (attachment)=>{
             if (checkIsArgosScreenshot(attachment) || checkIsArgosScreenshotMetadata(attachment)) {
-                const path = join(this.uploadDir, getAttachmentFilename(attachment.name));
+                const path = join(uploadDir, getAttachmentFilename(attachment.name));
                 await this.copyFile(attachment.path, path);
                 return;
             }
@@ -172,7 +193,7 @@ class ArgosReporter {
                 const trace = result.attachments.find(checkIsTrace) ?? null;
                 const metadata = await getMetadataFromTestCase(test, result);
                 const name = this.getAutomaticScreenshotName(test, result);
-                const path = join(this.uploadDir, `${name}.png`);
+                const path = join(uploadDir, `${name}.png`);
                 await Promise.all([
                     this.writeFile(path + ".argos.json", JSON.stringify(metadata)),
                     this.copyFile(attachment.path, path),
@@ -183,14 +204,27 @@ class ArgosReporter {
         }));
     }
     async onEnd(_result) {
-        if (!this.uploadToArgos) return;
+        debug("ArgosReporter:onEnd");
+        const uploadDir = await this.getUploadDir();
+        if (!this.uploadToArgos) {
+            debug("Not uploading to Argos because uploadToArgos is false.");
+            debug(`Upload directory: ${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"
                 ],
-                root: this.uploadDir,
+                root: uploadDir,
                 parallel: parallel ?? undefined,
                 ...this.config
             });

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.3",
+  "version": "2.0.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -43,14 +43,16 @@
   },
   "dependencies": {
     "@argos-ci/browser": "1.5.0",
-    "@argos-ci/core": "1.5.4",
+    "@argos-ci/core": "1.5.5",
     "@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",
     "@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": "2db40cba98f08e1d0c7bc9a48042e2f05af8a401"
+  "gitHead": "4da90d82cfb93a1377497731164b9fbaeb9fb7f6"
 }