sse-rails-engine 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 215385adafbeb44e44ff64603e5e4777206f100a
-  data.tar.gz: 18f56fa8185eaa46cc67ef115d0123ee895d3cd7
+  metadata.gz: 0bab1f8bb9471deacf8e724b2763a6f21c20f350
+  data.tar.gz: ea78faac1bb777ce07993f90043358edd9b1a57d
 SHA512:
-  metadata.gz: 57a701b21132ca315e60e79c93527eb1d35d4276b45f2c79059b3209909e360f43fdd9e699f1ac94fd2cfadb252c2c335b1f837c81fbd98661705df26e12456f
-  data.tar.gz: 5651157dba6581bb886589cb7f9b48cc116982c54d05427ae46e85d85eb42b0915ac1ac8b7a854588722fcce14d38690ab379aac139c16029e55b4cc6729a7bd
+  metadata.gz: 4d67d7f168f7d0cbd71ecf18f4311e48c56e5c0c7fa1e7303076321da994e0049a2a2472be12d15a31d395309119a032a061b88cbb91a55c2787535ff69bc518
+  data.tar.gz: f9a240475088861184a371d25441371f4a35bc7c606222bae0ddac50027746556f9661ce9f21fc5ca4008200f8471912d9e0a3a69a527aa3f0c90f0f5b72343d

data/README.md

@@ -47,6 +47,38 @@ Then you can send an event from anywhere in your app:
 SseRailsEngine.send_event('test', { foo: 'bar' })
 ```
 
+# Channels
+
+It supports the idea of channels so that if pages don't need to receive certain events, then you won't waste
+the bandwidth or processing on the server:
+
+Clientside:
+```
+$(document).ready(function () {
+  var source = new EventSource('/sse?channels=foo,bar,baz');
+
+  source.addEventListener('other', function(e) {
+    // Will never be called
+  }, true);
+
+  source.addEventListener('foo', function(e) {
+    // Do stuff
+  }, true);
+});
+
+```
+Serverside:
+```
+SseRailsEngine.send_event('foo', '') # Sent to the client
+SseRailsEngine.send_event('other', '') # Won't be sent to the client
+```
+
+# Notes
+
+## Nginx
+You may need to configure nginx to not buffer or cache SSE connections:
+http://stackoverflow.com/questions/13672743/eventsource-server-sent-events-through-nginx
+
 # License
 
 MIT - Have at it! :)

data/lib/sse-rails-engine.rb

@@ -1,4 +1,5 @@
 require 'sse_rails_engine/engine'
+require 'sse_rails_engine/connection'
 require 'sse_rails_engine/manager'
 
 module SseRailsEngine

data/lib/sse_rails_engine/connection.rb

@@ -0,0 +1,36 @@
+module SseRailsEngine
+  class Connection
+    attr_accessor :stream
+
+    SSE_HEADER = ["HTTP/1.1 200 OK\r\n",
+                  "Content-Type: text/event-stream\r\n",
+                  "Cache-Control: no-cache, no-store\r\n",
+                  "Connection: close\r\n",
+                  "\r\n"].join.freeze
+
+    def initialize(io, env)
+      @socket = io
+      @socket.write SSE_HEADER
+      @socket.flush
+      @stream = ActionController::Live::SSE.new(io)
+      @channels = requested_channels(env)
+    end
+
+    def write(name, data)
+      return if filtered?(name)
+      @stream.write(data, event: name)
+      @socket.flush
+    end
+
+    private
+
+    def filtered?(channel)
+      return false if @channels.empty? || channel == Manager::HEARTBEAT_EVENT
+      !@channels.include? channel
+    end
+
+    def requested_channels(env)
+      Rack::Utils.parse_query(env['QUERY_STRING']).fetch('channels', []).split(',').flatten
+    end
+  end
+end

data/lib/sse_rails_engine/manager.rb

@@ -16,11 +16,7 @@ module SseRailsEngine
 
     attr_reader :connections, :heartbeat_thread
 
-    SSE_HEADER = ["HTTP/1.1 200 OK\r\n",
-                  "Content-Type: text/event-stream\r\n",
-                  "Cache-Control: no-cache, no-store\r\n",
-                  "Connection: close\r\n",
-                  "\r\n"].join.freeze
+    HEARTBEAT_EVENT = 'heartbeat'
 
     def initialize
       @mutex = Mutex.new
@@ -33,41 +29,34 @@ module SseRailsEngine
         env['rack.hijack'].call
         socket = env['rack.hijack_io']
         # Perform full hijack of socket (http://old.blog.phusion.nl/2013/01/23/the-new-rack-socket-hijacking-api/)
-        SseRailsEngine.manager.open_connection(socket)
+        open_connection(socket, env)
       else
         fail RackHijackUnsupported, 'This Rack server does not support hijacking, ensure you are using >= v1.5 of Rack'
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def send_event(name, data)
+    def send_event(name, data = '')
       @mutex.synchronize do
-        @connections.dup.each do |stream, sse|
+        @connections.dup.each do |stream, connection|
           begin
-            sse.write(data, event: name)
-            stream.flush
-          rescue IOError, Errno::EPIPE, Errno::ETIMEDOUT
-            Rails.logger.debug "SSE Client disconnected: #{stream}"
-            close_connection(stream)
-          rescue => ex
-            Rails.logger.error "Failed to send event to SSE: #{stream} (#{name}, #{data} - #{ex.message} (#{ex.class}"
+            connection.write(name, data)
+          rescue IOError, Errno::EPIPE, Errno::ETIMEDOUT => ex
+            Rails.logger.debug "SSE Client disconnected: #{stream} - #{ex.message}"
             close_connection(stream)
           end
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
-    def open_connection(io)
+    def open_connection(io, env)
       Rails.logger.debug "New SSE Client connected: #{io}"
-      io.write(SSE_HEADER)
       @mutex.synchronize do
-        @connections[io] = ActionController::Live::SSE.new(io)
+        @connections[io] = Connection.new(io, env)
       end
     end
 
     def call(env)
-      SseRailsEngine.manager.register(env)
+      register(env)
       [-1, {}, []]
     end
 
@@ -75,7 +64,7 @@ module SseRailsEngine
 
     def close_connection(stream)
       return if @connections[stream].nil?
-      @connections[stream].close
+      @connections[stream].stream.close
       @connections.delete(stream)
     end
 
@@ -84,7 +73,7 @@ module SseRailsEngine
       @heartbeat_thread = Thread.new do
         loop do
           sleep SseRailsEngine.heartbeat_interval
-          send_event('heartbeat', '')
+          send_event(HEARTBEAT_EVENT)
         end
       end
     end

data/lib/sse_rails_engine/version.rb

@@ -1,3 +1,3 @@
 module SseRailsEngine
-  VERSION = '1.2.2'
+  VERSION = '1.3.0'
 end

data/test/dummy/log/test.log

@@ -145,3 +145,422 @@ New SSE Client connected: #<StringIO:0x007ff76cdb0838>
 Starting SSE heartbeat thread!
 New SSE Client connected: #<StringIO:0x007ff76cda0118>
 Failed to send event to SSE: #<StringIO:0x007ff76cda0118> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8ae344fe88>
+New SSE Client connected: #<StringIO:0x007f8ae345c5c0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f98fbe791b8>
+New SSE Client connected: #<StringIO:0x007f98fbe797f8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa5842f1f80>
+New SSE Client connected: #<StringIO:0x007fa5842f2480>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffe6c069308>
+New SSE Client connected: #<StringIO:0x007ffe6c06a618>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc85471538>
+New SSE Client connected: #<StringIO:0x007ffc85471e48>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fe576fe1330>
+New SSE Client connected: #<StringIO:0x007fe576fe1d30>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f80c45c2cd0>
+New SSE Client connected: #<StringIO:0x007f80c45c36a8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb0cde30c80>
+New SSE Client connected: #<StringIO:0x007fb0cde314f0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb95c5c9758>
+New SSE Client connected: #<StringIO:0x007fb95c5c88a8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb3c8f8e5c0>
+New SSE Client connected: #<StringIO:0x007fb3c8f8ed90>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f95fcc63ce0>
+New SSE Client connected: #<StringIO:0x007f95fcc70670>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc68bd72090>
+Failed to send event to SSE: #<StringIO:0x007fc68bd72090> (foo, bar - undefined method `channels' for #<Hash:0x007fc68bd70e98> (NoMethodError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc68bd696c0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc68bd5a4e0>
+Failed to send event to SSE: #<StringIO:0x007fc68bd5a4e0> (foo, bar - undefined method `channels' for #<Hash:0x007fc68bd59e00> (NoMethodError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc68bd2b028>
+Failed to send event to SSE: #<StringIO:0x007fc68bd2b028> (foo, bar - undefined method `channels' for #<Hash:0x007fc68bd2a7e0> (NoMethodError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc68bd12f00>
+New SSE Client connected: #<StringIO:0x007fc68bd13518>
+Starting SSE heartbeat thread!
+ENV: 
+New SSE Client connected: #<StringIO:0x007fc68bd027b8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc68bd001e8>
+Failed to send event to SSE: #<StringIO:0x007fc68bd001e8> (foo, {:a=>123, "b"=>"abc", :c=>{:foo=>"bar"}} - undefined method `channels' for #<Hash:0x007fc68bcfbd00> (NoMethodError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8f6e5818f8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f9abb84bb58>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fe4a5373890>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcffa778590>
+New SSE Client connected: #<StringIO:0x007fcffa778dd8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff97c572ec0>
+New SSE Client connected: #<StringIO:0x007ff97c573690>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5850f9068>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5850f1408>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5850d2f30>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5850aa648>
+New SSE Client connected: #<StringIO:0x007fc5850aaaf8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5850a1930>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5850912b0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc585072658>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8d6ec10c70>
+New SSE Client connected: #<StringIO:0x007f8d6ec11468>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f91c60c1d68>
+New SSE Client connected: #<StringIO:0x007f91c60c2560>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb0829b5bd8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb0829a64f8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb082955580>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb082917988>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb0828a9140>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb082861cf0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb082841c98>
+New SSE Client connected: #<StringIO:0x007fb082842508>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd343f735f0>
+New SSE Client connected: #<StringIO:0x007fd343f73dc0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fe58c1a14d0>
+New SSE Client connected: #<StringIO:0x007fe58c1a1b10>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff49e6d3f90>
+New SSE Client connected: #<StringIO:0x007ff49e6e0e20>
+SSE Client disconnected: #<StringIO:0x007ff49e6e0e20> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f9b99299f28>
+New SSE Client connected: #<StringIO:0x007f9b9929a658>
+SSE Client disconnected: #<StringIO:0x007f9b99299f28> - undefined local variable or method `channel' for #<SseRailsEngine::Connection:0x007f9b99299b18>
+SSE Client disconnected: #<StringIO:0x007f9b9929a658> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa17455ad80>
+New SSE Client connected: #<StringIO:0x007fa17455b5f0>
+SSE Client disconnected: #<StringIO:0x007fa17455b5f0> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f9b5d5aa500>
+New SSE Client connected: #<StringIO:0x007f9b5d5aad20>
+SSE Client disconnected: #<StringIO:0x007f9b5d5aad20> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f908134f878>
+New SSE Client connected: #<StringIO:0x007f90813740b0>
+SSE Client disconnected: #<StringIO:0x007f90813740b0> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8666022c38>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8665f70ee8>
+SSE Client disconnected: #<StringIO:0x007f8665f70ee8> - RuntimeError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8665f512f0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8665f01200>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8665ee2a08>
+New SSE Client connected: #<StringIO:0x007f8665ee31d8>
+SSE Client disconnected: #<StringIO:0x007f8665ee31d8> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8665ea0b80>
+SSE Client disconnected: #<StringIO:0x007f8665ea0b80> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f8665e81348>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbdb9b360>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbdb7abd8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbdb387d8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbdb0bfa8>
+SSE Client disconnected: #<StringIO:0x007fdbbdb0bfa8> - IOError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbdadad40>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbdaaa640>
+SSE Client disconnected: #<StringIO:0x007fdbbdaaa640> - RuntimeError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdbbda6bdf0>
+New SSE Client connected: #<StringIO:0x007fdbbda784d8>
+SSE Client disconnected: #<StringIO:0x007fdbbda784d8> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb07d2394b8>
+New SSE Client connected: #<StringIO:0x007fb07d23a430>
+SSE Client disconnected: #<StringIO:0x007fb07d23a430> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fb07d1ea408>
+New SSE Client connected: #<StringIO:0x007fb07d1eab10>
+SSE Client disconnected: #<StringIO:0x007fb07d1eab10> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd5864badf8>
+New SSE Client connected: #<StringIO:0x007fd5864bb410>
+SSE Client disconnected: #<StringIO:0x007fd5864bb410> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd58647a6e0>
+New SSE Client connected: #<StringIO:0x007fd58647ae38>
+SSE Client disconnected: #<StringIO:0x007fd58647ae38> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcecbe52a30>
+SSE Client disconnected: #<StringIO:0x007fcecbe52a30> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcecbdf28d8>
+New SSE Client connected: #<StringIO:0x007fcecbdf3120>
+SSE Client disconnected: #<StringIO:0x007fcecbdf3120> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa16ca24c38>
+SSE Client disconnected: #<StringIO:0x007fa16ca24c38> - uninitialized constant SseRailsEngine::Connection::HEARTBEAT_EVENT
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fca446a1588>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff605c1a8d8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9df80218>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9df53f60>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9df41590>
+New SSE Client connected: #<StringIO:0x007ffc9df41d10>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9deb9cd0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9de88c48>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9de5aa00>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9de19e38>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ffc9ddf84e0>
+SSE Client disconnected: #<StringIO:0x007ffc9ddf84e0> - IOError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f9fa485bb50>
+New SSE Client connected: #<StringIO:0x007f9fa48682d8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb8983d8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb843450>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb8113d8>
+New SSE Client connected: #<StringIO:0x007fcfbb8125d0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb7c8ac0>
+SSE Client disconnected: #<StringIO:0x007fcfbb7c8ac0> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb7a8978>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb759990>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb73b710>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb71a538>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcfbb6f9158>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cdaa4e0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cd88bd8>
+SSE Client disconnected: #<StringIO:0x007f807cd88bd8> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cd69300>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cd4af18>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cd38d90>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cd19418>
+New SSE Client connected: #<StringIO:0x007f807cd19fa8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807ccebbf8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807ccaaa68>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f807cc8a560>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee75441978>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee753dbf88>
+SSE Client disconnected: #<StringIO:0x007fee753dbf88> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee753bac20>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee7539ada8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee7537abe8>
+New SSE Client connected: #<StringIO:0x007fee7537b430>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee7535b2c0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee753496b0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee75328640>
+SSE Client disconnected: #<StringIO:0x007fee75328640> - IOError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fee752ab578>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff5753a8f00>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff57538ae38>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff575370fd8>
+New SSE Client connected: #<StringIO:0x007ff575371500>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff575352740>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff57534b760>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff575343b50>
+SSE Client disconnected: #<StringIO:0x007ff575343b50> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff57533b568>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff5753380e8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff57532aec0>
+SSE Client disconnected: #<StringIO:0x007ff57532aec0> - IOError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdfb438>
+SSE Client disconnected: #<StringIO:0x007f864bdfb438> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdfa5d8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdeba60>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdd94f0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdd12a0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdc9488>
+SSE Client disconnected: #<StringIO:0x007f864bdc9488> - IOError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdc0680>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdb9a88>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f864bdb27b0>
+New SSE Client connected: #<StringIO:0x007f864bdb2f58>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a921c10>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a91ae10>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a90bfa0>
+SSE Client disconnected: #<StringIO:0x007fdd7a90bfa0> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a9087b0>
+New SSE Client connected: #<StringIO:0x007fdd7a908e68>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a9019b0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a8fa778>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a8f8270>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a8daf18>
+SSE Client disconnected: #<StringIO:0x007fdd7a8daf18> - IOError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fdd7a8d27c8>

