RubyGems - message_bus - Versions diffs - 1.0.12 → 1.0.13 - Mend

message_bus 1.0.12 → 1.0.13

Potentially problematic release.

This version of message_bus might be problematic. Click here for more details.

Files changed (12) hide show

checksums.yaml +4 -4
data/CHANGELOG +5 -0
data/Gemfile +1 -0
data/examples/chat/chat.rb +137 -4
data/examples/chat/docker_container/chat.yml +5 -0
data/lib/message_bus.rb +45 -2
data/lib/message_bus/rack/middleware.rb +2 -9
data/lib/message_bus/timer_thread.rb +29 -0
data/lib/message_bus/version.rb +1 -1
data/spec/lib/multi_process_spec.rb +1 -0
data/spec/lib/timer_thread_spec.rb +27 -3
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9edd8ca36b455984824a1b9841e626352f04751e
-  data.tar.gz: 4f9069b34ea6823a316d20079ec698444f0c6e43
+  metadata.gz: 65597f9dd4a3b22117b594ccaff431aa8ed63198
+  data.tar.gz: 66c1a2a4079eb8d685e6029f1c0a6da4ecb7b7d3
 SHA512:
-  metadata.gz: 6fcc39d57dc21800df3e6fee29ec9bcf95285a44588e6b05e4746693cd070c7f6492e86fdc852351bfde59b209f7d21780912927d0bf20a290f6d4c4ebfb2ebd
-  data.tar.gz: 408932aae79880e94ac15d65c2a5d6fa75eb46eacc2a6fda8eb45f704daac3e7cc1322e4ea5dbe5653b548cfa6b8299a15e157dce46d7bc00d288e45a4d2ef3a
+  metadata.gz: 6b5e51a5a51aec25039cef045b5c75cd4b27e610c7f96c7fa694aee4c7cc0a65b43be5224b8daed76f3a20908a8382baee9c20b15f281c5d76573c135599ea5e
+  data.tar.gz: 121e47af10c76c4ad0ffc7cd70f679632c9be4808adae2314ef977bafd82a341456feb5d18b2ac14827ee2abb4bf7723aad759df87ddab0330c054fd1787bfc2

data/CHANGELOG CHANGED Viewed

@@ -1,3 +1,8 @@
+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

data/Gemfile CHANGED Viewed

@@ -7,6 +7,7 @@ group :test do
   gem 'rspec'
   gem 'redis'
   gem 'rake'
+  gem 'rbtrace'
   gem 'guard-rspec'
   gem 'rb-inotify', require: RUBY_PLATFORM =~ /linux/i ? 'rb-inotify' : false
   gem 'rack'

data/examples/chat/chat.rb CHANGED Viewed

@@ -2,7 +2,48 @@ $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 require 'message_bus'
 require 'sinatra'
 require 'sinatra/base'
+require 'set'
+require 'json'
+$online = Hash.new
+MessageBus.subscribe "/presence" do |msg|
+  if user = msg.data["enter"]
+     $online[user] = Time.now
+  end
+  if user = msg.data["leave"]
+     $online.delete user
+  end
+end
+MessageBus.user_id_lookup do |env|
+  name = env["HTTP_X_NAME"]
+  if name
+    unless $online[name]
+      MessageBus.publish "/presence", {enter: name}
+    end
+    $online[name] = Time.now
+  end
+  name
+end
+def expire_old_sessions
+  $online.each do |name,time|
+    if (Time.now - (5*60)) > time
+       puts "forcing leave for #{name} session timed out"
+       MessageBus.publish "/presence", {leave: name}
+    end
+  end
+rescue => e
+  # need to make $online thread safe
+  p e
+end
+Thread.new do
+  while true
+    expire_old_sessions
+    sleep 1
+  end
+end
 class Chat < Sinatra::Base
@@ -10,8 +51,25 @@ class Chat < Sinatra::Base
   use MessageBus::Rack::Middleware
+  post '/enter' do
+    name = params["name"]
+    i = 1
+    while $online.include? name
+      name = "#{params["name"]}#{i}"
+      i += 1
+    end
+    MessageBus.publish '/presence', {enter: name}
+    {users: $online.keys, name: name}.to_json
+  end
+  post '/leave' do
+    #puts "Got leave for #{params["name"]}"
+    MessageBus.publish '/presence', {leave: params["name"]}
+  end
   post '/message' do
-    MessageBus.publish '/message', params
+    msg = {data: params["data"][0..500], name: params["name"][0..100]}
+    MessageBus.publish '/message', msg
     "OK"
   end
@@ -26,13 +84,29 @@ class Chat < Sinatra::Base
     <script src="/message-bus.js"></script>
     <style>
         #panel { position: fixed; bottom: 0; background-color: #FFFFFF; }
+        #panel form { margin-bottom: 4px; }
+        #panel button, #panel textarea { height: 40px }
+        #panel button { width: 100px; vertical-align: top; }
         #messages { padding-bottom: 40px; }
         .hidden { display: none; }
+        #users {
+         position: fixed; top: 0; right: 0; width: 160px; background-color: #fafafa; height: 100%;
+         border-left: 1px solid #dfdfdf;
+         padding: 5px;
+        }
+        #users ul li {  margin: 0; padding: 0; }
+        #users ul li.me { font-weight: bold; }
+        #users ul { list-style: none; margin 0; padding: 0; }
+        body { padding-right: 160px; }
     </style>
   </head>
   <body>
     <p>This is a trivial chat demo... It is implemented as a <a href="https://github.com/SamSaffron/message_bus/blob/master/examples/chat/chat.rb">Sinatra app</a>. The <a href="https://github.com/SamSaffron/message_bus">message_bus</a> can easily be added to any Rails/Rack app. <small>This app can be deployed with <a href="https://github.com/discourse/discourse_docker">Discourse Docker</a> using <a href="https://github.com/SamSaffron/message_bus/blob/master/examples/chat/docker_container/chat.yml">this template</a>.</small></p>
     <div id='messages' class="hidden"></div>
+    <div id='users' class="hidden">
+      <h3>Online</h3>
+      <ul></ul>
+    </div>
     <div id='panel' class="hidden">
       <form>
         <textarea cols=80 rows=2></textarea>
