@nx/cypress 19.5.5 → 19.6.0-beta.0

package/migrations.json

@@ -29,6 +29,18 @@
       "version": "18.1.0-beta.3",
       "description": "Update to Cypress ^13.6.6 if the workspace is using Cypress v13 to ensure workspaces don't use v13.6.5 which has an issue when verifying Cypress.",
       "implementation": "./src/migrations/update-18-1-0/update-cypress-version-13-6-6"
+    },
+    "update-19-6-0-update-ci-webserver-for-vite": {
+      "cli": "nx",
+      "version": "19.6.0-beta.0",
+      "description": "Update ciWebServerCommand to use previewTargetName if Vite is detected for the application.",
+      "implementation": "./src/migrations/update-19-6-0/update-ci-webserver-for-vite"
+    },
+    "update-19-6-0-add-e2e-ci-target-defaults": {
+      "cli": "nx",
+      "version": "19.6.0-beta.0",
+      "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"
     }
   },
   "packageJsonUpdates": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "19.5.5",
+  "version": "19.6.0-beta.0",
   "private": false,
   "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
@@ -36,13 +36,13 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@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",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "detect-port": "^1.5.1",
     "tslib": "^2.3.0",
-    "@nrwl/cypress": "19.5.5"
+    "@nrwl/cypress": "19.6.0-beta.0"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 14"

package/plugins/cypress-preset.d.ts

@@ -64,6 +64,10 @@ export type NxCypressE2EPresetOptions = {
      * A command to start the web server - used for e2e tests distributed by Nx.
      */
     ciWebServerCommand?: string;
+    /**
+     * The url of the web server for ciWebServerCommand
+     */
+    ciBaseUrl?: string;
     /**
      * Configures how the web server command is started and monitored.
      */

package/plugins/cypress-preset.js

@@ -85,6 +85,7 @@ function nxE2EPreset(pathToConfig, options) {
             webServerCommand: options?.webServerCommands?.default,
             webServerCommands: options?.webServerCommands,
             ciWebServerCommand: options?.ciWebServerCommand,
+            ciBaseUrl: options?.ciBaseUrl,
         },
         async setupNodeEvents(on, config) {
             const webServerCommands = config.env?.webServerCommands ?? options?.webServerCommands;

package/src/generators/configuration/configuration.d.ts

@@ -16,6 +16,7 @@ export interface CypressE2EConfigSchema {
     rootProject?: boolean;
     webServerCommands?: Record<string, string>;
     ciWebServerCommand?: string;
+    ciBaseUrl?: string;
     addPlugin?: boolean;
 }
 export declare function configurationGenerator(tree: Tree, options: CypressE2EConfigSchema): Promise<GeneratorCallback>;

package/src/generators/configuration/configuration.js

@@ -125,9 +125,11 @@ async function addFiles(tree, options, projectGraph, hasPlugin) {
         const cyFile = (0, devkit_1.joinPathFragments)(projectConfig.root, options.js ? 'cypress.config.js' : 'cypress.config.ts');
         let webServerCommands;
         let ciWebServerCommand;
+        let ciBaseUrl;
         if (hasPlugin && options.webServerCommands && options.ciWebServerCommand) {
             webServerCommands = options.webServerCommands;
             ciWebServerCommand = options.ciWebServerCommand;
+            ciBaseUrl = options.ciBaseUrl;
         }
         else if (hasPlugin && options.devServerTarget) {
             webServerCommands = {};
@@ -150,6 +152,7 @@ async function addFiles(tree, options, projectGraph, hasPlugin) {
             bundler: options.bundler === 'vite' ? 'vite' : undefined,
             webServerCommands,
             ciWebServerCommand: ciWebServerCommand,
+            ciBaseUrl,
         }, options.baseUrl);
         tree.write(cyFile, updatedCyConfig);
     }

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,69 @@
+"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/cypress/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');
+            if (!configFileContents.includes('ciWebServerCommand')) {
+                continue;
+            }
+            const ast = tsquery_1.tsquery.ast(configFileContents);
+            const CI_WEBSERVER_COMMAND_SELECTOR = 'ObjectLiteralExpression PropertyAssignment:has(Identifier[name=ciWebServerCommand]) > StringLiteral';
+            const nodes = (0, tsquery_1.tsquery)(ast, CI_WEBSERVER_COMMAND_SELECTOR, {
+                visitAllChildren: true,
+            });
+            if (!nodes.length) {
+                continue;
+            }
+            const ciWebServerCommand = nodes[0].getText();
+            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);
+            const serveStaticTarget = graph.nodes[project].data.targets[target];
+            let resolvedBuildTarget;
+            if (serveStaticTarget.dependsOn) {
+                resolvedBuildTarget = serveStaticTarget.dependsOn.join(',');
+            }
+            else {
+                resolvedBuildTarget =
+                    (configuration
+                        ? serveStaticTarget.configurations[configuration].buildTarget
+                        : serveStaticTarget.options.buildTarget) ?? 'build';
+            }
+            const buildTarget = `^${resolvedBuildTarget}`;
+            await (0, target_defaults_utils_1.addE2eCiTargetDefaults)(tree, pluginName, buildTarget, configFile);
+        }
+    }
+    await (0, devkit_1.formatFiles)(tree);
+}

