message_bus 4.3.1 → 4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15a820bf3ce7658e466132cbc2dd41c4f71b5c68db2e993437698192922377b9
-  data.tar.gz: 2c698b0e82d3d17dc3c0aa682e34ffaf32713f47fe207c1e8b1d55d2fb7cbe48
+  metadata.gz: e36107abe5d2f970df28804121149c63c3fc7b7708013673340564f511bbfbbe
+  data.tar.gz: 5a3b55c06cd1137c152025b08e8ca3bba0b47c5cdb2330721c9c9c3559db454d
 SHA512:
-  metadata.gz: 0ea1a5c7a8c80bdddb487eed1442e6364b37518407c1809b0fe76bc3bf5fcba96bb66df04d02d4e491350d415abbae1cd0ecc91ef1079838d6455b6063c0459f
-  data.tar.gz: 981cc3d93b7ca7a3af50179c9450033f4e4566edca5d1269c73d3fd94952f5a77d5ce14b87aa58bc5845e377a2c5c6cbe64cd1dc7905dd7689dfe1295f0668cf
+  metadata.gz: 19ecda3ef5c20ffd217e491dcd784c4e2f04a360b0ad27d3aeee96b468ae55e88e23827a0d5fab787af05cf9afa9df2d2a0c7d3b1a7ccb8b3b4544164e430595
+  data.tar.gz: 05c2411c4b17495306d7c33da0a73759ceab0ec7f332e4626d914b68d4ae8febc53ab552a854197a0335c5f4483195a3389eec7c6b4774d14a719c7b8429bf7a

data/CHANGELOG

@@ -1,5 +1,12 @@
 FUTURE
 
+
+13-01-2023
+
+- Version 4.2.1
+
+  - FIX: Do not disable chunking on cancel/error
+
 06-01-2023
 
 - Version 4.2.1

data/assets/message-bus.js

@@ -205,10 +205,11 @@
       return handle_progress(payload, endChunk + separator.length);
     };
 
+    var chunkedTimeout;
     var disableChunked = function () {
       if (me.longPoll) {
         me.longPoll.abort();
-        chunkedBackoff = 30;
+        chunkedBackoff = me.retryChunkedAfterRequests;
       }
     };
 
