aedes 0.47.0 → 0.48.0

package/.github/workflows/ci.yml

@@ -11,21 +11,39 @@ on:
       - '*.md'
 
 jobs:
+  dependency-review:
+    name: Dependency Review
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+        - name: Check out repo
+          uses: actions/checkout@v3
+          with:
+            persist-credentials: false
+
+        - name: Dependency review
+          uses: actions/dependency-review-action@v2
+
   test:
     runs-on: ${{ matrix.os }}
-
+    permissions:
+      contents: read
     strategy:
       matrix:
-        node-version: [14.x, 16.x, "*"]
+        node-version: [14, 16, '*']
         os: [ubuntu-latest, windows-latest, macOS-latest]
-
     steps:
       - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
 
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+          check-latest: true
 
       - name: Install
         run: |
@@ -49,6 +67,8 @@ jobs:
   coverage:
     needs: test
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - name: Coveralls Finished
         uses: coverallsapp/github-action@master

package/.github/workflows/sast.yml

@@ -0,0 +1,29 @@
+name: sast
+
+on:
+  push:
+    branches-ignore:
+      - 'dependabot/**'
+  pull_request:
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: true
+      matrix:
+        language: [ 'javascript' ]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+
+      - uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+
+      - uses: github/codeql-action/analyze@v2

package/README.md

@@ -107,7 +107,7 @@ Brokers that support the [Bridge Protocol][bridge_protocol] can connect to
 Aedes.  When connecting with this special protocol, subscriptions work as usual
 except that the `retain` flag in the packet is propagated as-is.
 
-## Exensions
+## Extensions
 
 - [aedes-logging]: Logging module for Aedes, based on Pino
 - [aedes-stats]: Stats for Aedes

package/aedes.d.ts

@@ -1,9 +1,3 @@
-import { Aedes, AedesOptions } from './types/instance'
-
-export declare function aedes (options?: AedesOptions): Aedes
-export declare function Server (options?: AedesOptions): Aedes
-
-export * from './types/instance'
-export * from './types/packet'
-export * from './types/client'
-export default aedes
+/// <reference path="./types/instance.d.ts" />
+/// <reference path="./types/client.d.ts" />
+/// <reference path="./types/packet.d.ts" />

package/aedes.js

