@nx/cypress 17.2.0-beta.3 → 17.2.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "17.2.0-beta.3",
+  "version": "17.2.0-beta.5",
   "private": false,
   "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
@@ -34,15 +34,15 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "17.2.0-beta.3",
-    "@nx/eslint": "17.2.0-beta.3",
-    "@nx/js": "17.2.0-beta.3",
+    "@nx/devkit": "17.2.0-beta.5",
+    "@nx/eslint": "17.2.0-beta.5",
+    "@nx/js": "17.2.0-beta.5",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "detect-port": "^1.5.1",
     "string-argv": "^0.3.2",
     "semver": "7.5.3",
     "tslib": "^2.3.0",
-    "@nrwl/cypress": "17.2.0-beta.3"
+    "@nrwl/cypress": "17.2.0-beta.5"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 14"

package/plugins/cypress-preset.d.ts

@@ -32,6 +32,17 @@ export declare function nxBaseCypressPreset(pathToConfig: string, options?: {
  *
  */
 export declare function nxE2EPreset(pathToConfig: string, options?: NxCypressE2EPresetOptions): any;
+export interface WebServerConfig {
+    /**
+     * Timeout to wait for the webserver to start listening
+     */
+    timeout?: number;
+    /**
+     * Reuse an existing web server if it exists
+     * If this is false, an error will be thrown if the server is already running
+     */
+    reuseExistingServer?: boolean;
+}
 export type NxCypressE2EPresetOptions = {
     bundler?: string;
     /**
@@ -42,5 +53,6 @@ export type NxCypressE2EPresetOptions = {
     cypressDir?: string;
     webServerCommands?: Record<string, string>;
     ciWebServerCommand?: string;
+    webServerConfig?: WebServerConfig;
 };
 export {};

package/plugins/cypress-preset.js

@@ -5,8 +5,9 @@ const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const preprocessor_vite_1 = require("../src/plugins/preprocessor-vite");
-const string_argv_1 = require("string-argv");
 const child_process_1 = require("child_process");
+const http_1 = require("http");
+const https_1 = require("https");
 function nxBaseCypressPreset(pathToConfig, options) {
     // used to set babel settings for react CT.
     process.env.NX_CYPRESS_COMPONENT_TEST =
@@ -27,6 +28,16 @@ function nxBaseCypressPreset(pathToConfig, options) {
     };
 }
 exports.nxBaseCypressPreset = nxBaseCypressPreset;
+function startWebServer(webServerCommand) {
+    const serverProcess = (0, child_process_1.exec)(webServerCommand, {
+        cwd: devkit_1.workspaceRoot,
+    });
+    serverProcess.stdout.pipe(process.stdout);
+    serverProcess.stderr.pipe(process.stderr);
+    return () => {
+        serverProcess.kill();
+    };
+}
 /**
  * nx E2E Preset for Cypress
  * @description
@@ -61,37 +72,68 @@ function nxE2EPreset(pathToConfig, options) {
             if (!config.env.webServerCommands) {
                 return;
             }
-            const webServerCommand = config.env.webServerCommand ?? config.env.webServerCommands.default;
+            const webServerCommand = config.env.webServerCommand;
             if (!webServerCommand) {
                 return;
             }
-            if (!config.baseUrl && webServerCommand) {
-                return new Promise((resolve) => {
-                    const [command, ...args] = (0, string_argv_1.default)(webServerCommand);
-                    const serverProcess = (0, child_process_1.spawn)(command, args, {
-                        stdio: ['inherit', 'inherit', 'inherit', 'ipc'],
-                        cwd: devkit_1.workspaceRoot,
-                        // Shell is required for windows but cannot be true on linux because it interferes with terminating the process
-                        shell: process.platform === 'win32',
-                        windowsHide: true,
-                    });
-                    serverProcess.on('message', (message) => {
-                        if (typeof message === 'object' &&
-                            'type' in message &&
-                            'baseUrl' in message &&
-                            message.type === 'server') {
-                            config.baseUrl = message.baseUrl;
-                            resolve(config);
-                        }
-                    });
-                    on('after:run', () => {
-                        serverProcess.kill('SIGTERM');
-                    });
+            if (config.baseUrl && webServerCommand) {
+                if (await isServerUp(config.baseUrl)) {
+                    if (options.webServerConfig.reuseExistingServer === undefined
+                        ? true
+                        : options.webServerConfig.reuseExistingServer) {
+                        console.log(`Reusing the server already running on ${config.baseUrl}`);
+                        return;
+                    }
+                    else {
+                        throw new Error(`Web server is already running at ${config.baseUrl}`);
+                    }
+                }
+                const killWebServer = startWebServer(webServerCommand);
+                on('after:run', () => {
+                    killWebServer();
                 });
+                await waitForServer(config.baseUrl, options.webServerConfig);
             }
-            return config;
         },
     };
     return baseConfig;
 }
 exports.nxE2EPreset = nxE2EPreset;
+function waitForServer(url, webServerConfig) {
+    return new Promise((resolve, reject) => {
+        let pollTimeout;
+        const { protocol } = new URL(url);
+        const timeoutDuration = webServerConfig?.timeout ?? 5 * 1000;
+        const timeout = setTimeout(() => {
+            clearTimeout(pollTimeout);
+            reject(new Error(`Web server failed to start in ${timeoutDuration}ms. This can be configured in cypress.config.ts.`));
+        }, timeoutDuration);
+        const makeRequest = protocol === 'https:' ? https_1.request : http_1.request;
+        function pollForServer() {
+            const request = makeRequest(url, () => {
+                clearTimeout(timeout);
+                resolve();
+            });
+            request.on('error', () => {
+                pollTimeout = setTimeout(pollForServer, 100);
+            });
+            // Don't forget to end the request
+            request.end();
+        }
+        pollForServer();
+    });
+}
+function isServerUp(url) {
+    const { protocol } = new URL(url);
+    const makeRequest = protocol === 'https:' ? https_1.request : http_1.request;
+    return new Promise((resolve) => {
+        const request = makeRequest(url, () => {
+            resolve(true);
+        });
+        request.on('error', () => {
+            resolve(false);
+        });
+        // Don't forget to end the request
+        request.end();
+    });
+}

package/src/generators/configuration/configuration.js

@@ -97,7 +97,7 @@ async function addFiles(tree, options, projectGraph, hasPlugin) {
         const cyFile = (0, devkit_1.joinPathFragments)(projectConfig.root, 'cypress.config.ts');
         let webServerCommands;
         let ciDevServerTarget;
-        if (hasPlugin && !options.baseUrl && options.devServerTarget) {
+        if (hasPlugin && options.devServerTarget) {
             webServerCommands = {};
             webServerCommands.default = 'nx run ' + options.devServerTarget;
             const parsedTarget = (0, devkit_1.parseTargetString)(options.devServerTarget, projectGraph);

package/src/plugins/plugin.js

@@ -36,7 +36,9 @@ exports.createNodes = [
             !siblingFiles.includes('project.json')) {
             return {};
         }
-        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context);
+        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [
+            (0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot)),
+        ]);
         const targets = targetsCache[hash]
             ? targetsCache[hash]
             : buildCypressTargets(configFilePath, projectRoot, options, context);
@@ -96,7 +98,7 @@ function buildCypressTargets(configFilePath, projectRoot, options, context) {
         ...cypressConfig.env,
         ...cypressConfig.e2e?.env,
     };
-    const devServerTargets = cypressEnv?.devServerTargets;
+    const webServerCommands = cypressEnv?.webServerCommands;
     const relativeConfigPath = (0, path_1.relative)(projectRoot, configFilePath);
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
     const targets = {};
@@ -117,19 +119,21 @@ function buildCypressTargets(configFilePath, projectRoot, options, context) {
         if (e2eTargetDefaults?.outputs === undefined) {
             targets[options.targetName].outputs = getOutputs(projectRoot, cypressConfig, 'e2e');
         }
-        if (devServerTargets?.default) {
-            delete devServerTargets.default;
+        if (webServerCommands?.default) {
+            cypressConfig.e2e ??= {};
+            cypressConfig.e2e.webServerCommand ??= webServerCommands?.default;
+            delete webServerCommands.default;
         }
-        if (Object.keys(devServerTargets ?? {}).length > 0) {
+        if (Object.keys(webServerCommands ?? {}).length > 0) {
             targets[options.targetName].configurations ??= {};
-            for (const [configuration, devServerTarget] of Object.entries(devServerTargets ?? {})) {
+            for (const [configuration, webServerCommand] of Object.entries(webServerCommands ?? {})) {
                 targets[options.targetName].configurations[configuration] = {
-                    command: `cypress run --config-file ${relativeConfigPath} --e2e --env.webServerCommand "nx run ${devServerTarget}"`,
+                    command: `cypress run --config-file ${relativeConfigPath} --e2e --env webServerCommand="${webServerCommand}"`,
                 };
             }
         }
-        const ciDevServerTarget = cypressEnv?.ciDevServerTarget;
-        if (ciDevServerTarget) {
+        const ciWebServerCommand = cypressEnv?.ciWebServerCommand;
+        if (ciWebServerCommand) {
             const specPatterns = Array.isArray(cypressConfig.e2e.specPattern)
                 ? cypressConfig.e2e.specPattern.map((p) => (0, path_1.join)(projectRoot, p))
                 : [(0, path_1.join)(projectRoot, cypressConfig.e2e.specPattern)];
@@ -150,7 +154,10 @@ function buildCypressTargets(configFilePath, projectRoot, options, context) {
                     outputs,
                     inputs,
                     cache: true,
-                    command: `cypress run --config-file ${relativeConfigPath} --e2e --env.webServerCommand "nx run ${ciDevServerTarget}" --spec ${relativeSpecFilePath}`,
+                    command: `cypress run --config-file ${relativeConfigPath} --e2e --env webServerCommand="${ciWebServerCommand}" --spec ${relativeSpecFilePath}`,
+                    options: {
+                        cwd: projectRoot,
+                    },
                 };
                 dependsOn.push({
                     target: targetName,