message_bus 3.3.4 → 3.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e75dd767a8a80412a222bf74a50517711198a32cec7d4c772b160cee0f3792ad
-  data.tar.gz: c2d113e2e1e02038883e532c0308342d05fb9950d1a26a403e1c97565e0fab39
+  metadata.gz: b45c0d65f5a82c9465f620059d2125ebca09ee5619a9094fcbc309a0e179a983
+  data.tar.gz: b691c40ae2360ae661aa83f83e9647cb0223a70a6ca536f285db21ce791a3ae3
 SHA512:
-  metadata.gz: 4f35da832720aea8ac7295664846c8fa9f1f9d56cb6f6a9920bdf00710d67b558f28dc1390faf8379c860ebf9bca3eb366bff9554ce9bdb71fa86e74f5ec7b00
-  data.tar.gz: 5e5da62e131c0a2f7772d69758acd27fa3f43c7e993212ef81de36b280bb0dcccddc51b444ff5d3994f0b5f0cc224898c363a60f000c0c53544dec3b34492966
+  metadata.gz: 2bb5db140d0fc8bbee5df6e00f57560b1e399c7cac86d825f9841c4c9d8bc805ec8f9ab2ea8ba0ad066c53039a44b5044ecef7299a74f942b3a52cd426ecbef6
+  data.tar.gz: 66fdc2a3c483d1b775b3963b71bdc422edcdf16233cb47aa2ec99d3a6946e6e0f6f6ca917db12e5d528de6dfb39cc494923e2abe380ca0c75d64d92f6f167d7e

data/.eslintrc.js

@@ -0,0 +1,21 @@
+/*global module*/
+module.exports = {
+  env: {
+    browser: true,
+    es2021: false,
+  },
+  extends: 'eslint:recommended',
+  parserOptions: {
+    ecmaVersion: 2015,
+    sourceType: 'module',
+  },
+  rules: {},
+  ignorePatterns: [
+    '/vendor',
+    '/doc',
+    '/assets/babel.min.js',
+    '/assets/jquery-1.8.2.js',
+    '/assets/react-dom.js',
+    '/assets/react.js',
+  ],
+};

data/.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }} (redis ${{ matrix.redis }})
+    timeout-minutes: 10
+
+    env:
+      PGHOST: localhost
+      PGPASSWORD: postgres
+      PGUSER: postgres
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7, 3.0]
+        redis: [5, 6]
+
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_DB: message_bus_test
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      redis:
+        image: ${{ format('redis:{0}', matrix.redis) }}
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: npm
+
+      - name: Setup npm
+        run: npm install
+
+      - name: Tests
+        run: bundle exec rake
+        timeout-minutes: 3
+
+      - name: Linting
+        run: npx eslint .
+
+  publish:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release gem
+        uses: discourse/publish-rubygems-action@v2
+        id: publish-gem
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot
+
+      - name: Update package version
+        if: steps.publish-gem.outputs.new_version == 'true'
+        run: |
+          VERSION=$(ruby -r './lib/message_bus/version' -e 'puts MessageBus::VERSION')
+          sed -i "s/0.0.0-version-placeholder/$VERSION/" package.json
+          git config --global user.email "ci@ci.invalid"
+          git config --global user.name "Discourse CI"
+          git add package.json
+          git commit -m 'bump'
+
+      - name: Publish package
+        uses: JS-DevTools/npm-publish@v1
+        if: steps.publish-gem.outputs.new_version == 'true'
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

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

@@ -0,0 +1 @@
+{}

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,26 @@
-- Unrelease
+15-12-2021
+
+- Version 3.3.7
+
+  - FIX: Prevent simple polling from clobbering the session
+  - SECURITY: Fix path traversal on diagnostics route.
+
+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 visibility 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
 
@@ -47,7 +69,7 @@
 
 - Version 3.2.0
 
-   - FIX: compatability with Rails 6.0.3, note: apps without ActionDispatch::Flash may stop working after this upgrade
+   - FIX: compatibility with Rails 6.0.3, note: apps without ActionDispatch::Flash may stop working after this upgrade
    to correct this disable middleware injection with `config.skip_message_bus_middleware = true` and configure middleware by hand with `app.middleware.use(MessageBus::Rack::Middleware)`
 
 28-04-2020
@@ -174,7 +196,7 @@
 
 - Version 2.1.6
 
