actioncable 7.1.3.4 → 7.2.1

data/lib/action_cable/connection/tagged_logger_proxy.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module Connection
-    # = Action Cable \Connection \TaggedLoggerProxy
+    # # Action Cable Connection TaggedLoggerProxy
     #
-    # Allows the use of per-connection tags against the server logger. This wouldn't work using the traditional
-    # ActiveSupport::TaggedLogging enhanced Rails.logger, as that logger will reset the tags between requests.
-    # The connection is long-lived, so it needs its own set of tags for its independent duration.
+    # Allows the use of per-connection tags against the server logger. This wouldn't
+    # work using the traditional ActiveSupport::TaggedLogging enhanced Rails.logger,
+    # as that logger will reset the tags between requests. The connection is
+    # long-lived, so it needs its own set of tags for its independent duration.
     class TaggedLoggerProxy
       attr_reader :tags
 

data/lib/action_cable/connection/test_case.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support"
 require "active_support/test_case"
 require "active_support/core_ext/hash/indifferent_access"
@@ -18,25 +20,33 @@ module ActionCable
     end
 
     module Assertions
-      # Asserts that the connection is rejected (via +reject_unauthorized_connection+).
+      # Asserts that the connection is rejected (via
+      # `reject_unauthorized_connection`).
       #
-      #   # Asserts that connection without user_id fails
-      #   assert_reject_connection { connect params: { user_id: '' } }
+      #     # Asserts that connection without user_id fails
+      #     assert_reject_connection { connect params: { user_id: '' } }
       def assert_reject_connection(&block)
         assert_raises(Authorization::UnauthorizedError, "Expected to reject connection but no rejection was made", &block)
       end
     end
 
-    # We don't want to use the whole "encryption stack" for connection
-    # unit-tests, but we want to make sure that users test against the correct types
-    # of cookies (i.e. signed or encrypted or plain)
-    class TestCookieJar < ActiveSupport::HashWithIndifferentAccess
+    class TestCookies < ActiveSupport::HashWithIndifferentAccess # :nodoc:
+      def []=(name, options)
+        value = options.is_a?(Hash) ? options.symbolize_keys[:value] : options
+        super(name, value)
+      end
+    end
+
+    # We don't want to use the whole "encryption stack" for connection unit-tests,
+    # but we want to make sure that users test against the correct types of cookies
+    # (i.e. signed or encrypted or plain)
+    class TestCookieJar < TestCookies
       def signed
-        self[:signed] ||= {}.with_indifferent_access
+        @signed ||= TestCookies.new
       end
 
       def encrypted
-        self[:encrypted] ||= {}.with_indifferent_access
+        @encrypted ||= TestCookies.new
       end
     end
 
@@ -56,77 +66,77 @@ module ActionCable
       end
     end
 
-    # = Action Cable \Connection \TestCase
+    # # Action Cable Connection TestCase
     #
     # Unit test Action Cable connections.
     #
-    # Useful to check whether a connection's +identified_by+ gets assigned properly
+    # Useful to check whether a connection's `identified_by` gets assigned properly
     # and that any improper connection requests are rejected.
     #
-    # == Basic example
+    # ## Basic example
     #
     # Unit tests are written as follows:
     #
-    # 1. Simulate a connection attempt by calling +connect+.
-    # 2. Assert state, e.g. identifiers, has been assigned.
+    # 1.  Simulate a connection attempt by calling `connect`.
+    # 2.  Assert state, e.g. identifiers, has been assigned.
     #
     #
-    #   class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
-    #     def test_connects_with_proper_cookie
-    #       # Simulate the connection request with a cookie.
-    #       cookies["user_id"] = users(:john).id
+    #     class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
+    #       def test_connects_with_proper_cookie
+    #         # Simulate the connection request with a cookie.
+    #         cookies["user_id"] = users(:john).id
     #
-    #       connect
+    #         connect
     #
-    #       # Assert the connection identifier matches the fixture.
-    #       assert_equal users(:john).id, connection.user.id
-    #     end
+    #         # Assert the connection identifier matches the fixture.
+    #         assert_equal users(:john).id, connection.user.id
+    #       end
     #
-    #     def test_rejects_connection_without_proper_cookie
-    #       assert_reject_connection { connect }
+    #       def test_rejects_connection_without_proper_cookie
+    #         assert_reject_connection { connect }
+    #       end
     #     end
-    #   end
     #