data/test/lib/sse_rails_engine/manager_test.rb

@@ -2,11 +2,8 @@ require_relative '../../test_helper'
 
 describe SseRailsEngine::Manager do
   let(:manager) { SseRailsEngine.manager }
-  let(:env) do
-    Hashie::Mash.new('rack.hijack?' => true,
-                     'rack.hijack' => ->() {},
-                     'rack.hijack_io' => StringIO.new)
-  end
+  let(:env1) { Hashie::Mash.new('rack.hijack?' => true, 'rack.hijack' => ->() {}, 'rack.hijack_io' => StringIO.new) }
+  let(:env2) { Hashie::Mash.new('rack.hijack?' => true, 'rack.hijack' => ->() {}, 'rack.hijack_io' => StringIO.new) }
 
   before do
     SseRailsEngine.instance_variable_set(:@manager, nil)
@@ -14,13 +11,13 @@ describe SseRailsEngine::Manager do
   end
 
   it 'ensures rack supports hijacking' do
-    env['rack.hijack'] = nil
-    assert_raises(SseRailsEngine::Manager::RackHijackUnsupported) { manager.register(env) }
+    env1['rack.hijack'] = nil
+    assert_raises(SseRailsEngine::Manager::RackHijackUnsupported) { manager.register(env1) }
   end
 
   it 'registers new response streams' do
     manager.connections.size.must_equal 0
-    manager.register(env)
+    manager.register(env1)
     manager.connections.size.must_equal 1
   end
 
@@ -31,36 +28,38 @@ describe SseRailsEngine::Manager do
   it 'closes connection when client disconnects' do
     ActionController::Live::SSE.any_instance.stubs(:write).raises(IOError)
 
-    manager.register(env)
+    manager.register(env1)
     manager.connections.size.must_equal 1
     manager.send_event('foo', 'bar')
     manager.connections.size.must_equal 0
   end
 
   it 'closes connection when failed sending event to client' do
-    ActionController::Live::SSE.any_instance.stubs(:write).raises(RuntimeError)
+    ActionController::Live::SSE.any_instance.stubs(:write).raises(IOError)
 
-    manager.register(env)
+    manager.register(env1)
     manager.connections.size.must_equal 1
     manager.send_event('foo', 'bar')
     manager.connections.size.must_equal 0
   end
 
   it 'writes string event to stream' do
-    manager.register(env)
+    manager.register(env1)
     manager.send_event('foo', 'bar')
-    env['rack.hijack_io'].string.must_equal(SseRailsEngine::Manager::SSE_HEADER + "event: foo\ndata: bar\n\n")
+    env1['rack.hijack_io'].string.must_equal(SseRailsEngine::Connection::SSE_HEADER + "event: foo\ndata: bar\n\n")
   end
 
   it 'writes event object to stream' do
