From 0ce0cf0c04b53ee6c7038d8912dd1ed433f7935f Mon Sep 17 00:00:00 2001 From: Pratik Naik Date: Tue, 20 Oct 2015 17:17:18 -0500 Subject: [PATCH] Allow rejecting subscriptions from the channel --- lib/action_cable/channel/base.rb | 30 ++++++++++++++++--- lib/action_cable/connection/base.rb | 4 +-- lib/action_cable/connection/subscriptions.rb | 8 +++-- lib/assets/javascripts/cable.coffee | 1 + .../javascripts/cable/connection.coffee | 2 ++ .../javascripts/cable/subscriptions.coffee | 15 ++++++++-- test/channel/rejection_test.rb | 25 ++++++++++++++++ 7 files changed, 75 insertions(+), 10 deletions(-) create mode 100644 test/channel/rejection_test.rb diff --git a/lib/action_cable/channel/base.rb b/lib/action_cable/channel/base.rb index 221730dbc4..31b8dece4a 100644 --- a/lib/action_cable/channel/base.rb +++ b/lib/action_cable/channel/base.rb @@ -74,11 +74,12 @@ class Base include Broadcasting SUBSCRIPTION_CONFIRMATION_INTERNAL_MESSAGE = 'confirm_subscription'.freeze + SUBSCRIPTION_REJECTION_INTERNAL_MESSAGE = 'reject_subscription'.freeze on_subscribe :subscribed on_unsubscribe :unsubscribed - attr_reader :params, :connection + attr_reader :params, :connection, :identifier delegate :logger, to: :connection class << self @@ -170,8 +171,6 @@ def transmit(data, via: nil) connection.transmit ActiveSupport::JSON.encode(identifier: @identifier, message: data) end - - protected def defer_subscription_confirmation! @defer_subscription_confirmation = true end @@ -184,6 +183,14 @@ def subscription_confirmation_sent? @subscription_confirmation_sent end + def reject! + @reject_subscription = true + end + + def subscription_rejected? + @reject_subscription + end + private def delegate_connection_identifiers connection.identifiers.each do |identifier| @@ -196,7 +203,12 @@ def delegate_connection_identifiers def subscribe_to_channel run_subscribe_callbacks - transmit_subscription_confirmation unless defer_subscription_confirmation? + + if subscription_rejected? + reject_subscription + else + transmit_subscription_confirmation unless defer_subscription_confirmation? + end end @@ -243,6 +255,16 @@ def transmit_subscription_confirmation end end + def reject_subscription + connection.subscriptions.remove_subscription self + transmit_subscription_rejection + end + + def transmit_subscription_rejection + logger.info "#{self.class.name} is transmitting the subscription rejection" + connection.transmit ActiveSupport::JSON.encode(identifier: @identifier, type: SUBSCRIPTION_REJECTION_INTERNAL_MESSAGE) + end + end end end diff --git a/lib/action_cable/connection/base.rb b/lib/action_cable/connection/base.rb index 9f74226f98..b3de4dd4a9 100644 --- a/lib/action_cable/connection/base.rb +++ b/lib/action_cable/connection/base.rb @@ -48,7 +48,7 @@ class Base include InternalChannel include Authorization - attr_reader :server, :env + attr_reader :server, :env, :subscriptions delegate :worker_pool, :pubsub, to: :server attr_reader :logger @@ -140,7 +140,7 @@ def cookies private attr_reader :websocket - attr_reader :subscriptions, :message_buffer + attr_reader :message_buffer def on_open connect if respond_to?(:connect) diff --git a/lib/action_cable/connection/subscriptions.rb b/lib/action_cable/connection/subscriptions.rb index 229be2a316..6199db4898 100644 --- a/lib/action_cable/connection/subscriptions.rb +++ b/lib/action_cable/connection/subscriptions.rb @@ -37,8 +37,12 @@ def add(data) def remove(data) logger.info "Unsubscribing from channel: #{data['identifier']}" - subscriptions[data['identifier']].unsubscribe_from_channel - subscriptions.delete(data['identifier']) + remove_subscription subscriptions[data['identifier']] + end + + def remove_subscription(subscription) + subscription.unsubscribe_from_channel + subscriptions.delete(subscription.identifier) end def perform_action(data) diff --git a/lib/assets/javascripts/cable.coffee b/lib/assets/javascripts/cable.coffee index 476d90ef72..fca5e095b5 100644 --- a/lib/assets/javascripts/cable.coffee +++ b/lib/assets/javascripts/cable.coffee @@ -5,6 +5,7 @@ PING_IDENTIFIER: "_ping" INTERNAL_MESSAGES: SUBSCRIPTION_CONFIRMATION: 'confirm_subscription' + SUBSCRIPTION_REJECTION: 'reject_subscription' createConsumer: (url) -> new Cable.Consumer url diff --git a/lib/assets/javascripts/cable/connection.coffee b/lib/assets/javascripts/cable/connection.coffee index 33159130c7..9de3cc0be4 100644 --- a/lib/assets/javascripts/cable/connection.coffee +++ b/lib/assets/javascripts/cable/connection.coffee @@ -58,6 +58,8 @@ class Cable.Connection switch type when Cable.INTERNAL_MESSAGES.SUBSCRIPTION_CONFIRMATION @consumer.subscriptions.notify(identifier, "connected") + when Cable.INTERNAL_MESSAGES.SUBSCRIPTION_REJECTION + @consumer.subscriptions.rejectSubscription(identifier) else @consumer.subscriptions.notify(identifier, "received", message) diff --git a/lib/assets/javascripts/cable/subscriptions.coffee b/lib/assets/javascripts/cable/subscriptions.coffee index 4efb384ee2..497fcb074e 100644 --- a/lib/assets/javascripts/cable/subscriptions.coffee +++ b/lib/assets/javascripts/cable/subscriptions.coffee @@ -27,11 +27,22 @@ class Cable.Subscriptions for subscription in @subscriptions @sendCommand(subscription, "subscribe") + rejectSubscription: (identifier) -> + subscriptions = @findAll(identifier) + + for subscription in subscriptions + @removeSubscription(subscription) + @notify(subscription, "rejected") + remove: (subscription) -> - @subscriptions = (s for s in @subscriptions when s isnt subscription) + @removeSubscription(subscription) + unless @findAll(subscription.identifier).length @sendCommand(subscription, "unsubscribe") + removeSubscription: (subscription) -> + @subscriptions = (s for s in @subscriptions when s isnt subscription) + findAll: (identifier) -> s for s in @subscriptions when s.identifier is identifier @@ -48,7 +59,7 @@ class Cable.Subscriptions for subscription in subscriptions subscription[callbackName]?(args...) - if callbackName in ["initialized", "connected", "disconnected"] + if callbackName in ["initialized", "connected", "disconnected", "rejected"] {identifier} = subscription @record(notification: {identifier, callbackName, args}) diff --git a/test/channel/rejection_test.rb b/test/channel/rejection_test.rb new file mode 100644 index 0000000000..0e9725742c --- /dev/null +++ b/test/channel/rejection_test.rb @@ -0,0 +1,25 @@ +require 'test_helper' +require 'stubs/test_connection' +require 'stubs/room' + +class ActionCable::Channel::RejectionTest < ActiveSupport::TestCase + class SecretChannel < ActionCable::Channel::Base + def subscribed + reject! if params[:id] > 0 + end + end + + setup do + @user = User.new "lifo" + @connection = TestConnection.new(@user) + end + + test "subscription rejection" do + @connection.expects(:subscriptions).returns mock().tap { |m| m.expects(:remove_subscription).with instance_of(SecretChannel) } + @channel = SecretChannel.new @connection, "{id: 1}", { id: 1 } + + expected = ActiveSupport::JSON.encode "identifier" => "{id: 1}", "type" => "reject_subscription" + assert_equal expected, @connection.last_transmission + end + +end