node-red-contrib-qrusty 0.19.20 → 0.20.0

package/qrusty-consume.js

@@ -1,9 +1,38 @@
-// Function node for consuming from qrusty
-msg.url = "http://queue-server:6784/consume/" + (msg.queue || "default_queue");
-msg.method = "POST";
-msg.payload = {
-  consumer_id: msg.consumer_id || "node-red-consumer",
-  timeout_seconds: msg.timeout_seconds || 30,
+// qrusty-consume.js
+//
+// Pops (consumes) one message from a Qrusty queue.  The returned message
+// is placed in msg.payload, or null if the queue is empty.
+//
+// This is a request/response-style node: trigger it with any input msg
+// and it performs exactly one consume call, returning immediately.
+
+const {
+  setupActionNode,
+  fromConfigOrMsg,
+  toNumberOrUndefined,
+} = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyConsumeNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client, msg) => {
+      const queue = fromConfigOrMsg(n.queue, msg.queue);
+      if (!queue) {
+        throw new Error("queue is required (set on the node or via msg.queue)");
+      }
+      const consumerId =
+        fromConfigOrMsg(n.consumerId, msg.consumer_id) || "node-red-consumer";
+      const timeoutSeconds =
+        toNumberOrUndefined(
+          fromConfigOrMsg(n.timeoutSeconds, msg.timeout_seconds),
+        ) ?? 30;
+
+      return await client.consume(queue, consumerId, timeoutSeconds);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-consume", QrustyConsumeNode);
 };
-msg.headers = { "Content-Type": "application/json" };
-return msg;

package/qrusty-create-queue.html

@@ -0,0 +1,82 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-create-queue", {
+    category: "qrusty",
+    color: "#9acfe6",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+      ordering: { value: "MaxFirst" },
+      priorityKind: { value: "Numeric" },
+      allowDuplicates: { value: "true" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-plus-square",
+    label: function () {
+      return this.name || "qrusty create-queue";
+    },
+    paletteLabel: "create-queue",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-create-queue">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-queue"><i class="fa fa-list"></i> Queue</label>
+    <input
+      type="text"
+      id="node-input-queue"
+      placeholder="leave blank to use msg.queue"
+    />
+  </div>
+  <div class="form-row">
+    <label for="node-input-ordering"
+      ><i class="fa fa-sort"></i> Ordering</label
+    >
+    <select id="node-input-ordering">
+      <option value="MaxFirst">MaxFirst</option>
+      <option value="MinFirst">MinFirst</option>
+      <option value="Fifo">Fifo</option>
+    </select>
+  </div>
+  <div class="form-row">
+    <label for="node-input-priorityKind"
+      ><i class="fa fa-list-ol"></i> Priority kind</label
+    >
+    <select id="node-input-priorityKind">
+      <option value="Numeric">Numeric</option>
+      <option value="Text">Text</option>
+    </select>
+  </div>
+  <div class="form-row">
+    <label for="node-input-allowDuplicates"
+      ><i class="fa fa-clone"></i> Duplicates</label
+    >
+    <select id="node-input-allowDuplicates">
+      <option value="true">Allowed</option>
+      <option value="false">Blocked</option>
+    </select>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-create-queue">
+  <p>Creates a new Qrusty queue.  Throws if the queue already exists.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Name for the new queue (when the Queue field is blank).</dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd><code>{ ok: true, name: "&lt;queue&gt;" }</code> on success.</dd>
+  </dl>
+</script>

package/qrusty-create-queue.js

@@ -1,14 +1,40 @@
-// Function node for creating a queue in qrusty
-msg.url = "http://queue-server:6784/create-queue";
-msg.method = "POST";
-msg.payload = {
-  name: msg.queue || "my_queue",
-  config: {
-    ordering: msg.ordering || "MaxFirst",
-    allow_duplicates:
-      msg.allow_duplicates !== undefined ? msg.allow_duplicates : true,
-    priority_kind: msg.priority_kind || "Numeric",
-  },
+// qrusty-create-queue.js
+//
+// Creates a new queue on the Qrusty server.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyCreateQueueNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client, msg) => {
+      const queue = fromConfigOrMsg(n.queue, msg.queue);
+      if (!queue) throw new Error("queue name is required");
+
+      const ordering = fromConfigOrMsg(n.ordering, msg.ordering) || "MaxFirst";
+      const priorityKind =
+        fromConfigOrMsg(n.priorityKind, msg.priority_kind) || "Numeric";
+
+      // allowDuplicates is a boolean; treat config "true"/"false" strings
+      // as their boolean equivalents.  Default is true.
+      let allowDuplicates;
+      if (n.allowDuplicates === "false" || n.allowDuplicates === false) {
+        allowDuplicates = false;
+      } else if (n.allowDuplicates === "true" || n.allowDuplicates === true) {
+        allowDuplicates = true;
+      } else if (typeof msg.allow_duplicates === "boolean") {
+        allowDuplicates = msg.allow_duplicates;
+      } else {
+        allowDuplicates = true;
+      }
+
+      await client.createQueue(queue, ordering, allowDuplicates, priorityKind);
+      return { ok: true, name: queue };
+    });
+  }
+
+  RED.nodes.registerType("qrusty-create-queue", QrustyCreateQueueNode);
 };
