@blokcert/node-red-contrib-delayed-job 0.1.0

package/delayed-job/delayed-job-redis.html

@@ -0,0 +1,50 @@
+<script type="text/javascript">
+  RED.nodes.registerType('delayed-job-redis', {
+    category: 'config',
+    defaults: {
+      name: { value: '' },
+      host: { value: '127.0.0.1', required: true },
+      port: { value: 6379, required: true, validate: RED.validators.number() },
+      db: { value: 0, validate: RED.validators.number() },
+      tls: { value: false },
+      queueName: { value: 'default' },
+    },
+    credentials: {
+      password: { type: 'password' },
+    },
+    label: function () {
+      return this.name || this.host + ':' + this.port + '/' + (this.queueName || 'default');
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="delayed-job-redis">
+  <div class="form-row">
+    <label for="node-config-input-name"><i class="fa fa-tag"></i> <span data-i18n="delayed-job-redis.label.name"></span></label>
+    <input type="text" id="node-config-input-name" data-i18n="[placeholder]delayed-job-redis.label.name">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-host"><i class="fa fa-server"></i> <span data-i18n="delayed-job-redis.label.host"></span></label>
+    <input type="text" id="node-config-input-host" placeholder="127.0.0.1">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-port"><i class="fa fa-plug"></i> <span data-i18n="delayed-job-redis.label.port"></span></label>
+    <input type="number" id="node-config-input-port" placeholder="6379">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-password"><i class="fa fa-lock"></i> <span data-i18n="delayed-job-redis.label.password"></span></label>
+    <input type="password" id="node-config-input-password">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-db"><i class="fa fa-database"></i> <span data-i18n="delayed-job-redis.label.db"></span></label>
+    <input type="number" id="node-config-input-db" placeholder="0">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-tls"><i class="fa fa-shield"></i> <span data-i18n="delayed-job-redis.label.tls"></span></label>
+    <input type="checkbox" id="node-config-input-tls" style="width: auto">
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-queueName"><i class="fa fa-list"></i> <span data-i18n="delayed-job-redis.label.queueName"></span></label>
+    <input type="text" id="node-config-input-queueName" placeholder="default">
+  </div>
+</script>

package/delayed-job/delayed-job-redis.js

@@ -0,0 +1,36 @@
+module.exports = function (RED) {
+  function RedisConfigNode(config) {
+    RED.nodes.createNode(this, config);
+
+    this.host = config.host || '127.0.0.1';
+    this.port = parseInt(config.port, 10) || 6379;
+    this.db = parseInt(config.db, 10) || 0;
+    this.tls = config.tls || false;
+    this.queueName = config.queueName || 'default';
+
+    const password = this.credentials.password || undefined;
+
+    this.connectionOptions = {
+      host: this.host,
+      port: this.port,
+      db: this.db,
+      password: password,
+      maxRetriesPerRequest: null,
+      enableReadyCheck: false,
+    };
+
+    if (this.tls) {
+      this.connectionOptions.tls = {};
+    }
+
+    this.on('close', function (done) {
+      done();
+    });
+  }
+
+  RED.nodes.registerType('delayed-job-redis', RedisConfigNode, {
+    credentials: {
+      password: { type: 'password' },
+    },
+  });
+};

package/delayed-job/delayed-job.html

@@ -0,0 +1,48 @@
+<script type="text/javascript">
+  RED.nodes.registerType('delayed-job', {
+    category: 'function',
+    color: '#E67E22',
+    defaults: {
+      name: { value: '' },
+      redis: { value: '', type: 'delayed-job-redis', required: true },
+      concurrency: { value: 1, validate: RED.validators.number() },
+      intervalValue: { value: 0, validate: RED.validators.number() },
+      intervalUnit: { value: 'ms' },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'delayed-job.svg',
+    paletteLabel: 'delayed job',
+    label: function () {
+      return this.name || 'delayed job';
+    },
+    labelStyle: function () {
+      return this.name ? 'node_label_italic' : '';
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="delayed-job">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="delayed-job.label.name"></span></label>
+    <input type="text" id="node-input-name" data-i18n="[placeholder]delayed-job.label.name">
+  </div>
+  <div class="form-row">
+    <label for="node-input-redis"><i class="fa fa-server"></i> <span data-i18n="delayed-job.label.redis"></span></label>
+    <input type="text" id="node-input-redis">
+  </div>
+  <div class="form-row">
+    <label for="node-input-concurrency"><i class="fa fa-tasks"></i> <span data-i18n="delayed-job.label.concurrency"></span></label>
+    <input type="number" id="node-input-concurrency" min="1" max="100" placeholder="1">
+  </div>
+  <div class="form-row">
+    <label for="node-input-intervalValue"><i class="fa fa-clock-o"></i> <span data-i18n="delayed-job.label.interval"></span></label>
+    <input type="number" id="node-input-intervalValue" min="0" placeholder="0" style="width: 100px">
+    <select id="node-input-intervalUnit" style="width: 80px">
+      <option value="ms" data-i18n="delayed-job.interval.milliseconds"></option>
+      <option value="s" data-i18n="delayed-job.interval.seconds"></option>
+      <option value="m" data-i18n="delayed-job.interval.minutes"></option>
+      <option value="h" data-i18n="delayed-job.interval.hours"></option>
+    </select>
+  </div>
+</script>

package/delayed-job/delayed-job.js

@@ -0,0 +1,191 @@
+module.exports = function (RED) {
+  const { Queue, Worker } = require('bullmq');
+
+  function DelayedJobNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    node.concurrency = parseInt(config.concurrency, 10) || 1;
+
+    // --- Rate limit (interval between jobs) ---
+    const raw = parseInt(config.intervalValue, 10);
+    const intervalValue = isNaN(raw) ? 0 : raw;
+    const intervalUnit = config.intervalUnit || 'ms';
+    const unitMultiplier = { ms: 1, s: 1000, m: 60000, h: 3600000 };
+    const intervalMs = intervalValue * (unitMultiplier[intervalUnit] || 1);
+
+    node.redisConfig = RED.nodes.getNode(config.redis);
+    if (!node.redisConfig) {
+      node.status({ fill: 'red', shape: 'ring', text: 'no redis config' });
+      node.error('No Redis configuration node selected');
+      return;
+    }
+
+    const prefix = node.redisConfig.queueName || 'default';
+    node.queueName = prefix + '-' + node.id;
+
+    const connectionOpts = node.redisConfig.connectionOptions;
+    let queue = null;
+    let worker = null;
+    let closing = false;
+
+    // --- Serialization helpers ---
+
+    function serializeMsg(msg) {
+      const clean = Object.assign({}, msg);
+      delete clean._msgid;
+      return JSON.parse(JSON.stringify(clean));
+    }
+
+    function deserializeMsg(data) {
+      return reviveBuffers(data);
+    }
+
+    function reviveBuffers(obj) {
+      if (obj === null || typeof obj !== 'object') return obj;
+      if (obj.type === 'Buffer' && Array.isArray(obj.data)) {
+        return Buffer.from(obj.data);
+      }
+      if (Array.isArray(obj)) {
+        return obj.map(reviveBuffers);
+      }
+      for (const key of Object.keys(obj)) {
+        obj[key] = reviveBuffers(obj[key]);
+      }
+      return obj;
+    }
+
+    // --- Initialize Queue (Producer) ---
+
+    try {
+      queue = new Queue(node.queueName, {
+        connection: connectionOpts,
+        defaultJobOptions: {
+          removeOnComplete: false,
+          removeOnFail: false,
+        },
+      });
+    } catch (err) {
+      node.error('Failed to create queue: ' + err.message);
+      node.status({ fill: 'red', shape: 'ring', text: 'queue init fail' });
+      return;
+    }
+
+    // --- Initialize Worker (Consumer) ---
+
+    try {
+      worker = new Worker(
+        node.queueName,
+        async (job) => {
+          if (closing) return;
+          const ttlMs = job.data._ttl;
+          if (ttlMs && Date.now() - job.timestamp > ttlMs) {
+            node.warn('Job ' + job.id + ' expired (TTL ' + (ttlMs / 1000) + 's)');
+            return;
+          }
+          const msg = deserializeMsg(job.data);
+          delete msg._ttl;
+          node.send(msg);
+        },
+        {
+          connection: connectionOpts,
+          concurrency: node.concurrency,
+          stalledInterval: 30000,
+          maxStalledCount: 2,
+          ...(intervalMs > 0 ? { limiter: { max: node.concurrency, duration: intervalMs } } : {}),
+        }
+      );
+
+      worker.on('ready', () => {
+        node.status({ fill: 'green', shape: 'dot', text: 'ready' });
+      });
+
+      worker.on('failed', (job, err) => {
+        node.warn('Job ' + (job ? job.id : '?') + ' failed: ' + err.message);
+      });
+
+      worker.on('error', (err) => {
+        node.error('Worker error: ' + err.message);
+        node.status({
+          fill: 'red',
+          shape: 'ring',
+          text: err.message.substring(0, 30),
+        });
+      });
+
+      worker.on('stalled', (jobId) => {
+        node.warn('Job stalled: ' + jobId);
+      });
+    } catch (err) {
+      node.error('Failed to create worker: ' + err.message);
+      node.status({ fill: 'red', shape: 'ring', text: 'worker init fail' });
+      return;
+    }
+
+    // --- Input Handler (Producer) ---
+
+    node.on('input', async function (msg, send, done) {
+      send = send || function () { node.send.apply(node, arguments); };
+
+      if (closing) {
+        if (done) done(new Error('Node is closing, job not queued'));
+        return;
+      }
+
+      try {
+        const ttlSec = parseInt(msg.ttl, 10) || 0;
+        const serialized = serializeMsg(msg);
+        if (ttlSec > 0) {
+          serialized._ttl = ttlSec * 1000;
+        }
+        const jobName = 'job';
+        const jobOpts = {};
+
+        const delay = parseInt(msg.delay, 10) || 0;
+        if (delay > 0) {
+          jobOpts.delay = delay;
+        }
+        if (msg.priority !== undefined) {
+          jobOpts.priority = parseInt(msg.priority, 10);
+        }
+        const keepAfterSec = parseInt(msg.keepAfter, 10) || 0;
+        if (keepAfterSec > 0) {
+          jobOpts.removeOnComplete = { age: keepAfterSec };
+          jobOpts.removeOnFail = { age: keepAfterSec };
+        }
+        await queue.add(jobName, serialized, jobOpts);
+
+        if (done) done();
+      } catch (err) {
+        if (done) {
+          done(err);
+        } else {
+          node.error(err, msg);
+        }
+      }
+    });
+
+    // --- Close Handler (Graceful Shutdown) ---
+
+    node.on('close', async function (removed, done) {
+      closing = true;
+      node.status({ fill: 'yellow', shape: 'ring', text: 'closing...' });
+
+      try {
+        if (worker) {
+          await worker.close();
+        }
+        if (queue) {
+          await queue.close();
+        }
+      } catch (err) {
+        node.error('Error during shutdown: ' + err.message);
+      }
+
+      node.status({});
+      done();
+    });
+  }
+
+  RED.nodes.registerType('delayed-job', DelayedJobNode);
+};

package/delayed-job/icons/delayed-job.svg

@@ -0,0 +1,14 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 40 40" width="40" height="40">
+  <!-- Clock face -->
+  <circle cx="18" cy="20" r="12" fill="none" stroke="#ffffff" stroke-width="2"/>
+  <!-- Clock hands - hour -->
+  <line x1="18" y1="20" x2="18" y2="13" stroke="#ffffff" stroke-width="2" stroke-linecap="round"/>
+  <!-- Clock hands - minute -->
+  <line x1="18" y1="20" x2="23" y2="17" stroke="#ffffff" stroke-width="1.5" stroke-linecap="round"/>
+  <!-- Clock center dot -->
+  <circle cx="18" cy="20" r="1.2" fill="#ffffff"/>
+  <!-- Queue lines (right side) -->
+  <line x1="32" y1="15" x2="38" y2="15" stroke="#ffffff" stroke-width="2" stroke-linecap="round"/>
+  <line x1="32" y1="20" x2="38" y2="20" stroke="#ffffff" stroke-width="2" stroke-linecap="round"/>
+  <line x1="32" y1="25" x2="38" y2="25" stroke="#ffffff" stroke-width="2" stroke-linecap="round"/>
+</svg>

package/delayed-job/locales/en-US/delayed-job-redis.json

@@ -0,0 +1,13 @@
+{
+  "delayed-job-redis": {
+    "label": {
+      "name": "Name",
+      "host": "Host",
+      "port": "Port",
+      "password": "Password",
+      "db": "DB",
+      "tls": "TLS",
+      "queueName": "Queue Name"
+    }
+  }
+}

package/delayed-job/locales/en-US/delayed-job.html

@@ -0,0 +1,48 @@
+<script type="text/html" data-help-name="delayed-job">
+  <p>A Redis-backed job queue node using BullMQ. Acts as both producer and consumer.</p>
+
+  <h3>Input</h3>
+  <p>Messages received on the input are serialized and added to the named Redis queue.
+     The following <code>msg</code> properties control job behavior:</p>
+  <ul>
+    <li><code>msg.delay</code> - Delay in milliseconds before the job is processed</li>
+    <li><code>msg.priority</code> - Job priority (lower number = higher priority)</li>
+    <li><code>msg.ttl</code> - Time-to-live in seconds. If the job is not processed within this time, it will be discarded. Default: no limit</li>
+    <li><code>msg.keepAfter</code> - Keep the job in Redis for this many seconds after completion. Default: keep forever</li>
+  </ul>
+
+  <h3>Output</h3>
+  <p>When a job is picked up by the worker, the deserialized message is sent from the output.
+     A new <code>_msgid</code> is assigned by Node-RED.</p>
+
+  <h3>Details</h3>
+  <p>This node acts as both producer and consumer:</p>
+  <ul>
+    <li><b>On input</b>: the message is serialized and queued in Redis</li>
+    <li><b>Background worker</b>: polls the queue and sends messages to the output (rate limited by Interval setting)</li>
+  </ul>
+
+  <p>Multiple Node-RED instances sharing the same Redis server and queue name
+     form a distributed worker pool. Any instance can process any job.</p>
+
+  <h3>Crash Recovery</h3>
+  <p>Jobs are persisted in Redis. If Node-RED crashes, jobs remain in the queue and
+     will be picked up when any instance restarts.</p>
+
+  <h3>Limitations</h3>
+  <p>Non-serializable properties like <code>msg.req</code> and <code>msg.res</code>
+     (from http-in nodes) cannot survive queue serialization and will be lost.</p>
+</script>
+
+<script type="text/html" data-help-name="delayed-job-redis">
+  <p>Configuration for a Redis server connection used by delayed-job nodes.</p>
+  <h3>Properties</h3>
+  <ul>
+    <li><b>Host</b> - Redis server hostname (default: 127.0.0.1)</li>
+    <li><b>Port</b> - Redis server port (default: 6379)</li>
+    <li><b>Password</b> - Redis authentication password (optional, stored encrypted)</li>
+    <li><b>DB</b> - Redis database index (default: 0)</li>
+    <li><b>TLS</b> - Enable TLS/SSL connection</li>
+    <li><b>Queue Name</b> - Name of the job queue (default: default)</li>
+  </ul>
+</script>

package/delayed-job/locales/en-US/delayed-job.json

@@ -0,0 +1,16 @@
+{
+  "delayed-job": {
+    "label": {
+      "name": "Name",
+      "redis": "Redis",
+      "concurrency": "Concurrency",
+      "interval": "Interval"
+    },
+    "interval": {
+      "milliseconds": "ms",
+      "seconds": "seconds",
+      "minutes": "minutes",
+      "hours": "hours"
+    }
+  }
+}

package/delayed-job/locales/zh-TW/delayed-job-redis.json

@@ -0,0 +1,13 @@
+{
+  "delayed-job-redis": {
+    "label": {
+      "name": "名稱",
+      "host": "主機",
+      "port": "連接埠",
+      "password": "密碼",
+      "db": "資料庫",
+      "tls": "TLS",
+      "queueName": "佇列名稱"
+    }
+  }
+}

package/delayed-job/locales/zh-TW/delayed-job.html

@@ -0,0 +1,48 @@
+<script type="text/html" data-help-name="delayed-job">
+  <p>使用 BullMQ 的 Redis 佇列節點，同時扮演生產者和消費者。</p>
+
+  <h3>輸入</h3>
+  <p>收到的訊息會被序列化後加入 Redis 佇列。
+     以下 <code>msg</code> 屬性可控制工作行為：</p>
+  <ul>
+    <li><code>msg.delay</code> - 延遲毫秒數，工作將在指定時間後才被處理</li>
+    <li><code>msg.priority</code> - 工作優先級（數字越小，優先級越高）</li>
+    <li><code>msg.ttl</code> - 存活時間（秒）。若工作在此時間內未被處理，將被丟棄。預設：不限制</li>
+    <li><code>msg.keepAfter</code> - 工作完成後在 Redis 中保留的秒數。預設：永久保留</li>
+  </ul>
+
+  <h3>輸出</h3>
+  <p>當工作被 worker 取出處理時，反序列化後的訊息會從輸出端送出。
+     Node-RED 會指派新的 <code>_msgid</code>。</p>
+
+  <h3>詳細說明</h3>
+  <p>此節點同時扮演生產者和消費者：</p>
+  <ul>
+    <li><b>收到輸入時</b>：訊息被序列化後放入 Redis 佇列</li>
+    <li><b>背景 worker</b>：從佇列取出工作並送到輸出端（受間隔設定的速率限制）</li>
+  </ul>
+
+  <p>多個 Node-RED 實體共用相同的 Redis 伺服器和佇列名稱，
+     可組成分散式工作池。任何實體都可以處理任何工作。</p>
+
+  <h3>故障恢復</h3>
+  <p>工作持久化儲存在 Redis 中。如果 Node-RED 當機，工作會留在佇列中，
+     當任何實體重新啟動時會被取出處理。</p>
+
+  <h3>限制</h3>
+  <p>無法序列化的屬性（如 http-in 節點的 <code>msg.req</code> 和 <code>msg.res</code>）
+     無法通過佇列序列化，將會遺失。</p>
+</script>
+
+<script type="text/html" data-help-name="delayed-job-redis">
+  <p>delayed-job 節點使用的 Redis 伺服器連線設定。</p>
+  <h3>屬性</h3>
+  <ul>
+    <li><b>主機</b> - Redis 伺服器主機名稱（預設：127.0.0.1）</li>
+    <li><b>連接埠</b> - Redis 伺服器連接埠（預設：6379）</li>
+    <li><b>密碼</b> - Redis 認證密碼（選填，加密儲存）</li>
+    <li><b>資料庫</b> - Redis 資料庫索引（預設：0）</li>
+    <li><b>TLS</b> - 啟用 TLS/SSL 連線</li>
+    <li><b>佇列名稱</b> - 工作佇列名稱（預設：default）</li>
+  </ul>
+</script>

package/delayed-job/locales/zh-TW/delayed-job.json

@@ -0,0 +1,16 @@
+{
+  "delayed-job": {
+    "label": {
+      "name": "名稱",
+      "redis": "Redis",
+      "concurrency": "同時處理數",
+      "interval": "間隔"
+    },
+    "interval": {
+      "milliseconds": "毫秒",
+      "seconds": "秒",
+      "minutes": "分鐘",
+      "hours": "小時"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@blokcert/node-red-contrib-delayed-job",
+  "version": "0.1.0",
+  "description": "A Node-RED node for Redis-backed delayed job queues using BullMQ",
+  "keywords": ["node-red"],
+  "author": "caspar.wei",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MingShyanWei/node-red-contrib-delayed-job.git"
+  },
+  "node-red": {
+    "version": ">=2.0.0",
+    "nodes": {
+      "delayed-job-redis": "delayed-job/delayed-job-redis.js",
+      "delayed-job": "delayed-job/delayed-job.js"
+    }
+  },
+  "dependencies": {
+    "bullmq": "^5.0.0"
+  },
+  "devDependencies": {
+    "node-red": ">=3.0.0",
+    "node-red-node-test-helper": "^0.3.0",
+    "mocha": "^10.0.0",
+    "chai": "^4.3.0"
+  },
+  "scripts": {
+    "test": "mocha --timeout 10000 test/**/*_spec.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "license": "MIT"
+}