@@ -235,9 +236,9 @@
         chunked: chunked,
         onProgressListener: function (xhr) {
           var position = 0;
-          // if it takes longer than 3000 ms to get first chunk, we have some proxy
-          // this is messing with us, so just backoff from using chunked for now
-          var chunkedTimeout = setTimeout(disableChunked, 3000);
+          // if it takes longer than firstChunkTimeout to get first chunk, there may be a proxy
+          // buffering the response. Switch to non-chunked long-polling mode.
+          chunkedTimeout = setTimeout(disableChunked, me.firstChunkTimeout);
           return (xhr.onprogress = function () {
             clearTimeout(chunkedTimeout);
             if (
@@ -269,6 +270,7 @@
         }
       },
       error: function (xhr, textStatus) {
+        clearTimeout(chunkedTimeout);
         if (xhr.status === 429) {
           var tryAfter =
             parseInt(
@@ -364,6 +366,8 @@
     clientId: clientId,
     alwaysLongPoll: false,
     shouldLongPollCallback: undefined,
+    firstChunkTimeout: 3000,
+    retryChunkedAfterRequests: 30,
     baseUrl: baseUrl,
     headers: {},
     ajax: typeof jQuery !== "undefined" && jQuery.ajax,

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "4.3.1"
+  VERSION = "4.3.2"
 end

data/spec/assets/SpecHelper.js

@@ -34,8 +34,23 @@ beforeEach(function () {
     this.readyState = 4
     this.responseText = encodeChunks(this, spec.responseChunks);
     this.status = spec.responseStatus;
-    if (this.onprogress){ this.onprogress(); }
-    this.onreadystatechange()
+
+    spec.requestStarted?.();
+
+    const complete = () => {
+      if(this.statusText === "abort"){
+        return;
+      }
+      this.onprogress?.();
+      this.onreadystatechange();
+    }
+
+    if(spec.delayResponsePromise){
+      spec.delayResponsePromise.then(() => complete())
+      spec.delayResponsePromise = null;
+    }else{
+      complete();
+    }
   }
 
   MockedXMLHttpRequest.prototype.open              = function(){ }
@@ -43,8 +58,8 @@ beforeEach(function () {
   MockedXMLHttpRequest.prototype.abort             = function(){
     this.readyState = 4
     this.responseText = '';
-    this.statusText = '';
-    this.status = 400;
+    this.statusText = 'abort';
+    this.status = 0;
     this.onreadystatechange()
   }
 
@@ -68,6 +83,10 @@ beforeEach(function () {
     "Content-Type": 'text/plain; charset=utf-8',
   };
 
+  MessageBus.enableChunkedEncoding = true;
+  MessageBus.firstChunkTimeout = 3000;
+  MessageBus.retryChunkedAfterRequests = 1;
+
   MessageBus.start();
 });
 
@@ -75,7 +94,6 @@ 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

@@ -166,4 +166,63 @@ describe("Messagebus", function () {
     const nextPollScheduledIn = window.setTimeout.calls.mostRecent().args[1];
     expect(nextPollScheduledIn).toEqual(MessageBus.minPollInterval);
   });
+
+  it("enters don't-chunk-mode if first chunk times out", async function () {
+    spyOn(this.MockedXMLHttpRequest.prototype, "send").and.callThrough();
+    spyOn(
+      this.MockedXMLHttpRequest.prototype,
+      "setRequestHeader"
+    ).and.callThrough();
+
+    let resolveFirstResponse;
+    this.delayResponsePromise = new Promise(
+      (resolve) => (resolveFirstResponse = resolve)
+    );
+    MessageBus.firstChunkTimeout = 50;
+
+    await new Promise((resolve) => MessageBus.subscribe("/test", resolve));
+    resolveFirstResponse();
+
+    const calls =
+      this.MockedXMLHttpRequest.prototype.setRequestHeader.calls.all();
+
+    const dontChunkCalls = calls.filter((c) => c.args[0] === "Dont-Chunk");
+    expect(dontChunkCalls.length).toEqual(1);
+  });
+
+  it("doesn't enter don't-chunk-mode if aborted before first chunk", async function () {
+    spyOn(
+      this.MockedXMLHttpRequest.prototype,
+      "setRequestHeader"
+    ).and.callThrough();
+
+    this.delayResponsePromise = new Promise(() => {});
+    MessageBus.firstChunkTimeout = 300;
+
+    const requestWasStarted = new Promise(
+      (resolve) => (this.requestStarted = resolve)
+    );
+
+    // Trigger request
+    const subscribedPromise = new Promise((resolve) =>
+      MessageBus.subscribe("/test", resolve)
+    );
+
+    await requestWasStarted;
+
+    // Change subscription (triggers an abort and re-poll)
+    MessageBus.subscribe("/test2", () => {});
+
+    // Wait for stuff to settle
+    await subscribedPromise;
+
+    // Wait 300ms to ensure dontChunk timeout has passed
+    await new Promise((resolve) => setTimeout(resolve, 300));
+
+    const calls =
+      this.MockedXMLHttpRequest.prototype.setRequestHeader.calls.all();
+
+    const dontChunkCalls = calls.filter((c) => c.args[0] === "Dont-Chunk");
+    expect(dontChunkCalls.length).toEqual(0);
+  });
 });

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

@@ -205,10 +205,11 @@
       return handle_progress(payload, endChunk + separator.length);
     };
 
+    var chunkedTimeout;
     var disableChunked = function () {
       if (me.longPoll) {
         me.longPoll.abort();
-        chunkedBackoff = 30;
+        chunkedBackoff = me.retryChunkedAfterRequests;
       }
     };
 
@@ -235,9 +236,9 @@
         chunked: chunked,
         onProgressListener: function (xhr) {
           var position = 0;
-          // if it takes longer than 3000 ms to get first chunk, we have some proxy
-          // this is messing with us, so just backoff from using chunked for now
-          var chunkedTimeout = setTimeout(disableChunked, 3000);
+          // if it takes longer than firstChunkTimeout to get first chunk, there may be a proxy
+          // buffering the response. Switch to non-chunked long-polling mode.
+          chunkedTimeout = setTimeout(disableChunked, me.firstChunkTimeout);
           return (xhr.onprogress = function () {
             clearTimeout(chunkedTimeout);
             if (
@@ -269,6 +270,7 @@
         }
       },
       error: function (xhr, textStatus) {
+        clearTimeout(chunkedTimeout);
         if (xhr.status === 429) {
           var tryAfter =
             parseInt(
@@ -364,6 +366,8 @@
     clientId: clientId,
     alwaysLongPoll: false,
     shouldLongPollCallback: undefined,
+    firstChunkTimeout: 3000,
+    retryChunkedAfterRequests: 30,
     baseUrl: baseUrl,
     headers: {},
     ajax: typeof jQuery !== "undefined" && jQuery.ajax,

metadata

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