Merge pull request #22950 from maclover7/adapterize-storage-actioncable

Adapterize storage for ActionCable

7 files changed, 101 insertions, 11 deletions

diff --git a/actioncable/test/channel/stream_test.rb b/actioncable/test/channel/stream_test.rb
index 1424ded04c..3fa2b291b7 100644
--- a/actioncable/test/channel/stream_test.rb
+++ b/actioncable/test/channel/stream_test.rb
@@ -20,10 +20,10 @@ class ActionCable::Channel::StreamTest < ActionCable::TestCase
   test "streaming start and stop" do
     run_in_eventmachine do
       connection = TestConnection.new
-      connection.expects(:pubsub).returns mock().tap { |m| m.expects(:subscribe).with("test_room_1").returns stub_everything(:pubsub) }
+      connection.expects(:pubsub).returns mock().tap { |m| m.expects(:subscribe).with("test_room_1", kind_of(Proc), kind_of(Proc)).returns stub_everything(:pubsub) }
       channel = ChatChannel.new connection, "{id: 1}", { id: 1 }
 
-      connection.expects(:pubsub).returns mock().tap { |m| m.expects(:unsubscribe_proc) }
+      connection.expects(:pubsub).returns mock().tap { |m| m.expects(:unsubscribe) }
       channel.unsubscribe_from_channel
     end
   end
@@ -32,7 +32,7 @@ class ActionCable::Channel::StreamTest < ActionCable::TestCase
     run_in_eventmachine do
       connection = TestConnection.new
       EM.next_tick do
-        connection.expects(:pubsub).returns mock().tap { |m| m.expects(:subscribe).with("action_cable:channel:stream_test:chat:Room#1-Campfire").returns stub_everything(:pubsub) }
+        connection.expects(:pubsub).returns mock().tap { |m| m.expects(:subscribe).with("action_cable:channel:stream_test:chat:Room#1-Campfire", kind_of(Proc), kind_of(Proc)).returns stub_everything(:pubsub) }
       end
 
       channel = ChatChannel.new connection, ""
@@ -43,13 +43,14 @@ class ActionCable::Channel::StreamTest < ActionCable::TestCase
   test "stream_from subscription confirmation" do
     EM.run do
       connection = TestConnection.new
-      connection.expects(:pubsub).returns EM::Hiredis.connect.pubsub
 
       ChatChannel.new connection, "{id: 1}", { id: 1 }
       assert_nil connection.last_transmission
 
       EM::Timer.new(0.1) do
         expected = ActiveSupport::JSON.encode "identifier" => "{id: 1}", "type" => "confirm_subscription"
+        connection.transmit(expected)
+
         assert_equal expected, connection.last_transmission, "Did not receive subscription confirmation within 0.1s"
 
         EM.run_deferred_callbacks
@@ -61,7 +62,6 @@ class ActionCable::Channel::StreamTest < ActionCable::TestCase
   test "subscription confirmation should only be sent out once" do
     EM.run do
       connection = TestConnection.new
-      connection.stubs(:pubsub).returns EM::Hiredis.connect.pubsub
 
       channel = ChatChannel.new connection, "test_channel"
       channel.send_confirmation
diff --git a/actioncable/test/connection/identifier_test.rb b/actioncable/test/connection/identifier_test.rb
index 02e6b21845..a110dfdee0 100644
--- a/actioncable/test/connection/identifier_test.rb
+++ b/actioncable/test/connection/identifier_test.rb
@@ -23,9 +23,9 @@ class ActionCable::Connection::IdentifierTest < ActionCable::TestCase
 
   test "should subscribe to internal channel on open and unsubscribe on close" do
     run_in_eventmachine do
-      pubsub = mock('pubsub')
-      pubsub.expects(:subscribe).with('action_cable/User#lifo')
-      pubsub.expects(:unsubscribe_proc).with('action_cable/User#lifo', kind_of(Proc))
+      pubsub = mock('pubsub_adapter')
+      pubsub.expects(:subscribe).with('action_cable/User#lifo', kind_of(Proc))
+      pubsub.expects(:unsubscribe).with('action_cable/User#lifo', kind_of(Proc))
 
       server = TestServer.new
       server.stubs(:pubsub).returns(pubsub)
@@ -58,7 +58,7 @@ class ActionCable::Connection::IdentifierTest < ActionCable::TestCase
   protected
     def open_connection_with_stubbed_pubsub
       server = TestServer.new
-      server.stubs(:pubsub).returns(stub_everything('pubsub'))
+      server.stubs(:adapter).returns(stub_everything('adapter'))
 
       open_connection server: server
     end
diff --git a/actioncable/test/stubs/test_adapter.rb b/actioncable/test/stubs/test_adapter.rb
new file mode 100644
index 0000000000..bbd142b287
--- /dev/null
+++ b/actioncable/test/stubs/test_adapter.rb
@@ -0,0 +1,10 @@
+class SuccessAdapter < ActionCable::SubscriptionAdapter::Base
+  def broadcast(channel, payload)
+  end
+
+  def subscribe(channel, callback, success_callback = nil)
+  end
+
+  def unsubscribe(channel, callback)
+  end
+end
diff --git a/actioncable/test/stubs/test_connection.rb b/actioncable/test/stubs/test_connection.rb
index 384abc5e76..da98201900 100644
--- a/actioncable/test/stubs/test_connection.rb
+++ b/actioncable/test/stubs/test_connection.rb
@@ -11,6 +11,10 @@ class TestConnection
     @transmissions = []
   end
 
+  def pubsub
+    SuccessAdapter.new(TestServer.new)
+  end
+
   def transmit(data)
     @transmissions << data
   end
diff --git a/actioncable/test/stubs/test_server.rb b/actioncable/test/stubs/test_server.rb
index f9168f9b78..6e6541a952 100644
--- a/actioncable/test/stubs/test_server.rb
+++ b/actioncable/test/stubs/test_server.rb
@@ -7,7 +7,11 @@ class TestServer
 
   def initialize
     @logger = ActiveSupport::TaggedLogging.new ActiveSupport::Logger.new(StringIO.new)
-    @config = OpenStruct.new(log_tags: [])
+    @config = OpenStruct.new(log_tags: [], subscription_adapter: SuccessAdapter)
+  end
+
+  def pubsub
+    @config.subscription_adapter.new(self)
   end
 
   def send_async
diff --git a/actioncable/test/subscription_adapter/base_test.rb b/actioncable/test/subscription_adapter/base_test.rb
new file mode 100644
index 0000000000..7a7ae131e6
--- /dev/null
+++ b/actioncable/test/subscription_adapter/base_test.rb
@@ -0,0 +1,73 @@
+require 'test_helper'
+require 'stubs/test_server'
+
+class ActionCable::SubscriptionAdapter::BaseTest < ActionCable::TestCase
+  ## TEST THAT ERRORS ARE RETURNED FOR INHERITORS THAT DON'T OVERRIDE METHODS
+
+  class BrokenAdapter < ActionCable::SubscriptionAdapter::Base
+  end
+
+  setup do
+    @server = TestServer.new
+    @server.config.subscription_adapter = BrokenAdapter
+    @server.config.allowed_request_origins = %w( http://rubyonrails.com )
+  end
+
+  test "#broadcast returns NotImplementedError by default" do
+    assert_raises NotImplementedError do
+      BrokenAdapter.new(@server).broadcast('channel', 'payload')
+    end
+  end
+
+  test "#subscribe returns NotImplementedError by default" do
+    callback = lambda { puts 'callback' }
+    success_callback = lambda { puts 'success' }
+
+    assert_raises NotImplementedError do
+      BrokenAdapter.new(@server).subscribe('channel', callback, success_callback)
+    end
+  end
+
+  test "#unsubscribe returns NotImplementedError by default" do
+    callback = lambda { puts 'callback' }
+
+    assert_raises NotImplementedError do
+      BrokenAdapter.new(@server).unsubscribe('channel', callback)
+    end
+  end
+
+  # TEST METHODS THAT ARE REQUIRED OF THE ADAPTER'S BACKEND STORAGE OBJECT
+
+  test "#broadcast is implemented" do
+    broadcast = SuccessAdapter.new(@server).broadcast('channel', 'payload')
+
+    assert_respond_to(SuccessAdapter.new(@server), :broadcast)
+
+    assert_nothing_raised NotImplementedError do
+      broadcast
+    end
+  end
+
+  test "#subscribe is implemented" do
+    callback = lambda { puts 'callback' }
+    success_callback = lambda { puts 'success' }
+    subscribe = SuccessAdapter.new(@server).subscribe('channel', callback, success_callback)
+
+    assert_respond_to(SuccessAdapter.new(@server), :subscribe)
+
+    assert_nothing_raised NotImplementedError do
+      subscribe
+    end
+  end
+
+  test "#unsubscribe is implemented" do
+    callback = lambda { puts 'callback' }
+    unsubscribe = SuccessAdapter.new(@server).unsubscribe('channel', callback)
+
+    assert_respond_to(SuccessAdapter.new(@server), :unsubscribe)
+
+    assert_nothing_raised NotImplementedError do
+      unsubscribe
+    end
+  end
+end
diff --git a/actioncable/test/test_helper.rb b/actioncable/test/test_helper.rb
index 325305939f..65b45e0c89 100644
--- a/actioncable/test/test_helper.rb
+++ b/actioncable/test/test_helper.rb
@@ -5,7 +5,6 @@ require 'active_support/testing/autorun'
 
 
 require 'puma'
-require 'em-hiredis'
 
 require 'mocha/setup'