message_bus 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d2bee95bc6938bb37f780cf48bccd6481f2bca144c6672acac69e6d3e1ef176b
-  data.tar.gz: 387450399296441956030b46054a48b2f996c02e51eeb32e5bc181fa03d8b6d8
+SHA1:
+  metadata.gz: b2c8ffc1228b2e50751a6671ce91e12239e22cf3
+  data.tar.gz: 76b8c24586fa1781acd95dd352b269cf4a21bf99
 SHA512:
-  metadata.gz: 2a87dd71aba2740acd7dd326b9f9d2d8cf3b51c33f2c498bbb128346ed52fc2483f52b9135d5320c8ce3d025d2cb7357260d78b8d5963600256cb62704bfb173
-  data.tar.gz: db86f4a8d2b3949ced575612eac992d9d878abe836ee818340ef2045486a0debc816600db95ffb19a497acf3371e673473fe7bcf5d54f48cbd7b1505db8bc791
+  metadata.gz: 2f17a8234add27233c63619a73bf214b38c53cb5e4938f61b7b13a1d3fd605f20bb335d213f5c0202a4f6358d0dfd982bf38a8079571e77ffce3fb67eb0d7245
+  data.tar.gz: 5815b33e4f0cce2de16ac2bd6836bbb2eb1d115fb87818e00a35cc571841fdcff36125453d9c24bab725004941c9ef861aaa683d5c5c728edd18fff50c3fc34b

data/CHANGELOG

@@ -1,3 +1,9 @@
+20-04-2018
+
+- Version 2.1.3
+
+- FIX: Subtle issue where poll timeout may not be cleared causing multiple concurrent polls
+
 09-01-2018
 
 - Version 2.1.2

data/README.md

@@ -19,6 +19,7 @@ Live chat demo per [examples/chat](https://github.com/SamSaffron/message_bus/tre
 
 If you are looking to contribute to this project here are some ideas
 
+- MAKE THIS README BETTER!
 - Build backends for other providers (zeromq, rabbitmq, disque) - currently we support pg and redis.
 - Improve and properly document admin dashboard (add opt-in stats, better diagnostics into queues)
 - Improve general documentation (Add examples, refine existing examples)
@@ -58,6 +59,9 @@ Server to Server messaging
 ```ruby
 message_id = MessageBus.publish "/channel", "message"
 
+# last id in a channel
+id = MessageBus.last_id("/channel")
+
 # in another process / spot
 
 MessageBus.subscribe "/channel" do |msg|
@@ -142,13 +146,13 @@ location /message-bus/ {
 
 If you wish to disable chunked encoding run:
 
-```
+```ruby
 MessageBus.enableChunkedEncoding = false; // in your JavaScript
 ```
 
 Or
 
-```
+```ruby
 MessageBus.configure(chunked_encoding_enabled: false) // in Ruby
 ```
 
@@ -282,6 +286,24 @@ MessageBus.configure(backend: :redis, url: "redis://:p4ssw0rd@10.0.1.1:6380/15")
 ```
 The redis client message_bus uses is [redis-rb](https://github.com/redis/redis-rb), so you can visit it's repo to see what options you can configure.
 
+#### Data Retention
+
+Out of the box Redis keeps track of 2000 messages in the global backlog and 1000 messages in a per-channel backlog. Per-channel backlogs get cleared automatically after 7 days of inactivity.
+
+This is configurable via accessors on the ReliablePubSub instance.
+
+```ruby
+# only store 100 messages per channel
+MessageBus.reliabe_pub_sub.max_backlog_size = 100
+
+# only store 100 global messages
+MessageBus.reliabe_pub_sub.max_global_backlog_size = 100
+
+# flush per-channel backlog after 100 seconds of inactivity
+MessageBus.reliabe_pub_sub.max_backlog_age = 100
+
+```
+
 ### PostgreSQL
 
 message_bus also supports PostgreSQL as the backend:

data/assets/message-bus.js

@@ -289,6 +289,9 @@
           }
         }
 
