aedes 0.51.3 → 1.0.1

package/types/instance.d.ts

@@ -1,6 +1,6 @@
 import { Duplex } from 'node:stream'
 import { Socket } from 'node:net'
-import { IncomingMessage } from 'http'
+import { IncomingMessage } from 'node:http'
 import { Client } from './client'
 import type {
   AedesPublishPacket,
@@ -13,13 +13,13 @@ import type {
 } from './packet'
 import { EventEmitter } from 'node:events'
 
-type LastHearthbeatTimestamp = Date;
+type LastHearthbeatTimestamp = Date
 
 export interface Brokers {
   [brokerId: string]: LastHearthbeatTimestamp;
 }
 
-export type Connection = Duplex | Socket;
+export type Connection = Duplex | Socket
 
 /* eslint no-unused-vars: 0 */
 export const enum AuthErrorCode {
@@ -30,43 +30,43 @@ export const enum AuthErrorCode {
   NOT_AUTHORIZED = 5,
 }
 
-export type AuthenticateError = Error & { returnCode: AuthErrorCode };
+export type AuthenticateError = Error & { returnCode: AuthErrorCode }
 
 type PreConnectHandler = (
   client: Client,
   packet: ConnectPacket,
   callback: (error: Error | null, success: boolean) => void
-) => void;
+) => void
 
 type AuthenticateHandler = (
   client: Client,
   username: Readonly<string | undefined>,
   password: Readonly<Buffer | undefined>,
   done: (error: AuthenticateError | null, success: boolean | null) => void
-) => void;
+) => void
 
 type AuthorizePublishHandler = (
   client: Client | null,
   packet: PublishPacket,
   callback: (error?: Error | null) => void
-) => void;
+) => void
 
 type AuthorizeSubscribeHandler = (
   client: Client,
   subscription: Subscription,
   callback: (error: Error | null, subscription?: Subscription | null) => void
-) => void;
+) => void
 
 type AuthorizeForwardHandler = (
   client: Client,
   packet: AedesPublishPacket
-) => AedesPublishPacket | null | void;
+) => AedesPublishPacket | null | void
 
 type PublishedHandler = (
   packet: AedesPublishPacket,
   client: Client,
   callback: (error?: Error | null) => void
-) => void;
+) => void
 
 export interface AedesOptions {
   mq?: any;
@@ -75,6 +75,7 @@ export interface AedesOptions {
   concurrency?: number;
   heartbeatInterval?: number;
   connectTimeout?: number;
+  drainTimeout?: number; // default: 60000 (60 seconds)
   keepaliveLimit?: number;
   queueLimit?: number;
   maxClientsIdLength?: number;
@@ -86,70 +87,74 @@ export interface AedesOptions {
   published?: PublishedHandler;
 }
 
-export default class Aedes extends EventEmitter {
+export class Aedes extends EventEmitter {
   id: Readonly<string>
   connectedClients: Readonly<number>
   closed: Readonly<boolean>
   brokers: Readonly<Brokers>
 
-  constructor(option?: AedesOptions);
+  constructor (option?: AedesOptions)
   handle: (stream: Connection, request?: IncomingMessage) => Client
 
-  on(event: 'closed', listener: () => void): this;
-  on(
+  on (event: 'closed', listener: () => void): this
+  on (
     event: 'client' | 'clientReady' | 'clientDisconnect' | 'keepaliveTimeout',
     listener: (client: Client) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'clientError' | 'connectionError',
     listener: (client: Client, error: Error) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'connackSent',
     listener: (packet: ConnackPacket, client: Client) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'ping',
     listener: (packet: PingreqPacket, client: Client) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'publish',
     listener: (packet: AedesPublishPacket, client: Client | null) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'ack',
     listener: (packet: PublishPacket | PubrelPacket, client: Client) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'subscribe',
     listener: (subscriptions: Subscription[], client: Client) => void
-  ): this;
+  ): this
 
-  on(
+  on (
     event: 'unsubscribe',
     listener: (unsubscriptions: string[], client: Client) => void
-  ): this;
+  ): this
 
-  publish(packet: PublishPacket, callback: (error?: Error) => void): void;
-  subscribe(
+  listen (): Promise<void>
+
+  static createBroker (option?: AedesOptions): Promise<Aedes>
+
+  publish (packet: PublishPacket, callback: (error?: Error) => void): void
+  subscribe (
     topic: string,
     deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void,
     callback: () => void
-  ): void;
+  ): void
 
-  unsubscribe(
+  unsubscribe (
     topic: string,
     deliverfunc: (packet: AedesPublishPacket, callback: () => void) => void,
     callback: () => void
-  ): void;
+  ): void
 
-  close(callback?: () => void): void;
+  close (callback?: () => void): void
 
   preConnect: PreConnectHandler
   authenticate: AuthenticateHandler

package/types/packet.d.ts

@@ -11,17 +11,17 @@ import {
 } from 'mqtt-packet'
 import { Client } from './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

package/.coveralls.yml

@@ -1 +0,0 @@
-repo_token: 0zzWBuyAWoQxHHR0JQ4jdZ12CPdvhiolr

package/benchmarks/bombing.js

@@ -1,34 +0,0 @@
-#! /usr/bin/env node
-
-const mqtt = require('mqtt')
-const client = mqtt.connect({ port: 1883, host: 'localhost', clean: true, keepalive: 0 })
-const interval = 5000
-
-let sent = 0
-
-function count () {
-  console.log('sent/s', sent / interval * 1000)
-  sent = 0
-}
-
-setInterval(count, interval)
-
-function immediatePublish () {
-  setImmediate(publish)
-}
-
-function publish () {
-  sent++
-  client.publish('test', 'payload', immediatePublish)
-}
-
-client.on('connect', publish)
-
-client.on('offline', function () {
-  console.log('offline')
-})
-
-client.on('error', function () {
-  console.log('reconnect!')
-  client.stream.end()
-})

package/benchmarks/bombingQoS1.js

@@ -1,36 +0,0 @@
-#! /usr/bin/env node
-
-const mqtt = require('mqtt')
-const client = mqtt.connect({ port: 1883, host: 'localhost', clean: true, keepalive: 0 })
-const interval = 5000
-
-let sent = 0
-
-function count () {
-  console.log('sent/s', sent / interval * 1000)
-  sent = 0
-}
-
-setInterval(count, interval)
-
-function publish () {
-  sent++
-  client.publish('test', 'payload', { qos: 1 }, publish)
-}
-
-client.setMaxListeners(100)
-
-client.on('connect', function () {
-  for (let i = 0; i < 50; i++) {
-    publish()
-  }
-})
-
-client.on('offline', function () {
-  console.log('offline')
-})
-
-client.on('error', function () {
-  console.log('reconnect!')
-  client.stream.end()
-})

package/benchmarks/throughputCounter.js

@@ -1,23 +0,0 @@
-#! /usr/bin/env node
-
-const mqtt = require('mqtt')
-
-const client = mqtt.connect({ port: 1883, host: 'localhost', clean: true, encoding: 'binary', keepalive: 0 })
-const interval = 5000
-
-let counter = 0
-
-function count () {
-  console.log('received/s', counter / interval * 1000)
-  counter = 0
-}
-
-setInterval(count, interval)
-
-client.on('connect', function () {
-  count()
-  this.subscribe('test')
-  this.on('message', function () {
-    counter++
-  })
-})

package/benchmarks/throughputCounterQoS1.js

@@ -1,33 +0,0 @@
-#! /usr/bin/env node
-
-const mqtt = require('mqtt')
-
-const client = mqtt.connect({ port: 1883, host: 'localhost', clean: true, encoding: 'binary', keepalive: 0 })
-const interval = 5000
-
-let counter = 0
-
-function count () {
-  console.log('received/s', counter / interval * 1000)
-  counter = 0
-}
-
-setInterval(count, interval)
-
-client.on('connect', function () {
-  this.subscribe('test', { qos: 1 })
-})
-
-client.handleMessage = function (packet, done) {
-  counter++
-  done()
-}
-
-client.on('offline', function () {
-  console.log('offline')
-})
-
-client.on('error', function () {
-  console.log('reconnect!')
-  client.stream.end()
-})

package/types/.eslintrc.json

@@ -1,47 +0,0 @@
-{
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "standard"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"],
-  "env": { "node": true },
-  "parserOptions": {
-    "ecmaVersion": 6,
-    "sourceType": "module",
-    "project": "./types/tsconfig.json",
-    "createDefaultProgram": true
-  },
-  "rules": {
-    "linebreak-style": ["warn", "unix"],
-    "no-console": "off",
-    "semi": ["error", "never"],
-    "import/export": "off", // this errors on multiple exports (overload interfaces)
-    "@typescript-eslint/indent": ["error", 2]
-  },
-  "overrides": [
-    {
-      "files": ["*.d.ts", "*.test-d.ts"],
-      "rules": {
-        "no-dupe-class-members": "off",
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/triple-slash-reference": "off"
-      }
-    },
-    {
-      "files": ["*.test-d.ts"],
-      "rules": {
-        "no-unused-vars": "off",
-        "node/handle-callback-err": "off",
-        "@typescript-eslint/no-empty-function": "off",
-        "@typescript-eslint/explicit-function-return-type": "off",
-        "@typescript-eslint/no-unused-vars": "off",
-        "@typescript-eslint/no-non-null-assertion": "off"
-      },
-      "globals": {
-        "NodeJS": "readonly"
-      }
-    }
-  ]
-}