@yarkivaev/scada 1.3.3 → 1.5.0

package/index.js

@@ -47,3 +47,5 @@ export { default as pubsub } from './src/pubsub.js';
 // Sensors
 export { default as scyllaSensor } from './src/scyllaSensor.js';
 export { default as clickhouseSensor } from './src/clickhouseSensor.js';
+export { default as sqliteSensor } from './src/sqliteSensor.js';
+export { default as postgresSensor } from './src/postgresSensor.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yarkivaev/scada",
-  "version": "1.3.3",
+  "version": "1.5.0",
   "description": "SCADA domain objects for plant monitoring",
   "repository": {
     "type": "git",
@@ -22,6 +22,8 @@
     "eslint": "^9.39.2",
     "globals": "^17.0.0",
     "mocha": "^10.2.0",
+    "better-sqlite3": "^11.0.0",
+    "pg": "^8.0.0",
     "testcontainers": "^10.13.0"
   },
   "files": [

package/src/postgresSensor.js

@@ -0,0 +1,105 @@
+/**
+ * Sensor backed by PostgreSQL metrics table with downsampling.
+ *
+ * Reads sensor measurements from a PostgreSQL metrics table
+ * and provides real-time streaming via polling.
+ * Supports time-based downsampling using date_bin.
+ *
+ * @param {object} connection - PostgreSQL connection with query(sql, params) method
+ * @param {string} topic - Metric topic in format '{machine}/{sensor}'
+ * @param {string} displayName - Human-readable sensor name
+ * @param {string} unit - Measurement unit (e.g., 'V', 'cos(φ)')
+ * @returns {object} sensor with name, current, measurements and stream methods
+ *
+ * @example
+ *   const sensor = postgresSensor(conn, 'icht1/voltage', 'Voltage', 'V');
+ *   sensor.name(); // 'Voltage'
+ *   await sensor.current(); // { found: true, timestamp, value, unit } or { found: false }
+ *   await sensor.measurements({ start, end }, 60000); // downsampled to 1-minute intervals
+ *   sensor.stream(since, 1000, callback); // live stream
+ */
+// eslint-disable-next-line max-lines-per-function
+export default function postgresSensor(connection, topic, displayName, unit) {
+    return {
+        /**
+         * Returns the human-readable sensor name.
+         *
+         * @returns {string} Display name
+         */
+        name() {
+            return displayName;
+        },
+        /**
+         * Returns the most recent measurement.
+         *
+         * @returns {Promise<object>} Object with found flag and optional timestamp, value, unit
+         */
+        async current() {
+            const rows = await connection.query(
+                'SELECT ts, value FROM metrics WHERE topic = $1 ORDER BY ts DESC LIMIT 1',
+                [topic]
+            );
+            if (rows.length === 0) {
+                return { found: false };
+            }
+            return { found: true, timestamp: new Date(rows[0].ts), value: rows[0].value, unit };
+        },
+        /**
+         * Returns downsampled measurements within a time range.
+         *
+         * @param {object} range - Object with start and end Date properties
+         * @param {number} step - Downsampling bucket size in milliseconds
+         * @returns {Promise<Array>} Array of {timestamp, value, unit} objects
+         */
+        async measurements(range, step) {
+            const seconds = Math.max(1, Math.floor(step / 1000));
+            const rows = await connection.query(
+                `SELECT bucket AS ts, value FROM (
+                    SELECT date_bin($1::interval, ts, '1970-01-01'::timestamptz) AS bucket, value,
+                           ROW_NUMBER() OVER (PARTITION BY date_bin($1::interval, ts, '1970-01-01'::timestamptz) ORDER BY ts DESC) AS rn
+                    FROM metrics WHERE topic = $2 AND ts >= $3 AND ts <= $4
+                ) sub WHERE rn = 1 ORDER BY ts`,
+                [`${seconds} seconds`, topic, range.start, range.end]
+            );
+            return rows.map((row) => {
+                return { timestamp: new Date(row.ts), value: row.value, unit };
+            });
+        },
+        /**
+         * Polls for new measurements and delivers them via callback.
+         *
+         * @param {Date} since - Start timestamp for polling
+         * @param {number} step - Polling interval in milliseconds
+         * @param {Function} callback - Called with each {timestamp, value, unit}
+         * @param {Function} [clock] - Optional time provider returning current Date
+         * @returns {object} Object with cancel() method to stop polling
+         */
+        stream(since, step, callback, clock) {
+            const time = clock || (() => { return new Date(); });
+            let lastTs = since;
+            const timer = setInterval(async () => {
+                try {
+                    const rows = await connection.query(
+                        'SELECT ts, value FROM metrics WHERE topic = $1 AND ts > $2 AND ts <= $3 ORDER BY ts LIMIT 100',
+                        [topic, lastTs, time()]
+                    );
+                    rows.forEach((row) => {
+                        const timestamp = new Date(row.ts);
+                        callback({ timestamp, value: row.value, unit });
+                        lastTs = timestamp;
+                    });
+                } catch {
+                    // Connection errors are non-fatal; next poll retries
+                }
+            }, step);
+            return {
+                /**
+                 * Stops the polling timer.
+                 */
+                cancel() {
+                    clearInterval(timer);
+                }
+            };
+        }
+    };
+}

package/src/segments.js

@@ -3,14 +3,14 @@ import pubsub from './pubsub.js';
 /**
  * Per-machine in-memory timeline segment collection.
  * Stores segments with name, startTime, endTime, duration.
- * Supports relabeling by startTime and streaming events via pubsub.
+ * Supports resolving by startTime and streaming events via pubsub.
  *
- * @returns {object} collection with add, relabel, query, stream methods
+ * @returns {object} collection with add, resolve, query, stream methods
  *
  * @example
  *   const segs = segments();
  *   segs.add({ name: 'on', startTime: new Date(), endTime: new Date(), duration: 60 });
- *   segs.relabel(startTime, ['heating'], {});
+ *   segs.resolve(startTime, ['heating'], {});
  *   segs.query(); // all segments
  *   segs.query({ from: '2024-01-01', to: '2024-01-02' }); // filtered
  *   const sub = segs.stream((e) => console.log(e));
@@ -24,14 +24,14 @@ export default function segments() {
             items.push(segment);
             bus.emit({ type: 'created', segment });
         },
-        relabel(start, tags, properties) {
+        resolve(start, tags, properties) {
             const found = items.find((item) => {
                 return item.startTime.getTime() === start.getTime();
             });
             if (found) {
                 found.tags = tags;
                 found.properties = properties;
-                bus.emit({ type: 'relabeled', segment: found });
+                bus.emit({ type: 'resolved', segment: found });
             }
         },
         retag(start, tags, properties) {
@@ -42,7 +42,7 @@ export default function segments() {
                 found.tags = tags;
                 found.properties = properties;
                 delete found.options;
-                bus.emit({ type: 'relabeled', segment: found });
+                bus.emit({ type: 'resolved', segment: found });
             }
         },
         query(options) {

package/src/sqliteSensor.js

@@ -0,0 +1,106 @@
+/**
+ * Sensor backed by SQLite metrics table with downsampling.
+ *
+ * Reads sensor measurements from a SQLite metrics table
+ * and provides real-time streaming via polling.
+ * Supports time-based downsampling using window functions.
+ * Timestamps are stored as epoch milliseconds (REAL).
+ *
+ * @param {object} connection - SQLite connection with query(sql, params) method
+ * @param {string} topic - Metric topic in format '{machine}/{sensor}'
+ * @param {string} displayName - Human-readable sensor name
+ * @param {string} unit - Measurement unit (e.g., 'V', 'cos(φ)')
+ * @returns {object} sensor with name, current, measurements and stream methods
+ *
+ * @example
+ *   const sensor = sqliteSensor(conn, 'icht1/voltage', 'Voltage', 'V');
+ *   sensor.name(); // 'Voltage'
+ *   await sensor.current(); // { found: true, timestamp, value, unit } or { found: false }
+ *   await sensor.measurements({ start, end }, 60000); // downsampled to 1-minute intervals
+ *   sensor.stream(since, 1000, callback); // live stream
+ */
+// eslint-disable-next-line max-lines-per-function
+export default function sqliteSensor(connection, topic, displayName, unit) {
+    return {
+        /**
+         * Returns the human-readable sensor name.
+         *
+         * @returns {string} Display name
+         */
+        name() {
+            return displayName;
+        },
+        /**
+         * Returns the most recent measurement.
+         *
+         * @returns {Promise<object>} Object with found flag and optional timestamp, value, unit
+         */
+        async current() {
+            const rows = await connection.query(
+                'SELECT ts, value FROM metrics WHERE topic = ? ORDER BY ts DESC LIMIT 1',
+                [topic]
+            );
+            if (rows.length === 0) {
+                return { found: false };
+            }
+            return { found: true, timestamp: new Date(rows[0].ts), value: rows[0].value, unit };
+        },
+        /**
+         * Returns downsampled measurements within a time range.
+         *
+         * @param {object} range - Object with start and end Date properties
+         * @param {number} step - Downsampling bucket size in milliseconds
+         * @returns {Promise<Array>} Array of {timestamp, value, unit} objects
+         */
+        async measurements(range, step) {
+            const millis = Math.max(1000, step);
+            const rows = await connection.query(
+                `SELECT bucket * ? as ts, value FROM (
+                    SELECT CAST(ts / ? AS INTEGER) as bucket, value,
+                           ROW_NUMBER() OVER (PARTITION BY CAST(ts / ? AS INTEGER) ORDER BY ts DESC) as rn
+                    FROM metrics WHERE topic = ? AND ts >= ? AND ts <= ?
+                ) WHERE rn = 1 ORDER BY ts`,
+                [millis, millis, millis, topic, range.start.getTime(), range.end.getTime()]
+            );
+            return rows.map((row) => {
+                return { timestamp: new Date(row.ts), value: row.value, unit };
+            });
+        },
+        /**
+         * Polls for new measurements and delivers them via callback.
+         *
+         * @param {Date} since - Start timestamp for polling
+         * @param {number} step - Polling interval in milliseconds
+         * @param {Function} callback - Called with each {timestamp, value, unit}
+         * @param {Function} [clock] - Optional time provider returning current Date
+         * @returns {object} Object with cancel() method to stop polling
+         */
+        stream(since, step, callback, clock) {
+            const time = clock || (() => { return new Date(); });
+            let lastTs = since;
+            const timer = setInterval(async () => {
+                try {
+                    const rows = await connection.query(
+                        'SELECT ts, value FROM metrics WHERE topic = ? AND ts > ? AND ts <= ? ORDER BY ts LIMIT 100',
+                        [topic, lastTs.getTime(), time().getTime()]
+                    );
+                    rows.forEach((row) => {
+                        const timestamp = new Date(row.ts);
+                        callback({ timestamp, value: row.value, unit });
+                        lastTs = timestamp;
+                    });
+                } catch {
+                    // Connection errors are non-fatal; next poll retries
+                }
+            }, step);
+            return {
+                /**
+                 * Stops the polling timer.
+                 */
+                cancel() {
+                    clearInterval(timer);
+                }
+            };
+        }
+    };
+}