message_bus 4.2.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edad2fa285f65718a34893791166991c2cdf893b6e7064c5163882cd92f5fc95
-  data.tar.gz: 686c4fcc4c02add5adf75fa08586491af36173d67bfac917093b291d8d3343f2
+  metadata.gz: 15a820bf3ce7658e466132cbc2dd41c4f71b5c68db2e993437698192922377b9
+  data.tar.gz: 2c698b0e82d3d17dc3c0aa682e34ffaf32713f47fe207c1e8b1d55d2fb7cbe48
 SHA512:
-  metadata.gz: fb23eadc6112f7d28128b46e1e00d7bbdd196cf574398a3746927210d9affd4f127b83e6a9f104a65d8909d03729af16221ef7ec159126cdc5208d6eacf3e2d5
-  data.tar.gz: bdbf6a4d6d3c129f58a8c0fb02d5275cda59becb59120a602423340597e7afcb84410b39f58b537a2962a0157d0a1ca10d2efbc28f6bfbea4e3fe160a7cf46f7
+  metadata.gz: 0ea1a5c7a8c80bdddb487eed1442e6364b37518407c1809b0fe76bc3bf5fcba96bb66df04d02d4e491350d415abbae1cd0ecc91ef1079838d6455b6063c0459f
+  data.tar.gz: 981cc3d93b7ca7a3af50179c9450033f4e4566edca5d1269c73d3fd94952f5a77d5ce14b87aa58bc5845e377a2c5c6cbe64cd1dc7905dd7689dfe1295f0668cf

data/.eslintrc.js

@@ -11,4 +11,13 @@ module.exports = {
   },
   rules: {},
   ignorePatterns: ['/vendor', '/doc', '/assets/jquery-1.8.2.js'],
+  overrides: [
+    {
+      // Enable async/await in tests only
+      files: ["spec/**/*"],
+      parserOptions: {
+        ecmaVersion: 2022,
+      },
+    },
+  ],
 };

data/.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
           --health-retries 5
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: ruby/setup-ruby@v1
         with:
@@ -51,9 +51,9 @@ jobs:
           bundler-cache: true
 
       - name: Set up Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           cache: npm
 
       - name: Setup npm
@@ -74,7 +74,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Release gem
         uses: discourse/publish-rubygems-action@v2

data/CHANGELOG

@@ -1,3 +1,18 @@
+FUTURE
+
+06-01-2023
+
+- Version 4.2.1
+
+  - FIX: Ensure non-long-polling requests are always spaced out
+
+04-11-2022
+
+- Version 4.2.0
+
+  - FIX: Add redis gem version 5 support
+  - FEATURE: Allow disabling subscriptions without disabling publication
+
 22-02-2022
 
 - Version 4.2.0
@@ -376,6 +391,7 @@
 
 - Version 2.0.0.beta.5
 
+- Feature: Memory backend @jeremyevans
 - Fix: JavaScript unsubscribe was not updating publicly visible MessageBus.callbacks @sam
 - Fix: When MessageBus is talking to a readonly redis buffering may cause a infinite loop @tgxworld
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5
+FROM ruby:2.7
 
 RUN cd /tmp && \
   wget --quiet https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2 && \
@@ -10,7 +10,7 @@ WORKDIR /usr/src/app
 
 RUN mkdir -p ./lib/message_bus
 COPY lib/message_bus/version.rb ./lib/message_bus
-COPY Gemfile Gemfile.lock *.gemspec ./
+COPY Gemfile *.gemspec ./
 RUN bundle install
 
 COPY . .

data/README.md

@@ -155,7 +155,7 @@ end)
 
 #### Disabling message_bus
 
-In certain cases, it is undesirable for message_bus to start up on application start, for example in a Rails application during the `db:create` rake task when using the Postgres backend (which will error trying to connect to the non-existent database to subscribe). You can invoke `MessageBus.off` before the middleware chain is loaded in order to prevent subscriptions and publications from happening; in a Rails app you might do this in an initializer based on some environment variable or some other conditional means.
+In certain cases, it is undesirable for message_bus to start up on application start, for example in a Rails application during the `db:create` rake task when using the Postgres backend (which will error trying to connect to the non-existent database to subscribe). You can invoke `MessageBus.off` before the middleware chain is loaded in order to prevent subscriptions and publications from happening; in a Rails app you might do this in an initializer based on some environment variable or some other conditional means. If you want to just disable subscribing to the bus but want to continue to allow publications to be made, you can do `MessageBus.off(disable_publish: false)`.
 
 ### Debugging
 

data/assets/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"
       );
     },
 

data/lib/message_bus/backends/redis.rb

@@ -346,7 +346,29 @@ LUA
       private
 
       def new_redis_connection
-        ::Redis.new(@redis_config.dup)
+        config = @redis_config.filter do |k, v|
+          # This is not ideal, required for Redis gem version 5
+          # redis-client no longer accepts arbitrary params
+          # anything unknown will error out.
+          # https://github.com/redis-rb/redis-client/blob/4c8e05acfb3477c1651138a4924616e79e6116f2/lib/redis_client/config.rb#L21-L39
+          #
+          #
+          # We should be doing the opposite and allowlisting params
+          # or splitting the object up. Starting with the smallest change that is backwards compatible
+          ![
+            :backend,
+            :logger,
+            :long_polling_enabled,
+            :backend_options,
+            :base_route,
+            :client_message_filters,
+            :site_id_lookup,
+            :group_id_lookup,
+            :user_id_lookup,
+            :transport_codec
+          ].include?(k)
+        end
+        ::Redis.new(config)
       end
 
       # redis connection used for publishing messages

data/lib/message_bus/version.rb

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

data/lib/message_bus.rb

@@ -40,6 +40,7 @@ module MessageBus::Implementation
     @config = {}
     @mutex = Synchronizer.new
     @off = false
+    @off_disable_publish = false
     @destroyed = false
     @timer_thread = nil
     @subscriber_thread = nil
@@ -160,15 +161,17 @@ module MessageBus::Implementation
   end
 
   # Disables publication to the bus
+  # @param [Boolean] disable_publish Whether or not to disable publishing
   # @return [void]
-  def off
+  def off(disable_publish: true)
     @off = true
+    @off_disable_publish = disable_publish
   end
 
   # Enables publication to the bus
   # @return [void]
   def on
-    @destroyed = @off = false
+    @destroyed = @off = @off_disable_publish = false
   end
 
   # Overrides existing configuration
@@ -338,7 +341,7 @@ module MessageBus::Implementation
   # @raise [MessageBus::InvalidMessage] if attempting to put permission restrictions on a globally-published message
   # @raise [MessageBus::InvalidMessageTarget] if attempting to publish to a empty group of users
   def publish(channel, data, opts = nil)
-    return if @off
+    return if @off_disable_publish
 
     @mutex.synchronize do
       raise ::MessageBus::BusDestroyed if @destroyed
@@ -664,6 +667,8 @@ module MessageBus::Implementation
   end
 
   def subscribe_impl(channel, site_id, last_id, &blk)
+    return if @off
+
     raise MessageBus::BusDestroyed if @destroyed
 
     if last_id >= 0