ref(xmpp): adjust last success time tracker for bosh and websocket (#1053)

modules/xmpp/StropheBoshLastSuccess.js

@@ -1,41 +0,0 @@
-/**
- * Class attaches to Strophe BOSH connection and tracks the time of last successful request.
- * It does that by overriding {@code nextValidRid} method and tracking how the RID value changes.
- * A request was successful if the number has increased by 1 since the last time the method was called.
- */
-export default class LastRequestTracker {
-    /**
-     * Initializes new instance.
-     */
-    constructor() {
-        this._nextValidRid = null;
-        this._lastSuccess = null;
-    }
-
-    /**
-     * Starts tracking requests on the given connection.
-     *
-     * @param {Object} stropheConnection - Strophe connection instance.
-     */
-    startTracking(stropheConnection) {
-        stropheConnection.nextValidRid = rid => {
-            // Just before connect and on disconnect RID will get assigned a new random value.
-            // A request was successful only when the value got increased exactly by 1.
-            if (this._nextValidRid === rid - 1) {
-                this._lastSuccess = new Date().getTime();
-            }
-            this._nextValidRid = rid;
-        };
-    }
-
-    /**
-     * Returns how many milliseconds have passed since the last successful BOSH request.
-     *
-     * @returns {number|null}
-     */
-    getTimeSinceLastSuccess() {
-        return this._lastSuccess
-            ? new Date().getTime() - this._lastSuccess
-            : null;
-    }
-}

modules/xmpp/StropheLastSuccess.js

@@ -0,0 +1,36 @@
+/**
+ * Attaches to the {@link Strophe.Connection.rawInput} which is called whenever any data is received from the server.
+ */
+export default class LastRequestTracker {
+    /**
+     * Initializes new instance.
+     */
+    constructor() {
+        this._lastSuccess = null;
+    }
+
+    /**
+     * Starts tracking requests on the given connection.
+     *
+     * @param {Object} stropheConnection - Strophe connection instance.
+     */
+    startTracking(stropheConnection) {
+        const originalRawInput = stropheConnection.rawInput;
+
+        stropheConnection.rawInput = function(...args) {
+            this._lastSuccess = Date.now();
+            originalRawInput.apply(stropheConnection, args);
+        };
+    }
+
+    /**
+     * Returns how many milliseconds have passed since the last successful BOSH request.
+     *
+     * @returns {number|null}
+     */
+    getTimeSinceLastSuccess() {
+        return this._lastSuccess
+            ? Date.now() - this._lastSuccess
+            : null;
+    }
+}

modules/xmpp/XmppConnection.js

@@ -5,7 +5,7 @@ import 'strophejs-plugin-stream-management';
 import Listenable from '../util/Listenable';
 import { getJitterDelay } from '../util/Retry';
 
-import LastSuccessTracker from './StropheBoshLastSuccess';
+import LastSuccessTracker from './StropheLastSuccess';
 
 const logger = getLogger(__filename);
 
@@ -64,10 +64,8 @@ export default class XmppConnection extends Listenable {
         // The default maxRetries is 5, which is too long.
         this._stropheConn.maxRetries = 3;
 
-        if (!this._usesWebsocket) {
-            this._lastSuccessTracker = new LastSuccessTracker();
-            this._lastSuccessTracker.startTracking(this._stropheConn);
-        }
+        this._lastSuccessTracker = new LastSuccessTracker();
+        this._lastSuccessTracker.startTracking(this._stropheConn);
     }
 
     /**
@@ -279,10 +277,8 @@ export default class XmppConnection extends Listenable {
      *
      * @returns {number|null}
      */
-    getTimeSinceLastBOSHSuccess() {
-        return this._lastSuccessTracker
-            ? this._lastSuccessTracker.getTimeSinceLastSuccess()
-            : null;
+    getTimeSinceLastSuccess() {
+        return this._lastSuccessTracker.getTimeSinceLastSuccess();
     }
 
     /**

modules/xmpp/xmpp.js

@@ -668,7 +668,7 @@ export default class XMPP extends Listenable {
         /* eslint-disable camelcase */
         // check for possible suspend
         details.suspend_time = this.connection.ping.getPingSuspendTime();
-        details.time_since_last_success = this.connection.getTimeSinceLastBOSHSuccess();
+        details.time_since_last_success = this.connection.getTimeSinceLastSuccess();
         /* eslint-enable camelcase */
 
         return details;