@yroshcha/node-red-contrib-redis-full 1.0.7 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project are documented in this file.
 
+## 2.0.0 — 2026-09-07
+
+### Breaking changes
+
+- The minimum supported Node.js version is now 20 and the minimum supported Node-RED version is now 4. This aligns the package with `ioredis` 6.
+
+### Changed
+
+- Updated `ioredis` to the current 6.x release line.
+- Added an importable Redis Streams example flow (`XADD → XREADGROUP → XACK`) for the Node-RED library.
+
+## 1.0.9 — 2026-09-07
+
+### Fixed
+
+- Declared the supported Node-RED runtime range in the package metadata so the Flow Library scorecard and Palette Manager can evaluate compatibility correctly.
+
+## 1.0.8 — 2026-08-12
+
+### Fixed
+
+- `redis xreadgroup` and `redis xautoclaim` now restore nested object and array fields that were serialised by `redis xadd`, while preserving scalar Redis fields as strings.
+
 ## 1.0.7 — 2026-08-12
 
 ### Added

package/README.md

@@ -45,7 +45,7 @@ For a local archive, use `npm install /path/to/yroshcha-node-red-contrib-redis-f
 
 ## Release status
 
-**`1.0.7` is the current stable release.** See [CHANGELOG.md](CHANGELOG.md) for release notes and compatibility information.
+**`2.0.0` is the current stable release.** See [CHANGELOG.md](CHANGELOG.md) for release notes and compatibility information.
 
 ## Production profile
 
@@ -58,6 +58,7 @@ Safe consumer defaults and important settings:
 - **Rate limit (msg/s) = 0** is unlimited. For example, `500` limits average downstream delivery to 500 events per second.
 - **Read interval (ms) = 0** reads as fast as Redis responds. `1000` calls `XREADGROUP` no more often than once per second, independent of queue depth.
 - **Batch wait (ms) = 0** emits one event at a time. With a positive value, the node emits an array once it has collected `COUNT` events or the wait expires. `msg.payload` and `msg.streamId` become arrays.
+- Nested object and array fields written by `redis xadd` are automatically decoded from JSON by `redis xreadgroup` and `redis xautoclaim`; scalar Redis fields remain strings.
 - **Batch interval (ms)** sets the minimum delay between emitted batches regardless of queue depth. For one batch of up to 50 entries per second, use `COUNT = 50` and `Batch interval = 1000`.
 - **Max deliveries = 5.** After the limit is exceeded, an entry is atomically moved to `<stream>:dlq` and acknowledged. In Redis Cluster, source and DLQ keys must share a hash tag, for example `orders:{eu}` and `orders:{eu}:dlq`.
 - **Start paused (wait for resume)** makes a consumer create/verify its group without calling `XREADGROUP`. It takes no work until a control-plane `resume` request arrives; use it for controlled pod startup after readiness checks.
@@ -123,6 +124,8 @@ Run `redis consumer gc` from an input message, typically a scheduled Inject node
 
 ## Example flow
 
+Import [examples/redis-streams.json](examples/redis-streams.json) from **Import → Examples** after installing the palette. It contains a self-contained `XADD → XREADGROUP → XACK` flow using `example:events`.
+
 ```
 [yroshcha-redis-config] ← shared configuration for all nodes below
 

package/examples/redis-streams.json

