node-red-contrib-aedes 0.15.1 → 1.2.0

package/test/aedes_spec.js

@@ -4,6 +4,8 @@ const helper = require('node-red-node-test-helper');
 const aedesNode = require('../aedes.js');
 const mqttNode = require('../node_modules/node-red/node_modules/@node-red/nodes/core/network/10-mqtt.js');
 const mqtt = require('mqtt');
+const should = require('should');
+const { logError } = require('./test-utils');
 
 const credentialsOK = { n1: { username: 'test', password: 'test' }, b1: { user: 'test', password: 'test' } };
 const credentialsMissing = { n1: { username: 'test', password: 'test' }, b1: { user: 'test' } };
@@ -68,10 +70,13 @@ describe('Aedes Broker TCP tests', function () {
       }
     ],
     function () {
-      const n2 = helper.getNode('n2');
-      n2.on('input', function (msg) {
-        msg.should.have.property('topic', 'clientReady');
-        done();
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          msg.should.have.property('topic', 'clientReady');
+          done();
+        });
       });
     });
   });
@@ -108,10 +113,13 @@ describe('Aedes Broker TCP tests', function () {
 
     helper.load([aedesNode, mqttNode], flow, credentialsMissing,
       function () {
-        const n2 = helper.getNode('n2');
-        n2.on('input', function (msg) {
-          msg.should.have.property('topic', 'clientError');
-          done();
+        const n1 = helper.getNode('n1');
+        n1._initPromise.then(function () {
+          const n2 = helper.getNode('n2');
+          n2.on('input', function (msg) {
+            msg.should.have.property('topic', 'clientError');
+            done();
+          });
         });
       });
   });
@@ -148,10 +156,13 @@ describe('Aedes Broker TCP tests', function () {
 
     helper.load([aedesNode, mqttNode], flow, credentialsOK,
       function () {
-        const n2 = helper.getNode('n2');
-        n2.on('input', function (msg) {
-          msg.should.have.property('topic', 'clientReady');
-          done();
+        const n1 = helper.getNode('n1');
+        n1._initPromise.then(function () {
+          const n2 = helper.getNode('n2');
+          n2.on('input', function (msg) {
+            msg.should.have.property('topic', 'clientReady');
+            done();
+          });
         });
       });
   });
@@ -198,17 +209,20 @@ describe('Aedes Broker TCP tests', function () {
       }
     ],
     function () {
-      const n2 = helper.getNode('n2');
-      const n3 = helper.getNode('n3');
-      const n5 = helper.getNode('n5');
-      n2.on('input', function (msg) {
-        if (msg.topic === 'subscribe') {
-          n3.receive({ payload: 'test' });
-        }
-      });
-      n5.on('input', function (msg) {
-        msg.should.have.property('topic', 'test1883');
-        done();
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const n2 = helper.getNode('n2');
+        const n3 = helper.getNode('n3');
+        const n5 = helper.getNode('n5');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'subscribe') {
+            n3.receive({ payload: 'test' });
+          }
+        });
+        n5.on('input', function (msg) {
+          msg.should.have.property('topic', 'test1883');
+          done();
+        });
       });
     });
   });
@@ -267,22 +281,26 @@ describe('Aedes Broker TCP tests', function () {
       }
     ],
     function () {
-      let i = 0;
-      const n2 = helper.getNode('n2');
-      n2.on('input', function (msg) {
-        msg.should.have.property('topic', 'clientReady');
-        i++;
-        if (i === 2) {
-          done();
-        }
-      });
-      const n12 = helper.getNode('n12');
-      n12.on('input', function (msg) {
-        msg.should.have.property('topic', 'clientReady');
-        i++;
-        if (i === 2) {
-          done();
-        }
+      const n1 = helper.getNode('n1');
+      const n11 = helper.getNode('n11');
+      Promise.all([n1._initPromise, n11._initPromise]).then(function () {
+        let i = 0;
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          msg.should.have.property('topic', 'clientReady');
+          i++;
+          if (i === 2) {
+            done();
+          }
+        });
+        const n12 = helper.getNode('n12');
+        n12.on('input', function (msg) {
+          msg.should.have.property('topic', 'clientReady');
+          i++;
+          if (i === 2) {
+            done();
+          }
+        });
       });
     });
   });