-    # +connect+ accepts additional information about the HTTP request with the
-    # +params+, +headers+, +session+, and Rack +env+ options.
+    # `connect` accepts additional information about the HTTP request with the
+    # `params`, `headers`, `session`, and Rack `env` options.
     #
-    #   def test_connect_with_headers_and_query_string
-    #     connect params: { user_id: 1 }, headers: { "X-API-TOKEN" => "secret-my" }
+    #     def test_connect_with_headers_and_query_string
+    #       connect params: { user_id: 1 }, headers: { "X-API-TOKEN" => "secret-my" }
     #
-    #     assert_equal "1", connection.user.id
-    #     assert_equal "secret-my", connection.token
-    #   end
+    #       assert_equal "1", connection.user.id
+    #       assert_equal "secret-my", connection.token
+    #     end
     #
-    #   def test_connect_with_params
-    #     connect params: { user_id: 1 }
+    #     def test_connect_with_params
+    #       connect params: { user_id: 1 }
     #
-    #     assert_equal "1", connection.user.id
-    #   end
+    #       assert_equal "1", connection.user.id
+    #     end
     #
     # You can also set up the correct cookies before the connection request:
     #
-    #   def test_connect_with_cookies
-    #     # Plain cookies:
-    #     cookies["user_id"] = 1
+    #     def test_connect_with_cookies
+    #       # Plain cookies:
+    #       cookies["user_id"] = 1
     #
-    #     # Or signed/encrypted:
-    #     # cookies.signed["user_id"] = 1
-    #     # cookies.encrypted["user_id"] = 1
+    #       # Or signed/encrypted:
+    #       # cookies.signed["user_id"] = 1
+    #       # cookies.encrypted["user_id"] = 1
     #
-    #     connect
+    #       connect
     #
-    #     assert_equal "1", connection.user_id
-    #   end
+    #       assert_equal "1", connection.user_id
+    #     end
     #
-    # == \Connection is automatically inferred
+    # ## Connection is automatically inferred
     #
-    # ActionCable::Connection::TestCase will automatically infer the connection under test
-    # from the test class name. If the channel cannot be inferred from the test
-    # class name, you can explicitly set it with +tests+.
+    # ActionCable::Connection::TestCase will automatically infer the connection
+    # under test from the test class name. If the channel cannot be inferred from
+    # the test class name, you can explicitly set it with `tests`.
     #
-    #   class ConnectionTest < ActionCable::Connection::TestCase
-    #     tests ApplicationCable::Connection
-    #   end
+    #     class ConnectionTest < ActionCable::Connection::TestCase
+    #       tests ApplicationCable::Connection
+    #     end
     #
     class TestCase < ActiveSupport::TestCase
       module Behavior
@@ -178,10 +188,10 @@ module ActionCable
         #
         # Accepts request path as the first argument and the following request options:
         #
-        # - params – URL parameters (Hash)
-        # - headers – request headers (Hash)
-        # - session – session data (Hash)
-        # - env – additional Rack env configuration (Hash)
+        # *   params – URL parameters (Hash)
+        # *   headers – request headers (Hash)
+        # *   session – session data (Hash)
+        # *   env – additional Rack env configuration (Hash)
         def connect(path = ActionCable.server.config.mount_path, **request_params)
           path ||= DEFAULT_PATH
 

data/lib/action_cable/connection/web_socket.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "websocket/driver"
 
 module ActionCable
   module Connection
-    # = Action Cable \Connection \WebSocket
+    # # Action Cable Connection WebSocket
     #
     # Wrap the real socket to minimize the externally-presented API
     class WebSocket # :nodoc:
@@ -17,23 +19,23 @@ module ActionCable
       end
 
       def alive?
-        websocket && websocket.alive?
+        websocket&.alive?
       end
 
-      def transmit(data)
-        websocket.transmit data
+      def transmit(...)
+        websocket&.transmit(...)
       end
 
-      def close
-        websocket.close
+      def close(...)
+        websocket&.close(...)
       end
 
       def protocol
-        websocket.protocol
+        websocket&.protocol
       end
 
       def rack_response
-        websocket.rack_response
+        websocket&.rack_response
       end
 
       private

data/lib/action_cable/deprecator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   def self.deprecator # :nodoc:
     @deprecator ||= ActiveSupport::Deprecation.new

data/lib/action_cable/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rails"
 require "action_cable"
 require "active_support/core_ext/hash/indifferent_access"
