node-red-contrib-aedes 0.15.1 → 1.2.0

package/locales/de/aedes.html

@@ -0,0 +1,110 @@
+<script type="text/x-red" data-help-name="aedes broker">
+    <p>Ein eingebetteter MQTT-Broker basierend auf <a href="https://github.com/moscajs/aedes">Aedes</a>.
+    Ermöglicht MQTT-in- und MQTT-out-Nodes die Kommunikation ohne einen externen Broker wie Mosquitto.</p>
+
+    <h3>Ausgänge</h3>
+    <ol class="node-ports">
+        <li>Ereignisse
+            <dl class="message-properties">
+                <dt>topic <span class="property-type">string</span></dt>
+                <dd>Der Name des Ereignisses (siehe Tabelle unten).</dd>
+                <dt>payload <span class="property-type">object</span></dt>
+                <dd>Ereignisspezifische Daten mit Client-Informationen und ggf. Fehler- oder Abonnement-Details.</dd>
+            </dl>
+        </li>
+        <li>Publish
+            <dl class="message-properties">
+                <dt>topic <span class="property-type">string</span></dt>
+                <dd>immer <code>"publish"</code>.</dd>
+                <dt>payload.packet <span class="property-type">object</span></dt>
+                <dd>Das MQTT-Paket mit den Eigenschaften <code>topic</code>, <code>payload</code>, <code>qos</code> und <code>retain</code>.</dd>
+                <dt>payload.client <span class="property-type">object | null</span></dt>
+                <dd>Der Client, der die Nachricht gesendet hat, oder <code>null</code> bei Broker-eigenen Nachrichten.</dd>
+            </dl>
+        </li>
+    </ol>
+    <p><strong>Hinweis:</strong> Der Publish-Ausgang ist nur aktiv, wenn er mit einem anderen Node verbunden ist.
+    Dies vermeidet unnötige Verarbeitung, wenn Publish-Nachrichten nicht benötigt werden.</p>
+
+    <h3>Details</h3>
+    <p>Dieser Node startet einen MQTT-Broker innerhalb des Node-RED-Prozesses. MQTT-Clients,
+    einschließlich der integrierten MQTT-in- und MQTT-out-Nodes, können sich über den
+    konfigurierten Port (Standard <code>1883</code>) verbinden.</p>
+
+    <h4>Verbindung</h4>
+    <p>Konfigurieren Sie den MQTT-TCP-Port und den optionalen WebSocket-Zugang. WebSocket-Verbindungen
+    können auf zwei Arten bereitgestellt werden:</p>
+    <ul>
+        <li><b>Port</b> &ndash; ein eigenständiger WebSocket-Server auf einem separaten Port.</li>
+        <li><b>Pfad</b> &ndash; nutzt den Node-RED-HTTP-Server unter einem URL-Pfad
+        (relativ zu <code>httpNodeRoot</code>).</li>
+    </ul>
+    <p>Aktivieren Sie <i>SSL/TLS</i> um Verbindungen abzusichern. Zertifikate können
+    direkt hochgeladen oder als lokale Dateipfade auf dem Server angegeben werden.</p>
+
+    <h4>Persistenz</h4>
+    <p>Standardmäßig werden Nachrichten und Abonnements im Speicher gehalten und gehen
+    bei einem Neustart verloren. Wählen Sie <i>MongoDB</i> um Daten über Neustarts
+    hinweg zu persistieren.</p>
+
+    <h4>Sicherheit</h4>
+    <p>Legen Sie einen Benutzernamen und ein Passwort fest, um eine Client-Authentifizierung
+    zu erzwingen. Lassen Sie beide Felder leer, um anonyme Verbindungen zu erlauben.
+    Es wird nur ein einzelnes Zugangsdatenpaar unterstützt.</p>
+
+    <h4>Ereignis-Topics</h4>
+    <p>Der erste Ausgang sendet folgende Ereignisse:</p>
+    <table>
+        <thead>
+            <tr><th>Topic</th><th>Payload</th><th>Beschreibung</th></tr>
+        </thead>
+        <tbody>
+            <tr>
+                <td><code>client</code></td>
+                <td><code>{ client }</code></td>
+                <td>Ein neuer Client hat sich verbunden (vor der Authentifizierung).</td>
+            </tr>
+            <tr>
+                <td><code>clientReady</code></td>
+                <td><code>{ client }</code></td>
+                <td>Ein Client hat sich verbunden, ist authentifiziert und bereit.</td>
+            </tr>
+            <tr>
+                <td><code>clientDisconnect</code></td>
+                <td><code>{ client }</code></td>
+                <td>Ein Client hat sich ordnungsgemäß getrennt.</td>
+            </tr>
+            <tr>
+                <td><code>clientError</code></td>
+                <td><code>{ client, err }</code></td>
+                <td>Bei einer Client-Verbindung ist ein Fehler aufgetreten.</td>
+            </tr>
+            <tr>
+                <td><code>connectionError</code></td>
+                <td><code>{ client, err }</code></td>
+                <td>Ein Fehler auf Verbindungsebene ist aufgetreten.</td>
+            </tr>
+            <tr>
+                <td><code>keepaliveTimeout</code></td>
+                <td><code>{ client }</code></td>
+                <td>Ein Client wurde wegen Keepalive-Timeout getrennt.</td>
+            </tr>
+            <tr>
+                <td><code>subscribe</code></td>
+                <td><code>{ topic, qos, client }</code></td>
+                <td>Ein Client hat ein Topic abonniert. Pro Abonnement wird eine Nachricht gesendet.</td>
+            </tr>
+            <tr>
+                <td><code>unsubscribe</code></td>
+                <td><code>{ topic, client }</code></td>
+                <td>Ein Client hat ein Topic-Abonnement beendet. Pro Abmeldung wird eine Nachricht gesendet.</td>
+            </tr>
+        </tbody>
+    </table>
+
+    <h3>Referenzen</h3>
+    <ul>
+        <li><a href="https://github.com/moscajs/aedes">Aedes</a> - die zugrunde liegende MQTT-Broker-Bibliothek</li>
+        <li><a href="https://github.com/martin-doyle/node-red-contrib-aedes">node-red-contrib-aedes</a> - GitHub-Repository</li>
+    </ul>
+</script>

