@yarkivaev/source-to-sink 1.3.2 → 1.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarkivaev/source-to-sink",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Generic library for building data streaming pipelines",
   "repository": {
     "type": "git",

package/src/modbusSource.js

@@ -4,7 +4,7 @@ import pollingSource from './pollingSource.js';
 /**
  * Idle state for Modbus connection.
  *
- * @returns {object} State with connected() returning false and no retry handle
+ * @returns {object} State with no open attempt
  */
 function idle() {
   return {
@@ -13,6 +13,9 @@ function idle() {
     },
     retrying() {
       return false;
+    },
+    opening() {
+      return false;
     }
   };
 }
@@ -31,12 +34,34 @@ function retrying(handle) {
     retrying() {
       return true;
     },
+    opening() {
+      return false;
+    },
     cancel() {
       clearTimeout(handle);
     }
   };
 }
 
+/**
+ * In-flight TCP or RTU connect state.
+ *
+ * @returns {object} State with opening() returning true
+ */
+function opening() {
+  return {
+    connected() {
+      return false;
+    },
+    retrying() {
+      return false;
+    },
+    opening() {
+      return true;
+    }
+  };
+}
+
 /**
  * Connected state for Modbus connection.
  *
@@ -51,12 +76,44 @@ function connected(client) {
     retrying() {
       return false;
     },
+    opening() {
+      return false;
+    },
     disconnect() {
       client.close();
     }
   };
 }
 
+/**
+ * Starts one connect attempt and ignores results after stop().
+ *
+ * @param {object} bag - Mutable lifecycle bag
+ */
+function attempt(bag) {
+  const token = bag.epoch;
+  bag.state = opening();
+  bag.connect(bag.client).then(() => {
+    if (token !== bag.epoch) {
+      bag.client.close();
+      return;
+    }
+    bag.delay = bag.interval;
+    bag.state = connected(bag.client);
+    bag.source.start();
+  }).catch((err) => {
+    if (token !== bag.epoch) {
+      return;
+    }
+    bag.log.error(`Connection to ${bag.target} failed, retrying in ${bag.delay}s: ${err.message}`);
+    const handle = setTimeout(() => {
+      attempt(bag);
+    }, bag.delay * 1000);
+    bag.state = retrying(handle);
+    bag.delay = Math.min(bag.delay * 2, bag.maxDelay);
+  });
+}
+
 /**
  * Shared Modbus polling lifecycle for TCP and RTU transports.
  *
@@ -64,60 +121,42 @@ function connected(client) {
  * @returns {object} Source with start() and stop() methods
  */
 function modbusPollingSource(options) {
-  const {
-    connect,
-    target,
-    address,
-    count,
-    interval,
-    collector,
-    clk,
-    client,
-    log
-  } = options;
-  let state = idle();
+  const { address, count, interval, collector, clk, client } = options;
   async function fetch() {
     const result = await client.readHoldingRegisters(address, count);
     return [result.data];
   }
-  const maxDelay = 300;
-  const source = pollingSource(fetch, interval, collector, clk);
-  let delay = interval;
-  function attempt() {
-    connect(client).then(() => {
-      delay = interval;
-      state = connected(client);
-      source.start();
-    }).catch((err) => {
-      log.error(`Connection to ${target} failed, retrying in ${delay}s: ${err.message}`);
-      const handle = setTimeout(attempt, delay * 1000);
-      state = retrying(handle);
-      delay = Math.min(delay * 2, maxDelay);
-    });
-  }
+  const bag = {
+    ...options,
+    state: idle(),
+    epoch: 0,
+    maxDelay: 300,
+    source: pollingSource(fetch, interval, collector, clk),
+    delay: interval
+  };
   return {
     /**
      * Connects to the Modbus device and starts polling.
      */
     start() {
-      if (state.connected() || state.retrying()) {
+      if (bag.state.connected() || bag.state.retrying() || bag.state.opening()) {
         return;
       }
-      attempt();
+      attempt(bag);
     },
     /**
      * Stops polling and disconnects from the Modbus device.
      */
     stop() {
-      source.stop();
-      if (state.retrying()) {
-        state.cancel();
-        state = idle();
+      bag.epoch += 1;
+      bag.source.stop();
+      if (bag.state.retrying()) {
+        bag.state.cancel();
       }
-      if (state.connected()) {
-        state.disconnect();
-        state = idle();
+      if (bag.state.connected() || bag.state.opening()) {
+        bag.client.close();
       }
+      bag.state = idle();
     }
   };
 }

package/test/test_modbusSource.js

@@ -1,8 +1,89 @@
 import assert from 'node:assert';
+import net from 'node:net';
 import { describe, it } from 'mocha';
 import modbusSource from '../src/modbusSource.js';
 import fakeClock from './fakeClock.js';
 
+/**
+ * TCP listener that counts concurrent sockets on an ephemeral port.
+ *
+ * @returns {Promise<object>} Gate with port, live, peak, close
+ */
+function countingListen() {
+    let live = 0;
+    let peak = 0;
+    const sockets = new Set();
+    const server = net.createServer((sock) => {
+        live += 1;
+        if (live > peak) {
+            peak = live;
+        }
+        sockets.add(sock);
+        sock.on('close', () => {
+            sockets.delete(sock);
+            live -= 1;
+        });
+    });
+    return new Promise((resolve) => {
+        server.listen(0, '127.0.0.1', () => {
+            resolve({
+                port: server.address().port,
+                live() {
+                    return live;
+                },
+                peak() {
+                    return peak;
+                },
+                close() {
+                    for (const sock of sockets) {
+                        sock.destroy();
+                    }
+                    return new Promise((done) => {
+                        server.close(done);
+                    });
+                }
+            });
+        });
+    });
+}
+
+/**
+ * Resolves after the given delay.
+ *
+ * @param {number} ms - Delay in milliseconds
+ * @returns {Promise<void>} Timer promise
+ */
+function settle(ms) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+}
+
+/**
+ * Waits until probe is true or the timeout elapses.
+ *
+ * @param {Function} probe - Condition
+ * @param {number} limit - Timeout in milliseconds
+ * @returns {Promise<void>} Resolves when probe holds
+ */
+function until(probe, limit) {
+    const deadline = Date.now() + limit;
+    function tick(resolve, reject) {
+        if (probe()) {
+            resolve();
+            return;
+        }
+        if (Date.now() >= deadline) {
+            reject(new Error('condition did not hold before timeout'));
+            return;
+        }
+        setTimeout(() => {
+            tick(resolve, reject);
+        }, 20);
+    }
+    return new Promise(tick);
+}
+
 describe('modbusSource', () => {
   it('throws on empty host', () => {
     const collector = { accept: () => {} };
@@ -118,4 +199,73 @@ describe('modbusSource', () => {
     source.stop();
     assert.strictEqual(true, true, 'Should not crash on unreachable host');
   });
+
+  it('does not open a second TCP socket when start is called twice', async function() {
+    const gate = await countingListen();
+    const source = modbusSource(
+      '127.0.0.1',
+      gate.port,
+      4000,
+      14,
+      5,
+      { accept() {} },
+      fakeClock(1 + Math.floor(Math.random() * 100)),
+      { error() {} }
+    );
+    source.start();
+    await until(() => {
+      return gate.live() >= 1;
+    }, 2000);
+    source.start();
+    await settle(150);
+    const peak = gate.peak();
+    source.stop();
+    await gate.close();
+    assert.strictEqual(peak, 1, 'second start opened another Modbus TCP socket');
+  });
+
+  it('closes the TCP socket when stop is called after connect', async function() {
+    const gate = await countingListen();
+    const source = modbusSource(
+      '127.0.0.1',
+      gate.port,
+      4000,
+      14,
+      5,
+      { accept() {} },
+      fakeClock(3 + Math.floor(Math.random() * 100)),
+      { error() {} }
+    );
+    source.start();
+    await until(() => {
+      return gate.live() >= 1;
+    }, 2000);
+    source.stop();
+    await until(() => {
+      return gate.live() === 0;
+    }, 2000);
+    const live = gate.live();
+    await gate.close();
+    assert.strictEqual(live, 0, 'stop after connect left a Modbus TCP socket open');
+  });
+
+  it('does not keep a TCP socket when stop is called during connect', async function() {
+    const gate = await countingListen();
+    const source = modbusSource(
+      '127.0.0.1',
+      gate.port,
+      4000,
+      14,
+      5,
+      { accept() {} },
+      fakeClock(7 + Math.floor(Math.random() * 100)),
+      { error() {} }
+    );
+    source.start();
+    source.stop();
+    await settle(400);
+    const live = gate.live();
+    await gate.close();
+    assert.strictEqual(live, 0, 'stop during connect left a Modbus TCP socket open');
+  });
 });