message_bus 1.1.1 → 2.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00b86d8f7631445d13999cf03c8474c94a5c6df0
-  data.tar.gz: da3f677b77b8695d27cb5d6997c22894ea33bd5b
+  metadata.gz: 82d57b58ca16d1422134657e6b185c5192b0f3c8
+  data.tar.gz: 9d87638ef14e32e57c5b3062f0cfab969260fe51
 SHA512:
-  metadata.gz: 7bba577513285f36a95898d524e2cc60f832be1e1c7bb92d63313fe82b5862dd3ddeb48930fff071bde92d85be03eea102836af19513633f23e0962c645e8d1d
-  data.tar.gz: bbb1d8c326c2e8c85ddacce97a37aabdf0562ac15b0bd7153ce1fec6ebebbd7c7d68d14a36ec45e1afaa2a1b911ca2e01facf4a86da521669251bf86e97143e2
+  metadata.gz: defc3054b3f7bee5ac3b6ef58953153e51c39cde11deaa6876f9befa9953af1ebd7fd870253dfe5a4fec8bca6e8c8e5b09192c0ea075db26e6139c65f8c5edb5
+  data.tar.gz: aa4762a17e508d234889e3ea37fea18bd3a3e758e4d3ee5cf81d0c121c94f5763dff71bff22b476130a2ac1ef4cabd7085267f7a776dbaf8de61a866b6c27504

data/CHANGELOG

@@ -1,3 +1,11 @@
+03-01-2016
+
+- Version 2.0.0.beta.1
+- Feature: add support for chunked encoding transport, this significnatlly improves long polling performance
+- Feature: strip around_filters and client filters, which were speculative
+- Fix: Message delivery race condition when a message was published just as long poll started. Ben Langfeld
+- Feature: strip support for message_handlers, speculative feature that was not used
+
 09-12-2015
 
 - Version 1.1.1

data/README.md

@@ -2,12 +2,21 @@
 
 A reliable, robust messaging bus for Ruby processes and web clients built on Redis.
 
-MessageBus implements a Server to Server channel based protocol and Server to Web Client protocol (using polling or long-polling)
+MessageBus implements a Server to Server channel based protocol and Server to Web Client protocol (using polling, long-polling or long-polling + streaming)
 
 Long-polling is implemented using Rack Hijack and Thin::Async, all common Ruby web server can run MessageBus (Thin, Puma, Unicorn) and handle a large amount of concurrent connections that wait on messages.
 
 MessageBus is implemented as Rack middleware and can be used by and Rails / Sinatra or pure Rack application.
 
