@nx/cypress 24.0.0-beta.3 → 24.0.0-beta.4

package/dist/plugins/cypress-preset.js

@@ -130,6 +130,19 @@ function nxE2EPreset(pathToConfig, options) {
             if (options?.bundler === 'vite') {
                 on('file:preprocessor', (0, preprocessor_vite_1.default)(options?.viteConfigOverrides));
             }
+            // Set by Nx when the web server task already reported it is ready
+            const readyUrl = process.env.NX_READY_URL;
+            if (readyUrl && isBaseUrlOverridden(config, options)) {
+                console.log(`Testing against ${config.baseUrl} from --config or CYPRESS_BASE_URL, not the server Nx started on ${readyUrl}`);
+                await waitForServer(config.baseUrl, options?.webServerConfig, (ms) => `${config.baseUrl} did not respond within ${ms}ms. This can be configured in cypress.config.ts.`);
+                return;
+            }
+            if (readyUrl) {
+                config.baseUrl = (0, devkit_1.getReadyUrl)(config.baseUrl);
+                console.log(`Testing against the server Nx started on ${config.baseUrl}`);
+                // Cypress only applies config changes returned from setupNodeEvents.
+                return config;
+            }
             if (!options?.webServerCommands) {
                 return;
             }
@@ -158,23 +171,54 @@ function nxE2EPreset(pathToConfig, options) {
     };
     return baseConfig;
 }
