aedes 0.50.0 → 0.51.0

package/.github/workflows/ci.yml

@@ -41,7 +41,7 @@ jobs:
           persist-credentials: false
 
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           check-latest: true

package/.github/workflows/sast.yml

@@ -22,8 +22,8 @@ jobs:
         with:
           persist-credentials: false
 
-      - uses: github/codeql-action/init@v2
+      - uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
 
-      - uses: github/codeql-action/analyze@v2
+      - uses: github/codeql-action/analyze@v3

package/aedes.d.ts

@@ -1,12 +1,9 @@
 import Aedes, { AedesOptions } from './types/instance'
 
-export declare function createBroker (options?: AedesOptions): Aedes
+export declare function createBroker(options?: AedesOptions): Aedes
 
 export * from './types/instance'
 export * from './types/packet'
 export * from './types/client'
-export default Aedes
 
-declare module 'aedes' {
-  export = Aedes
-}
+export { default } from './types/instance'

package/aedes.js

@@ -29,7 +29,8 @@ const defaultOptions = {
   trustProxy: false,
   trustedProxies: [],
   queueLimit: 42,
-  maxClientsIdLength: 23
+  maxClientsIdLength: 23,
+  keepaliveLimit: 0
 }
 
 function Aedes (opts) {
@@ -47,6 +48,7 @@ function Aedes (opts) {
   this.counter = 0
   this.queueLimit = opts.queueLimit
   this.connectTimeout = opts.connectTimeout
+  this.keepaliveLimit = opts.keepaliveLimit
   this.maxClientsIdLength = opts.maxClientsIdLength
   this.mq = opts.mq || mqemitter({
     concurrency: opts.concurrency,
@@ -168,7 +170,13 @@ function Aedes (opts) {
     const clientId = packet.payload.toString()
 
     if (that.clients[clientId] && serverId !== that.id) {
-      that.clients[clientId].close(done)
+      if (that.clients[clientId].closed) {
+        // remove the client from the list if it is already closed
+        delete that.clients[clientId]
+        done()
+      } else {
+        that.clients[clientId].close(done)
+      }
     } else {
       done()
     }

package/docs/Aedes.md

@@ -42,6 +42,7 @@
   - `heartbeatInterval` `<number>` an interval in millisconds at which server beats its health signal in `$SYS/<aedes.id>/heartbeat` topic. __Default__: `60000`
   - `id` `<string>` aedes broker unique identifier. __Default__: `uuidv4()`
   - `connectTimeout` `<number>` maximum waiting time in milliseconds waiting for a [`CONNECT`][CONNECT] packet. __Default__: `30000`
+  - `keepaliveLimit` `<number>` maximum client keep alive time allowed, 0 means no limit. __Default__: `0`
 - Returns `<Aedes>`
 
 Create a new Aedes server.

package/lib/handlers/connect.js

@@ -36,7 +36,8 @@ const errorMessages = [
   'identifier rejected',
   'Server unavailable',
   'bad user name or password',
-  'not authorized'
+  'not authorized',
+  'keep alive limit exceeded'
 ]
 
 function handleConnect (client, packet, done) {
@@ -66,9 +67,14 @@ function init (client, packet, done) {
   if (packet.protocolVersion === 3 && clientId.length > client.broker.maxClientsIdLength) {
     returnCode = 2
   }
+  // check if the client keepalive is compatible with broker settings
+  if (client.broker.keepaliveLimit && (!packet.keepalive || packet.keepalive > client.broker.keepaliveLimit)) {
+    returnCode = 6
+  }
   if (returnCode > 0) {
     const error = new Error(errorMessages[returnCode])
     error.errorCode = returnCode
+    console.error(error)
     doConnack(
       { client, returnCode, sessionPresent: false },
       done.bind(this, error))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aedes",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "description": "Stream-based MQTT broker",
   "main": "aedes.js",
   "types": "aedes.d.ts",
@@ -126,7 +126,7 @@
     "fastseries": "^2.0.0",
     "hyperid": "^3.1.1",
     "mqemitter": "^5.0.0",
-    "mqtt-packet": "^8.2.0",
+    "mqtt-packet": "^9.0.0",
     "retimer": "^3.0.0",
     "reusify": "^1.0.4",
     "uuid": "^9.0.0"

package/test/connect.js

@@ -97,6 +97,40 @@ test('reject client requested for unsupported protocol version', function (t) {
   })
 })
 
+test('reject clients that exceed the keepalive limit', function (t) {
+  t.plan(3)
+
+  const broker = aedes({
+    keepaliveLimit: 100
+  })
+  t.teardown(broker.close.bind(broker))
+
+  const s = setup(broker)
+
+  s.inStream.write({
+    cmd: 'connect',
+    keepalive: 150
+  })
+  s.outStream.on('data', function (packet) {
+    console.log(packet)
+    t.same(packet, {
+      cmd: 'connack',
+      returnCode: 6,
+      length: 2,
+      qos: 0,
+      retain: false,
+      dup: false,
+      topic: null,
+      payload: null,
+      sessionPresent: false
+    }, 'unsuccessful connack, keep alive limit exceeded')
+  })
+  broker.on('connectionError', function (client, err) {
+    t.equal(err.message, 'keep alive limit exceeded')
+    t.equal(broker.connectedClients, 0)
+  })
+})
+
 // Guarded in mqtt-packet
 test('reject clients with no clientId running on MQTT 3.1.0', function (t) {
   t.plan(3)

package/test/events.js

@@ -221,3 +221,20 @@ test('Test backpressure aedes published function', function (t) {
     })
   })
 })
+
+test('clear closed clients when the same clientId is managed by another broker', function (t) {
+  t.plan(1)
+
+  const clientId = 'closed-client'
+  const broker = aedes()
+
+  // simulate a closed client on the broker
+  broker.clients[clientId] = { closed: true }
+
+  // simulate the creation of the same client on another broker of the cluster
+  broker.publish({ topic: '$SYS/anotherbroker/new/clients', payload: clientId }, () => {
+    t.equal(broker.clients[clientId], undefined) // check that the closed client was removed
+  })
+
+  t.teardown(broker.close.bind(broker))
+})

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

@@ -6,10 +6,13 @@ import type {
   Client,
   Connection
 } from '../../aedes'
-import Aedes, { createBroker } from '../../aedes'
+import Aedes, { AedesOptions, createBroker } from '../../aedes'
 import type { AedesPublishPacket, ConnackPacket, ConnectPacket, PingreqPacket, PublishPacket, PubrelPacket, Subscription, SubscribePacket, UnsubscribePacket } from '../../types/packet'
 import { expectType } from 'tsd'
 
+// Test for createBroker function
+expectType<(options?: AedesOptions) => Aedes>(createBroker)
+
 // Aedes server
 let broker = createBroker()
 expectType<Aedes>(broker)
@@ -20,6 +23,7 @@ broker = new Aedes({
   heartbeatInterval: 60000,
   connectTimeout: 30000,
   maxClientsIdLength: 23,
+  keepaliveLimit: 0,
   preConnect: (client: Client, packet: ConnectPacket, callback) => {
     if (client.req) {
       callback(new Error('not websocket stream'), false)

package/types/instance.d.ts

@@ -75,6 +75,7 @@ export interface AedesOptions {
   concurrency?: number;
   heartbeatInterval?: number;
   connectTimeout?: number;
+  keepaliveLimit?: number;
   queueLimit?: number;
   maxClientsIdLength?: number;
   preConnect?: PreConnectHandler;