+# Try it out!
+
+Live chat demo per [examples/chat](https://github.com/SamSaffron/message_bus/tree/master/examples/chat) is at:
+
+### http://chat.samsaffron.com
+
+## 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.
 
 ## Installation
 
@@ -39,7 +48,6 @@ end
 MessageBus.backlog "/channel", id
 # returns all messages after the id
 
-
 # messages can be targetted at particular users or groups
 MessageBus.publish "/channel", user_ids: [1,2,3], group_ids: [4,5,6]
 
@@ -56,17 +64,49 @@ MessageBus.group_ids_lookup do |env|
   # return the group ids the user belongs to
   # can be nil or []
 end
+```
 
+### Transport
 
-MessageBus.client_filter("/channel") do |user_id, message|
-  # return message if client is allowed to see this message
-  # allows you to inject server side filtering of messages based on arbitrary rules
-  # also allows you to override the message a clients will see
-  # be sure to .dup the message if you wish to change it
-end
+MessageBus ships with 3 transport mechanisms.
+
+1. Long Polling with chunked encoding (streaming)
+2. Long Polling
+3. Polling
+
+Long Polling with chunked encoding allows a single connection to stream multiple messages to a client, this requires HTTP/1.1
 
+Chunked encoding provides all the benefits of [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) with greater browser support (as it works on IE10 and up as well)
+
+To setup NGINX to proxy to your app correctly be sure to enable HTTP1.1 and disable buffering
+
+```
+location /message-bus/ {
+  ...
+  proxy_buffering off;
+  proxy_http_version 1.1;
+  ...
+}
 ```
 
+**NOTE**: do not set proxy_buffering off globally, it may have unintended consequences.
+
+If you wish to disable chunked encoding run:
+
+```
+MessageBus.enableChunkedEncoding = false; // in your JavaScript
+```
+
+Or
+
+```
+MessageBus.chunked_encoding_enabled = false // in Ruby
+```
+
+Long Polling requires no special setup, as soon as new data arrives on the channel the server delivers the data and closes the connection.
+
+Polling also requires no special setup, MessageBus will fallback to polling after a tab becomes inactive and remains inactive for a period.
+
 ### Multisite support
 
 MessageBus can be used in an environment that hosts multiple sites by multiplexing channels. To use this mode
@@ -195,5 +235,6 @@ If you are looking to contribute to this project here are some ideas
 - Build a PostgreSQL backend using NOTIFY and LISTEN
 - Improve general documentation
 - Port the test suite to MiniTest
+- Make MessageBus a nice website
 
 

data/assets/message-bus.js

@@ -1,12 +1,6 @@
 /*jshint bitwise: false*/
+"use strict;"
 
-/**
-  Message Bus functionality.
-
-  @class MessageBus
-  @namespace Discourse
-  @module Discourse
-**/
 window.MessageBus = (function() {
   // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript
   var callbacks, clientId, failCount, shouldLongPoll, queue, responseCallbacks, uniqueId, baseUrl;
@@ -30,12 +24,13 @@ window.MessageBus = (function() {
   baseUrl = "/";
   paused = false;
   later = [];
+  chunkedBackoff = 0;
 
   var hiddenProperty;
 
 
   (function(){
-    var prefixes = ["","webkit","ms","moz","ms"];
+    var prefixes = ["","webkit","ms","moz"];
     for(var i=0; i<prefixes.length; i++) {
       var prefix = prefixes[i];
       var check = prefix + (prefix === "" ? "hidden" : "Hidden");
@@ -53,6 +48,11 @@ window.MessageBus = (function() {
     }
   };
 
+  var hasonprogress = (new XMLHttpRequest()).onprogress === null;
+  var allowChunked = function(){
+    return me.enableChunkedEncoding && hasonprogress;
+  };
+
   shouldLongPoll = function() {
     return me.alwaysLongPoll || !isHidden();
   };
@@ -65,7 +65,6 @@ window.MessageBus = (function() {
     var gotData = false;
     if (!messages) return false; // server unexpectedly closed connection
 
-
     for (var i=0; i<messages.length; i++) {
       var message = messages[i];
       gotData = true;
@@ -93,6 +92,20 @@ window.MessageBus = (function() {
     return gotData;
   };
 
+  var reqSuccess = function(messages) {
+    failCount = 0;
+    if (paused) {
+      if (messages) {
+        for (var i=0; i<messages.length; i++) {
+          later.push(messages[i]);
+        }
+      }
+    } else {
+      return processMessages(messages);
+    }
+    return false;
+  };
+
   longPoller = function(poll,data){
     var gotData = false;
     var aborted = false;
@@ -100,27 +113,97 @@ window.MessageBus = (function() {
     totalAjaxCalls += 1;
     data.__seq = totalAjaxCalls;
 
-    return me.ajax({
-      url: me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""),
+    var longPoll = shouldLongPoll() && me.enableLongPolling;
+    var chunked = longPoll && allowChunked();
+    if (chunkedBackoff > 0) {
+      chunkedBackoff--;
+      chunked = false;
+    }
+
+    var headers = {
+      'X-SILENCE-LOGGER': 'true'
+    };
+
+    if (!chunked){
+      headers["Dont-Chunk"] = 'true';
+    }
+
+    var dataType = chunked ? "text" : "json";
+
+    var handle_progress = function(payload, position) {
+
+      var separator = "\r\n|\r\n";
+      var endChunk = payload.indexOf(separator, position);
+
+      if (endChunk === -1) {
+        return position;
+      }
+
+      var chunk = payload.substring(position, endChunk);
+      chunk = chunk.replace(/\r\n\|\|\r\n/g, separator);
+
+      try {
+        console.log(chunk);
+        reqSuccess(JSON.parse(chunk));
+      } catch(e) {
+        if (console.log) {
+          console.log("FAILED TO PARSE CHUNKED REPLY");
+          console.log(data);
+        }
+      }
+
+      return handle_progress(payload, endChunk + separator.length);
+    }
+
+    var disableChunked = function(){
+      if (me.longPoll) {
+        me.longPoll.abort();
+        chunkedBackoff = 30;
+      }
+    };
+
+    var req = me.ajax({
+      url: me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!longPoll ? "dlp=t" : ""),
       data: data,
       cache: false,
-      dataType: 'json',
+      dataType: dataType,
       type: 'POST',
-      headers: {
-        'X-SILENCE-LOGGER': 'true'
+      headers: headers,
+      xhr: function() {
+         var xhr = jQuery.ajaxSettings.xhr();
+
+         if (!chunked) {
+            return xhr;
+         }
+
+         var position = 0;
+
+         // if it takes longer than 3000 ms to get first chunk, we have some proxy
+         // this is messing with us, so just backoff from using chunked for now
+         var chunkedTimeout = setTimeout(disableChunked,3000);
+
+         xhr.onprogress = function () {
+           clearTimeout(chunkedTimeout);
+
+           if(xhr.getResponseHeader('Content-Type') === 'application/json; charset=utf-8') {
+             // not chunked we are sending json back
+             chunked = false;
+             return;
+           }
+           position = handle_progress(xhr.responseText, position);
+         }
+
+         return xhr;
       },
       success: function(messages) {
-        failCount = 0;
-        if (paused) {
-          if (messages) {
-            for (var i=0; i<messages.length; i++) {
-              later.push(messages[i]);
-            }
-          }
-        } else {
-          gotData = processMessages(messages);
-        }
-      },
+         if (!chunked) {
+           // we may have requested text so jQuery will not parse
+           if (typeof(messages) === "string") {
+             messages = JSON.parse(messages);
+           }
+           gotData = reqSuccess(messages);
+         }
+       },
       error: function(xhr, textStatus, err) {
         if(textStatus === "abort") {
           aborted = true;
@@ -161,9 +244,12 @@ window.MessageBus = (function() {
         me.longPoll = null;
       }
     });
+
+    return req;
   };
 
   me = {
+    enableChunkedEncoding: true,
     enableLongPolling: true,
     callbackInterval: 15000,
     backgroundCallbackInterval: 60000,

data/examples/chat/chat.rb

@@ -7,6 +7,7 @@ require 'json'
 
 $online = Hash.new
 
+
 MessageBus.subscribe "/presence" do |msg|
   if user = msg.data["enter"]
      $online[user] = Time.now
@@ -17,6 +18,7 @@ MessageBus.subscribe "/presence" do |msg|
 end
 
 MessageBus.user_id_lookup do |env|
+  MessageBus.logger = env['rack.logger']
   name = env["HTTP_X_NAME"]
   if name
     unless $online[name]

data/examples/chat/docker_container/chat.yml

@@ -1,4 +1,4 @@
-base_image: "samsaffron/discourse_base:1.0.11"
+base_image: "discourse/base:1.0.15"
 
 update_pups: false
 
@@ -28,23 +28,18 @@ hooks:
     - exec: cd /var/www && git clone --depth 1 https://github.com/SamSaffron/message_bus.git
     - exec:
         cmd:
-          - gem install unicorn
+          - gem install puma
           - 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
+       path: /etc/service/puma/run
        chmod: "+x"
        contents: |
          #!/bin/bash
          exec 2>&1
          # redis
          cd $home/examples/chat
-         exec sudo -E -u chat LD_PRELOAD=/usr/lib/libjemalloc.so.1 unicorn -p 8080 -E production
+         exec sudo -E -u chat LD_PRELOAD=/usr/lib/libjemalloc.so.1 puma -p 8080 -e production
     - exec: rm /etc/nginx/sites-enabled/default
     - replace:
         filename: /etc/nginx/nginx.conf
@@ -63,15 +58,32 @@ hooks:
             gzip_min_length 1000;
             server_name chat.samsaffron.com;
             keepalive_timeout 65;
+
+            location /message-bus/ {
+              proxy_set_header Host $http_host;
+              proxy_set_header X-Real-IP $remote_addr;
+              proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+              proxy_set_header X-Forwarded-Proto http;
+              proxy_http_version 1.1;
+              proxy_buffering off;
+              proxy_pass http://chat;
+              break;
+            }
+
+
             location / {
               try_files $uri @chat;
+              break;
             }
-            location @chat{
+
+            location @chat {
               proxy_set_header Host $http_host;
               proxy_set_header X-Real-IP $remote_addr;
               proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
               proxy_set_header X-Forwarded-Proto http;
+              proxy_http_version 1.1;
               proxy_pass http://chat;
+              break;
             }
           }
     - file:

data/examples/chat/docker_container/update_chat

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-result=`cd /root/logster && git pull | grep "Already up-to-date"`
+result=`cd /root/message_bus && git pull | grep "Already up-to-date"`
 
 if [ -z "$result" ]; then
    echo "updating..."
-   cd /var/docker && ./launcher bootstrap logster && ./launcher destroy logster && ./launcher start logster
+   cd /var/docker && ./launcher rebuild chat --skip-prereqs
 fi
 

data/lib/message_bus.rb

@@ -4,7 +4,6 @@ require "message_bus/version"
 require "message_bus/message"
 require "message_bus/client"
 require "message_bus/connection_manager"
-require "message_bus/message_handler"
 require "message_bus/diagnostics"
 require "message_bus/rack/middleware"
 require "message_bus/rack/diagnostics"
@@ -51,6 +50,16 @@ module MessageBus::Implementation
     return @logger if @logger
     require 'logger'
     @logger = Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+    @logger
+  end
+
+  def chunked_encoding_enabled?
+    @chunked_encoding_enabled == false ? false : true
+  end
+
+  def chunked_encoding_enabled=(val)
+    @chunked_encoding_enabled = val
   end
 
   def long_polling_enabled?
@@ -143,18 +152,6 @@ module MessageBus::Implementation
     @extra_response_headers_lookup
   end
 
-  def client_filter(channel, &blk)
-    @client_filters ||= {}
-    @client_filters[channel] = blk if blk
-    @client_filters[channel]
-  end
-
-  def around_client_batch(channel, &blk)
-    @around_client_batches ||= {}
-    @around_client_batches[channel] = blk if blk
-    @around_client_batches[channel]
-  end
-
   def on_connect(&blk)
     @on_connect = blk if blk
     @on_connect