@pauldeng/node-red-contrib-bullmq 1.0.2 → 2.0.0

package/examples/bullmq_features.json

@@ -8,7 +8,7 @@
   },
   {
     "id": "queue-bullmq-features",
-    "type": "bull-queue-server",
+    "type": "bullmq-queue-server",
     "name": "bullmq-features",
     "deployment": "single",
     "address": "localhost",
@@ -30,7 +30,11 @@
     "type": "inject",
     "z": "flow-bullmq-features",
     "name": "delay: send later",
-    "props": [{ "p": "payload" }],
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
     "repeat": "",
     "crontab": "",
     "once": false,
@@ -57,12 +61,80 @@
     "y": 100,
     "wires": [["cmd-feature-examples"]]
   },
+  {
+    "id": "inject-delay-series-example",
+    "type": "inject",
+    "z": "flow-bullmq-features",
+    "name": "delay: series of one-off jobs",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "str",
+    "x": 180,
+    "y": 140,
+    "wires": [["fn-delay-series-example"]]
+  },
+  {
+    "id": "fn-delay-series-example",
+    "type": "function",
+    "z": "flow-bullmq-features",
+    "name": "addBulk with delays",
+    "func": "msg.cmd = \"addBulk\";\nmsg.payload = [\n  { name: \"delayed-1\", data: { payload: \"first\" }, opts: { delay: 10000, removeOnComplete: true } },\n  { name: \"delayed-2\", data: { payload: \"second\" }, opts: { delay: 20000, removeOnComplete: true } },\n  { name: \"delayed-3\", data: { payload: \"third\" }, opts: { delay: 30000, removeOnComplete: true } }\n];\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 420,
+    "y": 140,
+    "wires": [["cmd-feature-examples"]]
+  },
+  {
+    "id": "inject-delay-datetime-example",
+    "type": "inject",
+    "z": "flow-bullmq-features",
+    "name": "delay: series at exact date-times",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "str",
+    "x": 190,
+    "y": 160,
+    "wires": [["fn-delay-datetime-example"]]
+  },
+  {
+    "id": "fn-delay-datetime-example",
+    "type": "function",
+    "z": "flow-bullmq-features",
+    "name": "ISO times to delays",
+    "func": "const schedule = [\n  { at: \"2030-01-01T09:00:00+11:00\", payload: \"first\" },\n  { at: \"2030-01-01T09:15:00+11:00\", payload: \"second\" },\n  { at: \"2030-01-01T09:30:00+11:00\", payload: \"third\" }\n];\nconst now = Date.now();\nmsg.cmd = \"addBulk\";\nmsg.payload = schedule.map(({ at, payload }, index) => ({\n  name: `scheduled-${index + 1}`,\n  data: { payload, scheduledFor: at },\n  opts: { delay: Math.max(0, Date.parse(at) - now), removeOnComplete: true }\n}));\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 420,
+    "y": 160,
+    "wires": [["cmd-feature-examples"]]
+  },
   {
     "id": "inject-priority-example",
     "type": "inject",
     "z": "flow-bullmq-features",
     "name": "priority: high priority",
-    "props": [{ "p": "payload" }],
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
     "repeat": "",
     "crontab": "",
     "once": false,
@@ -94,7 +166,11 @@
     "type": "inject",
     "z": "flow-bullmq-features",
     "name": "dedupe: same job once",
-    "props": [{ "p": "payload" }],
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
     "repeat": "",
     "crontab": "",
     "once": false,
@@ -126,7 +202,11 @@
     "type": "inject",
     "z": "flow-bullmq-features",
     "name": "rate limit: 2 per second",
-    "props": [{ "p": "payload" }],
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
     "repeat": "",
     "crontab": "",
     "once": false,
@@ -158,7 +238,11 @@
     "type": "inject",
     "z": "flow-bullmq-features",
     "name": "scheduler: every minute",
-    "props": [{ "p": "payload" }],
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
     "repeat": "",
     "crontab": "",
     "once": false,
@@ -174,8 +258,8 @@
     "id": "fn-scheduler-example",
     "type": "function",
     "z": "flow-bullmq-features",
-    "name": "repeat.pattern",
-    "func": "msg.cmd = \"add\";\nmsg.jobName = \"heartbeat\";\nmsg.jobopts = {\n  jobId: \"heartbeat-every-minute\",\n  repeat: { pattern: \"*/1 * * * *\" },\n  removeOnComplete: true\n};\nreturn msg;",
+    "name": "upsertJobScheduler",
+    "func": "msg.cmd = \"upsertJobScheduler\";\nmsg.schedulerId = \"heartbeat-every-minute\";\nmsg.repeat = { pattern: \"*/1 * * * *\" };\nmsg.template = {\n  name: \"heartbeat\",\n  data: { payload: msg.payload },\n  opts: { removeOnComplete: true }\n};\nreturn msg;",
     "outputs": 1,
     "noerr": 0,
     "initialize": "",
@@ -187,7 +271,7 @@
   },
   {
     "id": "cmd-feature-examples",
-    "type": "bull cmd",
+    "type": "bullmq cmd",
     "z": "flow-bullmq-features",
     "name": "send command",
     "queue": "queue-bullmq-features",
@@ -197,7 +281,7 @@
   },
   {
     "id": "run-immediate-example",
-    "type": "bull run",
+    "type": "bullmq run",
     "z": "flow-bullmq-features",
     "name": "worker: immediate complete",
     "queue": "queue-bullmq-features",
@@ -212,7 +296,7 @@
   },
   {
     "id": "run-manual-example",
-    "type": "bull run",
+    "type": "bullmq run",
     "z": "flow-bullmq-features",
     "name": "manual ack worker",
     "queue": "queue-bullmq-features",
@@ -227,7 +311,7 @@
   },
   {
     "id": "job-progress-example",
-    "type": "bull job",
+    "type": "bullmq job",
     "z": "flow-bullmq-features",
     "name": "progress 50%",
     "action": "progress",
@@ -237,7 +321,7 @@
   },
   {
     "id": "job-complete-example",
-    "type": "bull job",
+    "type": "bullmq job",
     "z": "flow-bullmq-features",
     "name": "complete job",
     "action": "complete",
@@ -245,9 +329,55 @@
     "y": 620,
     "wires": [["debug-worker-output"]]
   },
