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

package/dist/src/executors/wait-for-webserver/wait-for-webserver.impl.js

@@ -21,7 +21,7 @@ const FALLBACK_RETRY_DELAY = 1_000;
 // nothing, so it must not replace what the previous probe saw.
 const NO_OBSERVATION = 'the deadline passed before the server responded';
 async function waitForWebserverExecutor(options, context) {
-    const servers = options.servers ?? [];
+    const servers = withReadyUrl(options.servers ?? []);
     if (servers.length === 0) {
         devkit_1.logger.error('@nx/playwright:wait-for-webserver requires at least one server to wait for.');
         return { success: false };
@@ -49,6 +49,15 @@ async function waitForWebserverExecutor(options, context) {
     }
 }
 exports.default = waitForWebserverExecutor;
+// The address the server task reported when it signaled readiness. It names no
+// server, so it only moves the url of a gate waiting for exactly one.
+function withReadyUrl(servers) {
+    const readyUrl = process.env.NX_READY_URL;
+    if (!readyUrl || servers.length !== 1 || servers[0].port != null) {
+        return servers;
+    }
+    return [{ ...servers[0], url: (0, devkit_1.getReadyUrl)(servers[0].url) }];
+}
 // A malformed URL, an out-of-range port and a proxy that cannot be used are all
 // inputs that can never become valid, so they are rejected up front instead of
 // being retried until the timeout and reported as a slow server. An unusable

package/dist/src/generators/configuration/files/playwright.config.mts.template

@@ -1,9 +1,10 @@
 import { defineConfig, devices } from '@playwright/test';
 import { nxE2EPreset } from '@nx/playwright/preset';
-<% if (webServerCommand && webServerAddress) { %>import { workspaceRoot } from '@nx/devkit';<% } %>
+<% if (webServerCommand && webServerAddress) { %>import { getReadyUrl, workspaceRoot } from '@nx/devkit';<% } %>
 
 // For CI, you may want to set BASE_URL to the deployed application.
-const baseURL = process.env['BASE_URL'] || '<% if(webServerAddress) {%><%= webServerAddress %><% } else {%>http://localhost:3000<% } %>';
+<% if (webServerCommand && webServerAddress) { %>// getReadyUrl moves the address to the port the dev server task reported.
+const baseURL = process.env['BASE_URL'] || getReadyUrl('<%= webServerAddress %>');<% } else { %>const baseURL = process.env['BASE_URL'] || '<% if(webServerAddress) {%><%= webServerAddress %><% } else {%>http://localhost:3000<% } %>';<% } %>
 
 /**
  * Read environment variables from file.
@@ -32,7 +33,7 @@ export default defineConfig({
   /* Run your local dev server before starting the tests */<% if(webServerCommand && webServerAddress) {%>
   webServer: {
     command: '<%= webServerCommand %>',
-    url: '<%= webServerAddress %>',
+    url: getReadyUrl('<%= webServerAddress %>'),
     reuseExistingServer: true,
     cwd: workspaceRoot
   },<% } else {%>

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/playwright/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,40 @@
+#### Keep Playwright e2e tasks from waiting for the dev server to be ready
+
+`@nx/playwright/plugin` has a new `waitForServerReady` option, on by default. With it on, the inferred e2e tasks wait for the dev server task's `readyWhen` and get the address it reported in `NX_READY_URL`. Before, they only waited for the dev server task to start.
+
+This migration sets `waitForServerReady: false` on every `@nx/playwright/plugin` entry in `nx.json`, so existing workspaces keep the old behavior. Entries that already set the option stay as they are. To opt in, remove the option or set it to `true`.
+
+#### Sample code changes
+
+##### Before
+
+```json title="nx.json"
+{
+  "plugins": [
+    "@nx/playwright/plugin",
+    {
+      "plugin": "@nx/playwright/plugin",
+      "include": ["apps/admin-e2e/**"],
+      "options": { "targetName": "e2e" }
+    }
+  ]
+}
+```
+
+##### After
+
+```json title="nx.json"
+{
+  "plugins": [
+    {
+      "plugin": "@nx/playwright/plugin",
+      "options": { "waitForServerReady": false }
+    },
+    {
+      "plugin": "@nx/playwright/plugin",
+      "include": ["apps/admin-e2e/**"],
+      "options": { "targetName": "e2e", "waitForServerReady": false }
+    }
+  ]
+}
+```

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

@@ -16,6 +16,12 @@ export interface PlaywrightPluginOptions {
      * true.
      */
     waitForWebServer?: boolean;
+    /**
+     * Whether the inferred dependencies on the web server tasks wait for those
+     * tasks' `readyWhen` (`waitFor: 'ready'`) rather than for them to start.
+     * Defaults to true.
+     */
+    waitForServerReady?: boolean;
 }
 export declare const createNodes: CreateNodes<PlaywrightPluginOptions>;
 export declare const createNodesV2: CreateNodes<PlaywrightPluginOptions>;

package/dist/src/plugins/plugin.js

@@ -205,7 +205,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
             },
         },
     };