-- FEATURE: `MesssageBus.publish` accepts option `site_id` to publish to a site
+- FEATURE: `MessageBus.publish` accepts option `site_id` to publish to a site
 - FEATURE: Added MessageBus::DistributedCache for cross process caching
 - PERF: Use monotonic times in timer thread
 - FEATURE: min poll interval is now configurable client side
@@ -238,7 +260,7 @@
 
 - Version 2.0.6
 
-- Fix: correct after_fork so it correctly disconnnects redis
+- Fix: correct after_fork so it correctly disconnects redis
 - Fix: correct message_bus #destroy used in tests to clean up spec (deadlock)
 - Fix: deliver backlog unconditionally when polling (and not long polling)
 
@@ -308,7 +330,7 @@
 
 - Version 2.0.0.beta.6
 
-- Feature: Support standalone opertion without depending on jQuery @nathanstitt
+- Feature: Support standalone operation without depending on jQuery @nathanstitt
 - Feature: Support a noconflict mode @nathanstitt
 - Feature: Support JSON POST payload @nathanstitt
 
@@ -354,7 +376,7 @@
 - Version 1.1.0
 - Fix: keep track of client sequence on server, abandon old subscribes
 - Fix: rare concurrency issue when subscribing concurrently
-- Fature: remove most jQuery dependency from message-bus.js
+- Feature: remove most jQuery dependency from message-bus.js
 
 09-07-2015
 - Version 1.0.16
@@ -378,7 +400,7 @@
 
 28-05-2015
 - Version 1.0.12
-- Feature: Support client_id targetted message
+- Feature: Support client_id targeted message
 
 06-05-2015
 - Version 1.0.11
@@ -387,7 +409,7 @@
 01-05-2015
 - Version: 1.0.10
 - Feature: no longer depends on EventMachine (only used for Thin backend)
-- Feature: realiable pub sub will queue messages in memory if redis is readonly, configurable
+- Feature: reliable pub sub will queue messages in memory if redis is readonly, configurable
 - Fix: if redis is flushed we will continue to deliver messages
 
 23-03-2015

data/DEV.md

@@ -0,0 +1,7 @@
+### 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

@@ -3,28 +3,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in message_bus.gemspec
 gemspec
-
-group :test do
-  gem 'minitest'
-  gem 'minitest-hooks'
-  gem 'minitest-global_expectations'
-  gem 'rake'
-  gem 'http_parser.rb'
-  gem 'thin'
-  gem 'rack-test', require: 'rack/test'
-  gem 'jasmine'
-  gem 'puma'
-end
-
-group :test, :development do
-  gem 'byebug'
-end
-
-group :development do
-  gem 'yard'
-  gem 'rubocop-discourse', require: false
-  gem 'rubocop-rspec', require: false
-end
-
-gem 'rack'
-gem 'concurrent-ruby' # for distributed-cache

data/LICENSE

@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -10,15 +10,9 @@ 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.
+MessageBus only support officially supported versions of Ruby; as of [2021-03-31](https://www.ruby-lang.org/en/downloads/branches/) this means we only support Ruby version 2.6 and up.
 
 ## Can you handle concurrent requests?
 
@@ -74,19 +68,19 @@ id = MessageBus.last_id("/channel")
 MessageBus.backlog "/channel", id
 ```
 
-### Targetted messages
+### Targeted messages
 
-Messages can be targetted to particular clients by supplying the `client_ids` option when publishing a message.
+Messages can be targeted to particular clients by supplying the `client_ids` option when publishing a message.
 
 ```ruby
 MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"] # (using MessageBus.clientId)
 ```
 
-By configuring the `user_id_lookup` and `group_ids_lookup` options with a Proc or Lambda which will be called with a [Rack specification environment](https://github.com/rack/rack/blob/master/SPEC.rdoc#the-environment-), messages can be targetted to particular clients users or groups by supplying either the `user_ids` or `group_ids` options when publishing a message.
+By configuring the `user_id_lookup` and `group_ids_lookup` options with a Proc or Lambda which will be called with a [Rack specification environment](https://github.com/rack/rack/blob/master/SPEC.rdoc#the-environment-), messages can be targeted to particular clients users or groups by supplying either the `user_ids` or `group_ids` options when publishing a message.
 
 ```ruby
 MessageBus.configure(user_id_lookup: proc do |env|
-  # this lookup occurs on JS-client poolings, so that server can retrieve backlog
+  # this lookup occurs on JS-client polling, so that server can retrieve backlog
   # for the client considering/matching/filtering user_ids set on published messages
   # if user_id is not set on publish time, any user_id returned here will receive the message
   # return the user id here
@@ -104,7 +98,7 @@ end)
 MessageBus.publish "/channel", "hello", group_ids: [1, 2, 3]
 
 # example of MessageBus to set user_ids from an initializer in Rails and Devise:
-# config/inializers/message_bus.rb
+# config/initializers/message_bus.rb
 MessageBus.user_id_lookup do |env|
   req = Rack::Request.new(env)
 
@@ -115,13 +109,13 @@ MessageBus.user_id_lookup do |env|
 end
 ```
 
-If both `user_ids` and `group_ids` options are supplied when publishing a message, the message will be targetted at clients with lookup return values that  matches on either the `user_ids` **or** the `group_ids` options.
+If both `user_ids` and `group_ids` options are supplied when publishing a message, the message will be targeted at clients with lookup return values that  matches on either the `user_ids` **or** the `group_ids` options.
 
 ```ruby
 MessageBus.publish "/channel", "hello", user_ids: [1, 2, 3], group_ids: [1, 2, 3]
 ```
 
-If the `client_ids` option is supplied with either the `user_ids` or `group_ids` options when publising a message, the `client_ids` option will be applied unconditionally and messages will be filtered further using `user_id` or `group_id` clauses.
+If the `client_ids` option is supplied with either the `user_ids` or `group_ids` options when publishing a message, the `client_ids` option will be applied unconditionally and messages will be filtered further using `user_id` or `group_id` clauses.
 
 ```ruby
 MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"], user_ids: [1, 2, 3], group_ids: [1, 2, 3]
@@ -251,7 +245,7 @@ end)
 MessageBus.publish "/channel", "some message"
 
 # you can also choose to pass the `:site_id`.
-# This takes precendence over whatever `site_id_lookup`
+# This takes precedence over whatever `site_id_lookup`
 # returns
 MessageBus.publish "/channel", "some message", site_id: "site-id"
 
@@ -441,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 compatibility 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

@@ -4,12 +4,8 @@ require 'rake/testtask'
 require 'bundler'
 require 'bundler/gem_tasks'
 require 'bundler/setup'
-require 'jasmine'
-
-ENV['JASMINE_CONFIG_PATH'] ||= File.join(Dir.pwd, 'spec', 'assets', 'support', 'jasmine.yml')
-load 'jasmine/tasks/jasmine.rake'
-
 require 'rubocop/rake_task'
+
 RuboCop::RakeTask.new
 
 require 'yard'
@@ -35,7 +31,14 @@ module Bundler
   end
 end
 
-task spec_client_js: 'jasmine:ci'
+namespace :jasmine do
+  desc "Run Jasmine tests in headless mode"
+  task 'ci' do
+    if !system("npx jasmine-browser-runner runSpecs")
+      exit 1
+    end
+  end
+end
 
 backends = Dir["lib/message_bus/backends/*.rb"].map { |file| file.match(%r{backends/(?<backend>.*).rb})[:backend] } - ["base"]
 
@@ -57,6 +60,8 @@ namespace :spec do
 
   desc "Run integration tests"
   task :integration do
+    require "socket"
+
     def port_available?(port)
       server = TCPServer.open("0.0.0.0", port)
       server.close
@@ -78,7 +83,7 @@ namespace :spec do
 end
 
 desc "Run tests on all backends, plus client JS tests"
-task spec: backends.map { |backend| "spec:#{backend}" } + [:spec_client_js, "spec:integration"]
+task spec: backends.map { |backend| "spec:#{backend}" } + ["jasmine:ci", "spec:integration"]
 
 desc "Run performance benchmarks on all backends"
 task :performance do
@@ -94,5 +99,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

@@ -2,27 +2,21 @@
 // as a fallback if jQuery is not present
 //
 // Only implements methods & options used by MessageBus
-(function(global, undefined) {
+(function(global) {
   'use strict';
   if (!global.MessageBus){
       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]);
     }
-    xhr.setRequestHeader('Content-Type', 'application/json');
+    xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
     if (options.messageBus.chunked){
       options.messageBus.onProgressListener(xhr);
     }
@@ -37,7 +31,7 @@
         options.complete();
       }
     }
-    xhr.send(JSON.stringify(options.data));
+    xhr.send(new URLSearchParams(options.data).toString());
     return xhr;
   };