+  {
+    "id": "job-cancel-example",
+    "type": "bullmq job",
+    "z": "flow-bullmq-features",
+    "name": "cancel: stop running job",
+    "action": "cancelJob",
+    "x": 450,
+    "y": 920,
+    "wires": [["debug-worker-output"]]
+  },
+  {
+    "id": "inject-metrics-example",
+    "type": "inject",
+    "z": "flow-bullmq-features",
+    "name": "metrics: exportPrometheusMetrics",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "str",
+    "x": 200,
+    "y": 1000,
+    "wires": [["fn-metrics-example"]]
+  },
+  {
+    "id": "fn-metrics-example",
+    "type": "function",
+    "z": "flow-bullmq-features",
+    "name": "exportPrometheusMetrics",
+    "func": "msg.cmd = \"exportPrometheusMetrics\";\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 460,
+    "y": 1000,
+    "wires": [["cmd-feature-examples"]]
+  },
   {
     "id": "events-feature-example",
-    "type": "bull events",
+    "type": "bullmq events",
     "z": "flow-bullmq-features",
     "name": "events: completed failed delayed deduped",
     "queue": "queue-bullmq-features",
@@ -261,7 +391,11 @@
     "type": "inject",
     "z": "flow-bullmq-features",
     "name": "flow: parent plus child",
-    "props": [{ "p": "payload" }],
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
     "repeat": "",
     "crontab": "",
     "once": false,
@@ -275,7 +409,7 @@
   },
   {
     "id": "flow-feature-example",
-    "type": "bull flow",
+    "type": "bullmq flow",
     "z": "flow-bullmq-features",
     "name": "add parent/child flow",
     "queue": "queue-bullmq-features",
@@ -327,5 +461,73 @@
     "x": 900,
     "y": 720,
     "wires": []
+  },
+  {
+    "id": "queue-bullmq-cancel",
+    "type": "bullmq-queue-server",
+    "name": "bullmq-cancel",
+    "deployment": "single",
+    "address": "localhost",
+    "port": "6379",
+    "db": "",
+    "clusterNodes": "",
+    "sentinels": "",
+    "sentinelMasterName": "",
+    "username": "",
+    "sentinelUsername": "",
+    "tls": false,
+    "sentinelTls": false,
+    "tlsRejectUnauthorized": true,
+    "tlsServerName": "",
+    "prefix": ""
+  },
+  {
+    "id": "inject-cancel-example",
+    "type": "inject",
+    "z": "flow-bullmq-features",
+    "name": "cancel: stop running job",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "payload": "this job gets cancelled",
+    "payloadType": "str",
+    "x": 160,
+    "y": 860,
+    "wires": [["fn-cancel-example"]]
+  },
+  {
+    "id": "fn-cancel-example",
+    "type": "function",
+    "z": "flow-bullmq-features",
+    "name": "add to the cancel queue",
+    "func": "msg.cmd = \"add\";\nmsg.jobName = \"cancellable\";\nmsg.jobopts = {\n  attempts: 1,\n  removeOnFail: false\n};\nreturn msg;",
+    "x": 410,
+    "y": 860,
+    "wires": [["cmd-cancel-example"]]
+  },
+  {
+    "id": "cmd-cancel-example",
+    "type": "bullmq cmd",
+    "z": "flow-bullmq-features",
+    "name": "cmd: cancel queue",
+    "queue": "queue-bullmq-cancel",
+    "x": 680,
+    "y": 860,
+    "wires": [[]]
+  },
+  {
+    "id": "run-cancel-example",
+    "type": "bullmq run",
+    "z": "flow-bullmq-features",
+    "name": "cancellable worker",
+    "queue": "queue-bullmq-cancel",
+    "completionMode": "manual",
+    "ackTimeout": "300000",
+    "concurrency": "1",
+    "x": 180,
+    "y": 920,
+    "wires": [["job-cancel-example"]]
   }
 ]

package/examples/example_flow.json

@@ -8,7 +8,7 @@
   },
   {
     "id": "queue-basecasts",
-    "type": "bull-queue-server",
+    "type": "bullmq-queue-server",
     "name": "basecasts",
     "deployment": "single",
     "address": "localhost",
@@ -59,7 +59,7 @@
   },
   {
     "id": "cmd-simple",
-    "type": "bull cmd",
+    "type": "bullmq cmd",
     "z": "flow-basecasts",
     "name": "add simple",
     "queue": "queue-basecasts",
@@ -69,7 +69,7 @@
   },
   {
     "id": "run-immediate",
-    "type": "bull run",
+    "type": "bullmq run",
     "z": "flow-basecasts",
     "name": "run immediate",
     "queue": "queue-basecasts",
@@ -103,8 +103,8 @@
     "id": "fn-required-schedule",
     "type": "function",
     "z": "flow-basecasts",
-    "name": "add required repeat cron",
-    "func": "msg.cmd = \"add\";\nmsg.jobopts = {\n  jobId: msg.payload,\n  removeOnComplete: true,\n  repeat: {\n    cron: \"30 9,19,29,39,49,59 * * * *\"\n  }\n};\nreturn msg;",
+    "name": "upsert job scheduler",
+    "func": "msg.cmd = \"upsertJobScheduler\";\nmsg.schedulerId = msg.payload;\nmsg.repeat = {\n  pattern: \"30 9,19,29,39,49,59 * * * *\",\n  tz: \"UTC\"\n};\nmsg.template = {\n  name: \"default\",\n  data: { payload: msg.payload },\n  opts: { removeOnComplete: true }\n};\nreturn msg;",
     "outputs": 1,
     "noerr": 0,
     "initialize": "",
@@ -116,7 +116,7 @@
   },
   {
     "id": "cmd-required-schedule",
-    "type": "bull cmd",
+    "type": "bullmq cmd",
     "z": "flow-basecasts",
     "name": "upsert scheduler",
     "queue": "queue-basecasts",
@@ -158,7 +158,7 @@
   },
   {
     "id": "cmd-delayed-priority",
-    "type": "bull cmd",
+    "type": "bullmq cmd",
     "z": "flow-basecasts",
     "name": "add delayed priority",
     "queue": "queue-basecasts",
@@ -168,7 +168,7 @@
   },
   {
     "id": "events-basecasts",
-    "type": "bull events",
+    "type": "bullmq events",
     "z": "flow-basecasts",
     "name": "events",
     "queue": "queue-basecasts",
@@ -179,7 +179,7 @@
   },
   {
     "id": "run-manual",
-    "type": "bull run",
+    "type": "bullmq run",
     "z": "flow-basecasts",
     "name": "run manual",
     "queue": "queue-basecasts",
@@ -194,7 +194,7 @@
   },
   {
     "id": "job-complete",
-    "type": "bull job",
+    "type": "bullmq job",
     "z": "flow-basecasts",
     "name": "complete manual job",
     "action": "complete",
@@ -221,7 +221,7 @@
   },
   {
     "id": "flow-producer",
-    "type": "bull flow",
+    "type": "bullmq flow",
     "z": "flow-basecasts",
     "name": "add flow",
     "queue": "queue-basecasts",

package/examples/postgres_backend.json

@@ -0,0 +1,149 @@
+[
+  {
+    "id": "flow-postgres-backend",
+    "type": "tab",
+    "label": "PostgreSQL backend",
+    "disabled": false,
+    "info": ""
+  },
+  {
+    "id": "queue-postgres-backend",
+    "type": "bullmq-queue-server",
+    "name": "pgcasts",
+    "backend": "postgres",
+    "address": "localhost",
+    "port": "5432",
+    "database": "bullmq",
+    "username": "bullmq",
+    "schema": "",
+    "max": "",
+    "migrate": true,
+    "tls": false,
+    "tlsRejectUnauthorized": true,
+    "tlsServerName": "",
+    "removeOnComplete": "1000",
+    "removeOnFail": "5000",
+    "deployment": "single",
+    "db": "",
+    "clusterNodes": "",
+    "sentinels": "",
+    "sentinelMasterName": "",
+    "sentinelUsername": "",
+    "sentinelTls": false,
+    "prefix": "",
+    "telemetry": false,
+    "telemetryServiceName": "",
+    "telemetryMetrics": false
+  },
+  {
+    "id": "inject-postgres-add",
+    "type": "inject",
+    "z": "flow-postgres-backend",
+    "name": "postgres: add a job",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "order-1",
+    "payloadType": "str",
+    "x": 180,
+    "y": 120,
+    "wires": [["fn-postgres-add"]]
+  },
+  {
+    "id": "fn-postgres-add",
+    "type": "function",
+    "z": "flow-postgres-backend",
+    "name": "add order job",
+    "func": "// Nothing here is PostgreSQL-specific: the same msg.cmd values, job options\n// and worker messages work on either backend. Only the queue config node\n// differs, which is the point of this example.\nmsg.cmd = \"add\";\nmsg.payload = { orderId: msg.payload || \"order-1\", stage: \"received\" };\nmsg.jobopts = { removeOnComplete: 1000, removeOnFail: 5000 };\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 420,
+    "y": 120,
+    "wires": [["cmd-postgres-backend"]]
+  },
+  {
+    "id": "cmd-postgres-backend",
+    "type": "bullmq cmd",
+    "z": "flow-postgres-backend",
+    "name": "queue command",
+    "queue": "queue-postgres-backend",
+    "x": 680,
+    "y": 120,
+    "wires": [["debug-postgres-command"]]
+  },
+  {
+    "id": "debug-postgres-command",
+    "type": "debug",
+    "z": "flow-postgres-backend",
+    "name": "command output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 900,
+    "y": 120,
+    "wires": []
+  },
+  {
+    "id": "run-postgres-backend",
+    "type": "bullmq run",
+    "z": "flow-postgres-backend",
+    "name": "order worker",
+    "queue": "queue-postgres-backend",
+    "completionMode": "immediate",
+    "ackTimeout": 300000,
+    "concurrency": 1,
+    "maxStartedAttempts": 100,
+    "limiterMax": "",
+    "limiterDuration": "",
+    "x": 180,
+    "y": 260,
+    "wires": [["fn-postgres-worker"]]
+  },
+  {
+    "id": "fn-postgres-worker",
+    "type": "function",
+    "z": "flow-postgres-backend",
+    "name": "handle order",
+    "func": "// The worker receives the job's data as msg.payload, exactly as it does on\n// Redis.\nmsg.topic = msg.payload.stage;\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 420,
+    "y": 260,
+    "wires": [["debug-postgres-worker"]]
+  },
+  {
+    "id": "debug-postgres-worker",
+    "type": "debug",
+    "z": "flow-postgres-backend",
+    "name": "processed order",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": true,
+    "complete": "payload",
+    "targetType": "msg",
+    "statusVal": "topic",
+    "statusType": "msg",
+    "x": 660,
+    "y": 260,
+    "wires": []
+  }
+]