manage ip v6 too

Author: Nelson-numerical-software

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 - Update packages dependencies
 
+- unit tests reworked
+
 - Tested with Nelson 1.10.0
 
 - Requires Nodejs 22.14.0

lib/nelsonProcess.js

@@ -21,7 +21,7 @@
 // Import required modules
 const CONFIGURATION = require('../etc/configuration.json');
 const { spawn } = require('child_process');
-const { Address4 } = require('ip-address');
+const { Address4, Address6 } = require('ip-address');
 const socketio = require('socket.io');
 const os = require('os');
 //=============================================================================
@@ -49,7 +49,25 @@ function startNelsonProcess() {
   let io = []; // Array to store socket connections
   let nelsonApp; // Child process running Nelson application
   let commandio; // Socket.IO instance for command communication
+  let hasCleaned = false;
 
+  function cleanup(terminateNelson = false) {
+    if (hasCleaned) {
+      return;
+    }
+    hasCleaned = true;
+    if (terminateNelson) {
+      nelsonApp?.kill();
+    }
+    commandio?.close?.();
+    commandio = undefined;
+    nelsonApp = undefined;
+  }
+
+  process.once('SIGINT', () => cleanup(true));
+  process.once('SIGTERM', () => cleanup(true));
+  process.once('disconnect', () => cleanup(true));
+  process.once('exit', () => cleanup());
   // Listen for messages from the parent process
   process.on('message', (msg) => {
     switch (msg.msgtype) {
@@ -77,10 +95,11 @@ function startNelsonProcess() {
       case 'stop':
         // Stop the application
         commandio?.emit('stop');
+        cleanup(true);
         break;
       case 'quit':
         // Terminate Nelson application
-        nelsonApp?.kill();
+        cleanup(true);
         break;
       default:
         // Log unknown message types
@@ -93,6 +112,7 @@ function startNelsonProcess() {
    * @param {number} port - Port number for socket connection
    */
   function handleInitialization(port) {
+    hasCleaned = false;
     // Set up socket connection
     const { io: socketIOInstance, address: commandAddress } =
       initializeSocket(port);
@@ -106,6 +126,13 @@ function startNelsonProcess() {
     // Determine and spawn Nelson application
     const { app, parameters } = getAppAndParameters(commandAddress);
     nelsonApp = spawn(app, parameters);
+    nelsonApp.on('exit', (code, signal) => {
+      process.send?.({ msgtype: 'process_exit', code, signal });
+      cleanup();
+    });
+    nelsonApp.on('error', (error) => {
+      process.send?.({ msgtype: 'process_error', error: error.message });
+    });
 
     // Handle socket disconnection
     commandio.on('disconnect', () => {
@@ -120,24 +147,15 @@ function startNelsonProcess() {
    */
   function initializeSocket(port) {
     // Create Socket.IO instance
-    const commandio = socketio(port);
-
-    // Find first external IPv4 network interface
-    const networkInterfaces = os.networkInterfaces();
-    const ipv4 = Object.values(networkInterfaces)
-      .flat()
-      .find((details) => details.family === 'IPv4' && !details.internal);
-
-    // Throw error if no external IPv4 address found
-    if (!ipv4) {
-      throw new Error('No external IPv4 address found.');
-    }
-
-    // Create address object
-    const addr = new Address4(ipv4.address);
+    const ioInstance = socketio(port);
+    const addressInfo = resolveNetworkAddress();
+    const addressString =
+      addressInfo.family === 'IPv6'
+        ? `http://[${addressInfo.address.correctForm()}]:${port}`
+        : `http://${addressInfo.address.address}:${port}`;
     return {
-      io: commandio,
-      address: `http://${addr.address}:${port}`,
+      io: ioInstance,
+      address: addressString,
     };
   }
   //=============================================================================
@@ -153,15 +171,45 @@ function startNelsonProcess() {
       : CONFIGURATION.NELSON_APPLICATION;
 
     // Get corresponding parameters
-    const parameters = CONFIGURATION.USE_DOCKER
+    const baseParameters = CONFIGURATION.USE_DOCKER
       ? CONFIGURATION.DOCKER_PARAMETERS
       : CONFIGURATION.NELSON_APPLICATION_PARAMETERS;
 
-    // Append command address to parameters
-    parameters.push(commandAddress);
+    const parameters = [...(baseParameters ?? []), commandAddress];
     return { app, parameters };
   }
   //=============================================================================
+  /**
+   * Resolve network address for the socket connection
+   * Favors IPv4 over IPv6, and external over internal addresses
+   * @returns {Object} Resolved address and family (IPv4/IPv6)
+   */
+  function resolveNetworkAddress() {
+    const interfaces = Object.values(os.networkInterfaces())
+      .flat()
+      .filter(Boolean);
+    const candidate =
+      interfaces.find((details) => details.family === 'IPv4' && !details.internal) ??
+      interfaces.find((details) => details.family === 'IPv6' && !details.internal) ??
+      interfaces.find((details) => details.family === 'IPv4') ??
+      interfaces.find((details) => details.family === 'IPv6');
+
+    if (!candidate || typeof candidate.address !== 'string') {
+      throw new Error('No network address available.');
+    }
+
+    const addressValue = candidate.address.includes('%')
+      ? candidate.address.split('%')[0]
+      : candidate.address;
+
+    const address =
+      candidate.family === 'IPv6'
+        ? new Address6(addressValue)
+        : new Address4(addressValue);
+
+    return { address, family: candidate.family };
+  }
+  //=============================================================================
 }
 //=============================================================================
 /**