@nx/playwright 19.6.0-canary.20240808-333ab77 → 19.6.0-canary.20240813-c72ba9b

package/migrations.json

@@ -17,6 +17,12 @@
       "version": "19.6.0-beta.0",
       "description": "Use serve-static or preview for webServerCommand.",
       "implementation": "./src/migrations/update-19-6-0/use-serve-static-preview-for-command"
+    },
+    "update-19-6-0-add-e2e-ci-target-defaults": {
+      "cli": "nx",
+      "version": "19.6.0-beta.1",
+      "description": "Add inferred ciTargetNames to targetDefaults with dependsOn to ensure dependent application builds are scheduled before atomized tasks.",
+      "implementation": "./src/migrations/update-19-6-0/add-e2e-ci-target-defaults"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "19.6.0-canary.20240808-333ab77",
+  "version": "19.6.0-canary.20240813-c72ba9b",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -35,9 +35,11 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "19.6.0-canary.20240808-333ab77",
-    "@nx/eslint": "19.6.0-canary.20240808-333ab77",
-    "@nx/js": "19.6.0-canary.20240808-333ab77",
+    "@nx/devkit": "19.6.0-canary.20240813-c72ba9b",
+    "@nx/eslint": "19.6.0-canary.20240813-c72ba9b",
+    "@nx/webpack": "19.6.0-canary.20240813-c72ba9b",
+    "@nx/vite": "19.6.0-canary.20240813-c72ba9b",
+    "@nx/js": "19.6.0-canary.20240813-c72ba9b",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

package/src/migrations/update-19-6-0/add-e2e-ci-target-defaults.js

@@ -6,6 +6,7 @@ const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaul
 const internal_api_1 = require("nx/src/project-graph/plugins/internal-api");
 const devkit_internals_1 = require("nx/src/devkit-internals");
 const tsquery_1 = require("@phenomnomnominal/tsquery");
+const path_1 = require("path");
 async function addE2eCiTargetDefaults(tree) {
     const pluginName = '@nx/playwright/plugin';
     const graph = await (0, devkit_1.createProjectGraphAsync)();
@@ -65,6 +66,9 @@ async function addE2eCiTargetDefaults(tree) {
                 serveStaticProject = matches[2];
             }
             const resolvedServeStaticTarget = graph.nodes[serveStaticProject].data.targets[serveStaticTarget];
+            if (!resolvedServeStaticTarget) {
+                continue;
+            }
             let resolvedBuildTarget;
             if (resolvedServeStaticTarget.dependsOn) {
                 resolvedBuildTarget = resolvedServeStaticTarget.dependsOn.join(',');
@@ -76,7 +80,8 @@ async function addE2eCiTargetDefaults(tree) {
                             .buildTarget
                         : resolvedServeStaticTarget.options.buildTarget) ?? 'build';
             }
-            const buildTarget = `^${resolvedBuildTarget}`;
+            const targetDependsOnSelf = graph.nodes[serveStaticProject].data.root === (0, path_1.dirname)(configFile);
+            const buildTarget = `${targetDependsOnSelf ? '' : '^'}${resolvedBuildTarget}`;
             await (0, target_defaults_utils_1.addE2eCiTargetDefaults)(tree, pluginName, buildTarget, configFile);
         }
     }

package/src/migrations/update-19-6-0/use-serve-static-preview-for-command.js

@@ -4,9 +4,15 @@ exports.default = default_1;
 const devkit_1 = require("@nx/devkit");
 const tsquery_1 = require("@phenomnomnominal/tsquery");
 const add_e2e_ci_target_defaults_1 = require("./add-e2e-ci-target-defaults");
+const internal_api_1 = require("nx/src/project-graph/plugins/internal-api");
+const retrieve_workspace_files_1 = require("nx/src/project-graph/utils/retrieve-workspace-files");
+const error_types_1 = require("nx/src/project-graph/error-types");
+const plugin_1 = require("@nx/webpack/src/plugins/plugin");
+const plugin_2 = require("@nx/vite/plugin");
 async function default_1(tree) {
     const graph = await (0, devkit_1.createProjectGraphAsync)();
-    (0, devkit_1.visitNotIgnoredFiles)(tree, '', (path) => {
+    const collectedProjects = [];
+    (0, devkit_1.visitNotIgnoredFiles)(tree, '', async (path) => {
         if (!path.endsWith('playwright.config.ts')) {
             return;
         }
@@ -23,8 +29,8 @@ async function default_1(tree) {
         const command = commandValueNode.getText();
         let project;
         if (command.includes('nx run')) {
-            const NX_TARGET_REGEX = "(?<=nx run )[^']+";
-            const matches = command.match(NX_TARGET_REGEX);
+            const NX_RUN_TARGET_REGEX = "(?<=nx run )[^']+";
+            const matches = command.match(NX_RUN_TARGET_REGEX);
             if (!matches) {
                 return;
             }
@@ -48,15 +54,38 @@ async function default_1(tree) {
             (0, devkit_1.joinPathFragments)(graph.nodes[project].data.root, 'vite.config.ts'),
             (0, devkit_1.joinPathFragments)(graph.nodes[project].data.root, 'vite.config.js'),
         ].find((p) => tree.exists(p));
-        if (!pathToViteConfig) {
-            const newCommand = `${(0, devkit_1.getPackageManagerCommand)().exec} nx run ${project}:serve-static`;
-            tree.write(path, `${playwrightConfigFileContents.slice(0, commandValueNode.getStart())}"${newCommand}"${playwrightConfigFileContents.slice(commandValueNode.getEnd())}`);
+        const pathToWebpackConfig = [
+            (0, devkit_1.joinPathFragments)(graph.nodes[project].data.root, 'webpack.config.ts'),
+            (0, devkit_1.joinPathFragments)(graph.nodes[project].data.root, 'webpack.config.js'),
+        ].find((p) => tree.exists(p));
+        collectedProjects.push({
+            projectName: project,
+            configFile: pathToWebpackConfig ?? pathToViteConfig,
+            configFileType: pathToWebpackConfig ? 'webpack' : 'vite',
+            playwrightConfigFile: path,
+            commandValueNode,
+        });
+    });
+    for (const projectToMigrate of collectedProjects) {
+        let playwrightConfigFileContents = tree.read(projectToMigrate.playwrightConfigFile, 'utf-8');
+        const targetName = await getServeStaticTargetNameForConfigFile(tree, projectToMigrate.configFileType === 'webpack'
+            ? '@nx/webpack/plugin'
+            : '@nx/vite/plugin', projectToMigrate.configFile, projectToMigrate.configFileType === 'webpack'
+            ? 'serve-static'
+            : 'preview', projectToMigrate.configFileType === 'webpack'
+            ? 'serveStaticTargetName'
+            : 'previewTargetName', projectToMigrate.configFileType === 'webpack'
+            ? plugin_1.createNodesV2
+            : plugin_2.createNodesV2);
+        const oldCommand = projectToMigrate.commandValueNode.getText();
+        const newCommand = oldCommand.replace(/nx.*[^"']/, `nx run ${projectToMigrate.projectName}:${targetName}`);
+        if (projectToMigrate.configFileType === 'webpack') {
+            tree.write(projectToMigrate.playwrightConfigFile, `${playwrightConfigFileContents.slice(0, projectToMigrate.commandValueNode.getStart())}${newCommand}${playwrightConfigFileContents.slice(projectToMigrate.commandValueNode.getEnd())}`);
         }
         else {
-            const newCommand = `${(0, devkit_1.getPackageManagerCommand)().exec} nx run ${project}:preview`;
-            tree.write(path, `${playwrightConfigFileContents.slice(0, commandValueNode.getStart())}"${newCommand}"${playwrightConfigFileContents.slice(commandValueNode.getEnd())}`);
-            playwrightConfigFileContents = tree.read(path, 'utf-8');
-            ast = tsquery_1.tsquery.ast(playwrightConfigFileContents);
+            tree.write(projectToMigrate.playwrightConfigFile, `${playwrightConfigFileContents.slice(0, projectToMigrate.commandValueNode.getStart())}${newCommand}${playwrightConfigFileContents.slice(projectToMigrate.commandValueNode.getEnd())}`);
+            playwrightConfigFileContents = tree.read(projectToMigrate.playwrightConfigFile, 'utf-8');
+            let ast = tsquery_1.tsquery.ast(playwrightConfigFileContents);
             const BASE_URL_SELECTOR = 'VariableDeclaration:has(Identifier[name=baseURL])';
             const baseUrlNodes = (0, tsquery_1.tsquery)(ast, BASE_URL_SELECTOR, {
                 visitAllChildren: true,
@@ -66,8 +95,8 @@ async function default_1(tree) {
             }
             const baseUrlNode = baseUrlNodes[0];
             const newBaseUrlVariableDeclaration = "baseURL = process.env['BASE_URL'] || 'http://localhost:4300';";
-            tree.write(path, `${playwrightConfigFileContents.slice(0, baseUrlNode.getStart())}${newBaseUrlVariableDeclaration}${playwrightConfigFileContents.slice(baseUrlNode.getEnd())}`);
-            playwrightConfigFileContents = tree.read(path, 'utf-8');
+            tree.write(projectToMigrate.playwrightConfigFile, `${playwrightConfigFileContents.slice(0, baseUrlNode.getStart())}${newBaseUrlVariableDeclaration}${playwrightConfigFileContents.slice(baseUrlNode.getEnd())}`);
+            playwrightConfigFileContents = tree.read(projectToMigrate.playwrightConfigFile, 'utf-8');
             ast = tsquery_1.tsquery.ast(playwrightConfigFileContents);
             const WEB_SERVER_URL_SELECTOR = 'PropertyAssignment:has(Identifier[name=webServer]) PropertyAssignment:has(Identifier[name=url]) > StringLiteral';
             const webServerUrlNodes = (0, tsquery_1.tsquery)(ast, WEB_SERVER_URL_SELECTOR, {
@@ -78,9 +107,40 @@ async function default_1(tree) {
             }
             const webServerUrlNode = webServerUrlNodes[0];
             const newWebServerUrl = "'http://localhost:4300'";
-            tree.write(path, `${playwrightConfigFileContents.slice(0, webServerUrlNode.getStart())}${newWebServerUrl}${playwrightConfigFileContents.slice(webServerUrlNode.getEnd())}`);
+            tree.write(projectToMigrate.playwrightConfigFile, `${playwrightConfigFileContents.slice(0, webServerUrlNode.getStart())}${newWebServerUrl}${playwrightConfigFileContents.slice(webServerUrlNode.getEnd())}`);
         }
-    });
+    }
     await (0, add_e2e_ci_target_defaults_1.default)(tree);
     await (0, devkit_1.formatFiles)(tree);
 }
+async function getServeStaticTargetNameForConfigFile(tree, pluginName, configFile, defaultTargetName, targetNamePluginOption, createNodesV2) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const matchingPluginRegistrations = nxJson.plugins?.filter((p) => typeof p === 'string' ? p === pluginName : p.plugin === pluginName);
+    if (!matchingPluginRegistrations) {
+        return defaultTargetName;
+    }
+    let targetName = defaultTargetName;
+    for (const plugin of matchingPluginRegistrations) {
+        let projectConfigs;
+        try {
+            const loadedPlugin = new internal_api_1.LoadedNxPlugin({ createNodesV2, name: pluginName }, plugin);
+            projectConfigs = await (0, retrieve_workspace_files_1.retrieveProjectConfigurations)([loadedPlugin], tree.root, nxJson);
+        }
+        catch (e) {
+            if (e instanceof error_types_1.ProjectConfigurationsError) {
+                projectConfigs = e.partialProjectConfigurationsResult;
+            }
+            else {
+                throw e;
+            }
+        }
+        if (projectConfigs.matchingProjectFiles.includes(configFile)) {
+            targetName =
+                typeof plugin === 'string'
+                    ? defaultTargetName
+                    : plugin.options?.[targetNamePluginOption] ??
+                        defaultTargetName;
+        }
+    }
+    return targetName;
+}