actioncable 7.0.8.7 → 7.2.2.1

data/lib/action_cable/subscription_adapter/redis.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "thread"
+# :markup: markdown
 
-gem "redis", ">= 3", "< 6"
+gem "redis", ">= 4", "< 6"
 require "redis"
 
 require "active_support/core_ext/hash/except"
@@ -12,8 +12,9 @@ module ActionCable
     class Redis < Base # :nodoc:
       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.
+      # 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, default: ->(config) do
         ::Redis.new(config.except(:adapter, :channel_prefix))
       end
@@ -209,7 +210,7 @@ module ActionCable
             end
 
             if ::Redis::VERSION < "5"
-              ConnectionError = ::Redis::ConnectionError
+              ConnectionError = ::Redis::BaseConnectionError
 
               class SubscribedClient
                 def initialize(raw_client)
@@ -240,8 +241,7 @@ module ActionCable
               end
 
               def extract_subscribed_client(conn)
-                raw_client = conn.respond_to?(:_client) ? conn._client : conn.client
-                SubscribedClient.new(raw_client)
+                SubscribedClient.new(conn._client)
               end
             else
               ConnectionError = RedisClient::ConnectionError

data/lib/action_cable/subscription_adapter/subscriber_map.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   module SubscriptionAdapter
     class SubscriberMap

data/lib/action_cable/subscription_adapter/test.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "async"
+# :markup: markdown
 
 module ActionCable
   module SubscriptionAdapter
-    # == Test adapter for Action Cable
+    # ## Test adapter for Action Cable
     #
     # The test adapter should be used only in testing. Along with
     # ActionCable::TestHelper 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.
+    # 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.
+    # NOTE: `Test` adapter extends the `ActionCable::SubscriptionAdapter::Async`
+    # adapter, so it could be used in system tests too.
     class Test < Async
       def broadcast(channel, payload)
         broadcasts(channel) << payload

data/lib/action_cable/test_case.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/test_case"
 
 module ActionCable

data/lib/action_cable/test_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionCable
   # Provides helper methods for testing Action Cable broadcasting
   module TestHelper
@@ -18,105 +20,123 @@ module ActionCable
       ActionCable.server.instance_variable_set(:@pubsub, @old_pubsub_adapter)
     end
 
-    # Asserts that the number of broadcasted messages to the stream matches the given number.
-    #
-    #   def test_broadcasts
-    #     assert_broadcasts 'messages', 0
-    #     ActionCable.server.broadcast 'messages', { text: 'hello' }
-    #     assert_broadcasts 'messages', 1
-    #     ActionCable.server.broadcast 'messages', { text: 'world' }
-    #     assert_broadcasts 'messages', 2
-    #   end
-    #
-    # If a block is passed, that block should cause the specified number of
-    # messages to be broadcasted.
+    # Asserts that the number of broadcasted messages to the stream matches the
+    # given number.
     #
-    #   def test_broadcasts_again
-    #     assert_broadcasts('messages', 1) do
+    #     def test_broadcasts
+    #       assert_broadcasts 'messages', 0
     #       ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #       assert_broadcasts 'messages', 1
+    #       ActionCable.server.broadcast 'messages', { text: 'world' }
+    #       assert_broadcasts 'messages', 2
     #     end
     #
-    #     assert_broadcasts('messages', 2) do
-    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
-    #       ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    # If a block is passed, that block should cause the specified number of messages
+    # to be broadcasted.
+    #
+    #     def test_broadcasts_again
+    #       assert_broadcasts('messages', 1) do
+    #         ActionCable.server.broadcast 'messages', { text: 'hello' }
+    #       end
+    #
+    #       assert_broadcasts('messages', 2) do
+    #         ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #         ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #       end
     #     end
-    #   end
     #
     def assert_broadcasts(stream, number, &block)
       if block_given?
-        original_count = broadcasts_size(stream)
-        _assert_nothing_raised_or_warn("assert_broadcasts", &block)
-        new_count = broadcasts_size(stream)
-        actual_count = new_count - original_count
+        new_messages = new_broadcasts_from(broadcasts(stream), stream, "assert_broadcasts", &block)
+
+        actual_count = new_messages.size
+        assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
       else
-        actual_count = broadcasts_size(stream)
+        actual_count = broadcasts(stream).size
+        assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
       end
-
-      assert_equal number, actual_count, "#{number} broadcasts to #{stream} expected, but #{actual_count} were sent"
     end
 
     # Asserts that no messages have been sent to the stream.
     #
-    #   def test_no_broadcasts
-    #     assert_no_broadcasts 'messages'
-    #     ActionCable.server.broadcast 'messages', { text: 'hi' }
-    #     assert_broadcasts 'messages', 1
-    #   end
+    #     def test_no_broadcasts
+    #       assert_no_broadcasts 'messages'
+    #       ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #       assert_broadcasts 'messages', 1
+    #     end
     #
     # If a block is passed, that block should not cause any message to be sent.
     #
-    #   def test_broadcasts_again
-    #     assert_no_broadcasts 'messages' do
-    #       # No job messages should be sent from this block
+    #     def test_broadcasts_again
+    #       assert_no_broadcasts 'messages' do
+    #         # No job messages should be sent from this block
+    #       end
     #     end
-    #   end
     #
     # Note: This assertion is simply a shortcut for:
     #
-    #   assert_broadcasts 'messages', 0, &block
+    #     assert_broadcasts 'messages', 0, &block
     #
     def assert_no_broadcasts(stream, &block)
       assert_broadcasts stream, 0, &block
     end
 
-    # Asserts that the specified message has been sent to the stream.
+    # Returns the messages that are broadcasted in the block.
     #
-    #   def test_assert_transmitted_message
-    #     ActionCable.server.broadcast 'messages', text: 'hello'
-    #     assert_broadcast_on('messages', text: 'hello')
-    #   end
+    #     def test_broadcasts
+    #       messages = capture_broadcasts('messages') do
+    #         ActionCable.server.broadcast 'messages', { text: 'hi' }
+    #         ActionCable.server.broadcast 'messages', { text: 'how are you?' }
+    #       end
+    #       assert_equal 2, messages.length
+    #       assert_equal({ text: 'hi' }, messages.first)
+    #       assert_equal({ text: 'how are you?' }, messages.last)
+    #     end
     #
-    # If a block is passed, that block should cause a message with the specified data to be sent.
+    def capture_broadcasts(stream, &block)
+      new_broadcasts_from(broadcasts(stream), stream, "capture_broadcasts", &block).map { |m| ActiveSupport::JSON.decode(m) }
+    end
+
+    # Asserts that the specified message has been sent to the stream.
     #
-    #   def test_assert_broadcast_on_again
-    #     assert_broadcast_on('messages', text: 'hello') do
+    #     def test_assert_transmitted_message
     #       ActionCable.server.broadcast 'messages', text: 'hello'
+    #       assert_broadcast_on('messages', text: 'hello')
+    #     end
+    #
+    # If a block is passed, that block should cause a message with the specified
+    # data to be sent.
+    #
+    #     def test_assert_broadcast_on_again
+    #       assert_broadcast_on('messages', text: 'hello') do
+    #         ActionCable.server.broadcast 'messages', text: 'hello'
+    #       end
     #     end
-    #   end
     #
     def assert_broadcast_on(stream, data, &block)
-      # Encode to JSON and back–we want to use this value to compare
-      # with decoded JSON.
-      # Comparing JSON strings doesn't work due to the order if the keys.
+      # Encode to JSON and back–we want to use this value to compare with decoded
+      # JSON. Comparing JSON strings doesn't work due to the order if the keys.
       serialized_msg =
         ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(data))
 
       new_messages = broadcasts(stream)
       if block_given?
