sse-rails-engine 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e920b7f5c24984ee2a13737addac7cc27a8649a
-  data.tar.gz: ed5350675bd43869264955774542192abf3d83a5
+  metadata.gz: 5ba7d9cea724ef6cd38b1ae06f4b0a037e575cee
+  data.tar.gz: 8aef607c6e1908f4a07571842e59667271d44da1
 SHA512:
-  metadata.gz: f7ec726a3b2d2a52ec5477d38516feb4b50c2d9375bb32b6420a87f50057230922b2f879f2fe1fec3af07671680d09964b0e5e04c381eea711e6ecf8410ee940
-  data.tar.gz: c1b5081cc1d244619563b441d6ecdb2f6f82712e4c1ff6e51e1d73b196a9204e5cd76a843635d0cf755a6faada48d349ccd3a8aa50d70d7801618417b6cc31de
+  metadata.gz: c433f71bb37b808669f96d6cddcb77c7547258329d5c3d40149a735375a807a3ae1a46534790a424b91d3631d4e8e72cbc5e172684f2955b24cbf18efbf84984
+  data.tar.gz: 7d7965dd774c11512ffc7d156ef52753b0c478a3759dd36486e64fcd1305cecbebe085c65443974ff6862ba8837a02f9b21b76917f957c732a87f76fe395b600

data/lib/sse_rails_engine/manager.rb

@@ -1,6 +1,8 @@
 module SseRailsEngine
   class Manager
-    attr_reader :connections
+    RackHijackUnsupported = Class.new RuntimeError
+
+    attr_reader :connections, :heartbeat_thread
 
     SSE_HEADER = ["HTTP/1.1 200 OK\r\n",
       "Content-Type: text/event-stream\r\n",
@@ -21,7 +23,7 @@ module SseRailsEngine
         # Perform full hijack of socket (http://old.blog.phusion.nl/2013/01/23/the-new-rack-socket-hijacking-api/)
         SseRailsEngine.manager.open_connection(socket)
       else
-        raise 'This Rack server does not support hijacking, ensure you are using >= v1.5 of Rack'
+        raise RackHijackUnsupported, 'This Rack server does not support hijacking, ensure you are using >= v1.5 of Rack'
       end
     end
 
@@ -65,7 +67,7 @@ module SseRailsEngine
 
     def start_heartbeats
       Rails.logger.debug 'Starting SSE heartbeat thread!'
-      Thread.new do
+      @heartbeat_thread = Thread.new do
         loop do
           sleep SseRailsEngine.heartbeat_interval
           send_event('heartbeat', '')

data/lib/sse_rails_engine/version.rb

@@ -1,3 +1,3 @@
 module SseRailsEngine
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/test/dummy/log/test.log

@@ -1,11 +1,73 @@
 Starting SSE heartbeat thread!
 Starting SSE heartbeat thread!
-New SSE Client connected: #<StringIO:0x007fa8041d31a8>
-SSE Client disconnected: #<StringIO:0x007fa8041d31a8>
 Starting SSE heartbeat thread!
-New SSE Client connected: #<StringIO:0x007fa8041d0020>
 Starting SSE heartbeat thread!
-New SSE Client connected: #<StringIO:0x007fa8041c9338>
 Starting SSE heartbeat thread!
 Starting SSE heartbeat thread!
-New SSE Client connected: #<StringIO:0x007fa8041c0850>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fc5cb2272a0>
+Failed to send event to SSE: #<StringIO:0x007fc5cb2272a0> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fe0c42c4190>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f97591563a8>
+SSE Client disconnected: #<StringIO:0x007f97591563a8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f975914ef18>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f97591474e8>
+Failed to send event to SSE: #<StringIO:0x007f97591474e8> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f975913dba0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f9759124f88>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007f975911ec50>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff3392c3a88>
+Failed to send event to SSE: #<StringIO:0x007ff3392c3a88> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff3392ba4b0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff3392aad08>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff339282bf0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff33927b4b8>
+SSE Client disconnected: #<StringIO:0x007ff33927b4b8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff339278948>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!

data/test/lib/sse_rails_engine/manager_test.rb

@@ -13,6 +13,11 @@ describe SseRailsEngine::Manager do
     SseRailsEngine::Manager.stubs(:start_heartbeats).returns(true)
   end
 
+  it 'ensures rack supports hijacking' do
+    env['rack.hijack'] = nil
+    assert_raises(SseRailsEngine::Manager::RackHijackUnsupported) { manager.register(env) }
+  end
+
   it 'registers new response streams' do
     manager.connections.size.must_equal 0
     manager.register(env)
@@ -32,6 +37,15 @@ describe SseRailsEngine::Manager do
     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)
+
+    manager.register(env)
+    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.send_event('foo', 'bar')
@@ -43,4 +57,16 @@ describe SseRailsEngine::Manager do
     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")
   end
+
+  it 'writes minimum headers to rack middleware' do
+    manager.call(env).must_equal [ -1, {}, []]
+  end
+
+  it 'ensures heartbeat is sent' do
+    SseRailsEngine.stubs(:heartbeat_interval).returns(0,5)
+    SseRailsEngine::Manager.unstub(:start_heartbeats)
+    SseRailsEngine::Manager.any_instance.expects(:send_event).once
+    manager = SseRailsEngine::Manager.new
+    sleep 0.2
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sse-rails-engine
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Shane Hender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails