@nx/playwright 0.0.0-pr-32490-e4fdfa9 → 0.0.0-pr-32868-a65a4a2

package/executors.json

@@ -4,6 +4,12 @@
       "implementation": "./src/executors/playwright/playwright.impl",
       "schema": "./src/executors/playwright/schema.json",
       "description": "Run Playwright tests."
+    },
+    "merge-reports": {
+      "implementation": "./src/executors/merge-reports/merge-reports.impl",
+      "schema": "./src/executors/merge-reports/schema.json",
+      "description": "Merge Playwright blob reports to produce unified reports for the configured reporters (excluding the `blob` reporter).",
+      "hidden": true
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "0.0.0-pr-32490-e4fdfa9",
+  "version": "0.0.0-pr-32868-a65a4a2",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -35,14 +35,14 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "0.0.0-pr-32490-e4fdfa9",
-    "@nx/eslint": "0.0.0-pr-32490-e4fdfa9",
-    "@nx/js": "0.0.0-pr-32490-e4fdfa9",
+    "@nx/devkit": "0.0.0-pr-32868-a65a4a2",
+    "@nx/eslint": "0.0.0-pr-32868-a65a4a2",
+    "@nx/js": "0.0.0-pr-32868-a65a4a2",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },
   "devDependencies": {
-    "nx": "0.0.0-pr-32490-e4fdfa9"
+    "nx": "0.0.0-pr-32868-a65a4a2"
   },
   "peerDependencies": {
     "@playwright/test": "^1.36.0"

package/src/executors/merge-reports/merge-reports.impl.d.ts

@@ -0,0 +1,7 @@
+import { type ExecutorContext } from '@nx/devkit';
+import type { Schema } from './schema';
+export declare function mergeReportsExecutor(options: Schema, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;
+export default mergeReportsExecutor;
+//# sourceMappingURL=merge-reports.impl.d.ts.map

package/src/executors/merge-reports/merge-reports.impl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-reports.impl.d.ts","sourceRoot":"","sources":["../../../../../../packages/playwright/src/executors/merge-reports/merge-reports.impl.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,eAAe,EACrB,MAAM,YAAY,CAAC;AAOpB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,eAAe;;GAoHzB;AAED,eAAe,oBAAoB,CAAC"}

package/src/executors/merge-reports/merge-reports.impl.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeReportsExecutor = mergeReportsExecutor;
+const devkit_1 = require("@nx/devkit");
+const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const reporters_1 = require("../../utils/reporters");
+async function mergeReportsExecutor(options, context) {
+    const { config, expectedSuites } = options;
+    const projectRoot = (0, node_path_1.join)(context.root, context.projectsConfigurations.projects[context.projectName].root);
+    const configPath = (0, node_path_1.join)(projectRoot, config);
+    const playwrightConfig = await (0, config_utils_1.loadConfigFile)(configPath);
+    const reporterOutputs = (0, reporters_1.getReporterOutputs)(playwrightConfig);
+    const blobReporterOutput = reporterOutputs.find(([reporter]) => reporter === 'blob');
+    if (!blobReporterOutput) {
+        devkit_1.output.warn({
+            title: 'The blob reporter is not configured',
+            bodyLines: [
+                'The "blob" reporter is not configured in the Playwright configuration. Skipping merging the reports.',
+                '',
+                'To merge reports across tasks, enable the "blob" reporter in your Playwright configuration.',
+                'If using the preset from "@nx/playwright/preset", you can do this by setting `generateBlobReports: true` in the preset options.',
+                '',
+                'For more information see:',
+                '- Blob reporter: https://playwright.dev/docs/test-reporters#blob-reporter',
+                '- Merging reports: https://playwright.dev/docs/test-cli#merge-reports',
+            ],
+        });
+        return { success: true };
+    }
+    if (reporterOutputs.length === 1) {
+        devkit_1.output.warn({
+            title: 'No additional reporters are configured',
+            bodyLines: [
+                'Only the "blob" reporter is configured in your Playwright configuration.',
+                'To produce a different merged report, add at least one additional reporter alongside the "blob" reporter.',
+            ],
+        });
+    }
+    const blobReportDir = blobReporterOutput[1];
+    const absoluteBlobReportDir = (0, node_path_1.join)(projectRoot, blobReportDir);
+    if (!(0, node_fs_1.existsSync)(absoluteBlobReportDir)) {
+        devkit_1.output.error({
+            title: 'The blob reporter output directory does not exist',
+            bodyLines: [
+                `The blob reporter output directory "${blobReportDir}" does not exist.`,
+                'Please ensure the directory is configured correctly and it exists.',
+            ],
+        });
+        return { success: false };
+    }
+    const blobReportFiles = collectBlobReports(absoluteBlobReportDir);
+    const pmc = (0, devkit_1.getPackageManagerCommand)();
+    const result = (0, node_child_process_1.spawnSync)(pmc.exec, ['playwright', 'merge-reports', blobReportDir, '--config', configPath], {
+        cwd: projectRoot,
+        stdio: 'inherit',
+        shell: true,
+        windowsHide: false,
+    });
+    if (result.error) {
+        devkit_1.output.error({
+            title: 'Merging the blob reports failed',
+            bodyLines: [result.error.message, 'See above for more details.'],
+        });
+        return { success: false };
+    }
+    if (result.status !== 0) {
+        devkit_1.output.error({
+            title: 'Merging the blob reports failed',
+            bodyLines: [
+                `Process exited with code ${result.status}`,
+                'See above for more details.',
+            ],
+        });
+        return { success: false };
+    }
+    if (expectedSuites !== undefined) {
+        if (blobReportFiles.length !== expectedSuites) {
+            const hasAdditionalReports = blobReportFiles.length > expectedSuites;
+            devkit_1.output.warn({
+                title: hasAdditionalReports
+                    ? 'There are more blob reports than expected'
+                    : 'Some test results were not reported',
+                bodyLines: [
+                    `Expected results for ${expectedSuites} test suites, but ${blobReportFiles.length} were reported.`,
+                    ...(hasAdditionalReports
+                        ? [
+                            `Ensure the blob reporter's output folder only contains the blob reports for the test suites that were run.`,
+                        ]
+                        : []),
+                ],
+            });
+        }
+    }
+    return { success: true };
+}
+exports.default = mergeReportsExecutor;
+function collectBlobReports(blobReportsDir) {
+    const blobReportFiles = [];
+    for (const report of (0, node_fs_1.readdirSync)(blobReportsDir)) {
+        if (report.endsWith('.zip')) {
+            blobReportFiles.push((0, node_path_1.join)(blobReportsDir, report));
+        }
+    }
+    return blobReportFiles;
+}

package/src/executors/merge-reports/schema.d.ts

@@ -0,0 +1,4 @@
+export type Schema = {
+  config: string;
+  expectedSuites?: number;
+};

package/src/executors/merge-reports/schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "version": 2,
+  "title": "Schema for Playwright Merge Reports Executor",
+  "description": "Merge Playwright blob reports to produce unified reports for the configured reporters (excluding the `blob` reporter).",
+  "type": "object",
+  "properties": {
+    "config": {
+      "description": "The Playwright configuration file path. Relative to the project root.",
+      "type": "string",
+      "x-completion-type": "file",
+      "x-completion-glob": "playwright?(*)@(.js|.cjs|.mjs|.ts|.cts|.mtx)",
+      "x-priority": "important"
+    },
+    "expectedSuites": {
+      "description": "The expected number of test suites to produce a report.",
+      "type": "number",
+      "x-priority": "important"
+    }
+  },
+  "required": ["config"]
+}

package/src/plugins/plugin.d.ts

@@ -1,4 +1,4 @@
-import { CreateNodes, CreateNodesV2 } from '@nx/devkit';
+import { type CreateNodes, type CreateNodesV2 } from '@nx/devkit';
 export interface PlaywrightPluginOptions {
     targetName?: string;
     ciTargetName?: string;

package/src/plugins/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../../../packages/playwright/src/plugins/plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,WAAW,EAGX,aAAa,EAUd,MAAM,YAAY,CAAC;AAcpB,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AA6BD,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,uBAAuB,CAqBhE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,uBAAuB,CAQ5D,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../../../packages/playwright/src/plugins/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAGhB,KAAK,aAAa,EAWnB,MAAM,YAAY,CAAC;AAgBpB,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AA8BD,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,uBAAuB,CAqBhE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,uBAAuB,CAQ5D,CAAC"}

package/src/plugins/plugin.js

@@ -1,17 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodes = exports.createNodesV2 = void 0;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
 const devkit_1 = require("@nx/devkit");
-const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
-const workspace_context_1 = require("nx/src/utils/workspace-context");
-const minimatch_1 = require("minimatch");
-const cache_directory_1 = require("nx/src/utils/cache-directory");
-const js_1 = require("@nx/js");
 const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
+const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
+const js_1 = require("@nx/js");
+const minimatch_1 = require("minimatch");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 const file_hasher_1 = require("nx/src/hasher/file-hasher");
+const cache_directory_1 = require("nx/src/utils/cache-directory");
+const workspace_context_1 = require("nx/src/utils/workspace-context");
+const reporters_1 = require("../utils/reporters");
 const pmc = (0, devkit_1.getPackageManagerCommand)();
 function readTargetsCache(cachePath) {
     try {
@@ -61,7 +62,10 @@ async function createNodesInternal(configFilePath, options, context, targetsCach
         return {};
     }
     const normalizedOptions = normalizeOptions(options);
-    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, normalizedOptions, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
+    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, {
+        ...normalizedOptions,
+        CI: process.env.CI,
+    }, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
     targetsCache[hash] ??= await buildPlaywrightTargets(configFilePath, projectRoot, normalizedOptions, context);
     const { targets, metadata } = targetsCache[hash];
     return {
@@ -84,7 +88,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
     const targets = {};
     let metadata;
     const testOutput = getTestOutput(playwrightConfig);
-    const reporterOutputs = getReporterOutputs(playwrightConfig);
+    const reporterOutputs = (0, reporters_1.getReporterOutputs)(playwrightConfig);
     const webserverCommandTasks = getWebserverCommandTasks(playwrightConfig);
     const baseTargetConfig = {
         command: 'playwright test',
@@ -122,6 +126,11 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
         outputs: getTargetOutputs(testOutput, reporterOutputs, context.workspaceRoot, projectRoot),
     };
     if (options.ciTargetName) {
+        // ensure the blob reporter output is the directory containing the blob
+        // report files
+        const ciReporterOutputs = reporterOutputs.map(([reporter, output]) => reporter === 'blob' && output.endsWith('.zip')
+            ? [reporter, (0, node_path_1.dirname)(output)]
+            : [reporter, output]);
         const ciBaseTargetConfig = {
             ...baseTargetConfig,
             cache: true,
@@ -131,7 +140,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
                     : ['default', '^default']),
                 { externalDependencies: ['@playwright/test'] },
             ],
-            outputs: getTargetOutputs(testOutput, reporterOutputs, context.workspaceRoot, projectRoot),
+            outputs: getTargetOutputs(testOutput, ciReporterOutputs, context.workspaceRoot, projectRoot),
         };
         const groupName = 'E2E (CI)';
         metadata = { targetGroups: { [groupName]: [] } };
@@ -168,9 +177,9 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
                 ...ciBaseTargetConfig,
                 options: {
                     ...ciBaseTargetConfig.options,
-                    env: getOutputEnvVars(reporterOutputs, outputSubfolder),
+                    env: getAtomizedTaskEnvVars(reporterOutputs, outputSubfolder),
                 },
-                outputs: getTargetOutputs(testOutput, reporterOutputs, context.workspaceRoot, projectRoot, outputSubfolder),
+                outputs: getAtomizedTaskOutputs(testOutput, reporterOutputs, context.workspaceRoot, projectRoot, outputSubfolder),
                 command: `${baseTargetConfig.command} ${relativeSpecFilePath} --output=${(0, node_path_1.join)(testOutput, outputSubfolder)}`,
                 metadata: {
                     technologies: ['playwright'],
@@ -189,6 +198,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
                 target: targetName,
                 projects: 'self',
                 params: 'forward',
+                options: 'forward',
             });
         }
         targets[options.ciTargetName] ??= {};
@@ -216,6 +226,28 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
             targets[options.ciTargetName].parallelism = false;
         }
         ciTargetGroup.push(options.ciTargetName);
+        // infer the task to merge the reports from the atomized tasks
+        const mergeReportsTargetOutputs = new Set();
+        for (const [reporter, output] of reporterOutputs) {
+            if (reporter !== 'blob' && output) {
+                mergeReportsTargetOutputs.add(normalizeOutput(output, context.workspaceRoot, projectRoot));
+            }
+        }
+        targets[options.mergeReportsTargetName] = {
+            executor: '@nx/playwright:merge-reports',
+            cache: true,
+            inputs: ciBaseTargetConfig.inputs,
+            outputs: Array.from(mergeReportsTargetOutputs),
+            options: {
+                config: node_path_1.posix.relative(projectRoot, configFilePath),
+                expectedSuites: dependsOn.length,
+            },
+            metadata: {
+                technologies: ['playwright'],
+                description: 'Merges Playwright blob reports from atomized tasks to produce unified reports for the configured reporters.',
+            },
+        };
+        ciTargetGroup.push(options.mergeReportsTargetName);
     }
     return { targets, metadata };
 }
