@argos-ci/playwright 3.8.0 → 3.9.0

package/dist/index.mjs

@@ -1,334 +0,0 @@
-import { mkdir } from 'node:fs/promises';
-import { relative, resolve, dirname } from 'node:path';
-import { resolveViewport, getGlobalScript } from '@argos-ci/browser';
-import { getGitRepositoryPath, readVersionFromPackage, getScreenshotName, validateThreshold, writeMetadata, getMetadataPath } from '@argos-ci/util';
-import { createRequire } from 'node:module';
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { createHash } from 'node:crypto';
-
-function getAttachmentName(name, type) {
-    return `argos/${type}___${name}`;
-}
-
-const require$1 = createRequire(import.meta.url);
-/**
- * Try to resolve a package.
- */ function tryResolve(pkg) {
-    try {
-        return require$1.resolve(pkg);
-    } catch  {
-        return null;
-    }
-}
-/**
- * Private metadata config storage.
- * Used to inject the metadata from other SDKs like @argos-ci/storybook.
- */ const metadataConfigStorage = new AsyncLocalStorage();
-/**
- * Set the metadata config.
- */ async function setMetadataConfig(metadata) {
-    metadataConfigStorage.enterWith(metadata);
-}
-const DEFAULT_PLAYWRIGHT_LIBRARIES = [
-    "@playwright/test",
-    "playwright",
-    "playwright-core"
-];
-/**
- * Get the name and version of the automation library.
- */ async function getAutomationLibraryMetadata() {
-    const metadataConfig = metadataConfigStorage.getStore();
-    const libraries = metadataConfig?.playwrightLibraries ?? DEFAULT_PLAYWRIGHT_LIBRARIES;
-    for (const name of libraries){
-        const pkgPath = tryResolve(`${name}/package.json`);
-        if (pkgPath) {
-            const version = await readVersionFromPackage(pkgPath);
-            return {
-                version,
-                name
-            };
-        }
-    }
-    throw new Error(`Unable to find any of the following packages: ${libraries.join(", ")}`);
-}
-/**
- * Get the version of the Argos Playwright SDK.
- */ async function getArgosPlaywrightVersion() {
-    const pkgPath = require$1.resolve("@argos-ci/playwright/package.json");
-    return readVersionFromPackage(pkgPath);
-}
-/**
- * Get the name and version of the SDK.
- */ async function getSdkMetadata() {
-    // Get the SDK metadata from the async local storage.
-    const metadataConfig = metadataConfigStorage.getStore();
-    if (metadataConfig) {
-        return metadataConfig.sdk;
-    }
-    // Get the SDK metadata from the current SDK.
-    const argosPlaywrightVersion = await getArgosPlaywrightVersion();
-    return {
-        name: "@argos-ci/playwright",
-        version: argosPlaywrightVersion
-    };
-}
-/**
- * Get the metadata of the automation library and the SDK.
- */ async function getLibraryMetadata() {
-    const [automationLibrary, sdk] = await Promise.all([
-        getAutomationLibraryMetadata(),
-        getSdkMetadata()
-    ]);
-    return {
-        automationLibrary,
-        sdk
-    };
-}
-/**
- * Get the metadata of the test.
- */ async function getTestMetadataFromTestInfo(testInfo) {
-    const repositoryPath = await getGitRepositoryPath();
-    const testMetadata = {
-        id: testInfo.testId,
-        title: testInfo.title,
-        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,
-            column: testInfo.column
-        }
-    };
-    return testMetadata;
-}
-
-const require = createRequire(import.meta.url);
-function checkIsUsingArgosReporter(testInfo) {
-    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 DEFAULT_SCREENSHOT_ROOT = "./screenshots";
-/**
- * Inject Argos script into the page.
- */ async function injectArgos(page) {
-    const injected = await page.evaluate(()=>typeof window.__ARGOS__ !== "undefined");
-    if (!injected) {
-        await page.addScriptTag({
-            content: getGlobalScript()
-        });
-    }
-}
-/**
- * Get test info from the Playwright test.
- */ async function getTestInfo() {
-    try {
-        const { test } = await import('@playwright/test');
-        return test.info();
-    } catch (error) {
-        return null;
-    }
-}
-/**
- * Get the viewport size.
- */ function getViewportSize(page) {
-    const viewportSize = page.viewportSize();
-    if (!viewportSize) {
-        throw new Error("Can't take screenshots without a viewport.");
-    }
-    return viewportSize;
-}
-/**
- * Sets the viewport size and waits for the visual viewport to match the specified dimensions.
- * @returns A promise that resolves when the viewport size has been successfully set and matched.
- */ async function setViewportSize(page, viewportSize) {
-    await page.setViewportSize(viewportSize);
-    await page.waitForFunction(({ width, height })=>window.innerWidth === width && window.innerHeight === height, {
-        width: viewportSize.width,
-        height: viewportSize.height
-    });
-}
-/**
- * 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
-        });
-    };
-}
-/**
- * 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, root = DEFAULT_SCREENSHOT_ROOT, ...playwrightOptions } = 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;
-    const testInfo = await getTestInfo();
-    const useArgosReporter = Boolean(testInfo && checkIsUsingArgosReporter(testInfo));
-    await Promise.all([
-        // Create the screenshot folder if it doesn't exist
-        useArgosReporter ? null : mkdir(root, {
-            recursive: true
-        }),
-        // Inject Argos script into the page
-        injectArgos(page)
-    ]);
-    const originalViewportSize = getViewportSize(page);
-    const fullPage = options.fullPage !== undefined ? options.fullPage : handle === page;
-    const teardown = await setup(page, options);
-    const collectMetadata = async (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;
-    };
-    const stabilizeAndScreenshot = async (name)=>{
-        await page.waitForFunction(()=>window.__ARGOS__.waitForStability());
-        const names = getScreenshotNames(name, testInfo);
-        const metadata = await collectMetadata(testInfo);
-        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(root, `${names.name}.png`);
-        const dir = dirname(screenshotPath);
-        if (dir !== root) {
-            await mkdir(dirname(screenshotPath), {
-                recursive: true
-            });
-        }
-        await Promise.all([
-            handle.screenshot({
-                path: screenshotPath,
-                type: "png",
-                fullPage,
-                mask: [
-                    page.locator('[data-visual-test="blackout"]')
-                ],
-                animations: "disabled",
-                ...playwrightOptions
-            }),
-            writeMetadata(screenshotPath, metadata)
-        ]);
-        if (useArgosReporter && testInfo) {
-            await Promise.all([
-                testInfo.attach(getAttachmentName(names.name, "metadata"), {
-                    path: getMetadataPath(screenshotPath),
-                    contentType: "application/json"
-                }),
-                testInfo.attach(getAttachmentName(names.name, "screenshot"), {
-                    path: screenshotPath,
-                    contentType: "image/png"
-                })
-            ]);
-        }
-    };
-    // If no viewports are specified, take a single screenshot
-    if (viewports) {
-        // Take screenshots for each viewport
-        for (const viewport of viewports){
-            const viewportSize = resolveViewport(viewport);
-            await setViewportSize(page, viewportSize);
-            await stabilizeAndScreenshot(getScreenshotName(name, {
-                viewportWidth: viewportSize.width
-            }));
-        }
-        // Restore the original viewport size
-        await setViewportSize(page, originalViewportSize);
-    } else {
-        await stabilizeAndScreenshot(name);
-    }
-    await teardown();
-}
-
-/**
- * Get the CSP script hash.
- */ async function getCSPScriptHash() {
-    const hash = createHash("sha256").update(getGlobalScript()).digest("base64");
-    return `'sha256-${hash}'`;
-}
-
-export { setMetadataConfig as DO_NOT_USE_setMetadataConfig, argosScreenshot, getCSPScriptHash };

package/dist/reporter.mjs

@@ -1,344 +0,0 @@
-import chalk from 'chalk';
-import { upload, readConfig } from '@argos-ci/core';
-import { randomBytes } from 'node:crypto';
-import { writeFile, copyFile, readdir, mkdir } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { relative, dirname, join } from 'node:path';
-import { getGitRepositoryPath, readVersionFromPackage } from '@argos-ci/util';
-import { createRequire } from 'node:module';
-import { AsyncLocalStorage } from 'node:async_hooks';
-import createDebug from 'debug';
-
-function getOriginalAttachmentName(name) {
-    return name.replace(/^argos\/[^/]+___/, "");
-}
-function getAttachmentFilename(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}`);
-}
-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.path);
-}
-function checkIsArgosScreenshotMetadata(attachment) {
-    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);
-}
-
-const require = createRequire(import.meta.url);
-/**
- * Try to resolve a package.
- */ function tryResolve(pkg) {
-    try {
-        return require.resolve(pkg);
-    } catch  {
-        return null;
-    }
-}
-/**
- * Private metadata config storage.
- * Used to inject the metadata from other SDKs like @argos-ci/storybook.
- */ const metadataConfigStorage = new AsyncLocalStorage();
-const DEFAULT_PLAYWRIGHT_LIBRARIES = [
-    "@playwright/test",
-    "playwright",
-    "playwright-core"
-];
-/**
- * Get the name and version of the automation library.
- */ async function getAutomationLibraryMetadata() {
-    const metadataConfig = metadataConfigStorage.getStore();
-    const libraries = metadataConfig?.playwrightLibraries ?? DEFAULT_PLAYWRIGHT_LIBRARIES;
-    for (const name of libraries){
-        const pkgPath = tryResolve(`${name}/package.json`);
-        if (pkgPath) {
-            const version = await readVersionFromPackage(pkgPath);
-            return {
-                version,
-                name
-            };
-        }
-    }
-    throw new Error(`Unable to find any of the following packages: ${libraries.join(", ")}`);
-}
-/**
- * Get the version of the Argos Playwright SDK.
- */ async function getArgosPlaywrightVersion() {
-    const pkgPath = require.resolve("@argos-ci/playwright/package.json");
-    return readVersionFromPackage(pkgPath);
-}
-/**
- * Get the name and version of the SDK.
- */ async function getSdkMetadata() {
-    // Get the SDK metadata from the async local storage.
-    const metadataConfig = metadataConfigStorage.getStore();
-    if (metadataConfig) {
-        return metadataConfig.sdk;
-    }
-    // Get the SDK metadata from the current SDK.
-    const argosPlaywrightVersion = await getArgosPlaywrightVersion();
-    return {
-        name: "@argos-ci/playwright",
-        version: argosPlaywrightVersion
-    };
-}
-/**
- * Get the metadata of the automation library and the SDK.
- */ async function getLibraryMetadata() {
-    const [automationLibrary, sdk] = await Promise.all([
-        getAutomationLibraryMetadata(),
-        getSdkMetadata()
-    ]);
-    return {
-        automationLibrary,
-        sdk
-    };
-}
-async function getTestMetadataFromTestCase(testCase, testResult) {
-    const repositoryPath = await getGitRepositoryPath();
-    const testMetadata = {
-        title: testCase.title,
-        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,
-            column: testCase.location.column
-        }
-    };
-    return testMetadata;
-}
-async function getMetadataFromTestCase(testCase, testResult) {
-    const [libMetadata, testMetadata] = await Promise.all([
-        getLibraryMetadata(),
-        getTestMetadataFromTestCase(testCase, testResult)
-    ]);
-    const metadata = {
-        test: testMetadata,
-        ...libMetadata
-    };
-    return metadata;
-}
-
-const KEY = "@argos-ci/playwright";
-const debug = createDebug(KEY);
-
-const createDirectoryPromises = new Map();
-/**
- * Create a directory if it doesn't exist.
- */ async function createDirectory(pathname) {
-    let promise = createDirectoryPromises.get(pathname);
-    if (promise) {
-        return promise;
-    }
-    promise = mkdir(pathname, {
-        recursive: true
-    }).then(()=>{});
-    createDirectoryPromises.set(pathname, promise);
-    return promise;
-}
-/**
- * Create temporary directory.
- */ async function createTemporaryDirectory() {
-    debug("Creating temporary directory");
-    const osTmpDirectory = tmpdir();
-    const path = join(osTmpDirectory, "argos." + randomBytes(16).toString("hex"));
-    await createDirectory(path);
-    debug(`Temporary directory created: ${path}`);
-    return path;
-}
-/**
- * Check if the build name is dynamic.
- */ function checkIsDynamicBuildName(buildName) {
-    return Boolean(typeof buildName === "object" && buildName);
-}
-function createArgosReporterOptions(options) {
-    return options;
-}
-async function getParallelFromConfig(config) {
-    if (!config.shard) return null;
-    if (config.shard.total === 1) return null;
-    const argosConfig = await readConfig();
-    if (!argosConfig.parallelNonce) {
-        throw new Error("Playwright shard mode detected. Please specify ARGOS_PARALLEL_NONCE env variable. Read /parallel-testing");
-    }
-    return {
-        total: config.shard.total,
-        nonce: argosConfig.parallelNonce,
-        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;
-    config;
-    playwrightConfig;
-    uploadToArgos;
-    constructor(config){
-        this.config = config;
-        this.uploadToArgos = config.uploadToArgos ?? true;
-        this.rootUploadDirectoryPromise = null;
-        this.uploadDirectoryPromises = new Map();
-    }
-    /**
-   * Write a file to the temporary directory.
-   */ async writeFile(path, body) {
-        await createDirectory(dirname(path));
-        debug(`Writing file to ${path}`);
-        await writeFile(path, body);
-        debug(`File written to ${path}`);
-    }
-    /**
-   * Copy a file to the temporary directory.
-   */ async copyFile(from, to) {
-        await createDirectory(dirname(to));
-        debug(`Copying file from ${from} to ${to}`);
-        await copyFile(from, to);
-        debug(`File copied from ${from} to ${to}`);
-    }
-    /**
-   * Copy the trace file if found in the result.
-   */ async copyTraceIfFound(result, path) {
-        const trace = result.attachments.find(checkIsTrace) ?? null;
-        if (trace) {
-            await this.copyFile(trace.path, path + ".pw-trace.zip");
-        }
-    }
-    /**
-   * Get the root upload directory (cached).
-   */ getRootUploadDirectory() {
-        if (!this.rootUploadDirectoryPromise) {
-            this.rootUploadDirectoryPromise = createTemporaryDirectory();
-        }
-        return this.rootUploadDirectoryPromise;
-    }
-    onBegin(config, _suite) {
-        debug("ArgosReporter:onBegin");
-        this.playwrightConfig = config;
-    }
-    async onTestEnd(test, result) {
-        const buildName = checkIsDynamicBuildName(this.config.buildName) ? this.config.buildName.get(test) : this.config.buildName;
-        if (buildName === "") {
-            throw new Error('Argos "buildName" cannot be an empty string.');
-        }
-        const rootUploadDir = await this.getRootUploadDirectory();
-        const uploadDir = buildName ? join(rootUploadDir, buildName) : rootUploadDir;
-        debug("ArgosReporter:onTestEnd");
-        await Promise.all(result.attachments.map(async (attachment)=>{
-            if (checkIsArgosScreenshot(attachment) || checkIsArgosScreenshotMetadata(attachment)) {
-                const path = join(uploadDir, getAttachmentFilename(attachment.name));
-                await Promise.all([
-                    this.copyFile(attachment.path, path),
-                    this.copyTraceIfFound(result, path)
-                ]);
-                return;
-            }
-            // Error screenshots are sent to Argos
-            if (checkIsAutomaticScreenshot(attachment)) {
-                const metadata = await getMetadataFromTestCase(test, result);
-                const name = getAutomaticScreenshotName(test, result);
-                const path = join(uploadDir, `${name}.png`);
-                await Promise.all([
-                    this.writeFile(path + ".argos.json", JSON.stringify(metadata)),
-                    this.copyFile(attachment.path, path),
-                    this.copyTraceIfFound(result, path)
-                ]);
-                return;
-            }
-        }));
-    }
-    async onEnd(result) {
-        debug("ArgosReporter:onEnd");
-        const rootUploadDir = await this.getRootUploadDirectory();
-        if (!this.uploadToArgos) {
-            debug("Not uploading to Argos because uploadToArgos is false.");
-            debug(`Upload directory: ${rootUploadDir}`);
-            return;
-        }
-        debug("Getting parallel from config");
-        const parallel = await getParallelFromConfig(this.playwrightConfig);
-        if (parallel) {
-            debug(`Using parallel config — total: ${parallel.total}, nonce: "${parallel.nonce}"`);
-        } else {
-            debug("Non-parallel mode");
-        }
-        const buildNameConfig = this.config.buildName;
-        const uploadOptions = {
-            files: [
-                "**/*.png"
-            ],
-            parallel: parallel ?? undefined,
-            ...this.config,
-            buildName: undefined,
-            metadata: {
-                testReport: {
-                    status: result.status,
-                    stats: {
-                        startTime: result.startTime.toISOString(),
-                        duration: result.duration
-                    }
-                }
-            }
-        };
-        try {
-            if (checkIsDynamicBuildName(buildNameConfig)) {
-                debug(`Dynamic build names, uploading to Argos for each build name: ${buildNameConfig.values.join()}`);
-                const directories = await readdir(rootUploadDir);
-                // Check if the buildName.values are consistent with the directories created
-                if (directories.some((dir)=>!buildNameConfig.values.includes(dir))) {
-                    throw new Error(`The \`buildName.values\` (${buildNameConfig.values.join(", ")}) are inconsistent with the \`buildName.get\` returns values (${directories.join(", ")}). Please fix the configuration.`);
-                }
-                // In non-parallel mode, we iterate over the directories to avoid creating useless builds
-                const iteratesOnBuildNames = parallel ? buildNameConfig.values : directories;
-                // Iterate over each build name and upload the screenshots
-                for (const buildName of iteratesOnBuildNames){
-                    const uploadDir = join(rootUploadDir, buildName);
-                    await createDirectory(uploadDir);
-                    debug(`Uploading to Argos for build: ${buildName}`);
-                    const res = await upload({
-                        ...uploadOptions,
-                        root: uploadDir,
-                        buildName
-                    });
-                    console.log(chalk.green(`✅ Argos "${buildName}" build created: ${res.build.url}`));
-                }
-            } else {
-                debug("Uploading to Argos");
-                const uploadDir = buildNameConfig ? join(rootUploadDir, buildNameConfig) : rootUploadDir;
-                const res = await upload({
-                    ...uploadOptions,
-                    root: uploadDir,
-                    buildName: buildNameConfig ?? undefined
-                });
-                console.log(chalk.green(`✅ Argos build created: ${res.build.url}`));
-            }
-        } catch (error) {
-            console.error(error);
-            return {
-                status: "failed"
-            };
-        }
-        return;
-    }
-}
-
-export { createArgosReporterOptions, ArgosReporter as default };