package/locales/de/aedes.json

@@ -0,0 +1,54 @@
+{
+  "aedes-mqtt-broker": {
+    "status": {
+      "connected": "verbunden __count__",
+      "connected_plural": "verbunden __count__",
+      "disconnected": "getrennt",
+      "error": "Fehler",
+      "init-failed": "Initialisierung fehlgeschlagen"
+    },
+    "error": {
+      "port-in-use": "Fehler: Port __port__ wird bereits verwendet",
+      "server-error": "Fehler beim Erstellen des Servers auf Port __port__: __error__",
+      "init-failed": "Aedes Broker konnte nicht initialisiert werden: __error__"
+    },
+    "label": {
+      "mqtt_port": "MQTT-Port",
+      "mqtt_ws_bind": "WS-Bindung",
+      "mqtt_ws_port": "WS-Port",
+      "mqtt_ws_path": "WS-Pfad",
+      "use-tls": "Sichere Verbindung (SSL/TLS) aktivieren",
+      "use-local-files": "Lokale Dateien verwenden",
+      "tls-config": "TLS-Konfiguration",
+      "upload": "Hochladen",
+      "cert": "Zertifikat",
+      "key": "Privater Schlüssel",
+      "ca": "CA-Zertifikat",
+      "persistence_bind": "Persistenz",
+      "persistence_memory": "Speicher",
+      "persistence_mongodb": "MongoDB",
+      "persistence_level": "LevelDB",
+      "dburl": "DB-URL",
+      "persist_to_file": "Zustand über Neustarts hinweg speichern"
+    },
+    "tip": {
+      "persist_to_file": "Speichert Retained Messages und Subscriptions als JSON-Datei im Node-RED userDir. Wird beim Herunterfahren und alle 60 s geschrieben. QoS 1/2 In-Flight-Nachrichten werden nicht gespeichert. Wird automatisch deaktiviert, wenn userDir nicht beschreibbar ist."
+    },
+    "placeholder": {
+      "mqtt_port": "MQTT-Port eingeben",
+      "mqtt_ws_port": "WebSocket-Port eingeben. Leer lassen um WebSocket zu deaktivieren",
+      "mqtt_ws_path": "WebSocket-Pfad eingeben. Leer lassen um WebSocket zu deaktivieren",
+      "cert": "Pfad zum Zertifikat (PEM-Format)",
+      "key": "Pfad zum privaten Schlüssel (PEM-Format)",
+      "ca": "Pfad zum CA-Zertifikat (PEM-Format)",
+      "dburl": "mongodb://localhost:27017/mqtt",
+      "username": "Leer lassen um Authentifizierung zu deaktivieren",
+      "password": "Leer lassen um Authentifizierung zu deaktivieren"
+    },
+    "tabs-label": {
+      "connection": "Verbindung",
+      "persistence": "Persistenz",
+      "security": "Sicherheit"
+    }
+  }
+}

package/locales/en-US/aedes.html

@@ -1,18 +1,109 @@
 <script type="text/x-red" data-help-name="aedes broker">
-    <p>MQTT broker based on Barebone MQTT broker Aedes. You can use MQTT-in and MQTT-out nodes without an external broker like Mosquitto.</p>
+    <p>An embedded MQTT broker based on <a href="https://github.com/moscajs/aedes">Aedes</a>.
+    Allows MQTT-in and MQTT-out nodes to communicate without an external broker like Mosquitto.</p>
+
     <h3>Outputs</h3>
-        <dl class="message-properties">
-            <dt>topic <span class="property-type">string</span></dt>
-            <dd>the topic of the event.</dd>
-            <dt>payload 1<span class="property-type">object</span></dt>
-            <dd>the content of all events from the broker except publish.</dd>
-            <dt>payload 2<span class="property-type">object</span></dt>
-            <dd>the content of the publish events from the broker.</dd>
+    <ol class="node-ports">
+        <li>Events
+            <dl class="message-properties">
+                <dt>topic <span class="property-type">string</span></dt>
+                <dd>the name of the event (see table below).</dd>
+                <dt>payload <span class="property-type">object</span></dt>
+                <dd>event-specific data containing client information and, where applicable, error or subscription details.</dd>
+            </dl>
+        </li>
+        <li>Publish
+            <dl class="message-properties">
+                <dt>topic <span class="property-type">string</span></dt>
+                <dd>always <code>"publish"</code>.</dd>
+                <dt>payload.packet <span class="property-type">object</span></dt>
+                <dd>the MQTT packet with <code>topic</code>, <code>payload</code>, <code>qos</code>, and <code>retain</code> properties.</dd>
+                <dt>payload.client <span class="property-type">object | null</span></dt>
+                <dd>the client that published the message, or <code>null</code> for broker-originated messages.</dd>
+            </dl>
+        </li>
+    </ol>
+    <p><strong>Note:</strong> The publish output is only active when it is wired to another node.
+    This avoids unnecessary processing when publish messages are not needed.</p>
 
-        </dl>
     <h3>Details</h3>
+    <p>This node starts an MQTT broker inside the Node-RED process. MQTT clients,
+    including the built-in MQTT-in and MQTT-out nodes, can connect to it on the
+    configured port (default <code>1883</code>).</p>
+
+    <h4>Connection</h4>
+    <p>Configure the MQTT TCP port and optional WebSocket access. WebSocket
+    connections can be exposed in two ways:</p>
+    <ul>
+        <li><b>Port</b> &ndash; a standalone WebSocket server on a separate port.</li>
+        <li><b>Path</b> &ndash; shares the Node-RED HTTP server under a URL path
+        (relative to <code>httpNodeRoot</code>).</li>
+    </ul>
+    <p>Enable <i>SSL/TLS</i> to secure connections. Certificates can be uploaded
+    directly or referenced as local file paths on the server.</p>
+
+    <h4>Persistence</h4>
+    <p>By default messages and subscriptions are stored in memory and lost on
+    restart. Select <i>MongoDB</i> to persist data across restarts.</p>
+
+    <h4>Security</h4>
+    <p>Set a username and password to require client authentication.
+    Leave both fields blank to allow anonymous connections.
+    Only a single set of credentials is supported.</p>
+
+    <h4>Event Topics</h4>
+    <p>The first output emits the following events:</p>
+    <table>
+        <thead>
+            <tr><th>topic</th><th>payload</th><th>Description</th></tr>
+        </thead>
+        <tbody>
+            <tr>
+                <td><code>client</code></td>
+                <td><code>{ client }</code></td>
+                <td>A new client has connected (before authentication).</td>
+            </tr>
+            <tr>
+                <td><code>clientReady</code></td>
+                <td><code>{ client }</code></td>
+                <td>A client has connected and is authenticated and ready.</td>
+            </tr>
+            <tr>
+                <td><code>clientDisconnect</code></td>
+                <td><code>{ client }</code></td>
+                <td>A client has gracefully disconnected.</td>
+            </tr>
+            <tr>
+                <td><code>clientError</code></td>
+                <td><code>{ client, err }</code></td>
+                <td>An error occurred on a client connection.</td>
+            </tr>
+            <tr>
+                <td><code>connectionError</code></td>
+                <td><code>{ client, err }</code></td>
+                <td>A connection-level error occurred.</td>
+            </tr>
+            <tr>
+                <td><code>keepaliveTimeout</code></td>
+                <td><code>{ client }</code></td>
+                <td>A client has been disconnected due to keepalive timeout.</td>
+            </tr>
+            <tr>
+                <td><code>subscribe</code></td>
+                <td><code>{ topic, qos, client }</code></td>
+                <td>A client has subscribed to a topic. One message is sent per subscription.</td>
+            </tr>
+            <tr>
+                <td><code>unsubscribe</code></td>
+                <td><code>{ topic, client }</code></td>
+                <td>A client has unsubscribed from a topic. One message is sent per unsubscription.</td>
+            </tr>
+        </tbody>
+    </table>
+
     <h3>References</h3>
-        <ul>
-            <li><a href="https://github.com/moscajs/aedes">Aedes</a> - Barebone MQTT broker that can run on any stream server, the node way</li>
-        </ul>
+    <ul>
+        <li><a href="https://github.com/moscajs/aedes">Aedes</a> - the underlying MQTT broker library</li>
+        <li><a href="https://github.com/martin-doyle/node-red-contrib-aedes">node-red-contrib-aedes</a> - GitHub repository</li>
+    </ul>
 </script>

package/locales/en-US/aedes.json