-    manager.register(env)
+    manager.register(env1)
     manager.send_event('foo', a: 123, 'b' => 'abc', c: { foo: 'bar' })
-    env['rack.hijack_io'].string.must_equal(
-      SseRailsEngine::Manager::SSE_HEADER + "event: foo\ndata: {\"a\":123,\"b\":\"abc\",\"c\":{\"foo\":\"bar\"}}\n\n")
+    env1['rack.hijack_io'].string.must_equal(
+      SseRailsEngine::Connection::SSE_HEADER +
+      "event: foo\ndata: {\"a\":123,\"b\":\"abc\",\"c\":{\"foo\":\"bar\"}}\n\n"
+    )
   end
 
   it 'writes minimum headers to rack middleware' do
-    manager.call(env).must_equal [-1, {}, []]
+    manager.call(env1).must_equal [-1, {}, []]
   end
 
   it 'ensures heartbeat is sent' do
@@ -70,4 +69,31 @@ describe SseRailsEngine::Manager do
     SseRailsEngine::Manager.new
     sleep 0.2
   end
+
+  it 'sends events to connections that register for that channel' do
+    env1['QUERY_STRING'] = 'channels=foo,bar'
+    manager.register(env1)
+    manager.send_event('foo')
+    env1['rack.hijack_io'].string.must_equal(
+      SseRailsEngine::Connection::SSE_HEADER + "event: foo\ndata: \n\n", 'env1 should have received event')
+  end
+
+  it 'does not send events to clients that didnt register for them' do
+    env1['QUERY_STRING'] = 'channels=foo,bar'
+    manager.register(env1)
+    manager.send_event('test')
+    env1['rack.hijack_io'].string.must_equal(
+      SseRailsEngine::Connection::SSE_HEADER, 'env2 should not have received event')
+  end
+
+  it 'filters msgs depending on channels requested' do
+    env2['QUERY_STRING'] = 'channels=foo,bar'
+    manager.register(env1)
+    manager.register(env2)
+    manager.send_event('test')
+    env1['rack.hijack_io'].string.must_equal(
+      SseRailsEngine::Connection::SSE_HEADER + "event: test\ndata: \n\n", 'env1 should have received event')
+    env2['rack.hijack_io'].string.must_equal(
+      SseRailsEngine::Connection::SSE_HEADER, 'env2 should not have received event')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sse-rails-engine
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Shane Hender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 description: See the README.md at https://github.com/henders/sse-rails-engine
 email:
 - henders@gmail.com
@@ -107,6 +107,7 @@ files:
 - config/initializers/sse_rails_engine.rb
 - config/routes.rb
 - lib/sse-rails-engine.rb
+- lib/sse_rails_engine/connection.rb
 - lib/sse_rails_engine/engine.rb
 - lib/sse_rails_engine/manager.rb
 - lib/sse_rails_engine/version.rb