@argos-ci/playwright 1.4.2 → 1.5.0

package/dist/index.mjs

@@ -164,7 +164,7 @@ async function argosScreenshot(page, name, { element, has, hasText, viewports, a
     async function stabilizeAndScreenshot(name) {
         await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
         const metadata = await collectMetadata(testInfo);
-        const screenshotPath = useArgosReporter ? null : resolve(screenshotFolder, `${name}.png`);
+        const screenshotPath = useArgosReporter ? testInfo.outputPath("argos", `${name}.png`) : resolve(screenshotFolder, `${name}.png`);
         if (screenshotPath) {
             const dir = dirname(screenshotPath);
             if (dir !== screenshotFolder) {

package/dist/reporter.d.ts

@@ -1,11 +1,17 @@
 /// <reference types="node" />
 import { FullConfig, FullResult, Reporter, Suite, TestCase, TestResult } from "@playwright/test/reporter";
 import { UploadParameters } from "@argos-ci/core";
-type ArgosReporterOptions = Omit<UploadParameters, "files" | "root">;
+type ArgosReporterOptions = Omit<UploadParameters, "files" | "root"> & {
+    /**
+     * If `true`, the report will be uploaded to Argos.
+     */
+    uploadToArgos?: boolean;
+};
 declare class ArgosReporter implements Reporter {
     uploadDir: string;
     config: ArgosReporterOptions;
     playwrightConfig: FullConfig;
+    uploadToArgos: boolean;
     constructor(config: ArgosReporterOptions);
     writeFile(path: string, body: Buffer | string): Promise<void>;
     getAutomaticScreenshotName(test: TestCase, result: TestResult): string;

package/dist/reporter.mjs

@@ -1,3 +1,4 @@
+import chalk from 'chalk';
 import { upload, readConfig } from '@argos-ci/core';
 import { randomBytes } from 'node:crypto';
 import { mkdir, writeFile, copyFile } from 'node:fs/promises';
@@ -22,10 +23,10 @@ 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);
+    return attachment.name.startsWith("argos/") && attachment.contentType === "image/png" && Boolean(attachment.path);
 }
 function checkIsArgosScreenshotMetadata(attachment) {
-    return attachment.name.startsWith("argos/") && attachment.contentType === "application/json" && Boolean(attachment.body);
+    return attachment.name.startsWith("argos/") && attachment.contentType === "application/json" && Boolean(attachment.path);
 }
 function checkIsAutomaticScreenshot(attachment) {
     return attachment.name === "screenshot" && attachment.contentType === "image/png" && Boolean(attachment.path);
@@ -126,8 +127,10 @@ class ArgosReporter {
     uploadDir;
     config;
     playwrightConfig;
+    uploadToArgos;
     constructor(config){
         this.config = config;
+        this.uploadToArgos = config.uploadToArgos ?? false;
     }
     async writeFile(path, body) {
         const dir = dirname(path);
@@ -152,7 +155,7 @@ class ArgosReporter {
         await Promise.all(result.attachments.map(async (attachment)=>{
             if (checkIsArgosScreenshot(attachment) || checkIsArgosScreenshotMetadata(attachment)) {
                 const path = join(this.uploadDir, getAttachmentFilename(attachment.name));
-                await this.writeFile(path, attachment.body);
+                await copyFile(attachment.path, path);
                 return;
             }
             // Error screenshots are sent to Argos
@@ -171,9 +174,10 @@ class ArgosReporter {
         }));
     }
     async onEnd(_result) {
+        if (!this.uploadToArgos) return;
         const parallel = getParallelFromConfig(this.playwrightConfig);
         try {
-            await upload({
+            const res = await upload({
                 files: [
                     "**/*.png"
                 ],
@@ -181,6 +185,7 @@ class ArgosReporter {
                 parallel: parallel ?? undefined,
                 ...this.config
             });
+            console.log(chalk.green(`✅ Argos build created: ${res.build.url}`));
         } catch (error) {
             console.error(error);
             return {

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.4.2",
+  "version": "1.5.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -44,7 +44,8 @@
   "dependencies": {
     "@argos-ci/browser": "1.2.2",
     "@argos-ci/core": "1.3.0",
-    "@argos-ci/util": "1.1.0"
+    "@argos-ci/util": "1.1.0",
+    "chalk": "^5.3.0"
   },
   "devDependencies": {
     "@argos-ci/cli": "1.0.4",
@@ -56,7 +57,7 @@
     "prebuild": "rm -rf dist",
     "build": "rollup -c",
     "test": "pnpm exec playwright test",
-    "e2e": "WITH_ARGOS_REPORTER=true pnpm run test"
+    "e2e": "pnpm run test"
   },
-  "gitHead": "672a6e0fce11cd9e0acd8b77dad137d85d224ef9"
+  "gitHead": "dd3031f89cc03084a65b2b956783441d3dd75d9c"
 }