message_bus 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80297cfac62f4fc79e8d16a425762576757aab5d
-  data.tar.gz: be8b74aed2b678c858de6a2941f74bcbaad455c2
+  metadata.gz: f3cdd346c2878cd29ee74ec652ad39b524322db2
+  data.tar.gz: dcb547c36393e89b014e61eb37fa01757a813fac
 SHA512:
-  metadata.gz: 32fafd6d57c0176cc356724246909d430753428b375449b8c12a181dd8b2f50ab51404a6fd0c02a089cc7fbe2bf90e6071df6b5a24324fa0b0430e3c6f163460
-  data.tar.gz: e977e8bc61bdd4c74be64fe755ad413e036ae96fc149ccb26cbae05fb1bca53dcb45cf82b0ea6ae5e77e13ee3e3fc7a87a5068d6cbe98e5994f440c9668e43ca
+  metadata.gz: ad0c582fa78e53d1d59d355ee595b05e3d74ffb68858a3617db6fcbab45005220566e2baf74b9ea57bb19b3f03ccdc222928cf3b4e91dfe8f6cf015059b0fe67
+  data.tar.gz: faf5a01c159e6b016e7d99f418b195330ea3382390a306eef54be053b69d85b4bcf413ee4fa68d1dcf5f79a812822ac804ae38cc0d54bd0d1eb367c9182eb1bc

data/.rubocop.yml

@@ -0,0 +1,104 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/BlockAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/AlignHash:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: false

data/CHANGELOG

@@ -1,3 +1,12 @@
+16-08-2017
+
+- Version 2.0.3
+- Fix: broken MessageBus.redis_config
+- Perf: publish status message for filtered messages
+- Perf: add frozen strings to save on memory
+- Feature: improved logging when messages are dropped
+- Fix: handle missing actiondispatch flash
+
 25-08-2016
 
 - Version 2.0.2

data/README.md

@@ -14,6 +14,18 @@ Live chat demo per [examples/chat](https://github.com/SamSaffron/message_bus/tre
 
 ### http://chat.samsaffron.com
 
+
+## Want to help?
+
+If you are looking to contribute to this project here are some ideas
+
+- 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)
+- Make MessageBus a nice website
+- Add optional transports for websocket and shared web workers
+- Add `# frozen_string_literal: true` to all non test files and adjust code to allow for it.
+
 ## Can you handle concurrent requests?
 
 **Yes**, MessageBus uses Rack Hijack, this interface allows us to take control of the underlying socket. MessageBus can handle thousands of concurrent long polls on all popular Ruby webservers. MessageBus runs as middleware in your Rack (or by extension Rails) application and does not require a dedicated server. Background work is minimized to ensure it does not interfere with existing non MessageBus traffic.
@@ -71,10 +83,10 @@ MessageBus.publish "/channel", "hello", client_ids: ["XXX","YYY"]
 # message bus determines the user ids and groups based on env
 
 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 poolings, 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
 end)
 
@@ -200,7 +212,7 @@ Setting|Default|Info
 ----|---|---|
 enableLongPolling|true|Allow long-polling (provided it is enable by the server)
 callbackInterval|15000|Safeguard to ensure background polling does not exceed this interval (in milliseconds)
-backgroundCallbackInterval|60000|Interval to poll when long polling is disabled (either explicitly or due to browser being in backgroud)
+backgroundCallbackInterval|60000|Interval to poll when long polling is disabled (either explicitly or due to browser being in background)
 maxPollInterval|180000|If request to the server start failing, MessageBus will backoff, this is the upper limit of the backoff.
 alwaysLongPoll|false|For debugging you may want to disable the "is browser in background" check and always long-poll
 baseUrl|/|If message bus is mounted in a subdirectory of different domain, you may configure it to perform requests there