@@ -72,9 +74,9 @@ module ActionCable
       ActiveSupport.on_load(:action_cable) do
         ActionCable::Server::Worker.set_callback :work, :around, prepend: true do |_, inner|
           app.executor.wrap(source: "application.action_cable") do
-            # If we took a while to get the lock, we may have been halted
-            # in the meantime. As we haven't started doing any real work
-            # yet, we should pretend that we never made it off the queue.
+            # If we took a while to get the lock, we may have been halted in the meantime.
+            # As we haven't started doing any real work yet, we should pretend that we never
+            # made it off the queue.
             unless stopping?
               inner.call
             end

data/lib/action_cable/gem_version.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
-  # Returns the currently loaded version of Action Cable as a +Gem::Version+.
+  # Returns the currently loaded version of Action Cable as a `Gem::Version`.
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
 
   module VERSION
     MAJOR = 7
-    MINOR = 1
-    TINY  = 3
-    PRE   = "4"
+    MINOR = 2
+    TINY  = 1
+    PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_cable/helpers/action_cable_helper.rb

@@ -1,35 +1,37 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module Helpers
     module ActionCableHelper
-      # Returns an "action-cable-url" meta tag with the value of the URL specified in your
-      # configuration. Ensure this is above your JavaScript tag:
+      # Returns an "action-cable-url" meta tag with the value of the URL specified in
+      # your configuration. Ensure this is above your JavaScript tag:
       #
-      #   <head>
-      #     <%= action_cable_meta_tag %>
-      #     <%= javascript_include_tag 'application', 'data-turbo-track' => 'reload' %>
-      #   </head>
+      #     <head>
+      #       <%= action_cable_meta_tag %>
+      #       <%= javascript_include_tag 'application', 'data-turbo-track' => 'reload' %>
+      #     </head>
       #
-      # This is then used by Action Cable to determine the URL of your WebSocket server.
-      # Your JavaScript can then connect to the server without needing to specify the
-      # URL directly:
+      # This is then used by Action Cable to determine the URL of your WebSocket
+      # server. Your JavaScript can then connect to the server without needing to
+      # specify the URL directly:
       #
-      #   import Cable from "@rails/actioncable"
-      #   window.Cable = Cable
-      #   window.App = {}
-      #   App.cable = Cable.createConsumer()
+      #     import Cable from "@rails/actioncable"
+      #     window.Cable = Cable
+      #     window.App = {}
+      #     App.cable = Cable.createConsumer()
       #
       # Make sure to specify the correct server location in each of your environment
       # config files:
       #
-      #   config.action_cable.mount_path = "/cable123"
-      #   <%= action_cable_meta_tag %> would render:
-      #   => <meta name="action-cable-url" content="/cable123" />
+      #     config.action_cable.mount_path = "/cable123"
+      #     <%= action_cable_meta_tag %> would render:
+      #     => <meta name="action-cable-url" content="/cable123" />
       #
-      #   config.action_cable.url = "ws://actioncable.com"
-      #   <%= action_cable_meta_tag %> would render:
-      #   => <meta name="action-cable-url" content="ws://actioncable.com" />
+      #     config.action_cable.url = "ws://actioncable.com"
+      #     <%= action_cable_meta_tag %> would render:
+      #     => <meta name="action-cable-url" content="ws://actioncable.com" />
       #
       def action_cable_meta_tag
         tag "meta", name: "action-cable-url", content: (

data/lib/action_cable/remote_connections.rb

@@ -1,31 +1,33 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/module/redefine_method"
 
 module ActionCable
-  # = Action Cable Remote Connections
+  # # Action Cable Remote Connections
   #
   # If you need to disconnect a given connection, you can go through the
   # RemoteConnections. You can find the connections you're looking for by
   # searching for the identifier declared on the connection. For example:
   #
-  #   module ApplicationCable
-  #     class Connection < ActionCable::Connection::Base
-  #       identified_by :current_user
-  #       ....
+  #     module ApplicationCable
+  #       class Connection < ActionCable::Connection::Base
+  #         identified_by :current_user
+  #         ....
+  #       end
   #     end
-  #   end
   #
-  #   ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect
+  #     ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect
   #
-  # This will disconnect all the connections established for
-  # <tt>User.find(1)</tt>, across all servers running on all machines, because
-  # it uses the internal channel that all of these servers are subscribed to.
+  # This will disconnect all the connections established for `User.find(1)`,
+  # across all servers running on all machines, because it uses the internal
+  # channel that all of these servers are subscribed to.
   #
-  # By default, server sends a "disconnect" message with "reconnect" flag set to true.
-  # You can override it by specifying the +reconnect+ option:
+  # By default, server sends a "disconnect" message with "reconnect" flag set to
+  # true. You can override it by specifying the `reconnect` option:
   #
-  #   ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect(reconnect: false)
+  #     ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect(reconnect: false)
   class RemoteConnections
     attr_reader :server
 
@@ -38,10 +40,11 @@ module ActionCable
     end
 
     private
-      # = Action Cable Remote \Connection
+      # # Action Cable Remote Connection
       #
-      # Represents a single remote connection found via <tt>ActionCable.server.remote_connections.where(*)</tt>.
-      # Exists solely for the purpose of calling #disconnect on that connection.
+      # Represents a single remote connection found via
+      # `ActionCable.server.remote_connections.where(*)`. Exists solely for the
+      # purpose of calling #disconnect on that connection.
       class RemoteConnection
         class InvalidIdentifiersError < StandardError; end
 

data/lib/action_cable/server/base.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "monitor"
 
 module ActionCable
   module Server
-    # = Action Cable \Server \Base
+    # # Action Cable Server Base
     #
-    # A singleton ActionCable::Server instance is available via ActionCable.server. It's used by the Rack process that starts the Action Cable server, but
-    # is also used by the user to reach the RemoteConnections object, which is used for finding and disconnecting connections across all servers.
+    # A singleton ActionCable::Server instance is available via ActionCable.server.
+    # It's used by the Rack process that starts the Action Cable server, but is also
+    # used by the user to reach the RemoteConnections object, which is used for
+    # finding and disconnecting connections across all servers.
     #
-    # Also, this is the server instance used for broadcasting. See Broadcasting for more information.
+    # Also, this is the server instance used for broadcasting. See Broadcasting for
+    # more information.
     class Base
       include ActionCable::Server::Broadcasting
       include ActionCable::Server::Connections
@@ -36,7 +41,8 @@ module ActionCable
         config.connection_class.call.new(self, env).process
       end
 
-      # Disconnect all the connections identified by +identifiers+ on this server or any others via RemoteConnections.
+      # Disconnect all the connections identified by `identifiers` on this server or
+      # any others via RemoteConnections.
       def disconnect(identifiers)
         remote_connections.where(identifiers).disconnect
       end
@@ -66,17 +72,22 @@ module ActionCable
         @event_loop || @mutex.synchronize { @event_loop ||= ActionCable::Connection::StreamEventLoop.new }
       end
 
-      # The worker pool is where we run connection callbacks and channel actions. We do as little as possible on the server's main thread.
-      # The worker pool is an executor service that's backed by a pool of threads working from a task queue. The thread pool size maxes out
-      # at 4 worker threads by default. Tune the size yourself with <tt>config.action_cable.worker_pool_size</tt>.
+      # The worker pool is where we run connection callbacks and channel actions. We
+      # do as little as possible on the server's main thread. The worker pool is an
+      # executor service that's backed by a pool of threads working from a task queue.
+      # The thread pool size maxes out at 4 worker threads by default. Tune the size
+      # yourself with `config.action_cable.worker_pool_size`.
       #
-      # Using Active Record, Redis, etc within your channel actions means you'll get a separate connection from each thread in the worker pool.
-      # Plan your deployment accordingly: 5 servers each running 5 Puma workers each running an 8-thread worker pool means at least 200 database
-      # connections.
+      # Using Active Record, Redis, etc within your channel actions means you'll get a
+      # separate connection from each thread in the worker pool. Plan your deployment
+      # accordingly: 5 servers each running 5 Puma workers each running an 8-thread
+      # worker pool means at least 200 database connections.
       #
-      # Also, ensure that your database connection pool size is as least as large as your worker pool size. Otherwise, workers may oversubscribe
-      # the database connection pool and block while they wait for other workers to release their connections. Use a smaller worker pool or a larger
-      # database connection pool instead.
+      # Also, ensure that your database connection pool size is as least as large as
+      # your worker pool size. Otherwise, workers may oversubscribe the database
+      # connection pool and block while they wait for other workers to release their
+      # connections. Use a smaller worker pool or a larger database connection pool
+      # instead.
       def worker_pool
         @worker_pool || @mutex.synchronize { @worker_pool ||= ActionCable::Server::Worker.new(max_size: config.worker_pool_size) }
       end
@@ -86,7 +97,8 @@ module ActionCable
         @pubsub || @mutex.synchronize { @pubsub ||= config.pubsub_adapter.new(self) }
       end
 
-      # All of the identifiers applied to the connection class associated with this server.
+      # All of the identifiers applied to the connection class associated with this
+      # server.
       def connection_identifiers
         config.connection_class.call.identifiers
       end

data/lib/action_cable/server/broadcasting.rb

@@ -1,34 +1,40 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module Server
-    # = Action Cable \Server \Broadcasting
+    # # Action Cable Server Broadcasting
     #
-    # 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
-    # broadcastings are streamed directly to the clients subscribed to the named broadcasting. Let's explain with a full-stack example:
+    # 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
+    # broadcastings are streamed directly to the clients subscribed to the named
+    # broadcasting. Let's explain with a full-stack example:
     #
-    #   class WebNotificationsChannel < ApplicationCable::Channel
-    #     def subscribed
-    #       stream_from "web_notifications_#{current_user.id}"
+    #     class WebNotificationsChannel < ApplicationCable::Channel
+    #       def subscribed
+    #         stream_from "web_notifications_#{current_user.id}"
+    #       end
     #     end
-    #   end
     #
-    #   # Somewhere in your app this is called, perhaps from a NewCommentJob:
-    #   ActionCable.server.broadcast \
-    #     "web_notifications_1", { title: "New things!", body: "All that's fit for print" }
+    #     # Somewhere in your app this is called, perhaps from a NewCommentJob:
+    #     ActionCable.server.broadcast \
+    #       "web_notifications_1", { title: "New things!", body: "All that's fit for print" }
     #
-    #   # Client-side CoffeeScript, which assumes you've already requested the right to send web notifications:
-    #   App.cable.subscriptions.create "WebNotificationsChannel",
-    #     received: (data) ->
-    #       new Notification data['title'], body: data['body']
+    #     # Client-side CoffeeScript, which assumes you've already requested the right to send web notifications:
+    #     App.cable.subscriptions.create "WebNotificationsChannel",
+    #       received: (data) ->
+    #         new Notification data['title'], body: data['body']
     module Broadcasting
-      # Broadcast a hash directly to a named <tt>broadcasting</tt>. This will later be JSON encoded.
+      # Broadcast a hash directly to a named `broadcasting`. This will later be JSON
+      # encoded.
       def broadcast(broadcasting, message, coder: ActiveSupport::JSON)
         broadcaster_for(broadcasting, coder: coder).broadcast(message)
       end
 
-      # Returns a broadcaster for a named <tt>broadcasting</tt> that can be reused. Useful when you have an object that
-      # may need multiple spots to transmit to a specific broadcasting over and over.
+      # Returns a broadcaster for a named `broadcasting` that can be reused. Useful
+      # when you have an object that may need multiple spots to transmit to a specific
+      # broadcasting over and over.
       def broadcaster_for(broadcasting, coder: ActiveSupport::JSON)
         Broadcaster.new(self, String(broadcasting), coder: coder)
       end

data/lib/action_cable/server/configuration.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rack"
 
 module ActionCable
   module Server
-    # = Action Cable \Server \Configuration
+    # # Action Cable Server Configuration
     #
-    # 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.
+    # 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 :connection_class, :worker_pool_size
@@ -31,28 +34,28 @@ module ActionCable
         }
       end
 
-      # Returns constant of subscription adapter specified in config/cable.yml.
-      # If the adapter cannot be found, this will default to the Redis adapter.
-      # Also makes sure proper dependencies are required.
+      # Returns constant of subscription adapter specified in config/cable.yml. 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" })
 
         # Require the adapter itself and give useful feedback about
-        #   1. Missing adapter gems and
-        #   2. Adapter gems' missing dependencies.
+        #     1. Missing adapter gems and
+        #     2. Adapter gems' missing dependencies.
         path_to_adapter = "action_cable/subscription_adapter/#{adapter}"
         begin
           require path_to_adapter
         rescue LoadError => e
-          # We couldn't require the adapter itself. Raise an exception that
-          # points out config typos and missing gems.
+          # 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.
+            # 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.
+          # 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