aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2015-06-20 17:45:30 +0200
committerDavid Heinemeier Hansson <david@loudthinking.com>2015-06-20 17:45:30 +0200
commitdd77dd3868b6ea9942dc1340cba4491c2f1bc750 (patch)
tree7416d51224b1dd67bf9899da4b054768cbdce2aa
parent7c1becfc1a0ebeb5a1fd840afd89af26b3a6f02d (diff)
parent082c6317f0b680f4bcd3b1643e6481bed4606139 (diff)
downloadrails-dd77dd3868b6ea9942dc1340cba4491c2f1bc750.tar.gz
rails-dd77dd3868b6ea9942dc1340cba4491c2f1bc750.tar.bz2
rails-dd77dd3868b6ea9942dc1340cba4491c2f1bc750.zip
Merge branch 'master' of github.com:basecamp/action_cable
-rw-r--r--lib/action_cable/broadcaster.rb2
-rw-r--r--lib/action_cable/channel/base.rb17
-rw-r--r--lib/action_cable/channel/redis.rb7
-rw-r--r--lib/action_cable/connection/base.rb22
-rw-r--r--lib/assets/javascripts/channel.js.coffee9
5 files changed, 34 insertions, 23 deletions
diff --git a/lib/action_cable/broadcaster.rb b/lib/action_cable/broadcaster.rb
index 38c56b8262..7d8cc90970 100644
--- a/lib/action_cable/broadcaster.rb
+++ b/lib/action_cable/broadcaster.rb
@@ -10,8 +10,8 @@ module ActionCable
end
def broadcast(message)
+ logger.info "[ActionCable] Broadcasting to #{channel}: #{message}"
redis.publish channel, message.to_json
- logger.info "[ActionCable] Broadcasting to channel (#{channel}): #{message}"
end
end
end
diff --git a/lib/action_cable/channel/base.rb b/lib/action_cable/channel/base.rb
index 6060ccf681..e6ca45ddcc 100644
--- a/lib/action_cable/channel/base.rb
+++ b/lib/action_cable/channel/base.rb
@@ -31,6 +31,12 @@ module ActionCable
perform_connection
end
+ def perform_connection
+ logger.info "#{channel_name} connecting"
+ connect
+ run_subscribe_callbacks
+ end
+
def perform_action(data)
if authorized?
action = extract_action(data)
@@ -52,11 +58,6 @@ module ActionCable
logger.info "#{channel_name} disconnected"
end
- def perform_connection
- logger.info "#{channel_name} connecting"
- connect
- run_subscribe_callbacks
- end
protected
# Override in subclasses
@@ -78,10 +79,10 @@ module ActionCable
end
- def broadcast(data)
+ def transmit(data, via: nil)
if authorized?
- logger.info "#{channel_name} broadcasting #{data.inspect}"
- connection.broadcast({ identifier: @channel_identifier, message: data }.to_json)
+ logger.info "#{channel_name} transmitting #{data.inspect}".tap { |m| m << " (via #{via})" if via }
+ connection.transmit({ identifier: @channel_identifier, message: data }.to_json)
else
unauthorized
end
diff --git a/lib/action_cable/channel/redis.rb b/lib/action_cable/channel/redis.rb
index b5fc812919..0f77dc0418 100644
--- a/lib/action_cable/channel/redis.rb
+++ b/lib/action_cable/channel/redis.rb
@@ -14,14 +14,14 @@ module ActionCable
@_redis_channels << [ redis_channel, callback ]
pubsub.subscribe(redis_channel, &callback)
- logger.info "#{channel_name} subscribed to incoming actions from #{redis_channel}"
+ logger.info "#{channel_name} subscribed to broadcasts from #{redis_channel}"
end
def unsubscribe_from_all_channels
if @_redis_channels
@_redis_channels.each do |redis_channel, callback|
pubsub.unsubscribe_proc(redis_channel, callback)
- logger.info "#{channel_name} unsubscribed from incoming actions #{redis_channel}"
+ logger.info "#{channel_name} unsubscribed to broadcasts from #{redis_channel}"
end
end
end
@@ -29,8 +29,7 @@ module ActionCable
protected
def default_subscription_callback(channel)
-> (message) do
- logger.info "Received a message over the redis channel: #{channel}"
- broadcast ActiveSupport::JSON.decode(message)
+ transmit ActiveSupport::JSON.decode(message), via: "broadcast from #{channel}"
end
end
end
diff --git a/lib/action_cable/connection/base.rb b/lib/action_cable/connection/base.rb
index c36b7bbc1a..89d0844031 100644
--- a/lib/action_cable/connection/base.rb
+++ b/lib/action_cable/connection/base.rb
@@ -34,8 +34,8 @@ module ActionCable
@websocket = Faye::WebSocket.new(@env)
@websocket.on(:open) do |event|
- broadcast_ping_timestamp
- @ping_timer = EventMachine.add_periodic_timer(PING_INTERVAL) { broadcast_ping_timestamp }
+ transmit_ping_timestamp
+ @ping_timer = EventMachine.add_periodic_timer(PING_INTERVAL) { transmit_ping_timestamp }
worker_pool.async.invoke(self, :initialize_connection)
end
@@ -87,7 +87,7 @@ module ActionCable
end
end
- def broadcast(data)
+ def transmit(data)
@websocket.send data
end
@@ -109,6 +109,14 @@ module ActionCable
end
protected
+ def request
+ @request ||= ActionDispatch::Request.new(Rails.application.env_config.merge(env))
+ end
+
+ def cookies
+ request.cookie_jar
+ end
+
def initialize_connection
server.add_connection(self)
@@ -127,8 +135,8 @@ module ActionCable
disconnect if respond_to?(:disconnect)
end
- def broadcast_ping_timestamp
- broadcast({ identifier: '_ping', message: Time.now.to_i }.to_json)
+ def transmit_ping_timestamp
+ transmit({ identifier: '_ping', message: Time.now.to_i }.to_json)
end
def subscribe_channel(data)
@@ -173,10 +181,6 @@ module ActionCable
@websocket && @websocket.ready_state == Faye::WebSocket::API::OPEN
end
- def request
- @request ||= ActionDispatch::Request.new(env)
- end
-
def websocket?
@is_websocket ||= Faye::WebSocket.websocket?(@env)
end
diff --git a/lib/assets/javascripts/channel.js.coffee b/lib/assets/javascripts/channel.js.coffee
index 058bcc03aa..2f07affb19 100644
--- a/lib/assets/javascripts/channel.js.coffee
+++ b/lib/assets/javascripts/channel.js.coffee
@@ -1,6 +1,6 @@
class @Cable.Channel
constructor: (params = {}) ->
- @channelName ?= @underscore @constructor.name
+ @channelName ?= "#{@underscore(@constructor.name)}_channel"
params['channel'] = @channelName
@channelIdentifier = JSON.stringify params
@@ -11,6 +11,7 @@ class @Cable.Channel
onReceiveData: @received
})
+
connected: =>
# Override in the subclass
@@ -20,8 +21,14 @@ class @Cable.Channel
received: (data) =>
# Override in the subclass
+ # Perform a channel action with the optional data passed as an attribute
+ perform: (action, data = {}) ->
+ data.action = action
+ cable.sendData @channelIdentifier, JSON.stringify data
+
send: (data) ->
cable.sendData @channelIdentifier, JSON.stringify data
+
underscore: (value) ->
value.replace(/[A-Z]/g, (match) => "_#{match.toLowerCase()}").substr(1) \ No newline at end of file