@@ -322,14 +334,53 @@ after_fork do |server, worker|
 end
 ```
 
-###
+### Middleware stack in Rails
 
-## Want to help?
+MessageBus middleware has to show up after the session middleware, but depending on how the Rails app is configured that might be either `ActionDispatch::Session::CookieStore` or `ActionDispatch::Session::ActiveRecordStore`. To handle both cases, the middleware is inserted before `ActionDispatch::Flash`.
+
+For APIs or apps that have `ActionDispatch::Flash` deleted from the stack the middleware is pushed to the bottom.
+
+Should you want to manipulate the default behavior please refer to [Rails MiddlewareStackProxy documentation](http://api.rubyonrails.org/classes/Rails/Configuration/MiddlewareStackProxy.html) and alter the order of the middlewares in stack in `app/config/initializers/message_bus.rb`
+
+```ruby
+# config/initializers/message_bus.rb
+Rails.application.config do |config|
+  # do anything you wish with config.middleware here
+end
+```
+
+#### Error Handling
+
+The internet is a chaotic environment and clients can drop off for a variety of reasons. If this happens while MessageBus is trying to write a message to the client you may see something like this in your logs:
+
+```
+Errno::EPIPE: Broken pipe
+  from message_bus/client.rb:159:in `write'
+  from message_bus/client.rb:159:in `write_headers'
+  from message_bus/client.rb:178:in `write_chunk'
+  from message_bus/client.rb:49:in `ensure_first_chunk_sent'
+  from message_bus/rack/middleware.rb:150:in `block in call'
+  from message_bus/client.rb:21:in `block in synchronize'
+  from message_bus/client.rb:21:in `synchronize'
+  from message_bus/client.rb:21:in `synchronize'
+  from message_bus/rack/middleware.rb:147:in `call'
+  ...
+```
+
+The user doesn't see anything, but depending on your traffic you may acquire quite a few of these in your logs.
+
+You can rescue from errors that occur in MessageBus's middleware stack by adding a config option:
+
+```ruby
+MessageBus.configure(on_middleware_error: proc do |env, e|
+  # env contains the Rack environment at the time of error
+  # e contains the exception that was raised
+  if Errno::EPIPE === e
+    [422, {}, [""]]
+  else
+    raise e
+  end
+end)
+```
 
-If you are looking to contribute to this project here are some ideas
 
-- Add a test suite for JavaScript message-bus.js
-- Build backends for other providers (zeromq, rabbitmq, disque)
-- Improve and properly document admin dashboard (add opt-in stats, better diagnostics into queues)
-- Improve general documentation (Add examples, refine existing examples)
-- Make MessageBus a nice website

data/lib/message_bus.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "monitor"
 require "set"
 require "message_bus/version"
@@ -129,7 +130,7 @@ module MessageBus::Implementation
 
   # Allow us to inject a redis db
   def redis_config=(config)
-    configure(config.merge(:backend=>:redis))
+    configure(config.merge(backend: :redis))
   end
 
   alias redis_config config
@@ -228,17 +229,17 @@ module MessageBus::Implementation
 
     raise ::MessageBus::InvalidMessage if (user_ids || group_ids) && global?(channel)
 
-    encoded_data = JSON.dump({
+    encoded_data = JSON.dump(
       data: data,
       user_ids: user_ids,
       group_ids: group_ids,
       client_ids: client_ids
-    })
+    )
 
     reliable_pub_sub.publish(encode_channel_name(channel), encoded_data)
   end
 
-  def blocking_subscribe(channel=nil, &blk)
+  def blocking_subscribe(channel = nil, &blk)
     if channel
       reliable_pub_sub.subscribe(encode_channel_name(channel), &blk)
     else
@@ -249,7 +250,7 @@ module MessageBus::Implementation
   ENCODE_SITE_TOKEN = "$|$"
 
   # encode channel name to include site
-  def encode_channel_name(channel, site_id=nil)
+  def encode_channel_name(channel, site_id = nil)
     if (site_id || site_id_lookup) && !global?(channel)
       raise ArgumentError.new channel if channel.include? ENCODE_SITE_TOKEN
       "#{channel}#{ENCODE_SITE_TOKEN}#{site_id || site_id_lookup.call}"
