@nx/node 0.0.0-pr-30457-6a22ba8 → 0.0.0-pr-30516-94d09ba

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/node",
-  "version": "0.0.0-pr-30457-6a22ba8",
+  "version": "0.0.0-pr-30516-94d09ba",
   "private": false,
   "description": "The Node Plugin for Nx contains generators to manage Node applications within an Nx workspace.",
   "repository": {
@@ -32,10 +32,12 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "0.0.0-pr-30457-6a22ba8",
-    "@nx/jest": "0.0.0-pr-30457-6a22ba8",
-    "@nx/js": "0.0.0-pr-30457-6a22ba8",
-    "@nx/eslint": "0.0.0-pr-30457-6a22ba8"
+    "@nx/devkit": "0.0.0-pr-30516-94d09ba",
+    "@nx/jest": "0.0.0-pr-30516-94d09ba",
+    "@nx/js": "0.0.0-pr-30516-94d09ba",
+    "@nx/eslint": "0.0.0-pr-30516-94d09ba",
+    "tcp-port-used": "^1.0.2",
+    "kill-port": "^1.6.1"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/application/application.js

@@ -78,6 +78,7 @@ function getEsBuildConfig(project, options) {
 }
 function getServeConfig(options) {
     return {
+        continuous: true,
         executor: '@nx/js:node',
         defaultConfiguration: 'development',
         // Run build, which includes dependency on "^build" by default, so the first run
@@ -194,10 +195,16 @@ function addAppFiles(tree, options) {
 }
 function addProxy(tree, options) {
     const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.frontendProject);
-    if (projectConfig.targets && projectConfig.targets.serve) {
+    if (projectConfig.targets &&
+        ['serve', 'dev'].find((t) => !!projectConfig.targets[t])) {
+        const targetName = ['serve', 'dev'].find((t) => !!projectConfig.targets[t]);
+        projectConfig.targets[targetName].dependsOn = [
+            ...(projectConfig.targets[targetName].dependsOn ?? []),
+            `${options.name}:serve`,
+        ];
         const pathToProxyFile = `${projectConfig.root}/proxy.conf.json`;
-        projectConfig.targets.serve.options = {
-            ...projectConfig.targets.serve.options,
+        projectConfig.targets[targetName].options = {
+            ...projectConfig.targets[targetName].options,
             proxyConfig: pathToProxyFile,
         };
         if (!tree.exists(pathToProxyFile)) {

package/src/generators/e2e-project/e2e-project.js

@@ -45,7 +45,7 @@ async function e2eProjectGeneratorInternal(host, _options) {
                         jestConfig: `${options.e2eProjectRoot}/jest.config.ts`,
                         passWithNoTests: true,
                     },
-                    dependsOn: [`${options.project}:build`],
+                    dependsOn: [`${options.project}:build`, `${options.project}:serve`],
                 },
             },
         };
@@ -63,7 +63,7 @@ async function e2eProjectGeneratorInternal(host, _options) {
                         jestConfig: `${options.e2eProjectRoot}/jest.config.ts`,
                         passWithNoTests: true,
                     },
-                    dependsOn: [`${options.project}:build`],
+                    dependsOn: [`${options.project}:build`, `${options.project}:serve`],
                 },
             },
         });

package/src/generators/e2e-project/files/server/common/src/support/global-setup.ts__tmpl__

@@ -1,3 +1,5 @@
+import { waitForPortOpen } from '@nx/node/utils';
+
 /* eslint-disable */
 var __TEARDOWN_MESSAGE__: string;
 
@@ -5,6 +7,10 @@ module.exports = async function() {
   // Start services that that the app needs to run (e.g. database, docker-compose, etc.).
   console.log('\nSetting up...\n');
 
+  const host = process.env.HOST ?? 'localhost';
+  const port = process.env.PORT ? Number(process.env.PORT) : <%= port %>;
+  await waitForPortOpen(port, { host });
+
   // Hint: Use `globalThis` to pass variables to global teardown.
   globalThis.__TEARDOWN_MESSAGE__ = '\nTearing down...\n';
 };

package/src/generators/e2e-project/files/server/common/src/support/global-teardown.ts__tmpl__

@@ -1,7 +1,10 @@
+import { killPort } from '@nx/node/utils';
 /* eslint-disable */
 
 module.exports = async function() {
   // Put clean up logic here (e.g. stopping services, docker-compose, etc.).
   // Hint: `globalThis` is shared between setup and teardown.
+  const port = process.env.PORT ? Number(process.env.PORT) : <%= port %>;
+  await killPort(port);
   console.log(globalThis.__TEARDOWN_MESSAGE__);
 };

