actioncable 5.0.1 → 6.1.3

data/lib/action_cable/server/broadcasting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Server
     # Broadcasting is how other parts of your application can send messages to a channel's subscribers. As explained in Channel, most of the time, these
@@ -38,9 +40,13 @@ module ActionCable
           end
 
           def broadcast(message)
-            server.logger.info "[ActionCable] Broadcasting to #{broadcasting}: #{message.inspect}"
-            encoded = coder ? coder.encode(message) : message
-            server.pubsub.broadcast broadcasting, encoded
+            server.logger.debug { "[ActionCable] Broadcasting to #{broadcasting}: #{message.inspect}" }
+
+            payload = { broadcasting: broadcasting, message: message, coder: coder }
+            ActiveSupport::Notifications.instrument("broadcast.action_cable", payload) do
+              encoded = coder ? coder.encode(message) : message
+              server.pubsub.broadcast broadcasting, encoded
+            end
           end
         end
     end

data/lib/action_cable/server/configuration.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Server
     # An instance of this configuration object is available via ActionCable.server.config, which allows you to tweak Action Cable configuration
     # in a Rails config initializer.
     class Configuration
       attr_accessor :logger, :log_tags
-      attr_accessor :use_faye, :connection_class, :worker_pool_size
+      attr_accessor :connection_class, :worker_pool_size
       attr_accessor :disable_request_forgery_protection, :allowed_request_origins, :allow_same_origin_as_host
       attr_accessor :cable, :url, :mount_path
 
@@ -22,36 +24,33 @@ module ActionCable
       # If the adapter cannot be found, this will default to the Redis adapter.
       # Also makes sure proper dependencies are required.
       def pubsub_adapter
-        adapter = (cable.fetch('adapter') { 'redis' })
+        adapter = (cable.fetch("adapter") { "redis" })
+
+        # Require the adapter itself and give useful feedback about
+        #   1. Missing adapter gems and
+        #   2. Adapter gems' missing dependencies.
         path_to_adapter = "action_cable/subscription_adapter/#{adapter}"
         begin
           require path_to_adapter
-        rescue Gem::LoadError => e
-          raise Gem::LoadError, "Specified '#{adapter}' for Action Cable pubsub adapter, but the gem is not loaded. Add `gem '#{e.name}'` to your Gemfile (and ensure its version is at the minimum required by Action Cable)."
         rescue LoadError => e
-          raise LoadError, "Could not load '#{path_to_adapter}'. Make sure that the adapter in config/cable.yml is valid. If you use an adapter other than 'postgresql' or 'redis' add the necessary adapter gem to the Gemfile.", e.backtrace
+          # We couldn't require the adapter itself. Raise an exception that
+          # points out config typos and missing gems.
+          if e.path == path_to_adapter
+            # We can assume that a non-builtin adapter was specified, so it's
+            # either misspelled or missing from Gemfile.
+            raise e.class, "Could not load the '#{adapter}' Action Cable pubsub adapter. Ensure that the adapter is spelled correctly in config/cable.yml and that you've added the necessary adapter gem to your Gemfile.", e.backtrace
+
+          # Bubbled up from the adapter require. Prefix the exception message
+          # with some guidance about how to address it and reraise.
+          else
+            raise e.class, "Error loading the '#{adapter}' Action Cable pubsub adapter. Missing a gem it depends on? #{e.message}", e.backtrace
+          end
         end
 
         adapter = adapter.camelize
-        adapter = 'PostgreSQL' if adapter == 'Postgresql'
+        adapter = "PostgreSQL" if adapter == "Postgresql"
         "ActionCable::SubscriptionAdapter::#{adapter}".constantize
       end
-
-      def event_loop_class
-        if use_faye
-          ActionCable::Connection::FayeEventLoop
-        else
-          ActionCable::Connection::StreamEventLoop
-        end
-      end
-
-      def client_socket_class
-        if use_faye
-          ActionCable::Connection::FayeClientSocket
-        else
-          ActionCable::Connection::ClientSocket
-        end
-      end
     end
   end
 end

data/lib/action_cable/server/connections.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Server
     # Collection class for all the connections that have been established on this specific server. Remember, usually you'll run many Action Cable servers, so

data/lib/action_cable/server/worker.rb

@@ -1,6 +1,9 @@
-require 'active_support/callbacks'
-require 'active_support/core_ext/module/attribute_accessors_per_thread'
-require 'concurrent'
+# frozen_string_literal: true
+
+require "active_support/callbacks"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
+require "action_cable/server/worker/active_record_connection_management"
+require "concurrent"
 
 module ActionCable
   module Server
@@ -54,19 +57,16 @@ module ActionCable
 
       def invoke(receiver, method, *args, connection:, &block)
         work(connection) do
-          begin
-            receiver.send method, *args, &block
-          rescue Exception => e
-            logger.error "There was an exception - #{e.class}(#{e.message})"
-            logger.error e.backtrace.join("\n")
+          receiver.send method, *args, &block
+        rescue Exception => e
+          logger.error "There was an exception - #{e.class}(#{e.message})"
+          logger.error e.backtrace.join("\n")
 
-            receiver.handle_exception if receiver.respond_to?(:handle_exception)
-          end
+          receiver.handle_exception if receiver.respond_to?(:handle_exception)
         end
       end
 
       private
-
         def logger
           ActionCable.server.logger
         end

data/lib/action_cable/server/worker/active_record_connection_management.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Server
     class Worker

data/lib/action_cable/subscription_adapter.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module ActionCable
   module SubscriptionAdapter
     extend ActiveSupport::Autoload
 
     autoload :Base
+    autoload :Test
     autoload :SubscriberMap
+    autoload :ChannelPrefix
   end
 end

data/lib/action_cable/subscription_adapter/async.rb

@@ -1,4 +1,6 @@
-require 'action_cable/subscription_adapter/inline'
+# frozen_string_literal: true
+
+require "action_cable/subscription_adapter/inline"
 
 module ActionCable
   module SubscriptionAdapter

data/lib/action_cable/subscription_adapter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module SubscriptionAdapter
     class Base
@@ -23,6 +25,10 @@ module ActionCable
       def shutdown
         raise NotImplementedError
       end
+
+      def identifier
+        @server.config.cable[:id] ||= "ActionCable-PID-#{$$}"
+      end
     end
   end
 end

data/lib/action_cable/subscription_adapter/channel_prefix.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ActionCable
+  module SubscriptionAdapter
+    module ChannelPrefix # :nodoc:
+      def broadcast(channel, payload)
+        channel = channel_with_prefix(channel)
+        super
+      end
+
+      def subscribe(channel, callback, success_callback = nil)
+        channel = channel_with_prefix(channel)
+        super
+      end
+
+      def unsubscribe(channel, callback)
+        channel = channel_with_prefix(channel)
+        super
+      end
+
+      private
+        # Returns the channel name, including channel_prefix specified in cable.yml
+        def channel_with_prefix(channel)
+          [@server.config.cable[:channel_prefix], channel].compact.join(":")
+        end
+    end
+  end
+end

data/lib/action_cable/subscription_adapter/inline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module SubscriptionAdapter
     class Inline < Base # :nodoc:

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -1,50 +1,76 @@
-gem 'pg', '~> 0.18'
-require 'pg'
-require 'thread'
+# frozen_string_literal: true
+
+gem "pg", "~> 1.1"
+require "pg"
+require "thread"
+require "digest/sha1"
 
 module ActionCable
   module SubscriptionAdapter
     class PostgreSQL < Base # :nodoc:
+      prepend ChannelPrefix
+
       def initialize(*)
         super
         @listener = nil
       end
 
       def broadcast(channel, payload)
-        with_connection do |pg_conn|
-          pg_conn.exec("NOTIFY #{pg_conn.escape_identifier(channel)}, '#{pg_conn.escape_string(payload)}'")
+        with_broadcast_connection do |pg_conn|
+          pg_conn.exec("NOTIFY #{pg_conn.escape_identifier(channel_identifier(channel))}, '#{pg_conn.escape_string(payload)}'")
         end
       end
 
       def subscribe(channel, callback, success_callback = nil)
-        listener.add_subscriber(channel, callback, success_callback)
+        listener.add_subscriber(channel_identifier(channel), callback, success_callback)
       end
 
       def unsubscribe(channel, callback)
-        listener.remove_subscriber(channel, callback)
+        listener.remove_subscriber(channel_identifier(channel), callback)
       end
 
       def shutdown
         listener.shutdown
       end
 
-      def with_connection(&block) # :nodoc:
-        ActiveRecord::Base.connection_pool.with_connection do |ar_conn|
-          pg_conn = ar_conn.raw_connection
+      def with_subscriptions_connection(&block) # :nodoc:
+        ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
+          # Action Cable is taking ownership over this database connection, and
+          # will perform the necessary cleanup tasks
+          ActiveRecord::Base.connection_pool.remove(conn)
+        end
+        pg_conn = ar_conn.raw_connection
 
-          unless pg_conn.is_a?(PG::Connection)
-            raise 'ActiveRecord database must be Postgres in order to use the Postgres ActionCable storage adapter'
-          end
+        verify!(pg_conn)
+        pg_conn.exec("SET application_name = #{pg_conn.escape_identifier(identifier)}")
+        yield pg_conn
+      ensure
+        ar_conn.disconnect!
+      end
 
+      def with_broadcast_connection(&block) # :nodoc:
+        ActiveRecord::Base.connection_pool.with_connection do |ar_conn|
+          pg_conn = ar_conn.raw_connection
+          verify!(pg_conn)
           yield pg_conn
         end
       end
 
       private
+        def channel_identifier(channel)
+          channel.size > 63 ? Digest::SHA1.hexdigest(channel) : channel
+        end
+
         def listener
           @listener || @server.mutex.synchronize { @listener ||= Listener.new(self, @server.event_loop) }
         end
 
+        def verify!(pg_conn)
+          unless pg_conn.is_a?(PG::Connection)
+            raise "The Active Record database must be PostgreSQL in order to use the PostgreSQL Action Cable storage adapter"
+          end
+        end
+
         class Listener < SubscriberMap
           def initialize(adapter, event_loop)
             super()
@@ -60,7 +86,7 @@ module ActionCable
           end
 
           def listen
-            @adapter.with_connection do |pg_conn|
+            @adapter.with_subscriptions_connection do |pg_conn|
               catch :shutdown do
                 loop do
                   until @queue.empty?

data/lib/action_cable/subscription_adapter/redis.rb

@@ -1,14 +1,22 @@
-require 'thread'
+# frozen_string_literal: true
 
-gem 'redis', '~> 3.0'
-require 'redis'
+require "thread"
+
+gem "redis", ">= 3", "< 5"
+require "redis"
+
+require "active_support/core_ext/hash/except"
 
 module ActionCable
   module SubscriptionAdapter
     class Redis < Base # :nodoc:
-      # Overwrite this factory method for redis connections if you want to use a different Redis library than Redis.
+      prepend ChannelPrefix
+
+      # Overwrite this factory method for Redis connections if you want to use a different Redis library than the redis gem.
       # This is needed, for example, when using Makara proxies for distributed Redis.
-      cattr_accessor(:redis_connector) { ->(config) { ::Redis.new(url: config[:url]) } }
+      cattr_accessor :redis_connector, default: ->(config) do
+        ::Redis.new(config.except(:adapter, :channel_prefix))
+      end
 
       def initialize(*)
         super
@@ -48,7 +56,7 @@ module ActionCable
         end
 
         def redis_connection
-          self.class.redis_connector.call(@server.config.cable)
+          self.class.redis_connector.call(@server.config.cable.merge(id: identifier))
         end
 
         class Listener < SubscriberMap
@@ -70,9 +78,9 @@ module ActionCable
 
           def listen(conn)
             conn.without_reconnect do
-              original_client = conn.client
+              original_client = conn.respond_to?(:_client) ? conn._client : conn.client
 
-              conn.subscribe('_action_cable_internal') do |on|
+              conn.subscribe("_action_cable_internal") do |on|
                 on.subscribe do |chan, count|
                   @subscription_lock.synchronize do
                     if count == 1
@@ -111,7 +119,7 @@ module ActionCable
               return if @thread.nil?
 
               when_connected do
-                send_command('unsubscribe')
+                send_command("unsubscribe")
                 @raw_client = nil
               end
             end
@@ -123,13 +131,13 @@ module ActionCable
             @subscription_lock.synchronize do
               ensure_listener_running
               @subscribe_callbacks[channel] << on_success
-              when_connected { send_command('subscribe', channel) }
+              when_connected { send_command("subscribe", channel) }
             end
           end
 
           def remove_channel(channel)
             @subscription_lock.synchronize do
-              when_connected { send_command('unsubscribe', channel) }
+              when_connected { send_command("unsubscribe", channel) }
             end
           end
 

data/lib/action_cable/subscription_adapter/subscriber_map.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module ActionCable
   module SubscriptionAdapter
     class SubscriberMap
       def initialize
-        @subscribers = Hash.new { |h,k| h[k] = [] }
+        @subscribers = Hash.new { |h, k| h[k] = [] }
         @sync = Mutex.new
       end
 

data/lib/action_cable/subscription_adapter/test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "async"
+
+module ActionCable
+  module SubscriptionAdapter
+    # == Test adapter for Action Cable
+    #
+    # The test adapter should be used only in testing. Along with
+    # <tt>ActionCable::TestHelper</tt> it makes a great tool to test your Rails application.
+    #
+    # To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file.
+    #
+    # NOTE: Test adapter extends the <tt>ActionCable::SubscriptionsAdapter::Async</tt> adapter,
+    # so it could be used in system tests too.
+    class Test < Async
+      def broadcast(channel, payload)
+        broadcasts(channel) << payload
+        super
+      end
+
+      def broadcasts(channel)
+        channels_data[channel] ||= []
+      end
+
+      def clear_messages(channel)
+        channels_data[channel] = []
+      end
+
+      def clear
+        @channels_data = nil
+      end
+
+      private
+        def channels_data
+          @channels_data ||= {}
+        end
+    end
+  end
+end