@@ -45,14 +119,67 @@ class Chat < Sinatra::Base
       $(function() {
         var name;
+        MessageBus.ajax = function(args){
+          args["headers"]["X-NAME"] = name;
+          return $.ajax(args);
+        };
+        var enter = function(name, opts) {
+           if (opts && opts.check) {
+             var found = false;
+             $('#users ul li').each(function(){
+                found = found || ($(this).text().trim() === name.trim());
+                if (found && opts.me) {
+                  $(this).remove();
+                  found = false;
+                }
+                return !found;
+             });
+             if (found) { return; }
+           }
+           var li = $('<li></li>');
+           li.text(name);
+           if (opts && opts.me) {
+             li.addClass("me");
+             $('#users ul').prepend(li);
+           } else {
+             $('#users ul').append(li);
+           }
+        };
         $('#messages, #panel').addClass('hidden');
         $('#your-name input').keyup(function(e){
           if(e.keyCode == 13) {
             name = $(this).val();
+            $.post("/enter", { name: name}, null, "json" ).success(function(data){
+              $.each(data.users,function(idx, name){
+                enter(name);
+              });
+              name = data.name;
+              enter(name, {check: true, me: true});
+            });
             $('#your-name').addClass('hidden');
-            $('#messages, #panel').removeClass('hidden');
-            $('#send').text("send (" + name + ")");
+            $('#messages, #panel, #users').removeClass('hidden');
+            $(document.body).scrollTop(document.body.scrollHeight);
+            window.onbeforeunload = function(){
+              $.post("/leave", { name: name });
+            };
+            MessageBus.subscribe("/presence", function(msg){
+              if (msg.enter) {
+                 enter(msg.enter, {check: true});
+              }
+              if (msg.leave) {
+               $('#users ul li').each(function(){
+                  if ($(this).text() === msg.leave) {
+                    $(this).remove()
+                  }
+               });
+              }
+            });
           }
         });
@@ -70,7 +197,13 @@ class Chat < Sinatra::Base
           if (val.length === 0) {
             return;
           }
-          $.post("/message", { data: val, name: name} );
+          if (val.length > 500) {
+            alert("message too long");
+            return false;
+          } else {
+            $.post("/message", { data: val, name: name} );
+          }
           $('textarea').val("");
         };

data/examples/chat/docker_container/chat.yml CHANGED Viewed

@@ -31,6 +31,11 @@ hooks:
           - gem install unicorn
           - gem install redis
           - gem install sinatra
+          - gem install rbtrace
+    - replace:
+      - filename: $home/examples/chat/chat.rb
+      - from: "require 'json'"
+      - to: "require 'json'\nrequire 'rbtrace'"
     - file:
        path: /etc/service/unicorn/run
        chmod: "+x"

data/lib/message_bus.rb CHANGED Viewed

@@ -9,6 +9,7 @@ require "message_bus/diagnostics"
 require "message_bus/rack/middleware"
 require "message_bus/rack/diagnostics"
 require "message_bus/redis/reliable_pub_sub"
+require "message_bus/timer_thread"
 # we still need to take care of the logger
 if defined?(::Rails)
@@ -297,11 +298,14 @@ module MessageBus::Implementation
       @destroyed = true
     end
     @subscriber_thread.join if @subscriber_thread
+    timer.stop
   end
   def after_fork
     reliable_pub_sub.after_fork
     ensure_subscriber_thread
+    # will ensure timer is running
+    timer.queue{}
   end
   def listening?
@@ -313,6 +317,17 @@ module MessageBus::Implementation
     reliable_pub_sub.reset!
   end
+  def timer
+    return @timer_thread if @timer_thread
+    @timer_thread ||= begin
+      t = MessageBus::TimerThread.new
+      t.on_error do |e|
+        logger.warn "Failed to process job: #{e} #{e.backtrace}"
+      end
+      t
+    end
+  end
   protected
   def global?(channel)
@@ -370,24 +385,51 @@ module MessageBus::Implementation
     end
   end
+  KEEPALIVE_INTERVAL = 60
   def new_subscriber_thread
-    Thread.new do
+    thread = Thread.new do
       begin
         global_subscribe_thread unless @destroyed
       rescue => e
         MessageBus.logger.warn "Unexpected error in subscriber thread #{e}"
       end
     end
+    blk = proc do
+      if !@destroyed && thread.alive?
+        publish("/__mb_keepalive__/", Process.pid, user_ids: [-1])
+        if Time.now - (@last_message || Time.now) > KEEPALIVE_INTERVAL*2
+          MessageBus.logger.warn "Global messages on #{Process.pid} timed out, restarting thread"
+          # No other clean way to remove this thread, its listening on a socket
+          #   no data is arriving
+          #
+          # In production we see this kind of situation ... sometimes ... when there is
+          # a VRRP failover, or weird networking condition
+          thread.kill
+          sleep 1
+          ensure_subscriber_thread
+        else
+          timer.queue(KEEPALIVE_INTERVAL, &blk)
+        end
+      end
+    end
+    timer.queue(KEEPALIVE_INTERVAL, &blk)
+    thread
   end
   def global_subscribe_thread
-    reliable_pub_sub.global_subscribe do |msg|
+    # pretend we just got a message
+    @last_message = Time.now
+    reliable_pub_sub.global_subscribe(@global_id) do |msg|
       begin
+        @last_message = Time.now
         decode_message!(msg)
         globals, locals, local_globals, global_globals = nil
         @mutex.synchronize do
           raise MessageBus::BusDestroyed if @destroyed
+          @last_message_time = Time.now
           globals = @subscriptions[nil]
           locals = @subscriptions[msg.site_id] if msg.site_id
@@ -408,6 +450,7 @@ module MessageBus::Implementation
       rescue => e
         MessageBus.logger.warn "failed to process message #{msg.inspect}\n ex: #{e} backtrace: #{e.backtrace}"
       end
+      @global_id = msg.global_id
     end
   end

data/lib/message_bus/rack/middleware.rb CHANGED Viewed

@@ -5,12 +5,6 @@ class MessageBus::Rack::Middleware
   def start_listener
     unless @started_listener
-      require 'message_bus/timer_thread'
-      @timer_thread = MessageBus::TimerThread.new
-      @timer_thread.on_error do |e|
-        @bus.logger.warn "Failed to process job: #{e} #{e.backtrace}"
-      end
       thin = defined?(Thin::Server) && ObjectSpace.each_object(Thin::Server).to_a.first
       thin_running = thin && thin.running?
@@ -27,7 +21,7 @@ class MessageBus::Rack::Middleware
         if thin_running
           EM.next_tick(&run)
         else
-          @timer_thread.queue(&run)
+          MessageBus.timer.queue(&run)
         end
         @started_listener = true
@@ -45,7 +39,6 @@ class MessageBus::Rack::Middleware
   def stop_listener
     if @subscription
       @bus.unsubscribe(&@subscription)
-      @timer_thread.stop if @timer_thread
       @started_listener = false
     end
   end
@@ -165,7 +158,7 @@ class MessageBus::Rack::Middleware
   def add_client_with_timeout(client)
     @connection_manager.add_client(client)
-    client.cleanup_timer = @timer_thread.queue( @bus.long_polling_interval.to_f / 1000) {
+    client.cleanup_timer = MessageBus.timer.queue( @bus.long_polling_interval.to_f / 1000) {
       begin
         client.cleanup_timer = nil
         client.ensure_closed!

data/lib/message_bus/timer_thread.rb CHANGED Viewed

@@ -13,6 +13,14 @@ class MessageBus::TimerThread
     end
   end
+  class CancelableEvery
+    attr_accessor :cancelled, :current
+    def cancel
+      current.cancel if current
+      @cancelled = true
+    end
+  end
   def initialize
     @stopped = false
     @jobs = []
@@ -24,6 +32,27 @@ class MessageBus::TimerThread
   def stop
     @stopped = true
+    running = true
+    while running
+      @mutex.synchronize do
+        running = @thread && @thread.alive?
+        @thread.wakeup if running
+      end
+      sleep 0
+    end
+  end
+  def every(delay, &block)
+    result = CancelableEvery.new
+    do_work = proc do
+      begin
+        block.call
+      ensure
+        result.current = queue(delay, &do_work)
+      end
+    end
+    result.current = queue(delay,&do_work)
+    result
   end
   # queue a block to run after a certain delay (in seconds)

data/lib/message_bus/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "1.0.12"
+  VERSION = "1.0.13"
 end

data/spec/lib/multi_process_spec.rb CHANGED Viewed

@@ -52,6 +52,7 @@ describe MessageBus::Redis::ReliablePubSub do
           Process.wait(pid)
         end
       end
+      bus.global_unsubscribe
     end
   end
 end

data/spec/lib/timer_thread_spec.rb CHANGED Viewed

@@ -10,6 +10,21 @@ describe MessageBus::TimerThread do
     @timer.stop
   end
+  it "allows you to queue every jobs" do
+    i = 0
+    m = Mutex.new
+    every = @timer.every(0.001){m.synchronize{i += 1}}
+    # allow lots of time, cause in test mode stuff can be slow
+    wait_for(1000) do
+      m.synchronize do
+        every.cancel if i == 3
+        i == 3
+      end
+    end
+    sleep 0.002
+    i.should == 3
+  end
   it "allows you to cancel timers" do
     success = true
     @timer.queue(0.005){success=false}.cancel
@@ -21,18 +36,27 @@ describe MessageBus::TimerThread do
     counter = 0
     failed = nil
-    items = (0..5).to_a.shuffle
+    ready = 0
+    items = (0...4).to_a.shuffle
     items.map do |i|
       # threading introduces a delay meaning we need to wait a long time
       Thread.new do
-        @timer.queue(i/500.0) do
+        ready += 1
+        while ready < 4
+          sleep 0
+        end
+        # on my mbp I measure at least 200ms of schedule jitter for Thread
+        @timer.queue(i/3.0) do
+          #puts "counter #{counter} i #{i}"
           failed = true if counter != i
           counter += 1
         end
+        #puts "\nqueued #{i/200.0} #{i} #{Time.now.to_f}\n"
       end
     end
-    wait_for(1500) {
+    wait_for(3000) {
       counter == items.length
     }

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Sam Saffron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack