@argos-ci/playwright 1.0.1 → 1.2.0

package/dist/index.mjs

@@ -58,6 +58,8 @@ async function getTestMetadataFromTestInfo(testInfo) {
         id: testInfo.testId,
         title: testInfo.title,
         titlePath: testInfo.titlePath,
+        retry: testInfo.retry,
+        retries: testInfo.project.retries,
         location: {
             file: repositoryPath ? relative(repositoryPath, testInfo.file) : testInfo.file,
             line: testInfo.line,

package/dist/reporter.d.ts

@@ -5,9 +5,11 @@ type ArgosReporterOptions = Omit<UploadParameters, "files" | "root">;
 declare class ArgosReporter implements Reporter {
     uploadDir: string;
     config: ArgosReporterOptions;
+    playwrightConfig: FullConfig;
     constructor(config: ArgosReporterOptions);
     writeFile(path: string, body: Buffer | string): Promise<void>;
-    onBegin(_config: FullConfig, _suite: Suite): Promise<void>;
+    getAutomaticScreenshotName(test: TestCase, result: TestResult): string;
+    onBegin(config: FullConfig, _suite: Suite): Promise<void>;
     onTestEnd(test: TestCase, result: TestResult): Promise<void>;
     onEnd(_result: FullResult): Promise<{
         status: "failed";

package/dist/reporter.mjs

@@ -1,4 +1,4 @@
-import { upload } from '@argos-ci/core';
+import { upload, readConfig } from '@argos-ci/core';
 import { randomBytes } from 'node:crypto';
 import { mkdir, writeFile, copyFile } from 'node:fs/promises';
 import { tmpdir } from 'node:os';
@@ -18,6 +18,15 @@ function getAttachementFilename(name) {
     }
     throw new Error(`Unknown attachment name: ${name}`);
 }
+function checkIsTrace(attachment) {
+    return attachment.name === "trace" && attachment.contentType === "application/zip" && Boolean(attachment.path);
+}
+function checkIsArgosScreenshot(attachment) {
+    return attachment.name.startsWith("argos/") && attachment.contentType === "image/png" && Boolean(attachment.body);
+}
+function checkIsAutomaticScreenshot(attachment) {
+    return attachment.name === "screenshot" && attachment.contentType === "image/png" && Boolean(attachment.path);
+}
 
 const require = createRequire(import.meta.url);
 const tryResolve = (pkg)=>{
@@ -63,11 +72,13 @@ async function getLibraryMetadata() {
     };
     return metadata;
 }
-async function getTestMetadataFromTestCase(testCase) {
+async function getTestMetadataFromTestCase(testCase, testResult) {
     const repositoryPath = await getGitRepositoryPath();
     const testMetadata = {
         title: testCase.title,
         titlePath: testCase.titlePath(),
+        retry: testResult.retry,
+        retries: testCase.retries,
         location: {
             file: repositoryPath ? relative(repositoryPath, testCase.location.file) : testCase.location.file,
             line: testCase.location.line,
@@ -76,10 +87,10 @@ async function getTestMetadataFromTestCase(testCase) {
     };
     return testMetadata;
 }
-async function getMetadataFromTestCase(testCase) {
+async function getMetadataFromTestCase(testCase, testResult) {
     const [libMetadata, testMetadata] = await Promise.all([
         getLibraryMetadata(),
-        getTestMetadataFromTestCase(testCase)
+        getTestMetadataFromTestCase(testCase, testResult)
     ]);
     const metadata = {
         test: testMetadata,
@@ -96,9 +107,22 @@ async function createTempDirectory() {
     });
     return path;
 }
+const getParallelFromConfig = (config)=>{
+    if (!config.shard) return null;
+    if (config.shard.total === 1) return null;
+    const argosConfig = readConfig();
+    if (!argosConfig.parallelNonce) {
+        throw new Error("Playwright shard mode detected. Please specify ARGOS_PARALLEL_NONCE env variable. Read https://argos-ci.com/docs/parallel-testing");
+    }
+    return {
+        total: config.shard.total,
+        nonce: argosConfig.parallelNonce
+    };
+};
 class ArgosReporter {
     uploadDir;
     config;
+    playwrightConfig;
     constructor(config){
         this.config = config;
     }
@@ -111,12 +135,19 @@ class ArgosReporter {
         }
         await writeFile(path, body);
     }
-    async onBegin(_config, _suite) {
+    getAutomaticScreenshotName(test, result) {
+        let name = test.titlePath().join(" ");
+        name += result.retry > 0 ? ` #${result.retry + 1}` : "";
+        name += result.status === "failed" || result.status === "timedOut" ? " (failed)" : "";
+        return name;
+    }
+    async onBegin(config, _suite) {
+        this.playwrightConfig = config;
         this.uploadDir = await createTempDirectory();
     }
     async onTestEnd(test, result) {
         await Promise.all(result.attachments.map(async (attachment)=>{
-            if (attachment.name.startsWith("argos/")) {
+            if (checkIsArgosScreenshot(attachment)) {
                 if (!attachment.body) {
                     throw new Error("Missing attachment body");
                 }
@@ -125,24 +156,29 @@ class ArgosReporter {
                 return;
             }
             // Error screenshots are sent to Argos
-            if (attachment.name === "screenshot" && attachment.contentType === "image/png" && attachment.path) {
-                const metadata = await getMetadataFromTestCase(test);
-                const name = test.titlePath().join(" ");
-                const path = join(this.uploadDir, result.status === "failed" || result.status === "timedOut" ? `${name} (failed).png` : `${name}.png`);
+            if (checkIsAutomaticScreenshot(attachment)) {
+                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`);
                 await Promise.all([
                     this.writeFile(path + ".argos.json", JSON.stringify(metadata)),
-                    copyFile(attachment.path, path)
+                    copyFile(attachment.path, path),
+                    trace ? copyFile(trace.path, path + ".pw-trace.zip") : null
                 ]);
+                return;
             }
         }));
     }
     async onEnd(_result) {
+        const parallel = getParallelFromConfig(this.playwrightConfig);
         try {
             await upload({
                 files: [
                     "**/*.png"
                 ],
                 root: this.uploadDir,
+                parallel: parallel ?? undefined,
                 ...this.config
             });
         } catch (error) {

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.0.1",
+  "version": "1.2.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -43,11 +43,11 @@
   },
   "dependencies": {
     "@argos-ci/browser": "1.0.0",
-    "@argos-ci/core": "1.0.0",
-    "@argos-ci/util": "1.0.0"
+    "@argos-ci/core": "1.2.0",
+    "@argos-ci/util": "1.1.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.0",
+    "@argos-ci/cli": "1.0.2",
     "@argos-ci/playwright": "workspace:.",
     "@playwright/test": "^1.38.1",
     "@types/node": "^16.0.0"
@@ -58,5 +58,5 @@
     "test": "pnpm exec playwright test",
     "e2e": "WITH_ARGOS_REPORTER=true pnpm run test"
   },
-  "gitHead": "772629785526eb051bc5f1ccabe927ff9781a7c4"
+  "gitHead": "47a939474ca0c0d55ca5360dcaa5f8912547ed76"
 }