@argos-ci/playwright 0.0.7 → 0.0.8-alpha.187

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2023 Smooth Code
+Copyright 2022 Smooth Code
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.cjs

@@ -1,6 +1,8 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */ const argosScreenshot = async (...args)=>{
+// @ts-ignore
+const argosScreenshot = async (...args)=>{
     // @ts-ignore
-    const { argosScreenshot  } = await import('./index.mjs');
+    const { argosScreenshot } = await import('./index.mjs');
     return argosScreenshot(...args);
 };
+// @ts-ignore
 exports.argosScreenshot = argosScreenshot;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { ElementHandle, LocatorScreenshotOptions, PageScreenshotOptions, Page } from '@playwright/test';
-
+import { Page, PageScreenshotOptions, LocatorScreenshotOptions, ElementHandle } from "@playwright/test";
+import { ViewportOption } from "@argos-ci/browser";
 type LocatorOptions = Parameters<Page["locator"]>[1];
 type ScreenshotOptions<TBase extends PageScreenshotOptions | LocatorScreenshotOptions> = Omit<TBase, "encoding" | "type" | "omitBackground" | "path">;
 type ArgosScreenshotOptions = {
@@ -7,7 +7,10 @@ type ArgosScreenshotOptions = {
      * ElementHandle or string selector of the element to take a screenshot of.
      */
     element?: string | ElementHandle;
+    /**
+     * Viewports to take screenshots of.
+     */
+    viewports?: ViewportOption[];
 } & LocatorOptions & ScreenshotOptions<LocatorScreenshotOptions> & ScreenshotOptions<PageScreenshotOptions>;
-declare function argosScreenshot(page: Page, name: string, { element, has, hasText, ...options }?: ArgosScreenshotOptions): Promise<void>;
-
+declare function argosScreenshot(page: Page, name: string, { element, has, hasText, viewports, ...options }?: ArgosScreenshotOptions): Promise<void>;
 export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -1,78 +1,182 @@
-import { mkdir } from 'node:fs/promises';
-import { resolve } from 'node:path';
+import { mkdir, readFile } from 'node:fs/promises';
+import { relative, resolve } from 'node:path';
+import { createRequire } from 'node:module';
+import { resolveViewport } from '@argos-ci/browser';
+import { getGitRepositoryPath, readVersionFromPackage, getScreenshotName, writeMetadata } from '@argos-ci/util';
 
-const screenshotFolder = "./screenshots";
-const GLOBAL_STYLES = `
-  /* Hide carets */
-  * { caret-color: transparent !important; }
+function getAttachmentName(name, type) {
+    return `argos/${type}___${name}`;
+}
 
-  /* Hide scrollbars */
-  ::-webkit-scrollbar {
-    display: none !important;
-  }
+const require$2 = createRequire(import.meta.url);
+async function getPlaywrightVersion() {
+    const pkgPath = require$2.resolve("playwright/package.json");
+    return readVersionFromPackage(pkgPath);
+}
+async function getArgosPlaywrightVersion() {
+    const pkgPath = require$2.resolve("@argos-ci/playwright/package.json");
+    return readVersionFromPackage(pkgPath);
+}
+async function getLibraryMetadata() {
+    const [playwrightVersion, argosPlaywrightVersion] = await Promise.all([
+        getPlaywrightVersion(),
+        getArgosPlaywrightVersion()
+    ]);
+    const metadata = {
+        automationLibrary: {
+            name: "playwright",
+            version: playwrightVersion
+        },
+        sdk: {
+            name: "@argos-ci/playwright",
+            version: argosPlaywrightVersion
+        }
+    };
+    return metadata;
+}
+async function getTestMetadataFromTestInfo(testInfo) {
+    const repositoryPath = await getGitRepositoryPath();
+    const testMetadata = {
+        id: testInfo.testId,
+        title: testInfo.title,
+        titlePath: testInfo.titlePath,
+        location: {
+            file: repositoryPath ? relative(repositoryPath, testInfo.file) : testInfo.file,
+            line: testInfo.line,
+            column: testInfo.column
+        }
+    };
+    return testMetadata;
+}
 
-  /* Generic hide */
-  [data-visual-test="transparent"] {
-    color: transparent !important;
-    font-family: monospace !important;
-    opacity: 0 !important;
-  }
+const require$1 = createRequire(import.meta.url);
+function checkIsUsingArgosReporter(testInfo) {
+    const reporterPath = require$1.resolve("@argos-ci/playwright/reporter");
+    return testInfo.config.reporter.some((reporter)=>reporter[0].includes("@argos-ci/playwright/reporter") || reporter[0] === reporterPath);
+}
 
-  [data-visual-test="removed"] {
-    display: none !important;
-  }
-`;
-// Check if the fonts are loaded
-function waitForFontLoading() {
-    return document.fonts.status === "loaded";
+const require = createRequire(import.meta.url);
+const screenshotFolder = "./screenshots";
+/**
+ * Inject Argos script into the page.
+ */ async function injectArgos(page) {
+    const fileName = require.resolve("@argos-ci/browser/global.js");
+    const content = await readFile(fileName, "utf-8");
+    await page.addScriptTag({
+        content
+    });
 }
-// Check if the images are loaded
-function waitForImagesLoading() {
-    const allImages = Array.from(document.images);
-    allImages.forEach((img)=>img.loading = "eager");
-    return allImages.every((img)=>img.complete);
+async function getTestInfo() {
+    try {
+        const { test } = await import('@playwright/test');
+        return test.info();
+    } catch (error) {
+        return null;
+    }
 }
-// Disable spellcheck to avoid red underlines
-function disableSpellCheck() {
-    const query = "[contenteditable]:not([contenteditable=false]):not([spellcheck=false]), input:not([spellcheck=false]), textarea:not([spellcheck=false])";
-    const inputs = document.querySelectorAll(query);
-    inputs.forEach((input)=>input.setAttribute("spellcheck", "false"));
-    return true;
+function getViewportSize(page) {
+    const viewportSize = page.viewportSize();
+    if (!viewportSize) {
+        throw new Error("Can't take screenshots without a viewport.");
+    }
+    return viewportSize;
 }
-async function argosScreenshot(page, name, { element , has , hasText , ...options } = {}) {
-    if (!page) throw new Error("A Playwright `page` object is required.");
-    if (!name) throw new Error("The `name` argument is required.");
+async function argosScreenshot(page, name, { element, has, hasText, viewports, ...options } = {}) {
+    if (!page) {
+        throw new Error("A Playwright `page` object is required.");
+    }
+    if (!name) {
+        throw new Error("The `name` argument is required.");
+    }
     const handle = typeof element === "string" ? page.locator(element, {
         has,
         hasText
     }) : element ?? page;
-    mkdir(screenshotFolder, {
-        recursive: true
-    });
-    // Inject global styles
-    await page.addStyleTag({
-        content: GLOBAL_STYLES
-    });
-    // Wait for all busy elements to be loaded
-    await page.waitForSelector('[aria-busy="true"]', {
-        state: "hidden"
-    });
-    // Code injection to improve the screenshot stability
+    const testInfo = await getTestInfo();
+    const useArgosReporter = Boolean(testInfo && checkIsUsingArgosReporter(testInfo));
     await Promise.all([
-        page.waitForFunction(waitForImagesLoading),
-        page.waitForFunction(waitForFontLoading),
-        page.waitForFunction(disableSpellCheck)
+        // Create the screenshot folder if it doesn't exist
+        useArgosReporter ? null : mkdir(screenshotFolder, {
+            recursive: true
+        }),
+        // Inject Argos script into the page
+        injectArgos(page)
     ]);
-    await handle.screenshot({
-        path: resolve(screenshotFolder, `${name}.png`),
-        type: "png",
-        fullPage: true,
-        mask: [
-            page.locator('[data-visual-test="blackout"]')
-        ],
-        animations: "disabled",
-        ...options
-    });
+    const originalViewportSize = getViewportSize(page);
+    await page.evaluate(()=>window.__ARGOS__.prepareForScreenshot());
+    async function collectMetadata(testInfo) {
+        const [colorScheme, mediaType, libMetadata, testMetadata] = await Promise.all([
+            page.evaluate(()=>window.__ARGOS__.getColorScheme()),
+            page.evaluate(()=>window.__ARGOS__.getMediaType()),
+            getLibraryMetadata(),
+            testInfo ? getTestMetadataFromTestInfo(testInfo) : null
+        ]);
+        const viewportSize = getViewportSize(page);
+        const browser = page.context().browser();
+        if (!browser) {
+            throw new Error("Can't take screenshots without a browser.");
+        }
+        const browserName = browser.browserType().name();
+        const browserVersion = browser.version();
+        const metadata = {
+            url: page.url(),
+            viewport: viewportSize,
+            colorScheme,
+            mediaType,
+            test: testMetadata,
+            browser: {
+                name: browserName,
+                version: browserVersion
+            },
+            ...libMetadata
+        };
+        return metadata;
+    }
+    async function stabilizeAndScreenshot(name) {
+        await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
+        const metadata = await collectMetadata(testInfo);
+        const screenshotPath = useArgosReporter ? null : resolve(screenshotFolder, `${name}.png`);
+        const [screenshot] = await Promise.all([
+            handle.screenshot({
+                path: screenshotPath ?? undefined,
+                type: "png",
+                fullPage: handle === page,
+                mask: [
+                    page.locator('[data-visual-test="blackout"]')
+                ],
+                animations: "disabled",
+                ...options
+            }),
+            screenshotPath ? writeMetadata(screenshotPath, metadata) : null
+        ]);
+        if (useArgosReporter) {
+            await Promise.all([
+                testInfo.attach(getAttachmentName(name, "metadata"), {
+                    body: JSON.stringify(metadata),
+                    contentType: "application/json"
+                }),
+                testInfo.attach(getAttachmentName(name, "screenshot"), {
+                    body: screenshot,
+                    contentType: "image/png"
+                })
+            ]);
+        }
+    }
+    // If no viewports are specified, take a single screenshot
+    if (!viewports) {
+        await stabilizeAndScreenshot(name);
+        return;
+    }
+    // Take screenshots for each viewport
+    for (const viewport of viewports){
+        const viewportSize = resolveViewport(viewport);
+        await page.setViewportSize(viewportSize);
+        await stabilizeAndScreenshot(getScreenshotName(name, {
+            viewportWidth: viewportSize.width
+        }));
+    }
+    // Restore the original viewport size
+    await page.setViewportSize(originalViewportSize);
 }
 
 export { argosScreenshot };

package/dist/reporter.d.ts

@@ -0,0 +1,14 @@
+import { FullConfig, FullResult, Reporter, Suite, TestCase, TestResult } from "@playwright/test/reporter";
+import { UploadParameters } from "@argos-ci/core";
+type ArgosReporterOptions = Omit<UploadParameters, "files" | "root">;
+declare class ArgosReporter implements Reporter {
+    uploadDir: string;
+    config: ArgosReporterOptions;
+    constructor(config: ArgosReporterOptions);
+    onBegin(_config: FullConfig, _suite: Suite): Promise<void>;
+    onTestEnd(test: TestCase, result: TestResult): Promise<void>;
+    onEnd(_result: FullResult): Promise<{
+        status: "failed";
+    } | undefined>;
+}
+export { ArgosReporter as default, ArgosReporterOptions };

package/dist/reporter.mjs

@@ -0,0 +1,131 @@
+import { upload } from '@argos-ci/core';
+import { randomBytes } from 'node:crypto';
+import { writeFile, copyFile, mkdir } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { relative, join } from 'node:path';
+import { getGitRepositoryPath, readVersionFromPackage } from '@argos-ci/util';
+import { createRequire } from 'node:module';
+
+function getOriginalAttachmentName(name) {
+    return name.replace(/^argos\/[^/]+___/, "");
+}
+function getAttachementFilename(name) {
+    if (name.startsWith("argos/screenshot")) {
+        return `${getOriginalAttachmentName(name)}.png`;
+    }
+    if (name.startsWith("argos/metadata")) {
+        return `${getOriginalAttachmentName(name)}.png.argos.json`;
+    }
+    throw new Error(`Unknown attachment name: ${name}`);
+}
+
+const require = createRequire(import.meta.url);
+async function getPlaywrightVersion() {
+    const pkgPath = require.resolve("playwright/package.json");
+    return readVersionFromPackage(pkgPath);
+}
+async function getArgosPlaywrightVersion() {
+    const pkgPath = require.resolve("@argos-ci/playwright/package.json");
+    return readVersionFromPackage(pkgPath);
+}
+async function getLibraryMetadata() {
+    const [playwrightVersion, argosPlaywrightVersion] = await Promise.all([
+        getPlaywrightVersion(),
+        getArgosPlaywrightVersion()
+    ]);
+    const metadata = {
+        automationLibrary: {
+            name: "playwright",
+            version: playwrightVersion
+        },
+        sdk: {
+            name: "@argos-ci/playwright",
+            version: argosPlaywrightVersion
+        }
+    };
+    return metadata;
+}
+async function getTestMetadataFromTestCase(testCase) {
+    const repositoryPath = await getGitRepositoryPath();
+    const testMetadata = {
+        title: testCase.title,
+        titlePath: testCase.titlePath(),
+        location: {
+            file: repositoryPath ? relative(repositoryPath, testCase.location.file) : testCase.location.file,
+            line: testCase.location.line,
+            column: testCase.location.column
+        }
+    };
+    return testMetadata;
+}
+async function getMetadataFromTestCase(testCase) {
+    const [libMetadata, testMetadata] = await Promise.all([
+        getLibraryMetadata(),
+        getTestMetadataFromTestCase(testCase)
+    ]);
+    const metadata = {
+        test: testMetadata,
+        ...libMetadata
+    };
+    return metadata;
+}
+
+async function createTempDirectory() {
+    const osTmpDirectory = tmpdir();
+    const path = join(osTmpDirectory, "argos." + randomBytes(16).toString("hex"));
+    await mkdir(path, {
+        recursive: true
+    });
+    return path;
+}
+class ArgosReporter {
+    uploadDir;
+    config;
+    constructor(config){
+        this.config = config;
+    }
+    async onBegin(_config, _suite) {
+        this.uploadDir = await createTempDirectory();
+    }
+    async onTestEnd(test, result) {
+        await Promise.all(result.attachments.map(async (attachment)=>{
+            if (attachment.name.startsWith("argos/")) {
+                if (!attachment.body) {
+                    throw new Error("Missing attachment body");
+                }
+                const path = join(this.uploadDir, getAttachementFilename(attachment.name));
+                await writeFile(path, attachment.body);
+                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, `${name} (failed).png`);
+                await Promise.all([
+                    writeFile(path + ".argos.json", JSON.stringify(metadata)),
+                    copyFile(attachment.path, path)
+                ]);
+            }
+        }));
+    }
+    async onEnd(_result) {
+        try {
+            await upload({
+                files: [
+                    "*.png"
+                ],
+                root: this.uploadDir,
+                ...this.config
+            });
+        } catch (error) {
+            console.error(error);
+            return {
+                status: "failed"
+            };
+        }
+        return;
+    }
+}
+
+export { ArgosReporter as default };

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@argos-ci/playwright",
   "description": "Visual testing solution to avoid visual regression. Playwright commands and utilities for Argos visual testing.",
-  "version": "0.0.7",
+  "version": "0.0.8-alpha.187+b2cbada",
   "author": "Smooth Code",
   "license": "MIT",
-  "repository": "github:argos-ci/argos-playwright",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/argos-ci/argos-javascript.git",
+    "directory": "packages/playwright"
+  },
   "keywords": [
     "playwright",
     "argos",
@@ -18,9 +22,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "engines": {
-    "node": ">=16"
-  },
   "type": "module",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -30,32 +31,32 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.mjs"
     },
+    "./reporter": {
+      "import": "./dist/reporter.mjs",
+      "types": "./dist/reporter.d.ts",
+      "default": "./dist/reporter.mjs"
+    },
     "./package.json": "./package.json"
   },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "@argos-ci/browser": "0.0.0",
+    "@argos-ci/core": "0.12.1-alpha.7+b2cbada",
+    "@argos-ci/util": "0.0.1-alpha.187+b2cbada"
+  },
+  "devDependencies": {
+    "@argos-ci/cli": "0.6.1-alpha.7+b2cbada",
+    "@argos-ci/playwright": "workspace:.",
+    "@playwright/test": "^1.38.1",
+    "@types/node": "^16.0.0"
+  },
   "scripts": {
     "prebuild": "rm -rf dist",
     "build": "rollup -c",
-    "test": "npx playwright test",
-    "format": "prettier --write . --ignore-path .gitignore",
-    "check-format": "prettier --check .",
-    "lint": "eslint --ignore-path .gitignore .",
-    "prepublishOnly": "npm run build",
-    "release": "standard-version && conventional-github-releaser --preset angular"
+    "test": "pnpm exec playwright test",
+    "e2e": "WITH_ARGOS_REPORTER=true pnpm run test"
   },
-  "devDependencies": {
-    "@argos-ci/cli": "^0.4.4",
-    "@playwright/test": "^1.30.0",
-    "@swc/cli": "^0.1.62",
-    "@swc/core": "^1.3.35",
-    "@typescript-eslint/eslint-plugin": "^5.52.0",
-    "@typescript-eslint/parser": "^5.52.0",
-    "conventional-github-releaser": "^3.1.5",
-    "eslint": "^8.34.0",
-    "prettier": "^2.8.4",
-    "rollup": "^3.17.1",
-    "rollup-plugin-dts": "^5.2.0",
-    "rollup-plugin-swc3": "^0.8.0",
-    "standard-version": "^9.5.0",
-    "typescript": "^4.9.5"
-  }
+  "gitHead": "b2cbadab77b42d32946e7ed315290e9b9bd7d245"
 }