message_bus 3.3.6 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52ac95c63b3775df984e4900aff333c2ea9f9bab7e79d16b85909048247fb709
-  data.tar.gz: 879fd243f8947150fe8a31307d023b6ca719192568e0def45255dfdddaf1e34f
+  metadata.gz: 65630299cab9aae5df5b4f3131043d42063575978d5a83e9267436bed2b7d729
+  data.tar.gz: 2bd69d120552b01ae82c73a775d065c23575ac623016d2bd2ac25a5ebd637d6f
 SHA512:
-  metadata.gz: fe7252d6965628dd75027af80f775126394e6b3a81be01fd03f538f17fe5e7874e997cea552ee2e92d91b7ee47d17059755e7df995c5b8bab24049ce2746e0a8
-  data.tar.gz: 2c4ef234bab5ee1701b5bb2d7362929128855dda113a2531dd35f025b9d2be11a2c18a287aa25731e73a9e8f82af898e2f7725a7c9ea4200a390eaff633b4098
+  metadata.gz: 65a5d250126fc935053dfffef037baaf780678764ac95e4924603b901016f82b451a79a51f18fc699f2cfd8006cb805cd4887d206c12ca68ac68f059f1f13409
+  data.tar.gz: 2ebcc465985827a16866a948690a7bb4c03252050c8bfb1ee458809c6f0eda8c8fd581ba2f9bb1b496d3c7952456a11ad6ac51dd63e69c465238cffa17d7c2da

data/.eslintrc.js

@@ -4,10 +4,11 @@ module.exports = {
     browser: true,
     es2021: false,
   },
-  extends: "eslint:recommended",
+  extends: 'eslint:recommended',
   parserOptions: {
     ecmaVersion: 2015,
-    sourceType: "module",
+    sourceType: 'module',
   },
   rules: {},
+  ignorePatterns: ['/vendor', '/doc', '/assets/jquery-1.8.2.js'],
 };

data/.github/workflows/ci.yml

@@ -1,54 +1,101 @@
-name: Message Bus Tests
+name: CI
 
 on:
-  pull_request:
   push:
     branches:
-      - master
-
-env:
-  PGHOST: localhost
-  PGPORT: 5432
-  PGPASSWORD: postgres
-  PGUSER: postgres
+      - main
+  pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
+    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:9.4
+        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
-    strategy:
-      matrix:
-        ruby: ["2.7", "2.6", "2.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: actions/setup-ruby@v1
+
+      - uses: ruby/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
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
         with:
-          redis-version: '5.x'
-      - name: Setup gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4
+          node-version: 16
+          cache: npm
+
+      - name: Setup npm
+        run: npm install
+
       - name: Tests
+        env:
+          TESTOPTS: --verbose
         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/.prettierrc

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

data/CHANGELOG

@@ -1,10 +1,39 @@
+11-01-2022
+
+- Version 4.0.0
+
+  - DEV: Remove backend diagnostics
+  - DEV: Rename reliable_pub_sub to backend_instance
+  - FIX: `destroy` following `after_fork` could thread lock
+
+31-12-2021
+
+- Version 3.4.0
+
+  - FEATURE: Remove process auto-termination on missed keepalives
+
+20-12-2021
+
+- Version 3.3.8
+
+  - FIX: Restore dist js files to fix a regression in 3.3.7
+  - FIX: Stop various thread/pg connection leaks
+  - DEV: Fix ruby warnings
+
+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 visiblity change check by hand
+  - FEATURE: MessageBus.onVisibilityChange() can be used to trigger a visibility change check by hand
 
 28-04-2021
 
@@ -56,14 +85,14 @@
 
 - Version 3.3.0
 
-   - FEATURE: `MessageBus.base_route=` to alter the route that message bus will listen on.
+  - FEATURE: `MessageBus.base_route=` to alter the route that message bus will listen on.
 
 07-05-2020
 
 - Version 3.2.0
 
-   - FIX: compatability 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)`
+  - 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
 
@@ -98,7 +127,6 @@
 
   - FIX: In the redis backend make the `is_readonly?` method compatible with the redis gem both pre and post v4.0 when the `client` attribute was removed
 
-
 30-04-2019
 
 - Version 2.2.1
@@ -129,7 +157,7 @@
 - Version 2.2.0.pre
 
 - FIX: In redis backend we now expire the key used to track channel id this can cause a redis key leak
-    with large amounts of subscriptions that go away
+  with large amounts of subscriptions that go away
 - FEATURE: Much extra implementation documentation, and some improvements to usage documentation.
 - FEATURE: Improvements to development workflow:
   - Fully docker-based development and testing, with no other dependencies.
@@ -146,50 +174,53 @@
   - Supports setting backlog size on publication for memory/postgres
 - FEATURE: `MessageBus.off` now prevents the server subscription from starting up.
 - FEATURE: Trims unused parts of the public API:
+
   - Methods removed:
-    * ConnectionManager#stats (never used and the ConnectionManager is not exposed to application code)
-    * Client#cancel (effectively duplicate of Client#close and the Client is only available via the ConnectionManager, thus not available to application code)
+
+    - ConnectionManager#stats (never used and the ConnectionManager is not exposed to application code)
+    - Client#cancel (effectively duplicate of Client#close and the Client is only available via the ConnectionManager, thus not available to application code)
 
   - Methods made private:
-    * MessageBus::Implementation#encode_channel_name
-    * MessageBus::Implementation#decode_channel_name
-    * Client#in_async?
-    * Client#ensure_closed!
-    * ConnectionManager#subscribe_client
-    * Diagnostics.full_process_path
-    * Diagnostics.hostname
-    * MessageBus::Rack::Diagnostics#js_asset
-    * MessageBus::Rack::Diagnostics#generate_script_tag
-    * MessageBus::Rack::Diagnostics#file_hash
-    * MessageBus::Rack::Diagnostics#asset_contents
-    * MessageBus::Rack::Diagnostics#asset_path
-    * MessageBus::Rack::Diagnostics#index
-    * MessageBus::Rack::Diagnostics#translate_handlebars
-    * MessageBus::Rack::Diagnostics#indent
-    * MessageBus::Rack::Middleware#start_listener
-    * MessageBus::Rack::Middleware#close_db_connection!
-    * MessageBus::Rack::Middleware#add_client_with_timeout
+
+    - MessageBus::Implementation#encode_channel_name
+    - MessageBus::Implementation#decode_channel_name
+    - Client#in_async?
+    - Client#ensure_closed!
+    - ConnectionManager#subscribe_client
+    - Diagnostics.full_process_path
+    - Diagnostics.hostname
+    - MessageBus::Rack::Diagnostics#js_asset
+    - MessageBus::Rack::Diagnostics#generate_script_tag
+    - MessageBus::Rack::Diagnostics#file_hash
+    - MessageBus::Rack::Diagnostics#asset_contents
+    - MessageBus::Rack::Diagnostics#asset_path
+    - MessageBus::Rack::Diagnostics#index
+    - MessageBus::Rack::Diagnostics#translate_handlebars
+    - MessageBus::Rack::Diagnostics#indent
+    - MessageBus::Rack::Middleware#start_listener
+    - MessageBus::Rack::Middleware#close_db_connection!
+    - MessageBus::Rack::Middleware#add_client_with_timeout
 
   - Methods switched from protected to private:
-    * MessageBus::Implementation#global?
-    * MessageBus::Implementation#decode_message!
-    * MessageBus::Implementation#replay_backlog
-    * MessageBus::Implementation#subscribe_impl
-    * MessageBus::Implementation#unsubscribe_impl
-    * MessageBus::Implementation#ensure_subscriber_thread
-    * MessageBus::Implementation#new_subscriber_thread
-    * MessageBus::Implementation#global_subscribe_thread
-    * MessageBus::Implementation#multi_each
-    * Client#write_headers
-    * Client#write_chunk
-    * Client#write_and_close
-    * Client#messages_to_json
+    - MessageBus::Implementation#global?
+    - MessageBus::Implementation#decode_message!
+    - MessageBus::Implementation#replay_backlog
+    - MessageBus::Implementation#subscribe_impl
+    - MessageBus::Implementation#unsubscribe_impl
+    - MessageBus::Implementation#ensure_subscriber_thread
+    - MessageBus::Implementation#new_subscriber_thread
+    - MessageBus::Implementation#global_subscribe_thread
+    - MessageBus::Implementation#multi_each
+    - Client#write_headers
+    - Client#write_chunk
+    - Client#write_and_close
+    - Client#messages_to_json
 
 15-10-2018
 
 - 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
@@ -212,7 +243,7 @@
 - Version 2.1.2
 
 - FEATURE: minHiddenPollInterval set to 1500ms out of the box, ensures we never do hidden tab
-   polls at a high rate if tons of tabs are open
+  polls at a high rate if tons of tabs are open
 - FEATURE: added random 500ms to delayed polls to increase tab entropy
 
 18-12-2017
@@ -226,7 +257,7 @@
 - Version 2.1.0
 
 - FEATURE: you can now lookup last N messages on channel on subscribe from JavaScript
-   Subscribe at position (-1 - numberOfMessages) from the client
+  Subscribe at position (-1 - numberOfMessages) from the client
 
 24-11-2017
 
@@ -246,14 +277,13 @@
 - Version 2.0.7
 
 - Fix/Feature: use LUA script for publishing to bus, this eliminates a race condition
-   and ensures that we are never stuck in a multi transaction by mistake
-
+  and ensures that we are never stuck in a multi transaction by mistake
 
 29-09-2017
 
 - 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)
 
@@ -275,12 +305,10 @@
 - Version 2.0.2
 - Feature: Add on_middleware_error callback for remapping middleware errors to HTTP results
 
-
 25-07-2016
 
 - Feature: Add JavaScript MessageBus.status() function
 
-
 21-06-2016
 
 - Version 2.0.1
@@ -323,7 +351,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
 
@@ -361,97 +389,116 @@
 
 - Version 1.1.1
 - Fix: In multisite config there was no way to specify site for last_id or backlog
-   to resolve overrides were added to #last_id and #backlog, MessageBus::Client now
-   uses the new overrides
+  to resolve overrides were added to #last_id and #backlog, MessageBus::Client now
+  uses the new overrides
 
 07-12-2015
 
 - 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
 - Fix: correct edge cases around keepalive checks on bus
 
 09-07-2015
+
 - Version 1.0.15
 - Feature: MessageBus.reliable_pub_sub.max_backlog_age (in secs) configurable (default to 7 days)
 - Fix: API for MessageBus.backlog("/bla") was returning global backlog by mistake
 - Change: Max global backlog size reduced to 2000 elements
 
 08-06-2015
+
 - Version 1.0.14
 - Fix: we can not use Thread#kill best keepalive can do is terminate process cleanly
 - Feature: you can opt-out of keepalive with MessageBus.keepalive_timeout = 0
 
 08-06-2015
+
 - Version 1.0.13
 - Fix: on global subscribe reconnect replay missed messages
 - Feature: keepalive tests for global subscribe, catches hung redis connections
 
 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
 - Fix: race condition in TimerThread
 
 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
+
 - Version 1.0.9
 - Fix: inherit off StandardError not Exception for all exceptions raised
 
 20-03-2015
+
 - Version 1.0.8
 - Fix: aggressive short polling in background
 
 16-03-2015
+
 - Version 1.0.7
 - Feature: added pause and resume methods
 
 03-02-2015
+
 - Version 1.0.6
 - Fix: global backlog not truncating correctly
 
 23-09-2014
+
 - Version 1.0.5
 - Fix: missing custom headers from long polls
 
 23-09-2014
+
 - Version 1.0.4
 - Change: MessageBus.access_control_allow_origin_lookup to extra_response_headers_lookup
 
 23-09-2014
+
 - Version 1.0.3
 - Change: MessageBus.access_control_allow_origin to MessageBus.access_control_allow_origin_lookup
 
 23-09-2014
+
 - Version 1.0.2
 - Feature: MessageBus.access_control_allow_origin to control origin header
 
 23-09-2014
+
 - Version 1.0.1
 - Feature: $.ajax dependency can be passed in.
 - Feature: unsubscribe accepts a second param for the function to unsubscribe.
 
 22-09-2014
+
 - Version 1.0.0
 - Feature: add backgroundCallbackInterval - interval to send polls when page is in the background
 - Feature: issue a long poll as soon as page moves into the foreground
 
 11-08-2014
+
 - Version 0.9.5
 - Fix: release db connection a lot earlier for long polling (rails defer closes)
 
 13-01-2014
+
 - Version 0.9.4
 - Added support for /global/ channel to publish messages across a multisite
 - Cleaned up test harness so it uses local bus as opposed to global
@@ -460,19 +507,23 @@
 - ensure_reactor could say the reactor is running, but it was not, on first call
 
 06-12-2013
+
 - Version 0.9.3.2
 - Fix permissions in gem
 
 05-12-2013
+
 - Version 0.9.3.1
 - Add MessageBus.diagnostics() for diagnosing bus issues client side
 - Add more robustness to JavaScript, if callbacks used to fail they would halt the chain
 
 03-12-2013
+
 - Version 0.9.3
 - Remove thin dependency
 - Improve robustness under failure conditions
 
 30-09-2013
+
 - Fix failures in Ruby 1.9
 - Set up rack hijack by default in light of passengers new setting

data/DEV.md

@@ -5,5 +5,3 @@
 2. Log in to npm `yarn login`
 
 3. Publish: `yarn publish`
-
-

data/Gemfile

@@ -3,30 +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'
-  gem 'm'
-end
-
-group :test, :development do
-  gem 'byebug'
-  gem 'oj'
-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.