message_bus 3.3.4 → 3.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e75dd767a8a80412a222bf74a50517711198a32cec7d4c772b160cee0f3792ad
-  data.tar.gz: c2d113e2e1e02038883e532c0308342d05fb9950d1a26a403e1c97565e0fab39
+  metadata.gz: f34126c192c671b895e7cf912a04ffcb5d05a5a5447786c3f5e3db3595c79004
+  data.tar.gz: 5a638bf3eb07680d17d93b762bc41d92d8b4c4412d9f3fae3e7410ec2ae67488
 SHA512:
-  metadata.gz: 4f35da832720aea8ac7295664846c8fa9f1f9d56cb6f6a9920bdf00710d67b558f28dc1390faf8379c860ebf9bca3eb366bff9554ce9bdb71fa86e74f5ec7b00
-  data.tar.gz: 5e5da62e131c0a2f7772d69758acd27fa3f43c7e993212ef81de36b280bb0dcccddc51b444ff5d3994f0b5f0cc224898c363a60f000c0c53544dec3b34492966
+  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,11 @@
-- Unrelease
+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
 

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.

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);
 

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "3.3.4"
+  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",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 3.3.5
 platform: ruby
 authors:
 - Sam Saffron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-02 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.1.2
-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.5
-  - 2.6
-  - 2.7
-gemfile:
-  - Gemfile
-addons:
-  postgresql: "9.4"
-env:
-  - PGUSER=postgres
-before_script:
-  - psql -c 'create database message_bus_test;' -U postgres
-services:
-  - redis-server
-  - postgresql