message_bus 2.0.0.beta.6 → 2.0.0.beta.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 686569cf588c00aa211a970eab14d37cf979c844
-  data.tar.gz: 167ad799942ea8f8de1e945015bae4f687c4629f
+  metadata.gz: 765d5f2c439f0bcc0ca030a838d93510ed638916
+  data.tar.gz: 23a0428b2f62625e4063c066828d9fb5925a0a86
 SHA512:
-  metadata.gz: 6810d52979d00f065b8de475f8cbeb81edbe7ae8fc706d1a818d32ac2f1c36f2f9ee94c3585968beba594dde53064f82a58348c0948a2b0d64326e356880cb32
-  data.tar.gz: 0bd9ac5196a77f53797e834b3e296bdad9328fcc6a28331b5e53456527eb5be8df25de76fd3aa05e960f4927531d19f7bfb8ffafdb163006bb1264273d0987d1
+  metadata.gz: 19127a42396bebe0d047fc7a3c41d7be908072711ef294e71d4f6546acd260b93520a4d0eb391d39b63253b5d6e057ee43aebaf7e032dd8f6cc6531352131001
+  data.tar.gz: e863e48441974a73d3f956b9ba2cf01622bbc173ac5db435d3b0c1d38db0dab9b2b884d230cf50ab463ec225d323a73f4a7fd0299a033940074b5aaf29bb6583

data/CHANGELOG

@@ -1,3 +1,10 @@
+26-04-2016
+
+- Version 2.0.0.beta.7
+
+- Feature: Support custom HTTP headers without depending on jQuery @nathanstitt
+- Feature: Allow subscribe at a particular position from server side @sam
+
 29-02-2016
 
 - Version 2.0.0.beta.6

data/README.md

@@ -49,6 +49,16 @@ MessageBus.subscribe "/channel" do |msg|
   # block called in a background thread when message is received
 end
 
+# subscribe to channel and receive the entire backlog
+MessageBus.subscribe "/channel", 0 do |msg|
+  # block called in a background thread when message is received
+end
+
+# subscribe to channel and receive the backlog starting at message 6
+MessageBus.subscribe "/channel", 5 do |msg|
+  # block called in a background thread when message is received
+end
+
 MessageBus.backlog "/channel", id
 # returns all messages after the id
 
@@ -175,7 +185,7 @@ maxPollInterval|180000|If request to the server start failing, MessageBus will b
 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
 ajax|$.ajax or XMLHttpRequest|MessageBus will first attempt to use jQuery and then fallback to a plain XMLHttpRequest version that's contained in the `messsage-bus-ajax.js` file. `messsage-bus-ajax.js` must be loaded after `messsage-bus.js` for it to be used.
-
+headers|{}|Extra headers to be include with request.  Properties and values of object must be valid values for HTTP Headers, i.e. no spaces and control characters.
 **API**:
 
 `MessageBus.diagnostics()` : Returns a log that may be used for diagnostics on the status of message bus

data/assets/message-bus.js

@@ -123,6 +123,9 @@
     var headers = {
       'X-SILENCE-LOGGER': 'true'
     };
+    for (var name in me.headers){
+      headers[name] = me.headers[name];
+    }
 
     if (!chunked){
       headers["Dont-Chunk"] = 'true';
@@ -274,6 +277,7 @@
     clientId: clientId,
     alwaysLongPoll: false,
     baseUrl: baseUrl,
+    headers: {},
     ajax: (jQuery && jQuery.ajax),
     noConflict: function(){
       global.MessageBus = global.MessageBus.previousMessageBus;

data/examples/chat/chat.rb

@@ -121,10 +121,7 @@ class Chat < Sinatra::Base
       $(function() {
         var name;
 
-        MessageBus.ajax = function(args){
-          args["headers"]["X-NAME"] = name;
-          return $.ajax(args);
-        };
+        MessageBus.headers["X-NAME"] = name;
 
         var enter = function(name, opts) {
            if (opts && opts.check) {

data/examples/chat/docker_container/chat.yml

@@ -2,6 +2,7 @@ base_image: "discourse/base:1.0.15"
 
 update_pups: false
 
+
 params:
   home: /var/www/message_bus
 
@@ -10,11 +11,15 @@ templates:
 
 expose:
   - "80:80"
+  - "443:443"
 
 volumes:
   - volume:
      host: /var/docker/shared/chat
      guest: /shared
+  - volume:
+     host: /etc/letsencrypt
+     guest: /etc/letsencrypt
 
 hooks:
   after_redis:
@@ -45,6 +50,10 @@ hooks:
         filename: /etc/nginx/nginx.conf
         from: pid /run/nginx.pid;
         to: daemon off;
+    - exec:
+        cmd:
+          - "mkdir -p /shared/ssl"
+          - "[ -e /shared/ssl/dhparams.pem ] || openssl dhparam -out /shared/ssl/dhparams.pem 2048"
     - file:
         path: /etc/nginx/conf.d/chat.conf
         contents: |
@@ -53,11 +62,25 @@ hooks:
           }
           server {
             listen 80;
+            rewrite ^ https://chat.samsaffron.com$request_uri? permanent;
+          }
+          server {
+            listen 443 ssl http2;
+            ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+            ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA;
+            ssl_prefer_server_ciphers on; 
+            ssl_session_tickets off;
+            ssl_session_timeout 1d;
+            ssl_session_cache shared:SSL:1m; 
+            ssl_dhparam /shared/ssl/dhparams.pem;
+            ssl_certificate /etc/letsencrypt/live/chat.samsaffron.com/fullchain.pem;
+            ssl_certificate_key /etc/letsencrypt/live/chat.samsaffron.com/privkey.pem;
             gzip on;
             gzip_types application/json text/css application/x-javascript;
             gzip_min_length 1000;
             server_name chat.samsaffron.com;
             keepalive_timeout 65;
+            root /shared/letsencrypt;
 
             location /message-bus/ {
               proxy_set_header Host $http_host;
@@ -70,7 +93,6 @@ hooks:
               break;
             }
 
-
             location / {
               try_files $uri @chat;
               break;

data/lib/message_bus.rb

@@ -257,8 +257,14 @@ module MessageBus::Implementation
     channel.split(ENCODE_SITE_TOKEN)
   end
 
-  def subscribe(channel=nil, &blk)
-    subscribe_impl(channel, nil, &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)
+    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)
@@ -270,12 +276,6 @@ module MessageBus::Implementation
     unsubscribe_impl(channel, site_id, &blk)
   end
 
-  # subscribe only on current site
-  def local_subscribe(channel=nil, &blk)
-    site_id = site_id_lookup.call if site_id_lookup && ! global?(channel)
-    subscribe_impl(channel, site_id, &blk)
-  end
-
   def global_backlog(last_id=nil)
     backlog(nil, last_id)
   end
@@ -372,10 +372,45 @@ module MessageBus::Implementation
     msg.client_ids = parsed["client_ids"]
   end
 
-  def subscribe_impl(channel, site_id, &blk)
+  def replay_backlog(channel, last_id, site_id)
+    id = nil
+
+    backlog(channel, last_id, site_id).each do |m|
+      yield m
+      id = m.message_id
+    end
+
+    id
+  end
+
+  def subscribe_impl(channel, site_id, last_id, &blk)
 
     raise MessageBus::BusDestroyed if @destroyed
 
+    if last_id >= 0
+      # this gets a bit tricky, but we got to ensure ordering so we wrap the block
+      original_blk = blk
+      current_id = replay_backlog(channel, last_id, site_id, &blk)
+      just_yield = false
+
+      # we double check to ensure no messages snuck through while we were subscribing
+      blk = proc do |m|
+        if just_yield
+          original_blk.call m
+        else
+          if current_id && current_id == (m.message_id-1)
+            original_blk.call m
+            just_yield = true
+          else
+            current_id = replay_backlog(channel, current_id, site_id, &original_blk)
+            if (current_id == m.id)
+              just_yield = true
+            end
+          end
+        end
+      end
+    end
+
     @subscriptions ||= {}
     @subscriptions[site_id] ||= {}
     @subscriptions[site_id][channel] ||=  []

data/lib/message_bus/backends/postgres.rb

@@ -52,11 +52,11 @@ class MessageBus::Postgres::Client
   end
 
   def backlog(channel, backlog_id)
-    hold{|conn| exec_prepared(conn, 'channel_backlog', [channel, backlog_id]){|r| r.values.each{|a| a[0] = a[0].to_i}}}
+    hold{|conn| exec_prepared(conn, 'channel_backlog', [channel, backlog_id]){|r| r.values.each{|a| a[0] = a[0].to_i}}} || []
   end
 
   def global_backlog(backlog_id)
-    hold{|conn| exec_prepared(conn, 'global_backlog', [backlog_id]){|r| r.values.each{|a| a[0] = a[0].to_i}}}
+    hold{|conn| exec_prepared(conn, 'global_backlog', [backlog_id]){|r| r.values.each{|a| a[0] = a[0].to_i}}} || []
   end
 
   def get_value(channel, id)
@@ -157,7 +157,7 @@ class MessageBus::Postgres::Client
       conn = sync{@available.shift} || new_pg_connection
       sync{@allocated[Thread.current] = conn}
       yield conn
-    rescue PG::ConnectionBad => e
+    rescue PG::ConnectionBad, PG::UnableToSend => e
       # don't add this connection back to the pool
     ensure
       sync{@allocated.delete(Thread.current)}
@@ -279,8 +279,6 @@ class MessageBus::Postgres::ReliablePubSub
   end
 
   def global_backlog(last_id = nil)
-    last_id = last_id.to_i
-
     items = client.global_backlog last_id.to_i
 
     items.map! do |id, channel, data|

data/lib/message_bus/version.rb

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "2.0.0.beta.6"
+  VERSION = "2.0.0.beta.7"
 end

data/spec/assets/SpecHelper.js

@@ -24,7 +24,9 @@ var encodeChunks = function(xhr, chunks) {
 beforeEach(function () {
   var spec = this;
 
-  function MockedXMLHttpRequest(options){ this.options = options; }
+  function MockedXMLHttpRequest(){
+    this.headers = {};
+  };
   MockedXMLHttpRequest.prototype.send              = function(){
     this.readyState = 4
     this.responseText = encodeChunks(this, spec.responseChunks);
@@ -35,7 +37,9 @@ beforeEach(function () {
   }
   MockedXMLHttpRequest.prototype.open              = function(){ }
   MockedXMLHttpRequest.prototype.abort             = function(){ }
-  MockedXMLHttpRequest.prototype.setRequestHeader  = function(){ }
+  MockedXMLHttpRequest.prototype.setRequestHeader  = function(k,v){
+    this.headers[k] = v;
+  }
   MockedXMLHttpRequest.prototype.getResponseHeader = function(){
     return 'text/plain; charset=utf-8';
   }

data/spec/assets/message-bus.spec.js

@@ -74,4 +74,17 @@ describe("Messagebus", function() {
     window.MessageBus = mb;
   });
 
+  testMB('sends using custom header', function(){
+    MessageBus.headers['X-MB-TEST-VALUE'] = '42';
+    this.perform(function(message, xhr){
+      expect(xhr.headers).toEqual({
+        'X-SILENCE-LOGGER': 'true',
+        'X-MB-TEST-VALUE': '42',
+        'Content-Type': 'application/json'
+      });
+    }).finally(function(){
+      MessageBus.headers = {};
+    })
+  });
+
 });

data/spec/lib/message_bus_spec.rb

@@ -18,6 +18,28 @@ describe MessageBus do
     @bus.destroy
   end
 
+  it "can subscribe from a point in time" do
+    @bus.publish("/minion", "banana")
+
+    data1 = []
+    data2 = []
+
+    @bus.subscribe("/minion") do |msg|
+      data1 << msg.data
+    end
+
+    @bus.subscribe("/minion", 0) do |msg|
+      data2 << msg.data
+    end
+
+    @bus.publish("/minion", "bananana")
+
+    wait_for(2000){ data2.length == 2 && data1.length == 1}
+
+    data1.must_equal ['bananana']
+    data2.must_equal ['banana', 'bananana']
+  end
+
   it "can transmit client_ids" do
     client_ids = nil
 

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

@@ -0,0 +1,44 @@
+// A bare-bones implementation of $.ajax that MessageBus will use
+// as a fallback if jQuery is not present
+//
+// Only implements methods & options used by MessageBus
+(function(global, undefined) {
+  'use strict';
+  if (!global.MessageBus){
+      throw new Error("MessageBus must be loaded before the ajax adapter");
+  }
+
+  var cacheBuster =  Math.random() * 10000 | 0;
+
+  global.MessageBus.ajax = function(options){
+    var XHRImpl = (global.MessageBus && global.MessageBus.xhrImplementation) || global.XMLHttpRequest;
+    var xhr = new XHRImpl();
+    xhr.dataType = options.dataType;
+    var url = options.url;
+    if (!options.cache){
+      url += ((-1 == url.indexOf('?')) ? '?' : '&') + '_=' + (cacheBuster++)
+    }
+    xhr.open('POST', url);
+    for (var name in options.headers){
+      xhr.setRequestHeader(name, options.headers[name]);
+    }
+    xhr.setRequestHeader('Content-Type', 'application/json');
+    if (options.messageBus.chunked){
+      options.messageBus.onProgressListener(xhr);
+    }
+    xhr.onreadystatechange = function(){
+      if (xhr.readyState === 4){
+        var status = xhr.status;
+        if (status >= 200 && status < 300 || status === 304){
+          options.success(xhr.responseText);
+        } else {
+          options.error(xhr, xhr.statusText);
+        }
+        options.complete();
+      }
+    }
+    xhr.send(JSON.stringify(options.data));
+    return xhr;
+  };
+
+})(window);

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

@@ -123,6 +123,9 @@
     var headers = {
       'X-SILENCE-LOGGER': 'true'
     };
+    for (var name in me.headers){
+      headers[name] = me.headers[name];
+    }
 
     if (!chunked){
       headers["Dont-Chunk"] = 'true';
@@ -274,6 +277,7 @@
     clientId: clientId,
     alwaysLongPoll: false,
     baseUrl: baseUrl,
+    headers: {},
     ajax: (jQuery && jQuery.ajax),
     noConflict: function(){
       global.MessageBus = global.MessageBus.previousMessageBus;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.6
+  version: 2.0.0.beta.7
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -131,6 +131,7 @@ files:
 - spec/lib/message_bus/timer_thread_spec.rb
 - spec/lib/message_bus_spec.rb
 - spec/spec_helper.rb
+- vendor/assets/javascripts/message-bus-ajax.js
 - vendor/assets/javascripts/message-bus.js
 homepage: https://github.com/SamSaffron/message_bus
 licenses: