sse-rails-engine 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00fbf3e9401876a9e5bc1fbb3aef50447f220975
-  data.tar.gz: c4cdf90290eaddd8f28023d39b7366d3e5501cf5
+  metadata.gz: 2f447d929f60a969aedc1b5e1dcc666654daad75
+  data.tar.gz: 0b13bcf75030e96034da7be4b6a692ee98bf5b40
 SHA512:
-  metadata.gz: eae8e419e6b9a5d3a21895be58cad4532f71a734a3eee992194c031608a4bfff6d7a4fc6f6d3d49d380dd5d569a831a95ff7517e39192aedcd8565258505b882
-  data.tar.gz: ad0b22604ff57413016c1767c03dfaf8428b92913f42be44d2ef1e16b70c6b5937488b04a718eab5983bdae8ebfaf96f1cd68cbb49082cc80b2b34785aa80626
+  metadata.gz: 071ca673108b4d6c1e29e4818f4dff978f65dd430dd25e282862351529c9ba985c223a922cabd57f301e012ef6f2550a36adedf72d3cda9fdd5d19ceda397f1b
+  data.tar.gz: 5435274799d1c6ba93579a40a328aa42821d5ec012afbe5021a1590c6806dcf3904ff3f6e3bf1b13888a47f333cce9405884196ab5923ebc612bba682fac4bd2

data/README.md

@@ -0,0 +1,50 @@
+[![Build Status](https://travis-ci.org/henders/sse-rails-engine.svg?branch=master)](https://travis-ci.org/henders/sse-rails-engine)
+[![Code Climate](https://codeclimate.com/github/henders/sse-rails-engine/badges/gpa.svg)](https://codeclimate.com/github/henders/sse-rails-engine)
+[![Test Coverage](https://codeclimate.com/github/henders/sse-rails-engine/badges/coverage.svg)](https://codeclimate.com/github/henders/sse-rails-engine)
+[![Gem Version](https://badge.fury.io/rb/sse-rails-engine.svg)](http://badge.fury.io/rb/sse-rails-engine)
+
+This engine is designed to allow Server-Sent Events to be broadcast to all listeners from anywhere
+in your Rails app.
+At the moment it only works with Thread based Rack servers like Puma, Thin, Reel, ...
+
+Plans are to hook it up to Redis if you need to use process-based servers like Unicorn.
+
+This has been mostly tested with Ruby v2.2.1 and Rails v4.2.1 + Puma.
+
+This uses the Rack socket hijacking functionality to avoid having to occupy a thread per connection. Now
+only 1 extra thread in your app is required.
+
+# Installation
+```
+gem 'sse-rails-engine'
+```
+
+# Usage
+
+Mount the engine in your ```config/routes.rb```:
+```
+Rails.application.routes.draw do
+  mount SseRailsEngine::Engine, at: '/sse'
+end
+```
+
+To use, initialize the connection on the client side, so add the following javascript:
+```
+$(document).ready(function () {
+  var source = new EventSource('/sse');
+
+  source.addEventListener('test', function(e) {
+    // Do something
+  }, true);
+});
+
+```
+
+Then you can send an event from anywhere in your app:
+```
+SseRailsEngine.send_event('test', { foo: 'bar' })
+```
+
+# License
+
+MIT - Have at it! :)

data/app/controllers/sse_rails_engine/sse_controller.rb

@@ -2,11 +2,9 @@ require_dependency "sse_rails_engine/application_controller"
 
 module SseRailsEngine
   class SseController < ApplicationController
-    include ActionController::Live
-
     def connect
+      raise 'This Rack server does not support hijacking, ensure you are using >v1.5 of Rack' unless request.env['rack.hijack?']
       SseRailsEngine.manager.register(response)
-      SseRailsEngine.wait_for_disconnect(response)
       render json: {}
     end
   end

data/lib/sse-rails-engine.rb

@@ -2,24 +2,14 @@ require 'sse_rails_engine/engine'
 require 'sse_rails_engine/manager'
 
 module SseRailsEngine
-  mattr_accessor :disconnect_wait_time
   mattr_accessor :heartbeat_interval
 
-  @@disconnect_wait_time = 3.seconds
   @@heartbeat_interval = 5.seconds
 
   def self.manager
     @manager ||= Manager.new
   end
 
-  def self.wait_for_disconnect(response)
-    loop do
-      sleep disconnect_wait_time
-      break unless manager.registered?(response)
-    end
-    true
-  end
-
   def self.send_event(name, data)
     manager.send_event(name, data)
   end

data/lib/sse_rails_engine/manager.rb

@@ -9,24 +9,10 @@ module SseRailsEngine
     end
 
     def register(response)
-      ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord)
       response.headers['Content-Type'] = 'text/event-stream'
       response.headers['Cache-Control'] = 'no-cache'
-      @mutex.synchronize do
-        @connections[response.stream] = ActionController::Live::SSE.new(response.stream)
-      end
-    end
-
-    def registered?(response)
-      @mutex.synchronize do
-        @connections[response.stream] ? true : false
-      end
-    end
-
-    def unregister(response)
-      @mutex.synchronize do
-        close_connection(response.stream)
-      end
+      # Perform partial hijack of socket (http://old.blog.phusion.nl/2013/01/23/the-new-rack-socket-hijacking-api/)
+      response.headers['rack.hijack'] = ->(io) { SseRailsEngine.manager.open_connection(io) }
     end
 
     def send_event(name, data)
@@ -34,33 +20,37 @@ module SseRailsEngine
         @connections.dup.each do |stream, sse|
           begin
             sse.write(data, event: name)
-          rescue ActionController::Live::ClientDisconnected
+          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}"
+            Rails.logger.error "Failed to send event to SSE: #{stream} (#{name}, #{data} - #{ex.message} (#{ex.class}"
           end
         end
       end
     end
 
+    def open_connection(io)
+      Rails.logger.debug "New SSE Client connected: #{io}"
+      @mutex.synchronize do
+        @connections[io] = ActionController::Live::SSE.new(io)
+      end
+    end
+
     private
 
     def close_connection(stream)
       return if @connections[stream].nil?
       @connections[stream].close
       @connections.delete(stream)
-      stream.close unless stream.closed?
-    end
-
-    def heartbeat
-      send_event('heartbeat', '')
     end
 
     def start_heartbeats
+      Rails.logger.debug 'Starting SSE heartbeat thread!!!!!'
       Thread.new do
         loop do
           sleep SseRailsEngine.heartbeat_interval
-          heartbeat
+          send_event('heartbeat', '')
         end
       end
     end

data/lib/sse_rails_engine/version.rb

@@ -1,3 +1,3 @@
 module SseRailsEngine
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/controllers/sse_rails_engine/sse_controller_test.rb

@@ -4,18 +4,19 @@ describe SseRailsEngine::SseController do
   before do
     SseRailsEngine.instance_variable_set(:@manager, nil)
     @routes = SseRailsEngine::Engine.routes
+    request.env['rack.hijack?'] = 1
   end
 
   it 'registers new connections' do
-    SseRailsEngine.expects(:wait_for_disconnect).returns(true)
     get :connect
     assert_response :success
+    response.headers['rack.hijack'].call(response.stream)
     SseRailsEngine.manager.connections.size.must_equal 1
   end
 
   it 'sends event to connection' do
-    SseRailsEngine.expects(:wait_for_disconnect).returns(true)
     get :connect
+    response.headers['rack.hijack'].call(response.stream)
     SseRailsEngine.manager.connections.size.must_equal 1
     ActionController::Live::SSE.any_instance.expects(:write).with('bar', event: 'foo').once
     SseRailsEngine.send_event('foo', 'bar')

data/test/dummy/log/test.log

@@ -355,3 +355,157 @@ SseRailsEngine::SseController: test_0002_sends event to connection
 ------------------------------------------------------------------
 Processing by SseRailsEngine::SseController#connect as HTML
 Completed 200 OK in 0ms (Views: 0.1ms)
+Starting SSE heartbeat thread!!!!!
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0002_sends event to connection
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Completed 500 Internal Server Error in 0ms
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Completed 500 Internal Server Error in 0ms
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fc3b3512498>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f88b3ad3a20>
+SSE Client disconnected: #<StringIO:0x007f88b3ad3a20>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fb040de4ed0>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f8efcf18b68>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fc1ca020358>
+New SSE Client connected: #<StringIO:0x007fc1c9dea750>
+New SSE Client connected: #<StringIO:0x007fc1c9dba9d8>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f8e3b1e31d0>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f8e3b1b3c28>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f8e3b143248>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f8e3b130c60>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fd622d27378>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fd622d04648>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fd622cd4da8>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fd622c94960>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fd1c25a9560>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f840cd439f0>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f7feb5be3a8>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f7feb576288>
+SSE Client disconnected: #<StringIO:0x007f7feb576288>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f7feb5279d0>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f7feb506b90>
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Completed 500 Internal Server Error in 0ms
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.2ms)
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.1ms)
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.2ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007ff07459b8b8>
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.2ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007fd6c12fbf30>
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.2ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007fb813d73020>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f93e9fd9e20>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f93e9fd32c8>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f93e9fd11d0>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007f93e9fc9818>
+SSE Client disconnected: #<StringIO:0x007f93e9fc9818>
+Starting SSE heartbeat thread!!!!!
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0002_sends event to connection
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.1ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007f93e9f99d48>
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.1ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007f93e9f88700>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fc84d982f48>
+Starting SSE heartbeat thread!!!!!
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fc84ca5a1d8>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fc84d97ba40>
+Starting SSE heartbeat thread!!!!!
+New SSE Client connected: #<StringIO:0x007fc84d97a4d8>
+SSE Client disconnected: #<StringIO:0x007fc84d97a4d8>
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0001_registers new connections
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.1ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007fc84d909698>
+------------------------------------------------------------------
+SseRailsEngine::SseController: test_0002_sends event to connection
+------------------------------------------------------------------
+Processing by SseRailsEngine::SseController#connect as HTML
+Starting SSE heartbeat thread!!!!!
+Completed 200 OK in 0ms (Views: 0.1ms)
+New SSE Client connected: #<ActionDispatch::Response::Buffer:0x007fc84ca50b38>

data/test/lib/sse_rails_engine/manager_test.rb

@@ -2,38 +2,41 @@ require_relative '../../test_helper'
 
 describe SseRailsEngine::Manager do
   let(:response) { Hashie::Mash.new(stream: StringIO.new, headers: {}) }
-  let(:manager) { SseRailsEngine.manager }
+  let(:manager) { SseRailsEngine::manager }
 
-  it 'should only instantiate 1 manager' do
-    manager.must_equal SseRailsEngine.manager
-  end
+  before { SseRailsEngine.instance_variable_set(:@manager, nil) }
 
   it 'registers new response streams' do
+    manager.connections.size.must_equal 0
     manager.register(response)
-    manager.registered?(response).must_equal true
+    response.headers['rack.hijack'].call(response.stream)
+    manager.connections.size.must_equal 1
   end
 
   it 'does not register new response stream' do
-    manager.registered?(response).must_equal false
+    manager.connections.size.must_equal 0
   end
 
   it 'closes connection when client disconnects' do
-    ActionController::Live::SSE.any_instance.stubs(:write).raises(ActionController::Live::ClientDisconnected)
+    ActionController::Live::SSE.any_instance.stubs(:write).raises(IOError)
 
     manager.register(response)
-    manager.registered?(response).must_equal true
+    response.headers['rack.hijack'].call(response.stream)
+    manager.connections.size.must_equal 1
     manager.send_event('foo', 'bar')
-    manager.registered?(response).must_equal false
+    manager.connections.size.must_equal 0
   end
 
   it 'writes string event to stream' do
     manager.register(response)
+    response.headers['rack.hijack'].call(response.stream)
     manager.send_event('foo', 'bar')
     response.stream.string.must_equal "event: foo\ndata: bar\n\n"
   end
 
   it 'writes event object to stream' do
     manager.register(response)
+    response.headers['rack.hijack'].call(response.stream)
     manager.send_event('foo', { a: 123, 'b' => 'abc', c: { foo: 'bar' } })
     response.stream.string.must_equal "event: foo\ndata: {\"a\":123,\"b\":\"abc\",\"c\":{\"foo\":\"bar\"}}\n\n"
   end

data/test/lib/sse_rails_engine_test.rb

@@ -2,11 +2,10 @@ require_relative '../test_helper'
 
 describe SseRailsEngine do
   before do
-    SseRailsEngine.disconnect_wait_time = 3.seconds
     SseRailsEngine.heartbeat_interval = 5.seconds
   end
 
-  it "should be a module" do
+  it 'should be a module' do
     assert_kind_of Module, SseRailsEngine
   end
 
@@ -15,36 +14,19 @@ describe SseRailsEngine do
   end
 
   it 'should have default config values' do
-    SseRailsEngine.disconnect_wait_time.must_equal 3.seconds
     SseRailsEngine.heartbeat_interval.must_equal 5.seconds
   end
 
   it 'allows usage of setup block' do
     SseRailsEngine.setup do |config|
-      config.disconnect_wait_time.must_equal 3.seconds
       config.heartbeat_interval.must_equal 5.seconds
     end
   end
 
   it 'allows config override' do
     SseRailsEngine.setup do |config|
-      config.disconnect_wait_time = 99.hours
       config.heartbeat_interval = 1.minute
     end
-    SseRailsEngine.disconnect_wait_time.must_equal 99.hours
     SseRailsEngine.heartbeat_interval.must_equal 1.minute
   end
-
-  it 'disconnects without a registry' do
-    response = Hashie::Mash.new(stream: StringIO.new, headers: {})
-    SseRailsEngine.disconnect_wait_time = 0.1
-    SseRailsEngine.wait_for_disconnect(response).must_equal true
-  end
-
-  it 'disconnects after registry deletion' do
-    SseRailsEngine.manager.expects(:registered?).times(3).returns(true, true, false)
-    response = Hashie::Mash.new(stream: StringIO.new, headers: {})
-    SseRailsEngine.disconnect_wait_time = 0.1
-    SseRailsEngine.wait_for_disconnect(response).must_equal true
-  end
 end

data/test/test_helper.rb

@@ -1,14 +1,14 @@
 # Configure Rails Environment
 ENV['RAILS_ENV'] = 'test'
 
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
+
 require File.expand_path('../../test/dummy/config/environment.rb',  __FILE__)
 require 'rails/test_help'
 require 'minitest/rails'
 require 'mocha/mini_test'
 require 'hashie'
-require 'codeclimate-test-reporter'
-
-CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.
@@ -22,6 +22,3 @@ if ActiveSupport::TestCase.respond_to?(:fixture_path=)
   ActiveSupport::TestCase.fixture_path = File.expand_path('../fixtures', __FILE__)
   ActiveSupport::TestCase.fixtures :all
 end
-
-class ActiveSupport::TestCase
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sse-rails-engine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shane Hender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,66 +28,66 @@ dependencies:
   name: minitest-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides SSE connection tracking and broadcasting of events from anywhere
-  in Rails app
+description: See the README.md at https://github.com/henders/sse-rails-engine
 email:
-- shender@zendesk.com
+- henders@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - Rakefile
 - app/controllers/sse_rails_engine/application_controller.rb
 - app/controllers/sse_rails_engine/sse_controller.rb