Merge pull request #25170 from maclover7/add-configuration-cable

[Action Cable] Add `WebSocket` and `logger` configuration options

8 files changed, 69 insertions, 51 deletions

diff --git a/actioncable/app/assets/javascripts/action_cable.coffee.erb b/actioncable/app/assets/javascripts/action_cable.coffee.erb
index 210a3ae17e..e0758dae72 100644
--- a/actioncable/app/assets/javascripts/action_cable.coffee.erb
+++ b/actioncable/app/assets/javascripts/action_cable.coffee.erb
@@ -4,6 +4,8 @@
 
 @ActionCable =
   INTERNAL: <%= ActionCable::INTERNAL.to_json %>
+  WebSocket: window.WebSocket
+  logger: window.console
 
   createConsumer: (url) ->
     url ?= @getConfig("url") ? @INTERNAL.default_mount_path
@@ -33,4 +35,4 @@
   log: (messages...) ->
     if @debugging
       messages.push(Date.now())
-      console.log("[ActionCable]", messages...)
+      @logger.log("[ActionCable]", messages...)
diff --git a/actioncable/app/assets/javascripts/action_cable/connection.coffee b/actioncable/app/assets/javascripts/action_cable/connection.coffee
index d6a6397804..29ad676290 100644
--- a/actioncable/app/assets/javascripts/action_cable/connection.coffee
+++ b/actioncable/app/assets/javascripts/action_cable/connection.coffee
@@ -27,7 +27,7 @@ class ActionCable.Connection
     else
       ActionCable.log("Opening WebSocket, current state is #{@getState()}, subprotocols: #{protocols}")
       @uninstallEventHandlers() if @webSocket?
-      @webSocket = new WebSocket(@consumer.url, protocols)
+      @webSocket = new ActionCable.WebSocket(@consumer.url, protocols)
       @installEventHandlers()
       @monitor.start()
       true
diff --git a/actioncable/test/javascript/src/test.coffee b/actioncable/test/javascript/src/test.coffee
index 3ce88c7789..eb95fb2604 100644
--- a/actioncable/test/javascript/src/test.coffee
+++ b/actioncable/test/javascript/src/test.coffee
@@ -1,3 +1,3 @@
 #= require action_cable
-#= require_tree ./test_helpers
+#= require ./test_helpers
 #= require_tree ./unit
diff --git a/actioncable/test/javascript/src/test_helpers/consumer_test_helper.coffee b/actioncable/test/javascript/src/test_helpers/consumer_test_helper.coffee
new file mode 100644
index 0000000000..6b145dede8
--- /dev/null
+++ b/actioncable/test/javascript/src/test_helpers/consumer_test_helper.coffee
@@ -0,0 +1,37 @@
+#= require mock-socket
+
+{TestHelpers} = ActionCable
+
+TestHelpers.consumerTest = (name, options = {}, callback) ->
+  unless callback?
+    callback = options
+    options = {}
+
+  options.url ?= TestHelpers.testURL
+
+  QUnit.test name, (assert) ->
+    doneAsync = assert.async()
+
+    ActionCable.WebSocket = MockWebSocket
+    server = new MockServer options.url
+    consumer = ActionCable.createConsumer(options.url)
+
+    server.on "connection", ->
+      clients = server.clients()
+      assert.equal clients.length, 1
+      assert.equal clients[0].readyState, WebSocket.OPEN
+
+    done = ->
+      consumer.disconnect()
+      server.close()
+      doneAsync()
+
+    testData = {assert, consumer, server, done}
+
+    if options.connect is false
+      callback(testData)
+    else
+      server.on "connection", ->
+        testData.client = server.clients()[0]
+        callback(testData)
+      consumer.connect()
diff --git a/actioncable/test/javascript/src/test_helpers/index.coffee b/actioncable/test/javascript/src/test_helpers/index.coffee
index e0d1e412cd..d36524d9cc 100644
--- a/actioncable/test/javascript/src/test_helpers/index.coffee
+++ b/actioncable/test/javascript/src/test_helpers/index.coffee
@@ -3,3 +3,6 @@
 
 ActionCable.TestHelpers =
   testURL: "ws://cable.example.com/"
+
+originalWebSocket = ActionCable.WebSocket
+QUnit.testDone -> ActionCable.WebSocket = originalWebSocket
diff --git a/actioncable/test/javascript/src/test_helpers/mock_websocket.coffee b/actioncable/test/javascript/src/test_helpers/mock_websocket.coffee
deleted file mode 100644
index b7f86f18f6..0000000000
--- a/actioncable/test/javascript/src/test_helpers/mock_websocket.coffee
+++ /dev/null
@@ -1,21 +0,0 @@
-#= require mock-socket
-
-NativeWebSocket = window.WebSocket
-
-server = null
-consumer = null
-
-ActionCable.TestHelpers.createConsumer = (url, callback) ->
-  window.WebSocket = MockWebSocket
-  server = new MockServer url
-  consumer = ActionCable.createConsumer(url)
-  callback(consumer, server)
-
-QUnit.testDone ->
-  if consumer?
-    consumer.disconnect()
-
-  if server?
-    server.clients().forEach (client) -> client.close()
-    server.close()
-    window.WebSocket = NativeWebSocket
diff --git a/actioncable/test/javascript/src/unit/action_cable_test.coffee b/actioncable/test/javascript/src/unit/action_cable_test.coffee
index f9eff64769..3944f3a7f6 100644
--- a/actioncable/test/javascript/src/unit/action_cable_test.coffee
+++ b/actioncable/test/javascript/src/unit/action_cable_test.coffee
@@ -2,6 +2,23 @@
 {testURL} = ActionCable.TestHelpers
 
 module "ActionCable", ->
+  module "Adapters", ->
+    module "WebSocket", ->
+      test "default is window.WebSocket", (assert) ->
+        assert.equal ActionCable.WebSocket, window.WebSocket
+
+      test "configurable", (assert) ->
+        ActionCable.WebSocket = ""
+        assert.equal ActionCable.WebSocket, ""
+
+    module "logger", ->
+      test "default is window.console", (assert) ->
+        assert.equal ActionCable.logger, window.console
+
+      test "configurable", (assert) ->
+        ActionCable.logger = ""
+        assert.equal ActionCable.logger, ""
+
   module "#createConsumer", ->
     test "uses specified URL", (assert) ->
       consumer = ActionCable.createConsumer(testURL)
diff --git a/actioncable/test/javascript/src/unit/consumer_test.coffee b/actioncable/test/javascript/src/unit/consumer_test.coffee
index d8b1450ad8..cf8a592255 100644
--- a/actioncable/test/javascript/src/unit/consumer_test.coffee
+++ b/actioncable/test/javascript/src/unit/consumer_test.coffee
@@ -1,31 +1,11 @@
 {module, test} = QUnit
-{testURL, createConsumer} = ActionCable.TestHelpers
+{consumerTest} = ActionCable.TestHelpers
 
 module "ActionCable.Consumer", ->
-  test "#connect", (assert) ->
-    done = assert.async()
+  consumerTest "#connect", connect: false, ({consumer, server, done}) ->
+    server.on("connection", done)
+    consumer.connect()
 
-    createConsumer testURL, (consumer, server) ->
-      server.on "connection", ->
-        clients = server.clients()
-        assert.equal clients.length, 1
-        assert.equal clients[0].readyState, WebSocket.OPEN
-        done()
-
-      consumer.connect()
-
-  test "#disconnect", (assert) ->
-    done = assert.async()
-
-    createConsumer testURL, (consumer, server) ->
-      server.on "connection", ->
-        clients = server.clients()
-        assert.equal clients.length, 1
-
-        clients[0].addEventListener "close", (event) ->
-          assert.equal event.type, "close"
-          done()
-
-        consumer.disconnect()
-
-      consumer.connect()
+  consumerTest "#disconnect", ({consumer, client, done}) ->
+    client.addEventListener("close", done)
+    consumer.disconnect()