@@ -79,10 +79,19 @@ function Aedes (opts) {
   this.brokers = {}
 
   const heartbeatTopic = $SYS_PREFIX + that.id + '/heartbeat'
+  const birthTopic = $SYS_PREFIX + that.id + '/birth'
+
   this._heartbeatInterval = setInterval(heartbeat, opts.heartbeatInterval)
 
   const bufId = Buffer.from(that.id, 'utf8')
 
+  // in a cluster env this is used to warn other broker instances
+  // that this broker is alive
+  that.publish({
+    topic: birthTopic,
+    payload: bufId
+  }, noop)
+
   function heartbeat () {
     that.publish({
       topic: heartbeatTopic,
@@ -115,27 +124,25 @@ function Aedes (opts) {
   }
 
   function checkAndPublish (will, done) {
-    const needsPublishing =
-      !that.brokers[will.brokerId] ||
-      that.brokers[will.brokerId] + (3 * opts.heartbeatInterval) <
-      Date.now()
-
-    if (needsPublishing) {
-      // randomize this, so that multiple brokers
-      // do not publish the same wills at the same time
-      that.publish(will, function publishWill (err) {
-        if (err) {
-          return done(err)
-        }
+    const notPublish =
+      that.brokers[will.brokerId] !== undefined && that.brokers[will.brokerId] + (3 * opts.heartbeatInterval) >= Date.now()
 
+    if (notPublish) return done()
+
+    // randomize this, so that multiple brokers
+    // do not publish the same wills at the same time
+    this.authorizePublish(that.clients[will.clientId] || null, will, function (err) {
+      if (err) { return doneWill() }
+      that.publish(will, doneWill)
+
+      function doneWill (err) {
+        if (err) { return done(err) }
         that.persistence.delWill({
           id: will.clientId,
           brokerId: will.brokerId
         }, done)
-      })
-    } else {
-      done()
-    }
+      }
+    })
   }
 
   this.mq.on($SYS_PREFIX + '+/heartbeat', function storeBroker (packet, done) {
@@ -143,6 +150,19 @@ function Aedes (opts) {
     done()
   })
 
+  this.mq.on($SYS_PREFIX + '+/birth', function brokerBorn (packet, done) {
+    const brokerId = packet.payload.toString()
+
+    // reset duplicates counter
+    if (brokerId !== that.id) {
+      for (const clientId in that.clients) {
+        delete that.clients[clientId].duplicates[brokerId]
+      }
+    }
+
+    done()
+  })
+
   this.mq.on($SYS_PREFIX + '+/new/clients', function closeSameClients (packet, done) {
     const serverId = packet.topic.split('/')[1]
     const clientId = packet.payload.toString()

package/docs/Aedes.md

@@ -186,7 +186,7 @@ const server = require('net').createServer(aedes.handle)
 
 Directly subscribe a `topic` in server side. Bypass [`authorizeSubscribe`](#handler-authorizesubscribe-client-subscription-callback)
 
-The `topic` and `deliverfunc` is a compound key to differentiate the uniqueness of its subscription pool. `topic` could be the one that is existed, in this case `deliverfunc` will be invoked as well as `SUBSCRIBE` does.
+The `topic` and `deliverfunc` is a compound key to differentiate the uniqueness of its subscription pool. `topic` could be the one that is existed, in this case `deliverfunc` will be invoked as well as [`SUBSCRIBE`][SUBSCRIBE] does.
 
 `deliverfunc` supports backpressue.
 
@@ -291,7 +291,7 @@ Please refer to [Connect Return Code](http://docs.oasis-open.org/mqtt/mqtt/v3.1.
 
 ## Handler: authorizePublish (client, packet, callback)
 
-- client: [`<Client>`](./Client.md)
+- client: [`<Client>`](./Client.md) | `null`
 - packet: `<object>` [`PUBLISH`][PUBLISH]
 - callback: `<Function>` `(error) => void`
   - error `<Error>` | `null`
@@ -301,6 +301,8 @@ Invoked when
 1. publish LWT to all online clients
 2. incoming client publish
 
+`client` is `null` when aedes publishes obsolete LWT without connected clients
+
 If invoked `callback` with no errors, server authorizes the packet otherwise emits `clientError` with `error`. If an `error` occurs the client connection will be closed, but no error is returned to the client (MQTT-3.3.5-2)
 
 ```js
@@ -337,7 +339,7 @@ function defaultAuthorizePublish (client, packet, callback) {
 Invoked when
 
 1. restore subscriptions in non-clean session.
-2. incoming client `SUBSCRIBE`
+2. incoming client [`SUBSCRIBE`][SUBSCRIBE]
 
 `subscription` is a dictionary object like `{ topic: hello, qos: 0 }`.
 

package/lib/handlers/connect.js

@@ -70,7 +70,7 @@ function init (client, packet, done) {
     const error = new Error(errorMessages[returnCode])
     error.errorCode = returnCode
     doConnack(
-      { client: client, returnCode: returnCode, sessionPresent: false },
+      { client, returnCode, sessionPresent: false },
       done.bind(this, error))
     return
   }
@@ -156,8 +156,8 @@ function fetchSubs (arg, done) {
   if (!this.packet.clean) {
     client.broker.persistence.subscriptionsByClient({
       id: client.id,
-      done: done,
-      arg: arg
+      done,
+      arg
     }, gotSubs)
     return
   }

package/lib/handlers/subscribe.js

@@ -217,7 +217,7 @@ function completeSubscribe (err) {
     topic: $SYS_PREFIX + broker.id + '/new/subscribes',
     payload: Buffer.from(JSON.stringify({
       clientId: client.id,
-      subs: subs
+      subs
     }), 'utf8')
   }, noop)
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "aedes",
-  "version": "0.47.0",
+  "version": "0.48.0",
   "description": "Stream-based MQTT broker",
   "main": "aedes.js",
   "types": "aedes.d.ts",
   "scripts": {
     "lint": "npm run lint:standard && npm run lint:typescript && npm run lint:markdown",
-    "lint:fix": "standard --fix",
+    "lint:fix": "standard --fix && eslint -c types/.eslintrc.json --fix aedes.d.ts types/**/*.ts test/types/**/*.test-d.ts",
     "lint:standard": "standard --verbose | snazzy",
     "lint:typescript": "eslint -c types/.eslintrc.json aedes.d.ts types/**/*.ts test/types/**/*.test-d.ts",
     "lint:markdown": "markdownlint docs/*.md README.md",
@@ -98,37 +98,37 @@
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "^9.1.2",
-    "@types/node": "^17.0.24",
-    "@typescript-eslint/eslint-plugin": "^5.19.0",
-    "@typescript-eslint/parser": "^5.19.0",
+    "@types/node": "^18.6.1",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
+    "@typescript-eslint/parser": "^5.31.0",
     "concat-stream": "^2.0.0",
     "duplexify": "^4.1.2",
     "license-checker": "^25.0.1",
-    "markdownlint-cli": "^0.31.1",
+    "markdownlint-cli": "^0.32.1",
     "mqtt": "^4.3.7",
     "mqtt-connection": "^4.1.0",
     "pre-commit": "^1.2.2",
     "proxyquire": "^2.1.3",
-    "release-it": "^14.14.2",
+    "release-it": "^15.2.0",
     "snazzy": "^9.0.0",
-    "standard": "^16.0.4",
-    "tap": "^16.0.1",
-    "tsd": "^0.20.0",
-    "typescript": "^4.6.3",
+    "standard": "^17.0.0",
+    "tap": "^16.3.0",
+    "tsd": "^0.23.0",
+    "typescript": "^4.7.4",
     "websocket-stream": "^5.5.2"
   },
   "dependencies": {
     "aedes-packet": "^3.0.0",
-    "aedes-persistence": "^9.1.1",
+    "aedes-persistence": "^9.1.2",
     "end-of-stream": "^1.4.4",
     "fastfall": "^1.5.1",
     "fastparallel": "^2.4.1",
     "fastseries": "^2.0.0",
     "hyperid": "^3.0.1",
-    "mqemitter": "^4.5.0",
-    "mqtt-packet": "^7.1.2",
+    "mqemitter": "^5.0.0",
+    "mqtt-packet": "^8.1.1",
     "retimer": "^3.0.0",
     "reusify": "^1.0.4",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.0"
   }
 }

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/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'
 }

package/types/instance.d.ts

@@ -1,100 +1,101 @@
-import { Duplex } from 'stream'
-import { Socket } from 'net'
-import { Client } from './client'
-import type { AedesPublishPacket, ConnectPacket, ConnackPacket, Subscription, PingreqPacket, PublishPacket, PubrelPacket } from './packet'
-import { EventEmitter } from 'events'
-
-type LastHearthbeatTimestamp = Date;
-
-export interface Brokers {
-  [brokerId: string]: LastHearthbeatTimestamp;
-}
-
-export type Connection = Duplex | Socket
-
-/* eslint no-unused-vars: 0 */
-export const enum AuthErrorCode {
-  UNNACCEPTABLE_PROTOCOL = 1,
-  IDENTIFIER_REJECTED = 2,
-  SERVER_UNAVAILABLE = 3,
-  BAD_USERNAME_OR_PASSWORD = 4,
-  NOT_AUTHORIZED = 5
-}
-
-export type AuthenticateError = Error & { returnCode: AuthErrorCode }
-
-type PreConnectHandler = (client: Client, packet: ConnectPacket, callback: (error: Error | null, success: boolean) => void) => void
-
-type AuthenticateHandler = (
-  client: Client,
-  username: Readonly<string>,
-  password: Readonly<Buffer>,
-  done: (error: AuthenticateError | null, success: boolean | null) => void
-) => void
-
-type AuthorizePublishHandler = (client: Client, packet: PublishPacket, callback: (error?: Error | null) => void) => void
-
-type AuthorizeSubscribeHandler = (client: Client, subscription: Subscription, callback: (error: Error | null, subscription?: Subscription | null) => void) => void
-
-type AuthorizeForwardHandler = (client: Client, packet: AedesPublishPacket) => AedesPublishPacket | null | void
-
-type PublishedHandler = (packet: AedesPublishPacket, client: Client, callback: (error?: Error | null) => void) => void
-
-export interface AedesOptions {
-  mq?: any
-  id?: string
-  persistence?: any
-  concurrency?: number
-  heartbeatInterval?: number
-  connectTimeout?: number
-  queueLimit?: number
-  maxClientsIdLength?: number
-  preConnect?: PreConnectHandler
-  authenticate?: AuthenticateHandler
-  authorizePublish?: AuthorizePublishHandler
-  authorizeSubscribe?: AuthorizeSubscribeHandler
-  authorizeForward?: AuthorizeForwardHandler
-  published?: PublishedHandler
+declare module 'aedes' {
+  import { Duplex } from 'node:stream'
+  import { Socket } from 'node:net'
+  import { IncomingMessage } from 'http'
+  import { Client } from 'aedes:client'
+  import type { AedesPublishPacket, ConnectPacket, ConnackPacket, Subscription, PingreqPacket, PublishPacket, PubrelPacket } from 'aedes:packet'
+  import { EventEmitter } from 'node:events'
+
+  type LastHearthbeatTimestamp = Date;
+
+  export interface Brokers {
+    [brokerId: string]: LastHearthbeatTimestamp;
+  }
+
+  export type Connection = Duplex | Socket
+
+  /* eslint no-unused-vars: 0 */
+  export const enum AuthErrorCode {
+    UNNACCEPTABLE_PROTOCOL = 1,
+    IDENTIFIER_REJECTED = 2,
+    SERVER_UNAVAILABLE = 3,
+    BAD_USERNAME_OR_PASSWORD = 4,
+    NOT_AUTHORIZED = 5
+  }
+
+  export type AuthenticateError = Error & { returnCode: AuthErrorCode }
+
+  type PreConnectHandler = (client: Client, packet: ConnectPacket, callback: (error: Error | null, success: boolean) => void) => void
+
+  type AuthenticateHandler = (
+    client: Client,
+    username: Readonly<string>,
+    password: Readonly<Buffer>,
+    done: (error: AuthenticateError | null, success: boolean | null) => void
+  ) => void
+
+  type AuthorizePublishHandler = (client: Client | null, packet: PublishPacket, callback: (error?: Error | null) => void) => void
+
+  type AuthorizeSubscribeHandler = (client: Client, subscription: Subscription, callback: (error: Error | null, subscription?: Subscription | null) => void) => void
+
+  type AuthorizeForwardHandler = (client: Client, packet: AedesPublishPacket) => AedesPublishPacket | null | void
+
+  type PublishedHandler = (packet: AedesPublishPacket, client: Client, callback: (error?: Error | null) => void) => void
+
+  export interface AedesOptions {
+    mq?: any
+    id?: string
+    persistence?: any
+    concurrency?: number
+    heartbeatInterval?: number
+    connectTimeout?: number
+    queueLimit?: number
+    maxClientsIdLength?: number
+    preConnect?: PreConnectHandler
+    authenticate?: AuthenticateHandler
+    authorizePublish?: AuthorizePublishHandler
+    authorizeSubscribe?: AuthorizeSubscribeHandler
+    authorizeForward?: AuthorizeForwardHandler
+    published?: PublishedHandler
+  }
+
+  export default class Aedes extends EventEmitter {
+    id: Readonly<string>
+    connectedClients: Readonly<number>
+    closed: Readonly<boolean>
+    brokers: Readonly<Brokers>
+
+    constructor(option?: AedesOptions)
+    handle: (stream: Connection, request: IncomingMessage) => Client
+
+    on (event: 'closed', listener: () => void): this
+    on (event: 'client' | 'clientReady' | 'clientDisconnect' | 'keepaliveTimeout', listener: (client: Client) => void): this
+    on (event: 'clientError' | 'connectionError', listener: (client: Client, error: Error) => void): this
+    on (event: 'connackSent', listener: (packet: ConnackPacket, client: Client) => void): this
+    on (event: 'ping', listener: (packet: PingreqPacket, client: Client) => void): this
+    on (event: 'publish', listener: (packet: AedesPublishPacket, client: Client | null) => void): this
+    on (event: 'ack', listener: (packet: PublishPacket | PubrelPacket, client: Client) => void): this
+    on (event: 'subscribe', listener: (subscriptions: Subscription[], client: Client) => void): this
+    on (event: 'unsubscribe', listener: (unsubscriptions: string[], client: Client) => void): this
+
+    publish (packet: PublishPacket, callback: (error?: Error) => void): void
+    subscribe (topic: string, deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void, callback: () => void): void
+    unsubscribe (topic: string, deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void, callback: () => void): void
+    close (callback?: () => void): void
+
+    preConnect: PreConnectHandler
+    authenticate: AuthenticateHandler
+    authorizePublish: AuthorizePublishHandler
+    authorizeSubscribe: AuthorizeSubscribeHandler
+    authorizeForward: AuthorizeForwardHandler
+    published: PublishedHandler
+  }
+
+  export { Aedes }
+  // export function createServer(options?: AedesOptions): Aedes
 }
 
-export interface Aedes extends EventEmitter {
-  id: Readonly<string>
-  connectedClients: Readonly<number>
-  closed: Readonly<boolean>
-  brokers: Readonly<Brokers>
-
-  handle: (stream: Connection) => Client
-
-  on (event: 'closed', listener: () => void): this
-  on (event: 'client' | 'clientReady' | 'clientDisconnect' | 'keepaliveTimeout', listener: (client: Client) => void): this
-  on (event: 'clientError' | 'connectionError', listener: (client: Client, error: Error) => void): this
-  on (event: 'connackSent', listener: (packet: ConnackPacket, client: Client) => void): this
-  on (event: 'ping', listener: (packet: PingreqPacket, client: Client) => void): this
-  on (event: 'publish', listener: (packet: AedesPublishPacket, client: Client) => void): this
-  on (event: 'ack', listener: (packet: PublishPacket | PubrelPacket, client: Client) => void): this
-  on (event: 'subscribe', listener: (subscriptions: Subscription[], client: Client) => void): this
-  on (event: 'unsubscribe', listener: (unsubscriptions: string[], client: Client) => void): this
-
-  publish (
-    packet: PublishPacket,
-    callback: (error?: Error) => void
-  ): void
-  subscribe (
-    topic: string,
-    deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void,
-    callback: () => void
-  ): void
-  unsubscribe (
-    topic: string,
-    deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void,
-    callback: () => void
-  ): void
-  close (callback?: () => void): void
-
-  preConnect: PreConnectHandler
-  authenticate: AuthenticateHandler
-  authorizePublish: AuthorizePublishHandler
-  authorizeSubscribe: AuthorizeSubscribeHandler
-  authorizeForward: AuthorizeForwardHandler
-  published: PublishedHandler
+declare module 'aedes:server' {
+  export * from 'aedes'
+  export { default } from 'aedes'
 }

package/types/packet.d.ts

@@ -1,18 +1,23 @@
-import { AedesPacket } from 'aedes-packet'
-import { IConnackPacket, IConnectPacket, IPingreqPacket, IPublishPacket, IPubrelPacket, ISubscribePacket, ISubscription, IUnsubscribePacket } from 'mqtt-packet'
-import { Client } from './client'
+declare module 'packet' {
+  import { AedesPacket } from 'aedes-packet'
+  import { IConnackPacket, IConnectPacket, IPingreqPacket, IPublishPacket, IPubrelPacket, ISubscribePacket, ISubscription, IUnsubscribePacket } from 'mqtt-packet'
+  import { Client } from 'aedes:client'
 
-export type SubscribePacket = ISubscribePacket & { cmd: 'subscribe' }
-export type UnsubscribePacket = IUnsubscribePacket & { cmd: 'unsubscribe' }
-export type Subscription = ISubscription & { clientId?: Client['id'] }
-export type Subscriptions = { subscriptions: Subscription[] }
+  export type SubscribePacket = ISubscribePacket & { cmd: 'subscribe' }
+  export type UnsubscribePacket = IUnsubscribePacket & { cmd: 'unsubscribe' }
+  export type Subscription = ISubscription & { clientId?: Client['id'] }
+  export type Subscriptions = { subscriptions: Subscription[] }
 
-export type PublishPacket = IPublishPacket & { cmd: 'publish' }
+  export type PublishPacket = IPublishPacket & { cmd: 'publish' }
 
-export type ConnectPacket = IConnectPacket & { cmd: 'connect' }
-export type ConnackPacket = IConnackPacket & { cmd: 'connack' }
+  export type ConnectPacket = IConnectPacket & { cmd: 'connect' }
+  export type ConnackPacket = IConnackPacket & { cmd: 'connack' }
 
-export type PubrelPacket = IPubrelPacket & { cmd: 'pubrel' }
-export type PingreqPacket = IPingreqPacket & { cmd: 'pingreq' }
+  export type PubrelPacket = IPubrelPacket & { cmd: 'pubrel' }
+  export type PingreqPacket = IPingreqPacket & { cmd: 'pingreq' }
 
-export type AedesPublishPacket = PublishPacket & AedesPacket
+  export type AedesPublishPacket = PublishPacket & AedesPacket
+}
+declare module 'aedes:packet' {
+  export * from 'packet'
+}

package/types/tsconfig.json

@@ -1,13 +1,15 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
     "target": "es6",
+    "module": "commonjs",
     "noEmit": true,
-    "strict": true
+    "strict": true,
+    "removeComments": true,
+    "typeRoots" : ["../types", "../node_modules/@types/"]
   },
   "include": [
-    "/test/types/*.test-d.ts",
-    "/types/*.d.ts",
+    "./test/types/*.test-d.ts",
+    "./types/*.d.ts",
     "aedes.d.ts"
   ]
 }