@argos-ci/playwright 1.7.1 → 1.9.0

package/dist/index.d.ts

@@ -15,6 +15,11 @@ type ArgosScreenshotOptions = {
      * Custom CSS evaluated during the screenshot process.
      */
     argosCSS?: string;
+    /**
+     * Disable hover effects by moving the mouse to the top-left corner of the page.
+     * @default true
+     */
+    disableHover?: boolean;
 } & LocatorOptions & ScreenshotOptions<LocatorScreenshotOptions> & ScreenshotOptions<PageScreenshotOptions>;
-declare function argosScreenshot(page: Page, name: string, { element, has, hasText, viewports, argosCSS, ...options }?: ArgosScreenshotOptions): Promise<void>;
+declare function argosScreenshot(page: Page, name: string, options?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -1,17 +1,17 @@
-import { mkdir, readFile } from 'node:fs/promises';
+import { mkdir } from 'node:fs/promises';
 import { relative, resolve, dirname } from 'node:path';
-import { createRequire } from 'node:module';
-import { resolveViewport } from '@argos-ci/browser';
+import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
 import { getGitRepositoryPath, readVersionFromPackage, getScreenshotName, writeMetadata, getMetadataPath } from '@argos-ci/util';
+import { createRequire } from 'node:module';
 
 function getAttachmentName(name, type) {
     return `argos/${type}___${name}`;
 }
 
-const require$2 = createRequire(import.meta.url);
+const require$1 = createRequire(import.meta.url);
 const tryResolve = (pkg)=>{
     try {
-        return require$2.resolve(pkg);
+        return require$1.resolve(pkg);
     } catch  {
         return null;
     }
@@ -35,7 +35,7 @@ async function getAutomationLibrary() {
     throw new Error(`Unable to find any of the following packages: ${libraries.join(", ")}`);
 }
 async function getArgosPlaywrightVersion() {
-    const pkgPath = require$2.resolve("@argos-ci/playwright/package.json");
+    const pkgPath = require$1.resolve("@argos-ci/playwright/package.json");
     return readVersionFromPackage(pkgPath);
 }
 async function getLibraryMetadata() {
@@ -69,23 +69,20 @@ async function getTestMetadataFromTestInfo(testInfo) {
     return testMetadata;
 }
 
-const require$1 = createRequire(import.meta.url);
+const require = createRequire(import.meta.url);
 function checkIsUsingArgosReporter(testInfo) {
-    const reporterPath = require$1.resolve("@argos-ci/playwright/reporter");
+    const reporterPath = require.resolve("@argos-ci/playwright/reporter");
     return testInfo.config.reporter.some((reporter)=>reporter[0].includes("@argos-ci/playwright/reporter") || reporter[0] === reporterPath);
 }
 
-const require = createRequire(import.meta.url);
 const screenshotFolder = "./screenshots";
 /**
  * Inject Argos script into the page.
  */ async function injectArgos(page) {
     const injected = await page.evaluate(()=>typeof window.__ARGOS__ !== "undefined");
     if (injected) return;
-    const fileName = require.resolve("@argos-ci/browser/global.js");
-    const content = await readFile(fileName, "utf-8");
     await page.addScriptTag({
-        content
+        content: getGlobalScript()
     });
 }
 async function getTestInfo() {
@@ -103,7 +100,33 @@ function getViewportSize(page) {
     }
     return viewportSize;
 }
-async function argosScreenshot(page, name, { element, has, hasText, viewports, argosCSS, ...options } = {}) {
+/**
+ * Setup Argos for the screenshot process.
+ * @returns A function to teardown Argos.
+ */ async function setup(page, options) {
+    const { disableHover = true, fullPage, argosCSS } = options;
+    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.setup({
+            fullPage,
+            argosCSS
+        }), {
+        fullPage,
+        argosCSS
+    });
+    if (disableHover) {
+        await page.mouse.move(0, 0);
+    }
+    return async ()=>{
+        await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.teardown({
+                fullPage,
+                argosCSS
+            }), {
+            fullPage,
+            argosCSS
+        });
+    };
+}
+async function argosScreenshot(page, name, options = {}) {
+    const { element, has, hasText, viewports, argosCSS, ...playwrightOptions } = options;
     if (!page) {
         throw new Error("A Playwright `page` object is required.");
     }
@@ -126,13 +149,7 @@ async function argosScreenshot(page, name, { element, has, hasText, viewports, a
     ]);
     const originalViewportSize = getViewportSize(page);
     const fullPage = options.fullPage !== undefined ? options.fullPage : handle === page;
-    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.setup({
-            fullPage,
-            argosCSS
-        }), {
-        fullPage,
-        argosCSS
-    });
+    const teardown = await setup(page, options);
     async function collectMetadata(testInfo) {
         const [colorScheme, mediaType, libMetadata, testMetadata] = await Promise.all([
             page.evaluate(()=>window.__ARGOS__.getColorScheme()),
@@ -182,7 +199,7 @@ async function argosScreenshot(page, name, { element, has, hasText, viewports, a
                     page.locator('[data-visual-test="blackout"]')
                 ],
                 animations: "disabled",
-                ...options
+                ...playwrightOptions
             }),
             screenshotPath ? writeMetadata(screenshotPath, metadata) : null
         ]);
@@ -214,14 +231,7 @@ async function argosScreenshot(page, name, { element, has, hasText, viewports, a
     } else {
         await stabilizeAndScreenshot(name);
     }
-    // Teardown Argos
-    await page.evaluate(({ fullPage, argosCSS })=>window.__ARGOS__.teardown({
-            fullPage,
-            argosCSS
-        }), {
-        fullPage,
-        argosCSS
-    });
+    await teardown();
 }
 
 export { argosScreenshot };

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.7.1",
+  "version": "1.9.0",
   "author": "Smooth Code",
   "license": "MIT",
   "repository": {
@@ -42,13 +42,13 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "@argos-ci/browser": "1.3.0",
-    "@argos-ci/core": "1.5.1",
+    "@argos-ci/browser": "1.4.1",
+    "@argos-ci/core": "1.5.2",
     "@argos-ci/util": "1.2.0",
     "chalk": "^5.3.0"
   },
   "devDependencies": {
-    "@argos-ci/cli": "1.0.8",
+    "@argos-ci/cli": "1.0.9",
     "@argos-ci/playwright": "workspace:.",
     "@playwright/test": "^1.38.1",
     "@types/node": "^16.0.0"
@@ -59,5 +59,5 @@
     "test": "pnpm exec playwright test",
     "e2e": "UPLOAD_TO_ARGOS=true pnpm run test"
   },
-  "gitHead": "174a9847d8a547d4fa4acb7602ea3687dc9bde8e"
+  "gitHead": "47e813466b9224cb428eb44ee4d4d450f737763e"
 }