@@ -262,50 +263,50 @@ module MessageBus::Implementation
     channel.split(ENCODE_SITE_TOKEN)
   end
 
-  def subscribe(channel=nil, last_id=-1, &blk)
+  def subscribe(channel = nil, last_id = -1, &blk)
     subscribe_impl(channel, nil, last_id, &blk)
   end
 
   # subscribe only on current site
-  def local_subscribe(channel=nil, last_id=-1, &blk)
+  def local_subscribe(channel = nil, last_id = -1, &blk)
     site_id = site_id_lookup.call if site_id_lookup && ! global?(channel)
     subscribe_impl(channel, site_id, last_id, &blk)
   end
 
-  def unsubscribe(channel=nil, &blk)
+  def unsubscribe(channel = nil, &blk)
     unsubscribe_impl(channel, nil, &blk)
   end
 
-  def local_unsubscribe(channel=nil, &blk)
+  def local_unsubscribe(channel = nil, &blk)
     site_id = site_id_lookup.call if site_id_lookup
     unsubscribe_impl(channel, site_id, &blk)
   end
 
-  def global_backlog(last_id=nil)
+  def global_backlog(last_id = nil)
     backlog(nil, last_id)
   end
 
-  def backlog(channel=nil, last_id=nil, site_id=nil)
+  def backlog(channel = nil, last_id = nil, site_id = nil)
     old =
       if channel
-        reliable_pub_sub.backlog(encode_channel_name(channel,site_id), last_id)
+        reliable_pub_sub.backlog(encode_channel_name(channel, site_id), last_id)
       else
         reliable_pub_sub.global_backlog(last_id)
       end
 
-    old.each{ |m|
+    old.each do |m|
       decode_message!(m)
-    }
+    end
     old
   end
 
-  def last_id(channel,site_id=nil)
-    reliable_pub_sub.last_id(encode_channel_name(channel,site_id))
+  def last_id(channel , site_id = nil)
+    reliable_pub_sub.last_id(encode_channel_name(channel, site_id))
   end
 
   def last_message(channel)
     if last_id = last_id(channel)
-      messages = backlog(channel, last_id-1)
+      messages = backlog(channel, last_id - 1)
       if messages
         messages[0]
       end
@@ -326,7 +327,7 @@ module MessageBus::Implementation
     reliable_pub_sub.after_fork
     ensure_subscriber_thread
     # will ensure timer is running
-    timer.queue{}
+    timer.queue {}
   end
 
   def listening?
@@ -403,7 +404,7 @@ module MessageBus::Implementation
         if just_yield
           original_blk.call m
         else
-          if current_id && current_id == (m.message_id-1)
+          if current_id && current_id == (m.message_id - 1)
             original_blk.call m
             just_yield = true
           else
@@ -418,14 +419,14 @@ module MessageBus::Implementation
 
     @subscriptions ||= {}
     @subscriptions[site_id] ||= {}
-    @subscriptions[site_id][channel] ||=  []
+    @subscriptions[site_id][channel] ||= []
     @subscriptions[site_id][channel] << blk
     ensure_subscriber_thread
 
     attempts = 100
     while attempts > 0 && !reliable_pub_sub.subscribed
       sleep 0.001
-      attempts-=1
+      attempts -= 1
     end
 
     raise MessageBus::BusDestroyed if @destroyed
@@ -444,7 +445,6 @@ module MessageBus::Implementation
 
   end
 
-
   def ensure_subscriber_thread
     @mutex.synchronize do
       return if (@subscriber_thread && @subscriber_thread.alive?) || @destroyed
@@ -473,7 +473,7 @@ module MessageBus::Implementation
         publish("/__mb_keepalive__/", Process.pid, user_ids: [-1])
         # 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
+        if (Time.now - (@last_message || Time.now)) > keepalive_interval * 3
           MessageBus.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
@@ -530,7 +530,7 @@ module MessageBus::Implementation
           locals = locals[msg.channel] if locals
         end
 
