Added opts parameter to reconnect().

That includes `incomingStore` and `outgoingStore` similar to `connect()`. If stores passed, `reconnect()` uses them, otherwise renew default `Store`.
thingsbrain · Dec 6, 2017 · 8adeaa7 · 8adeaa7
1 parent e271142
commit 8adeaa7
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -375,7 +375,6 @@ After this function is called, the messageId is released and becomes reusable.
 ### mqtt.Client#reconnect()
 
 Connect again using the same options as connect()
-`incomingStore` and `outgoingStore` need to be ready before `reconnect()` calling.
 
 -------------------------------------------------------
 <a name="handleMessage"></a>

diff --git a/lib/client.js b/lib/client.js
@@ -637,15 +637,27 @@ MqttClient.prototype.removeOutgoingMessage = function (mid) {
 
 /**
  * reconnect - connect again using the same options as connect()
- * `incomingStore` and `outgoingStore` need to be ready before `reconnect()` calling.
  *
+ * @param {Object} [opts] - reconnect options, includes:
+ *    {Object} incomingStore - a store for the incoming packets
+ *    {Object} outgoingStore - a store for the outgoing packets
+ *    if opts is not given, current stores are used
  * @returns {MqttClient} this - for chaining
  *
  * @api public
  */
-MqttClient.prototype.reconnect = function () {
+MqttClient.prototype.reconnect = function (opts) {
   var that = this
   var f = function () {
+    if (opts) {
+      that.options.incomingStore = opts.incomingStore
+      that.options.outgoingStore = opts.outgoingStore
+    } else {
+      that.options.incomingStore = null
+      that.options.outgoingStore = null
+    }
+    that.incomingStore = that.options.incomingStore || new Store()
+    that.outgoingStore = that.options.outgoingStore || new Store()
     that.disconnecting = false
     that.disconnected = false
     that._deferredReconnect = null

diff --git a/test/abstract_client.js b/test/abstract_client.js
@@ -1975,6 +1975,8 @@ module.exports = function (server, config) {
     it('should preserved incomingStore after disconnecting if clean is false', function (done) {
       var reconnect = false
       var client = {}
+      var incomingStore = new mqtt.Store({ clean: false })
+      var outgoingStore = new mqtt.Store({ clean: false })
       var server2 = new Server(function (c) {
         c.on('connect', function (packet) {
           c.connack({returnCode: 0})
@@ -1993,7 +1995,10 @@ module.exports = function (server, config) {
         })
         c.on('pubrec', function (packet) {
           client.end(false, function () {
-            client.reconnect()
+            client.reconnect({
+              incomingStore: incomingStore,
+              outgoingStore: outgoingStore
+            })
           })
         })
         c.on('pubcomp', function (packet) {
@@ -2010,8 +2015,8 @@ module.exports = function (server, config) {
           clean: false,
           clientId: 'cid1',
           reconnectPeriod: 0,
-          incomingStore: new mqtt.Store({ clean: false }),
-          outgoingStore: new mqtt.Store({ clean: false })
+          incomingStore: incomingStore,
+          outgoingStore: outgoingStore
         })
 
         client.on('connect', function () {
@@ -2029,13 +2034,7 @@ module.exports = function (server, config) {
     })
 
     it('should be able to pub/sub if reconnect() is called at close handler', function (done) {
-      var client = connect({
-        clean: false,
-        clientId: 'cid1',
-        reconnectPeriod: 0,
-        incomingStore: new mqtt.Store({ clean: false }),
-        outgoingStore: new mqtt.Store({ clean: false })
-      })
+      var client = connect({ reconnectPeriod: 0 })
       var tryReconnect = true
       var reconnectEvent = false
 
@@ -2065,13 +2064,7 @@ module.exports = function (server, config) {
     })
 
     it('should be able to pub/sub if reconnect() is called at out of close handler', function (done) {
-      var client = connect({
-        clean: false,
-        clientId: 'cid1',
-        reconnectPeriod: 0,
-        incomingStore: new mqtt.Store({ clean: false }),
-        outgoingStore: new mqtt.Store({ clean: false })
-      })
+      var client = connect({ reconnectPeriod: 0 })
       var tryReconnect = true
       var reconnectEvent = false
 
@@ -2102,59 +2095,6 @@ module.exports = function (server, config) {
       })
     })
 
-    it('should be able to pub/sub if connect() is called at close handler', function (done) {
-      var client = connect({ reconnectPeriod: 0 })
-      var reconnectEvent = false
-      client.on('close', function () {
-        client = connect({ reconnectPeriod: 0 })
-        client.on('connect', function () {
-          client.subscribe('hello', function () {
-            client.end()
-          })
-        })
-        client.on('close', function () {
-          reconnectEvent.should.equal(false)
-          done()
-        })
-      })
-
-      client.on('reconnect', function () {
-        reconnectEvent = true
-      })
-
-      client.on('connect', function () {
-        client.end()
-      })
-    })
-
-    it('should be able to pub/sub if connect() is called at out of close handler', function (done) {
-      var client = connect({ reconnectPeriod: 0 })
-      var reconnectEvent = false
-
-      client.on('close', function () {
-        setTimeout(function () {
-          client = connect({ reconnectPeriod: 0 })
-          client.on('connect', function () {
-            client.subscribe('hello', function () {
-              client.end()
-            })
-          })
-          client.on('close', function () {
-            reconnectEvent.should.equal(false)
-            done()
-          })
-        }, 100)
-      })
-
-      client.on('reconnect', function () {
-        reconnectEvent = true
-      })
-
-      client.on('connect', function () {
-        client.end()
-      })
-    })
-
     context('with alternate server client', function () {
       var cachedClientListeners
 

diff --git a/types/lib/client.d.ts b/types/lib/client.d.ts
@@ -165,7 +165,11 @@ export declare class MqttClient extends events.EventEmitter {
 
   /**
    * reconnect - connect again using the same options as connect()
-   * `incomingStore` and `outgoingStore` need to be ready before `reconnect()` calling.
+   *
+   * @param {Object} [opts] - reconnect options, includes:
+   *    {Object} incomingStore - a store for the incoming packets
+   *    {Object} outgoingStore - a store for the outgoing packets
+   *    if opts is not given, current stores are used
    *
    * @returns {MqttClient} this - for chaining
    *