RubyGems - actioncable - Versions diffs - 6.1.7.8 → 7.0.8.4 - Mend

actioncable 6.1.7.8 → 7.0.8.4

Files changed (33) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +78 -69
data/README.md +1 -1
data/app/assets/javascripts/action_cable.js +211 -295
data/app/assets/javascripts/actioncable.esm.js +491 -0
data/app/assets/javascripts/actioncable.js +489 -0
data/lib/action_cable/channel/base.rb +1 -1
data/lib/action_cable/channel/broadcasting.rb +1 -1
data/lib/action_cable/channel/naming.rb +1 -1
data/lib/action_cable/channel/streams.rb +5 -7
data/lib/action_cable/channel/test_case.rb +16 -1
data/lib/action_cable/connection/base.rb +5 -5
data/lib/action_cable/connection/identification.rb +1 -1
data/lib/action_cable/connection/subscriptions.rb +1 -1
data/lib/action_cable/connection/tagged_logger_proxy.rb +3 -3
data/lib/action_cable/connection/test_case.rb +1 -1
data/lib/action_cable/engine.rb +10 -1
data/lib/action_cable/gem_version.rb +5 -5
data/lib/action_cable/helpers/action_cable_helper.rb +3 -2
data/lib/action_cable/server/configuration.rb +1 -0
data/lib/action_cable/server/worker/active_record_connection_management.rb +2 -2
data/lib/action_cable/server/worker.rb +3 -4
data/lib/action_cable/subscription_adapter/postgresql.rb +2 -2
data/lib/action_cable/subscription_adapter/redis.rb +98 -22
data/lib/action_cable/subscription_adapter/test.rb +1 -1
data/lib/action_cable/test_helper.rb +2 -2
data/lib/action_cable/version.rb +1 -1
data/lib/rails/generators/channel/USAGE +1 -1
data/lib/rails/generators/channel/channel_generator.rb +79 -20
data/lib/rails/generators/channel/templates/javascript/index.js.tt +1 -5
metadata +13 -11
/data/lib/rails/generators/channel/templates/application_cable/{channel.rb.tt → channel.rb} +0 -0
/data/lib/rails/generators/channel/templates/application_cable/{connection.rb.tt → connection.rb} +0 -0

data/lib/action_cable/gem_version.rb CHANGED Viewed

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 module ActionCable
-  # Returns the version of the currently loaded Action Cable as a <tt>Gem::Version</tt>.
+  # Returns the currently loaded version of Action Cable as a <tt>Gem::Version</tt>.
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
   module VERSION
-    MAJOR = 6
-    MINOR = 1
-    TINY  = 7
-    PRE   = "8"
+    MAJOR = 7
+    MINOR = 0
+    TINY  = 8
+    PRE   = "4"
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_cable/helpers/action_cable_helper.rb CHANGED Viewed

@@ -8,14 +8,15 @@ module ActionCable
       #
       #   <head>
       #     <%= action_cable_meta_tag %>
-      #     <%= javascript_include_tag 'application', 'data-turbolinks-track' => 'reload' %>
+      #     <%= 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:
       #
-      #   window.Cable = require("@rails/actioncable")
+      #   import Cable from "@rails/actioncable"
+      #   window.Cable = Cable
       #   window.App = {}
       #   App.cable = Cable.createConsumer()
       #

data/lib/action_cable/server/configuration.rb CHANGED Viewed

@@ -9,6 +9,7 @@ module ActionCable
       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
+      attr_accessor :precompile_assets
       def initialize
         @log_tags = []

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

@@ -12,8 +12,8 @@ module ActionCable
           end
         end
-        def with_database_connections
-          connection.logger.tag(ActiveRecord::Base.logger) { yield }
+        def with_database_connections(&block)
+          connection.logger.tag(ActiveRecord::Base.logger, &block)
         end
       end
     end

data/lib/action_cable/server/worker.rb CHANGED Viewed

