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

package/dist/index.mjs

@@ -181,7 +181,7 @@ async function argosScreenshot(page, name, options = {}) {
     const stabilizeAndScreenshot = async (name)=>{
         await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
         const metadata = await collectMetadata(testInfo);
-        const nameInProject = (testInfo === null || testInfo === void 0 ? void 0 : testInfo.project.name) ? `${testInfo.project.name}/${name}` : name;
+        const nameInProject = 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) {

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

@@ -107,12 +107,14 @@ async function getMetadataFromTestCase(testCase, testResult) {
 const KEY = "@argos-ci/playwright";
 const debug = createDebug(KEY);
 
-async function createTempDirectory() {
+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) {
@@ -128,17 +130,19 @@ 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
             });
@@ -148,8 +152,9 @@ class ArgosReporter {
         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
             });
@@ -164,18 +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;
-        debug(`Creating temporary directory for uploads`);
-        this.uploadDir = await createTempDirectory();
-        debug(`Temporary directory created for uploads: ${this.uploadDir}`);
     }
     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;
             }
@@ -184,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),
@@ -196,9 +205,10 @@ class ArgosReporter {
     }
     async onEnd(_result) {
         debug("ArgosReporter:onEnd");
+        const uploadDir = await this.getUploadDir();
         if (!this.uploadToArgos) {
             debug("Not uploading to Argos because uploadToArgos is false.");
-            debug(`Upload directory: ${this.uploadDir}`);
+            debug(`Upload directory: ${uploadDir}`);
             return;
         }
         debug("Getting parallel from config");
@@ -214,7 +224,7 @@ class ArgosReporter {
                 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.4-alpha.1+f0cee6a",
+  "version": "3.0.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -39,21 +39,21 @@
     "./package.json": "./package.json"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.5.0",
-    "@argos-ci/core": "1.5.5-alpha.3+f0cee6a",
-    "@argos-ci/util": "1.2.1",
+    "@argos-ci/browser": "2.0.0",
+    "@argos-ci/core": "2.0.0",
+    "@argos-ci/util": "2.0.0",
     "chalk": "^5.3.0",
     "debug": "^4.3.4"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.12-alpha.3+f0cee6a",
+    "@argos-ci/cli": "2.0.0",
     "@argos-ci/playwright": "workspace:.",
-    "@playwright/test": "^1.42.1",
+    "@playwright/test": "^1.43.0",
     "@types/debug": "^4.1.12",
-    "@types/node": "^16.0.0"
+    "@types/node": "^18.0.0"
   },
   "scripts": {
     "prebuild": "rm -rf dist",
@@ -61,5 +61,5 @@
     "test": "pnpm exec playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "f0cee6a09987b4af96e8d6705f958a40ebe2b866"
+  "gitHead": "fcadf37f2a9c4a65a3f4c082db56aff2576c8c16"
 }