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

package/dist/src/migrations/update-24-0-0/remove-deprecated-executors.md

@@ -0,0 +1,61 @@
+#### Convert `@nx/cypress:cypress` targets to inferred tasks
+
+Nx 24 removes the `@nx/cypress:cypress` executor and its `@nrwl/cypress:cypress` alias. The migration registers `@nx/cypress/plugin` in `nx.json` and converts the targets that use those executors to inferred tasks. It moves the dev server and `baseUrl` settings into `cypress.config.*`. A target with nothing left to override is removed from project configuration. When several projects share the same remaining options, those options move to a `targetDefaults` entry scoped to the plugin. `targetDefaults` entries keyed by a removed executor are removed once no target uses that executor.
+
+The migration lists the targets the converter cannot convert safely. In agentic runs, an AI prompt finishes them and validates the project graph.
+
+#### Sample code changes
+
+##### Before
+
+```json title="myapp-e2e/project.json"
+{
+  "name": "myapp-e2e",
+  "targets": {
+    "e2e": {
+      "executor": "@nx/cypress:cypress",
+      "options": {
+        "cypressConfig": "myapp-e2e/cypress.config.ts",
+        "testingType": "e2e",
+        "devServerTarget": "myapp:serve"
+      },
+      "configurations": {
+        "ci": {
+          "devServerTarget": "myapp:static-serve"
+        }
+      }
+    }
+  }
+}
+```
+
+##### After
+
+```json title="myapp-e2e/project.json"
+{
+  "name": "myapp-e2e",
+  "targets": {
+    "e2e": {
+      "options": {
+        "config-file": "./cypress.config.ts"
+      }
+    }
+  }
+}
+```
+
+```json title="nx.json"
+{
+  "plugins": [
+    {
+      "plugin": "@nx/cypress/plugin",
+      "options": {
+        "ciTargetName": "e2e-ci",
+        "componentTestingTargetName": "component-test",
+        "openTargetName": "open-cypress",
+        "targetName": "e2e"
+      }
+    }
+  ]
+}
+```

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,13 +293,14 @@ async function buildCypressTargets(configFilePath, projectRoot, options, context
                         {
                             target: ciWebServerCommandTask.target,
                             projects: [ciWebServerCommandTask.project],
+                            ...waitForServer,
                         },
                     ];
                 }
                 else {
                     targets[targetName].parallelism = false;
                 }
-                targets[targetName] = (0, internal_1.applyTestFileDirectives)(targets[targetName], context.workspaceRoot, file, ['depends-on', 'ultracache']);
+                targets[targetName] = (0, internal_1.applyTestFileDirectives)(targets[targetName], context.workspaceRoot, file, { ignoreServerInputs: true });
             }
             targets[options.ciTargetName] = {
                 executor: 'nx:noop',

package/dist/src/utils/add-linter.d.ts

@@ -21,6 +21,5 @@ export interface CyLinterOptions {
      * This is useful when adding linting to a brand new project vs an existing one
      **/
     overwriteExisting?: boolean;
-    addPlugin?: boolean;
 }
 export declare function addLinterToCyProject(tree: Tree, options: CyLinterOptions): Promise<GeneratorCallback>;

package/dist/src/utils/add-linter.js

@@ -24,7 +24,6 @@ async function addLinterToCyProject(tree, options) {
             enableTypedLinting,
             skipPackageJson: options.skipPackageJson,
             rootProject: options.rootProject,
-            addPlugin: options.addPlugin,
         }));
     }
     // Everything below configures ESLint — predefined configs, `extends`, ignore

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/executors.json

@@ -1,9 +1,3 @@
 {
-  "executors": {
-    "cypress": {
-      "implementation": "./dist/src/executors/cypress/cypress.impl",
-      "schema": "./dist/src/executors/cypress/schema.json",
-      "description": "Run Cypress E2E tests."
-    }
-  }
+  "executors": {}
 }

package/migrations.json

@@ -104,10 +104,24 @@
       "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",
       "documentation": "./dist/src/migrations/update-23-3-0/upgrade-to-cypress-16.md"
+    },
+    "remove-deprecated-executors": {
+      "version": "24.0.0-beta.3",
+      "description": "Converts targets using the removed `@nx/cypress` executors to inferred tasks; an AI prompt finishes the targets the converter cannot convert safely and validates the project graph.",
+      "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.2",
+  "version": "24.0.0-beta.4",
   "private": false,
   "type": "commonjs",
   "files": [
@@ -10,7 +10,7 @@
     "executors.json",
     "generators.json"
   ],
-  "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
+  "description": "The Nx Plugin for Cypress infers tasks and provides generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
     "type": "git",
     "url": "https://github.com/nrwl/nx.git",
@@ -84,17 +84,16 @@
     "supportsOptionalMigrations": true
   },
   "dependencies": {
-    "@nx/devkit": "24.0.0-beta.2",
-    "@nx/eslint": "24.0.0-beta.2",
-    "@nx/js": "24.0.0-beta.2",
+    "@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",
-    "detect-port": "^2.1.0",
     "semver": "^7.6.3",
     "tree-kill": "^1.2.2",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "nx": "24.0.0-beta.2"
+    "nx": "24.0.0-beta.4"
   },
   "peerDependencies": {
     "cypress": ">= 13 < 17"

package/dist/src/executors/cypress/cypress.impl.js

@@ -1,136 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = cypressExecutor;
-const devkit_1 = require("@nx/devkit");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const ct_helpers_1 = require("../../utils/ct-helpers");
-const deprecation_1 = require("../../utils/deprecation");
-const start_dev_server_1 = require("../../utils/start-dev-server");
-const Cypress = require('cypress'); // @NOTE: Importing via ES6 messes the whole test dependencies.
-async function cypressExecutor(options, context) {
-    (0, deprecation_1.warnCypressExecutorDeprecation)();
-    options = normalizeOptions(options, context);
-    // this is used by cypress component testing presets to build the executor contexts with the correct configuration options.
-    process.env.NX_CYPRESS_TARGET_CONFIGURATION = context.configurationName;
-    let success;
-    const generatorInstance = (0, start_dev_server_1.startDevServer)(options, context);
-    for await (const devServerValues of generatorInstance) {
-        try {
-            success = await runCypress(devServerValues.baseUrl, {
-                ...options,
-                portLockFilePath: devServerValues.portLockFilePath,
-            });
-            if (!options.watch) {
-                generatorInstance.return();
-                break;
-            }
-        }
-        catch (e) {
-            devkit_1.logger.error(e.message);
-            success = false;
-            if (!options.watch)
-                break;
-        }
-    }
-    return { success };
-}
-function normalizeOptions(options, context) {
-    options.env = options.env || {};
-    options.testingType ??= 'e2e';
-    if (options.testingType === 'component') {
-        const project = context?.projectGraph?.nodes?.[context.projectName];
-        if (project?.data?.root) {
-            options.ctTailwindPath = (0, ct_helpers_1.getTempTailwindPath)(context);
-        }
-    }
-    return options;
-}
-/**
- * @whatItDoes Initialize the Cypress test runner with the provided project configuration.
- * By default, Cypress will run tests from the CLI without the GUI and provide directly the results in the console output.
- * If `watch` is `true`: Open Cypress in the interactive GUI to interact directly with the application.
- */
-async function runCypress(baseUrl, opts) {
-    // Cypress expects the folder where a cypress config is present
-    const projectFolderPath = (0, path_1.dirname)(opts.cypressConfig);
-    const options = {
-        project: projectFolderPath,
-        configFile: (0, path_1.basename)(opts.cypressConfig),
-    };
-    // If not, will use the `baseUrl` normally from `cypress.json`
-    if (baseUrl) {
-        options.config = { baseUrl };
-    }
-    if (opts.browser) {
-        options.browser = opts.browser;
-    }
-    if (opts.env) {
-        options.env = {
-            ...options.env,
-            ...opts.env,
-        };
-    }
-    if (opts.spec) {
-        options.spec = opts.spec;
-    }
-    options.tag = opts.tag;
-    options.exit = opts.exit;
-    options.headed = opts.headed;
-    options.runnerUi = opts.runnerUi;
-    if (opts.headless) {
-        options.headless = opts.headless;
-    }
-    options.record = opts.record;
-    options.key = opts.key;
-    options.parallel = opts.parallel;
-    options.ciBuildId = opts.ciBuildId?.toString();
-    options.group = opts.group;
-    // renamed in cy 10
-    options.config ??= {};
-    options.config[opts.testingType] = {
-        excludeSpecPattern: opts.ignoreTestFiles,
-    };
-    if (opts.reporter) {
-        options.reporter = opts.reporter;
-    }
-    if (opts.reporterOptions) {
-        options.reporterOptions = opts.reporterOptions;
-    }
-    if (opts.quiet) {
-        options.quiet = opts.quiet;
-    }
-    if (opts.autoCancelAfterFailures !== undefined) {
-        options.autoCancelAfterFailures = opts.autoCancelAfterFailures;
-    }
-    options.testingType = opts.testingType;
-    const result = await (opts.watch
-        ? Cypress.open(options)
-        : Cypress.run(options));
-    cleanupTmpFile(opts.ctTailwindPath);
-    cleanupTmpFile(opts.portLockFilePath);
-    if (process.env.NX_VERBOSE_LOGGING === 'true' && opts.portLockFilePath) {
-        (0, fs_1.readdirSync)((0, path_1.dirname)(opts.portLockFilePath)).forEach((f) => {
-            if (f.endsWith('.txt')) {
-                devkit_1.logger.debug(`Lock file ${f} still present`);
-            }
-        });
-    }
-    /**
-     * `cypress.open` is returning `0` and is not of the same type as `cypress.run`.
-     * `cypress.open` is the graphical UI, so it will be obvious to know what wasn't
-     * working. Forcing the build to success when `cypress.open` is used.
-     */
-    return !result.totalFailed && !result.failures;
-}
-function cleanupTmpFile(path) {
-    try {
-        if (path && (0, fs_1.existsSync)(path)) {
-            (0, fs_1.unlinkSync)(path);
-        }
-        return true;
-    }
-    catch (err) {
-        return false;
-    }
-}

package/dist/src/executors/cypress/schema.json

@@ -1,186 +0,0 @@
-{
-  "version": 2,
-  "title": "Cypress Target",
-  "description": "Run Cypress for e2e, integration and component testing.",
-  "type": "object",
-  "outputCapture": "pipe",
-  "cli": "nx",
-  "x-deprecated": "The `@nx/cypress:cypress` executor is deprecated and will be removed in Nx v24. Run `nx g @nx/cypress:convert-to-inferred` to migrate to the `@nx/cypress/plugin` inferred plugin. See https://nx.dev/docs/guides/tasks--caching/convert-to-inferred for details.",
-  "presets": [
-    {
-      "name": "Starting Dev Server",
-      "keys": ["cypressConfig", "devServerTarget"]
-    },
-    {
-      "name": "Custom Base Url",
-      "keys": ["cypressConfig", "baseUrl"]
-    },
-    {
-      "name": "Component Testing",
-      "keys": ["cypressConfig", "devServerTarget", "testingType", "skipServe"]
-    }
-  ],
-  "properties": {
-    "cypressConfig": {
-      "type": "string",
-      "description": "The path of the Cypress configuration json file.",
-      "x-completion-type": "file",
-      "x-completion-glob": "cypress?(*)@(.js|.ts|.json)"
-    },
-    "watch": {
-      "type": "boolean",
-      "description": "Recompile and run tests when files change.",
-      "default": false
-    },
-    "devServerTarget": {
-      "type": "string",
-      "description": "Dev server target to run tests against."
-    },
-    "headed": {
-      "type": "boolean",
-      "description": "Displays the browser instead of running headlessly. Set this to `true` if your run depends on a Chrome extension being loaded.",
-      "default": false
-    },
-    "headless": {
-      "type": "boolean",
-      "description": "Hide the browser instead of running headed.",
-      "default": false,
-      "x-deprecated": "Cypress runs headless by default. Use the --watch flag to control head/headless behavior instead. It will be removed in Nx v23."
-    },
-    "exit": {
-      "type": "boolean",
-      "description": "Whether or not the Cypress Test Runner will stay open after running tests in a spec file.",
-      "default": true
-    },
-    "key": {
-      "type": "string",
-      "description": "The key cypress should use to run tests in parallel/record the run (CI only)."
-    },
-    "record": {
-      "type": "boolean",
-      "description": "Whether or not Cypress should record the results of the tests.",
-      "default": false
-    },
-    "parallel": {
-      "aliases": ["p"],
-      "type": "boolean",
-      "description": "Whether or not Cypress should run its tests in parallel (CI only).",
-      "default": false
-    },
-    "baseUrl": {
-      "type": "string",
-      "description": "The address (with the port) which your application is running on.",
-      "x-priority": "important"
-    },
-    "browser": {
-      "type": "string",
-      "description": "The browser to run tests in."
-    },
-    "env": {
-      "type": "object",
-      "description": "A key-value Pair of environment variables to pass to Cypress runner."
-    },
-    "spec": {
-      "type": "string",
-      "description": "A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. i.e. `**examples/**,**actions.spec**`."
-    },
-    "ciBuildId": {
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "number"
-        }
-      ],
-      "description": "A unique identifier for a run to enable grouping or parallelization."
-    },
-    "group": {
-      "type": "string",
-      "description": "A named group for recorded runs in the Cypress dashboard."
-    },
-    "ignoreTestFiles": {
-      "aliases": ["excludeSpecPattern"],
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        }
-      ],
-      "description": "A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: `{dot: true, matchBase: true}`. We suggest using https://globster.xyz to test what files would match."
-    },
-    "reporter": {
-      "type": "string",
-      "description": "The reporter used during cypress run."
-    },
-    "reporterOptions": {
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "object"
-        }
-      ],
-      "description": "The reporter options used. Supported options depend on the reporter. https://docs.cypress.io/guides/tooling/reporters#Reporter-Options"
-    },
-    "skipServe": {
-      "type": "boolean",
-      "description": "Skip dev-server build.",
-      "default": false
-    },
-    "testingType": {
-      "type": "string",
-      "description": "Specify the type of tests to execute.",
-      "enum": ["component", "e2e"],
-      "default": "e2e"
-    },
-    "tag": {
-      "type": "string",
-      "description": "A comma delimited list to identify a run with.",
-      "aliases": ["t"]
-    },
-    "port": {
-      "oneOf": [
-        {
-          "type": "string",
-          "enum": ["cypress-auto"]
-        },
-        {
-          "type": "number"
-        }
-      ],
-      "description": "Pass a specified port value to the devServerTarget, if the value is 'cypress-auto' a free port will automatically be picked for the devServerTarget."
-    },
-    "quiet": {
-      "aliases": ["q"],
-      "type": "boolean",
-      "description": "If passed, Cypress output will not be printed to stdout. Only output from the configured Mocha reporter will print.",
-      "default": false
-    },
-    "runnerUi": {
-      "type": "boolean",
-      "description": "Displays the Cypress Runner UI. Useful for when Test Replay is enabled and you would still like the Cypress Runner UI to be displayed for screenshots and video."
-    },
-    "autoCancelAfterFailures": {
-      "oneOf": [
-        {
-          "type": "number"
-        },
-        {
-          "type": "boolean",
-          "const": false
-        }
-      ],
-      "description": "Specify the number of failures to cancel a run being recorded to the Cypress Cloud or `false` to disable auto-cancellation."
-    }
-  },
-  "additionalProperties": true,
-  "required": ["cypressConfig"],
-  "examplesFile": "../../../docs/cypress-examples.md"
-}

package/dist/src/utils/deprecation.d.ts

@@ -1,3 +0,0 @@
-export declare const CYPRESS_EXECUTOR_DEPRECATION_MESSAGE = "The `@nx/cypress:cypress` executor is deprecated and will be removed in Nx v24. Run `nx g @nx/cypress:convert-to-inferred` to migrate to the `@nx/cypress/plugin` inferred targets. See https://nx.dev/docs/guides/tasks--caching/convert-to-inferred for details.";
-export declare function warnCypressExecutorDeprecation(): void;
-export declare function warnCypressExecutorGenerating(): void;

package/dist/src/utils/deprecation.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CYPRESS_EXECUTOR_DEPRECATION_MESSAGE = void 0;
-exports.warnCypressExecutorDeprecation = warnCypressExecutorDeprecation;
-exports.warnCypressExecutorGenerating = warnCypressExecutorGenerating;
-const devkit_1 = require("@nx/devkit");
-// TODO(v24): Remove the @nx/cypress:cypress executor. The inferred plugin
-// (@nx/cypress/plugin) and the convert-to-inferred generator stay supported.
-exports.CYPRESS_EXECUTOR_DEPRECATION_MESSAGE = 'The `@nx/cypress:cypress` executor is deprecated and will be removed in Nx v24. Run `nx g @nx/cypress:convert-to-inferred` to migrate to the `@nx/cypress/plugin` inferred targets. See https://nx.dev/docs/guides/tasks--caching/convert-to-inferred for details.';
-function warnCypressExecutorDeprecation() {
-    devkit_1.logger.warn(exports.CYPRESS_EXECUTOR_DEPRECATION_MESSAGE);
-}
-// Fired when the @nx/cypress:configuration or :component-configuration
-// generator is about to generate a target that uses the deprecated executor —
-// i.e. when @nx/cypress/plugin isn't registered in nx.json. Surfaces the
-// deprecation at generation time rather than only when the user later runs the
-// generated target.
-function warnCypressExecutorGenerating() {
-    devkit_1.logger.warn('Generating a target that uses the deprecated `@nx/cypress:cypress` executor. The executor will be removed in Nx v24. Run `nx g @nx/cypress:convert-to-inferred` next to migrate this target to the `@nx/cypress/plugin` inferred plugin and prevent future generators from emitting executor targets. See https://nx.dev/docs/guides/tasks--caching/convert-to-inferred for details.');
-}

package/dist/src/utils/start-dev-server.d.ts

@@ -1,9 +0,0 @@
-import { ExecutorContext } from '@nx/devkit';
-import { CypressExecutorOptions } from '../executors/cypress/cypress.impl';
-export declare function startDevServer(opts: Omit<CypressExecutorOptions, 'cypressConfig'>, context: ExecutorContext): AsyncGenerator<{
-    baseUrl: any;
-    portLockFilePath?: undefined;
-} | {
-    baseUrl: any;
-    portLockFilePath: string;
-}, void, unknown>;