@yarkivaev/source-to-sink 1.2.7 → 1.3.1

package/index.js

@@ -11,8 +11,10 @@
  * - postgresSink: PostgreSQL sink (accepts URL)
  * - mqttSource: MQTT subscription source (accepts URL)
  * - stompSource: STOMP subscription source (accepts URL)
+ * - stompSend: one-shot STOMP publish (accepts URL)
  * - lokiSource: Loki polling source (accepts URL)
  * - modbusSource: Modbus TCP polling source (accepts host/port)
+ * - modbusRtuSource: Modbus RTU polling source (accepts serial path)
  * - mqttSink: MQTT publishing sink (accepts URL)
  *
  * @example
@@ -34,7 +36,8 @@ export { default as clickhouseSink } from './src/clickhouseSink.js';
 export { default as postgresSink } from './src/postgresSink.js';
 export { default as mqttSource } from './src/mqttSource.js';
 export { default as stompSource } from './src/stompSource.js';
+export { default as stompSend } from './src/stompSend.js';
 export { default as lokiSource } from './src/lokiSource.js';
-export { default as modbusSource } from './src/modbusSource.js';
+export { default as modbusSource, modbusRtuSource } from './src/modbusSource.js';
 export { default as mqttSink } from './src/mqttSink.js';
 export { default as sqliteSink } from './src/sqliteSink.js';

package/package.json

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

package/src/modbusSource.js

@@ -58,42 +58,23 @@ function connected(client) {
 }
 
 /**
- * Modbus TCP polling source for reading holding registers.
+ * Shared Modbus polling lifecycle for TCP and RTU transports.
  *
- * Connects to a Modbus TCP device and polls holding registers
- * at a specified interval. Forwards register arrays to the
- * collector via pollingSource.
- *
- * @example
- * const source = modbusSource('192.168.2.148', 502, 4000, 14, 5, collector, clock);
- * source.start();
- * // ... later
- * source.stop();
- *
- * @param {string} host - Modbus TCP host address
- * @param {number} port - Modbus TCP port
- * @param {number} address - Starting register address
- * @param {number} count - Number of registers to read
- * @param {number} interval - Polling interval in seconds
- * @param {object} collector - Collector with accept() method
- * @param {object} clk - Clock with millis() method
- * @param {object} [log] - Logger with error() method for connection failures
+ * @param {object} options - connect, target, address, count, interval, collector, clk, client, log
  * @returns {object} Source with start() and stop() methods
  */
-export default function modbusSource(host, port, address, count, interval, collector, clk, log = console) {
-  if (typeof host !== 'string' || host.length === 0) {
-    throw new Error('Host must be a non-empty string');
-  }
-  if (typeof port !== 'number' || port <= 0) {
-    throw new Error(`Port must be a positive number, got: ${port}`);
-  }
-  if (typeof address !== 'number' || address < 0) {
-    throw new Error(`Address must be a non-negative number, got: ${address}`);
-  }
-  if (typeof count !== 'number' || count <= 0) {
-    throw new Error(`Count must be a positive number, got: ${count}`);
-  }
-  const client = new ModbusRTU();
+function modbusPollingSource(options) {
+  const {
+    connect,
+    target,
+    address,
+    count,
+    interval,
+    collector,
+    clk,
+    client,
+    log
+  } = options;
   let state = idle();
   async function fetch() {
     const result = await client.readHoldingRegisters(address, count);
@@ -103,12 +84,12 @@ export default function modbusSource(host, port, address, count, interval, colle
   const source = pollingSource(fetch, interval, collector, clk);
   let delay = interval;
   function attempt() {
-    client.connectTCP(host, { port }).then(() => {
+    connect(client).then(() => {
       delay = interval;
       state = connected(client);
       source.start();
     }).catch((err) => {
-      log.error(`Connection to ${host}:${port} failed, retrying in ${delay}s: ${err.message}`);
+      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);
@@ -140,3 +121,118 @@ export default function modbusSource(host, port, address, count, interval, colle
     }
   };
 }
+
+/**
+ * Modbus TCP polling source for reading holding registers.
+ *
+ * Connects to a Modbus TCP device and polls holding registers
+ * at a specified interval. Forwards register arrays to the
+ * collector via pollingSource.
+ *
+ * @example
+ * const source = modbusSource('192.168.2.148', 502, 4000, 14, 5, collector, clock);
+ * source.start();
+ *
+ * @param {string} host - Modbus TCP host address
+ * @param {number} port - Modbus TCP port
+ * @param {number} address - Starting register address
+ * @param {number} count - Number of registers to read
+ * @param {number} interval - Polling interval in seconds
+ * @param {object} collector - Collector with accept() method
+ * @param {object} clk - Clock with millis() method
+ * @param {object} [log] - Logger with error() method for connection failures
+ * @returns {object} Source with start() and stop() methods
+ */
+export default function modbusSource(host, port, address, count, interval, collector, clk, log = console) {
+  if (typeof host !== 'string' || host.length === 0) {
+    throw new Error('Host must be a non-empty string');
+  }
+  if (typeof port !== 'number' || port <= 0) {
+    throw new Error(`Port must be a positive number, got: ${port}`);
+  }
+  if (typeof address !== 'number' || address < 0) {
+    throw new Error(`Address must be a non-negative number, got: ${address}`);
+  }
+  if (typeof count !== 'number' || count <= 0) {
+    throw new Error(`Count must be a positive number, got: ${count}`);
+  }
+  const client = new ModbusRTU();
+  function connect(modbusClient) {
+    return modbusClient.connectTCP(host, { port });
+  }
+  return modbusPollingSource({
+    connect,
+    target: `${host}:${port}`,
+    address,
+    count,
+    interval,
+    collector,
+    clk,
+    client,
+    log
+  });
+}
+
+/**
+ * Modbus RTU polling source for reading holding registers over serial.
+ *
+ * Connects to a Modbus RTU device on a serial port and polls holding registers
+ * at a specified interval. Forwards register arrays to the collector via pollingSource.
+ *
+ * @example
+ * const source = modbusRtuSource('/dev/ttyUSB0', { baudRate: 9600, slaveId: 1 }, 4000, 44, 5, collector, clock);
+ * source.start();
+ *
+ * @param {string} path - Serial device path (e.g. /dev/ttyUSB0)
+ * @param {object} serial - baudRate, dataBits, stopBits, parity, slaveId
+ * @param {number} address - Starting register address
+ * @param {number} count - Number of registers to read
+ * @param {number} interval - Polling interval in seconds
+ * @param {object} collector - Collector with accept() method
+ * @param {object} clk - Clock with millis() method
+ * @param {object} [log] - Logger with error() method for connection failures
+ * @returns {object} Source with start() and stop() methods
+ */
+export function modbusRtuSource(path, serial, address, count, interval, collector, clk, log = console) {
+  if (typeof path !== 'string' || path.length === 0) {
+    throw new Error('Serial path must be a non-empty string');
+  }
+  if (!serial || typeof serial !== 'object') {
+    throw new Error('Serial config must be an object');
+  }
+  if (typeof serial.baudRate !== 'number' || serial.baudRate <= 0) {
+    throw new Error(`Baud rate must be a positive number, got: ${serial.baudRate}`);
+  }
+  if (typeof address !== 'number' || address < 0) {
+    throw new Error(`Address must be a non-negative number, got: ${address}`);
+  }
+  if (typeof count !== 'number' || count <= 0) {
+    throw new Error(`Count must be a positive number, got: ${count}`);
+  }
+  const client = new ModbusRTU();
+  const slaveId = serial.slaveId || 1;
+  const dataBits = serial.dataBits || 8;
+  const stopBits = serial.stopBits || 1;
+  const parity = serial.parity || 'none';
+  function connect(modbusClient) {
+    return modbusClient.connectRTUBuffered(path, {
+      baudRate: serial.baudRate,
+      dataBits,
+      stopBits,
+      parity
+    }).then(() => {
+      modbusClient.setID(slaveId);
+    });
+  }
+  return modbusPollingSource({
+    connect,
+    target: path,
+    address,
+    count,
+    interval,
+    collector,
+    clk,
+    client,
+    log
+  });
+}

package/src/stompSend.js

@@ -0,0 +1,72 @@
+import stompit from 'stompit';
+
+/**
+ * Builds STOMP connect options from a URL.
+ *
+ * @param {URL} parsed - Parsed URL object
+ * @param {object} options - Connection options
+ * @returns {object} stompit connect parameters
+ */
+function connectParams(parsed, options) {
+    return {
+        host: parsed.hostname,
+        port: parseInt(parsed.port, 10) || 61613,
+        connectHeaders: {
+            host: options.host || parsed.hostname,
+            login: options.login || '',
+            passcode: options.passcode || ''
+        }
+    };
+}
+
+/**
+ * One-shot STOMP publish of a JSON payload to a destination.
+ *
+ * Connects, sends one MESSAGE frame, disconnects. For operator decisions
+ * and other low-volume outbound events.
+ *
+ * @example
+ * await stompSend('stomp://rabbitmq:61613', '/exchange/scada.user_decisions',
+ *   { machine: 'icht2', start: 1700000000, user: 'hmi', tags: ['heating'] },
+ *   { login: 'guest', passcode: 'guest', host: '/' });
+ *
+ * @param {string} url - STOMP broker URL
+ * @param {string} destination - STOMP destination
+ * @param {object|string} payload - JSON-serializable body or raw string
+ * @param {object} [options] - STOMP connection options
+ * @param {string} [options.login] - Login
+ * @param {string} [options.passcode] - Passcode
+ * @param {string} [options.host] - Virtual host header
+ * @returns {Promise<void>} Resolves when the frame is sent and client disconnects
+ */
+export default function stompSend(url, destination, payload, options = {}) {
+    if (typeof url !== 'string' || url.length === 0) {
+        throw new Error('URL must be a non-empty string');
+    }
+    if (typeof destination !== 'string' || destination.length === 0) {
+        throw new Error('Destination must be a non-empty string');
+    }
+    const parsed = new URL(url);
+    const params = connectParams(parsed, options);
+    const body = typeof payload === 'string' ? payload : JSON.stringify(payload);
+    return new Promise((resolve, reject) => {
+        stompit.connect(params, (error, client) => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            const frame = client.send({
+                destination,
+                'content-type': 'application/json'
+            });
+            frame.end(body);
+            client.disconnect((disconnectError) => {
+                if (disconnectError) {
+                    reject(disconnectError);
+                    return;
+                }
+                resolve();
+            });
+        });
+    });
+}

package/test/test_modbusRtuSource.js

@@ -0,0 +1,45 @@
+import assert from 'node:assert';
+import { describe, it } from 'mocha';
+import { modbusRtuSource } from '../src/modbusSource.js';
+import fakeClock from './fakeClock.js';
+
+describe('modbusRtuSource', () => {
+  it('throws on empty serial path', () => {
+    const collector = { accept: () => {} };
+    const clk = fakeClock(Math.floor(Math.random() * 10000));
+    assert.throws(
+      () => {return modbusRtuSource('', { baudRate: 9600 }, 4000, 44, 5, collector, clk)},
+      /Serial path must be a non-empty string/u,
+      'Should reject empty serial path'
+    );
+  });
+
+  it('throws on invalid baud rate', () => {
+    const collector = { accept: () => {} };
+    const clk = fakeClock(Math.floor(Math.random() * 10000));
+    assert.throws(
+      () => {return modbusRtuSource('/dev/ttyUSB0', { baudRate: 0 }, 4000, 44, 5, collector, clk)},
+      /Baud rate must be a positive number/u,
+      'Should reject zero baud rate'
+    );
+  });
+
+  it('creates source with start method', () => {
+    const collector = { accept: () => {} };
+    const clk = fakeClock(Math.floor(Math.random() * 10000));
+    const source = modbusRtuSource(`/dev/ttyUSB${Math.floor(Math.random() * 9)}`, { baudRate: 9600 }, 4000, 44, 5, collector, clk);
+    assert.strictEqual(typeof source.start, 'function', 'Should expose start method for RTU source');
+  });
+
+  it('retries connection on failure', async () => {
+    let logged = false;
+    const log = { error: () => { logged = true; } };
+    const collector = { accept: () => {} };
+    const clk = fakeClock(Math.floor(Math.random() * 10000));
+    const source = modbusRtuSource(`/dev/tty\u044b${Math.random()}`, { baudRate: 9600 }, 4000, 44, 5, collector, clk, log);
+    source.start();
+    await new Promise(resolve => { setTimeout(resolve, 200); });
+    source.stop();
+    assert.strictEqual(logged, true, 'Should log RTU connection failure and retry');
+  });
+});

package/test/test_modbusSource.js

@@ -99,7 +99,8 @@ describe('modbusSource', () => {
     const log = { error: () => { logged = true; } };
     const collector = { accept: () => {} };
     const clk = fakeClock(Math.floor(Math.random() * 10000));
-    const source = modbusSource(`\u00df${Math.random()}`, 502, 4000, 14, 5, collector, clk, log);
+    const port = 65000 + Math.floor(Math.random() * 500);
+    const source = modbusSource('127.0.0.1', port, 4000, 14, 5, collector, clk, log);
     source.start();
     await new Promise(resolve => { setTimeout(resolve, 200); });
     source.stop();
@@ -110,7 +111,8 @@ describe('modbusSource', () => {
     const log = { error: () => {} };
     const collector = { accept: () => {} };
     const clk = fakeClock(Math.floor(Math.random() * 10000));
-    const source = modbusSource(`\u0420${Math.random()}`, 502, 4000, 14, 5, collector, clk, log);
+    const port = 65000 + Math.floor(Math.random() * 500);
+    const source = modbusSource('127.0.0.1', port, 4000, 14, 5, collector, clk, log);
     source.start();
     await new Promise(resolve => { setTimeout(resolve, 200); });
     source.stop();

package/test/test_stompSend.js

@@ -0,0 +1,35 @@
+import assert from 'node:assert';
+import { describe, it } from 'mocha';
+import stompSend from '../src/stompSend.js';
+
+describe('stompSend', () => {
+    it('throws on missing url', () => {
+        assert.throws(
+            () => {
+                stompSend(null, '/exchange/test', {});
+            },
+            /URL must be a non-empty string/u,
+            'Should reject missing url'
+        );
+    });
+
+    it('throws on empty destination', () => {
+        assert.throws(
+            () => {
+                stompSend('stomp://localhost:61613', '', {});
+            },
+            /Destination must be a non-empty string/u,
+            'Should reject empty destination'
+        );
+    });
+
+    it('returns a promise', () => {
+        const pending = stompSend(
+            `stomp://\u00e9${Math.random()}:61613`,
+            '/exchange/scada.user_decisions',
+            { machine: 'x', start: 1, user: 'u', tags: [] }
+        );
+        assert.strictEqual(typeof pending.then, 'function', 'Should return a promise');
+        pending.catch(() => {});
+    });
+});