@@ -19,6 +19,7 @@ module ActionCable
       def initialize(max_size: 5)
         @executor = Concurrent::ThreadPoolExecutor.new(
+          name: "ActionCable",
           min_threads: 1,
           max_threads: max_size,
           max_queue: 0,
@@ -35,12 +36,10 @@ module ActionCable
         @executor.shuttingdown?
       end
-      def work(connection)
+      def work(connection, &block)
         self.connection = connection
-        run_callbacks :work do
-          yield
-        end
+        run_callbacks :work, &block
       ensure
         self.connection = nil
       end

data/lib/action_cable/subscription_adapter/postgresql.rb CHANGED Viewed

@@ -3,7 +3,7 @@
 gem "pg", "~> 1.1"
 require "pg"
 require "thread"
-require "digest/sha1"
+require "openssl"
 module ActionCable
   module SubscriptionAdapter
@@ -58,7 +58,7 @@ module ActionCable
       private
         def channel_identifier(channel)
-          channel.size > 63 ? Digest::SHA1.hexdigest(channel) : channel
+          channel.size > 63 ? OpenSSL::Digest::SHA1.hexdigest(channel) : channel
         end
         def listener

data/lib/action_cable/subscription_adapter/redis.rb CHANGED Viewed

@@ -2,7 +2,7 @@
 require "thread"
-gem "redis", ">= 3", "< 5"
+gem "redis", ">= 3", "< 6"
 require "redis"
 require "active_support/core_ext/hash/except"
@@ -46,7 +46,7 @@ module ActionCable
       private
         def listener
-          @listener || @server.mutex.synchronize { @listener ||= Listener.new(self, @server.event_loop) }
+          @listener || @server.mutex.synchronize { @listener ||= Listener.new(self, config_options, @server.event_loop) }
         end
         def redis_connection_for_broadcasts
@@ -56,11 +56,15 @@ module ActionCable
         end
         def redis_connection
-          self.class.redis_connector.call(@server.config.cable.merge(id: identifier))
+          self.class.redis_connector.call(config_options)
+        end
+        def config_options
+          @config_options ||= @server.config.cable.deep_symbolize_keys.merge(id: identifier)
         end
         class Listener < SubscriberMap
-          def initialize(adapter, event_loop)
+          def initialize(adapter, config_options, event_loop)
             super()
             @adapter = adapter
@@ -69,7 +73,12 @@ module ActionCable
             @subscribe_callbacks = Hash.new { |h, k| h[k] = [] }
             @subscription_lock = Mutex.new
-            @raw_client = nil
+            @reconnect_attempt = 0
+            # Use the same config as used by Redis conn
+            @reconnect_attempts = config_options.fetch(:reconnect_attempts, 1)
+            @reconnect_attempts = Array.new(@reconnect_attempts, 0) if @reconnect_attempts.is_a?(Integer)
+            @subscribed_client = nil
             @when_connected = []
@@ -78,13 +87,14 @@ module ActionCable
           def listen(conn)
             conn.without_reconnect do
-              original_client = conn.respond_to?(:_client) ? conn._client : conn.client
+              original_client = extract_subscribed_client(conn)
               conn.subscribe("_action_cable_internal") do |on|
                 on.subscribe do |chan, count|
                   @subscription_lock.synchronize do
                     if count == 1
-                      @raw_client = original_client
+                      @reconnect_attempt = 0
+                      @subscribed_client = original_client
                       until @when_connected.empty?
                         @when_connected.shift.call
@@ -106,7 +116,7 @@ module ActionCable
                 on.unsubscribe do |chan, count|
                   if count == 0
                     @subscription_lock.synchronize do
-                      @raw_client = nil
+                      @subscribed_client = nil
                     end
                   end
                 end
@@ -119,8 +129,8 @@ module ActionCable
               return if @thread.nil?
               when_connected do
-                send_command("unsubscribe")
-                @raw_client = nil
+                @subscribed_client.unsubscribe
+                @subscribed_client = nil
               end
             end
@@ -131,13 +141,13 @@ module ActionCable
             @subscription_lock.synchronize do
               ensure_listener_running
               @subscribe_callbacks[channel] << on_success
-              when_connected { send_command("subscribe", channel) }
+              when_connected { @subscribed_client.subscribe(channel) }
             end
           end
           def remove_channel(channel)
             @subscription_lock.synchronize do
-              when_connected { send_command("unsubscribe", channel) }
+              when_connected { @subscribed_client.unsubscribe(channel) }
             end
           end
@@ -150,28 +160,94 @@ module ActionCable
               @thread ||= Thread.new do
                 Thread.current.abort_on_exception = true
-                conn = @adapter.redis_connection_for_subscriptions
-                listen conn
+                begin
+                  conn = @adapter.redis_connection_for_subscriptions
+                  listen conn
+                rescue ConnectionError
+                  reset
+                  if retry_connecting?
+                    when_connected { resubscribe }
+                    retry
+                  end
+                end
               end
             end
             def when_connected(&block)
-              if @raw_client
+              if @subscribed_client
                 block.call
               else
                 @when_connected << block
               end
             end
-            def send_command(*command)
-              @raw_client.write(command)
+            def retry_connecting?
+              @reconnect_attempt += 1
+              return false if @reconnect_attempt > @reconnect_attempts.size
+              sleep_t = @reconnect_attempts[@reconnect_attempt - 1]
+              sleep(sleep_t) if sleep_t > 0
+              true
+            end
+            def resubscribe
+              channels = @sync.synchronize do
+                @subscribers.keys
+              end
+              @subscribed_client.subscribe(*channels) unless channels.empty?
+            end
+            def reset
+              @subscription_lock.synchronize do
+                @subscribed_client = nil
+                @subscribe_callbacks.clear
+                @when_connected.clear
+              end
+            end
+            if ::Redis::VERSION < "5"
+              ConnectionError = ::Redis::ConnectionError
+              class SubscribedClient
+                def initialize(raw_client)
+                  @raw_client = raw_client
+                end
+                def subscribe(*channel)
+                  send_command("subscribe", *channel)
+                end
+                def unsubscribe(*channel)
+                  send_command("unsubscribe", *channel)
+                end
-              very_raw_connection =
-                @raw_client.connection.instance_variable_defined?(:@connection) &&
-                @raw_client.connection.instance_variable_get(:@connection)
+                private
+                  def send_command(*command)
+                    @raw_client.write(command)
+                    very_raw_connection =
+                      @raw_client.connection.instance_variable_defined?(:@connection) &&
+                      @raw_client.connection.instance_variable_get(:@connection)
+                    if very_raw_connection && very_raw_connection.respond_to?(:flush)
+                      very_raw_connection.flush
+                    end
+                    nil
+                  end
+              end
+              def extract_subscribed_client(conn)
+                raw_client = conn.respond_to?(:_client) ? conn._client : conn.client
+                SubscribedClient.new(raw_client)
+              end
+            else
+              ConnectionError = RedisClient::ConnectionError
-              if very_raw_connection && very_raw_connection.respond_to?(:flush)
-                very_raw_connection.flush
+              def extract_subscribed_client(conn)
+                conn
               end
             end
         end

data/lib/action_cable/subscription_adapter/test.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module ActionCable
     # == 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.
+    # 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.
     #

data/lib/action_cable/test_helper.rb CHANGED Viewed

@@ -45,7 +45,7 @@ module ActionCable
     def assert_broadcasts(stream, number, &block)
       if block_given?
         original_count = broadcasts_size(stream)
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("assert_broadcasts", &block)
         new_count = broadcasts_size(stream)
         actual_count = new_count - original_count
       else
@@ -106,7 +106,7 @@ module ActionCable
         old_messages = new_messages
         clear_messages(stream)
-        assert_nothing_raised(&block)
+        _assert_nothing_raised_or_warn("assert_broadcast_on", &block)
         new_messages = broadcasts(stream)
         clear_messages(stream)

data/lib/action_cable/version.rb CHANGED Viewed

@@ -3,7 +3,7 @@
 require_relative "gem_version"
 module ActionCable
-  # Returns the version of the currently loaded Action Cable as a <tt>Gem::Version</tt>
+  # Returns the currently loaded version of Action Cable as a <tt>Gem::Version</tt>.
   def self.version
     gem_version
   end

data/lib/rails/generators/channel/USAGE CHANGED Viewed

@@ -10,4 +10,4 @@ Example:
     creates a Chat channel class, test and JavaScript asset:
         Channel:    app/channels/chat_channel.rb
         Test:       test/channels/chat_channel_test.rb
-        Assets:     app/javascript/channels/chat_channel.js
+        Assets:     $JAVASCRIPT_PATH/channels/chat_channel.js

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

@@ -13,39 +13,98 @@ module Rails
       hook_for :test_framework
-      def create_channel_file
-        template "channel.rb", File.join("app/channels", class_path, "#{file_name}_channel.rb")
+      def create_channel_files
+        create_shared_channel_files
+        create_channel_file
-        if options[:assets]
-          if behavior == :invoke
-            template "javascript/index.js", "app/javascript/channels/index.js"
-            template "javascript/consumer.js", "app/javascript/channels/consumer.js"
+        if using_javascript?
+          if first_setup_required?
+            create_shared_channel_javascript_files
+            import_channels_in_javascript_entrypoint
+            if using_importmap?
+              pin_javascript_dependencies
+            elsif using_node?
+              install_javascript_dependencies
+            end
           end
-          js_template "javascript/channel", File.join("app/javascript/channels", class_path, "#{file_name}_channel")
+          create_channel_javascript_file
+          import_channel_in_javascript_entrypoint
         end
-        generate_application_cable_files
       end
       private
+        def create_shared_channel_files
+          return if behavior != :invoke
+          copy_file "#{__dir__}/templates/application_cable/channel.rb",
+            "app/channels/application_cable/channel.rb"
+          copy_file "#{__dir__}/templates/application_cable/connection.rb",
+            "app/channels/application_cable/connection.rb"
+        end
+        def create_channel_file
+          template "channel.rb",
+            File.join("app/channels", class_path, "#{file_name}_channel.rb")
+        end
+        def create_shared_channel_javascript_files
+          template "javascript/index.js", "app/javascript/channels/index.js"
+          template "javascript/consumer.js", "app/javascript/channels/consumer.js"
+        end
+        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?
+        end
+        def import_channels_in_javascript_entrypoint
+          append_to_file "app/javascript/application.js",
+            using_node? ? %(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)
+        end
+        def install_javascript_dependencies
+          say "Installing JavaScript dependencies", :green
+          run "yarn add @rails/actioncable"
+        end
+        def pin_javascript_dependencies
+          append_to_file "config/importmap.rb", <<-RUBY
+pin "@rails/actioncable", to: "actioncable.esm.js"
+pin_all_from "app/javascript/channels", under: "channels"
+          RUBY
+        end
         def file_name
           @_file_name ||= super.sub(/_channel\z/i, "")
         end
-        # FIXME: Change these files to symlinks once RubyGems 2.5.0 is required.
-        def generate_application_cable_files
-          return if behavior != :invoke
+        def first_setup_required?
+          !root.join("app/javascript/channels/index.js").exist?
+        end
-          files = [
-            "application_cable/channel.rb",
-            "application_cable/connection.rb"
-          ]
+        def using_javascript?
+          @using_javascript ||= options[:assets] && root.join("app/javascript").exist?
+        end
-          files.each do |name|
-            path = File.join("app/channels/", name)
-            template(name, path) if !File.exist?(path)
-          end
+        def using_node?
+          @using_node ||= root.join("package.json").exist?
+        end
+        def using_importmap?
+          @using_importmap ||= root.join("config/importmap.rb").exist?
+        end
+        def root
+          @root ||= Pathname(destination_root)
         end
     end
   end

data/lib/rails/generators/channel/templates/javascript/index.js.tt CHANGED Viewed

@@ -1,5 +1 @@
-// Load all the channels within this directory and all subdirectories.
-// Channel files must be named *_channel.js.
-const channels = require.context('.', true, /_channel\.js$/)
-channels.keys().forEach(channels)
+// Import all the channels to be used by Action Cable

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 6.1.7.8
+  version: 7.0.8.4
 platform: ruby
 authors:
 - Pratik Naik
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.7.8
+        version: 7.0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.7.8
+        version: 7.0.8.4
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.7.8
+        version: 7.0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.7.8
+        version: 7.0.8.4
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,8 @@ files:
 - MIT-LICENSE
 - README.md
 - app/assets/javascripts/action_cable.js
+- 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
@@ -127,8 +129,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.tt
-- lib/rails/generators/channel/templates/application_cable/connection.rb.tt
+- lib/rails/generators/channel/templates/application_cable/channel.rb
+- lib/rails/generators/channel/templates/application_cable/connection.rb
 - 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
@@ -140,10 +142,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v6.1.7.8/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v6.1.7.8/
+  changelog_uri: https://github.com/rails/rails/blob/v7.0.8.4/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.0.8.4/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v6.1.7.8/actioncable
+  source_code_uri: https://github.com/rails/rails/tree/v7.0.8.4/actioncable
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -153,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

/data/lib/rails/generators/channel/templates/application_cable/{channel.rb.tt → channel.rb} RENAMED Viewed

File without changes

/data/lib/rails/generators/channel/templates/application_cable/{connection.rb.tt → connection.rb} RENAMED Viewed

File without changes