message_bus 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65630299cab9aae5df5b4f3131043d42063575978d5a83e9267436bed2b7d729
-  data.tar.gz: 2bd69d120552b01ae82c73a775d065c23575ac623016d2bd2ac25a5ebd637d6f
+  metadata.gz: 11a14ba0ec9ad142d3335fb7eb764be8e9b975a8dc8367fd4bf359e128a56095
+  data.tar.gz: bf41cede85c8e75e56829447cd3cf9ed6cd531ba27fcddfbccb6043f3a82da34
 SHA512:
-  metadata.gz: 65a5d250126fc935053dfffef037baaf780678764ac95e4924603b901016f82b451a79a51f18fc699f2cfd8006cb805cd4887d206c12ca68ac68f059f1f13409
-  data.tar.gz: 2ebcc465985827a16866a948690a7bb4c03252050c8bfb1ee458809c6f0eda8c8fd581ba2f9bb1b496d3c7952456a11ad6ac51dd63e69c465238cffa17d7c2da
+  metadata.gz: 23c1d181028194c16e98c5a3df42e445458aef4779c97ae2d6d5100adf5053680f62ea4c914bea7c84c124bd453127e141c68ffeb1c742cc208e1d040bc8558f
+  data.tar.gz: 7efffe711fac2520356b115820acba2d4206d53f35017ba64c86e3c571a85fb423e943cb9301a03d3b47d6f442f1626dea0495c0242220283685eaa944c890b6

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, 3.0]
+        ruby: [2.6, 2.7, '3.0', 3.1]
         redis: [5, 6]
 
     services:

data/CHANGELOG

@@ -1,3 +1,12 @@
+16-02-2022
+
+- Version 4.1.0
+
+  - PERF: Optimize Client#backlog for up-to-date clients
+
+    Also introduces a new MessageBus#last_ids(*channels) api for fetching the last_ids of
+    multiple channels simultaneously
+
 11-01-2022
 
 - Version 4.0.0

data/lib/message_bus/backends/base.rb

@@ -118,6 +118,15 @@ module MessageBus
         raise ConcreteClassMustImplementError
       end
 
+      # Get the ID of the last message published on multiple channels
+      #
+      # @param [Array<String>] channels - array of channels to fetch
+      #
+      # @return [Array<Integer>] the channel-specific IDs of the last message published to each requested channel
+      def last_ids(*channels)
+        raise ConcreteClassMustImplementError
+      end
+
       # Get messages from a channel backlog
       #
       # @param [String] channel the name of the channel in question

data/lib/message_bus/backends/memory.rb

@@ -244,6 +244,13 @@ module MessageBus
         client.max_id(channel)
       end
 
+      # (see Base#last_ids)
+      def last_ids(*channels)
+        channels.map do |c|
+          last_id(c)
+        end
+      end
+
       # (see Base#backlog)
       def backlog(channel, last_id = 0)
         items = client.backlog channel, last_id.to_i

data/lib/message_bus/backends/postgres.rb

@@ -132,6 +132,21 @@ module MessageBus
           end
         end
 
+        def max_ids(*channels)
+          block = proc do |pg_result|
+            ids = Array.new(channels.size, 0)
+            pg_result.ntuples.times do |i|
+              channel = pg_result.getvalue(i, 0)
+              max_id = pg_result.getvalue(i, 1)
+              channel_index = channels.index(channel)
+              ids[channel_index] = max_id.to_i
+            end
+            ids
+          end
+
+          hold { |conn| exec_prepared(conn, 'max_channel_ids', [PG::TextEncoder::Array.new.encode(channels)], &block) }
+        end
+
         def publish(channel, data)
           hold { |conn| exec_prepared(conn, 'publish', [channel, data]) }
         end
@@ -175,9 +190,16 @@ module MessageBus
         end
 
         def create_table(conn)
-          conn.exec 'CREATE TABLE message_bus (id bigserial PRIMARY KEY, channel text NOT NULL, value text NOT NULL CHECK (octet_length(value) >= 2), added_at timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL)'
-          conn.exec 'CREATE INDEX table_channel_id_index ON message_bus (channel, id)'
-          conn.exec 'CREATE INDEX table_added_at_index ON message_bus (added_at)'
+          sync do
+            begin
+              conn.exec("SELECT 'message_bus'::regclass")
+            rescue PG::UndefinedTable
+              conn.exec 'CREATE TABLE message_bus (id bigserial PRIMARY KEY, channel text NOT NULL, value text NOT NULL CHECK (octet_length(value) >= 2), added_at timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL)'
+              conn.exec 'CREATE INDEX table_channel_id_index ON message_bus (channel, id)'
+              conn.exec 'CREATE INDEX table_added_at_index ON message_bus (added_at)'
+            end
+          end
+
           nil
         end
 
@@ -214,11 +236,7 @@ module MessageBus
         def new_pg_connection
           conn = raw_pg_connection
 
-          begin
-            conn.exec("SELECT 'message_bus'::regclass")
-          rescue PG::UndefinedTable
-            create_table(conn)
-          end
+          create_table(conn)
 
           conn.exec 'PREPARE insert_message AS INSERT INTO message_bus (channel, value) VALUES ($1, $2) RETURNING id'
           conn.exec 'PREPARE clear_global_backlog AS DELETE FROM message_bus WHERE (id <= $1)'
@@ -228,6 +246,7 @@ module MessageBus
           conn.exec "PREPARE expire AS DELETE FROM message_bus WHERE added_at < CURRENT_TIMESTAMP - ($1::text || ' seconds')::interval"
           conn.exec 'PREPARE get_message AS SELECT value FROM message_bus WHERE ((channel = $1) AND (id = $2))'
           conn.exec 'PREPARE max_channel_id AS SELECT max(id) FROM message_bus WHERE (channel = $1)'
+          conn.exec 'PREPARE max_channel_ids AS SELECT channel, max(id) FROM message_bus WHERE (channel = ANY($1)) GROUP BY channel'
           conn.exec 'PREPARE max_id AS SELECT max(id) FROM message_bus'
           conn.exec 'PREPARE publish AS SELECT pg_notify($1, $2)'
 
@@ -310,7 +329,12 @@ module MessageBus
         client.max_id(channel)
       end
 
-      # (see Base#last_id)
+      # (see Base#last_ids)
+      def last_ids(*channels)
+        client.max_ids(*channels)
+      end
+
+      # (see Base#backlog)
       def backlog(channel, last_id = 0)
         items = client.backlog channel, last_id.to_i
 

data/lib/message_bus/backends/redis.rb

@@ -194,6 +194,13 @@ LUA
         pub_redis.get(backlog_id_key).to_i
       end
 
+      # (see Base#last_ids)
+      def last_ids(*channels)
+        return [] if channels.size == 0
+        backlog_id_keys = channels.map { |c| backlog_id_key(c) }
+        pub_redis.mget(*backlog_id_keys).map(&:to_i)
+      end
+
       # (see Base#backlog)
       def backlog(channel, last_id = 0)
         redis = pub_redis

data/lib/message_bus/client.rb

@@ -178,31 +178,32 @@ class MessageBus::Client
     r = []
     new_message_ids = nil
 
-    @subscriptions.each do |k, v|
-      id = v.to_i
+    last_bus_ids = @bus.last_ids(*@subscriptions.keys, site_id: site_id)
 
-      if id < -1
-        last_id = @bus.last_id(k, site_id)
-        id = last_id + id + 1
-        id = 0 if id < 0
+    @subscriptions.each do |k, v|
+      last_client_id = v.to_i
+      last_bus_id = last_bus_ids[k]
+
+      if last_client_id < -1 # Client requesting backlog relative to bus position
+        last_client_id = last_bus_id + last_client_id + 1
+        last_client_id = 0 if last_client_id < 0
+      elsif last_client_id == -1 # Client not requesting backlog
+        next
+      elsif last_client_id == last_bus_id # Client already up-to-date
+        next
+      elsif last_client_id > last_bus_id # Client ahead of the bus
+        @subscriptions[k] = -1
+        next
       end
 
-      next if id < 0
-
-      messages = @bus.backlog(k, id, site_id)
+      messages = @bus.backlog(k, last_client_id, site_id)
 
-      if messages.length == 0
-        if id > @bus.last_id(k, site_id)
-          @subscriptions[k] = -1
-        end
-      else
-        messages.each do |msg|
-          if allowed?(msg)
-            r << msg
-          else
-            new_message_ids ||= {}
-            new_message_ids[k] = msg.message_id
-          end
+      messages.each do |msg|
+        if allowed?(msg)
+          r << msg
+        else
+          new_message_ids ||= {}
+          new_message_ids[k] = msg.message_id
         end
       end
     end
@@ -212,7 +213,7 @@ class MessageBus::Client
     @subscriptions.each do |k, v|
       if v.to_i == -1 || (new_message_ids && new_message_ids[k])
         status_message ||= {}
-        @subscriptions[k] = status_message[k] = @bus.last_id(k, site_id)
+        @subscriptions[k] = status_message[k] = last_bus_ids[k]
       end
     end
 

data/lib/message_bus/version.rb

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

data/lib/message_bus.rb

@@ -503,6 +503,18 @@ module MessageBus::Implementation
     backend_instance.last_id(encode_channel_name(channel, site_id))
   end
 
+  # Get the ID of the last message published on multiple channels
+  #
+  # @param [Array<String>] channels - array of channels to fetch
+  # @param [String] site_id - the ID of the site by which to filter
+  #
+  # @return [Hash] the channel-specific IDs of the last message published to each requested channel
+  def last_ids(*channels, site_id: nil)
+    encoded_channel_names = channels.map { |c| encode_channel_name(c, site_id) }
+    ids = backend_instance.last_ids(*encoded_channel_names)
+    channels.zip(ids).to_h
+  end
+
   # Get the last message published on a channel
   #
   # @param [String] channel the name of the channel in question

data/message_bus.gemspec

