@argos-ci/playwright 3.10.0 → 4.1.0

package/dist/index.d.ts

@@ -45,7 +45,14 @@ type ArgosScreenshotOptions = {
      * Run a function before taking the screenshot.
      * When using viewports, this function will run before taking sreenshots on each viewport.
      */
-    beforeScreenshot?: () => Promise<void> | void;
+    beforeScreenshot?: (api: {
+        /**
+         * Run Argos stabilization alorithm.
+         * Accepts an object to customize the stabilization.
+         * Note that this function is independent of the `stabilize` option.
+         */
+        runStabilization: (options?: StabilizationOptions) => Promise<void>;
+    }) => Promise<void> | void;
     /**
      * Run a function after taking the screenshot.
      * When using viewports, this function will run after taking sreenshots on each viewport.

package/dist/index.js

@@ -123,7 +123,7 @@ async function getTestInfo() {
   try {
     const { test } = await import("@playwright/test");
     return test.info();
-  } catch (error) {
+  } catch {
     return null;
   }
 }
@@ -179,7 +179,7 @@ async function argosScreenshot(page, name, options = {}) {
     has,
     hasText,
     viewports,
-    argosCSS,
+    argosCSS: _argosCSS,
     stabilize = true,
     root = DEFAULT_SCREENSHOT_ROOT,
     ...playwrightOptions
@@ -222,8 +222,9 @@ async function argosScreenshot(page, name, options = {}) {
     }
     const browserName = browser.browserType().name();
     const browserVersion = browser.version();
+    const url = page.url();
     const metadata = {
-      url: page.url(),
+      url,
       viewport: viewportSize,
       colorScheme,
       mediaType,
@@ -236,28 +237,32 @@ async function argosScreenshot(page, name, options = {}) {
     };
     return metadata;
   };
-  const stabilizeAndScreenshot = async (name2) => {
-    await options.beforeScreenshot?.();
-    if (stabilize) {
-      const stabilizationOptions = typeof stabilize === "object" ? stabilize : {};
-      try {
-        await page.waitForFunction(
-          (options2) => window.__ARGOS__.checkIsStable(options2),
-          stabilizationOptions
-        );
-      } catch (error) {
-        const reasons = await page.evaluate(
-          (options2) => window.__ARGOS__.getStabilityFailureReasons(options2),
-          stabilizationOptions
-        );
-        throw new Error(
-          `
+  const runStabilization = async (options2 = {}) => {
+    try {
+      await page.waitForFunction(
+        (options3) => window.__ARGOS__.checkIsStable(options3),
+        options2
+      );
+    } catch (error) {
+      const reasons = await page.evaluate(
+        (options3) => window.__ARGOS__.getStabilityFailureReasons(
+          options3
+        ),
+        options2
+      );
+      throw new Error(
+        `
 Failed to stabilize screenshot, found the following issues:
 ${reasons.map((reason) => `- ${reason}`).join("\n")}
         `.trim(),
-          { cause: error }
-        );
-      }
+        { cause: error }
+      );
+    }
+  };
+  const stabilizeAndScreenshot = async (name2) => {
+    await options.beforeScreenshot?.({ runStabilization });
+    if (stabilize) {
+      await runStabilization(stabilize === true ? void 0 : stabilize);
     }
     const names = getScreenshotNames(name2, testInfo);
     const metadata = await collectMetadata(testInfo);

package/dist/reporter.d.ts

@@ -1,4 +1,4 @@
-import { Reporter, FullConfig, TestResult, Suite, TestCase, FullResult } from '@playwright/test/reporter';
+import { Reporter, FullConfig, TestResult, TestCase, FullResult } from '@playwright/test/reporter';
 import { UploadParameters } from '@argos-ci/core';
 
 /**
@@ -18,7 +18,7 @@ type DynamicBuildName<T extends readonly string[]> = {
      */
     get: (test: TestCase) => T[number];
 };
-type ArgosReporterOptions<T extends string[] = string[]> = Omit<UploadParameters, "files" | "root" | "buildName"> & {
+type ArgosReporterOptions<T extends string[] = string[]> = Omit<UploadParameters, "files" | "root" | "buildName" | "metadata"> & {
     /**
      * Upload the report to Argos.
      * @default true
@@ -54,7 +54,7 @@ declare class ArgosReporter implements Reporter {
      * Get the root upload directory (cached).
      */
     getRootUploadDirectory(): Promise<string>;
-    onBegin(config: FullConfig, _suite: Suite): void;
+    onBegin(config: FullConfig): void;
     onTestEnd(test: TestCase, result: TestResult): Promise<void>;
     onEnd(result: FullResult): Promise<{
         status: "failed";

package/dist/reporter.js

@@ -153,8 +153,12 @@ function createArgosReporterOptions(options) {
   return options;
 }
 async function getParallelFromConfig(config) {
-  if (!config.shard) return null;
-  if (config.shard.total === 1) return null;
+  if (!config.shard) {
+    return null;
+  }
+  if (config.shard.total === 1) {
+    return null;
+  }
   const argosConfig = await readConfig();
   if (!argosConfig.parallelNonce) {
     throw new Error(
@@ -221,7 +225,7 @@ var ArgosReporter = class {
     }
     return this.rootUploadDirectoryPromise;
   }
-  onBegin(config, _suite) {
+  onBegin(config) {
     debug("ArgosReporter:onBegin");
     this.playwrightConfig = config;
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/playwright",
   "description": "Playwright SDK for visual testing with Argos.",
-  "version": "3.10.0",
+  "version": "4.1.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -47,14 +47,14 @@
     "node": ">=18.16.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "2.2.2",
-    "@argos-ci/core": "3.0.0",
-    "@argos-ci/util": "2.2.2",
+    "@argos-ci/browser": "3.0.1",
+    "@argos-ci/core": "3.1.0",
+    "@argos-ci/util": "2.3.0",
     "chalk": "^5.4.1",
     "debug": "^4.4.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "workspace:*",
+    "@argos-ci/cli": "2.5.5",
     "@argos-ci/playwright": "workspace:.",
     "@playwright/test": "^1.49.1",
     "@types/debug": "^4.1.12",
@@ -65,5 +65,5 @@
     "test": "pnpm exec -- playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "0c91306ae0cb8bec5ef93db79565635e405086f7"
+  "gitHead": "8d46b4d4fc2b59b4fe93bac6fda02fb18440f935"
 }