message_bus 3.3.0 → 3.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4103e822baabb87e382a7c3c960605fa31d737fd89ed2b2f2036a9983fbf8fc
-  data.tar.gz: d3f83ce786dd1a06b495a3773041145bea990869462238d46e723c4f9e82a0e7
+  metadata.gz: f34126c192c671b895e7cf912a04ffcb5d05a5a5447786c3f5e3db3595c79004
+  data.tar.gz: 5a638bf3eb07680d17d93b762bc41d92d8b4c4412d9f3fae3e7410ec2ae67488
 SHA512:
-  metadata.gz: f2623043461d284141e727cd28c20750d544ac6edc047c2332f1f306bceb6afc79f154261d4f94085cc6f18396274c2d9ec8fc662cb6185c54e7220675f352c2
-  data.tar.gz: 12b3027295123f1c17468ef56920c19f57aeec82bc9ffb75bb0054fb8a426560c52f552b5150f02cab02ae3979a3161777bd2ae42d023aee53e1a2b37d41f772
+  metadata.gz: f7102c7e62cc9854237fab235e2020f318bbdc956ba64f6d0c77c515430df1169bb06e01a9125f71631546daa3dfa1179c971ca207f32a9cda96880b0d9be6c6
+  data.tar.gz: 91b8e655e1dc27b4f386477d38dea8ef4f44daa658793a2205392135cb2f846a80ac0aca52fc04c9a471990b64cb18c6ea9dbd36818690c28cac0c80f922d8be

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/.rubocop.yml

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

data/CHANGELOG

@@ -1,4 +1,52 @@
-- Unreleased
+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
+
+  - FIX: Disconnect Redis conn when rescuing errors in global subscribe.
+  - FIX: `MessageBus::Backends::Redis#global_subscribe` not closing Redis connections.
+
+15-05-2020
+
+- Version 3.3.0
 
    - FEATURE: `MessageBus.base_route=` to alter the route that message bus will listen on.
 

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/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

data/Rakefile

@@ -92,3 +92,7 @@ end
 
 desc "Run all tests, link checks and confirms documentation compiles without error"
 task default: [:spec, :rubocop, :test_doc]
+
+Rake::Task['release'].enhance do
+  sh "npm 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

@@ -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;
@@ -103,7 +101,6 @@
   };
 
   var processMessages = function(messages) {
-    var gotData = false;
     if ((!messages) || (messages.length === 0)) { return false; }
 
     for (var i = 0; i < messages.length; i++) {
@@ -213,24 +210,6 @@
       }
     };
 
-    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,7 +225,6 @@
         "/poll" +
         (!longPoll ? "?dlp=t" : ""),
       data: data,
-      cache: false,
       async: true,
       dataType: dataType,
       type: "POST",
