message_bus 1.0.16 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f42e4714f39aecb865965bb91a089a5bcd7a8670
-  data.tar.gz: ab929f4b40c6ea23d6f680392da942234ec02457
+  metadata.gz: 7add5c68e797a080452032f17f17930bd2d28092
+  data.tar.gz: 15b55cad8b5dc0599d92fb88c74a83271703f46a
 SHA512:
-  metadata.gz: 04ea180a321eb637807bc14bf657706a1cc66073043f41d915788fe74e8fe7590d80d1dfaddcbea24fe67639b10ff436638c5d6e21636183b93976e1589060a9
-  data.tar.gz: 92eac39422601a62401f9c2ff2386e1ce686194fce6ca67b88f9948bdddc0d60b001feba16a07cd503bad83ca0ebe1debb2253767243fc6dec6e500cb67226a7
+  metadata.gz: 3385147eb91410e0606e95d32183f017cf218b86d2c51f2cfed7fd8ec7b15394c64fa6b64bcc9e3862e61781030b7c8f4d8fbd640f4c3e698dc28e2dd784e3ed
+  data.tar.gz: afcd0a5014c1c1f9ae229565d7dc7574f76eb1eecf544066acbed7b47db9d134b656a4bbc772ecf7285928f0e74b16a8c2e0f26cffa31aa252b55a86120066ef

data/CHANGELOG

@@ -1,3 +1,10 @@
+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
+
 09-07-2015
 - Version 1.0.16
 - Fix: correct edge cases around keepalive checks on bus

data/README.md

@@ -110,6 +110,40 @@ MessageBus.redis_config = { 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.
 
+### Forking/threading app servers
+
+If you're using a forking or threading app server and you're not getting immediate updates from published messages, you might need to reconnect Redis in your app server config:
+
+#### Passenger
+```ruby
+# Rails: config/application.rb or config.ru
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      # We're in smart spawning mode.
+      MessageBus.after_fork
+    else
+      # We're in conservative spawning mode. We don't need to do anything.
+    end
+  end
+end
+```
+
+#### Puma
+```ruby
+# path/to/your/config/puma.rb
+on_worker_boot do
+  MessageBus.after_fork
+end
+```
+
+#### Unicorn
+```ruby
+# path/to/your/config/unicorn.rb
+after_fork do |server, worker|
+  MessageBus.after_fork
+end
+```
 
 ## Similar projects
 

data/assets/message-bus.js

@@ -33,12 +33,17 @@ window.MessageBus = (function() {
 
   var hiddenProperty;
 
-  $.each(["","webkit","ms","moz","ms"], function(index, prefix){
-    var check = prefix + (prefix === "" ? "hidden" : "Hidden");
-    if(document[check] !== undefined ){
-      hiddenProperty = check;
+
+  (function(){
+    var prefixes = ["","webkit","ms","moz","ms"];
+    for(var i=0; i<prefixes.length; i++) {
+      var prefix = prefixes[i];
+      var check = prefix + (prefix === "" ? "hidden" : "Hidden");
+      if(document[check] !== undefined ){
+        hiddenProperty = check;
+      }
     }
-  });
+  })();
 
   var isHidden = function() {
     if (hiddenProperty !== undefined){
@@ -60,9 +65,12 @@ window.MessageBus = (function() {
     var gotData = false;
     if (!messages) return false; // server unexpectedly closed connection
 
-    $.each(messages,function(_,message) {
+
+    for (var i=0; i<messages.length; i++) {
+      var message = messages[i];
       gotData = true;
-      $.each(callbacks, function(_,callback) {
+      for (var j=0; j<callbacks.length; j++) {
+        var callback = callbacks[j];
         if (callback.channel === message.channel) {
           callback.last_id = message.message_id;
           try {
@@ -79,8 +87,8 @@ window.MessageBus = (function() {
             callback.last_id = message.data[callback.channel];
           }
         }
-      });
-    });
+      }
+    }
 
     return gotData;
   };
@@ -90,6 +98,7 @@ window.MessageBus = (function() {
     var aborted = false;
     lastAjax = new Date();
     totalAjaxCalls += 1;
+    data.__seq = totalAjaxCalls;
 
     return me.ajax({
       url: me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""),
@@ -104,9 +113,9 @@ window.MessageBus = (function() {
         failCount = 0;
         if (paused) {
           if (messages) {
-            $.each(messages, function(_,message) {
-              later.push(messages);
-            });
+            for (var i=0; i<messages.length; i++) {
+              later.push(messages[i]);
+            }
           }
         } else {
           gotData = processMessages(messages);
@@ -215,9 +224,9 @@ window.MessageBus = (function() {
         }
 
         data = {};
-        $.each(callbacks, function(_,callback) {
-          data[callback.channel] = callback.last_id;
-        });
+        for (var i=0;i<callbacks.length;i++) {
+          data[callbacks[i].channel] = callbacks[i].last_id;
+        }
 
         me.longPoll = longPoller(poll,data);
       };
@@ -265,7 +274,12 @@ window.MessageBus = (function() {
         channel = channel.substr(0, channel.length - 1);
         glob = true;
       }
-      callbacks = $.grep(callbacks,function(callback) {
+
+      var filtered = [];
+
+      for (var i=0; i<callbacks.length; i++) {
+
+        callback = callbacks[i];
         var keep;
 
         if (glob) {
@@ -278,8 +292,12 @@ window.MessageBus = (function() {
           keep = true;
         }
 
-        return keep;
-      });
+        if (keep) {
+          filtered.push(callback);
+        }
+      }
+
+      callbacks = filtered;
 
       if (me.longPoll) {
         return me.longPoll.abort();

data/lib/message_bus/client.rb

@@ -1,18 +1,28 @@
 class MessageBus::Client
   attr_accessor :client_id, :user_id, :group_ids, :connect_time,
                 :subscribed_sets, :site_id, :cleanup_timer,
-                :async_response, :io, :headers
+                :async_response, :io, :headers, :seq
 
   def initialize(opts)
     self.client_id = opts[:client_id]
     self.user_id = opts[:user_id]
     self.group_ids = opts[:group_ids] || []
     self.site_id = opts[:site_id]
+    self.seq = opts[:seq].to_i
     self.connect_time = Time.now
     @bus = opts[:message_bus] || MessageBus
     @subscriptions = {}
   end
 
+  def cancel
+    if cleanup_timer
+      # concurrency may nil cleanup timer
+      cleanup_timer.cancel rescue nil
+      self.cleanup_timer = nil
+    end
+    ensure_closed!
+  end
+
   def in_async?
     @async_response || @io
   end

data/lib/message_bus/connection_manager.rb

@@ -2,117 +2,124 @@ require 'json' unless defined? ::JSON
 
 class MessageBus::ConnectionManager
   require 'monitor'
+  include MonitorMixin
 
-  class SynchronizedSet
-    include MonitorMixin
-
-    def initialize
-      super
-      @set = Set.new
-    end
-
-    def self.synchronize(methods)
-      methods.each do |method|
-        define_method method do |*args, &blk|
-          synchronize do
-            @set.send method,*args,&blk
-          end
-        end
-      end
-    end
-
-    synchronize(Set.new.methods - Object.new.methods)
-
-  end
-
-  def initialize(bus = nil)
+  def initialize(bus=nil)
     @clients = {}
     @subscriptions = {}
     @bus = bus || MessageBus
+    mon_initialize
   end
 
   def notify_clients(msg)
-    begin
-      site_subs = @subscriptions[msg.site_id]
-      subscription = site_subs[msg.channel] if site_subs
-
-      return unless subscription
-
-      around_filter = @bus.around_client_batch(msg.channel)
-
-      work = lambda do
-        subscription.each do |client_id|
-          client = @clients[client_id]
-          if client && client.allowed?(msg)
-            if copy = client.filter(msg)
-              begin
-                client << copy
-              rescue
-                # pipe may be broken, move on
+    synchronize do
+      begin
+        site_subs = @subscriptions[msg.site_id]
+        subscription = site_subs[msg.channel] if site_subs
+
+        return unless subscription
+
+        around_filter = @bus.around_client_batch(msg.channel)
+
+        work = lambda do
+          subscription.each do |client_id|
+            client = @clients[client_id]
+            if client && client.allowed?(msg)
+              if copy = client.filter(msg)
+                begin
+                  client << copy
+                rescue
+                  # pipe may be broken, move on
+                end
+                # turns out you can delete from a set while itereating
+                remove_client(client)
               end
-              # turns out you can delete from a set while itereating
-              remove_client(client)
             end
           end
         end
-      end
 
-      if around_filter
-        user_ids = subscription.map do |s|
-          c = @clients[s]
-          c && c.user_id
-        end.compact
+        if around_filter
+          user_ids = subscription.map do |s|
+            c = @clients[s]
+            c && c.user_id
+          end.compact
 
-        if user_ids && user_ids.length > 0
-          around_filter.call(msg, user_ids, work)
+          if user_ids && user_ids.length > 0
+            around_filter.call(msg, user_ids, work)
+          end
+        else
+          work.call
         end
-      else
-        work.call
-      end
 
-    rescue => e
-      MessageBus.logger.error "notify clients crash #{e} : #{e.backtrace}"
+      rescue => e
+        MessageBus.logger.error "notify clients crash #{e} : #{e.backtrace}"
+      end
     end
   end
 
   def add_client(client)
-    @clients[client.client_id] = client
-    @subscriptions[client.site_id] ||= {}
-    client.subscriptions.each do |k,v|
-      subscribe_client(client, k)
+    synchronize do
+      existing = @clients[client.client_id]
+      if existing && existing.seq > client.seq
+        client.cancel
+      else
+        if existing
+          remove_client(existing)
+          existing.cancel
+        end
+
+        @clients[client.client_id] = client
+        @subscriptions[client.site_id] ||= {}
+        client.subscriptions.each do |k,v|
+          subscribe_client(client, k)
+        end
+      end
     end
   end
 
   def remove_client(c)
-    @clients.delete c.client_id
-    @subscriptions[c.site_id].each do |k, set|
-      set.delete c.client_id
+    synchronize do
+      @clients.delete c.client_id
+      @subscriptions[c.site_id].each do |k, set|
+        set.delete c.client_id
+      end
+      if c.cleanup_timer
+        # concurrency may cause this to fail
+        c.cleanup_timer.cancel rescue nil
+      end
     end
-    c.cleanup_timer.cancel if c.cleanup_timer
   end
 
   def lookup_client(client_id)
-    @clients[client_id]
+    synchronize do
+      @clients[client_id]
+    end
   end
 
   def subscribe_client(client,channel)
-    set = @subscriptions[client.site_id][channel]
-    unless set
-      set = SynchronizedSet.new
-      @subscriptions[client.site_id][channel] = set
+    synchronize do
+      set = @subscriptions[client.site_id][channel]
+      unless set
+        set = Set.new
+        @subscriptions[client.site_id][channel] = set
+      end
+      set << client.client_id
     end
-    set << client.client_id
   end
 
   def client_count
-    @clients.length
+    synchronize do
+      @clients.length
+    end
   end
 
   def stats
-    {
-      client_count: @clients.length,
-      subscriptions: @subscriptions
-    }
+    synchronize do
+      {
+        client_count: @clients.length,
+        subscriptions: @subscriptions
+      }
+    end
   end
 
 end

data/lib/message_bus/rack/middleware.rb

@@ -86,7 +86,11 @@ class MessageBus::Rack::Middleware
 
     request = Rack::Request.new(env)
     request.POST.each do |k,v|
-      client.subscribe(k, v)
+      if k == "__seq".freeze
+        client.seq = v.to_i
+      else
+        client.subscribe(k, v)
+      end
     end
 
     backlog = client.backlog

data/lib/message_bus/version.rb

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "1.0.16"
+  VERSION = "1.1.0"
 end

data/spec/lib/connection_manager_spec.rb

@@ -84,6 +84,18 @@ end
 
 describe MessageBus::ConnectionManager, "notifying and subscribing concurrently" do
 
+  it "does not subscribe incorrect clients" do
+    manager = MessageBus::ConnectionManager.new
+
+    client1 = MessageBus::Client.new(client_id: "a", seq: 1)
+    client2 = MessageBus::Client.new(client_id: "a", seq: 2)
+
+    manager.add_client(client2)
+    manager.add_client(client1)
+
+    manager.lookup_client("a").should == client2
+  end
+
   it "is thread-safe" do
     @bus = MessageBus
     @manager = MessageBus::ConnectionManager.new(@bus)

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

@@ -33,12 +33,17 @@ window.MessageBus = (function() {
 
   var hiddenProperty;
 
-  $.each(["","webkit","ms","moz","ms"], function(index, prefix){
-    var check = prefix + (prefix === "" ? "hidden" : "Hidden");
-    if(document[check] !== undefined ){
-      hiddenProperty = check;
+
+  (function(){
+    var prefixes = ["","webkit","ms","moz","ms"];
+    for(var i=0; i<prefixes.length; i++) {
+      var prefix = prefixes[i];
+      var check = prefix + (prefix === "" ? "hidden" : "Hidden");
+      if(document[check] !== undefined ){
+        hiddenProperty = check;
+      }
     }
-  });
+  })();
 
   var isHidden = function() {
     if (hiddenProperty !== undefined){
@@ -60,9 +65,12 @@ window.MessageBus = (function() {
     var gotData = false;
     if (!messages) return false; // server unexpectedly closed connection
 
-    $.each(messages,function(_,message) {
+
+    for (var i=0; i<messages.length; i++) {
+      var message = messages[i];
       gotData = true;
-      $.each(callbacks, function(_,callback) {
+      for (var j=0; j<callbacks.length; j++) {
+        var callback = callbacks[j];
         if (callback.channel === message.channel) {
           callback.last_id = message.message_id;
           try {
@@ -79,8 +87,8 @@ window.MessageBus = (function() {
             callback.last_id = message.data[callback.channel];
           }
         }
-      });
-    });
+      }
+    }
 
     return gotData;
   };
@@ -90,6 +98,7 @@ window.MessageBus = (function() {
     var aborted = false;
     lastAjax = new Date();
     totalAjaxCalls += 1;
+    data.__seq = totalAjaxCalls;
 
     return me.ajax({
       url: me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""),
@@ -104,9 +113,9 @@ window.MessageBus = (function() {
         failCount = 0;
         if (paused) {
           if (messages) {
-            $.each(messages, function(_,message) {
-              later.push(messages);
-            });
+            for (var i=0; i<messages.length; i++) {
+              later.push(messages[i]);
+            }
           }
         } else {
           gotData = processMessages(messages);
@@ -215,9 +224,9 @@ window.MessageBus = (function() {
         }
 
         data = {};
-        $.each(callbacks, function(_,callback) {
-          data[callback.channel] = callback.last_id;
-        });
+        for (var i=0;i<callbacks.length;i++) {
+          data[callbacks[i].channel] = callbacks[i].last_id;
+        }
 
         me.longPoll = longPoller(poll,data);
       };
@@ -265,7 +274,12 @@ window.MessageBus = (function() {
         channel = channel.substr(0, channel.length - 1);
         glob = true;
       }
-      callbacks = $.grep(callbacks,function(callback) {
+
+      var filtered = [];
+
+      for (var i=0; i<callbacks.length; i++) {
+
+        callback = callbacks[i];
         var keep;
 
         if (glob) {
@@ -278,8 +292,12 @@ window.MessageBus = (function() {
           keep = true;
         }
 
-        return keep;
-      });
+        if (keep) {
+          filtered.push(callback);
+        }
+      }
+
+      callbacks = filtered;
 
       if (me.longPoll) {
         return me.longPoll.abort();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.1.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: ''