actioncable 7.0.3 → 7.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7294e8477c23e63558167989d2cde088da65d58289884a00940cfc83d7ed8549
-  data.tar.gz: 4d68105c0c252e959c9a47d336cf9877c88eaf22bf0af4b48f5dc8b15edc4aec
+  metadata.gz: 93e4a2b2cddb15ebdbce60bcf1b41a9ed7c0d42c4a559415708cfb1cd8d1336b
+  data.tar.gz: c8d6623c5f44c0c283617b8ff3fca22ccb48b6331acfdf2e56071a44be65118a
 SHA512:
-  metadata.gz: f622a763302ed4d2c2da4128ff9eb8ebf3ce7e132123939e1d437989cdfe27f04f33e8cd910940f65872ae3396b4a43d1c3ad2c19c48741503587256d1ee4f59
-  data.tar.gz: 2118b822316ae38d38bbb93e50241e3e60ffd72be33f027ac3645920d26cd7584c0e69999d84be32c02abe1f7db0791967f19710e5ac2c2938bfb1daa483b029
+  metadata.gz: 60bd3dff9ae1fdf2ed1065957dad4af7f7441c6fb3f3f0461bd97585b54f7397b46ad660be82fac4b9d783b753f608689859ee547ec9735d8a68b0a64e5b4e55
+  data.tar.gz: bfeb76fd0365ea64a539d249ea6f2e31ac509acad1e9f74bd569a488fd0e6066c9e58f15c9f4764b3d46624f30a75460a8e728293e50ea856c7dcd705b40911d

data/CHANGELOG.md

@@ -1,3 +1,57 @@
+## Rails 7.0.6 (June 29, 2023) ##
+
+*   Fix Action Cable Redis configuration with sentinels.
+
+    *Dmitriy Ivliev*
+
+
+## Rails 7.0.5.1 (June 26, 2023) ##
+
+*   No changes.
+
+
+## Rails 7.0.5 (May 24, 2023) ##
+
+*   Restore Action Cable Redis pub/sub listener on connection failure.
+
+    *Vladimir Dementyev*
+
+
+## Rails 7.0.4.3 (March 13, 2023) ##
+
+*   No changes.
+
+
+## Rails 7.0.4.2 (January 24, 2023) ##
+
+*   No changes.
+
+
+## Rails 7.0.4.1 (January 17, 2023) ##
+
+*   No changes.
+
+
+## Rails 7.0.4 (September 09, 2022) ##
+
+*   The Redis adapter is now compatible with redis-rb 5.0
+
+    Compatibility with redis-rb 3.x was dropped.
+
+    *Jean Boussier*
+
+*   The Action Cable server is now mounted with `anchor: true`.
+
+    This means that routes that also start with `/cable` will no longer clash with Action Cable.
+
+    *Alex Ghiculescu*
+
+
+## Rails 7.0.3.1 (July 12, 2022) ##
+
+*   No changes.
+
+
 ## Rails 7.0.3 (May 09, 2022) ##
 
 *   No changes.

data/README.md

@@ -15,7 +15,7 @@ API documentation is at:
 
 * https://api.rubyonrails.org
 
-Bug reports for the Ruby on Rails project can be filed here:
+Bug reports for the Ruby on \Rails project can be filed here:
 
 * https://github.com/rails/rails/issues
 

data/lib/action_cable/engine.rb

@@ -54,7 +54,7 @@ module ActionCable
         config = app.config
         unless config.action_cable.mount_path.nil?
           app.routes.prepend do
-            mount ActionCable.server => config.action_cable.mount_path, internal: true
+            mount ActionCable.server => config.action_cable.mount_path, internal: true, anchor: true
           end
         end
       end

data/lib/action_cable/gem_version.rb

@@ -9,7 +9,7 @@ module ActionCable
   module VERSION
     MAJOR = 7
     MINOR = 0
-    TINY  = 3
+    TINY  = 6
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/action_cable/subscription_adapter/redis.rb

@@ -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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 7.0.3
+  version: 7.0.6
 platform: ruby
 authors:
 - Pratik Naik
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: 7.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: 7.0.6
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: 7.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: 7.0.6
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -142,12 +142,12 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.0.3/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.0.3/
+  changelog_uri: https://github.com/rails/rails/blob/v7.0.6/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v7.0.6/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.0.3/actioncable
+  source_code_uri: https://github.com/rails/rails/tree/v7.0.6/actioncable
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.13
+signing_key: 
 specification_version: 4
 summary: WebSocket framework for Rails.
 test_files: []