refactor(*): cleanup code and tests

Author: thetutlage

package-lock.json

@@ -34,6 +34,7 @@
     "karma-japa": "^1.0.2",
     "karma-rollup-preprocessor": "^5.1.1",
     "karma-sourcemap-loader": "^0.3.7",
+    "pify": "^3.0.0",
     "puppeteer": "^1.2.0",
     "rollup": "^0.57.0",
     "rollup-plugin-babel": "^3.0.3",

package.json

@@ -21,6 +21,16 @@ import debug from '../Debug'
 import Socket from '../Socket/index.js'
 import JsonEncoder from '../JsonEncoder/index.js'
 
+/**
+ * Connection class is used to make a TCP/Socket connection
+ * with the server. It relies on Native Websocket browser
+ * support.
+ *
+ * @class Connection
+ *
+ * @param {String} url
+ * @param {Object} options
+ */
 export default class Connection extends Emitter {
   constructor (url, options) {
     super()
@@ -55,20 +65,6 @@ export default class Connection extends Emitter {
      */
     this._reconnectionAttempts = 0
 
-    /**
-     * Base URL for the websocket connection
-     *
-     * @type {String}
-     */
-    this.url = `${url.replace(/\/$/, '')}/${this.options.path}`
-
-    /**
-     * Subscriptions for a single connection
-     *
-     * @type {Object}
-     */
-    this.subscriptions = {}
-
     /**
      * All packets are sent in sequence to the server. So we need to
      * maintain a queue and process one at a time
@@ -100,6 +96,20 @@ export default class Connection extends Emitter {
      */
     this._extendedQuery = {}
 
+    /**
+     * Base URL for the websocket connection
+     *
+     * @type {String}
+     */
+    this._url = `${url.replace(/\/$/, '')}/${this.options.path}`
+
+    /**
+     * Subscriptions for a single connection
+     *
+     * @type {Object}
+     */
+    this.subscriptions = {}
+
     /**
      * Handler called when `close` is emitted from the
      * subscription
@@ -122,6 +132,21 @@ export default class Connection extends Emitter {
     this.options.reconnectionAttempts > this._reconnectionAttempts
   }
 
+  /**
+   * Clean references
+   *
+   * @method _cleanup
+   *
+   * @return {void}
+   *
+   * @private
+   */
+  _cleanup () {
+    clearInterval(this._pingTimer)
+    this.ws = null
+    this._pingTimer = null
+  }
+
   /**
    * Calls a callback passing subscription to it
    *
@@ -134,9 +159,7 @@ export default class Connection extends Emitter {
    * @private
    */
   _subscriptionsIterator (callback) {
-    Object.keys(this.subscriptions).forEach((sub) => {
-      callback(this.subscriptions[sub], sub)
-    })
+    Object.keys(this.subscriptions).forEach((sub) => callback(this.subscriptions[sub], sub))
   }
 
   /**
@@ -156,7 +179,7 @@ export default class Connection extends Emitter {
     const socket = this.getSubscription(packet.d.topic)
 
     if (!socket) {
-      debug('cannot acknowledge join since topic has no subscription %j', packet)
+      debug('cannot consume packet since %s topic has no active subscription %j', packet.d.topic, packet)
       return
     }
 
@@ -228,6 +251,7 @@ export default class Connection extends Emitter {
    * @private
    */
   _onError (event) {
+    debug('error %O', event)
     this._subscriptionsIterator((subscription) => (subscription.serverError()))
     this.emit('error', event)
   }
@@ -245,8 +269,9 @@ export default class Connection extends Emitter {
   _reconnect () {
     this._reconnectionAttempts++
 
-    const timer = setTimeout(() => {
-      clearTimeout(timer)
+    this.emit('reconnect', this._reconnectionAttempts)
+
+    setTimeout(() => {
       this._connectionState = 'reconnect'
       this.connect()
     }, this.options.reconnectionDelay * this._reconnectionAttempts)
@@ -264,11 +289,11 @@ export default class Connection extends Emitter {
    * @private
    */
   _onClose (event) {
-    clearInterval(this._pingTimer)
-
-    this.ws = null
-    this._pingTimer = null
+    this._cleanup()
 
+    /**
+     * Force subscriptions to terminate
+     */
     this._subscriptionsIterator((subscription) => subscription.terminate())
 
     this
@@ -391,6 +416,7 @@ export default class Connection extends Emitter {
     /**
      * Sending packets to make pending subscriptions
      */
+    debug('processing pre connection subscriptions')
     this._subscriptionsIterator((subscription) => {
       this.sendPacket(wsp.joinPacket(subscription.topic))
     })
@@ -495,7 +521,7 @@ export default class Connection extends Emitter {
    */
   connect () {
     const query = stringify(extend({}, this.options.query, this._extendedQuery))
-    const url = query ? `${this.url}?${query}` : this.url
+    const url = query ? `${this._url}?${query}` : this._url
 
     debug('creating socket connection on %s url', url)
 

src/Connection/index.js

@@ -1,3 +1,14 @@
+'use strict'
+
+/*
+ * adonis-websocket-client
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+
 import Debug from 'debug'
 Debug.enable('adonis:*')
 export default Debug('adonis:websocket')

src/Debug/index.js

@@ -9,6 +9,9 @@
  * file that was distributed with this source code.
 */
 
+/**
+ * The default encoder to encode packets.
+ */
 export default {
   name: 'json',
   /**

src/JsonEncoder/index.js

@@ -12,6 +12,13 @@
 import Emitter from 'emittery'
 import wsp from '@adonisjs/websocket-packet'
 
+/**
+ * Socket class holds details for a single subscription. The instance
+ * of this class can be used to exchange messages with the server
+ * on a given topic.
+ *
+ * @class Socket
+ */
 export default class Socket {
   constructor (topic, connection) {
     this.topic = topic
@@ -66,7 +73,7 @@ export default class Socket {
     this.emitter.emit('ready', this)
 
     /**
-     * Process queued events, before the subscription was ready
+     * Process queued events
      */
     this._emitBuffer.forEach((buf) => (this.emit(buf.event, buf.data)))
     this._emitBuffer = []