@@ -334,18 +352,19 @@ describe('Aedes Broker TCP tests', function () {
       type: 'helper'
     }];
     helper.load(aedesNode, flow, function () {
-      const client = mqtt.connect('mqtt://localhost:1883', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
-      client.on('error', function (err) {
-        console.error('Error: ', err.toString());
-      });
-      client.on('connect', function () {
-        // console.log('External client connected');
-      });
-      const n2 = helper.getNode('n2');
-      n2.on('input', function (msg) {
-        msg.should.have.property('topic', 'clientReady');
-        client.end(function () {
-          done();
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect('mqtt://localhost:1883', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
+        client.on('error', logError);
+        client.on('connect', function () {
+          // console.log('External client connected');
+        });
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          msg.should.have.property('topic', 'clientReady');
+          client.end(function () {
+            done();
+          });
         });
       });
     });
@@ -387,27 +406,198 @@ describe('Aedes Broker TCP tests', function () {
       }
     ];
     helper.load([aedesNode, mqttNode], flow, function () {
-      const client = mqtt.connect('mqtt://localhost:1883', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
-      client.on('error', function (err) {
-        console.error('Error: ', err.toString());
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect('mqtt://localhost:1883', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
+        client.on('error', logError);
+        client.on('connect', function () {
+          // console.log('External client connected');
+        });
+        const n2 = helper.getNode('n2');
+        const n5 = helper.getNode('n5');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'subscribe') {
+            client.publish('test1883', 'test');
+          }
+        });
+        n5.on('input', function (msg) {
+          // console.log(msg);
+          msg.should.have.property('topic', 'test1883');
+          client.end(function () {
+            done();
+          });
+        });
+      });
+    });
+  });
+
+  it('should handle initialization failure gracefully', function (done) {
+    this.timeout(10000);
+    const net = require('net');
+    // Occupy port 1887 to force an EADDRINUSE
+    const blocker = net.createServer();
+    blocker.listen(1887, function () {
+      const flow = [{
+        id: 'n1',
+        type: 'aedes broker',
+        mqtt_port: '1887',
+        name: 'Aedes 1887',
+        wires: [[], []]
+      }];
+      helper.load(aedesNode, flow, function () {
+        const n1 = helper.getNode('n1');
+        n1._initPromise.then(function () {
+          // Init succeeded but server.listen should have fired an error
+          blocker.close(function () {
+            done();
+          });
+        }).catch(function () {
+          // Expected to fail
+          blocker.close(function () {
+            done();
+          });
+        });
       });
-      client.on('connect', function () {
-        // console.log('External client connected');
+    });
+  });
+
+  it('should emit clientDisconnect when a client disconnects', function (done) {
+    this.timeout(10000);
+    const flow = [
+      {
+        id: 'n1',
+        type: 'aedes broker',
+        mqtt_port: '1883',
+        name: 'Aedes 1883',
+        wires: [['n2'], []]
+      },
+      {
+        id: 'n2',
+        type: 'helper'
+      }
+    ];
+    helper.load(aedesNode, flow, function () {
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect('mqtt://localhost:1883', {
+          clientId: 'client-disconnect-test',
+          resubscribe: false,
+          reconnectPeriod: -1
+        });
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'clientReady') {
+            client.end();
+          } else if (msg.topic === 'clientDisconnect') {
+            should(msg.payload.client.id).equal('client-disconnect-test');
+            done();
+          }
+        });
       });
-      const n2 = helper.getNode('n2');
-      const n5 = helper.getNode('n5');
-      n2.on('input', function (msg) {
-        if (msg.topic === 'subscribe') {
-          client.publish('test1883', 'test');
-        }
+    });
+  });
+
+  it('should emit keepaliveTimeout when a client stops responding', function (done) {
+    this.timeout(10000);
+    const flow = [
+      {
+        id: 'n1',
+        type: 'aedes broker',
+        mqtt_port: '1883',
+        name: 'Aedes 1883',
+        wires: [['n2'], []]
+      },
+      {
+        id: 'n2',
+        type: 'helper'
+      }
+    ];
+    helper.load(aedesNode, flow, function () {
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const net = require('net');
+        const socket = net.createConnection({ port: 1883 }, function () {
+          // Send a minimal MQTT CONNECT packet with keepalive=1 second
+          const connectPacket = Buffer.from([
+            0x10, // CONNECT packet type
+            0x11, // Remaining length: 17
+            0x00, 0x04, // Protocol name length
+            0x4D, 0x51, 0x54, 0x54, // "MQTT"
+            0x04, // Protocol level 4 (MQTT 3.1.1)
+            0x02, // Connect flags (clean session)
+            0x00, 0x01, // Keep alive: 1 second
+            0x00, 0x05, // Client ID length: 5
+            0x6B, 0x61, 0x74, 0x65, 0x73 // "kates"
+          ]);
+          socket.write(connectPacket);
+          // Do not send any more data — keepalive will expire
+        });
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'keepaliveTimeout') {
+            should(msg.payload.client.id).equal('kates');
+            socket.destroy();
+            done();
+          }
+        });
       });
-      n5.on('input', function (msg) {
-        // console.log(msg);
-        msg.should.have.property('topic', 'test1883');
-        client.end(function () {
-          done();
+    });
+  });
+
+  it('should emit published messages on the 2nd output', function (done) {
+    this.timeout(10000);
+    const flow = [
+      {
+        id: 'n1',
+        type: 'aedes broker',
+        mqtt_port: '1883',
+        name: 'Aedes 1883',
+        wires: [[], ['n2']]
+      },
+      {
+        id: 'n2',
+        type: 'helper'
+      }
+    ];
+    helper.load(aedesNode, flow, function () {
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect('mqtt://localhost:1883', {
+          clientId: 'publish-test',
+          resubscribe: false,
+          reconnectPeriod: -1
+        });
+        client.on('connect', function () {
+          client.publish('testTopic', 'testPayload');
+        });
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          if (msg.payload.packet && msg.payload.packet.topic === 'testTopic') {
+            should(msg.topic).equal('publish');
+            should(msg.payload.packet.payload.toString()).equal('testPayload');
+            client.end(function () {
+              done();
+            });
+          }
         });
       });
     });
   });
+
+  it('should handle close during initialization', function (done) {
+    this.timeout(10000);
+    const flow = [{
+      id: 'n1',
+      type: 'aedes broker',
+      mqtt_port: '1888',
+      name: 'Aedes 1888',
+      wires: [[], []]
+    }];
+    helper.load(aedesNode, flow, function () {
+      // Immediately unload before init completes
+      helper.unload().then(function () {
+        done();
+      });
+    });
+  });
 });

package/test/aedes_ws_spec.js

@@ -4,6 +4,7 @@ const helper = require('node-red-node-test-helper');
 const aedesNode = require('../aedes.js');
 const mqttNode = require('../node_modules/node-red/node_modules/@node-red/nodes/core/network/10-mqtt.js');
 const mqtt = require('mqtt');
+const { logError } = require('./test-utils');
 
 helper.init(require.resolve('node-red'));
 
@@ -17,6 +18,43 @@ describe('Aedes Broker Websocket tests', function () {
     });
   });
 
+  it('should connect an external ws mqtt client', function (done) {
+    this.timeout(10000);
+    const flow = [
+      {
+        id: 'n1',
+        type: 'aedes broker',
+        mqtt_port: '1883',
+        mqtt_ws_port: '8080',
+        name: 'Aedes 1883',
+        wires: [['n2'], []]
+      },
+      {
+        id: 'n2',
+        type: 'helper'
+      }
+    ];
+    helper.load(aedesNode, flow, function () {
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect('ws://localhost:8080', {
+          clientId: 'ws-client',
+          resubscribe: false,
+          reconnectPeriod: -1
+        });
+        client.on('error', logError);
+        const n2 = helper.getNode('n2');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'clientReady') {
+            client.end(function () {
+              done();
+            });
+          }
+        });
+      });
+    });
+  });
+
   it('should not throw an exception with 2 servers on the same ws port', function (done) {
     this.timeout(10000); // have to wait for the inject with delay of two seconds
 
@@ -50,6 +88,35 @@ describe('Aedes Broker Websocket tests', function () {
     });
   });
 