package/src/utils/kill-port.d.ts

@@ -0,0 +1,7 @@
+export declare const kill: any;
+/**
+ * Kills the process on the given port
+ * @param port
+ * @param killPortDelay
+ */
+export declare function killPort(port: number, killPortDelay?: number): Promise<boolean>;

package/src/utils/kill-port.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kill = void 0;
+exports.killPort = killPort;
+const devkit_1 = require("@nx/devkit");
+const tcp_port_used_1 = require("tcp-port-used");
+exports.kill = require('kill-port');
+/**
+ * Kills the process on the given port
+ * @param port
+ * @param killPortDelay
+ */
+async function killPort(port, killPortDelay = 2500) {
+    if (await (0, tcp_port_used_1.check)(port)) {
+        let killPortResult;
+        try {
+            devkit_1.logger.info(`Attempting to close port ${port}`);
+            killPortResult = await (0, exports.kill)(port);
+            await new Promise((resolve) => setTimeout(() => resolve(), killPortDelay));
+            if (await (0, tcp_port_used_1.check)(port)) {
+                devkit_1.logger.error(`Port ${port} still open ${JSON.stringify(killPortResult)}`);
+            }
+            else {
+                devkit_1.logger.info(`Port ${port} successfully closed`);
+                return true;
+            }
+        }
+        catch {
+            devkit_1.logger.error(`Port ${port} closing failed`);
+        }
+        return false;
+    }
+    else {
+        return true;
+    }
+}

package/src/utils/wait-for-port-open.d.ts

@@ -0,0 +1,24 @@
+interface WaitForPortOpenOptions {
+    /**
+     * The host to connect to
+     * @default 'localhost'
+     */
+    host?: string;
+    /**
+     * The number of retries to attempt
+     * @default 120
+     */
+    retries?: number;
+    /**
+     * The delay between retries
+     * @default 1000
+     */
+    retryDelay?: number;
+}
+/**
+ * Waits for the given port to be open
+ * @param port
+ * @param options
+ */
+export declare function waitForPortOpen(port: number, options?: WaitForPortOpenOptions): Promise<void>;
+export {};

package/src/utils/wait-for-port-open.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForPortOpen = waitForPortOpen;
+const net = require("net");
+const devkit_1 = require("@nx/devkit");
+/**
+ * Waits for the given port to be open
+ * @param port
+ * @param options
+ */
+function waitForPortOpen(port, options = {}) {
+    const host = options.host ?? 'localhost';
+    const allowedErrorCodes = ['ECONNREFUSED', 'ECONNRESET', 'ETIMEDOUT'];
+    return new Promise((resolve, reject) => {
+        const checkPort = (retries = options.retries ?? 120) => {
+            const client = new net.Socket();
+            const cleanupClient = () => {
+                client.removeAllListeners('connect');
+                client.removeAllListeners('error');
+                client.end();
+                client.destroy();
+                client.unref();
+            };
+            client.once('connect', () => {
+                cleanupClient();
+                resolve();
+            });
+            client.once('error', (err) => {
+                if (retries === 0 || !allowedErrorCodes.includes(err['code'])) {
+                    if (process.env['NX_VERBOSE_LOGGING'] === 'true') {
+                        devkit_1.logger.info(`Error connecting on ${host}:${port}: ${err['code'] || err}`);
+                    }
+                    cleanupClient();
+                    reject(err);
+                }
+                else {
+                    setTimeout(() => checkPort(retries - 1), options.retryDelay ?? 1000);
+                }
+            });
+            if (process.env['NX_VERBOSE_LOGGING'] === 'true') {
+                devkit_1.logger.info(`Connecting on ${host}:${port}`);
+            }
+            client.connect({ port, host });
+        };
+        checkPort();
+    });
+}

package/utils.d.ts

@@ -0,0 +1,2 @@
+export { waitForPortOpen } from './src/utils/wait-for-port-open';
+export { killPort } from './src/utils/kill-port';

package/utils.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.killPort = exports.waitForPortOpen = void 0;
+var wait_for_port_open_1 = require("./src/utils/wait-for-port-open");
+Object.defineProperty(exports, "waitForPortOpen", { enumerable: true, get: function () { return wait_for_port_open_1.waitForPortOpen; } });
+var kill_port_1 = require("./src/utils/kill-port");
+Object.defineProperty(exports, "killPort", { enumerable: true, get: function () { return kill_port_1.killPort; } });