-        multi_each(globals,locals, global_globals, local_globals) do |c|
+        multi_each(globals, locals, global_globals, local_globals) do |c|
           begin
             c.call msg
           rescue => e
@@ -544,7 +544,7 @@ module MessageBus::Implementation
     end
   end
 
-  def multi_each(*args,&block)
+  def multi_each(*args, &block)
     args.each do |a|
       a.each(&block) if a
     end

data/lib/message_bus/backends/memory.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MessageBus::Memory; end
 
 class MessageBus::Memory::Client
@@ -33,7 +34,7 @@ class MessageBus::Memory::Client
     end
     msg = MessageBus::Message.new id, id, channel, value
     payload = msg.encode
-    listeners.each{|l| l.push(payload)}
+    listeners.each { |l| l.push(payload) }
     id
   end
 
@@ -42,7 +43,7 @@ class MessageBus::Memory::Client
       oldest = backlog_id - num_to_keep
       sync do
         @channels.each_value do |entries|
-          entries.delete_if{|id, _| id <= oldest}
+          entries.delete_if { |id, _| id <= oldest }
         end
       end
       nil
@@ -51,24 +52,24 @@ class MessageBus::Memory::Client
 
   def clear_channel_backlog(channel, backlog_id, num_to_keep)
     oldest = backlog_id - num_to_keep
-    sync{chan(channel).delete_if{|id, _| id <= oldest}}
+    sync { chan(channel).delete_if { |id, _| id <= oldest } }
     nil
   end
 
   def backlog(channel, backlog_id)
-    sync{chan(channel).select{|id, _| id > backlog_id}}
+    sync { chan(channel).select { |id, _| id > backlog_id } }
   end
 
   def global_backlog(backlog_id)
     sync do
       @channels.dup.flat_map do |channel, messages|
-        messages.select{|id, _| id > backlog_id}.map{|id, value| [id, channel, value]}
+        messages.select { |id, _| id > backlog_id }.map { |id, value| [id, channel, value] }
       end.sort
     end
   end
 
   def get_value(channel, id)
-    sync{chan(channel).find{|i, _| i == id}.last}
+    sync { chan(channel).find { |i, _| i == id }.last }
   end
 
   # Dangerous, drops the message_bus table containing the backlog if it exists.
@@ -79,7 +80,7 @@ class MessageBus::Memory::Client
     end
   end
 
-  def max_id(channel=nil)
+  def max_id(channel = nil)
     if channel
       sync do
         if entry = chan(channel).last
@@ -87,7 +88,7 @@ class MessageBus::Memory::Client
         end
       end
     else
-      sync{@global_id - 1}
+      sync { @global_id - 1 }
     end || 0
   end
 
@@ -113,7 +114,7 @@ class MessageBus::Memory::Client
   end
 
   def unsubscribe
-    sync{@listeners.each{|l| l.push(nil)}}
+    sync { @listeners.each { |l| l.push(nil) } }
   end
 
   private
@@ -123,7 +124,7 @@ class MessageBus::Memory::Client
   end
 
   def sync
-    @mutex.synchronize{yield}
+    @mutex.synchronize { yield }
   end
 end
 
@@ -163,7 +164,7 @@ class MessageBus::Memory::ReliablePubSub
     client.reset!
   end
 
-  def publish(channel, data, queue_in_memory=true)
+  def publish(channel, data, queue_in_memory = true)
     client = self.client
     backlog_id = client.add(channel, data)
     if backlog_id % clear_every == 0
@@ -232,7 +233,7 @@ class MessageBus::Memory::ReliablePubSub
     @subscribed = false
   end
 
-  def global_subscribe(last_id=nil, &blk)
+  def global_subscribe(last_id = nil, &blk)
     raise ArgumentError unless block_given?
     highest_id = last_id
 
@@ -254,7 +255,7 @@ class MessageBus::Memory::ReliablePubSub
           @subscribed = false
         end
 
-        on.message do |c,m|
+        on.message do |c, m|
           m = MessageBus::Message.decode m
 
           # we have 3 options