-        old_messages = new_messages
-        clear_messages(stream)
-
-        _assert_nothing_raised_or_warn("assert_broadcast_on", &block)
-        new_messages = broadcasts(stream)
-        clear_messages(stream)
-
-        # Restore all sent messages
-        (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
+        new_messages = new_broadcasts_from(new_messages, stream, "assert_broadcast_on", &block)
       end
 
       message = new_messages.find { |msg| ActiveSupport::JSON.decode(msg) == serialized_msg }
 
-      assert message, "No messages sent with #{data} to #{stream}"
+      error_message = "No messages sent with #{data} to #{stream}"
+
+      if new_messages.any?
+        error_message = new_messages.inject("#{error_message}\nMessage(s) found:\n") do |error_message, new_message|
+          error_message + "#{ActiveSupport::JSON.decode(new_message)}\n"
+        end
+      else
+        error_message = "#{error_message}\nNo message found for #{stream}"
+      end
+
+      assert message, error_message
     end
 
     def pubsub_adapter # :nodoc:
@@ -126,8 +146,18 @@ module ActionCable
     delegate :broadcasts, :clear_messages, to: :pubsub_adapter
 
     private
-      def broadcasts_size(channel)
-        broadcasts(channel).size
+      def new_broadcasts_from(current_messages, stream, assertion, &block)
+        old_messages = current_messages
+        clear_messages(stream)
+
+        _assert_nothing_raised_or_warn(assertion, &block)
+        new_messages = broadcasts(stream)
+        clear_messages(stream)
+
+        # Restore all sent messages
+        (old_messages + new_messages).each { |m| pubsub_adapter.broadcast(stream, m) }
+
+        new_messages
       end
   end
 end

data/lib/action_cable/version.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require_relative "gem_version"
 
 module ActionCable
-  # Returns the currently loaded version of Action Cable as a <tt>Gem::Version</tt>.
+  # Returns the currently loaded version of Action Cable as a `Gem::Version`.
   def self.version
     gem_version
   end

data/lib/action_cable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #--
-# Copyright (c) 2015-2022 Basecamp, LLC
+# Copyright (c) 37signals LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -25,10 +25,35 @@
 
 require "active_support"
 require "active_support/rails"
-require "action_cable/version"
+require "zeitwerk"
 
+# We compute lib this way instead of using __dir__ because __dir__ gives a real
+# path, while __FILE__ honors symlinks. If the gem is stored under a symlinked
+# directory, this matters.
+lib = File.dirname(__FILE__)
+
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore(
+    "#{lib}/rails", # Contains generators, templates, docs, etc.
+    "#{lib}/action_cable/gem_version.rb",
+    "#{lib}/action_cable/version.rb",
+    "#{lib}/action_cable/deprecator.rb",
+  )
+
+  loader.do_not_eager_load(
+    "#{lib}/action_cable/subscription_adapter", # Adapters are required and loaded on demand.
+    "#{lib}/action_cable/test_helper.rb",
+    Dir["#{lib}/action_cable/**/test_case.rb"]
+  )
+
+  loader.inflector.inflect("postgresql" => "PostgreSQL")
+end.setup
+
+# :markup: markdown
+# :include: ../README.md
 module ActionCable
-  extend ActiveSupport::Autoload
+  require_relative "action_cable/version"
+  require_relative "action_cable/deprecator"
 
   INTERNAL = {
     message_types: {
@@ -41,7 +66,8 @@ module ActionCable
     disconnect_reasons: {
       unauthorized: "unauthorized",
       invalid_request: "invalid_request",
-      server_restart: "server_restart"
+      server_restart: "server_restart",
+      remote: "remote"
     },
     default_mount_path: "/cable",
     protocols: ["actioncable-v1-json", "actioncable-unsupported"].freeze
@@ -51,12 +77,4 @@ module ActionCable
   module_function def server
     @server ||= ActionCable::Server::Base.new
   end
-
-  autoload :Server
-  autoload :Connection
-  autoload :Channel
-  autoload :RemoteConnections
-  autoload :SubscriptionAdapter
-  autoload :TestHelper
-  autoload :TestCase
 end

data/lib/rails/generators/channel/USAGE

@@ -1,13 +1,19 @@
 Description:
-============
     Generates a new cable channel for the server (in Ruby) and client (in JavaScript).
     Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.
 
-Example:
-========
-    bin/rails generate channel Chat speak
+Examples:
+    `bin/rails generate channel notification`
 
-    creates a Chat channel class, test and JavaScript asset:
-        Channel:    app/channels/chat_channel.rb
-        Test:       test/channels/chat_channel_test.rb
-        Assets:     $JAVASCRIPT_PATH/channels/chat_channel.js
+    creates a notification channel class, test and JavaScript asset:
+        Channel:    app/channels/notification_channel.rb
+        Test:       test/channels/notification_channel_test.rb
+        Assets:     $JAVASCRIPT_PATH/channels/notification_channel.js
+
+    `bin/rails generate channel chat speak`
+
+    creates a chat channel with a speak action.
+
+    `bin/rails generate channel comments --no-assets`
+
+    creates a comments channel without JavaScript assets.

data/lib/rails/generators/channel/channel_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module Rails
   module Generators
     class ChannelGenerator < NamedBase
@@ -24,7 +26,7 @@ module Rails
 
             if using_importmap?
               pin_javascript_dependencies
-            elsif using_node?
+            elsif using_js_runtime?
               install_javascript_dependencies
             end
           end
@@ -57,22 +59,26 @@ module Rails
         def create_channel_javascript_file
           channel_js_path = File.join("app/javascript/channels", class_path, "#{file_name}_channel")
           js_template "javascript/channel", channel_js_path
-          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_node?
+          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_js_runtime?
         end
 
         def import_channels_in_javascript_entrypoint
           append_to_file "app/javascript/application.js",
-            using_node? ? %(import "./channels"\n) : %(import "channels"\n)
+            using_js_runtime? ? %(import "./channels"\n) : %(import "channels"\n)
         end
 
         def import_channel_in_javascript_entrypoint
           append_to_file "app/javascript/channels/index.js",
-            using_node? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
+            using_js_runtime? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
         end
 
         def install_javascript_dependencies
           say "Installing JavaScript dependencies", :green
-          run "yarn add @rails/actioncable"
+          if using_bun?
+            run "bun add @rails/actioncable"
+          elsif using_node?
+            run "yarn add @rails/actioncable"
+          end
         end
 
         def pin_javascript_dependencies
@@ -82,7 +88,6 @@ pin_all_from "app/javascript/channels", under: "channels"
           RUBY
         end
 
-
         def file_name
           @_file_name ||= super.sub(/_channel\z/i, "")
         end
@@ -95,8 +100,19 @@ pin_all_from "app/javascript/channels", under: "channels"
           @using_javascript ||= options[:assets] && root.join("app/javascript").exist?
         end
 
+        def using_js_runtime?
+          @using_js_runtime ||= root.join("package.json").exist?
+        end
+
+        def using_bun?
+          # Cannot assume bun.lockb has been generated yet so we look for a file known to
+          # be generated by the jsbundling-rails gem
+          @using_bun ||= using_js_runtime? && root.join("bun.config.js").exist?
+        end
+
         def using_node?
-          @using_node ||= root.join("package.json").exist?
+          # Bun is the only runtime that _isn't_ node.
+          @using_node ||= using_js_runtime? && !root.join("bun.config.js").exist?
         end
 
         def using_importmap?

data/lib/rails/generators/test_unit/channel_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module TestUnit
   module Generators
     class ChannelGenerator < ::Rails::Generators::NamedBase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 7.0.8.7
+  version: 7.2.2.1
 platform: ruby
 authors:
 - Pratik Naik
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8.7
+        version: 7.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8.7
+        version: 7.2.2.1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8.7
+        version: 7.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.8.7
+        version: 7.2.2.1
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Structure many real-time application concerns into channels over a single
   WebSocket connection.
 email:
@@ -83,7 +97,6 @@ files:
 - app/assets/javascripts/actioncable.esm.js
 - app/assets/javascripts/actioncable.js
 - lib/action_cable.rb
-- lib/action_cable/channel.rb
 - lib/action_cable/channel/base.rb
 - lib/action_cable/channel/broadcasting.rb
 - lib/action_cable/channel/callbacks.rb
@@ -91,9 +104,9 @@ files:
 - lib/action_cable/channel/periodic_timers.rb
 - lib/action_cable/channel/streams.rb
 - lib/action_cable/channel/test_case.rb
-- lib/action_cable/connection.rb
 - lib/action_cable/connection/authorization.rb
 - lib/action_cable/connection/base.rb
+- lib/action_cable/connection/callbacks.rb
 - lib/action_cable/connection/client_socket.rb
 - lib/action_cable/connection/identification.rb
 - lib/action_cable/connection/internal_channel.rb
@@ -104,18 +117,17 @@ files:
 - lib/action_cable/connection/tagged_logger_proxy.rb
 - lib/action_cable/connection/test_case.rb
 - lib/action_cable/connection/web_socket.rb
+- lib/action_cable/deprecator.rb
 - lib/action_cable/engine.rb
 - lib/action_cable/gem_version.rb
 - lib/action_cable/helpers/action_cable_helper.rb
 - lib/action_cable/remote_connections.rb
-- lib/action_cable/server.rb
 - lib/action_cable/server/base.rb
 - lib/action_cable/server/broadcasting.rb
 - lib/action_cable/server/configuration.rb
 - lib/action_cable/server/connections.rb
 - lib/action_cable/server/worker.rb
 - lib/action_cable/server/worker/active_record_connection_management.rb
-- lib/action_cable/subscription_adapter.rb
 - lib/action_cable/subscription_adapter/async.rb
 - lib/action_cable/subscription_adapter/base.rb
 - lib/action_cable/subscription_adapter/channel_prefix.rb
@@ -129,8 +141,8 @@ files:
 - lib/action_cable/version.rb
 - lib/rails/generators/channel/USAGE
 - lib/rails/generators/channel/channel_generator.rb
-- lib/rails/generators/channel/templates/application_cable/channel.rb
-- lib/rails/generators/channel/templates/application_cable/connection.rb
+- lib/rails/generators/channel/templates/application_cable/channel.rb.tt
+- lib/rails/generators/channel/templates/application_cable/connection.rb.tt
 - lib/rails/generators/channel/templates/channel.rb.tt
 - lib/rails/generators/channel/templates/javascript/channel.js.tt
 - lib/rails/generators/channel/templates/javascript/consumer.js.tt
@@ -142,10 +154,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.0.8.7/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.0.8.7/
+  changelog_uri: https://github.com/rails/rails/blob/v7.2.2.1/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.2.2.1/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.0.8.7/actioncable
+  source_code_uri: https://github.com/rails/rails/tree/v7.2.2.1/actioncable
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -155,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/action_cable/channel.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ActionCable
-  module Channel
-    extend ActiveSupport::Autoload
-
-    eager_autoload do
-      autoload :Base
-      autoload :Broadcasting
-      autoload :Callbacks
-      autoload :Naming
-      autoload :PeriodicTimers
-      autoload :Streams
-      autoload :TestCase
-    end
-  end
-end

data/lib/action_cable/connection.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module ActionCable
-  module Connection
-    extend ActiveSupport::Autoload
-
-    eager_autoload do
-      autoload :Authorization
-      autoload :Base
-      autoload :ClientSocket
-      autoload :Identification
-      autoload :InternalChannel
-      autoload :MessageBuffer
-      autoload :Stream
-      autoload :StreamEventLoop
-      autoload :Subscriptions
-      autoload :TaggedLoggerProxy
-      autoload :TestCase
-      autoload :WebSocket
-    end
-  end
-end