message_bus 4.3.0 → 4.3.1

data/package.json

@@ -20,7 +20,7 @@
   },
   "homepage": "https://github.com/discourse/message_bus#readme",
   "devDependencies": {
-    "eslint": "^7.27.0",
+    "eslint": "^8.31.0",
     "jasmine-browser-runner": "^0.10.0",
     "jasmine-core": "^3.10.1"
   }

data/spec/assets/SpecHelper.js

@@ -33,8 +33,7 @@ beforeEach(function () {
   MockedXMLHttpRequest.prototype.send              = function(){
     this.readyState = 4
     this.responseText = encodeChunks(this, spec.responseChunks);
-    this.statusText = 'OK';
-    this.status = 200;
+    this.status = spec.responseStatus;
     if (this.onprogress){ this.onprogress(); }
     this.onreadystatechange()
   }
@@ -53,8 +52,8 @@ beforeEach(function () {
     this.headers[k] = v;
   }
 
-  MockedXMLHttpRequest.prototype.getResponseHeader = function(){
-    return 'text/plain; charset=utf-8';
+  MockedXMLHttpRequest.prototype.getResponseHeader = function(headerName){
+    return spec.responseHeaders[headerName];
   }
 
   MessageBus.xhrImplementation = MockedXMLHttpRequest
@@ -64,12 +63,19 @@ beforeEach(function () {
     {channel: '/test', data: {password: 'MessageBusRocks!'}}
   ];
 
+  this.responseStatus = 200;
+  this.responseHeaders = {
+    "Content-Type": 'text/plain; charset=utf-8',
+  };
+
   MessageBus.start();
 });
 
 afterEach(function(){
   MessageBus.stop()
   MessageBus.callbacks.splice(0, MessageBus.callbacks.length)
+  MessageBus.shouldLongPollCallback = null;
+  MessageBus.enableChunkedEncoding = true;
 });
 
 window.testMB = function(description, testFn, path, data){

data/spec/assets/message-bus.spec.js

@@ -1,7 +1,11 @@
+/* eslint-env es2022 */
 /* global describe, it, spyOn, MessageBus, expect, jasmine, testMB */
 
-describe("Messagebus", function() {
+function approxEqual(valueOne, valueTwo) {
+  return Math.abs(valueOne - valueTwo) < 500;
+}
 
+describe("Messagebus", function () {
   it("submits change requests", function(done){
     spyOn(this.MockedXMLHttpRequest.prototype, 'send').and.callThrough();
     var spec = this;
@@ -97,4 +101,69 @@ describe("Messagebus", function() {
     })
   });
 
+  it("respects Retry-After response header when larger than 15 seconds", async function () {
+    spyOn(this.MockedXMLHttpRequest.prototype, "send").and.callThrough();
+    spyOn(window, "setTimeout").and.callThrough();
+
+    this.responseStatus = 429;
+    this.responseHeaders["Retry-After"] = "23";
+
+    await new Promise((resolve) => MessageBus.subscribe("/test", resolve));
+
+    const nextPollScheduledIn = window.setTimeout.calls.mostRecent().args[1];
+    expect(nextPollScheduledIn).toEqual(23000);
+  });
+
+  it("retries after 15s for lower retry-after values", async function () {
+    spyOn(this.MockedXMLHttpRequest.prototype, "send").and.callThrough();
+    spyOn(window, "setTimeout").and.callThrough();
+
+    this.responseStatus = 429;
+    this.responseHeaders["Retry-After"] = "13";
+
+    await new Promise((resolve) => MessageBus.subscribe("/test", resolve));
+
+    const nextPollScheduledIn = window.setTimeout.calls.mostRecent().args[1];
+    expect(nextPollScheduledIn).toEqual(15000);
+  });
+
+  it("waits for callbackInterval after receiving data in chunked long-poll mode", async function () {
+    // The callbackInterval is equal to the length of the server response in chunked long-poll mode, so
+    // this ultimately ends up being a continuous stream of requests
+
+    spyOn(this.MockedXMLHttpRequest.prototype, "send").and.callThrough();
+    spyOn(window, "setTimeout").and.callThrough();
+
+    await new Promise((resolve) => MessageBus.subscribe("/test", resolve));
+
+    const nextPollScheduledIn = window.setTimeout.calls.mostRecent().args[1];
+    expect(
+      approxEqual(nextPollScheduledIn, MessageBus.callbackInterval)
+    ).toEqual(true);
+  });
+
+  it("waits for backgroundCallbackInterval after receiving data in non-long-poll mode", async function () {
+    spyOn(this.MockedXMLHttpRequest.prototype, "send").and.callThrough();
+    spyOn(window, "setTimeout").and.callThrough();
+    MessageBus.shouldLongPollCallback = () => false;
+    MessageBus.enableChunkedEncoding = false;
+
+    await new Promise((resolve) => MessageBus.subscribe("/test", resolve));
+
+    const nextPollScheduledIn = window.setTimeout.calls.mostRecent().args[1];
+    expect(
+      approxEqual(nextPollScheduledIn, MessageBus.backgroundCallbackInterval)
+    ).toEqual(true);
+  });
+
+  it("re-polls immediately after receiving data in non-chunked long-poll mode", async function () {
+    spyOn(this.MockedXMLHttpRequest.prototype, "send").and.callThrough();
+    spyOn(window, "setTimeout").and.callThrough();
+    MessageBus.enableChunkedEncoding = false;
+
+    await new Promise((resolve) => MessageBus.subscribe("/test", resolve));
+
+    const nextPollScheduledIn = window.setTimeout.calls.mostRecent().args[1];
+    expect(nextPollScheduledIn).toEqual(MessageBus.minPollInterval);
+  });
 });

data/vendor/assets/javascripts/message-bus.js

@@ -40,7 +40,7 @@
   var pollTimeout = null;
   var totalAjaxFailures = 0;
   var totalAjaxCalls = 0;
-  var lastAjax;
+  var lastAjaxStartedAt;
 
   var isHidden = (function () {
     var prefixes = ["", "webkit", "ms", "moz"];
@@ -156,11 +156,11 @@
     }
 
     var gotData = false;
-    var aborted = false;
+    var abortedByClient = false;
     var rateLimited = false;
     var rateLimitedSeconds;
 
-    lastAjax = new Date();
+    lastAjaxStartedAt = new Date();
     totalAjaxCalls += 1;
     data.__seq = totalAjaxCalls;
 
@@ -281,7 +281,7 @@
           rateLimitedSeconds = tryAfter;
           rateLimited = true;
         } else if (textStatus === "abort") {
-          aborted = true;
+          abortedByClient = true;
         } else {
           failCount += 1;
           totalAjaxFailures += 1;
@@ -290,27 +290,40 @@
       complete: function () {
         ajaxInProgress = false;
 
-        var interval;
+        var inLongPollingMode = shouldLongPoll();
+        var startNextRequestAfter;
         try {
           if (rateLimited) {
-            interval = Math.max(me.minPollInterval, rateLimitedSeconds * 1000);
-          } else if (gotData || aborted) {
-            interval = me.minPollInterval;
+            // Respect `Retry-After` header
+            startNextRequestAfter = Math.max(
+              me.minPollInterval,
+              rateLimitedSeconds * 1000
+            );
+          } else if (abortedByClient) {
+            // Immediately trigger another poll
+            startNextRequestAfter = me.minPollInterval;
+          } else if (failCount > 2) {
+            // Linear backoff up to maxPollInterval
+            startNextRequestAfter = Math.min(
+              me.callbackInterval * failCount,
+              me.maxPollInterval
+            );
+          } else if (inLongPollingMode && gotData) {
+            // Immediately trigger another poll
+            startNextRequestAfter = me.minPollInterval;
           } else {
-            interval = me.callbackInterval;
-            if (failCount > 2) {
-              interval = interval * failCount;
-            } else if (!shouldLongPoll()) {
-              interval = me.backgroundCallbackInterval;
-            }
-            if (interval > me.maxPollInterval) {
-              interval = me.maxPollInterval;
-            }
+            // Trigger next poll N seconds after the last one **started**
+            var targetRequestInterval = inLongPollingMode
+              ? me.callbackInterval
+              : me.backgroundCallbackInterval;
+
+            var elapsedSinceLastAjaxStarted = new Date() - lastAjaxStartedAt;
 
-            interval -= new Date() - lastAjax;
+            startNextRequestAfter =
+              targetRequestInterval - elapsedSinceLastAjaxStarted;
 
-            if (interval < 100) {
-              interval = 100;
+            if (startNextRequestAfter < 100) {
+              startNextRequestAfter = 100;
             }
           }
         } catch (e) {
@@ -328,7 +341,7 @@
           pollTimeout = setTimeout(function () {
             pollTimeout = null;
             poll();
-          }, interval);
+          }, startNextRequestAfter);
         }
 
         me.longPoll = null;
@@ -367,7 +380,9 @@
           totalAjaxFailures
       );
       console.log(
-        "Last ajax call: " + (new Date() - lastAjax) / 1000 + " seconds ago"
+        "Last ajax call: " +
+          (new Date() - lastAjaxStartedAt) / 1000 +
+          " seconds ago"
       );
     },
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack