message_bus 3.3.1 → 3.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659722c1ea3a6a805dbe81099ee2848a11ab7ebffaf8612d119f5062fd740337
-  data.tar.gz: 4b187421f5fb4bdff177d117b059c05314305729885f5ec520127ad827db5369
+  metadata.gz: 52ac95c63b3775df984e4900aff333c2ea9f9bab7e79d16b85909048247fb709
+  data.tar.gz: 879fd243f8947150fe8a31307d023b6ca719192568e0def45255dfdddaf1e34f
 SHA512:
-  metadata.gz: c345409c8c9c1624b079d28ca166b962f9d64bd79159fc085055df8cb760545372732fd5cf509061b55eb0a427e8ffd7018238a7b49c44f27f4e942d575f0504
-  data.tar.gz: d92fb533dea19da315c210f7ac96a1029cf2d1709fee3dd919032f221b557cff9ebb3d2556285e5e0c6018ebc4b227ed178fd8658711c5a9ffacf19aeb47edff
+  metadata.gz: fe7252d6965628dd75027af80f775126394e6b3a81be01fd03f538f17fe5e7874e997cea552ee2e92d91b7ee47d17059755e7df995c5b8bab24049ce2746e0a8
+  data.tar.gz: 2c4ef234bab5ee1701b5bb2d7362929128855dda113a2531dd35f025b9d2be11a2c18a287aa25731e73a9e8f82af898e2f7725a7c9ea4200a390eaff633b4098

data/.eslintrc.js

@@ -0,0 +1,13 @@
+/*global module*/
+module.exports = {
+  env: {
+    browser: true,
+    es2021: false,
+  },
+  extends: "eslint:recommended",
+  parserOptions: {
+    ecmaVersion: 2015,
+    sourceType: "module",
+  },
+  rules: {},
+};

data/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: Message Bus Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  PGHOST: localhost
+  PGPORT: 5432
+  PGPASSWORD: postgres
+  PGUSER: postgres
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    services:
+      postgres:
+        image: postgres:9.4
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    strategy:
+      matrix:
+        ruby: ["2.7", "2.6", "2.5"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Bundler cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - name: Create Database
+        run: |
+          createdb message_bus_test
+      - name: Setup redis
+        uses: shogo82148/actions-setup-redis@v1
+        with:
+          redis-version: '5.x'
+      - name: Setup gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4
+      - name: Tests
+        run: bundle exec rake

data/.gitignore

@@ -18,3 +18,5 @@ tmp
 *.swp
 .rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml
 .byebug_history
+node_modules/
+yarn.lock

data/.rubocop.yml

@@ -1,6 +1,8 @@
 inherit_gem:
   rubocop-discourse: .rubocop.yml
-
+inherit_mode:
+  merge:
+    - Exclude
 AllCops:
   Exclude:
     - 'examples/**/*'

data/CHANGELOG

@@ -1,3 +1,50 @@
+31-05-2021
+
+- Version 3.3.6
+
+  - FEATURE: Introduce support for transport codecs
+  - FIX: event subscription leak in JS after start/stop/start sequence
+  - FEATURE: MessageBus.onVisibilityChange() can be used to trigger a visiblity change check by hand
+
+28-04-2021
+
+- Version 3.3.5
+
+  - PERF: Optimised CORS preflight handling
+  - FEATURE: Enable CORS preflight caching
+  - FEATURE: Removed trailing cache buster from message bus polls
+  - PERF: Improved delay poll timeout for cases where a tab moves in and out of the background
+
+02-10-2020
+
+- Version 3.3.4
+
+  - FIX: Remove trailing comma incorrectly added in ec60d8865.
+
+18-09-2020
+
+- Version 3.3.3
+
+  - FIX: `queue_in_memory` option not being passed to the backends.
+  - FIX: `MessageBus::DistributedCache#publish` should raise on error.
+
+    On the redis backend, any errors encountered during `MessageBus#publish`
+    will add the message into an in memory queue and silently swallow the
+    error. While this is behavior is OK for normal message_bus usage, it may
+    lead to inconsistency when using `DistributedCache`. If a process
+    doesn't publish successfully to another process, it will still update
+    its in memory cache leaving the other processes unaware. As such, the
+    distributed cache is out of sync and will require another successful
+    write to the cache to resync all the caches.
+
+15-09-2020
+
+- Version 3.3.2
+
+  - FIX: In the JavaScript client throw when when lastId is given but is not a number.
+  - FEATURE: raise when attempting to publish to invalid targets
+  - Log when DistributedCache encounters an error when publishing.
+
 09-06-2020
 
 - Version 3.3.1

data/DEV.md

@@ -0,0 +1,9 @@
+### How to Publish to NPM
+
+1. First, edit `package.json` and bump the version.
+
+2. Log in to npm `yarn login`
+
+3. Publish: `yarn publish`
+
+

data/Gemfile

@@ -14,10 +14,12 @@ group :test do
   gem 'rack-test', require: 'rack/test'
   gem 'jasmine'
   gem 'puma'
+  gem 'm'
 end
 
 group :test, :development do
   gem 'byebug'
+  gem 'oj'
 end
 
 group :development do

data/README.md

@@ -10,12 +10,6 @@ MessageBus is implemented as Rack middleware and can be used by any Rails / Sina
 
 Read the generated docs: <https://www.rubydoc.info/gems/message_bus>
 
-## Try it out!
-
-Live chat demo per [examples/chat](https://github.com/SamSaffron/message_bus/tree/master/examples/chat) is at:
-
-### http://chat.samsaffron.com
-
 ## Ruby version support
 
 MessageBus only support officially supported versions of Ruby; as of [2018-06-20](https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/) this means we only support Ruby version 2.3 and up.
@@ -304,6 +298,11 @@ MessageBus.subscribe("/channel", function(data){
 MessageBus.subscribe("/channel", function(data){
   // data shipped from server
 }, -3);
+
+// you will get the entire backlog
+MessageBus.subscribe("/channel", function(data){
+  // data shipped from server
+}, 0);
 ```
 
 #### JavaScript Client settings
@@ -436,6 +435,31 @@ MessageBus.configure(backend: :memory)
 
 The `:clear_every` option supported by the PostgreSQL backend is also supported by the in-memory backend.
 
+
+### Transport codecs
+
+By default MessageBus serializes messages to the backend using JSON. Under most situation this performs extremely well.
+
+In some exceptional cases you may consider a different transport codec. To configure a custom codec use:
+
+```ruby
+MessageBus.configure(transport_codec: codec)
+```
+
+A codec class must implement MessageBus::Codec::Base. Specifically an `encode` and `decode` method.
+
+See the `bench` directory for examples where the default JSON codec can perform poorly. A specific examples may be
+attempting to distribute a message to a restricted list of thousands of users. In cases like this you may consider
+using a packed string encoder.
+
+Keep in mind, much of MessageBus internals and supporting tools expect data to be converted to JSON and back, if you use a naive (and fast) `Marshal` based codec you may need to limit the features you use. Specifically the Postgresql backend expects the codec never to return a string with `\u0000`, additionally some classes like DistributedCache expect keys to be converted to Strings.
+
+Another example may be very large and complicated messages where Oj in compatability mode outperforms JSON. To opt for the Oj codec use:
+
+```
+MessageBus.configure(transport_codec: MessageBus::Codec::Oj.new)
+```
+
 ### Forking/threading app servers
 
 If you're using a forking or threading app server and you're not getting immediate delivery of published messages, you might need to configure your web server to re-connect to the message_bus backend

data/Rakefile

@@ -94,5 +94,5 @@ desc "Run all tests, link checks and confirms documentation compiles without err
 task default: [:spec, :rubocop, :test_doc]
 
 Rake::Task['release'].enhance do
-  sh "npm publish"
+  sh "yarn publish"
 end

data/assets/message-bus-ajax.js

@@ -8,17 +8,11 @@
       throw new Error("MessageBus must be loaded before the ajax adapter");
   }
 
-  var cacheBuster =  Math.random() * 10000 | 0;
-
   global.MessageBus.ajax = function(options){
     var XHRImpl = (global.MessageBus && global.MessageBus.xhrImplementation) || global.XMLHttpRequest;
     var xhr = new XHRImpl();
     xhr.dataType = options.dataType;
-    var url = options.url;
-    if (!options.cache){
-      url += ((-1 == url.indexOf('?')) ? '?' : '&') + '_=' + (cacheBuster++)
-    }
-    xhr.open('POST', url);
+    xhr.open('POST', options.url);
     for (var name in options.headers){
       xhr.setRequestHeader(name, options.headers[name]);
     }

data/assets/message-bus.js

@@ -1,9 +1,9 @@
-/*jshint bitwise: false*/
+/*global define, jQuery*/
 
 (function (root, factory) {
-  if (typeof define === 'function' && define.amd) {
+  if (typeof define === "function" && define.amd) {
     // AMD. Register as an anonymous module.
-    define([], function (b) {
+    define([], function () {
       // Also create a global in case some scripts
       // that are loaded still are looking for
       // a global even when an AMD loader is in use.
@@ -13,12 +13,12 @@
     // Browser globals
     root.MessageBus = factory();
   }
-}(typeof self !== 'undefined' ? self : this, function () {
+})(typeof self !== "undefined" ? self : this, function () {
   "use strict";
 
   // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript
-  var uniqueId = function() {
-    return "xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx".replace(/[xy]/g, function(c) {
+  var uniqueId = function () {
+    return "xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx".replace(/[xy]/g, function (c) {
       var r = (Math.random() * 16) | 0;
       var v = c === "x" ? r : (r & 0x3) | 0x8;
       return v.toString(16);
@@ -31,8 +31,6 @@
   var started = false;
   var clientId = uniqueId();
   var callbacks = [];
-  var queue = [];
-  var interval = null;
   var failCount = 0;
   var baseUrl = "/";
   var paused = false;
@@ -44,7 +42,7 @@
   var totalAjaxCalls = 0;
   var lastAjax;
 
-  var isHidden = (function() {
+  var isHidden = (function () {
     var prefixes = ["", "webkit", "ms", "moz"];
     var hiddenProperty;
     for (var i = 0; i < prefixes.length; i++) {
@@ -55,7 +53,7 @@
       }
     }
 
-    return function() {
+    return function () {
       if (hiddenProperty !== undefined) {
         return document[hiddenProperty];
       } else {
@@ -64,7 +62,7 @@
     };
   })();
 
-  var hasLocalStorage = (function() {
+  var hasLocalStorage = (function () {
     try {
       localStorage.setItem("mbTestLocalStorage", Date.now());
       localStorage.removeItem("mbTestLocalStorage");
@@ -74,13 +72,13 @@
     }
   })();
 
-  var updateLastAjax = function() {
+  var updateLastAjax = function () {
     if (hasLocalStorage) {
       localStorage.setItem("__mbLastAjax", Date.now());
     }
   };
 
-  var hiddenTabShouldWait = function() {
+  var hiddenTabShouldWait = function () {
     if (hasLocalStorage && isHidden()) {
       var lastAjaxCall = parseInt(localStorage.getItem("__mbLastAjax"), 10);
       var deltaAjax = Date.now() - lastAjaxCall;
@@ -91,20 +89,21 @@
   };
 
   var hasonprogress = new XMLHttpRequest().onprogress === null;
-  var allowChunked = function() {
+  var allowChunked = function () {
     return me.enableChunkedEncoding && hasonprogress;
   };
 
-  var shouldLongPoll = function() {
+  var shouldLongPoll = function () {
     return (
       me.alwaysLongPoll ||
       (me.shouldLongPollCallback ? me.shouldLongPollCallback() : !isHidden())
     );
   };
 
-  var processMessages = function(messages) {
-    var gotData = false;
-    if ((!messages) || (messages.length === 0)) { return false; }
+  var processMessages = function (messages) {
+    if (!messages || messages.length === 0) {
+      return false;
+    }
 
     for (var i = 0; i < messages.length; i++) {
       var message = messages[i];
@@ -136,7 +135,7 @@
     return true;
   };
 
-  var reqSuccess = function(messages) {
+  var reqSuccess = function (messages) {
     failCount = 0;
     if (paused) {
       if (messages) {
@@ -150,7 +149,7 @@
     return false;
   };
 
-  var longPoller = function(poll, data) {
+  var longPoller = function (poll, data) {
     if (ajaxInProgress) {
       // never allow concurrent ajax reqs
       return;
@@ -183,7 +182,7 @@
 
     var dataType = chunked ? "text" : "json";
 
-    var handle_progress = function(payload, position) {
+    var handle_progress = function (payload, position) {
       var separator = "\r\n|\r\n";
       var endChunk = payload.indexOf(separator, position);
 
@@ -206,31 +205,13 @@
       return handle_progress(payload, endChunk + separator.length);
     };
 
-    var disableChunked = function() {
+    var disableChunked = function () {
       if (me.longPoll) {
         me.longPoll.abort();
         chunkedBackoff = 30;
       }
     };
 
-    var setOnProgressListener = 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);
-      xhr.onprogress = function() {
-        clearTimeout(chunkedTimeout);
-        if (
-          xhr.getResponseHeader("Content-Type") ===
-          "application/json; charset=utf-8"
-        ) {
-          // not chunked we are sending json back
-          chunked = false;
-          return;
-        }
-        position = handle_progress(xhr.responseText, position);
-      };
-    };
     if (!me.ajax) {
       throw new Error("Either jQuery or the ajax adapter must be loaded");
     }
@@ -246,19 +227,18 @@
         "/poll" +
         (!longPoll ? "?dlp=t" : ""),
       data: data,
-      cache: false,
       async: true,
       dataType: dataType,
       type: "POST",
       headers: headers,
       messageBus: {
         chunked: chunked,
-        onProgressListener: function(xhr) {
+        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);
-          return (xhr.onprogress = function() {
+          return (xhr.onprogress = function () {
             clearTimeout(chunkedTimeout);
             if (
               xhr.getResponseHeader("Content-Type") ===
@@ -269,9 +249,9 @@
               position = handle_progress(xhr.responseText, position);
             }
           });
-        }
+        },
       },
-      xhr: function() {
+      xhr: function () {
         var xhr = jQuery.ajaxSettings.xhr();
         if (!chunked) {
           return xhr;
@@ -279,7 +259,7 @@
         this.messageBus.onProgressListener(xhr);
         return xhr;
       },
-      success: function(messages) {
+      success: function (messages) {
         if (!chunked) {
           // we may have requested text so jQuery will not parse
           if (typeof messages === "string") {
@@ -288,7 +268,7 @@
           gotData = reqSuccess(messages);
         }
       },
-      error: function(xhr, textStatus, err) {
+      error: function (xhr, textStatus) {
         if (xhr.status === 429) {
           var tryAfter =
             parseInt(
@@ -307,7 +287,7 @@
           totalAjaxFailures += 1;
         }
       },
-      complete: function() {
+      complete: function () {
         ajaxInProgress = false;
 
         var interval;
@@ -345,14 +325,14 @@
         }
 
         if (started) {
-          pollTimeout = setTimeout(function() {
+          pollTimeout = setTimeout(function () {
             pollTimeout = null;
             poll();
           }, interval);
         }
 
         me.longPoll = null;
-      }
+      },
     });
 
     return req;
@@ -374,7 +354,7 @@
     baseUrl: baseUrl,
     headers: {},
     ajax: typeof jQuery !== "undefined" && jQuery.ajax,
-    diagnostics: function() {
+    diagnostics: function () {
       console.log("Stopped: " + stopped + " Started: " + started);
       console.log("Current callbacks");
       console.log(callbacks);
@@ -391,42 +371,50 @@
       );
     },
 
-    pause: function() {
+    pause: function () {
       paused = true;
     },
 
-    resume: function() {
+    resume: function () {
       paused = false;
       processMessages(later);
       later = [];
     },
 
-    stop: function() {
+    stop: function () {
       stopped = true;
       started = false;
       if (delayPollTimeout) {
         clearTimeout(delayPollTimeout);
         delayPollTimeout = null;
       }
+      if (pollTimeout) {
+        clearTimeout(pollTimeout);
+        pollTimeout = null;
+      }
       if (me.longPoll) {
         me.longPoll.abort();
       }
+      if (me.onVisibilityChange) {
+        document.removeEventListener("visibilitychange", me.onVisibilityChange);
+        me.onVisibilityChange = null;
+      }
     },
 
     // Start polling
-    start: function() {
+    start: function () {
       if (started) return;
       started = true;
       stopped = false;
 
-      var poll = function() {
+      var poll = function () {
         if (stopped) {
           return;
         }
 
         if (callbacks.length === 0 || hiddenTabShouldWait()) {
           if (!delayPollTimeout) {
-            delayPollTimeout = setTimeout(function() {
+            delayPollTimeout = setTimeout(function () {
               delayPollTimeout = null;
               poll();
             }, parseInt(500 + Math.random() * 500));
@@ -448,25 +436,28 @@
 
       // monitor visibility, issue a new long poll when the page shows
       if (document.addEventListener && "hidden" in document) {
-        me.visibilityEvent = document.addEventListener(
-          "visibilitychange",
-          function() {
-            if (!document.hidden && !me.longPoll && pollTimeout) {
-              clearTimeout(pollTimeout);
-              clearTimeout(delayPollTimeout);
-
-              delayPollTimeout = null;
-              pollTimeout = null;
-              poll();
-            }
+        me.onVisibilityChange = function () {
+          if (
+            !document.hidden &&
+            !me.longPoll &&
+            (pollTimeout || delayPollTimeout)
+          ) {
+            clearTimeout(pollTimeout);
+            clearTimeout(delayPollTimeout);
+
+            delayPollTimeout = null;
+            pollTimeout = null;
+            poll();
           }
-        );
+        };
+
+        document.addEventListener("visibilitychange", me.onVisibilityChange);
       }
 
       poll();
     },
 
-    status: function() {
+    status: function () {
       if (paused) {
         return "paused";
       } else if (started) {
@@ -484,13 +475,18 @@
     // -1 will subscribe to all new messages
     // -2 will recieve last message + all new messages
     // -3 will recieve last 2 messages + all new messages
-    subscribe: function(channel, func, lastId) {
+    // if undefined will default to -1
+    subscribe: function (channel, func, lastId) {
       if (!started && !stopped) {
         me.start();
       }
 
-      if (typeof lastId !== "number") {
+      if (lastId === null || typeof lastId === "undefined") {
         lastId = -1;
+      } else if (typeof lastId !== "number") {
+        throw (
+          "lastId has type " + typeof lastId + " but a number was expected."
+        );
       }
 
       if (typeof channel !== "string") {
@@ -500,7 +496,7 @@
       callbacks.push({
         channel: channel,
         func: func,
-        last_id: lastId
+        last_id: lastId,
       });
       if (me.longPoll) {
         me.longPoll.abort();
@@ -510,7 +506,7 @@
     },
 
     // Unsubscribe from a channel
-    unsubscribe: function(channel, func) {
+    unsubscribe: function (channel, func) {
       // TODO allow for globbing in the middle of a channel name
       // like /something/*/something
       // at the moment we only support globbing /something/*
@@ -547,7 +543,7 @@
       }
 
       return removed;
-    }
+    },
   };
   return me;
-}));
+});