@nx/playwright 19.5.5 → 19.6.0-beta.0

package/migrations.json

@@ -11,6 +11,12 @@
       "version": "18.1.0-beta.3",
       "description": "Remove invalid baseUrl option from @nx/playwright:playwright targets in project.json.",
       "implementation": "./src/migrations/update-18-1-0/remove-baseUrl-from-project-json"
+    },
+    "19-6-0-use-serve-static-preview-for-command": {
+      "cli": "nx",
+      "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"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "19.5.5",
+  "version": "19.6.0-beta.0",
   "type": "commonjs",
   "homepage": "https://nx.dev",
   "private": false,
@@ -35,9 +35,9 @@
   },
   "dependencies": {
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "@nx/devkit": "19.5.5",
-    "@nx/eslint": "19.5.5",
-    "@nx/js": "19.5.5",
+    "@nx/devkit": "19.6.0-beta.0",
+    "@nx/eslint": "19.6.0-beta.0",
+    "@nx/js": "19.6.0-beta.0",
     "tslib": "^2.3.0",
     "minimatch": "9.0.3"
   },

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

@@ -0,0 +1,2 @@
+import { type Tree } from '@nx/devkit';
+export default function addE2eCiTargetDefaults(tree: Tree): Promise<void>;

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

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = addE2eCiTargetDefaults;
+const devkit_1 = require("@nx/devkit");
+const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaults-utils");
+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");
+async function addE2eCiTargetDefaults(tree) {
+    const pluginName = '@nx/playwright/plugin';
+    const graph = await (0, devkit_1.createProjectGraphAsync)();
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const matchingPluginRegistrations = nxJson.plugins?.filter((p) => typeof p === 'string' ? p === pluginName : p.plugin === pluginName);
+    if (!matchingPluginRegistrations) {
+        return;
+    }
+    const { createNodesV2, } = await Promise.resolve(`${pluginName}`).then(s => require(s));
+    for (const plugin of matchingPluginRegistrations) {
+        let projectConfigs;
+        try {
+            const loadedPlugin = new internal_api_1.LoadedNxPlugin({ createNodesV2, name: pluginName }, plugin);
+            projectConfigs = await (0, devkit_internals_1.retrieveProjectConfigurations)([loadedPlugin], tree.root, nxJson);
+        }
+        catch (e) {
+            if (e instanceof devkit_internals_1.ProjectConfigurationsError) {
+                projectConfigs = e.partialProjectConfigurationsResult;
+            }
+            else {
+                throw e;
+            }
+        }
+        for (const configFile of projectConfigs.matchingProjectFiles) {
+            const configFileContents = tree.read(configFile, 'utf-8');
+            const ast = tsquery_1.tsquery.ast(configFileContents);
+            const CI_WEBSERVER_COMMAND_SELECTOR = 'PropertyAssignment:has(Identifier[name=webServer]) PropertyAssignment:has(Identifier[name=command]) > StringLiteral';
+            const nodes = (0, tsquery_1.tsquery)(ast, CI_WEBSERVER_COMMAND_SELECTOR, {
+                visitAllChildren: true,
+            });
+            if (!nodes.length) {
+                continue;
+            }
+            const ciWebServerCommand = nodes[0].getText();
+            let serveStaticProject;
+            let serveStaticTarget;
+            let serveStaticConfiguration;
+            if (ciWebServerCommand.includes('nx run')) {
+                const NX_TARGET_REGEX = "(?<=nx run )[^']+";
+                const matches = ciWebServerCommand.match(NX_TARGET_REGEX);
+                if (!matches) {
+                    continue;
+                }
+                const targetString = matches[0];
+                const { project, target, configuration } = (0, devkit_1.parseTargetString)(targetString, graph);
+                serveStaticProject = project;
+                serveStaticTarget = target;
+                serveStaticConfiguration = configuration;
+            }
+            else {
+                const NX_PROJECT_REGEX = 'nx\\s+([^ ]+)\\s+([^ ]+)';
+                const matches = ciWebServerCommand.match(NX_PROJECT_REGEX);
+                if (!matches) {
+                    return;
+                }
+                serveStaticTarget = matches[1];
+                serveStaticProject = matches[2];
+            }
+            const resolvedServeStaticTarget = graph.nodes[serveStaticProject].data.targets[serveStaticTarget];
+            let resolvedBuildTarget;
+            if (resolvedServeStaticTarget.dependsOn) {
+                resolvedBuildTarget = resolvedServeStaticTarget.dependsOn.join(',');
+            }
+            else {
+                resolvedBuildTarget =
+                    (serveStaticConfiguration
+                        ? resolvedServeStaticTarget.configurations[serveStaticConfiguration]
+                            .buildTarget
+                        : resolvedServeStaticTarget.options.buildTarget) ?? 'build';
+            }
+            const buildTarget = `^${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.d.ts

@@ -0,0 +1,2 @@
+import { type Tree } from '@nx/devkit';
+export default function (tree: Tree): Promise<void>;

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

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+async function default_1(tree) {
+    const graph = await (0, devkit_1.createProjectGraphAsync)();
+    (0, devkit_1.visitNotIgnoredFiles)(tree, '', (path) => {
+        if (!path.endsWith('playwright.config.ts')) {
+            return;
+        }
+        let playwrightConfigFileContents = tree.read(path, 'utf-8');
+        const WEBSERVER_COMMAND_SELECTOR = 'PropertyAssignment:has(Identifier[name=webServer]) PropertyAssignment:has(Identifier[name=command]) > StringLiteral';
+        let ast = tsquery_1.tsquery.ast(playwrightConfigFileContents);
+        const nodes = (0, tsquery_1.tsquery)(ast, WEBSERVER_COMMAND_SELECTOR, {
+            visitAllChildren: true,
+        });
+        if (!nodes.length) {
+            return;
+        }
+        const commandValueNode = nodes[0];
+        const command = commandValueNode.getText();
+        let project;
+        if (command.includes('nx run')) {
+            const NX_TARGET_REGEX = "(?<=nx run )[^']+";
+            const matches = command.match(NX_TARGET_REGEX);
+            if (!matches) {
+                return;
+            }
+            const targetString = matches[0];
+            const parsedTargetString = (0, devkit_1.parseTargetString)(targetString, graph);
+            if (parsedTargetString.target === 'serve-static' ||
+                parsedTargetString.target === 'preview') {
+                return;
+            }
+            project = parsedTargetString.project;
+        }
+        else {
+            const NX_PROJECT_REGEX = "(?<=nx [^ ]+ )[^']+";
+            const matches = command.match(NX_PROJECT_REGEX);
+            if (!matches) {
+                return;
+            }
+            project = matches[0];
+        }
+        const pathToViteConfig = [
+            (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())}`);
+        }
+        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);
+            const BASE_URL_SELECTOR = 'VariableDeclaration:has(Identifier[name=baseURL])';
+            const baseUrlNodes = (0, tsquery_1.tsquery)(ast, BASE_URL_SELECTOR, {
+                visitAllChildren: true,
+            });
+            if (!baseUrlNodes.length) {
+                return;
+            }
+            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');
+            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, {
+                visitAllChildren: true,
+            });
+            if (!webServerUrlNodes.length) {
+                return;
+            }
+            const webServerUrlNode = webServerUrlNodes[0];
+            const newWebServerUrl = "'http://localhost:4300'";
+            tree.write(path, `${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);
+}