package/src/migrations/update-19-6-0/update-ci-webserver-for-vite.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/update-ci-webserver-for-vite.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const devkit_1 = require("@nx/devkit");
+const devkit_internals_1 = require("nx/src/devkit-internals");
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+async function default_1(tree) {
+    const pluginName = '@nx/cypress/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);
+    const { createNodesV2, } = await Promise.resolve(`${pluginName}`).then(s => require(s));
+    for (const plugin of matchingPluginRegistrations) {
+        let projectConfigs;
+        try {
+            const loadedPlugin = new devkit_internals_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');
+            if (!configFileContents.includes('ciWebServerCommand')) {
+                continue;
+            }
+            const ast = tsquery_1.tsquery.ast(configFileContents);
+            const CI_WEBSERVER_COMMAND_SELECTOR = 'ObjectLiteralExpression PropertyAssignment:has(Identifier[name=ciWebServerCommand]) > StringLiteral';
+            const nodes = (0, tsquery_1.tsquery)(ast, CI_WEBSERVER_COMMAND_SELECTOR, {
+                visitAllChildren: true,
+            });
+            if (!nodes.length) {
+                continue;
+            }
+            const ciWebServerCommand = nodes[0].getText();
+            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);
+            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) {
+                continue;
+            }
+            const viteConfigContents = tree.read(pathToViteConfig, 'utf-8');
+            if (!viteConfigContents.includes('preview:')) {
+                continue;
+            }
+            const matchingVitePlugin = await findPluginForConfigFile(tree, '@nx/vite/plugin', pathToViteConfig);
+            const previewTargetName = matchingVitePlugin
+                ? typeof matchingVitePlugin === 'string'
+                    ? 'preview'
+                    : matchingVitePlugin.options?.previewTargetName ?? 'preview'
+                : 'preview';
+            tree.write(configFile, `${configFileContents.slice(0, nodes[0].getStart())}'nx run ${project}:${previewTargetName}',
+      ciBaseUrl: "http://localhost:4300"${configFileContents.slice(nodes[0].getEnd())}`);
+        }
+    }
+    await (0, devkit_1.formatFiles)(tree);
+}
+async function findPluginForConfigFile(tree, pluginName, pathToConfigFile) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    if (!nxJson.plugins) {
+        return;
+    }
+    const pluginRegistrations = nxJson.plugins.filter((p) => (typeof p === 'string' ? p === pluginName : p.plugin === pluginName));
+    for (const plugin of pluginRegistrations) {
+        if (typeof plugin === 'string') {
+            return plugin;
+        }
+        if (!plugin.include && !plugin.exclude) {
+            return plugin;
+        }
+        if (plugin.include || plugin.exclude) {
+            const resolvedPlugin = await Promise.resolve(`${pluginName}`).then(s => require(s));
+            const pluginGlob = resolvedPlugin.createNodesV2?.[0] ?? resolvedPlugin.createNodes?.[0];
+            const matchingConfigFile = (0, devkit_internals_1.findMatchingConfigFiles)([pathToConfigFile], pluginGlob, plugin.include, plugin.exclude);
+            if (matchingConfigFile.length) {
+                return plugin;
+            }
+        }
+    }
+}

package/src/plugins/plugin.js

@@ -160,6 +160,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                     ? cypressConfig.e2e.excludeSpecPattern.map((p) => (0, path_1.join)(projectRoot, p))
                     : [(0, path_1.join)(projectRoot, cypressConfig.e2e.excludeSpecPattern)];
             const specFiles = await (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, specPatterns, excludeSpecPatterns);
+            const ciBaseUrl = pluginPresetOptions?.ciBaseUrl;
             const dependsOn = [];
             const outputs = getOutputs(projectRoot, cypressConfig, 'e2e');
             const inputs = getInputs(namedInputs);
@@ -174,7 +175,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                     outputs,
                     inputs,
                     cache: true,
-                    command: `cypress run --env webServerCommand="${ciWebServerCommand}" --spec ${relativeSpecFilePath}`,
+                    command: `cypress run --env webServerCommand="${ciWebServerCommand}" --spec ${relativeSpecFilePath}${ciBaseUrl ? ` --config='{"baseUrl": "${ciBaseUrl}"}'` : ''}`,
                     options: {
                         cwd: projectRoot,
                     },