From 354018bf9b5f5bf0fbbc6e6efddc719e7523b39d Mon Sep 17 00:00:00 2001 From: Pratik Naik Date: Sat, 4 Apr 2015 00:26:14 -0500 Subject: Separate connection and server classes --- action_cable.gemspec | 1 + lib/action_cable.rb | 4 + lib/action_cable/channel/redis.rb | 7 +- lib/action_cable/connection.rb | 133 ++++++++++++++++++++++++++++++++ lib/action_cable/connections.rb | 17 +++++ lib/action_cable/server.rb | 154 +++----------------------------------- 6 files changed, 166 insertions(+), 150 deletions(-) create mode 100644 lib/action_cable/connection.rb create mode 100644 lib/action_cable/connections.rb diff --git a/action_cable.gemspec b/action_cable.gemspec index 1dade2a394..ba5c4159d6 100644 --- a/action_cable.gemspec +++ b/action_cable.gemspec @@ -12,6 +12,7 @@ Gem::Specification.new do |s| s.add_dependency('activesupport', '>= 4.2.0') s.add_dependency('faye-websocket', '~> 0.9.2') s.add_dependency('celluloid', '~> 0.16.0') + s.add_dependency('em-hiredis', '~> 0.3.0') s.files = Dir['README', 'lib/**/*'] s.has_rdoc = false diff --git a/lib/action_cable.rb b/lib/action_cable.rb index 0681b8bdde..62046c7717 100644 --- a/lib/action_cable.rb +++ b/lib/action_cable.rb @@ -7,10 +7,12 @@ require 'active_support' require 'active_support/json' require 'active_support/concern' require 'active_support/core_ext/hash/indifferent_access' +require 'active_support/core_ext/module/delegation' require 'active_support/callbacks' require 'faye/websocket' require 'celluloid' +require 'em-hiredis' require 'action_cable/engine' if defined?(Rails) @@ -20,4 +22,6 @@ module ActionCable autoload :Channel, 'action_cable/channel' autoload :Worker, 'action_cable/worker' autoload :Server, 'action_cable/server' + autoload :Connection, 'action_cable/connection' + autoload :Connections, 'action_cable/connections' end diff --git a/lib/action_cable/channel/redis.rb b/lib/action_cable/channel/redis.rb index bdbd3c95b1..2691a3b145 100644 --- a/lib/action_cable/channel/redis.rb +++ b/lib/action_cable/channel/redis.rb @@ -6,11 +6,10 @@ module ActionCable included do on_unsubscribe :unsubscribe_from_redis_channels + delegate :pubsub, to: :connection end def subscribe_to(redis_channel, callback = nil) - raise "`ActionCable::Server.pubsub` class method is not defined" unless connection.class.respond_to?(:pubsub) - callback ||= -> (message) { broadcast ActiveSupport::JSON.decode(message) } @_redis_channels ||= [] @_redis_channels << [ redis_channel, callback ] @@ -24,10 +23,6 @@ module ActionCable @_redis_channels.each { |channel, callback| pubsub.unsubscribe_proc(channel, callback) } end end - - def pubsub - connection.class.pubsub - end end end diff --git a/lib/action_cable/connection.rb b/lib/action_cable/connection.rb new file mode 100644 index 0000000000..00fb8ca817 --- /dev/null +++ b/lib/action_cable/connection.rb @@ -0,0 +1,133 @@ +module ActionCable + class Connection + PING_INTERVAL = 3 + + attr_reader :env, :server + delegate :worker_pool, :pubsub, :logger, to: :server + + def initialize(server, env) + @server = server + @env = env + @accept_messages = false + @pending_messages = [] + end + + def process + if Faye::WebSocket.websocket?(@env) + @subscriptions = {} + + @websocket = Faye::WebSocket.new(@env) + + @websocket.on(:open) do |event| + broadcast_ping_timestamp + @ping_timer = EventMachine.add_periodic_timer(PING_INTERVAL) { broadcast_ping_timestamp } + worker_pool.async.invoke(self, :initialize_client) + end + + @websocket.on(:message) do |event| + message = event.data + + if message.is_a?(String) + if @accept_messages + worker_pool.async.invoke(self, :received_data, message) + else + @pending_messages << message + end + end + end + + @websocket.on(:close) do |event| + worker_pool.async.invoke(self, :cleanup_subscriptions) + worker_pool.async.invoke(self, :disconnect) if respond_to?(:disconnect) + + EventMachine.cancel_timer(@ping_timer) if @ping_timer + end + + @websocket.rack_response + else + invalid_request + end + end + + def received_data(data) + return unless websocket_alive? + + data = ActiveSupport::JSON.decode data + + case data['action'] + when 'subscribe' + subscribe_channel(data) + when 'unsubscribe' + unsubscribe_channel(data) + when 'message' + process_message(data) + end + end + + def cleanup_subscriptions + @subscriptions.each do |id, channel| + channel.unsubscribe + end + end + + def broadcast(data) + logger.info "Sending data: #{data}" + @websocket.send data + end + + def handle_exception + logger.error "[ActionCable] Closing connection" + + @websocket.close + end + + private + def initialize_client + connect if respond_to?(:connect) + @accept_messages = true + + worker_pool.async.invoke(self, :received_data, @pending_messages.shift) until @pending_messages.empty? + end + + def broadcast_ping_timestamp + broadcast({ identifier: '_ping', message: Time.now.to_i }.to_json) + end + + def subscribe_channel(data) + id_key = data['identifier'] + id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access + + subscription_klass = server.registered_channels.detect { |channel_klass| channel_klass.find_name == id_options[:channel] } + + if subscription_klass + logger.info "Subscribing to channel: #{id_key}" + @subscriptions[id_key] = subscription_klass.new(self, id_key, id_options) + else + logger.error "Unable to subscribe to channel: #{id_key}" + end + end + + def process_message(message) + if @subscriptions[message['identifier']] + @subscriptions[message['identifier']].receive_data(ActiveSupport::JSON.decode message['data']) + else + logger.error "Unable to process message: #{message}" + end + end + + def unsubscribe_channel(data) + logger.info "Unsubscribing from channel: #{data['identifier']}" + @subscriptions[data['identifier']].unsubscribe + @subscriptions.delete(data['identifier']) + end + + def invalid_request + [404, {'Content-Type' => 'text/plain'}, ['Page not found']] + end + + def websocket_alive? + @websocket && @websocket.ready_state == Faye::WebSocket::API::OPEN + end + + end +end diff --git a/lib/action_cable/connections.rb b/lib/action_cable/connections.rb new file mode 100644 index 0000000000..e68cc6e7a4 --- /dev/null +++ b/lib/action_cable/connections.rb @@ -0,0 +1,17 @@ +module ActionCable + module Connections + class << self + def active + end + + def where(identification) + end + end + + def disconnect + end + + def reconnect + end + end +end diff --git a/lib/action_cable/server.rb b/lib/action_cable/server.rb index ebf98171c1..6e9265dc06 100644 --- a/lib/action_cable/server.rb +++ b/lib/action_cable/server.rb @@ -1,157 +1,23 @@ module ActionCable class Server - class_attribute :registered_channels - self.registered_channels = Set.new - - class_attribute :worker_pool_size - self.worker_pool_size = 100 - cattr_accessor(:logger, instance_reader: true) { Rails.logger } - PING_INTERVAL = 3 - - class << self - def register_channels(*channel_classes) - self.registered_channels += channel_classes - end - - def call(env) - new(env).process - end - - def worker_pool - @worker_pool ||= ActionCable::Worker.pool(size: worker_pool_size) - end - end - - attr_reader :env - - def initialize(env) - @env = env - @accept_messages = false - @pending_messages = [] - end - - def process - if Faye::WebSocket.websocket?(@env) - @subscriptions = {} - - @websocket = Faye::WebSocket.new(@env) - - @websocket.on(:open) do |event| - broadcast_ping_timestamp - @ping_timer = EventMachine.add_periodic_timer(PING_INTERVAL) { broadcast_ping_timestamp } - worker_pool.async.invoke(self, :initialize_client) - end - - @websocket.on(:message) do |event| - message = event.data - - if message.is_a?(String) - if @accept_messages - worker_pool.async.invoke(self, :received_data, message) - else - @pending_messages << message - end - end - end + attr_accessor :registered_channels, :worker_pool - @websocket.on(:close) do |event| - worker_pool.async.invoke(self, :cleanup_subscriptions) - worker_pool.async.invoke(self, :disconnect) if respond_to?(:disconnect) - - EventMachine.cancel_timer(@ping_timer) if @ping_timer - end - - @websocket.rack_response - else - invalid_request - end + def initialize(redis_config:, channels:, worker_pool_size: 100, connection: Connection) + @redis_config = redis_config + @registered_channels = Set.new(channels) + @worker_pool = ActionCable::Worker.pool(size: worker_pool_size) + @connection_class = connection end - def received_data(data) - return unless websocket_alive? - - data = ActiveSupport::JSON.decode data - - case data['action'] - when 'subscribe' - subscribe_channel(data) - when 'unsubscribe' - unsubscribe_channel(data) - when 'message' - process_message(data) - end + def call(env) + @connection_class.new(self, env).process end - def cleanup_subscriptions - @subscriptions.each do |id, channel| - channel.unsubscribe - end + def pubsub + @pubsub ||= EM::Hiredis.connect(@redis_config['url']).pubsub end - def broadcast(data) - logger.info "Sending data: #{data}" - @websocket.send data - end - - def worker_pool - self.class.worker_pool - end - - def handle_exception - logger.error "[ActionCable] Closing connection" - - @websocket.close - end - - private - def initialize_client - connect if respond_to?(:connect) - @accept_messages = true - - worker_pool.async.invoke(self, :received_data, @pending_messages.shift) until @pending_messages.empty? - end - - def broadcast_ping_timestamp - broadcast({ identifier: '_ping', message: Time.now.to_i }.to_json) - end - - def subscribe_channel(data) - id_key = data['identifier'] - id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access - - subscription_klass = registered_channels.detect { |channel_klass| channel_klass.find_name == id_options[:channel] } - - if subscription_klass - logger.info "Subscribing to channel: #{id_key}" - @subscriptions[id_key] = subscription_klass.new(self, id_key, id_options) - else - logger.error "Unable to subscribe to channel: #{id_key}" - end - end - - def process_message(message) - if @subscriptions[message['identifier']] - @subscriptions[message['identifier']].receive_data(ActiveSupport::JSON.decode message['data']) - else - logger.error "Unable to process message: #{message}" - end - end - - def unsubscribe_channel(data) - logger.info "Unsubscribing from channel: #{data['identifier']}" - @subscriptions[data['identifier']].unsubscribe - @subscriptions.delete(data['identifier']) - end - - def invalid_request - [404, {'Content-Type' => 'text/plain'}, ['Page not found']] - end - - def websocket_alive? - @websocket && @websocket.ready_state == Faye::WebSocket::API::OPEN - end - end end -- cgit v1.2.3