node-red-contrib-qrusty 0.19.20 → 0.20.1

package/qrusty-nack.js

@@ -1,12 +1,32 @@
-// Function node for negative-acknowledging a message in qrusty
-msg.url =
-  "http://queue-server:6784/nack/" +
-  (msg.queue || "default_queue") +
-  "/" +
-  msg.messageId;
-msg.method = "POST";
-msg.payload = {
-  consumer_id: msg.consumer_id || "node-red-consumer",
+// qrusty-nack.js
+//
+// Negatively acknowledges a previously-consumed message.  msg.payload
+// becomes `true` on success or `false` if the server returned 404.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyNackNode(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 messageId = fromConfigOrMsg(
+        undefined,
+        msg.messageId ?? msg.id ?? msg.message_id,
+      );
+      if (!messageId) {
+        throw new Error("messageId is required (set msg.messageId or msg.id)");
+      }
+      const consumerId =
+        fromConfigOrMsg(n.consumerId, msg.consumer_id) || "node-red-consumer";
+
+      return await client.nack(queue, messageId, consumerId);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-nack", QrustyNackNode);
 };
-msg.headers = { "Content-Type": "application/json" };
-return msg;

package/qrusty-publish.html

@@ -0,0 +1,92 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-publish", {
+    category: "qrusty",
+    color: "#d78a4e",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+      priority: { value: "" },
+      maxRetries: { value: "" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-paper-plane",
+    label: function () {
+      return this.name || "qrusty publish";
+    },
+    paletteLabel: "publish",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-publish">
+  <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-priority"
+      ><i class="fa fa-sort-numeric-desc"></i> Priority</label
+    >
+    <input
+      type="number"
+      id="node-input-priority"
+      placeholder="default 0 or msg.priority"
+    />
+  </div>
+  <div class="form-row">
+    <label for="node-input-maxRetries"
+      ><i class="fa fa-refresh"></i> Max retries</label
+    >
+    <input
+      type="number"
+      id="node-input-maxRetries"
+      placeholder="default 3 or msg.max_retries"
+    />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-publish">
+  <p>Publishes <code>msg.payload</code> to a Qrusty queue.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">any</span></dt>
+    <dd>
+      The message body.  Non-string payloads are automatically
+      JSON-stringified by the client.
+    </dd>
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>
+      Target queue name.  Used when the node's <b>Queue</b> field is blank.
+    </dd>
+    <dt class="optional">priority <span class="property-type">number</span></dt>
+    <dd>
+      Message priority.  Used when the node's <b>Priority</b> field is blank.
+    </dd>
+    <dt class="optional">max_retries <span class="property-type">number</span></dt>
+    <dd>
+      Retry ceiling before the message moves to the DLQ.  Used when the
+      node's <b>Max retries</b> field is blank.
+    </dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>
+      The server response: <code>{ id: "&lt;uuid&gt;" }</code> for the
+      newly-published message.
+    </dd>
+  </dl>
+</script>

package/qrusty-publish.js

@@ -1,11 +1,38 @@
-// Function node for publishing to qrusty
-msg.url = "http://queue-server:6784/publish";
-msg.method = "POST";
-msg.payload = {
-  queue: "my_queue",
-  priority: msg.priority || 1000,
-  payload: JSON.stringify(msg.payload),
-  max_retries: 3,
+// qrusty-publish.js
+//
+// Publishes `msg.payload` to a Qrusty queue.
+//
+// The queue, priority, and max_retries can be set in the node config
+// (takes precedence) or via `msg.queue` / `msg.priority` / `msg.max_retries`.
+// The resulting message id from the server is written back to
+// `msg.payload = { id: "..." }`.
+
+const {
+  setupActionNode,
+  fromConfigOrMsg,
+  toNumberOrUndefined,
+} = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyPublishNode(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 priority =
+        toNumberOrUndefined(fromConfigOrMsg(n.priority, msg.priority)) ?? 0;
+      const maxRetries =
+        toNumberOrUndefined(fromConfigOrMsg(n.maxRetries, msg.max_retries)) ??
+        3;
+
+      return await client.publish(queue, priority, msg.payload, maxRetries);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-publish", QrustyPublishNode);
 };
-msg.headers = { "Content-Type": "application/json" };
-return msg;

package/qrusty-purge-all.html

@@ -0,0 +1,41 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-purge-all", {
+    category: "qrusty",
+    color: "#e99999",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-eraser",
+    label: function () {
+      return this.name || "qrusty purge-all";
+    },
+    paletteLabel: "purge-all",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-purge-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-purge-all">
+  <p>Purges every message from every queue on the server.</p>
+  <p>
+    The queues themselves are not deleted &mdash; use
+    <code>qrusty-delete-all</code> for that.
+  </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-purge-all.js

@@ -1,5 +1,19 @@
-// Function node for purging all messages from all queues in qrusty
-msg.url = "http://queue-server:6784/purge-all";
-msg.method = "POST";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-purge-all.js
+//
+// Purges every queue on the server (but leaves them in place).
+
+const { setupActionNode } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyPurgeAllNode(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.purgeAll();
+    });
+  }
+
+  RED.nodes.registerType("qrusty-purge-all", QrustyPurgeAllNode);
+};

package/qrusty-purge-queue.html

@@ -0,0 +1,51 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-purge-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-eraser",
+    label: function () {
+      return this.name || "qrusty purge-queue";
+    },
+    paletteLabel: "purge-queue",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-purge-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-purge-queue">
+  <p>Removes every message from a queue, leaving the queue itself in place.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Queue to purge (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-purge-queue.js

@@ -1,5 +1,21 @@
-// Function node for purging all messages from a queue in qrusty
-msg.url = "http://queue-server:6784/purge-queue/" + (msg.queue || "my_queue");
-msg.method = "POST";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-purge-queue.js
+//
+// Removes all messages from a queue without deleting the queue itself.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyPurgeQueueNode(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.purge(queue);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-purge-queue", QrustyPurgeQueueNode);
+};

package/qrusty-queue-metrics.html

@@ -0,0 +1,51 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-queue-metrics", {
+    category: "qrusty",
+    color: "#b9d18c",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-line-chart",
+    label: function () {
+      return this.name || "qrusty queue-metrics";
+    },
+    paletteLabel: "queue-metrics",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-queue-metrics">
+  <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-queue-metrics">
+  <p>Fetches time-series metrics (per-second buckets) for a queue.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Queue to inspect.</dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>The time-series metrics payload (pub/ack/nack counts per second).</dd>
+  </dl>
+</script>

package/qrusty-queue-metrics.js

@@ -1,6 +1,21 @@
-// Function node for getting time-series metrics for a queue in qrusty
-msg.url =
-  "http://queue-server:6784/queues/" + (msg.queue || "my_queue") + "/metrics";
-msg.method = "GET";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-queue-metrics.js
+//
+// Fetches time-series metrics (per-second buckets) for a queue.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyQueueMetricsNode(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");
+      return await client.queueMetrics(queue);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-queue-metrics", QrustyQueueMetricsNode);
+};

package/qrusty-queue-stats.html

@@ -0,0 +1,51 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-queue-stats", {
+    category: "qrusty",
+    color: "#b9d18c",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+      queue: { value: "" },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-bar-chart",
+    label: function () {
+      return this.name || "qrusty queue-stats";
+    },
+    paletteLabel: "queue-stats",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-queue-stats">
+  <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-queue-stats">
+  <p>Fetches detailed statistics for a single queue.</p>
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt class="optional">queue <span class="property-type">string</span></dt>
+    <dd>Queue to inspect.</dd>
+  </dl>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd>The per-queue stats object (counts, rates, config).</dd>
+  </dl>
+</script>

package/qrusty-queue-stats.js

@@ -1,5 +1,21 @@
-// Function node for getting stats for a specific queue in qrusty
-msg.url = "http://queue-server:6784/queue-stats/" + (msg.queue || "my_queue");
-msg.method = "GET";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-queue-stats.js
+//
+// Fetches detailed stats for one specific queue.
+
+const { setupActionNode, fromConfigOrMsg } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyQueueStatsNode(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");
+      return await client.queueStats(queue);
+    });
+  }
+
+  RED.nodes.registerType("qrusty-queue-stats", QrustyQueueStatsNode);
+};

package/qrusty-server.html

@@ -0,0 +1,64 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-server", {
+    category: "config",
+    defaults: {
+      name: { value: "" },
+      host: { value: "localhost", required: true },
+      port: {
+        value: 6784,
+        required: true,
+        validate: RED.validators.number(),
+      },
+      useHttps: { value: false },
+    },
+    label: function () {
+      return this.name || this.host + ":" + this.port;
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-server">
+  <div class="form-row">
+    <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-config-input-name" placeholder="optional" />
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-host"><i class="fa fa-server"></i> Host</label>
+    <input type="text" id="node-config-input-host" placeholder="localhost" />
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-port"><i class="fa fa-sign-in"></i> Port</label>
+    <input type="number" id="node-config-input-port" placeholder="6784" />
+  </div>
+  <div class="form-row">
+    <label for="node-config-input-useHttps"><i class="fa fa-lock"></i> HTTPS</label>
+    <input
+      type="checkbox"
+      id="node-config-input-useHttps"
+      style="display: inline-block; width: auto; vertical-align: top;"
+    />
+    <span>&nbsp;Use <code>https://</code> instead of <code>http://</code></span>
+  </div>
+</script>
+
+<script type="text/html" data-help-name="qrusty-server">
+  <p>Connection details for a Qrusty priority queue server.</p>
+  <p>
+    Action nodes reference an instance of this config node and read its
+    <code>baseUrl</code> at runtime, so you can switch between environments
+    (dev / staging / prod) by swapping the config node rather than editing
+    every action node.
+  </p>
+  <h3>Fields</h3>
+  <dl class="message-properties">
+    <dt>Host <span class="property-type">string</span></dt>
+    <dd>Hostname or IP of the Qrusty server (e.g. <code>localhost</code>).</dd>
+    <dt>Port <span class="property-type">number</span></dt>
+    <dd>TCP port, typically <code>6784</code>.</dd>
+    <dt>HTTPS <span class="property-type">boolean</span></dt>
+    <dd>
+      When checked, the computed <code>baseUrl</code> uses
+      <code>https://</code>; otherwise <code>http://</code>.
+    </dd>
+  </dl>
+</script>

package/qrusty-server.js

@@ -0,0 +1,20 @@
+// qrusty-server.js
+//
+// Config node that holds the connection details for a Qrusty server.
+// Action nodes (qrusty-publish, qrusty-consume, etc.) reference a
+// qrusty-server instance and read `baseUrl` from it at runtime.
+
+module.exports = function (RED) {
+  function QrustyServerNode(n) {
+    RED.nodes.createNode(this, n);
+    this.name = n.name || "";
+    this.host = n.host || "localhost";
+    this.port = parseInt(n.port, 10) || 6784;
+    this.useHttps = !!n.useHttps;
+
+    const scheme = this.useHttps ? "https" : "http";
+    this.baseUrl = `${scheme}://${this.host}:${this.port}`;
+  }
+
+  RED.nodes.registerType("qrusty-server", QrustyServerNode);
+};

package/qrusty-stats.html

@@ -0,0 +1,37 @@
+<script type="text/javascript">
+  RED.nodes.registerType("qrusty-stats", {
+    category: "qrusty",
+    color: "#b9d18c",
+    defaults: {
+      name: { value: "" },
+      server: { value: "", type: "qrusty-server", required: true },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-bar-chart",
+    label: function () {
+      return this.name || "qrusty stats";
+    },
+    paletteLabel: "stats",
+  });
+</script>
+
+<script type="text/html" data-template-name="qrusty-stats">
+  <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-stats">
+  <p>Fetches aggregate stats for every queue on the server.</p>
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">object</span></dt>
+    <dd><code>{ queues: [...] }</code> with per-queue counts and rates.</dd>
+  </dl>
+</script>

package/qrusty-stats.js

@@ -1,5 +1,19 @@
-// Function node for getting stats for all queues in qrusty
-msg.url = "http://queue-server:6784/stats";
-msg.method = "GET";
-msg.headers = { "Content-Type": "application/json" };
-return msg;
+// qrusty-stats.js
+//
+// Fetches aggregate stats for every queue on the server.
+
+const { setupActionNode } = require("./lib/common");
+
+module.exports = function (RED) {
+  function QrustyStatsNode(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.stats();
+    });
+  }
+
+  RED.nodes.registerType("qrusty-stats", QrustyStatsNode);
+};