@@ -11,8 +11,6 @@ Gem::Specification.new do |gem|
   gem.license       = "MIT"
   gem.files         = `git ls-files`.split($\) +
                       ["vendor/assets/javascripts/message-bus.js", "vendor/assets/javascripts/message-bus-ajax.js"]
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "message_bus"
   gem.require_paths = ["lib"]
   gem.version       = MessageBus::VERSION

data/spec/lib/message_bus/backend_spec.rb

@@ -91,6 +91,22 @@ describe BACKEND_CLASS do
     @bus.last_id("/foo").must_equal 1
   end
 
+  it "should allow us to get multiple last_ids" do
+    @bus.last_ids("/foo", "/bar", "/foobar").must_equal [0, 0, 0]
+
+    @bus.publish("/foo", "one")
+    @bus.publish("/foo", "two")
+    @bus.publish("/foobar", "three")
+
+    @bus.last_ids("/foo", "/bar", "/foobar").must_equal(
+      [
+        @bus.last_id("/foo"),
+        @bus.last_id("/bar"),
+        @bus.last_id("/foobar")
+      ]
+    )
+  end
+
   it "can set backlog age" do
     @bus.max_backlog_age = 1
 

data/spec/performance/backlog.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+require 'logger'
+require 'benchmark'
+require 'message_bus'
+
+require_relative "../helpers"
+
+backends = ENV['MESSAGE_BUS_BACKENDS'].split(",").map(&:to_sym)
+channel = "/foo"
+iterations = 10_000
+results = []
+
+puts "Running backlog benchmark with #{iterations} iterations on backends: #{backends.inspect}"
+
+run_benchmark = lambda do |bm, backend|
+  bus = MessageBus::Instance.new
+  bus.configure(test_config_for_backend(backend))
+
+  bus.backend_instance.max_backlog_size = 100
+  bus.backend_instance.max_global_backlog_size = 1000
+
+  channel_names = 10.times.map { |i| "channel#{i}" }
+
+  100.times do |i|
+    channel_names.each do |ch|
+      bus.publish(ch, { message_number_is: i })
+    end
+  end
+
+  last_ids = channel_names.map { |ch| [ch, bus.last_id(ch)] }.to_h
+
+  1000.times do
+    # Warmup
+    client = MessageBus::Client.new(message_bus: bus)
+    channel_names.each { |ch| client.subscribe(ch, -1) }
+    client.backlog
+  end
+
+  bm.report("#{backend} - #backlog with no backlogs requested") do
+    iterations.times do
+      client = MessageBus::Client.new(message_bus: bus)
+      channel_names.each { |ch| client.subscribe(ch, -1) }
+      client.backlog
+    end
+  end
+
+  (0..5).each do |ch_i|
+    channels_with_messages = (ch_i) * 2
+
+    bm.report("#{backend} - #backlog when #{channels_with_messages}/10 channels have new messages") do
+      iterations.times do
+        client = MessageBus::Client.new(message_bus: bus)
+        channel_names.each_with_index do |ch, i|
+          client.subscribe(ch, last_ids[ch] + ((i < channels_with_messages) ? -1 : 0))
+        end
+        result = client.backlog
+        if result.length != channels_with_messages
+          raise "Result has #{result.length} messages. Expected #{channels_with_messages}"
+        end
+      end
+    end
+  end
+
+  bus.reset!
+  bus.destroy
+end
+
+puts
+
+Benchmark.benchmark("     duration\n", 60, "%10.2rs\n", "") do |bm|
+  backends.each do |backend|
+    run_benchmark.call(bm, backend)
+  end
+end
+puts
+results.each do |result|
+  puts result
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -344,6 +344,7 @@ files:
 - spec/lib/message_bus/rack/middleware_spec.rb
 - spec/lib/message_bus/timer_thread_spec.rb
 - spec/lib/message_bus_spec.rb
+- spec/performance/backlog.rb
 - spec/performance/publish.rb
 - spec/spec_helper.rb
 - spec/support/jasmine-browser.json
@@ -373,23 +374,4 @@ rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: ''
-test_files:
-- spec/assets/SpecHelper.js
-- spec/assets/message-bus.spec.js
-- spec/fixtures/test/Gemfile
-- spec/fixtures/test/config.ru
-- spec/helpers.rb
-- spec/integration/http_client_spec.rb
-- spec/lib/fake_async_middleware.rb
-- spec/lib/message_bus/assets/asset_encoding_spec.rb
-- spec/lib/message_bus/backend_spec.rb
-- spec/lib/message_bus/client_spec.rb
-- spec/lib/message_bus/connection_manager_spec.rb
-- spec/lib/message_bus/distributed_cache_spec.rb
-- spec/lib/message_bus/multi_process_spec.rb
-- spec/lib/message_bus/rack/middleware_spec.rb
-- spec/lib/message_bus/timer_thread_spec.rb
-- spec/lib/message_bus_spec.rb
-- spec/performance/publish.rb
-- spec/spec_helper.rb
-- spec/support/jasmine-browser.json
+test_files: []