aboutsummaryrefslogtreecommitdiffstats
path: root/actioncable/app/javascript/action_cable/connection.js
blob: 462db965d180e0e8d86878dc50250f0ed440b133 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * decaffeinate suggestions:
 * DS101: Remove unnecessary use of Array.from
 * DS102: Remove unnecessary code created because of implicit returns
 * DS104: Avoid inline assignments
 * DS201: Simplify complex destructure assignments
 * DS204: Change includes calls to have a more natural evaluation order
 * DS206: Consider reworking classes to avoid initClass
 * DS207: Consider shorter variations of null checks
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
//= require ./connection_monitor

// Encapsulate the cable connection held by the consumer. This is an internal class not intended for direct user manipulation.

const {message_types, protocols} = ActionCable.INTERNAL
const adjustedLength = Math.max(protocols.length, 1),
  supportedProtocols = protocols.slice(0, adjustedLength - 1),
  unsupportedProtocol = protocols[adjustedLength - 1]

const Cls = (ActionCable.Connection = class Connection {
  static initClass() {
    this.reopenDelay = 500

    this.prototype.events = {
      message(event) {
        if (!this.isProtocolSupported()) { return }
        const {identifier, message, type} = JSON.parse(event.data)
        switch (type) {
          case message_types.welcome:
            this.monitor.recordConnect()
            return this.subscriptions.reload()
          case message_types.ping:
            return this.monitor.recordPing()
          case message_types.confirmation:
            return this.subscriptions.notify(identifier, "connected")
          case message_types.rejection:
            return this.subscriptions.reject(identifier)
          default:
            return this.subscriptions.notify(identifier, "received", message)
        }
      },

      open() {
        ActionCable.log(`WebSocket onopen event, using '${this.getProtocol()}' subprotocol`)
        this.disconnected = false
        if (!this.isProtocolSupported()) {
          ActionCable.log("Protocol is unsupported. Stopping monitor and disconnecting.")
          return this.close({allowReconnect: false})
        }
      },

      close(event) {
        ActionCable.log("WebSocket onclose event")
        if (this.disconnected) { return }
        this.disconnected = true
        this.monitor.recordDisconnect()
        return this.subscriptions.notifyAll("disconnected", {willAttemptReconnect: this.monitor.isRunning()})
      },

      error() {
        return ActionCable.log("WebSocket onerror event")
      }
    }
  }

  constructor(consumer) {
    this.open = this.open.bind(this)
    this.consumer = consumer;
    ({subscriptions: this.subscriptions} = this.consumer)
    this.monitor = new ActionCable.ConnectionMonitor(this)
    this.disconnected = true
  }

  send(data) {
    if (this.isOpen()) {
      this.webSocket.send(JSON.stringify(data))
      return true
    } else {
      return false
    }
  }

  open() {
    if (this.isActive()) {
      ActionCable.log(`Attempted to open WebSocket, but existing socket is ${this.getState()}`)
      return false
    } else {
      ActionCable.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${protocols}`)
      if (this.webSocket != null) { this.uninstallEventHandlers() }
      this.webSocket = new ActionCable.WebSocket(this.consumer.url, protocols)
      this.installEventHandlers()
      this.monitor.start()
      return true
    }
  }

  close(param) {
    if (param == null) { param = {allowReconnect: true} }
    const {allowReconnect} = param
    if (!allowReconnect) { this.monitor.stop() }
    if (this.isActive()) { return (this.webSocket != null ? this.webSocket.close() : undefined) }
  }

  reopen() {
    ActionCable.log(`Reopening WebSocket, current state is ${this.getState()}`)
    if (this.isActive()) {
      try {
        return this.close()
      } catch (error) {
        return ActionCable.log("Failed to reopen WebSocket", error)
      }
      finally {
        ActionCable.log(`Reopening WebSocket in ${this.constructor.reopenDelay}ms`)
        setTimeout(this.open, this.constructor.reopenDelay)
      }
    } else {
      return this.open()
    }
  }

  getProtocol() {
    return (this.webSocket != null ? this.webSocket.protocol : undefined)
  }

  isOpen() {
    return this.isState("open")
  }

  isActive() {
    return this.isState("open", "connecting")
  }

  // Private

  isProtocolSupported() {
    let needle
    return (needle = this.getProtocol(), Array.from(supportedProtocols).includes(needle))
  }

  isState(...states) {
    let needle
    return (needle = this.getState(), Array.from(states).includes(needle))
  }

  getState() {
    for (let state in WebSocket) { const value = WebSocket[state]; if (value === (this.webSocket != null ? this.webSocket.readyState : undefined)) { return state.toLowerCase() } }
    return null
  }

  installEventHandlers() {
    for (let eventName in this.events) {
      const handler = this.events[eventName].bind(this)
      this.webSocket[`on${eventName}`] = handler
    }
  }

  uninstallEventHandlers() {
    for (let eventName in this.events) {
      this.webSocket[`on${eventName}`] = function() {}
    }
  }
})
Cls.initClass()