-function waitForServer(url, webServerConfig) {
+// Cypress keeps the config file's values in rawJson, without --config, and
+// reports CYPRESS_BASE_URL as from 'env'. A config file that reads
+// CYPRESS_BASE_URL has it in rawJson too. Inferred CI targets pass ciBaseUrl.
+function isBaseUrlOverridden(config, options) {
+    if (!config.baseUrl) {
+        return false;
+    }
+    if (config.resolved?.baseUrl?.from === 'env') {
+        return true;
+    }
+    const isInferredCiTarget = !!options?.ciWebServerCommand &&
+        config.env?.webServerCommand === options.ciWebServerCommand;
+    return (!isSameUrl(config.baseUrl, config.rawJson?.e2e?.baseUrl) &&
+        !(isInferredCiTarget && isSameUrl(config.baseUrl, options.ciBaseUrl)));
+}
+function isSameUrl(url, other) {
+    if (typeof other !== 'string') {
+        return false;
+    }
+    try {
+        return new URL(url).href === new URL(other).href;
+    }
+    catch {
+        return url === other;
+    }
+}
+function waitForServer(url, webServerConfig, timeoutMessage = (ms) => `Web server failed to start in ${ms}ms. This can be configured in cypress.config.ts.`) {
     return new Promise((resolve, reject) => {
         let pollTimeout;
         const { protocol } = new URL(url);
+        let settled = false;
         const timeoutDuration = webServerConfig?.timeout ?? 60 * 1000;
         const timeout = setTimeout(() => {
+            settled = true;
             clearTimeout(pollTimeout);
-            reject(new Error(`Web server failed to start in ${timeoutDuration}ms. This can be configured in cypress.config.ts.`));
+            reject(new Error(timeoutMessage(timeoutDuration)));
         }, timeoutDuration);
         const makeRequest = protocol === 'https:' ? https_1.request : http_1.request;
         function pollForServer() {
             const request = makeRequest(url, () => {
+                settled = true;
                 clearTimeout(timeout);
                 resolve();
             });
             request.on('error', () => {
-                pollTimeout = setTimeout(pollForServer, 100);
+                if (!settled) {
+                    pollTimeout = setTimeout(pollForServer, 100);
+                }
             });
             // Don't forget to end the request
             request.end();

package/dist/src/migrations/update-23-3-0/upgrade-to-cypress-16.js

@@ -29,8 +29,9 @@ const NX_WEBPACK_CT_PRESETS = [
     '@nx/react/plugins/component-testing',
 ];
 // Re-collects the Cypress 16 migrations: below their version, above every
-// 23.2.x. `--from` is exclusive.
-const REPLAN_COMMAND = `npx nx migrate @nx/cypress@${versions_1.nxVersion} --from=@nx/cypress@23.3.0-beta.0`;
+// 23.2.x. `--from` is exclusive. `--include=all` overrides nx.json and the
+// prompt: `required` skips the upgrade and `optional` rejects `--from`.
+const REPLAN_COMMAND = `npx nx migrate @nx/cypress@${versions_1.nxVersion} --from=@nx/cypress@23.3.0-beta.0 --include=all`;
 const RERUN_COMMAND = `${REPLAN_COMMAND} && npx nx migrate --run-migration=@nx/cypress:upgrade-to-cypress-16`;
 let ts;
 async function upgradeToCypress16(tree) {

package/dist/src/migrations/update-24-0-0/disable-wait-for-server-ready.d.ts

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

package/dist/src/migrations/update-24-0-0/disable-wait-for-server-ready.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = update;
+const devkit_1 = require("@nx/devkit");
+const pluginName = '@nx/cypress/plugin';
+async function update(tree) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    if (!nxJson?.plugins) {
+        return { skipAgentic: true };
+    }
+    let changed = false;
+    nxJson.plugins = nxJson.plugins.map((plugin) => {
+        if (typeof plugin === 'string') {
+            if (plugin !== pluginName) {
+                return plugin;
+            }
+            changed = true;
+            return { plugin, options: { waitForServerReady: false } };
+        }
+        if (plugin.plugin !== pluginName) {
+            return plugin;
+        }
+        const options = (plugin.options ?? {});
+        if (options.waitForServerReady !== undefined) {
+            return plugin;
+        }
+        changed = true;
+        return { ...plugin, options: { ...options, waitForServerReady: false } };
+    });
+    if (!changed) {
+        return { skipAgentic: true };
+    }
+    (0, devkit_1.updateNxJson)(tree, nxJson);
+    await (0, devkit_1.formatFiles)(tree);
+}

package/dist/src/migrations/update-24-0-0/disable-wait-for-server-ready.md

@@ -0,0 +1,33 @@
+#### Keep the Cypress e2e tasks from waiting for the dev server to be ready
+
+The `@nx/cypress/plugin` option `waitForServerReady` now defaults to `true`.
+With it on, the inferred e2e tasks wait for the dev server task's `readyWhen` check, and `nxE2EPreset` tests against the address the server reported instead of `baseUrl`.
+
+This migration sets `waitForServerReady` to `false` on every `@nx/cypress/plugin` entry in `nx.json`, so existing workspaces keep the old behavior.
+It expands a string entry into an object entry, keeps `include`, `exclude`, and other options, and leaves an entry alone when it already sets `waitForServerReady`.
+To opt in later, set the option to `true`.
+
+#### Sample code changes
+
+##### Before
+
+```json title="nx.json"
+{
+  "plugins": ["@nx/cypress/plugin"]
+}
+```
+
+##### After
+
+```json title="nx.json"
+{
+  "plugins": [
+    {
+      "plugin": "@nx/cypress/plugin",
+      "options": {
+        "waitForServerReady": false
+      }
+    }
+  ]
+}
+```

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

@@ -5,6 +5,11 @@ export interface CypressPluginOptions {
     openTargetName?: string;
     componentTestingTargetName?: string;
     ciComponentTestingTargetName?: string;
+    /**
+     * Wait for the web server task's `readyWhen` and test against the URL it
+     * reports. Defaults to `true`.
+     */
+    waitForServerReady?: boolean;
 }
 export declare const createNodes: CreateNodes<CypressPluginOptions>;
 export declare const createNodesV2: CreateNodes<CypressPluginOptions>;

package/dist/src/plugins/plugin.js

@@ -177,6 +177,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
     };
     const webServerCommands = pluginPresetOptions?.webServerCommands;
     const shouldReuseExistingServer = pluginPresetOptions?.reuseExistingServer ?? true;
+    const waitForServer = options.waitForServerReady === false ? {} : { waitFor: 'ready' };
     const namedInputs = (0, internal_1.getNamedInputs)(projectRoot, context);
     const targets = {};
     let metadata;
@@ -211,6 +212,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                     {
                         projects: [webServerCommandTask.project],
                         target: webServerCommandTask.target,
+                        ...waitForServer,
                     },
                 ];
             }
@@ -291,6 +293,7 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                         {
                             target: ciWebServerCommandTask.target,
                             projects: [ciWebServerCommandTask.project],
+                            ...waitForServer,
                         },
                     ];
                 }

package/dist/src/utils/find-target-options.js

@@ -42,7 +42,6 @@ ${Array.from(options.validExecutorNames)
             .map((ve) => ` - ${ve}`)
             .join('\n')}
 
-${frameworkHelperMessage(Array.from(options.buildTarget), executorName)}
 This is most likely because the provided --build-target is not a build target for an application or framework.
 For example, the provide build target, '${options.buildTarget}' is:
  - the build target for a buildable/publishable library instead of an app.
@@ -55,29 +54,6 @@ If you do not have an app in the workspace to you can make a new app with 'nx g
     const foundConfig = configuration || projectConfig?.targets?.[target]?.defaultConfiguration;
     return (0, devkit_1.readTargetOptions)({ project, target, configuration: foundConfig }, createExecutorContext(graph, projectConfig.targets, project, target, foundConfig));
 }
-function frameworkHelperMessage(validExecutorNames, executorName) {
-    const executorsToFramework = {
-        '@nx/webpack:webpack': 'react',
-        '@nx/vite:build': 'react',
-        '@nrwl/webpack:webpack': 'react',
-        '@nrwl/vite:build': 'react',
-        '@nx/angular:webpack-browser': 'angular',
-        '@nrwl/angular:webpack-browser': 'angular',
-        '@angular-devkit/build-angular:browser': 'angular',
-        '@nx/next:build': 'next',
-        '@nrwl/next:build': 'next',
-    };
-    const buildTargetFramework = executorsToFramework[executorName];
-    const invokedGeneratorFramework = validExecutorNames.find((e) => !!executorsToFramework[e]);
-    if (buildTargetFramework &&
-        invokedGeneratorFramework &&
-        buildTargetFramework !== invokedGeneratorFramework) {
-        return `It looks like you're using a different plugin generator than the --build-target framework is set up for.
-The provided build target is configured for ${buildTargetFramework} instead of ${invokedGeneratorFramework}.
-Try using @nx/${buildTargetFramework} instead.`;
-    }
-    return '';
-}
 async function findInGraph(tree, graph, options) {
     const parents = findParentsOfProject(graph, options.project);
     const potentialTargets = [];

package/migrations.json

@@ -104,6 +104,7 @@
       "requires": {
         "cypress": ">=15.0.0 <16.0.0"
       },
+      "optionalUpdate": true,
       "description": "Moves a Cypress 15 workspace to Cypress 16: bumps `cypress` and the declared `@cypress/*-dev-server` packages unless a Vite component testing config, or a config whose bundler cannot be determined statically, resolves a Vite below 8, applies the Cypress 16 config option, `overwriteQuery` and `cypress/angular` rewrites, and hands the remaining source changes to an AI prompt.",
       "implementation": "./dist/src/migrations/update-23-3-0/upgrade-to-cypress-16",
       "prompt": "./dist/src/migrations/update-23-3-0/ai-instructions-for-cypress-16.md",
@@ -115,6 +116,12 @@
       "implementation": "./dist/src/migrations/update-24-0-0/remove-deprecated-executors",
       "prompt": "./dist/src/migrations/update-24-0-0/finish-inferred-conversion.md",
       "documentation": "./dist/src/migrations/update-24-0-0/remove-deprecated-executors.md"
+    },
+    "disable-wait-for-server-ready": {
+      "version": "24.0.0-beta.4",
+      "description": "Sets `waitForServerReady: false` on `@nx/cypress/plugin` entries in `nx.json` so existing Cypress e2e tasks keep starting without waiting for the dev server to report it is ready.",
+      "implementation": "./dist/src/migrations/update-24-0-0/disable-wait-for-server-ready",
+      "documentation": "./dist/src/migrations/update-24-0-0/disable-wait-for-server-ready.md"
     }
   },
   "packageJsonUpdates": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "24.0.0-beta.3",
+  "version": "24.0.0-beta.4",
   "private": false,
   "type": "commonjs",
   "files": [
@@ -84,16 +84,16 @@
     "supportsOptionalMigrations": true
   },
   "dependencies": {
-    "@nx/devkit": "24.0.0-beta.3",
-    "@nx/eslint": "24.0.0-beta.3",
-    "@nx/js": "24.0.0-beta.3",
+    "@nx/devkit": "24.0.0-beta.4",
+    "@nx/eslint": "24.0.0-beta.4",
+    "@nx/js": "24.0.0-beta.4",
     "@phenomnomnominal/tsquery": "~6.2.0",
     "semver": "^7.6.3",
     "tree-kill": "^1.2.2",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "nx": "24.0.0-beta.3"
+    "nx": "24.0.0-beta.4"
   },
   "peerDependencies": {
     "cypress": ">= 13 < 17"