@@ -0,0 +1,163 @@
+[
+  {
+    "id": "redis-streams-example-tab",
+    "type": "tab",
+    "label": "Redis Streams example",
+    "disabled": false,
+    "info": "Publish an example event, consume it with a Redis consumer group, then ACK it after processing."
+  },
+  {
+    "id": "redis-streams-example-note",
+    "type": "comment",
+    "z": "redis-streams-example-tab",
+    "name": "Redis Streams: XADD → XREADGROUP → XACK",
+    "info": "Set the Redis config node to your Redis server. Click Publish example event. The consumer group is created automatically and the event is acknowledged after the processing function completes.",
+    "x": 310,
+    "y": 60,
+    "wires": []
+  },
+  {
+    "id": "redis-streams-example-config",
+    "type": "yroshcha-redis-config",
+    "name": "Local Redis",
+    "host": "127.0.0.1",
+    "port": "6379",
+    "db": "0",
+    "username": "",
+    "tls": false,
+    "cluster": false,
+    "connectTimeout": "10000",
+    "commandTimeout": "30000",
+    "retryMaxDelay": "30000"
+  },
+  {
+    "id": "redis-streams-example-inject",
+    "type": "inject",
+    "z": "redis-streams-example-tab",
+    "name": "Publish example event",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"eventType\":\"example.created\",\"event\":{\"id\":\"example-1\",\"message\":\"Hello Redis Streams\"}}",
+    "payloadType": "json",
+    "x": 160,
+    "y": 140,
+    "wires": [["redis-streams-example-out"]]
+  },
+  {
+    "id": "redis-streams-example-out",
+    "type": "yroshcha-redis-stream-out",
+    "z": "redis-streams-example-tab",
+    "name": "XADD example:events",
+    "server": "redis-streams-example-config",
+    "streamKey": "example:events",
+    "maxlen": "",
+    "approxTrim": true,
+    "unsafeTrim": false,
+    "x": 400,
+    "y": 140,
+    "wires": [["redis-streams-example-published"]]
+  },
+  {
+    "id": "redis-streams-example-published",
+    "type": "debug",
+    "z": "redis-streams-example-tab",
+    "name": "Published stream ID",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "streamId",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 650,
+    "y": 140,
+    "wires": []
+  },
+  {
+    "id": "redis-streams-example-in",
+    "type": "yroshcha-redis-stream-in",
+    "z": "redis-streams-example-tab",
+    "name": "XREADGROUP example-workers",
+    "server": "redis-streams-example-config",
+    "streamKey": "example:events",
+    "group": "example-workers",
+    "consumer": "",
+    "count": "100",
+    "blockMs": "5000",
+    "readIntervalMs": "0",
+    "rateLimitPerSecond": "0",
+    "batchWindowMs": "0",
+    "batchIntervalMs": "0",
+    "autoAck": false,
+    "startPaused": false,
+    "startId": "$",
+    "maxPending": "1000",
+    "capacityPollMs": "500",
+    "capacityCheckIntervalMs": "250",
+    "autoClaim": true,
+    "reclaimIdleMs": "60000",
+    "reclaimIntervalMs": "30000",
+    "reclaimCount": "100",
+    "maxDeliveries": "5",
+    "deadLetterStream": "",
+    "initialBackoffMs": "500",
+    "maxBackoffMs": "30000",
+    "backoffMultiplier": "2",
+    "pelAlertThreshold": "0",
+    "pelCheckIntervalMs": "30000",
+    "x": 190,
+    "y": 260,
+    "wires": [["redis-streams-example-process"]]
+  },
+  {
+    "id": "redis-streams-example-process",
+    "type": "function",
+    "z": "redis-streams-example-tab",
+    "name": "Business logic (replace me)",
+    "func": "// Do business work here.\n// ACK only after this succeeds.\nreturn msg;",
+    "outputs": 1,
+    "timeout": 0,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 445,
+    "y": 260,
+    "wires": [["redis-streams-example-ack"]]
+  },
+  {
+    "id": "redis-streams-example-ack",
+    "type": "yroshcha-redis-stream-ack",
+    "z": "redis-streams-example-tab",
+    "name": "ACK after success",
+    "server": "redis-streams-example-config",
+    "streamKey": "",
+    "group": "",
+    "deleteAfterAck": false,
+    "x": 665,
+    "y": 260,
+    "wires": [["redis-streams-example-acked"]]
+  },
+  {
+    "id": "redis-streams-example-acked",
+    "type": "debug",
+    "z": "redis-streams-example-tab",
+    "name": "ACK result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "acked",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 865,
+    "y": 260,
+    "wires": []
+  }
+]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yroshcha/node-red-contrib-redis-full",
-  "version": "1.0.7",
+  "version": "2.0.0",
   "description": "Production-oriented Redis palette for Node-RED: generic commands, Pub/Sub, scans, transactions, and Redis Streams consumer groups.",
   "keywords": ["node-red", "redis", "redis-streams", "pubsub", "xadd", "xreadgroup", "ioredis"],
   "license": "MIT",
@@ -14,12 +14,12 @@
   },
   "homepage": "https://github.com/yroshcha/node-red-contrib-redis-full#readme",
   "main": "redis.js",
-  "files": ["redis.js", "redis.html", "README.md", "CHANGELOG.md", "LICENSE", "icons"],
+  "files": ["redis.js", "redis.html", "README.md", "CHANGELOG.md", "LICENSE", "icons", "examples"],
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "peerDependencies": {
-    "node-red": ">=3 <6"
+    "node-red": ">=4 <6"
   },
   "scripts": {
     "test": "node --test test/*.test.js",
@@ -28,9 +28,10 @@
     "prepublishOnly": "npm run check"
   },
   "dependencies": {
-    "ioredis": "^5.4.1"
+    "ioredis": "^6.0.0"
   },
   "node-red": {
+    "version": ">=4.0.0 <6.0.0",
     "nodes": {
       "yroshcha-redis": "redis.js"
     }

package/redis.js

@@ -173,6 +173,22 @@ module.exports = function (RED) {
     return obj;
   }
 
+  function parseStreamFields(flat) {
+    const obj = parseFlatFields(flat);
+    for (const [field, value] of Object.entries(obj)) {
+      // redis xadd serialises nested objects and arrays to JSON. Restore only
+      // these compound JSON values; scalar strings such as "true", "42", or
+      // "null" remain strings and preserve Redis field semantics.
+      if (typeof value !== 'string' || !/^[\[{]/.test(value.trim())) continue;
+      try {
+        obj[field] = JSON.parse(value);
+      } catch (_) {
+        // A value that merely looks like JSON is still a valid Redis string.
+      }
+    }
+    return obj;
+  }
+
   function isNoGroupError(err) {
     return String(err && err.message ? err.message : err).includes('NOGROUP');
   }
@@ -868,7 +884,7 @@ module.exports = function (RED) {
       if (!Array.isArray(flat)) {
         throw new Error(`Stream entry ${id} no longer has a payload; do not trim streams below the PEL horizon`);
       }
-      const payload = parseFlatFields(flat);
+      const payload = parseStreamFields(flat);
       if (checkDeliveryCount && await shouldDeadLetter(id, payload)) return;
       if (!await waitForDeliverySlot() || paused) return false;
 
@@ -1173,7 +1189,7 @@ module.exports = function (RED) {
           const [nextCursor, entries] = res;
           cursor = nextCursor;
           for (const [id, flat] of entries || []) {
-            claimed.push({ streamId: id, payload: parseFlatFields(flat) });
+            claimed.push({ streamId: id, payload: parseStreamFields(flat) });
           }
         } while (cursor !== '0' && claimed.length < node.maxMessages);