@@ -451,7 +429,7 @@
         me.visibilityEvent = document.addEventListener(
           "visibilitychange",
           function() {
-            if (!document.hidden && !me.longPoll && pollTimeout) {
+            if (!document.hidden && !me.longPoll && (pollTimeout || delayPollTimeout)) {
               clearTimeout(pollTimeout);
               clearTimeout(delayPollTimeout);
 
@@ -484,13 +462,16 @@
     // -1 will subscribe to all new messages
     // -2 will recieve last message + all new messages
     // -3 will recieve last 2 messages + all new messages
+    // 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") {

data/lib/message_bus.rb

@@ -20,6 +20,7 @@ end
 module MessageBus; end
 MessageBus::BACKENDS = {}
 class MessageBus::InvalidMessage < StandardError; end
+class MessageBus::InvalidMessageTarget < MessageBus::InvalidMessage; end
 class MessageBus::BusDestroyed < StandardError; end
 
 # The main server-side interface to a message bus for the purposes of
@@ -329,6 +330,7 @@ module MessageBus::Implementation
   #
   # @raise [MessageBus::BusDestroyed] if the bus is destroyed
   # @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
 
@@ -348,7 +350,13 @@ module MessageBus::Implementation
       site_id = opts[:site_id]
     end
 
-    raise ::MessageBus::InvalidMessage if (user_ids || group_ids) && global?(channel)
+    if (user_ids || group_ids) && global?(channel)
+      raise ::MessageBus::InvalidMessage
+    end
+
+    if (user_ids == []) || (group_ids == []) || (client_ids == [])
+      raise ::MessageBus::InvalidMessageTarget
+    end
 
     encoded_data = JSON.dump(
       data: data,
@@ -357,13 +365,17 @@ module MessageBus::Implementation
       client_ids: client_ids
     )
 
-    channel_opts = nil
+    channel_opts = {}
 
-    if opts && ((age = opts[:max_backlog_age]) || (size = opts[:max_backlog_size]))
-      channel_opts = {
-        max_backlog_size: size,
-        max_backlog_age: age
-      }
+    if opts
+      if ((age = opts[:max_backlog_age]) || (size = opts[:max_backlog_size]))
+        channel_opts[:max_backlog_size] = size
+        channel_opts[:max_backlog_age] = age
+      end
+
+      if opts.has_key?(:queue_in_memory)
+        channel_opts[:queue_in_memory] = opts[:queue_in_memory]
+      end
     end
 
     encoded_channel_name = encode_channel_name(channel, site_id)

data/lib/message_bus/backends/redis.rb

@@ -251,11 +251,11 @@ LUA
 
       # (see Base#global_unsubscribe)
       def global_unsubscribe
-        if @redis_global
-          # new connection to avoid deadlock
-          new_redis_connection.publish(redis_channel_name, UNSUB_MESSAGE)
-          @redis_global.disconnect
-          @redis_global = nil
+        begin
+          new_redis = new_redis_connection
+          new_redis.publish(redis_channel_name, UNSUB_MESSAGE)
+        ensure
+          new_redis&.disconnect!
         end
       end
 
@@ -278,13 +278,13 @@ LUA
         end
 
         begin
-          @redis_global = new_redis_connection
+          global_redis = new_redis_connection
 
           if highest_id
             clear_backlog.call(&blk)
           end
 
-          @redis_global.subscribe(redis_channel_name) do |on|
+          global_redis.subscribe(redis_channel_name) do |on|
             on.subscribe do
               if highest_id
                 clear_backlog.call(&blk)
@@ -298,7 +298,7 @@ LUA
 
             on.message do |_c, m|
               if m == UNSUB_MESSAGE
-                @redis_global.unsubscribe
+                global_redis.unsubscribe
                 return
               end
               m = MessageBus::Message.decode m
@@ -318,9 +318,12 @@ LUA
             end
           end
         rescue => error
-          @logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack #{error.backtrace}"
+          @logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack #{error.backtrace.join("\n")}"
           sleep 1
+          global_redis&.disconnect!
           retry
+        ensure
+          global_redis&.disconnect!
         end
       end
 

data/lib/message_bus/client.rb

@@ -133,7 +133,6 @@ class MessageBus::Client
     user_allowed = false
     group_allowed = false
 
-    # this is an inconsistency we should fix anyway, publishing `user_ids: nil` should work same as groups
     has_users = msg.user_ids && msg.user_ids.length > 0
     has_groups = msg.group_ids && msg.group_ids.length > 0
 

data/lib/message_bus/distributed_cache.rb

@@ -16,11 +16,12 @@ module MessageBus
 
       attr_accessor :app_version
 
-      def initialize(message_bus = nil)
+      def initialize(message_bus = nil, publish_queue_in_memory: true)
         @subscribers = []
         @subscribed = false
         @lock = Mutex.new
         @message_bus = message_bus || MessageBus
+        @publish_queue_in_memory = publish_queue_in_memory
       end
 
       def subscribers
@@ -75,7 +76,11 @@ module MessageBus
         message[:origin] = hash.identity
         message[:hash_key] = hash.key
         message[:app_version] = @app_version if @app_version
-        @message_bus.publish(CHANNEL_NAME, message, user_ids: [-1])
+
+        @message_bus.publish(CHANNEL_NAME, message,
+          user_ids: [-1],
+          queue_in_memory: @publish_queue_in_memory
+        )
       end
 
       def set(hash, key, value)

data/lib/message_bus/message.rb

@@ -20,10 +20,10 @@ class MessageBus::Message < Struct.new(:global_id, :message_id, :channel, :data)
 
   # only tricky thing to encode is pipes in a channel name ... do a straight replace
   def encode
-    global_id.to_s << "|" << message_id.to_s << "|" << channel.gsub("|", "$$123$$") << "|" << data
+    "#{global_id}|#{message_id}|#{channel.gsub("|", "$$123$$")}|#{data}"
   end
 
   def encode_without_ids
-    channel.gsub("|", "$$123$$") << "|" << data
+    "#{channel.gsub("|", "$$123$$")}|#{data}"
   end
 end

data/lib/message_bus/rack/middleware.rb

@@ -81,6 +81,22 @@ class MessageBus::Rack::Middleware
     client_id = env['PATH_INFO'][@base_route_length..-1].split("/")[0]
     return [404, {}, ["not found"]] unless client_id
 
+    headers = {}
+    headers["Cache-Control"] = "must-revalidate, private, max-age=0"
+    headers["Content-Type"] = "application/json; charset=utf-8"
+    headers["Pragma"] = "no-cache"
+    headers["Expires"] = "0"
+
+    if @bus.extra_response_headers_lookup
+      @bus.extra_response_headers_lookup.call(env).each do |k, v|
+        headers[k] = v
+      end
+    end
+
+    if env["REQUEST_METHOD"] == "OPTIONS"
+      return [200, headers, ["OK"]]
+    end
+
     user_id = @bus.user_id_lookup.call(env) if @bus.user_id_lookup
     group_ids = @bus.group_ids_lookup.call(env) if @bus.group_ids_lookup
     site_id = @bus.site_id_lookup.call(env) if @bus.site_id_lookup
@@ -111,22 +127,6 @@ class MessageBus::Rack::Middleware
       end
     end
 
-    headers = {}
-    headers["Cache-Control"] = "must-revalidate, private, max-age=0"
-    headers["Content-Type"] = "application/json; charset=utf-8"
-    headers["Pragma"] = "no-cache"
-    headers["Expires"] = "0"
-
-    if @bus.extra_response_headers_lookup
-      @bus.extra_response_headers_lookup.call(env).each do |k, v|
-        headers[k] = v
-      end
-    end
-
-    if env["REQUEST_METHOD"] == "OPTIONS"
-      return [200, headers, ["OK"]]
-    end
-
     long_polling = @bus.long_polling_enabled? &&
                    env['QUERY_STRING'] !~ /dlp=t/ &&
                    @connection_manager.client_count < @bus.max_active_clients

data/lib/message_bus/timer_thread.rb

@@ -45,7 +45,14 @@ class MessageBus::TimerThread
     while running
       @mutex.synchronize do
         running = @thread && @thread.alive?
-        @thread.wakeup if running
+
+        if running
+          begin
+            @thread.wakeup
+          rescue ThreadError
+            raise if @thread.alive?
+          end
+        end
       end
       sleep 0
     end

data/lib/message_bus/version.rb

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

data/message_bus.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.name          = "message_bus"
   gem.require_paths = ["lib"]
   gem.version       = MessageBus::VERSION
-  gem.required_ruby_version = ">= 2.3.0"
+  gem.required_ruby_version = ">= 2.4.0"
   gem.add_runtime_dependency 'rack', '>= 1.1.3'
   gem.add_development_dependency 'redis'
   gem.add_development_dependency 'pg'

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "message-bus-client",
-  "version": "3.3.0",
+  "version": "3.3.5",
   "description": "A message bus client in Javascript",
   "main": "assets/message-bus.js",
   "keywords": "es6, modules",

data/spec/lib/message_bus_spec.rb

@@ -201,6 +201,13 @@ describe MessageBus do
     @bus.backlog("/chuck").map { |i| i.data }.to_a.must_equal ['norris', 'foo']
   end
 
+  it "should correctly restrict the backlog size of a channel" do
+    @bus.publish("/chuck", "norris")
+    @bus.publish("/chuck", "foo", max_backlog_size: 1)
+
+    @bus.backlog("/chuck").map { |i| i.data }.to_a.must_equal ['foo']
+  end
+
   it "allows you to look up last_message" do
     @bus.publish("/bob", "dylan")
     @bus.publish("/bob", "marley")
@@ -266,15 +273,37 @@ describe MessageBus do
     end
 
     it "should exception if publishing restricted messages to user" do
-      lambda do
+      assert_raises(MessageBus::InvalidMessage) do
         @bus.publish("/global/test", "test", user_ids: [1])
-      end.must_raise(MessageBus::InvalidMessage)
+      end
     end
 
     it "should exception if publishing restricted messages to group" do
-      lambda do
+      assert_raises(MessageBus::InvalidMessage) do
         @bus.publish("/global/test", "test", user_ids: [1])
-      end.must_raise(MessageBus::InvalidMessage)
+      end
+    end
+
+    it "should raise if we publish to an empty group or user list" do
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", user_ids: []
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", group_ids: []
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", client_ids: []
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", group_ids: [], user_ids: [1]
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", group_ids: [1], user_ids: []
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.5
 platform: ruby
 authors:
 - Sam Saffron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -59,10 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG
+- DEV.md
 - Dockerfile
 - Gemfile
 - Guardfile
@@ -141,7 +142,7 @@ homepage: https://github.com/SamSaffron/message_bus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,15 +150,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: ''
 test_files:

data/.travis.yml

@@ -1,17 +0,0 @@
-before_install: gem install bundler
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-gemfile:
-  - Gemfile
-addons:
-  postgresql: "9.4"
-env:
-  - PGUSER=postgres
-before_script:
-  - psql -c 'create database message_bus_test;' -U postgres
-services:
-  - redis-server
-  - postgresql