-    applyChainDependsOn(baseTargetConfig, e2eChain, e2eReadyTargetName);
+    applyChainDependsOn(baseTargetConfig, e2eChain, e2eReadyTargetName, options.waitForServerReady);
     targets[options.targetName] = {
         ...baseTargetConfig,
         cache: true,
@@ -219,10 +219,10 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
         outputs: getTargetOutputs(testOutput, reporterOutputs, context.workspaceRoot, projectRoot),
     };
     if (e2eReadyTargetName) {
-        targets[e2eReadyTargetName] = buildWaitForWebserverTarget(e2eChain, options.webServerTimeout);
+        targets[e2eReadyTargetName] = buildWaitForWebserverTarget(e2eChain, options.webServerTimeout, options.waitForServerReady);
     }
     if (ciReadyTargetName && ciReadyTargetName !== e2eReadyTargetName) {
-        targets[ciReadyTargetName] = buildWaitForWebserverTarget(ciChain, options.webServerTimeout);
+        targets[ciReadyTargetName] = buildWaitForWebserverTarget(ciChain, options.webServerTimeout, options.waitForServerReady);
     }
     if (options.ciTargetName) {
         // ensure the blob reporter output is the directory containing the blob
@@ -245,7 +245,7 @@ async function buildPlaywrightTargets(configFilePath, projectRoot, options, cont
         // Unconditionally: the chains can differ in ways the shared-gate check
         // deliberately ignores (an extra uncovered server flips parallelism), and
         // re-deriving is a no-op when they match.
-        applyChainDependsOn(ciBaseTargetConfig, ciChain, ciReadyTargetName);
+        applyChainDependsOn(ciBaseTargetConfig, ciChain, ciReadyTargetName, options.waitForServerReady);
         const groupName = 'E2E (CI)';
         metadata = { targetGroups: { [groupName]: [] } };
         const ciTargetGroup = metadata.targetGroups[groupName];
@@ -401,6 +401,7 @@ function normalizeOptions(options) {
         ciTargetName,
         mergeReportsTargetName: `${ciTargetName}--merge-reports`,
         waitForWebServer: options?.waitForWebServer ?? true,
+        waitForServerReady: options?.waitForServerReady !== false,
     };
 }
 function getTestOutput(playwrightConfig) {
@@ -546,7 +547,7 @@ function sameChain(a, b) {
     return (JSON.stringify(a.commandTasks) === JSON.stringify(b.commandTasks) &&
         JSON.stringify(a.readinessServers) === JSON.stringify(b.readinessServers));
 }
-function buildWaitForWebserverTarget(chain, webServerTimeout) {
+function buildWaitForWebserverTarget(chain, webServerTimeout, waitForServerReady) {
     return {
         executor: '@nx/playwright:wait-for-webserver',
         cache: false,
@@ -554,7 +555,7 @@ function buildWaitForWebserverTarget(chain, webServerTimeout) {
             servers: chain.readinessServers,
             ...(webServerTimeout != null ? { timeout: webServerTimeout } : {}),
         },
-        dependsOn: getDependsOn(chain.commandTasks),
+        dependsOn: getDependsOn(chain.commandTasks, waitForServerReady),
         metadata: {
             technologies: ['playwright'],
             description: 'Waits for the E2E web server(s) to be ready before the Playwright test tasks run.',
@@ -693,11 +694,12 @@ function chainRequiresSerialization(chain) {
 // was inferred). Set together with parallelism so a config that inherits one
 // state (the atomized CI base copies the e2e config) cannot end up carrying
 // both.
-function applyChainDependsOn(targetConfig, chain, readyTargetName) {
+function applyChainDependsOn(targetConfig, chain, readyTargetName, waitForServerReady) {
     if (chain.commandTasks.length) {
+        const serverDependsOn = getDependsOn(chain.commandTasks, waitForServerReady);
         targetConfig.dependsOn = readyTargetName
-            ? [...getDependsOn(chain.commandTasks), { target: readyTargetName }]
-            : getDependsOn(chain.commandTasks);
+            ? [...serverDependsOn, { target: readyTargetName }]
+            : serverDependsOn;
     }
     else {
         delete targetConfig.dependsOn;
@@ -709,7 +711,7 @@ function applyChainDependsOn(targetConfig, chain, readyTargetName) {
         delete targetConfig.parallelism;
     }
 }
-function getDependsOn(tasks) {
+function getDependsOn(tasks, waitForServerReady) {
     const projectsPerTask = new Map();
     for (const { project, target } of tasks) {
         if (!projectsPerTask.has(target)) {
@@ -720,6 +722,7 @@ function getDependsOn(tasks) {
     return Array.from(projectsPerTask.entries()).map(([target, projects]) => ({
         projects,
         target,
+        ...(waitForServerReady ? { waitFor: 'ready' } : {}),
     }));
 }
 function normalizeOutput(path, workspaceRoot, projectRoot) {

package/migrations.json

@@ -12,6 +12,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"
+    },
+    "update-24-0-0-disable-wait-for-server-ready": {
+      "version": "24.0.0-beta.4",
+      "description": "Sets `waitForServerReady: false` on `@nx/playwright/plugin` entries in `nx.json` so existing Playwright 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"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/playwright",
-  "version": "24.0.0-beta.3",
+  "version": "24.0.0-beta.4",
   "private": false,
   "type": "commonjs",
   "files": [
@@ -75,16 +75,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",
     "https-proxy-agent": "^7.0.6",
     "minimatch": "10.2.5",
     "semver": "^7.6.3",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "nx": "24.0.0-beta.3"
+    "nx": "24.0.0-beta.4"
   },
   "peerDependencies": {
     "@playwright/test": "^1.36.0"