@@ -247,10 +279,12 @@ function createMatcher(pattern) {
     }
 }
 function normalizeOptions(options) {
+    const ciTargetName = options?.ciTargetName ?? 'e2e-ci';
     return {
         ...options,
         targetName: options?.targetName ?? 'e2e',
-        ciTargetName: options?.ciTargetName ?? 'e2e-ci',
+        ciTargetName,
+        mergeReportsTargetName: `${ciTargetName}--merge-reports`,
     };
 }
 function getTestOutput(playwrightConfig) {
@@ -262,50 +296,34 @@ function getTestOutput(playwrightConfig) {
         return './test-results';
     }
 }
-function getReporterOutputs(playwrightConfig) {
-    const outputs = [];
-    const { reporter } = playwrightConfig;
-    if (reporter) {
-        const DEFAULT_REPORTER_OUTPUT = 'playwright-report';
-        if (reporter === 'html') {
-            outputs.push([reporter, DEFAULT_REPORTER_OUTPUT]);
-        }
-        else if (reporter === 'json') {
-            outputs.push([reporter, DEFAULT_REPORTER_OUTPUT]);
-        }
-        else if (Array.isArray(reporter)) {
-            for (const r of reporter) {
-                const [reporter, opts] = r;
-                // There are a few different ways to specify an output file or directory
-                // depending on the reporter. This is a best effort to find the output.
-                if (opts?.outputFile) {
-                    outputs.push([reporter, opts.outputFile]);
-                }
-                else if (opts?.outputDir) {
-                    outputs.push([reporter, opts.outputDir]);
-                }
-                else if (opts?.outputFolder) {
-                    outputs.push([reporter, opts.outputFolder]);
-                }
-                else {
-                    outputs.push([reporter, DEFAULT_REPORTER_OUTPUT]);
-                }
-            }
+function getTargetOutputs(testOutput, reporterOutputs, workspaceRoot, projectRoot) {
+    const outputs = new Set();
+    outputs.add(normalizeOutput(testOutput, workspaceRoot, projectRoot));
+    for (const [, output] of reporterOutputs) {
+        if (!output) {
+            continue;
         }
+        outputs.add(normalizeOutput(output, workspaceRoot, projectRoot));
     }
-    return outputs;
+    return Array.from(outputs);
 }
-function getTargetOutputs(testOutput, reporterOutputs, workspaceRoot, projectRoot, subFolder) {
+function getAtomizedTaskOutputs(testOutput, reporterOutputs, workspaceRoot, projectRoot, subFolder) {
     const outputs = new Set();
     outputs.add(normalizeOutput(addSubfolderToOutput(testOutput, subFolder), workspaceRoot, projectRoot));
-    for (const [, output] of reporterOutputs) {
+    for (const [reporter, output] of reporterOutputs) {
+        if (!output) {
+            continue;
+        }
+        if (reporter === 'blob') {
+            const blobOutput = normalizeAtomizedTaskBlobReportOutput(output, subFolder);
+            outputs.add(normalizeOutput(blobOutput, workspaceRoot, projectRoot));
+            continue;
+        }
         outputs.add(normalizeOutput(addSubfolderToOutput(output, subFolder), workspaceRoot, projectRoot));
     }
     return Array.from(outputs);
 }
 function addSubfolderToOutput(output, subfolder) {
-    if (!subfolder)
-        return output;
     const parts = (0, node_path_1.parse)(output);
     if (parts.ext !== '') {
         return (0, node_path_1.join)(parts.dir, subfolder, parts.base);
@@ -368,19 +386,35 @@ function normalizeOutput(path, workspaceRoot, projectRoot) {
     }
     return (0, devkit_1.joinPathFragments)('{projectRoot}', pathRelativeToProjectRoot);
 }
-function getOutputEnvVars(reporterOutputs, outputSubfolder) {
+function getAtomizedTaskEnvVars(reporterOutputs, outputSubfolder) {
     const env = {};
     for (let [reporter, output] of reporterOutputs) {
-        if (outputSubfolder) {
-            const isFile = (0, node_path_1.parse)(output).ext !== '';
-            const envVarName = `PLAYWRIGHT_${reporter.toUpperCase()}_OUTPUT_${isFile ? 'FILE' : 'DIR'}`;
-            env[envVarName] = addSubfolderToOutput(output, outputSubfolder);
-            // Also set PLAYWRIGHT_HTML_REPORT for Playwright prior to 1.45.0.
-            // HTML prior to this version did not follow the pattern of "PLAYWRIGHT_<REPORTER>_OUTPUT_<FILE|DIR>".
-            if (reporter === 'html') {
-                env['PLAYWRIGHT_HTML_REPORT'] = env[envVarName];
-            }
+        if (!output) {
+            continue;
+        }
+        if (reporter === 'blob') {
+            output = normalizeAtomizedTaskBlobReportOutput(output, outputSubfolder);
+        }
+        else {
+            // add subfolder to the output to make them unique
+            output = addSubfolderToOutput(output, outputSubfolder);
+        }
+        const outputExtname = (0, node_path_1.parse)(output).ext;
+        const isFile = outputExtname !== '';
+        let envVarName;
+        envVarName = `PLAYWRIGHT_${reporter.toUpperCase()}_OUTPUT_${isFile ? 'FILE' : 'DIR'}`;
+        env[envVarName] = output;
+        // Also set PLAYWRIGHT_HTML_REPORT for Playwright prior to 1.45.0.
+        // HTML prior to this version did not follow the pattern of "PLAYWRIGHT_<REPORTER>_OUTPUT_<FILE|DIR>".
+        if (reporter === 'html') {
+            env['PLAYWRIGHT_HTML_REPORT'] = env[envVarName];
         }
     }
     return env;
 }
+function normalizeAtomizedTaskBlobReportOutput(output, subfolder) {
+    // set unique name for the blob report file
+    return output.endsWith('.zip')
+        ? (0, node_path_1.join)((0, node_path_1.dirname)(output), `${subfolder}.zip`)
+        : (0, node_path_1.join)(output, `${subfolder}.zip`);
+}

package/src/utils/preset.d.ts

@@ -4,6 +4,12 @@ export interface NxPlaywrightOptions {
      * @default './src'
      **/
     testDir?: string;
+    /**
+     * Whether to generate blob reports. Useful when running atomized tasks in CI
+     * and you want to merge the reports.
+     * @default `!!process.env['CI']`
+     */
+    generateBlobReports?: boolean;
 }
 /**
  * nx E2E Preset for Playwright

package/src/utils/preset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../../../../packages/playwright/src/utils/preset.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,mBAAmB;IAClC;;;QAGI;IACJ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,mBAAmB,2DAsC9B"}
+{"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../../../../packages/playwright/src/utils/preset.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,mBAAmB;IAClC;;;QAGI;IACJ,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CACzB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,mBAAmB,2DAkD9B"}

package/src/utils/preset.js

@@ -38,9 +38,26 @@ function nxE2EPreset(pathToConfig, options) {
     const testResultOuputDir = isTsSolutionSetup
         ? 'test-output/playwright/output'
         : (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'test-output');
-    const reporterOutputDir = isTsSolutionSetup
-        ? 'test-output/playwright/report'
-        : (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'playwright-report');
+    const reporters = [];
+    reporters.push([
+        'html',
+        {
+            outputFolder: isTsSolutionSetup
+                ? 'test-output/playwright/report'
+                : (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'playwright-report'),
+        },
+    ]);
+    const shouldGenerateBlobReports = options?.generateBlobReports ?? !!process.env['CI'];
+    if (shouldGenerateBlobReports) {
+        reporters.push([
+            'blob',
+            {
+                outputDir: isTsSolutionSetup
+                    ? 'test-output/playwright/blob-report'
+                    : (0, node_path_1.join)(offset, 'dist', '.playwright', projectPath, 'blob-report'),
+            },
+        ]);
+    }
     return (0, test_1.defineConfig)({
         testDir: options?.testDir ?? './src',
         outputDir: testResultOuputDir,
@@ -53,13 +70,6 @@ function nxE2EPreset(pathToConfig, options) {
         /* Opt out of parallel tests on CI. */
         workers: process.env.CI ? 1 : undefined,
         /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-        reporter: [
-            [
-                'html',
-                {
-                    outputFolder: reporterOutputDir,
-                },
-            ],
-        ],
+        reporter: [...reporters],
     });
 }

package/src/utils/reporters.d.ts

@@ -0,0 +1,4 @@
+import type { PlaywrightTestConfig } from '@playwright/test';
+export type ReporterOutput = [reporter: string, output?: string];
+export declare function getReporterOutputs(playwrightConfig: PlaywrightTestConfig): Array<ReporterOutput>;
+//# sourceMappingURL=reporters.d.ts.map

package/src/utils/reporters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporters.d.ts","sourceRoot":"","sources":["../../../../../packages/playwright/src/utils/reporters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;AAEjE,wBAAgB,kBAAkB,CAChC,gBAAgB,EAAE,oBAAoB,GACrC,KAAK,CAAC,cAAc,CAAC,CAuCvB"}

package/src/utils/reporters.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReporterOutputs = getReporterOutputs;
+function getReporterOutputs(playwrightConfig) {
+    const reporters = [];
+    const reporterConfig = playwrightConfig.reporter;
+    if (!reporterConfig) {
+        // `list` is the default reporter except in CI where `dot` is the default.
+        // https://playwright.dev/docs/test-reporters#list-reporter
+        return [[process.env.CI ? 'dot' : 'list']];
+    }
+    const defaultHtmlOutputDir = 'playwright-report';
+    const defaultBlobOutputDir = 'blob-report';
+    if (reporterConfig === 'html') {
+        reporters.push([reporterConfig, defaultHtmlOutputDir]);
+    }
+    else if (reporterConfig === 'blob') {
+        reporters.push([reporterConfig, defaultBlobOutputDir]);
+    }
+    else if (typeof reporterConfig === 'string') {
+        reporters.push([reporterConfig]);
+    }
+    else if (Array.isArray(reporterConfig)) {
+        for (const [reporter, opts] of reporterConfig) {
+            // There are a few different ways to specify an output file or directory
+            // depending on the reporter. This is a best effort to find the output.
+            if (opts?.outputFile) {
+                reporters.push([reporter, opts.outputFile]);
+            }
+            else if (opts?.outputDir) {
+                reporters.push([reporter, opts.outputDir]);
+            }
+            else if (opts?.outputFolder) {
+                reporters.push([reporter, opts.outputFolder]);
+            }
+            else if (reporter === 'html') {
+                reporters.push([reporter, defaultHtmlOutputDir]);
+            }
+            else if (reporter === 'blob') {
+                reporters.push([reporter, defaultBlobOutputDir]);
+            }
+            else {
+                reporters.push([reporter]);
+            }
+        }
+    }
+    return reporters;
+}