aedes 0.51.3 → 1.0.0

package/lib/handlers/connect.js

@@ -1,22 +1,26 @@
-'use strict'
+import retimer from 'retimer'
+import { pipeline } from 'stream'
+import write from '../write.js'
+import QoSPacket from '../qos-packet.js'
+import { through } from '../utils.js'
+import handleSubscribe from './subscribe.js'
+import hyperid from 'hyperid'
 
-const retimer = require('retimer')
-const { pipeline } = require('stream')
-const write = require('../write')
-const QoSPacket = require('../qos-packet')
-const { through } = require('../utils')
-const handleSubscribe = require('./subscribe')
-const uniqueId = require('hyperid')()
+const uniqueId = hyperid()
 
-function Connack (arg) {
-  this.cmd = 'connack'
-  this.returnCode = arg.returnCode
-  this.sessionPresent = arg.sessionPresent
+class Connack {
+  constructor (arg) {
+    this.cmd = 'connack'
+    this.returnCode = arg.returnCode
+    this.sessionPresent = arg.sessionPresent
+  }
 }
 
-function ClientPacketStatus (client, packet) {
-  this.client = client
-  this.packet = packet
+class ClientPacketStatus {
+  constructor (client, packet) {
+    this.client = client
+    this.packet = packet
+  }
 }
 
 const connectActions = [
@@ -159,24 +163,22 @@ function setKeepAlive (arg, done) {
 function fetchSubs (arg, done) {
   const client = this.client
   if (!this.packet.clean) {
-    client.broker.persistence.subscriptionsByClient({
+    const subsClient = {
       id: client.id,
       done,
       arg
-    }, gotSubs)
+    }
+    client.broker.persistence.subscriptionsByClient({ id: client.id })
+      .then(subs => gotSubs(subs, subsClient), subsClient.done)
     return
   }
   arg.sessionPresent = false // [MQTT-3.2.2-1]
-  client.broker.persistence.cleanSubscriptions(
-    client,
-    done)
+  client.broker.persistence.cleanSubscriptions(client)
+    .then(() => done(null), done)
 }
 
-function gotSubs (err, subs, client) {
-  if (err) {
-    return client.done(err)
-  }
-  client.arg.subs = subs
+function gotSubs (subs, client) {
+  client.arg.subs = subs.length > 0 ? subs : null
   client.done()
 }
 
@@ -194,16 +196,15 @@ function storeWill (arg, done) {
   const client = this.client
   client.will = client._will
   // delete any existing will messages from persistence
-  client.broker.persistence.delWill(client, function () {
-    if (client.will) {
-      client.broker.persistence.putWill(
-        client,
-        client.will,
-        done)
-    } else {
-      done()
-    }
-  })
+  client.broker.persistence.delWill(client)
+    .finally(() => {
+      if (client.will) {
+        client.broker.persistence.putWill(client, client.will)
+          .then(() => done(null, client), done)
+      } else {
+        done()
+      }
+    })
 }
 
 function registerClient (arg, done) {
@@ -242,7 +243,9 @@ function emptyQueue (arg, done) {
       // Object filled the buffer up to the highWaterMark preventing stored messages
       // being sent
       packet.writeCallback = (error, _client) => next(error)
-      persistence.outgoingUpdate(client, packet, emptyQueueFilter)
+      const filter = (err) => emptyQueueFilter(err, client, packet)
+      persistence.outgoingUpdate(client, packet)
+        .then(() => filter(null, client, packet), err => filter(err, client, packet))
     }),
     done
   )
@@ -263,10 +266,11 @@ function emptyQueueFilter (err, client, packet) {
   const persistence = client.broker.persistence
 
   if (client.clean || !authorized) {
-    persistence.outgoingClearMessageId(client, packet, next)
+    persistence.outgoingClearMessageId(client, packet)
+      .then(packet => next(null, packet), next)
   } else {
     write(client, packet, next)
   }
 }
 
-module.exports = handleConnect
+export default handleConnect

package/lib/handlers/index.js

@@ -1,13 +1,11 @@
-'use strict'
-
-const handleConnect = require('./connect')
-const handleSubscribe = require('./subscribe')
-const handleUnsubscribe = require('./unsubscribe')
-const handlePublish = require('./publish')
-const handlePuback = require('./puback')
-const handlePubrel = require('./pubrel')
-const handlePubrec = require('./pubrec')
-const handlePing = require('./ping')
+import handleConnect from './connect.js'
+import handleSubscribe from './subscribe.js'
+import handleUnsubscribe from './unsubscribe.js'
+import handlePublish from './publish.js'
+import handlePuback from './puback.js'
+import handlePubrel from './pubrel.js'
+import handlePubrec from './pubrec.js'
+import handlePing from './ping.js'
 
 function handle (client, packet, done) {
   if (packet.cmd === 'connect') {
@@ -74,4 +72,4 @@ function finish (conn, packet, done) {
   done(error)
 }
 
-module.exports = handle
+export default handle

package/lib/handlers/ping.js

@@ -1,6 +1,5 @@
-'use strict'
+import write from '../write.js'
 
-const write = require('../write')
 const pingResp = {
   cmd: 'pingresp'
 }
@@ -10,4 +9,4 @@ function handlePing (client, packet, done) {
   write(client, pingResp, done)
 }
 
-module.exports = handlePing
+export default handlePing

package/lib/handlers/puback.js

@@ -1,11 +1,11 @@
-'use strict'
-
 function handlePuback (client, packet, done) {
   const persistence = client.broker.persistence
-  persistence.outgoingClearMessageId(client, packet, function (err, origPacket) {
+  const emitAck = (err, origPacket) => {
     client.broker.emit('ack', origPacket, client)
     done(err)
-  })
+  }
+  persistence.outgoingClearMessageId(client, packet)
+    .then((packet) => emitAck(null, packet), emitAck)
 }
 
-module.exports = handlePuback
+export default handlePuback

package/lib/handlers/publish.js

@@ -1,15 +1,17 @@
-'use strict'
+import write from '../write.js'
 
-const write = require('../write')
-
-function PubAck (packet) {
-  this.cmd = 'puback'
-  this.messageId = packet.messageId
+class PubAck {
+  constructor (packet) {
+    this.cmd = 'puback'
+    this.messageId = packet.messageId
+  }
 }
 
-function PubRec (packet) {
-  this.cmd = 'pubrec'
-  this.messageId = packet.messageId
+class PubRec {
+  constructor (packet) {
+    this.cmd = 'pubrec'
+    this.messageId = packet.messageId
+  }
 }
 
 const publishActions = [
@@ -39,10 +41,23 @@ function enqueuePublish (packet, done) {
 
   switch (packet.qos) {
     case 2:
-      client.broker.persistence.incomingStorePacket(client, packet, function (err) {
-        if (err) { return done(err) }
-        write(client, new PubRec(packet), done)
-      })
+      // MQTT-4.3.3-2: Check if we already have this packet by messageId
+      client.broker.persistence.incomingGetPacket(client, packet)
+        .then(() => {
+          // Duplicate packet: just send PUBREC, don't publish again
+          write(client, new PubRec(packet), done)
+        }, () => {
+          // New packet (not found in store): store first, then publish
+          // This ensures if storage fails, message hasn't been delivered yet
+          // preventing duplicate delivery on retransmission
+          client.broker.persistence.incomingStorePacket(client, packet)
+            .then(() => {
+              client.broker.publish(packet, client, (err) => {
+                if (err) { return done(err) }
+                write(client, new PubRec(packet), done)
+              })
+            }, done)
+        })
       break
     case 1:
       write(client, new PubAck(packet), function (err) {
@@ -62,4 +77,4 @@ function authorizePublish (packet, done) {
   this.broker.authorizePublish(this, packet, done)
 }
 
-module.exports = handlePublish
+export default handlePublish

package/lib/handlers/pubrec.js

@@ -1,10 +1,10 @@
-'use strict'
+import write from '../write.js'
 
-const write = require('../write')
-
-function PubRel (packet) {
-  this.cmd = 'pubrel'
-  this.messageId = packet.messageId
+class PubRel {
+  constructor (packet) {
+    this.cmd = 'pubrel'
+    this.messageId = packet.messageId
+  }
 }
 
 function handlePubrec (client, packet, done) {
@@ -15,16 +15,8 @@ function handlePubrec (client, packet, done) {
     return
   }
 
-  client.broker.persistence.outgoingUpdate(
-    client, pubrel, reply)
-
-  function reply (err) {
-    if (err) {
-      done(err)
-    } else {
-      write(client, pubrel, done)
-    }
-  }
+  client.broker.persistence.outgoingUpdate(client, pubrel)
+    .then(() => write(client, pubrel, done), done)
 }
 
-module.exports = handlePubrec
+export default handlePubrec

package/lib/handlers/pubrel.js

@@ -1,22 +1,23 @@
-'use strict'
+import write from '../write.js'
 
-const write = require('../write')
-
-function ClientPacketStatus (client, packet) {
-  this.client = client
-  this.packet = packet
+class ClientPacketStatus {
+  constructor (client, packet) {
+    this.client = client
+    this.packet = packet
+  }
 }
 
-function PubComp (packet) {
-  this.cmd = 'pubcomp'
-  this.messageId = packet.messageId
+class PubComp {
+  constructor (packet) {
+    this.cmd = 'pubcomp'
+    this.messageId = packet.messageId
+  }
 }
 
 const pubrelActions = [
   pubrelGet,
-  pubrelPublish,
-  pubrelWrite,
-  pubrelDel
+  pubrelDelete,
+  pubrelWrite
 ]
 function handlePubrel (client, packet, done) {
   client.broker._series(
@@ -25,26 +26,34 @@ function handlePubrel (client, packet, done) {
 }
 
 function pubrelGet (arg, done) {
+  // MQTT-4.3.3-2: Check if we have this packet in persistence
   const persistence = this.client.broker.persistence
-  persistence.incomingGetPacket(this.client, this.packet, reply)
+  persistence.incomingGetPacket(this.client, this.packet)
+    .then((packet) => {
+      arg.packet = this.packet
+      arg.foundInStore = !!packet
+      done(null, arg)
+    }, () => {
+      // Even if incomingGetPacket fails, continue to send PUBCOMP
+      arg.packet = this.packet
+      arg.foundInStore = false
+      done(null, arg)
+    })
+}
 
-  function reply (err, packet) {
-    arg.packet = packet
-    done(err)
+function pubrelDelete (arg, done) {
+  // Only delete if we found the packet in the store
+  if (!arg.foundInStore) {
+    return done(null, arg)
   }
-}
 
-function pubrelPublish (arg, done) {
-  this.client.broker.publish(arg.packet, this.client, done)
+  const persistence = this.client.broker.persistence
+  persistence.incomingDelPacket(this.client, arg.packet).finally(() => done(null, arg))
 }
 
 function pubrelWrite (arg, done) {
+  // Always send PUBCOMP, even if packet was not found in store
   write(this.client, new PubComp(arg.packet), done)
 }
 
-function pubrelDel (arg, done) {
-  const persistence = this.client.broker.persistence
-  persistence.incomingDelPacket(this.client, arg.packet, done)
-}
-
-module.exports = handlePubrel
+export default handlePubrel

package/lib/handlers/subscribe.js

@@ -1,10 +1,7 @@
-'use strict'
-
-const fastfall = require('fastfall')
-const Packet = require('aedes-packet')
-const { through } = require('../utils')
-const { validateTopic, $SYS_PREFIX } = require('../utils')
-const write = require('../write')
+import fastfall from 'fastfall'
+import Packet from 'aedes-packet'
+import { through, validateTopic, $SYS_PREFIX } from '../utils.js'
+import write from '../write.js'
 
 const subscribeTopicActions = fastfall([
   authorize,
@@ -16,47 +13,55 @@ const restoreTopicActions = fastfall([
   addSubs
 ])
 
-function SubAck (packet, granted) {
-  this.cmd = 'suback'
-  this.messageId = packet.messageId
-  // the qos granted
-  this.granted = granted
+class SubAck {
+  constructor (packet, granted) {
+    this.cmd = 'suback'
+    this.messageId = packet.messageId
+    // the qos granted
+    this.granted = granted
+  }
 }
 
-function Subscription (qos, func, rh, rap, nl) {
-  this.qos = qos
-  this.func = func
+class Subscription {
+  constructor (qos, func, rh, rap, nl) {
+    this.qos = qos
+    this.func = func
 
-  // retain-handling indicates how retained messages should be
-  // handled when a new subscription is created
-  // (see [MQTT-3.3.1-9] through [MQTT-3.3.1-11])
-  this.rh = rh
+    // retain-handling indicates how retained messages should be
+    // handled when a new subscription is created
+    // (see [MQTT-3.3.1-9] through [MQTT-3.3.1-11])
+    this.rh = rh
 
-  // retain-as-published indicates whether to leave the retain flag as-is (true)
-  // or to clear it before sending to subscriptions (false) default false
-  // (see [MQTT-3.3.1-12] through [MQTT-3.3.1-13])
-  this.rap = rap
+    // retain-as-published indicates whether to leave the retain flag as-is (true)
+    // or to clear it before sending to subscriptions (false) default false
+    // (see [MQTT-3.3.1-12] through [MQTT-3.3.1-13])
+    this.rap = rap
 
-  // no-local indicates that a client should not receive its own
-  // messages (see [MQTT-3.8.3-3])
-  this.nl = nl
+    // no-local indicates that a client should not receive its own
+    // messages (see [MQTT-3.8.3-3])
+    this.nl = nl
+  }
 }
 
-function SubscribeState (client, packet, restore, finish) {
-  this.client = client
-  this.packet = packet
-  this.actions = restore ? restoreTopicActions : subscribeTopicActions
-  this.finish = finish
-  this.subState = []
+class SubscribeState {
+  constructor (client, packet, restore, finish) {
+    this.client = client
+    this.packet = packet
+    this.actions = restore ? restoreTopicActions : subscribeTopicActions
+    this.finish = finish
+    this.subState = []
+  }
 }
 
-function SubState (client, packet, granted, rh, rap, nl) {
-  this.client = client
-  this.packet = packet
-  this.granted = granted
-  this.rh = rh
-  this.rap = rap
-  this.nl = nl
+class SubState {
+  constructor (client, packet, granted, rh, rap, nl) {
+    this.client = client
+    this.packet = packet
+    this.granted = granted
+    this.rh = rh
+    this.rap = rap
+    this.nl = nl
+  }
 }
 
 // if same subscribed topic in subs array, we pick up the last one
@@ -123,9 +128,8 @@ function storeSubscriptions (sub, done) {
     return done(null, sub)
   }
 
-  client.broker.persistence.addSubscriptions(client, packet.subscriptions, function addSub (err) {
-    done(err, sub)
-  })
+  client.broker.persistence.addSubscriptions(client, packet.subscriptions)
+    .then(() => done(null, sub), err => done(err, sub))
 }
 
 function addSubs (sub, done) {
@@ -252,4 +256,4 @@ function completeSubscribe (err) {
 
 function noop () { }
 
-module.exports = handleSubscribe
+export default handleSubscribe

package/lib/handlers/unsubscribe.js

@@ -1,17 +1,19 @@
-'use strict'
+import write from '../write.js'
+import { validateTopic, $SYS_PREFIX } from '../utils.js'
 
-const write = require('../write')
-const { validateTopic, $SYS_PREFIX } = require('../utils')
-
-function UnSubAck (packet) {
-  this.cmd = 'unsuback'
-  this.messageId = packet.messageId // [MQTT-3.10.4-4]
+class UnSubAck {
+  constructor (packet) {
+    this.cmd = 'unsuback'
+    this.messageId = packet.messageId // [MQTT-3.10.4-4]
+  }
 }
 
-function UnsubscribeState (client, packet, finish) {
-  this.client = client
-  this.packet = packet
-  this.finish = finish
+class UnsubscribeState {
+  constructor (client, packet, finish) {
+    this.client = client
+    this.packet = packet
+    this.finish = finish
+  }
 }
 
 function handleUnsubscribe (client, packet, done) {
@@ -31,13 +33,8 @@ function handleUnsubscribe (client, packet, done) {
       return actualUnsubscribe(client, packet, done)
     }
 
-    broker.persistence.removeSubscriptions(client, unsubscriptions, function (err) {
-      if (err) {
-        return done(err)
-      }
-
-      actualUnsubscribe(client, packet, done)
-    })
+    broker.persistence.removeSubscriptions(client, unsubscriptions)
+      .then(() => actualUnsubscribe(client, packet, done), done)
   } else {
     actualUnsubscribe(client, packet, done)
   }
@@ -101,4 +98,4 @@ function completeUnsubscribe (err) {
 
 function noop () { }
 
-module.exports = handleUnsubscribe
+export default handleUnsubscribe

package/lib/qos-packet.js

@@ -1,25 +1,22 @@
-'use strict'
+import Packet from 'aedes-packet'
 
-const Packet = require('aedes-packet')
-const util = require('util')
+class QoSPacket extends Packet {
+  constructor (original, client) {
+    super(original, client.broker)
 
-function QoSPacket (original, client) {
-  Packet.call(this, original, client.broker)
+    this.writeCallback = client._onError.bind(client)
 
-  this.writeCallback = client._onError.bind(client)
-
-  if (!original.messageId) {
-    this.messageId = client._nextId
-    if (client._nextId >= 65535) {
-      client._nextId = 1
+    if (!original.messageId) {
+      this.messageId = client._nextId
+      if (client._nextId >= 65535) {
+        client._nextId = 1
+      } else {
+        client._nextId++
+      }
     } else {
-      client._nextId++
+      this.messageId = original.messageId
     }
-  } else {
-    this.messageId = original.messageId
   }
 }
 
-util.inherits(QoSPacket, Packet)
-
-module.exports = QoSPacket
+export default QoSPacket

package/lib/utils.js

@@ -1,8 +1,6 @@
-'use strict'
+import { Transform, Writable } from 'stream'
 
-const { Transform, Writable } = require('stream')
-
-function validateTopic (topic, message) {
+export function validateTopic (topic, message) {
   if (!topic || topic.length === 0) { // [MQTT-3.8.3-3]
     return new Error('impossible to ' + message + ' to an empty topic')
   }
@@ -32,14 +30,14 @@ function validateTopic (topic, message) {
   }
 }
 
-function through (transform) {
+export function through (transform) {
   return new Transform({
     objectMode: true,
     transform
   })
 }
 
-function bulk (fn) {
+export function bulk (fn) {
   return new Writable({
     objectMode: true,
     writev: function (chunks, cb) {
@@ -48,9 +46,4 @@ function bulk (fn) {
   })
 }
 
-module.exports = {
-  validateTopic,
-  through,
-  bulk,
-  $SYS_PREFIX: '$SYS/'
-}
+export const $SYS_PREFIX = '$SYS/'

package/lib/write.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const mqtt = require('mqtt-packet')
+import mqtt from 'mqtt-packet'
 
 function write (client, packet, done) {
   let error = null
@@ -8,7 +6,8 @@ function write (client, packet, done) {
     try {
       const result = mqtt.writeToStream(packet, client.conn)
       if (!result && !client.errored) {
-        client.conn.once('drain', done)
+        // Socket buffer is full - wait for drain
+        client.waitForDrain(done)
         return
       }
     } catch (e) {
@@ -21,4 +20,4 @@ function write (client, packet, done) {
   setImmediate(done, error, client)
 }
 
-module.exports = write
+export default write