websocket-rails 0.1.8 → 0.1.9

data/CHANGELOG.md

@@ -1,15 +1,28 @@
 # WebsocketRails Change Log
 
+## Version 0.1.9
+
+November 19 2012
+
+* Fix bug that crashed the server when receiving badly formed messages
+  through an open websocket. Fixes issue #27.
+
+* Add support for communication between multiple server instances and
+  background jobs. Solves scaling problems discussed in issue #21.
+
+* Fixed client_disconnected event firing twice - Thanks to
+  @nickdesaulniers
+
 ## Version 0.1.8
 
-July 18
+July 18 2012
 
 * Fix bug in Channel#trigger preventing the data from coming through
   properly.
 
 ## Version 0.1.7
 
-July 17
+July 17 2012
 
 * Fixed botched release of 0.1.6
 * Reorganized directory structure

data/Gemfile

@@ -3,11 +3,13 @@ source "http://rubygems.org"
 gemspec
 
 gem "rspec-rails"
+gem "therubyrhino"
+gem "therubyracer"
 gem "jasmine"
 gem "headless"
 gem "coffee-script"
 gem "thin"
-gem "eventmachine", ">= 1.0.0.beta.3"
+gem "eventmachine"
 gem "faye-websocket"
 gem "simplecov"
 gem "ruby_gntp"

data/lib/assets/javascripts/websocket_rails/websocket_connection.js.coffee

@@ -9,6 +9,7 @@ class WebSocketRails.WebSocketConnection
     @_conn           = new WebSocket(@url)
     @_conn.onmessage = @on_message
     @_conn.onclose   = @on_close
+    @_conn.onerror   = @on_error
 
   trigger: (event) =>
     if @dispatcher.state != 'connected'
@@ -24,6 +25,10 @@ class WebSocketRails.WebSocketConnection
     close_event = new WebSocketRails.Event(['connection_closed',{}])
     @dispatcher.dispatch close_event
 
+  on_error: (event) =>
+    error_event = new WebSocketRails.Event(['connection_error',event?.data])
+    @dispatcher.dispatch error_event
+
   flush_queue: =>
     for event in @message_queue
       @_conn.send event.serialize()

data/lib/websocket-rails.rb

@@ -3,24 +3,50 @@ require 'thin'
 
 module WebsocketRails
   mattr_accessor :app_root
-  
+
   def self.setup
     yield self
   end
-  
+
   def self.route_block=(routes)
     @event_routes = routes
   end
-  
+
   def self.route_block
     @event_routes
   end
-end
 
-LOG_LEVEL = :warn
+  def self.log_level
+    @log_level ||= :warn
+  end
+
+  def self.log_level=(level)
+    @log_level = level
+  end
+
+  attr_accessor :synchronize
+  module_function :synchronize, :synchronize=
+
+  def self.synchronize?
+    @synchronize == true
+  end
+
+  def self.redis_options
+    @redis_options ||= redis_defaults
+  end
+
+  def self.redis_options=(options = {})
+    @redis_options = redis_defaults.merge(options)
+  end
+
+  def self.redis_defaults
+    {:host => '127.0.0.1', :port => 6379}
+  end
+end
 
 require 'websocket_rails/engine'
 require 'websocket_rails/logging'
+require 'websocket_rails/synchronization'
 require 'websocket_rails/connection_manager'
 require 'websocket_rails/dispatcher'
 require 'websocket_rails/event'

data/lib/websocket_rails/channel.rb

@@ -1,6 +1,8 @@
 module WebsocketRails
   class Channel
 
+    include Logging
+
     attr_reader :name, :subscribers
 
     def initialize(channel_name)
@@ -10,30 +12,38 @@ module WebsocketRails
     end
 
     def subscribe(connection)
+      log "#{connection} subscribed to channel #{name}"
       @subscribers << connection
     end
 
-    def trigger(event_name,data={})
-      event_data    = {:data => data, :channel => name}
-      channel_event = Event.new event_name, event_data
-      send_data channel_event
+    def trigger(event_name,data={},options={})
+      options.merge! :channel => name
+      options[:data] = data
+
+      event = Event.new event_name, options
+
+      send_data event
     end
 
     def trigger_event(event)
       send_data event
     end
-    
+
     def make_private
       @private = true
     end
-    
+
     def is_private?
       @private
     end
-    
+
     private
 
     def send_data(event)
+      if WebsocketRails.synchronize? && event.server_token.nil?
+        Synchronization.publish event
+      end
+
       subscribers.each do |subscriber|
         subscriber.trigger event
       end

data/lib/websocket_rails/channel_manager.rb

@@ -17,7 +17,7 @@ module WebsocketRails
   class ChannelManager
 
     attr_reader :channels
-    
+
     def initialize
       @channels = HashWithIndifferentAccess.new
     end

data/lib/websocket_rails/connection_adapters.rb

@@ -1,19 +1,19 @@
 module WebsocketRails
   module ConnectionAdapters
-    
+
     attr_reader :adapters
     module_function :adapters
-    
+
     def self.register(adapter)
       @adapters ||= []
       @adapters.unshift adapter
     end
-    
+
     def self.establish_connection(request,dispatcher)
       adapter = adapters.detect { |a| a.accepts?( request.env ) } || (raise InvalidConnectionError)
       adapter.new request, dispatcher
     end
-    
+
     class Base
 
       include Logging
@@ -21,11 +21,11 @@ module WebsocketRails
       def self.accepts?(env)
         false
       end
-      
+
       def self.inherited(adapter)
         ConnectionAdapters.register adapter
       end
-      
+
       attr_reader :dispatcher, :queue, :env, :request
 
       def initialize(request,dispatcher)
@@ -52,6 +52,7 @@ module WebsocketRails
       end
 
       def on_close(data=nil)
+        @ping_timer.cancel
         dispatch Event.new_on_close( self, data )
         close_connection
       end
@@ -93,11 +94,11 @@ module WebsocketRails
       def send(message)
         raise NotImplementedError, "Override this method in the connection specific adapter class"
       end
-      
+
       def rack_response
         [ -1, {}, [] ]
       end
-      
+
       def id
         object_id.to_i
       end
@@ -135,6 +136,6 @@ module WebsocketRails
       end
 
     end
-    
+
   end
 end

data/lib/websocket_rails/connection_adapters/http.rb

@@ -7,18 +7,18 @@ module WebsocketRails
         'Content-Type'      => 'text/json',
         'Transfer-Encoding' => 'chunked'
       }
-      
+
       def self.accepts?(env)
         true
       end
-      
+
       attr_accessor :headers
 
       def initialize(env,dispatcher)
         super
         @body = DeferrableBody.new
         @headers = HttpHeaders
-        
+
         define_deferrable_callbacks
 
         EM.next_tick do
@@ -30,9 +30,9 @@ module WebsocketRails
       def send(message)
         @body.chunk encode_chunk( message )
       end
-      
+
       private
-      
+
       def define_deferrable_callbacks
         @body.callback do |event|
           on_close(event)
@@ -41,7 +41,7 @@ module WebsocketRails
           on_close(event)
         end
       end
-      
+
       # From [Rack::Stream](https://github.com/intridea/rack-stream)
       def encode_chunk(c)
         return nil if c.nil?
@@ -53,7 +53,7 @@ module WebsocketRails
         c.dup.force_encoding(Encoding::BINARY) if c.respond_to?(:force_encoding)
         [size.to_s(16), TERM, c, TERM].join
       end
-            
+
       # From [thin_async](https://github.com/macournoyer/thin_async)
       class DeferrableBody
         include EM::Deferrable
@@ -103,7 +103,7 @@ module WebsocketRails
           end
         end
       end
-      
+
     end
   end
 end

data/lib/websocket_rails/connection_adapters/web_socket.rb

@@ -1,11 +1,11 @@
 module WebsocketRails
   module ConnectionAdapters
     class WebSocket < Base
-      
+
       def self.accepts?(env)
         Faye::WebSocket.websocket?( env )
       end
-      
+
       def initialize(request,dispatcher)
         super
         @connection = Faye::WebSocket.new( request.env )
@@ -14,7 +14,7 @@ module WebsocketRails
         @connection.onclose   = method(:on_close)
         on_open
       end
-      
+
       def send(message)
         @connection.send message
       end
@@ -23,7 +23,7 @@ module WebsocketRails
         data = event.respond_to?(:data) ? event.data : event
         super data
       end
-      
+
     end
   end
 end

data/lib/websocket_rails/connection_manager.rb

@@ -12,35 +12,48 @@ module WebsocketRails
     SuccessfulResponse = [200,{'Content-Type' => 'text/plain'},['success']].freeze
     BadRequestResponse = [400,{'Content-Type' => 'text/plain'},['invalid']].freeze
     ExceptionResponse  = [500,{'Content-Type' => 'text/plain'},['exception']].freeze
-    
+
     # Contains an Array of currently open connections.
     # @return [Array]
     attr_reader :connections
-    
+
     # Contains the {Dispatcher} instance for the active server.
     # @return [Dispatcher]
     attr_reader :dispatcher
-    
+
+    # Contains the {Synchronization} instance for the active server.
+    # @return [Synchronization]
+    attr_reader :synchronization
+
     def initialize
       @connections = []
-      @dispatcher  = Dispatcher.new( self )
+      @dispatcher  = Dispatcher.new(self)
+
+      if WebsocketRails.synchronize?
+        EM.next_tick do
+          Fiber.new {
+            Synchronization.synchronize!
+            EM.add_shutdown_hook { Synchronization.shutdown! }
+          }.resume
+        end
+      end
     end
-    
+
     # Primary entry point for the Rack application
     def call(env)
-      request = ActionDispatch::Request.new env
+      request = ActionDispatch::Request.new(env)
 
       if request.post?
-        response = parse_incoming_event request.params
+        response = parse_incoming_event(request.params)
       else
-        response = open_connection request
+        response = open_connection(request)
       end
-      
+
       response
     rescue InvalidConnectionError
       BadRequestResponse
     end
-    
+
     private
 
     def parse_incoming_event(params)
@@ -52,7 +65,7 @@ module WebsocketRails
     def find_connection_by_id(id)
       connections.detect { |connection| connection.id == id.to_i } || (raise InvalidConnectionError)
     end
-    
+
     # Opens a persistent connection using the appropriate {ConnectionAdapter}. Stores
     # active connections in the {connections} array.
     def open_connection(request)
@@ -68,6 +81,6 @@ module WebsocketRails
       connection = nil
     end
     public :close_connection
-    
+
   end
 end

data/lib/websocket_rails/data_store.rb

@@ -4,16 +4,16 @@ module WebsocketRails
   # variables defined in actions will be shared between clients. The {DataStore} provides a Hash
   # that is private for each connected client. It is accessed through a WebsocketRails controller
   # using the {BaseController.data_store} instance method.
-  # 
+  #
   # = Example Usage
   # == Creating a user
   #   # action on ChatController called by :client_connected event
   #   def new_user
   #     # This would be overwritten when the next user joins
   #     @user = User.new( message[:user_name] )
-  #     
+  #
   #     # This will remain private for each user
-  #     data_store[:user] = User.new( message[:user_name] ) 
+  #     data_store[:user] = User.new( message[:user_name] )
   #   end
   #
   # == Collecting all Users from the DataStore
@@ -29,11 +29,11 @@ module WebsocketRails
   #   data_store.each_user
   #   => [UserOne,UserTwo,UserThree]
   class DataStore
-    
+
     extend Forwardable
-    
+
     def_delegator :@base, :client_id, :cid
-    
+
     def initialize(base_controller)
       @base = base_controller
       @data = Hash.new {|h,k| h[k] = Hash.new}
@@ -55,15 +55,15 @@ module WebsocketRails
         block.call(hash) if block
       end
     end
-    
+
     def remove_client
       @data.delete(cid)
     end
-    
+
     def delete(key)
       @data[cid].delete(key)
     end
-    
+
     def method_missing(method, *args, &block)
       if /each_(?<hash_key>\w*)/ =~ method
         results = []
@@ -76,4 +76,4 @@ module WebsocketRails
       end
     end
   end
-end
+end