mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
7b0b37240a
- Rename action_cable/*.coffee -> *.js - Move app/assets/javascripts/* -> app/javascript/* - Rename action_cable.js.erb -> action_cable/index.js.erb Renaming the extension to .js is in preparation for converting these files from coffeescript to ES2015. Moving the files to app/javascript and putting the entry point in index.js.erb changes the structure of ActionCable's javascript to match the structure of ActiveStorage's javascript. (We are doing the file moving and renaming in a separate commit to ensure that the git history of the files will be preserved - i.e. git will track these as file renames rather than unrelated file additions/deletions. In particular, git blame will still trace back to the original authorship.)
116 lines
3.3 KiB
JavaScript
116 lines
3.3 KiB
JavaScript
#= require ./connection_monitor
|
|
|
|
# Encapsulate the cable connection held by the consumer. This is an internal class not intended for direct user manipulation.
|
|
|
|
{message_types, protocols} = ActionCable.INTERNAL
|
|
[supportedProtocols..., unsupportedProtocol] = protocols
|
|
|
|
class ActionCable.Connection
|
|
@reopenDelay: 500
|
|
|
|
constructor: (@consumer) ->
|
|
{@subscriptions} = @consumer
|
|
@monitor = new ActionCable.ConnectionMonitor this
|
|
@disconnected = true
|
|
|
|
send: (data) ->
|
|
if @isOpen()
|
|
@webSocket.send(JSON.stringify(data))
|
|
true
|
|
else
|
|
false
|
|
|
|
open: =>
|
|
if @isActive()
|
|
ActionCable.log("Attempted to open WebSocket, but existing socket is #{@getState()}")
|
|
false
|
|
else
|
|
ActionCable.log("Opening WebSocket, current state is #{@getState()}, subprotocols: #{protocols}")
|
|
@uninstallEventHandlers() if @webSocket?
|
|
@webSocket = new ActionCable.WebSocket(@consumer.url, protocols)
|
|
@installEventHandlers()
|
|
@monitor.start()
|
|
true
|
|
|
|
close: ({allowReconnect} = {allowReconnect: true}) ->
|
|
@monitor.stop() unless allowReconnect
|
|
@webSocket?.close() if @isActive()
|
|
|
|
reopen: ->
|
|
ActionCable.log("Reopening WebSocket, current state is #{@getState()}")
|
|
if @isActive()
|
|
try
|
|
@close()
|
|
catch error
|
|
ActionCable.log("Failed to reopen WebSocket", error)
|
|
finally
|
|
ActionCable.log("Reopening WebSocket in #{@constructor.reopenDelay}ms")
|
|
setTimeout(@open, @constructor.reopenDelay)
|
|
else
|
|
@open()
|
|
|
|
getProtocol: ->
|
|
@webSocket?.protocol
|
|
|
|
isOpen: ->
|
|
@isState("open")
|
|
|
|
isActive: ->
|
|
@isState("open", "connecting")
|
|
|
|
# Private
|
|
|
|
isProtocolSupported: ->
|
|
@getProtocol() in supportedProtocols
|
|
|
|
isState: (states...) ->
|
|
@getState() in states
|
|
|
|
getState: ->
|
|
return state.toLowerCase() for state, value of WebSocket when value is @webSocket?.readyState
|
|
null
|
|
|
|
installEventHandlers: ->
|
|
for eventName of @events
|
|
handler = @events[eventName].bind(this)
|
|
@webSocket["on#{eventName}"] = handler
|
|
return
|
|
|
|
uninstallEventHandlers: ->
|
|
for eventName of @events
|
|
@webSocket["on#{eventName}"] = ->
|
|
return
|
|
|
|
events:
|
|
message: (event) ->
|
|
return unless @isProtocolSupported()
|
|
{identifier, message, type} = JSON.parse(event.data)
|
|
switch type
|
|
when message_types.welcome
|
|
@monitor.recordConnect()
|
|
@subscriptions.reload()
|
|
when message_types.ping
|
|
@monitor.recordPing()
|
|
when message_types.confirmation
|
|
@subscriptions.notify(identifier, "connected")
|
|
when message_types.rejection
|
|
@subscriptions.reject(identifier)
|
|
else
|
|
@subscriptions.notify(identifier, "received", message)
|
|
|
|
open: ->
|
|
ActionCable.log("WebSocket onopen event, using '#{@getProtocol()}' subprotocol")
|
|
@disconnected = false
|
|
if not @isProtocolSupported()
|
|
ActionCable.log("Protocol is unsupported. Stopping monitor and disconnecting.")
|
|
@close(allowReconnect: false)
|
|
|
|
close: (event) ->
|
|
ActionCable.log("WebSocket onclose event")
|
|
return if @disconnected
|
|
@disconnected = true
|
|
@monitor.recordDisconnect()
|
|
@subscriptions.notifyAll("disconnected", {willAttemptReconnect: @monitor.isRunning()})
|
|
|
|
error: ->
|
|
ActionCable.log("WebSocket onerror event")
|