+  it('should set error status when ws port is already in use', function (done) {
+    this.timeout(10000);
+    const net = require('net');
+    const blocker = net.createServer();
+    blocker.listen(8081, function () {
+      const flow = [{
+        id: 'n1',
+        type: 'aedes broker',
+        mqtt_port: '1883',
+        mqtt_ws_port: '8081',
+        name: 'Aedes WS Error',
+        wires: [[], []]
+      }];
+      helper.load(aedesNode, flow, function () {
+        const n1 = helper.getNode('n1');
+        n1.on('call:status', function (call) {
+          if (call.args[0].fill === 'red') {
+            call.args[0].should.have.property('fill', 'red');
+            call.args[0].should.have.property('shape', 'ring');
+            call.args[0].should.have.property('text', 'aedes-mqtt-broker.status.error');
+            blocker.close(function () {
+              done();
+            });
+          }
+        });
+      });
+    });
+  });
+
   it('a subscriber should receive a message from an external ws publisher', function (done) {
     this.timeout(10000); // have to wait for the inject with delay of 10 seconds
     const flow = [
@@ -87,25 +154,26 @@ describe('Aedes Broker Websocket tests', function () {
       }
     ];
     helper.load([aedesNode, mqttNode], flow, function () {
-      const client = mqtt.connect('ws://localhost:8080', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
-      client.on('error', function (err) {
-        console.error('Error: ', err.toString());
-      });
-      client.on('connect', function () {
-        // console.log('External client connected');
-      });
-      const n2 = helper.getNode('n2');
-      const n5 = helper.getNode('n5');
-      n2.on('input', function (msg) {
-        if (msg.topic === 'subscribe') {
-          client.publish('test1883', 'test');
-        }
-      });
-      n5.on('input', function (msg) {
-        // console.log(msg);
-        msg.should.have.property('topic', 'test1883');
-        client.end(function () {
-          done();
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect('ws://localhost:8080', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
+        client.on('error', logError);
+        client.on('connect', function () {
+          // console.log('External client connected');
+        });
+        const n2 = helper.getNode('n2');
+        const n5 = helper.getNode('n5');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'subscribe') {
+            client.publish('test1883', 'test');
+          }
+        });
+        n5.on('input', function (msg) {
+          // console.log(msg);
+          msg.should.have.property('topic', 'test1883');
+          client.end(function () {
+            done();
+          });
         });
       });
     });
@@ -150,25 +218,26 @@ describe('Aedes Broker Websocket tests', function () {
     ];
 
     helper.load([aedesNode, mqttNode], flow, function () {
-      const client = mqtt.connect(helper.url().replace(/http/, 'ws') + '/mqtt', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
-      client.on('error', function (err) {
-        console.error('Client on error: ', err.toString());
-      });
-      client.on('connect', function () {
-        // console.log('External client connected');
-      });
-      const n2 = helper.getNode('n2');
-      const n5 = helper.getNode('n5');
-      n2.on('input', function (msg) {
-        if (msg.topic === 'subscribe') {
-          client.publish('test1883', 'test');
-        }
-      });
-      n5.on('input', function (msg) {
-        // console.log(msg);
-        msg.should.have.property('topic', 'test1883');
-        client.end(function () {
-          done();
+      const n1 = helper.getNode('n1');
+      n1._initPromise.then(function () {
+        const client = mqtt.connect(helper.url().replace(/http/, 'ws') + '/mqtt', { clientId: 'client', resubscribe: false, reconnectPeriod: -1 });
+        client.on('error', logError);
+        client.on('connect', function () {
+          // console.log('External client connected');
+        });
+        const n2 = helper.getNode('n2');
+        const n5 = helper.getNode('n5');
+        n2.on('input', function (msg) {
+          if (msg.topic === 'subscribe') {
+            client.publish('test1883', 'test');
+          }
+        });
+        n5.on('input', function (msg) {
+          // console.log(msg);
+          msg.should.have.property('topic', 'test1883');
+          client.end(function () {
+            done();
+          });
         });
       });
     });

package/test/test-utils.js

@@ -0,0 +1,17 @@
+/* eslint no-console: ["error", { allow: ["log", "warn", "error"] }] */
+
+/**
+ * Logs detailed error information including AggregateError support.
+ * Useful for debugging Node-RED and MQTT client errors in tests.
+ */
+function logError (err) {
+  if (err instanceof AggregateError) {
+    console.error('AggregateError:', err.message);
+    console.error('Name:', err.name);
+    console.error('Errors:', err.errors);
+  } else {
+    console.error('Error:', err.message || err.toString());
+  }
+}
+
+module.exports = { logError };

package/docs/DEV-SETUP.md

@@ -1,86 +0,0 @@
-# Developer Setup Note
-
-After every `npm install` or `npm update`, re-link Node-RED:
-
-```bash
-sudo npm link node-red
-```
-
-`npm install` resets the `node_modules` directory and removes the symlink created by `npm link`. Without re-linking, the test helper cannot find Node-RED and tests will fail.
-
----
-
-## Backporting a fix to a legacy branch
-
-```bash
-# 1. Stash any WIP on current branch
-git stash push -m "WIP before backport"
-
-# 2. Switch to the legacy branch
-git checkout v0.15.x           # or: git checkout v11
-
-# 3. Cherry-pick the fix commit from the source branch
-git cherry-pick <commit-hash>  # resolve conflicts if any
-
-# 4. Run tests
-npm test
-
-# 5. Bump patch version and commit
-npm run patch                  # bumps version in package.json (no git tag)
-git add -A
-git commit -m "Bump patch version"
-
-# 6. Publish to npm (optional, with appropriate tag)
-npm publish --tag <tag>        # e.g. --tag legacy or --tag v11
-
-# 7. Return to working branch and restore WIP
-git checkout <working-branch>
-git stash pop
-```
-
-Notes:
-- Find the commit hash with `git log --oneline <source-branch>`.
-- If the cherry-pick has conflicts, resolve them, then `git cherry-pick --continue`.
-- `npm run patch` runs `npm --no-git-tag-version version patch` — it bumps the patch version in `package.json` without creating a git tag.
-- Use `--tag <tag>` with `npm publish` to avoid overwriting the `latest` tag on npm. Choose a tag that matches the branch (e.g. `legacy`, `v11`).
-
-### Example: Backport Tasks 6 and 7.1
-
-Each fix you want to backport needs its own separate commit on the source branch.
-
-```bash
-# 1. Commit each fix separately on the source branch
-git add aedes.js
-git commit -m "Fix: add removed parameter to close handler"    # Task 7.1
-
-git add aedes.js
-git commit -m "Fix: iterate subscribe/unsubscribe arrays"      # Task 6
-
-# 2. Find the commit hashes
-git log --oneline migrate-aedes-v1
-
-# 3. Backport to v0.15.x
-git stash push -m "WIP before backport"
-git checkout v0.15.x
-git cherry-pick <Task-7.1-commit>  # close handler: add removed parameter
-git cherry-pick <Task-6-commit>    # fix subscribe/unsubscribe event handlers
-npm test
-npm run patch
-git add -A && git commit -m "Bump patch version"
-npm publish --tag v0.15.x
-git push origin v0.15.x
-
-# 4. Backport to v11
-git checkout v11
-git cherry-pick <Task-7.1-commit>  # close handler: add removed parameter
-git cherry-pick <Task-6-commit>    # fix subscribe/unsubscribe event handlers
-npm test
-npm run patch
-git add -A && git commit -m "Bump patch version"
-npm publish --tag v11
-git push origin v11
-
-# 5. Return to working branch
-git checkout migrate-aedes-v1
-git stash pop
-```