@argos-ci/playwright 3.3.0 → 3.4.0

package/dist/index.d.ts

@@ -20,6 +20,31 @@ type ArgosScreenshotOptions = {
      * @default true
      */
     disableHover?: boolean;
+    /**
+     * Sensitivity threshold between 0 and 1.
+     * The higher the threshold, the less sensitive the diff will be.
+     * @default 0.5
+     */
+    threshold?: number;
 } & LocatorOptions & ScreenshotOptions<LocatorScreenshotOptions> & ScreenshotOptions<PageScreenshotOptions>;
-declare function argosScreenshot(page: Page, name: string, options?: ArgosScreenshotOptions): Promise<void>;
+/**
+ * Stabilize the UI and takes a screenshot of the application under test.
+ *
+ * @example
+ *    argosScreenshot(page, "my-screenshot")
+ * @see https://argos-ci.com/docs/playwright#api-overview
+ */
+declare function argosScreenshot(
+/**
+ * Playwright `page` object.
+ */
+page: Page, 
+/**
+ * Name of the screenshot. Must be unique.
+ */
+name: string, 
+/**
+ * Options for the screenshot.
+ */
+options?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { mkdir } from 'node:fs/promises';
 import { relative, resolve, dirname } from 'node:path';
 import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
-import { getGitRepositoryPath, readVersionFromPackage, getScreenshotName, writeMetadata, getMetadataPath } from '@argos-ci/util';
+import { getGitRepositoryPath, readVersionFromPackage, getScreenshotName, validateThreshold, writeMetadata, getMetadataPath } from '@argos-ci/util';
 import { createRequire } from 'node:module';
 
 function getAttachmentName(name, type) {
@@ -60,6 +60,7 @@ async function getTestMetadataFromTestInfo(testInfo) {
         titlePath: testInfo.titlePath,
         retry: testInfo.retry,
         retries: testInfo.project.retries,
+        repeat: testInfo.repeatEachIndex,
         location: {
             file: repositoryPath ? relative(repositoryPath, testInfo.file) : testInfo.file,
             line: testInfo.line,
@@ -125,7 +126,40 @@ function getViewportSize(page) {
         });
     };
 }
-async function argosScreenshot(page, name, options = {}) {
+/**
+ * Get the screenshot names based on the test info.
+ */ function getScreenshotNames(name, testInfo) {
+    if (testInfo) {
+        const projectName = `${testInfo.project.name}/${name}`;
+        if (testInfo.repeatEachIndex > 0) {
+            return {
+                name: `${projectName} repeat-${testInfo.repeatEachIndex}`,
+                baseName: projectName
+            };
+        }
+        return {
+            name: projectName,
+            baseName: null
+        };
+    }
+    return {
+        name,
+        baseName: null
+    };
+}
+/**
+ * Stabilize the UI and takes a screenshot of the application under test.
+ *
+ * @example
+ *    argosScreenshot(page, "my-screenshot")
+ * @see https://argos-ci.com/docs/playwright#api-overview
+ */ async function argosScreenshot(/**
+   * Playwright `page` object.
+   */ page, /**
+   * Name of the screenshot. Must be unique.
+   */ name, /**
+   * Options for the screenshot.
+   */ options = {}) {
     const { element, has, hasText, viewports, argosCSS, ...playwrightOptions } = options;
     if (!page) {
         throw new Error("A Playwright `page` object is required.");
@@ -180,9 +214,17 @@ async function argosScreenshot(page, name, options = {}) {
     };
     const stabilizeAndScreenshot = async (name)=>{
         await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
+        const names = getScreenshotNames(name, testInfo);
         const metadata = await collectMetadata(testInfo);
-        const nameInProject = testInfo?.project.name ? `${testInfo.project.name}/${name}` : name;
-        const screenshotPath = useArgosReporter && testInfo ? testInfo.outputPath("argos", `${nameInProject}.png`) : resolve(screenshotFolder, `${nameInProject}.png`);
+        metadata.transient = {};
+        if (options.threshold !== undefined) {
+            validateThreshold(options.threshold);
+            metadata.transient.threshold = options.threshold;
+        }
+        if (names.baseName) {
+            metadata.transient.baseName = `${names.baseName}.png`;
+        }
+        const screenshotPath = useArgosReporter && testInfo ? testInfo.outputPath("argos", `${names.name}.png`) : resolve(screenshotFolder, `${names.name}.png`);
         const dir = dirname(screenshotPath);
         if (dir !== screenshotFolder) {
             await mkdir(dirname(screenshotPath), {
@@ -204,11 +246,11 @@ async function argosScreenshot(page, name, options = {}) {
         ]);
         if (useArgosReporter && testInfo) {
             await Promise.all([
-                testInfo.attach(getAttachmentName(nameInProject, "metadata"), {
+                testInfo.attach(getAttachmentName(names.name, "metadata"), {
                     path: getMetadataPath(screenshotPath),
                     contentType: "application/json"
                 }),
-                testInfo.attach(getAttachmentName(nameInProject, "screenshot"), {
+                testInfo.attach(getAttachmentName(names.name, "screenshot"), {
                     path: screenshotPath,
                     contentType: "image/png"
                 })

package/dist/reporter.d.ts

@@ -59,7 +59,6 @@ declare class ArgosReporter implements Reporter {
      * Copy the trace file if found in the result.
      */
     copyTraceIfFound(result: TestResult, path: string): Promise<void>;
-    getAutomaticScreenshotName(test: TestCase, result: TestResult): string;
     /**
      * Get the root upload directory (cached).
      */

package/dist/reporter.mjs

@@ -84,6 +84,7 @@ async function getTestMetadataFromTestCase(testCase, testResult) {
         titlePath: testCase.titlePath(),
         retry: testResult.retry,
         retries: testCase.retries,
+        repeat: testCase.repeatEachIndex,
         location: {
             file: repositoryPath ? relative(repositoryPath, testCase.location.file) : testCase.location.file,
             line: testCase.location.line,
@@ -152,6 +153,14 @@ async function getParallelFromConfig(config) {
         index: config.shard.current
     };
 }
+/**
+ * Get the automatic screenshot name.
+ */ function 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;
+}
 class ArgosReporter {
     rootUploadDirectoryPromise;
     uploadDirectoryPromises;
@@ -188,12 +197,6 @@ class ArgosReporter {
             await this.copyFile(trace.path, path + ".pw-trace.zip");
         }
     }
-    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;
-    }
     /**
    * Get the root upload directory (cached).
    */ getRootUploadDirectory() {
@@ -226,7 +229,7 @@ class ArgosReporter {
             // Error screenshots are sent to Argos
             if (checkIsAutomaticScreenshot(attachment)) {
                 const metadata = await getMetadataFromTestCase(test, result);
-                const name = this.getAutomaticScreenshotName(test, result);
+                const name = getAutomaticScreenshotName(test, result);
                 const path = join(uploadDir, `${name}.png`);
                 await Promise.all([
                     this.writeFile(path + ".argos.json", JSON.stringify(metadata)),

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": "3.3.0",
+  "version": "3.4.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -43,13 +43,13 @@
   },
   "dependencies": {
     "@argos-ci/browser": "2.1.2",
-    "@argos-ci/core": "2.3.0",
-    "@argos-ci/util": "2.0.0",
+    "@argos-ci/core": "2.4.0",
+    "@argos-ci/util": "2.1.0",
     "chalk": "^5.3.0",
     "debug": "^4.3.4"
   },
   "devDependencies": {
-    "@argos-ci/cli": "2.2.0",
+    "@argos-ci/cli": "2.3.0",
     "@argos-ci/playwright": "workspace:.",
     "@playwright/test": "^1.43.0",
     "@types/debug": "^4.1.12",
@@ -61,5 +61,5 @@
     "test": "pnpm exec -- playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "5c09f1d861630af0d98200e52a0f44876bb7f891"
+  "gitHead": "aca82cf842a6d8310611a8594c581794df85cbd8"
 }