-msg.headers = { "Content-Type": "application/json" };
-return msg;

package/qrusty-delete-all.html

@@ -0,0 +1,38 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-delete-all", {
+    category: "qrusty",
+    color: "#e99999",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-trash-o",
+    label: function () {
+      return this.name || "qrusty delete-all";
+    },
+    paletteLabel: "delete-all",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-delete-all">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-delete-all">
+  <p>Deletes every queue on the server and all of their messages.</p>
+  <p><b>Warning:</b> this is irreversible.</p>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>Server response.</dd>
+  </dl>
+</script>

package/qrusty-delete-all.js

@@ -1,5 +1,19 @@
-// Function node for deleting all queues and their messages in qrusty
-msg.url = "http://queue-server:6784/delete-all";
-msg.method = "POST";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-delete-all.js
+//
+// Deletes every queue on the server (and all their messages).
+
+const { setupActionNode } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyDeleteAllNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client /*, msg */) => {
+      return await client.deleteAll();
+    });
+  }
+
+  RED.nodes.registerType("qrusty-delete-all", QrustyDeleteAllNode);
+};

package/qrusty-delete-queue.html

@@ -0,0 +1,51 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-delete-queue", {
+    category: "qrusty",
+    color: "#e99999",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-trash",
+    label: function () {
+      return this.name || "qrusty delete-queue";
+    },
+    paletteLabel: "delete-queue",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-delete-queue">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-queue"><i class="fa fa-list"></i> Queue</label>
+    <input
+      type="text"
+      id="node-input-queue"
+      placeholder="leave blank to use msg.queue"
+    />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-delete-queue">
+  <p>Deletes a Qrusty queue and all of its messages.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Queue to delete (when the Queue field is blank).</dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>Server response.</dd>
+  </dl>
+</script>

package/qrusty-delete-queue.js

@@ -1,5 +1,21 @@
-// Function node for deleting a queue in qrusty
-msg.url = "http://queue-server:6784/delete-queue/" + (msg.queue || "my_queue");
-msg.method = "DELETE";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-delete-queue.js
+//
+// Deletes a queue and all of its messages.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyDeleteQueueNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client, msg) => {
+      const queue = fromConfigOrMsg(n.queue, msg.queue);
+      if (!queue) throw new Error("queue name is required");
+      return await client.deleteQueue(queue);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-delete-queue", QrustyDeleteQueueNode);
+};

package/qrusty-health.html

@@ -0,0 +1,37 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-health", {
+    category: "qrusty",
+    color: "#b9d18c",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-heartbeat",
+    label: function () {
+      return this.name || "qrusty health";
+    },
+    paletteLabel: "health",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-health">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-health">
+  <p>Checks the Qrusty server's <code>/health</code> endpoint.</p>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>The health payload, usually <code>{ status: "ok" }</code>.</dd>
+  </dl>
+</script>

package/qrusty-health.js

@@ -1,5 +1,19 @@
-// Function node for checking qrusty server health
-msg.url = "http://queue-server:6784/health";
-msg.method = "GET";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-health.js
+//
+// Checks the Qrusty server's /health endpoint.
+
+const { setupActionNode } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyHealthNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client /*, msg */) => {
+      return await client.health();
+    });
+  }
+
+  RED.nodes.registerType("qrusty-health", QrustyHealthNode);
+};

package/qrusty-list-queues.html

@@ -0,0 +1,37 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-list-queues", {
+    category: "qrusty",
+    color: "#b9d18c",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-list-alt",
+    label: function () {
+      return this.name || "qrusty list-queues";
+    },
+    paletteLabel: "list-queues",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-list-queues">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-list-queues">
+  <p>Returns the list of queues that exist on the server.</p>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">string[]</span></dt>
+    <dd>Array of queue names.</dd>
+  </dl>
+</script>

package/qrusty-list-queues.js

@@ -1,5 +1,19 @@
-// Function node for listing all queues in qrusty
-msg.url = "http://queue-server:6784/queues";
-msg.method = "GET";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-list-queues.js
+//
+// Lists every queue on the server.
+
+const { setupActionNode } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyListQueuesNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client /*, msg */) => {
+      return await client.listQueues();
+    });
+  }
+
+  RED.nodes.registerType("qrusty-list-queues", QrustyListQueuesNode);
+};

package/qrusty-nack-batch.html

@@ -0,0 +1,67 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-nack-batch", {
+    category: "qrusty",
+    color: "#d78a4e",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+      consumerId: { value: "" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-times-circle",
+    label: function () {
+      return this.name || "qrusty nack batch";
+    },
+    paletteLabel: "nack batch",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-nack-batch">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-queue"><i class="fa fa-list"></i> Queue</label>
+    <input
+      type="text"
+      id="node-input-queue"
+      placeholder="leave blank to use msg.queue"
+    />
+  </div>
+  <div class="form-row">
+    <label for="node-input-consumerId"
+      ><i class="fa fa-user"></i> Consumer ID</label
+    >
+    <input
+      type="text"
+      id="node-input-consumerId"
+      placeholder="default node-red-consumer"
+    />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-nack-batch">
+  <p>Negatively acknowledges multiple messages at once.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>messageIds <span class="property-type">string[]</span></dt>
+    <dd>
+      The ids to nack.  Supplied via <code>msg.messageIds</code>,
+      <code>msg.message_ids</code>, or <code>msg.payload</code>.
+    </dd>
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Queue holding the messages.</dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>Server response with counts of nacked / not-found ids.</dd>
+  </dl>
+</script>

package/qrusty-nack-batch.js

@@ -1,10 +1,38 @@
-// Function node for batch-negative-acknowledging messages in qrusty
-msg.url =
-  "http://queue-server:6784/nack-batch/" + (msg.queue || "default_queue");
-msg.method = "POST";
-msg.payload = {
-  consumer_id: msg.consumer_id || "node-red-consumer",
-  message_ids: msg.messageIds || [],
+// qrusty-nack-batch.js
+//
+// Batch-negative-acknowledges multiple messages in one HTTP round trip.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyNackBatchNode(n) {
+    RED.nodes.createNode(this, n);
+    const node = this;
+    const server = RED.nodes.getNode(n.server);
+
+    setupActionNode(node, server, async (client, msg) => {
+      const queue = fromConfigOrMsg(n.queue, msg.queue);
+      if (!queue) throw new Error("queue is required");
+
+      const ids = Array.isArray(msg.messageIds)
+        ? msg.messageIds
+        : Array.isArray(msg.message_ids)
+          ? msg.message_ids
+          : Array.isArray(msg.payload)
+            ? msg.payload
+            : null;
+      if (!ids || ids.length === 0) {
+        throw new Error(
+          "messageIds array is required (set msg.messageIds, msg.message_ids, or msg.payload)",
+        );
+      }
+
+      const consumerId =
+        fromConfigOrMsg(n.consumerId, msg.consumer_id) || "node-red-consumer";
+
+      return await client.nackBatch(queue, consumerId, ids);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-nack-batch", QrustyNackBatchNode);
 };
-msg.headers = { "Content-Type": "application/json" };
-return msg;

package/qrusty-nack.html

@@ -0,0 +1,66 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-nack", {
+    category: "qrusty",
+    color: "#d78a4e",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+      consumerId: { value: "" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-times",
+    label: function () {
+      return this.name || "qrusty nack";
+    },
+    paletteLabel: "nack",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-nack">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-server"><i class="fa fa-server"></i> Server</label>
+    <input type="text" id="node-input-server" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-queue"><i class="fa fa-list"></i> Queue</label>
+    <input
+      type="text"
+      id="node-input-queue"
+      placeholder="leave blank to use msg.queue"
+    />
+  </div>
+  <div class="form-row">
+    <label for="node-input-consumerId"
+      ><i class="fa fa-user"></i> Consumer ID</label
+    >
+    <input
+      type="text"
+      id="node-input-consumerId"
+      placeholder="default node-red-consumer"
+    />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-nack">
+  <p>Negatively acknowledges a Qrusty message so it is retried or dead-lettered.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>messageId / id <span class="property-type">string</span></dt>
+    <dd>The id of the message to nack.</dd>
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Queue holding the message.</dd>
+    <dt class="optional">consumer_id <span class="property-type">string</span></dt>
+    <dd>Consumer identity that originally locked the message.</dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">boolean</span></dt>
+    <dd><code>true</code> on success, <code>false</code> if the server returned 404.</dd>
+  </dl>
+</script>