+        if (pollTimeout) {
+          clearTimeout(pollTimeout);
+        }
         pollTimeout = setTimeout(function(){
           pollTimeout = null;
           poll();

data/lib/message_bus/backends/memory.rb

@@ -277,7 +277,7 @@ class MessageBus::Memory::ReliablePubSub
         end
       end
     rescue => error
-      MessageBus.logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack\n#{error.backtrace.join("\n")}"
+      @config[:logger].warn "#{error} subscribe failed, reconnecting in 1 second. Call stack\n#{error.backtrace.join("\n")}"
       sleep 1
       retry
     end

data/lib/message_bus/backends/postgres.rb

@@ -379,7 +379,7 @@ class MessageBus::Postgres::ReliablePubSub
         end
       end
     rescue => error
-      MessageBus.logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack\n#{error.backtrace.join("\n")}"
+      @config[:logger].warn "#{error} subscribe failed, reconnecting in 1 second. Call stack\n#{error.backtrace.join("\n")}"
       sleep 1
       retry
     end

data/lib/message_bus/backends/redis.rb

@@ -30,6 +30,7 @@ class MessageBus::Redis::ReliablePubSub
   # max_backlog_size is per multiplexed channel
   def initialize(redis_config = {}, max_backlog_size = 1000)
     @redis_config = redis_config.dup
+    @logger = @redis_config[:logger]
     unless @redis_config[:enable_redis_logger]
       @redis_config[:logger] = nil
     end
@@ -160,7 +161,7 @@ LUA
         @in_memory_backlog << [channel, data]
         if @in_memory_backlog.length > @max_in_memory_publish_backlog
           @in_memory_backlog.delete_at(0)
-          MessageBus.logger.warn("Dropping old message cause max_in_memory_publish_backlog is full: #{e.message}\n#{e.backtrace.join('\n')}")
+          @logger.warn("Dropping old message cause max_in_memory_publish_backlog is full: #{e.message}\n#{e.backtrace.join('\n')}")
         end
       end
 
@@ -201,10 +202,10 @@ LUA
           if e.message =~ /^READONLY/
             try_again = true
           else
-            MessageBus.logger.warn("Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}")
+            @logger.warn("Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}")
           end
         rescue => e
-          MessageBus.logger.warn("Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}")
+          @logger.warn("Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}")
         end
 
         @in_memory_backlog.delete_at(0) unless try_again
@@ -367,7 +368,7 @@ LUA
         end
       end
     rescue => error
-      MessageBus.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}"
       sleep 1
       retry
     end

data/lib/message_bus/connection_manager.rb

@@ -36,7 +36,7 @@ class MessageBus::ConnectionManager
         end
 
       rescue => e
-        MessageBus.logger.error "notify clients crash #{e} : #{e.backtrace}"
+        @bus.logger.error "notify clients crash #{e} : #{e.backtrace}"
       end
     end
   end

data/lib/message_bus/diagnostics.rb

@@ -23,14 +23,14 @@ class MessageBus::Diagnostics
     end
   end
 
-  def self.enable
+  def self.enable(bus = MessageBus)
     full_path = full_process_path
     start_time = Time.now.to_f
     hostname = self.hostname
 
     # it may make sense to add a channel per machine/host to streamline
     #  process to process comms
-    MessageBus.subscribe('/_diagnostics/hup') do |msg|
+    bus.subscribe('/_diagnostics/hup') do |msg|
       if Process.pid == msg.data["pid"] && hostname == msg.data["hostname"]
         $shutdown = true
         sleep 4
@@ -38,16 +38,16 @@ class MessageBus::Diagnostics
       end
     end
 
-    MessageBus.subscribe('/_diagnostics/discover') do |msg|
-      MessageBus.on_connect.call msg.site_id if MessageBus.on_connect
-      MessageBus.publish '/_diagnostics/process-discovery', {
+    bus.subscribe('/_diagnostics/discover') do |msg|
+      bus.on_connect.call msg.site_id if bus.on_connect
+      bus.publish '/_diagnostics/process-discovery', {
         pid: Process.pid,
         process_name: $0,
         full_path: full_path,
         uptime: (Time.now.to_f - start_time).to_i,
         hostname: hostname
       }, user_ids: [msg.data["user_id"]]
-      MessageBus.on_disconnect.call msg.site_id if MessageBus.on_disconnect
+      bus.on_disconnect.call msg.site_id if bus.on_disconnect
     end
   end
 end

data/lib/message_bus/rack/middleware.rb

@@ -24,7 +24,7 @@ class MessageBus::Rack::Middleware
         if thin_running
           EM.next_tick(&run)
         else
-          MessageBus.timer.queue(&run)
+          @bus.timer.queue(&run)
         end
 
         @started_listener = true
@@ -204,7 +204,7 @@ class MessageBus::Rack::Middleware
   def add_client_with_timeout(client)
     @connection_manager.add_client(client)
 
-    client.cleanup_timer = MessageBus.timer.queue(@bus.long_polling_interval.to_f / 1000) {
+    client.cleanup_timer = @bus.timer.queue(@bus.long_polling_interval.to_f / 1000) {
       begin
         client.cleanup_timer = nil
         client.ensure_closed!

data/lib/message_bus/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MessageBus
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

data/lib/message_bus.rb

@@ -195,6 +195,11 @@ module MessageBus::Implementation
   def reliable_pub_sub
     @mutex.synchronize do
       return nil if @destroyed
+
+      # Make sure logger is loaded before config is
+      # passed to backend.
+      logger
+
       @config[:reliable_pub_sub] ||= begin
         @config[:backend_options] ||= {}
         require "message_bus/backends/#{backend}"
@@ -208,7 +213,7 @@ module MessageBus::Implementation
   end
 
   def enable_diagnostics
-    MessageBus::Diagnostics.enable
+    MessageBus::Diagnostics.enable(self)
   end
 
   def publish(channel, data, opts = nil)
@@ -472,7 +477,7 @@ module MessageBus::Implementation
       begin
         global_subscribe_thread unless @destroyed
       rescue => e
-        MessageBus.logger.warn "Unexpected error in subscriber thread #{e}"
+        logger.warn "Unexpected error in subscriber thread #{e}"
       end
     end
 
@@ -486,7 +491,7 @@ module MessageBus::Implementation
         # going for x3 keepalives missed for a restart, need to ensure this only very rarely happens
         # note: after_fork will sort out a bad @last_message date, but thread will be dead anyway
         if (Time.now - (@last_message || Time.now)) > keepalive_interval * 3
-          MessageBus.logger.warn "Global messages on #{Process.pid} timed out, restarting process"
+          logger.warn "Global messages on #{Process.pid} timed out, restarting process"
           # No other clean way to remove this thread, its listening on a socket
           #   no data is arriving
           #
@@ -501,7 +506,7 @@ module MessageBus::Implementation
             begin
               Process.kill('KILL', pid)
             rescue Errno::ESRCH
-              MessageBus.logger.warn "#{Process.pid} successfully terminated by `TERM` signal."
+              logger.warn "#{Process.pid} successfully terminated by `TERM` signal."
             end
           end
 
@@ -546,11 +551,11 @@ module MessageBus::Implementation
           begin
             c.call msg
           rescue => e
-            MessageBus.logger.warn "failed to deliver message, skipping #{msg.inspect}\n ex: #{e} backtrace: #{e.backtrace}"
+            logger.warn "failed to deliver message, skipping #{msg.inspect}\n ex: #{e} backtrace: #{e.backtrace}"
           end
         end
       rescue => e
-        MessageBus.logger.warn "failed to process message #{msg.inspect}\n ex: #{e} backtrace: #{e.backtrace}"
+        logger.warn "failed to process message #{msg.inspect}\n ex: #{e} backtrace: #{e.backtrace}"
       end
       @global_id = msg.global_id
     end

data/vendor/assets/javascripts/message-bus.js

@@ -289,6 +289,9 @@
           }
         }
 
+        if (pollTimeout) {
+          clearTimeout(pollTimeout);
+        }
         pollTimeout = setTimeout(function(){
           pollTimeout = null;
           poll();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: ''