aedes 0.46.3 → 0.48.0

package/test/bridge.js

@@ -0,0 +1,57 @@
+'use strict'
+
+const { test } = require('tap')
+const { setup, connect, subscribe } = require('./helper')
+
+for (const qos of [0, 1, 2]) {
+  const packet = {
+    qos,
+    cmd: 'publish',
+    topic: 'hello',
+    payload: 'world'
+  }
+
+  if (qos > 0) packet.messageId = 42
+
+  test('normal client sends a publish message and shall receive it back, qos = ' + qos, function (t) {
+    const s = connect(setup())
+    t.teardown(s.broker.close.bind(s.broker))
+
+    const handle = setTimeout(() => {
+      t.fail('did not receive packet back')
+      t.end()
+    }, 1000)
+
+    subscribe(t, s, 'hello', qos, function () {
+      s.outStream.on('data', (packet) => {
+        if (packet.cmd === 'publish') {
+          clearTimeout(handle)
+          t.end()
+        } else if (packet.cmd === 'pubrec') {
+          s.inStream.write({ cmd: 'pubrel', messageId: 42 })
+        }
+      })
+
+      s.inStream.write(packet)
+    })
+  })
+
+  test('bridge client sends a publish message but shall not receive it back, qos = ' + qos, function (t) {
+    // protocolVersion 128 + 4 means mqtt 3.1.1 with bridgeMode enabled
+    // https://github.com/mqttjs/mqtt-packet/blob/7f7c2ed8bcb4b2c582851d120a94e0b4a731f661/parser.js#L171
+    const s = connect(setup(), { clientId: 'my-client-bridge-1', protocolVersion: 128 + 4 })
+    t.teardown(s.broker.close.bind(s.broker))
+
+    const handle = setTimeout(() => t.end(), 1000)
+
+    subscribe(t, s, 'hello', qos, function () {
+      s.outStream.on('data', function () {
+        clearTimeout(handle)
+        t.fail('should not receive packet back')
+        t.end()
+      })
+
+      s.inStream.write(packet)
+    })
+  })
+}

package/test/client-pub-sub.js

@@ -905,10 +905,10 @@ test('should not receive a message on negated subscription', function (t) {
 test('programmatically add custom subscribe', function (t) {
   t.plan(6)
 
-  const broker = aedes()
+  const broker = aedes({ clientId: 'my-client-xyz-7' })
   t.teardown(broker.close.bind(broker))
 
-  const s = connect(setup(broker))
+  const s = connect(setup(broker), { clientId: 'my-client-xyz-7' })
   const expected = {
     cmd: 'publish',
     topic: 'hello',
@@ -924,7 +924,8 @@ test('programmatically add custom subscribe', function (t) {
     payload: Buffer.from('world'),
     qos: 0,
     retain: false,
-    dup: false
+    dup: false,
+    clientId: 'my-client-xyz-7'
   }
   subscribe(t, s, 'hello', 0, function () {
     broker.subscribe('hello', deliver, function () {
@@ -963,9 +964,10 @@ test('custom function in broker.subscribe', function (t) {
     qos: 1,
     retain: false,
     dup: false,
-    messageId: undefined
+    messageId: undefined,
+    clientId: 'my-client-xyz-6'
   }
-  connect(s, {}, function () {
+  connect(s, { clientId: 'my-client-xyz-6' }, function () {
     broker.subscribe('hello', deliver, function () {
       t.pass('subscribed')
     })

package/test/connect.js

@@ -214,13 +214,13 @@ test('client connect clear outgoing', function (t) {
   const broker = aedes({ id: brokerId })
   t.teardown(broker.close.bind(broker))
 
-  const subs = [{ clientId: clientId }]
+  const subs = [{ clientId }]
   const packet = {
     cmd: 'publish',
     topic: 'hello',
     payload: Buffer.from('world'),
     qos: 1,
-    brokerId: brokerId,
+    brokerId,
     brokerCounter: 2,
     retain: true,
     messageId: 42,
@@ -235,7 +235,7 @@ test('client connect clear outgoing', function (t) {
       protocolId: 'MQTT',
       protocolVersion: 4,
       clean: true,
-      clientId: clientId,
+      clientId,
       keepalive: 0
     })
 
@@ -705,7 +705,7 @@ test('websocket clients have access to the request object', function (t) {
 
   const server = http.createServer()
   ws.createServer({
-    server: server
+    server
   }, broker.handle)
 
   server.listen(port, function (err) {

package/test/events.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { test } = require('tap')
+const mqemitter = require('mqemitter')
 const { setup, connect, subscribe } = require('./helper')
 const aedes = require('../')
 
@@ -16,9 +17,49 @@ test('publishes an hearbeat', function (t) {
     const id = message.topic.match(/\$SYS\/([^/]+)\/heartbeat/)[1]
     t.equal(id, broker.id, 'broker id matches')
     t.same(message.payload.toString(), id, 'message has id as the payload')
+    cb()
   })
 })
 
+test('publishes birth', function (t) {
+  t.plan(4)
+
+  const mq = mqemitter()
+  const brokerId = 'test-broker'
+  const fakeBroker = 'fake-broker'
+  const clientId = 'test-client'
+
+  mq.on(`$SYS/${brokerId}/birth`, (message, cb) => {
+    t.pass('broker birth received')
+    t.same(message.payload.toString(), brokerId, 'message has id as the payload')
+    cb()
+  })
+
+  const broker = aedes({
+    id: brokerId,
+    mq
+  })
+
+  broker.on('client', (client) => {
+    t.equal(client.id, clientId, 'client connected')
+    // set a fake counter on a fake broker
+    process.nextTick(() => {
+      broker.clients[clientId].duplicates[fakeBroker] = 42
+      mq.emit({ topic: `$SYS/${fakeBroker}/birth`, payload: Buffer.from(fakeBroker) })
+    })
+  })
+
+  mq.on(`$SYS/${fakeBroker}/birth`, (message, cb) => {
+    process.nextTick(() => {
+      t.equal(!!broker.clients[clientId].duplicates[fakeBroker], false, 'client duplicates has been resetted')
+      cb()
+    })
+  })
+
+  const s = connect(setup(broker), { clientId })
+  t.teardown(s.broker.close.bind(s.broker))
+})
+
 ;['$mcollina', '$SYS'].forEach(function (topic) {
   test('does not forward $ prefixed topics to # subscription - ' + topic, function (t) {
     t.plan(4)
@@ -161,7 +202,7 @@ test('Test backpressure aedes published function', function (t) {
 
   server.listen(0, function () {
     const port = server.address().port
-    publisher = mqtt.connect({ port: port, host: 'localhost', clean: true, keepalive: 30 })
+    publisher = mqtt.connect({ port, host: 'localhost', clean: true, keepalive: 30 })
 
     function next () {
       if (--publishCount > 0) { process.nextTick(publish) }

package/test/helper.js

@@ -19,10 +19,10 @@ function setup (broker) {
 
   return {
     client: broker.handle(conn),
-    conn: conn,
-    inStream: inStream,
-    outStream: outStream,
-    broker: broker
+    conn,
+    inStream,
+    outStream,
+    broker
   }
 }
 
@@ -74,8 +74,8 @@ function subscribe (t, subscriber, topic, qos, done) {
     cmd: 'subscribe',
     messageId: 24,
     subscriptions: [{
-      topic: topic,
-      qos: qos
+      topic,
+      qos
     }]
   })
 
@@ -110,10 +110,10 @@ function subscribeMultiple (t, subscriber, subs, expectedGranted, done) {
 }
 
 module.exports = {
-  setup: setup,
-  connect: connect,
-  noError: noError,
-  subscribe: subscribe,
-  subscribeMultiple: subscribeMultiple,
+  setup,
+  connect,
+  noError,
+  subscribe,
+  subscribeMultiple,
   delay: util.promisify(setTimeout)
 }

package/test/meta.js

@@ -307,7 +307,7 @@ test('connect and connackSent event', { timeout: 50 }, function (t) {
     protocolId: 'MQTT',
     protocolVersion: 4,
     clean: true,
-    clientId: clientId,
+    clientId,
     keepalive: 0
   })
 

package/test/not-blocking.js

@@ -42,7 +42,7 @@ test('connect 500 concurrent clients', function (t) {
 
     for (let i = 0; i < total; i++) {
       clients[i] = mqtt.connect({
-        port: port,
+        port,
         keepalive: 0,
         reconnectPeriod: 100
       }).on('connect', function () {
@@ -79,7 +79,7 @@ test('do not block after a subscription', function (t) {
     const port = server.address().port
 
     const publisher = mqtt.connect({
-      port: port,
+      port,
       keepalive: 0
     }).on('error', function (err) {
       clock.clearTimeout(clockId)
@@ -103,7 +103,7 @@ test('do not block after a subscription', function (t) {
 
     function startSubscriber () {
       subscriber = mqtt.connect({
-        port: port,
+        port,
         keepalive: 0
       }).on('error', function (err) {
         clock.clearTimeout(clockId)
@@ -163,7 +163,7 @@ test('do not block with overlapping subscription', function (t) {
     const port = server.address().port
 
     const publisher = mqtt.connect({
-      port: port,
+      port,
       keepalive: 0
     }).on('error', function (err) {
       clock.clearTimeout(clockId)
@@ -187,7 +187,7 @@ test('do not block with overlapping subscription', function (t) {
 
     function startSubscriber () {
       subscriber = mqtt.connect({
-        port: port,
+        port,
         keepalive: 0
       }).on('error', function (err) {
         clock.clearTimeout(clockId)

package/test/qos2.js

@@ -239,7 +239,7 @@ test('call published method with client with QoS 2', function (t) {
     t.teardown(broker.close.bind(broker))
 
     const opts = { clean: cleanSession }
-    const publisher = connect(setup(broker))
+    const publisher = connect(setup(broker), { clientId: 'my-client-xyz-8' })
     const subscriber = connect(setup(broker), { ...opts, clientId: 'abcde' })
     const forwarded = {
       cmd: 'publish',
@@ -248,7 +248,8 @@ test('call published method with client with QoS 2', function (t) {
       qos: 2,
       retain: false,
       dup: false,
-      messageId: undefined
+      messageId: undefined,
+      clientId: 'my-client-xyz-8'
     }
     const expected = {
       cmd: 'publish',
@@ -262,6 +263,7 @@ test('call published method with client with QoS 2', function (t) {
     broker.authorizeForward = function (client, packet) {
       forwarded.brokerId = broker.id
       forwarded.brokerCounter = broker.counter
+      delete packet.nl
       t.same(packet, forwarded, 'forwarded packet must match')
       return packet
     }

package/test/retain.js

@@ -275,7 +275,7 @@ test('new QoS 0 subscribers receive QoS 0 retained messages when clean', functio
   })
 
   clock.setTimeout(() => {
-    t.equal(broker.counter, 8)
+    t.equal(broker.counter, 9)
   }, 200)
 })
 
@@ -315,7 +315,7 @@ test('new QoS 0 subscribers receive downgraded QoS 1 retained messages when clea
     })
   })
   broker.on('closed', function () {
-    t.equal(broker.counter, 7)
+    t.equal(broker.counter, 8)
   })
 })
 

package/test/topics.js

@@ -108,7 +108,7 @@ test('publish invalid topic with +', function (t) {
       cmd: 'subscribe',
       messageId: 24,
       subscriptions: [{
-        topic: topic,
+        topic,
         qos: 0
       }]
     })
@@ -157,7 +157,7 @@ test('topics are case-sensitive', function (t) {
     ;['hello', 'HELLO', 'heLLo', 'HELLO/#', 'hello/+'].forEach(function (topic) {
       publisher.inStream.write({
         cmd: 'publish',
-        topic: topic,
+        topic,
         payload: 'world',
         qos: 0,
         retain: false
@@ -171,7 +171,7 @@ function subscribeMultipleTopics (t, broker, qos, subscriber, subscriptions, don
   subscriber.inStream.write({
     cmd: 'subscribe',
     messageId: 24,
-    subscriptions: subscriptions
+    subscriptions
   })
 
   subscriber.outStream.once('data', function (packet) {
@@ -183,7 +183,7 @@ function subscribeMultipleTopics (t, broker, qos, subscriber, subscriptions, don
       cmd: 'publish',
       topic: 'hello/world',
       payload: 'world',
-      qos: qos,
+      qos,
       messageId: 42
     })
 

package/test/types/aedes.test-d.ts

@@ -1,17 +1,19 @@
+/// <reference path="../../aedes.d.ts" />
+
+import type { AedesPublishPacket, ConnackPacket, ConnectPacket, PingreqPacket, PublishPacket, PubrelPacket, SubscribePacket, Subscription, UnsubscribePacket } from 'aedes:packet'
+import type { AuthenticateError, Brokers, Connection } from 'aedes:server'
+import Server, { Aedes } from 'aedes:server'
+
+import { IncomingMessage } from 'node:http'
+import type { Client } from 'aedes:client'
+import { Socket } from 'node:net'
 import { expectType } from 'tsd'
-import { Socket } from 'net'
-import type {
-  Aedes,
-  Brokers,
-  AuthenticateError,
-  Client,
-  Connection
-} from '../../aedes'
-import { Server } from '../../aedes'
-import type { AedesPublishPacket, ConnackPacket, ConnectPacket, PingreqPacket, PublishPacket, PubrelPacket, Subscription, SubscribePacket, UnsubscribePacket } from '../../types/packet'
 
 // Aedes server
-const broker = Server({
+let broker = new Server()
+expectType<Aedes>(broker)
+
+broker = new Aedes({
   id: 'aedes',
   concurrency: 100,
   heartbeatInterval: 60000,
@@ -37,7 +39,7 @@ const broker = Server({
       callback(error, false)
     }
   },
-  authorizePublish: (client: Client, packet: PublishPacket, callback) => {
+  authorizePublish: (client: Client | null, packet: PublishPacket, callback) => {
     if (packet.topic === 'aaaa') {
       return callback(new Error('wrong topic'))
     }
@@ -93,7 +95,7 @@ expectType<Aedes>(broker.on('clientError', (client: Client, error: Error) => {})
 expectType<Aedes>(broker.on('connectionError', (client: Client, error: Error) => {}))
 expectType<Aedes>(broker.on('connackSent', (packet: ConnackPacket, client: Client) => {}))
 expectType<Aedes>(broker.on('ping', (packet: PingreqPacket, client: Client) => {}))
-expectType<Aedes>(broker.on('publish', (packet: AedesPublishPacket, client: Client) => {}))
+expectType<Aedes>(broker.on('publish', (packet: AedesPublishPacket, client: Client | null) => {}))
 expectType<Aedes>(broker.on('ack', (packet: PublishPacket | PubrelPacket, client: Client) => {}))
 expectType<Aedes>(broker.on('subscribe', (subscriptions: Subscription[], client: Client) => {}))
 expectType<Aedes>(broker.on('unsubscribe', (unsubscriptions: string[], client: Client) => {}))
@@ -123,11 +125,12 @@ expectType<void>(broker.close())
 expectType<void>(broker.close(() => {}))
 
 // Aedes client
-const client = broker.handle({} as Connection)
+const client = broker.handle({} as Connection, {} as IncomingMessage)
 
 expectType<Client>(client)
 
 expectType<Connection>(client.conn)
+expectType<IncomingMessage>(client.req!)
 
 expectType<Client>(client.on('connected', () => {}))
 expectType<Client>(client.on('error', (error: Error) => {

package/test/will.js

@@ -58,8 +58,11 @@ test('calling close two times should not deliver two wills', function (t) {
   willConnect(setup(broker), opts)
 
   function onWill (packet, cb) {
-    broker.mq.removeListener('mywill', onWill)
-    broker.mq.on('mywill', t.fail.bind(t))
+    broker.mq.removeListener('mywill', onWill, function () {
+      broker.mq.on('mywill', function (packet) {
+        t.fail('the will must be delivered only once')
+      })
+    })
     t.equal(packet.topic, opts.will.topic, 'topic matches')
     t.same(packet.payload, opts.will.payload, 'payload matches')
     t.equal(packet.qos, opts.will.qos, 'qos matches')
@@ -69,7 +72,7 @@ test('calling close two times should not deliver two wills', function (t) {
 })
 
 test('delivers old will in case of a crash', function (t) {
-  t.plan(6)
+  t.plan(8)
 
   const persistence = memory()
   const will = {
@@ -88,10 +91,16 @@ test('delivers old will in case of a crash', function (t) {
   }, will, function (err) {
     t.error(err, 'no error')
 
+    let authorized = false
     const interval = 10 // ms, so that the will check happens fast!
     const broker = aedes({
-      persistence: persistence,
-      heartbeatInterval: interval
+      persistence,
+      heartbeatInterval: interval,
+      authorizePublish: function (client, packet, callback) {
+        t.strictSame(client, null, 'client must be null')
+        authorized = true
+        callback(null)
+      }
     })
     t.teardown(broker.close.bind(broker))
 
@@ -100,15 +109,58 @@ test('delivers old will in case of a crash', function (t) {
     broker.mq.on('mywill', check)
 
     function check (packet, cb) {
-      broker.mq.removeListener('mywill', check)
+      broker.mq.removeListener('mywill', check, function () {
+        broker.mq.on('mywill', function (packet) {
+          t.fail('the will must be delivered only once')
+        })
+      })
       t.ok(Date.now() - start >= 3 * interval, 'the will needs to be emitted after 3 heartbeats')
       t.equal(packet.topic, will.topic, 'topic matches')
       t.same(packet.payload, will.payload, 'payload matches')
       t.equal(packet.qos, will.qos, 'qos matches')
       t.equal(packet.retain, will.retain, 'retain matches')
-      broker.mq.on('mywill', function (packet) {
-        t.fail('the will must be delivered only once')
-      })
+      t.equal(authorized, true, 'authorization called')
+      cb()
+    }
+  })
+})
+
+test('deliver old will without authorization in case of a crash', function (t) {
+  t.plan(2)
+
+  const persistence = memory()
+  const will = {
+    topic: 'mywill',
+    payload: Buffer.from('last will'),
+    qos: 0,
+    retain: false
+  }
+
+  persistence.broker = {
+    id: 'anotherBroker'
+  }
+
+  persistence.putWill({
+    id: 'myClientId42'
+  }, will, function (err) {
+    t.error(err, 'no error')
+
+    const interval = 10 // ms, so that the will check happens fast!
+    const broker = aedes({
+      persistence,
+      heartbeatInterval: interval,
+      authorizePublish: function (client, packet, callback) {
+        t.strictSame(client, null, 'client must be null')
+        callback(new Error())
+      }
+    })
+
+    t.teardown(broker.close.bind(broker))
+
+    broker.mq.on('mywill', check)
+
+    function check (packet, cb) {
+      t.fail('received will without authorization')
       cb()
     }
   })
@@ -121,7 +173,7 @@ test('delete old broker', function (t) {
 
   const heartbeatInterval = 100
   const broker = aedes({
-    heartbeatInterval: heartbeatInterval
+    heartbeatInterval
   })
   t.teardown(broker.close.bind(broker))
 
@@ -185,8 +237,7 @@ test('delete the will in the persistence after publish', function (t) {
   willConnect(setup(broker), opts)
 
   function check (packet, cb) {
-    broker.mq.removeListener('mywill', check)
-    setImmediate(function () {
+    broker.mq.removeListener('mywill', check, function () {
       broker.persistence.getWill({
         id: opts.clientId
       }, function (err, p) {
@@ -421,7 +472,7 @@ test('don\'t delivers a will if broker alive', function (t) {
     t.error(err, 'no error')
 
     const opts = {
-      persistence: persistence,
+      persistence,
       heartbeatInterval: 10
     }
 
@@ -472,7 +523,7 @@ test('handle will publish error', function (t) {
     t.error(err, 'no error')
 
     const opts = {
-      persistence: persistence,
+      persistence,
       heartbeatInterval: 10
     }
 
@@ -509,7 +560,7 @@ test('handle will publish error 2', function (t) {
     t.error(err, 'no error')
 
     const opts = {
-      persistence: persistence,
+      persistence,
       heartbeatInterval: 10
     }
 

package/types/.eslintrc.json

@@ -1,7 +1,6 @@
 {
   "extends": [
     "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "standard"
   ],
@@ -15,16 +14,19 @@
     "createDefaultProgram": true
   },
   "rules": {
+    "linebreak-style": ["warn", "unix"],
     "no-console": "off",
-    "@typescript-eslint/indent": ["error", 2],
     "semi": ["error", "never"],
-    "import/export": "off" // this errors on multiple exports (overload interfaces)
+    "import/export": "off", // this errors on multiple exports (overload interfaces)
+    "@typescript-eslint/indent": ["error", 2]
   },
   "overrides": [
     {
-      "files": ["*.d.ts","*.test-d.ts"],
+      "files": ["*.d.ts", "*.test-d.ts"],
       "rules": {
-        "@typescript-eslint/no-explicit-any": "off"
+        "no-dupe-class-members": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/triple-slash-reference": "off"
       }
     },
     {

package/types/client.d.ts

@@ -1,27 +1,32 @@
-import { IncomingMessage } from 'http'
-import { PublishPacket, SubscribePacket, Subscription, Subscriptions, UnsubscribePacket } from './packet'
-import { Connection } from './instance'
-import { EventEmitter } from 'events'
+declare module 'client' {
+  import { IncomingMessage } from 'node:http'
+  import { PublishPacket, SubscribePacket, Subscription, Subscriptions, UnsubscribePacket } from 'aedes:packet'
+  import { Connection } from 'aedes:server'
+  import { EventEmitter } from 'node:events'
 
-export interface Client extends EventEmitter {
-  id: Readonly<string>
-  clean: Readonly<boolean>
-  version: Readonly<number>
-  conn: Connection
-  req?: IncomingMessage
-  connecting: Readonly<boolean>
-  connected: Readonly<boolean>
-  closed: Readonly<boolean>
+  export interface Client extends EventEmitter {
+    id: Readonly<string>
+    clean: Readonly<boolean>
+    version: Readonly<number>
+    conn: Connection
+    req?: IncomingMessage
+    connecting: Readonly<boolean>
+    connected: Readonly<boolean>
+    closed: Readonly<boolean>
 
-  on (event: 'connected', listener: () => void): this
-  on (event: 'error', listener: (error: Error) => void): this
+    on (event: 'connected', listener: () => void): this
+    on (event: 'error', listener: (error: Error) => void): this
 
-  publish (message: PublishPacket, callback?: (error?: Error) => void): void
-  subscribe (
-    subscriptions: Subscriptions | Subscription | Subscription[] | SubscribePacket,
-    callback?: (error?: Error) => void
-  ): void
-  unsubscribe (topicObjects: Subscriptions | Subscription | Subscription[] | UnsubscribePacket, callback?: (error?: Error) => void): void
-  close (callback?: () => void): void
-  emptyOutgoingQueue (callback?: () => void): void
+    publish (message: PublishPacket, callback?: (error?: Error) => void): void
+    subscribe (
+      subscriptions: Subscriptions | Subscription | Subscription[] | SubscribePacket,
+      callback?: (error?: Error) => void
+    ): void
+    unsubscribe (topicObjects: Subscriptions | Subscription | Subscription[] | UnsubscribePacket, callback?: (error?: Error) => void): void
+    close (callback?: () => void): void
+    emptyOutgoingQueue (callback?: () => void): void
+  }
+}
+declare module 'aedes:client' {
+  export * from 'client'
 }