node-red-contrib-aedes 0.15.0 → 1.1.0

package/.github/workflows/nodejs.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [22.x, 24.x]
         node-red: [3.x, 4.x]
 
     steps:

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # node-red-contrib-aedes Changelog
 
+## Feb 15, 2026, Version 1.1.0
+### Notable changes
+- Improved help documentation
+- Improved UI
+- Added German locale (de)
+
+## Feb 14, 2026, Version 1.0.0
+### Notable changes
+- Update aedes to version 1.0.0
+
 ## Jul 22, 2025, Version 0.15.0
 ### Notable changes
 - TLS configuration with local filess

package/README.md

@@ -30,7 +30,7 @@ Just put this node on Node-RED and hit the deploy button. The MQTT Broker will r
 - Standard TCP Support
 - WebSocket Support via port or path
 - SSL / TLS
-- Message Persistence (In-memory, LevelDB or MongoDB)
+- Message Persistence (In-memory or MongoDB)
  
 For more information see [Aedes](https://github.com/moscajs/aedes/blob/master/README.md#features).
 
@@ -41,6 +41,26 @@ When your Node-RED server address is `https://yourserver/`, you can set the WebS
 
 You can also bind the WebSocket to the root `"/"` path and having `wss://yourserver/` WebSocket listening at port `443` (or `ws://yourserver/` at port `80`).
  
+## Version Compatibility
+
+The current version is based on **Aedes version 1.0**, which introduces several breaking changes. If your environment requires Aedes version 0.51, you can switch to version 0.15.x of this package.
+
+To install the compatible version using the `version-11` dist-tag:
+```sh
+npm install node-red-contrib-aedes@version-15
+```
+
+The current version and version 0.15.x require **Node.js >= 20** and **Node-RED >= 3.0**.
+
+If you are running an older Node.js version (e.g. on locked-down or legacy hardware), please use version **0.11.x** of this package.
+
+To install the compatible version using the `version-11` dist-tag:
+```sh
+npm install node-red-contrib-aedes@version-11
+```
+
+For more details, see [issue #85](https://github.com/martin-doyle/node-red-contrib-aedes/issues/85).
+
 ## License
- 
+
  Licensed under [MIT](./LICENSE).

package/aedes.html

@@ -25,27 +25,28 @@
   <div id="node-config-aedes-broker-tabs-content" style="min-height:150px;">
       <div id="aedes-broker-tab-connection" style="display:none">
           <div class="form-row">
-              <label for="node-input-mqtt_port"><i class="fa fa-globe"></i> <span
+              <label for="node-input-mqtt_port"><i class="fa fa-plug"></i> <span
                       data-i18n="aedes-mqtt-broker.label.mqtt_port"></span></label>
               <input type="text" id="node-input-mqtt_port"
                   data-i18n="[placeholder]aedes-mqtt-broker.placeholder.mqtt_port">
           </div>
           <div class="form-row">
-              <label for="node-input-mqtt_ws_bind"><i class="fa fa-globe"></i> WS bind</label>
-              <select id="node-input-mqtt_ws_bind" type="text" style="width:30%" text-center>
+              <label for="node-input-mqtt_ws_bind"><i class="fa fa-exchange"></i> <span
+                      data-i18n="aedes-mqtt-broker.label.mqtt_ws_bind"></span></label>
+              <select id="node-input-mqtt_ws_bind" type="text" style="width:30%; text-align:center;">
                   <option value="path" default>path</option>
                   <option value="port">port</option>
               </select>
           </div>
           <div class="form-row" id="node-input-mqtt_ws_path-label">
-              <label for="node-input-mqtt_ws_path"><i class="fa fa-globe"></i> <span
-                      data-i18n="aedes-mqtt-broker.label.mqtt_ws_path"></label>
+              <label for="node-input-mqtt_ws_path"><i class="fa fa-link"></i> <span
+                      data-i18n="aedes-mqtt-broker.label.mqtt_ws_path"></span></label>
               <input type="text" id="node-input-mqtt_ws_path"
                   data-i18n="[placeholder]aedes-mqtt-broker.placeholder.mqtt_ws_path">
           </div>
           <div class="form-row" id="node-input-mqtt_ws_port-label">
-              <label for="node-input-mqtt_ws_port"><i class="fa fa-globe"></i> <span
-                      data-i18n="aedes-mqtt-broker.label.mqtt_ws_port"></label>
+              <label for="node-input-mqtt_ws_port"><i class="fa fa-plug"></i> <span
+                      data-i18n="aedes-mqtt-broker.label.mqtt_ws_port"></span></label>
               <input type="text" id="node-input-mqtt_ws_port"
                   data-i18n="[placeholder]aedes-mqtt-broker.placeholder.mqtt_ws_port">
           </div>
@@ -58,7 +59,7 @@
                       <input type="checkbox" id="node-input-uselocalfiles"
                           style="display: inline-block; width: auto; vertical-align: top;">
                       <label for="node-input-uselocalfiles" style="width: 70%;"><span
-                              data-i18n="aedes-mqtt-broker.label.use-local-files"></label>
+                              data-i18n="aedes-mqtt-broker.label.use-local-files"></span></label>
                   </div>
 
                   <div class="form-row">
@@ -122,17 +123,17 @@
       </div>
       <div id="aedes-broker-tab-persistence" style="display:none">
           <div class="form-row">
-              <label for="node-input-persistence_bind"><i class="fa fa-globe"></i> <span
-                      data-i18n="aedes-mqtt-broker.label.persistence_bind"></label>
-              <select id="node-input-persistence_bind" type="text" style="width:30%" text-center>
+              <label for="node-input-persistence_bind"><i class="fa fa-hdd-o"></i> <span
+                      data-i18n="aedes-mqtt-broker.label.persistence_bind"></span></label>
+              <select id="node-input-persistence_bind" type="text" style="width:30%; text-align:center;">
                   <option value="memory" data-i18n="aedes-mqtt-broker.label.persistence_memory" default></option>
                   <option value="mongodb" data-i18n="aedes-mqtt-broker.label.persistence_mongodb"></option>
              <!--     <option value="level" data-i18n="aedes-mqtt-broker.label.persistence_level"></option> -->
               </select>
           </div>
-          <div class="form-row" id="node-row-dburl" class="hide">
+          <div class="form-row hide" id="node-row-dburl">
               <label for="node-input-dburl"><i class="fa fa-database"></i> <span
-                      data-i18n="aedes-mqtt-broker.label.dburl"></label>
+                      data-i18n="aedes-mqtt-broker.label.dburl"></span></label>
               <input type="text" id="node-input-dburl" data-i18n="[placeholder]aedes-mqtt-broker.placeholder.dburl">
           </div>
       </div>
@@ -157,9 +158,16 @@
     category: 'network',
     defaults: {
       name: { value: '' },
-      mqtt_port: { value: 1883, validate: RED.validators.number() },
+      mqtt_port: { value: 1883, validate: function (v) {
+        var n = parseInt(v, 10);
+        return !isNaN(n) && n >= 1 && n <= 65535;
+      }},
       mqtt_ws_bind: { value: 'port', required: true },
-      mqtt_ws_port: { value: null, required: false, validate: RED.validators.number(true) },
+      mqtt_ws_port: { value: null, required: false, validate: function (v) {
+        if (v === '' || v === null || v === undefined) return true;
+        var n = parseInt(v, 10);
+        return !isNaN(n) && n >= 1 && n <= 65535;
+      }},
       mqtt_ws_path: { value: '', required: false },
       cert: {
         value: '',
@@ -331,7 +339,7 @@
       $('#tls-button-key-clear').on('click', function () {
         clearNameData('key');
       });
-      $("#tls-config-button-ca-clear").on("click", function() {
+      $("#tls-button-ca-clear").on("click", function() {
         clearNameData("ca");
       });
 
@@ -360,9 +368,11 @@
         $('#node-input-tls').val('');
       }
       if ($("#node-input-uselocalfiles").is(':checked')) {
-          clearNameData("ca");
-          clearNameData("cert");
-          clearNameData("key");
+          ['ca', 'cert', 'key'].forEach(function (prop) {
+            $('#tls-' + prop + 'name').text('');
+            $('#node-input-' + prop + 'data').val('');
+            $('#node-input-' + prop + 'name').val('');
+          });
       } else {
           $("#node-input-ca").val("");
           $("#node-input-cert").val("");

package/aedes.js

@@ -19,13 +19,13 @@ module.exports = function (RED) {
   const MongoPersistence = require('aedes-persistence-mongodb');
   // const { Level } = require('level');
   // const LevelPersistence = require('aedes-persistence-level');
-  const aedes = require('aedes');
+  // aedes is ESM-only in v1 -- dynamically imported in initializeBroker()
   const fs = require('fs');
   const net = require('net');
   const tls = require('tls');
   const http = require('http');
   const https = require('https');
-  const ws = require('websocket-stream');
+  const { WebSocketServer, createWebSocketStream } = require('ws');
 
   let serverUpgradeAdded = false;
   const listenerNodes = {};
@@ -51,131 +51,53 @@ module.exports = function (RED) {
     }
   }
 
-  function AedesBrokerNode (config) {
-    RED.nodes.createNode(this, config);
-    this.mqtt_port = parseInt(config.mqtt_port, 10);
-    this.mqtt_ws_port = parseInt(config.mqtt_ws_port, 10);
-    this.mqtt_ws_path = '' + config.mqtt_ws_path;
-    this.mqtt_ws_bind = config.mqtt_ws_bind;
-    this.usetls = config.usetls;
-
-    const certPath = config.cert ? config.cert.trim() : '';
-    const keyPath = config.key ? config.key.trim() : '';
-    const caPath = config.ca ? config.ca.trim() : '';
-
-    this.uselocalfiles = config.uselocalfiles;
-    this.dburl = config.dburl;
-
-    if (this.mqtt_ws_bind === 'path') {
-      this.mqtt_ws_port = 0;
-    } else {
-      this.mqtt_ws_path = '';
-    }
-
-    if (certPath.length > 0 || keyPath.length > 0 || caPath.length > 0) {
-      if ((certPath.length > 0) !== (keyPath.length > 0)) {
-        this.valid = false;
-        this.error(RED._('tls.error.missing-file'));
-        return;
-      }
-      try {
-        if (certPath) {
-          this.cert = fs.readFileSync(certPath);
-        }
-        if (keyPath) {
-          this.key = fs.readFileSync(keyPath);
-        }
-        if (caPath) {
-          this.ca = fs.readFileSync(caPath);
-        }
-      } catch (err) {
-        this.valid = false;
-        this.error(err.toString());
-        return;
-      }
-    } else {
-      if (this.credentials) {
-        this.cert = this.credentials.certdata || '';
-        this.key = this.credentials.keydata || '';
-        this.ca = this.credentials.cadata || '';
-      }
-    }
-    if (this.credentials) {
-      this.username = this.credentials.username;
-      this.password = this.credentials.password;
-    }
+  async function initializeBroker (node, config, aedesSettings, serverOptions) {
+    const { Aedes } = await import('aedes');
+    const broker = await Aedes.createBroker(aedesSettings);
+    if (node._closing) { broker.close(); return; }
+    node._broker = broker;
 
-    if (typeof this.usetls === 'undefined') {
-      this.usetls = false;
-    }
-
-    const node = this;
-
-    const aedesSettings = {};
-    const serverOptions = {};
-
-    if (config.persistence_bind === 'mongodb' && config.dburl) {
-      aedesSettings.persistence = MongoPersistence({
-        url: config.dburl
-      });
-      node.log('Start persistence to MongeDB');
-      /*
-    } else if (config.persistence_bind === 'level') {
-      aedesSettings.persistence = LevelPersistence(new Level('leveldb'));
-      node.log('Start persistence to LevelDB');
-      */
-    }
-
-    if (this.cert && this.key && this.usetls) {
-      serverOptions.cert = this.cert;
-      serverOptions.key = this.key;
-      serverOptions.ca = this.ca;
-    }
-
-    const broker = aedes.createBroker(aedesSettings);
     let server;
-    if (this.usetls) {
+    if (node.usetls) {
       server = tls.createServer(serverOptions, broker.handle);
     } else {
       server = net.createServer(broker.handle);
     }
+    node._server = server;
 
-    let wss = null;
-    let httpServer = null;
-
-    if (this.mqtt_ws_port) {
+    if (node.mqtt_ws_port) {
       // Awkward check since http or ws do not fire an error event in case the port is in use
       const testServer = net.createServer();
       testServer.once('error', function (err) {
         if (err.code === 'EADDRINUSE') {
           node.error(
-            'Error: Port ' + config.mqtt_ws_port + ' is already in use'
+            RED._('aedes-mqtt-broker.error.port-in-use', { port: config.mqtt_ws_port })
           );
         } else {
           node.error(
-            'Error creating net server on port ' +
-              config.mqtt_ws_port +
-              ', ' +
-              err.toString()
+            RED._('aedes-mqtt-broker.error.server-error', { port: config.mqtt_ws_port, error: err.toString() })
           );
         }
+        node.status({ fill: 'red', shape: 'ring', text: 'aedes-mqtt-broker.status.error' });
       });
       testServer.once('listening', function () {
         testServer.close();
       });
 
       testServer.once('close', function () {
+        let httpServer;
         if (node.usetls) {
           httpServer = https.createServer(serverOptions);
         } else {
           httpServer = http.createServer();
         }
-        wss = ws.createServer(
-          {
-            server: httpServer
-          },
-          broker.handle
-        );
+        node._httpServer = httpServer;
+        const wss = new WebSocketServer({ server: httpServer });
+        wss.on('connection', function (websocket, req) {
+          const stream = createWebSocketStream(websocket);
+          broker.handle(stream, req);
+        });
+        node._wss = wss;
         httpServer.listen(config.mqtt_ws_port, function () {
           node.log(
             'Binding aedes mqtt server on ws port: ' + config.mqtt_ws_port
@@ -187,7 +109,7 @@ module.exports = function (RED) {
       });
     }
 
-    if (this.mqtt_ws_path !== '') {
+    if (node.mqtt_ws_path !== '') {
       if (!serverUpgradeAdded) {
         RED.server.on('upgrade', handleServerUpgrade);
         serverUpgradeAdded = true;
@@ -206,46 +128,44 @@ module.exports = function (RED) {
         node.error(
           RED._('websocket.errors.duplicate-path', { path: node.mqtt_ws_path })
         );
-        return;
-      }
-      listenerNodes[node.fullPath] = node;
-      const serverOptions_ = {
-        noServer: true
-      };
-      if (RED.settings.webSocketNodeVerifyClient) {
-        serverOptions_.verifyClient = RED.settings.webSocketNodeVerifyClient;
-      }
-
-      node.server = ws.createServer(
-        {
+      } else {
+        listenerNodes[node.fullPath] = node;
+        const serverOptions_ = {
           noServer: true
-        },
-        broker.handle
-      );
+        };
+        if (RED.settings.webSocketNodeVerifyClient) {
+          serverOptions_.verifyClient = RED.settings.webSocketNodeVerifyClient;
+        }
 
-      node.log('Binding aedes mqtt server on ws path: ' + node.fullPath);
+        node.server = new WebSocketServer(serverOptions_);
+        node.server.on('connection', function (websocket, req) {
+          const stream = createWebSocketStream(websocket);
+          broker.handle(stream, req);
+        });
+
+        node.log('Binding aedes mqtt server on ws path: ' + node.fullPath);
+      }
     }
 
     server.once('error', function (err) {
       if (err.code === 'EADDRINUSE') {
-        node.error('Error: Port ' + config.mqtt_port + ' is already in use');
-        node.status({
-          fill: 'red',
-          shape: 'ring',
-          text: 'node-red:common.status.disconnected'
-        });
+        node.error(
+          RED._('aedes-mqtt-broker.error.port-in-use', { port: config.mqtt_port })
+        );
       } else {
-        node.error('Error: Port ' + config.mqtt_port + ' ' + err.toString());
-        node.status({
-          fill: 'red',
-          shape: 'ring',
-          text: 'node-red:common.status.disconnected'
-        });
+        node.error(
+          RED._('aedes-mqtt-broker.error.server-error', { port: config.mqtt_port, error: err.toString() })
+        );
       }
+      node.status({
+        fill: 'red',
+        shape: 'ring',
+        text: 'aedes-mqtt-broker.status.error'
+      });
     });
 
-    if (this.mqtt_port) {
-      server.listen(this.mqtt_port, function () {
+    if (node.mqtt_port) {
+      server.listen(node.mqtt_port, function () {
         node.log('Binding aedes mqtt server on port: ' + config.mqtt_port);
         node.status({
           fill: 'green',
@@ -255,7 +175,7 @@ module.exports = function (RED) {
       });
     }
 
-    if (this.credentials && this.username && this.password) {
+    if (node.credentials && node.username && node.password) {
       broker.authenticate = function (client, username, password, callback) {
         const authorized =
           username === node.username &&
@@ -365,31 +285,25 @@ module.exports = function (RED) {
       });
     });
 
-    broker.on('subscribe', function (subscription, client) {
-      const msg = {
-        topic: 'subscribe',
-        payload: {
-          topic: subscription.topic,
-          qos: subscription.qos,
-          client
-        }
-      };
-      node.send([msg, null]);
+    broker.on('subscribe', function (subscriptions, client) {
+      for (const subscription of subscriptions) {
+        node.send([{
+          topic: 'subscribe',
+          payload: { topic: subscription.topic, qos: subscription.qos, client }
+        }, null]);
+      }
     });
 
-    broker.on('unsubscribe', function (subscription, client) {
-      const msg = {
-        topic: 'unsubscribe',
-        payload: {
-          topic: subscription.topic,
-          qos: subscription.qos,
-          client
-        }
-      };
-      node.send([msg, null]);
+    broker.on('unsubscribe', function (unsubscriptions, client) {
+      for (const topic of unsubscriptions) {
+        node.send([{
+          topic: 'unsubscribe',
+          payload: { topic, client }
+        }, null]);
+      }
     });
 
-    if (this.wires && this.wires[1] && this.wires[1].length > 0) {
+    if (node.wires && node.wires[1] && node.wires[1].length > 0) {
       node.log('Publish output wired. Enable broker publish event messages.');
       broker.on('publish', function (packet, client) {
         const msg = {
@@ -406,49 +320,143 @@ module.exports = function (RED) {
     broker.on('closed', function () {
       node.debug('Closed event');
     });
+  }
 
-    this.on('close', function (done) {
-      process.nextTick(function onCloseDelayed () {
-        function wsClose () {
-          if (wss) {
-            node.log(
-              'Unbinding aedes mqtt server from ws port: ' + config.mqtt_ws_port
-            );
-            wss.close(function () {
-              node.debug('after wss.close(): ');
-              httpServer.close(function () {
-                node.debug('after httpServer.close(): ');
-                done();
-              });
-            });
-          } else {
-            done();
-          }
-        }
+  function AedesBrokerNode (config) {
+    RED.nodes.createNode(this, config);
+    this.mqtt_port = parseInt(config.mqtt_port, 10);
+    this.mqtt_ws_port = parseInt(config.mqtt_ws_port, 10);
+    this.mqtt_ws_path = '' + config.mqtt_ws_path;
+    this.mqtt_ws_bind = config.mqtt_ws_bind;
+    this.usetls = config.usetls;
 
-        function brokerClose () {
-          broker.close(function () {
-            node.log(
-              'Unbinding aedes mqtt server from port: ' + config.mqtt_port
-            );
-            server.close(function () {
-              node.debug('after server.close(): ');
-              if (node.mqtt_ws_path !== '') {
-                node.log(
-                  'Unbinding aedes mqtt server from ws path: ' + node.fullPath
-                );
-                delete listenerNodes[node.fullPath];
-                node.server.close(function () {
-                  wsClose();
-                });
-              } else {
-                wsClose();
-              }
-            });
-          });
+    const certPath = config.cert ? config.cert.trim() : '';
+    const keyPath = config.key ? config.key.trim() : '';
+    const caPath = config.ca ? config.ca.trim() : '';
+
+    this.uselocalfiles = config.uselocalfiles;
+    this.dburl = config.dburl;
+
+    if (this.mqtt_ws_bind === 'path') {
+      this.mqtt_ws_port = 0;
+    } else {
+      this.mqtt_ws_path = '';
+    }
+
+    if (certPath.length > 0 || keyPath.length > 0 || caPath.length > 0) {
+      if ((certPath.length > 0) !== (keyPath.length > 0)) {
+        this.valid = false;
+        this.error(RED._('tls.error.missing-file'));
+        return;
+      }
+      try {
+        if (certPath) {
+          this.cert = fs.readFileSync(certPath);
+        }
+        if (keyPath) {
+          this.key = fs.readFileSync(keyPath);
         }
-        brokerClose();
+        if (caPath) {
+          this.ca = fs.readFileSync(caPath);
+        }
+      } catch (err) {
+        this.valid = false;
+        this.error(err.toString());
+        return;
+      }
+    } else {
+      if (this.credentials) {
+        this.cert = this.credentials.certdata || '';
+        this.key = this.credentials.keydata || '';
+        this.ca = this.credentials.cadata || '';
+      }
+    }
+    if (this.credentials) {
+      this.username = this.credentials.username;
+      this.password = this.credentials.password;
+    }
+
+    if (typeof this.usetls === 'undefined') {
+      this.usetls = false;
+    }
+
+    const node = this;
+
+    const aedesSettings = {};
+    const serverOptions = {};
+
+    if (config.persistence_bind === 'mongodb' && config.dburl) {
+      aedesSettings.persistence = MongoPersistence({
+        url: config.dburl
       });
+      node.log('Start persistence to MongoDB');
+      /*
+    } else if (config.persistence_bind === 'level') {
+      aedesSettings.persistence = LevelPersistence(new Level('leveldb'));
+      node.log('Start persistence to LevelDB');
+      */
+    }
+
+    if (this.cert && this.key && this.usetls) {
+      serverOptions.cert = this.cert;
+      serverOptions.key = this.key;
+      serverOptions.ca = this.ca;
+    }
+
+    node._closing = false;
+    node._broker = null;
+    node._server = null;
+    node._wss = null;
+    node._httpServer = null;
+
+    node._initPromise = initializeBroker(node, config, aedesSettings, serverOptions);
+    node._initPromise.catch(function (err) {
+      node.error(RED._('aedes-mqtt-broker.error.init-failed', { error: err.toString() }));
+      node.status({ fill: 'red', shape: 'ring', text: 'aedes-mqtt-broker.status.init-failed' });
+    });
+
+    this.on('close', async function (removed, done) {
+      node._closing = true;
+      if (removed) {
+        node.debug('Node removed or disabled');
+      } else {
+        node.debug('Node restarting');
+      }
+      try {
+        await node._initPromise;
+        closeBroker(node, done);
+      } catch (e) {
+        done();
+      }
+    });
+  }
+
+  function closeBroker (node, done) {
+    process.nextTick(function () {
+      function wsClose () {
+        if (node._wss) {
+          node._wss.close(function () {
+            if (node._httpServer) {
+              node._httpServer.close(function () { done(); });
+            } else { done(); }
+          });
+        } else { done(); }
+      }
+      function serverClose () {
+        if (node._server) {
+          node._server.close(function () {
+            if (node.mqtt_ws_path !== '' && node.fullPath) {
+              delete listenerNodes[node.fullPath];
+              if (node.server) {
+                node.server.close(function () { wsClose(); });
+              } else { wsClose(); }
+            } else { wsClose(); }
+          });
+        } else { wsClose(); }
+      }
+      if (node._broker) {
+        node._broker.close(function () { serverClose(); });
+      } else { serverClose(); }
     });
   }