@@ -2,10 +2,19 @@
   "aedes-mqtt-broker": {
     "status": {
       "connected": "connected __count__",
-      "connected_plural": "connected __count__"
+      "connected_plural": "connected __count__",
+      "disconnected": "disconnected",
+      "error": "error",
+      "init-failed": "initialization failed"
+    },
+    "error": {
+      "port-in-use": "Error: Port __port__ is already in use",
+      "server-error": "Error creating server on port __port__: __error__",
+      "init-failed": "Failed to initialize Aedes broker: __error__"
     },
     "label": {
       "mqtt_port": "MQTT port",
+      "mqtt_ws_bind": "WS bind",
       "mqtt_ws_port": "WS port",
       "mqtt_ws_path": "WS path",
       "use-tls": "Enable secure (SSL/TLS) connection",
@@ -19,7 +28,11 @@
       "persistence_memory": "Memory",
       "persistence_mongodb": "MongoDB",
       "persistence_level": "LevelDB",
-      "dburl": "DB Url"
+      "dburl": "DB Url",
+      "persist_to_file": "Persist state across restarts"
+    },
+    "tip": {
+      "persist_to_file": "Saves retained messages and subscriptions as a JSON file in the Node-RED userDir. Written on shutdown and every 60 s. QoS 1/2 in-flight messages are not persisted. Disabled automatically if userDir is not writable."
     },
     "placeholder": {
       "mqtt_port": "Enter MQTT port",

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "node-red-contrib-aedes",
-  "version": "0.15.1",
+  "version": "1.2.0",
   "description": "Node Red MQTT broker node based on aedes.js",
   "dependencies": {
-    "aedes": "^0.51.3",
+    "aedes": "^1.0.0",
     "aedes-persistence-mongodb": "^9.3.0",
-    "websocket-stream": "^5.5.2"
+    "ws": "^8.18.0"
   },
   "devDependencies": {
     "mqtt": "^5.13.1",
-    "node-red-node-test-helper": "^0.3.3"
+    "node-red-node-test-helper": "^0.3.3",
+    "semistandard": "^17.0.0",
+    "snazzy": "^9.0.0"
   },
   "scripts": {
     "patch": "npm --no-git-tag-version version patch",

package/test/aedes_last_will_spec.js

@@ -4,6 +4,7 @@ const helper = require('node-red-node-test-helper');
 const aedesNode = require('../aedes.js');
 const mqtt = require('mqtt');
 const should = require('should');
+const { logError } = require('./test-utils');
 
 helper.init(require.resolve('node-red'));
 
@@ -34,20 +35,7 @@ describe('Aedes Broker Last Will tests', function () {
         done();
       });
     } catch (n) {
-    // Check if AggregateError
-      console.log(
-        n instanceof AggregateError
-      );
-
-      // Print the message of the error
-      console.log(n.message);
-
-      // Print the name of the error
-      console.log(n.name);
-
-      // Print all the errors that this
-      // error comprises
-      console.log(n.errors);
+      logError(n);
       done();
     }
   });
@@ -70,40 +58,29 @@ describe('Aedes Broker Last Will tests', function () {
       }
     ];
     helper.load([aedesNode], flow, function () {
-      const client1 = mqtt.connect('mqtt://localhost:1883', {
-        clientId: 'client1',
-        will: { topic: 'testLastWill', payload: 'last will' }
-      });
-      client1.on('error', function (n) {
-        console.log(
-          n instanceof AggregateError
-        );
-
-        // Print the message of the error
-        console.log(n.message);
-
-        // Print the name of the error
-        console.log(n.name);
-
-        // Print all the errors that this
-        // error comprises
-        console.log(n.errors);
-      });
-      client1.on('connect', function () {
-        // console.log('External client1 connected');
-      });
-      const n2 = helper.getNode('n2');
-      n2.on('input', function (msg) {
-        // console.log('Broker received message topic: ' + msg.topic + ', clientid: ' + msg.payload.client.id);
-        if (msg.topic === 'clientReady') {
-          // console.log('Topic: ' + msg.payload.client.will.topic);
-          // console.log('Payload: ' + msg.payload.client.will.payload.toString());
-          should(msg.payload.client.will.topic).equal('testLastWill');
-          should(msg.payload.client.will.payload.toString()).equal('last will');
-          client1.end(function () {
-            done();
-          });
-        }
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client1 = mqtt.connect('mqtt://localhost:1883', {
+          clientId: 'client1',
+          will: { topic: 'testLastWill', payload: 'last will' }
+        });
+        client1.on('error', logError);
+        client1.on('connect', function () {
+          // console.log('External client1 connected');
+        });
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          // console.log('Broker received message topic: ' + msg.topic + ', clientid: ' + msg.payload.client.id);
+          if (msg.topic === 'clientReady') {
+            // console.log('Topic: ' + msg.payload.client.will.topic);
+            // console.log('Payload: ' + msg.payload.client.will.payload.toString());
+            should(msg.payload.client.will.topic).equal('testLastWill');
+            should(msg.payload.client.will.payload.toString()).equal('last will');
+            client1.end(function () {
+              done();
+            });
+          }
+        });
       });
     });
   });