@nx/playwright 20.1.0-canary.20241031-ce05a98 → 20.1.0-canary.20241101-d4f4dac

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "20.1.0-canary.20241031-ce05a98",
+  "version": "20.1.0-canary.20241101-d4f4dac",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -35,11 +35,11 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "20.1.0-canary.20241031-ce05a98",
-    "@nx/eslint": "20.1.0-canary.20241031-ce05a98",
-    "@nx/webpack": "20.1.0-canary.20241031-ce05a98",
-    "@nx/vite": "20.1.0-canary.20241031-ce05a98",
-    "@nx/js": "20.1.0-canary.20241031-ce05a98",
+    "@nx/devkit": "20.1.0-canary.20241101-d4f4dac",
+    "@nx/eslint": "20.1.0-canary.20241101-d4f4dac",
+    "@nx/webpack": "20.1.0-canary.20241101-d4f4dac",
+    "@nx/vite": "20.1.0-canary.20241101-d4f4dac",
+    "@nx/js": "20.1.0-canary.20241101-d4f4dac",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

package/src/plugins/plugin.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodes = exports.createNodesV2 = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
+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");
@@ -14,7 +14,7 @@ const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
 const file_hasher_1 = require("nx/src/hasher/file-hasher");
 const pmc = (0, devkit_1.getPackageManagerCommand)();
 function readTargetsCache(cachePath) {
-    return (0, fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
+    return (0, node_fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
 }
 function writeTargetsToCache(cachePath, results) {
     (0, devkit_1.writeJsonFile)(cachePath, results);
@@ -24,7 +24,7 @@ exports.createNodesV2 = [
     playwrightConfigGlob,
     async (configFilePaths, options, context) => {
         const optionsHash = (0, file_hasher_1.hashObject)(options);
-        const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `playwright-${optionsHash}.hash`);
+        const cachePath = (0, node_path_1.join)(cache_directory_1.workspaceDataDirectory, `playwright-${optionsHash}.hash`);
         const targetsCache = readTargetsCache(cachePath);
         try {
             return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => createNodesInternal(configFile, options, context, targetsCache), configFilePaths, options, context);
@@ -46,9 +46,9 @@ exports.createNodes = [
     },
 ];
 async function createNodesInternal(configFilePath, options, context, targetsCache) {
-    const projectRoot = (0, path_1.dirname)(configFilePath);
+    const projectRoot = (0, node_path_1.dirname)(configFilePath);
     // Do not create a project if package.json and project.json isn't there.
-    const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
+    const siblingFiles = (0, node_fs_1.readdirSync)((0, node_path_1.join)(context.workspaceRoot, projectRoot));
     if (!siblingFiles.includes('package.json') &&
         !siblingFiles.includes('project.json')) {
         return {};
@@ -72,10 +72,12 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
     // but we're just reading the config so let's delete the variable they are using to detect this.
     // See: https://github.com/microsoft/playwright/pull/11218/files
     delete process['__pw_initiator__'];
-    const playwrightConfig = await (0, config_utils_1.loadConfigFile)((0, path_1.join)(context.workspaceRoot, configFilePath));
+    const playwrightConfig = await (0, config_utils_1.loadConfigFile)((0, node_path_1.join)(context.workspaceRoot, configFilePath));
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
     const targets = {};
     let metadata;
+    const testOutput = getTestOutput(playwrightConfig);
+    const reporterOutputs = getReporterOutputs(playwrightConfig);
     const baseTargetConfig = {
         command: 'playwright test',
         options: {
@@ -104,7 +106,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
                 : ['default', '^default']),
             { externalDependencies: ['@playwright/test'] },
         ],
-        outputs: getOutputs(projectRoot, playwrightConfig),
+        outputs: getTargetOutputs(testOutput, reporterOutputs, projectRoot),
     };
     if (options.ciTargetName) {
         const ciBaseTargetConfig = {
@@ -116,7 +118,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
                     : ['default', '^default']),
                 { externalDependencies: ['@playwright/test'] },
             ],
-            outputs: getOutputs(projectRoot, playwrightConfig),
+            outputs: getTargetOutputs(testOutput, reporterOutputs, projectRoot),
         };
         const groupName = 'E2E (CI)';
         metadata = { targetGroups: { [groupName]: [] } };
@@ -128,12 +130,20 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
         playwrightConfig.testMatch ??= '**/*.@(spec|test).?(c|m)[jt]s?(x)';
         const dependsOn = [];
         await forEachTestFile((testFile) => {
-            const relativeSpecFilePath = (0, devkit_1.normalizePath)((0, path_1.relative)(projectRoot, testFile));
+            const outputSubfolder = (0, node_path_1.relative)(projectRoot, testFile)
+                .replace(/[\/\\]/g, '-')
+                .replace(/\./g, '-');
+            const relativeSpecFilePath = (0, devkit_1.normalizePath)((0, node_path_1.relative)(projectRoot, testFile));
             const targetName = `${options.ciTargetName}--${relativeSpecFilePath}`;
             ciTargetGroup.push(targetName);
             targets[targetName] = {
                 ...ciBaseTargetConfig,
-                command: `${baseTargetConfig.command} ${relativeSpecFilePath}`,
+                options: {
+                    ...ciBaseTargetConfig.options,
+                    env: getOutputEnvVars(reporterOutputs, outputSubfolder),
+                },
+                outputs: getTargetOutputs(testOutput, reporterOutputs, projectRoot, outputSubfolder),
+                command: `${baseTargetConfig.command} ${relativeSpecFilePath} --output=${(0, node_path_1.join)(testOutput, outputSubfolder)}`,
                 metadata: {
                     technologies: ['playwright'],
                     description: `Runs Playwright Tests in ${relativeSpecFilePath} in CI`,
@@ -214,58 +224,84 @@ function createMatcher(pattern) {
         };
     }
 }
-function getOutputs(projectRoot, playwrightConfig) {
-    function getOutput(path) {
-        if (path.startsWith('..')) {
-            return (0, path_1.join)('{workspaceRoot}', (0, path_1.join)(projectRoot, path));
-        }
-        else {
-            return (0, path_1.join)('{projectRoot}', path);
-        }
+function normalizeOptions(options) {
+    return {
+        ...options,
+        targetName: options.targetName ?? 'e2e',
+        ciTargetName: options.ciTargetName ?? 'e2e-ci',
+    };
+}
+function getTestOutput(playwrightConfig) {
+    const { outputDir } = playwrightConfig;
+    if (outputDir) {
+        return outputDir;
+    }
+    else {
+        return './test-results';
     }
+}
+function getReporterOutputs(playwrightConfig) {
     const outputs = [];
-    const { reporter, outputDir } = playwrightConfig;
+    const { reporter } = playwrightConfig;
     if (reporter) {
-        const DEFAULT_REPORTER_OUTPUT = getOutput('playwright-report');
-        if (reporter === 'html' || reporter === 'json') {
-            // Reporter is a string, so it uses the default output directory.
-            outputs.push(DEFAULT_REPORTER_OUTPUT);
+        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 [, opts] = r;
+                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) {
-                    outputs.push(DEFAULT_REPORTER_OUTPUT);
-                }
-                else if (opts.outputFile) {
-                    outputs.push(getOutput(opts.outputFile));
+                if (opts?.outputFile) {
+                    outputs.push([reporter, opts.outputFile]);
                 }
-                else if (opts.outputDir) {
-                    outputs.push(getOutput(opts.outputDir));
+                else if (opts?.outputDir) {
+                    outputs.push([reporter, opts.outputDir]);
                 }
-                else if (opts.outputFolder) {
-                    outputs.push(getOutput(opts.outputFolder));
+                else if (opts?.outputFolder) {
+                    outputs.push([reporter, opts.outputFolder]);
                 }
                 else {
-                    outputs.push(DEFAULT_REPORTER_OUTPUT);
+                    outputs.push([reporter, DEFAULT_REPORTER_OUTPUT]);
                 }
             }
         }
     }
-    if (outputDir) {
-        outputs.push(getOutput(outputDir));
+    return outputs;
+}
+function getTargetOutputs(testOutput, reporterOutputs, projectRoot, scope) {
+    const outputs = new Set();
+    outputs.add(normalizeOutput(projectRoot, scope ? (0, node_path_1.join)(testOutput, scope) : testOutput));
+    for (const [, output] of reporterOutputs) {
+        outputs.add(normalizeOutput(projectRoot, scope ? (0, node_path_1.join)(output, scope) : output));
+    }
+    return Array.from(outputs);
+}
+function normalizeOutput(projectRoot, path) {
+    if (path.startsWith('..')) {
+        return (0, node_path_1.join)('{workspaceRoot}', (0, node_path_1.join)(projectRoot, path));
     }
     else {
-        outputs.push(getOutput('./test-results'));
+        return (0, node_path_1.join)('{projectRoot}', path);
     }
-    return outputs;
 }
-function normalizeOptions(options) {
-    return {
-        ...options,
-        targetName: options.targetName ?? 'e2e',
-        ciTargetName: options.ciTargetName ?? 'e2e-ci',
-    };
+function getOutputEnvVars(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] = (0, node_path_1.join)(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];
+            }
+        }
+    }
+    return env;
 }