solid_cable 3.0.12 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb120f549ab39af171e93f67350d0ca6b44d2d43e42e23d538c74f894a8e4d4
-  data.tar.gz: 13404708ae736ed703e80623b0b8496bbaca984cee263a97818951abb94fe35c
+  metadata.gz: 10e383ae37ea3643b84e98e513c1123340c94db2d3c0d9683c6bbd1f86f6b3dc
+  data.tar.gz: b883a4c70ca58c0bada49bc4ee0b42e3cac9e5c4260c42a6a2ffb2ade678ee26
 SHA512:
-  metadata.gz: 5fc3825837aa2ee2ff4e805e40a45a2c19471576f91d0f9a0603fdb679542e2a473dd2797cd2a0bf795785ea65d713b01c2c3d0f2ef3bdcdba100608a3cf6115
-  data.tar.gz: 1b9474761a35f8aa38063128b6c4fb3a9c30ae94b995e80d1f17eb590cf47ff84f684f557328448d8cc4aa2a26ba509b9b6c32f7ad179d140f9cc23cccca94e9
+  metadata.gz: c7a8924daed8e0b78e9955bad3cc800f33bb917f0fab735ea1e892af037aa51f1e5ab64fc14f363d077f3ae748e977be192d36f42c86730119e1f21729dbc508
+  data.tar.gz: 412baa21c8913721f097d49ceeddc9b893634c3412936fd7f8b9bfbd1d454ed5343b2677a76c785aac6ef72cf8b8edb70bae23631fcc02622a72fdd4ee3bceb0

data/README.md

@@ -86,6 +86,8 @@ The options are:
 - `silence_polling` - whether to silence Active Record logs emitted when polling (Defaults to true)
 - `use_skip_locked` - whether to use `FOR UPDATE SKIP LOCKED` when performing trimming. This will be automatically detected in the future, and for now, you'd only need to set this to `false` if your database doesn't support it. For MySQL, that'd be versions < 8, and for PostgreSQL, versions < 9.5. If you use SQLite, this has no effect, as writes are sequential. (Defaults to true)
 - `trim_batch_size` - the batch size to use when deleting old records (default: `100`)
+- `reconnect_attempts` - Supports a number of connection attempts or an array of
+  durations to wait between attempts. (Defaults to 1 retry attempt)
 
 
 ## Trimming

data/Rakefile

@@ -1,5 +1,6 @@
-# frozen_string_literal: true
-
 require "bundler/setup"
 
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
 require "bundler/gem_tasks"

data/lib/action_cable/subscription_adapter/solid_cable.rb

@@ -12,6 +12,13 @@ module ActionCable
 
       def initialize(*)
         super
+        @mutex =
+          if defined?(@server)
+            @server.mutex
+          else
+            Mutex.new
+          end
+
         @listener = nil
       end
 
@@ -33,29 +40,52 @@ module ActionCable
 
       private
         def listener
-          @listener || @server.mutex.synchronize do
-            @listener ||= Listener.new(@server.event_loop)
+          @listener || @mutex.synchronize do
+            @listener ||= Listener.new(self, pubsub_executor)
           end
         end
 
+        def pubsub_executor
+          @pubsub_executor ||=
+            if respond_to?(:executor, true)
+              executor
+            else
+              @server.event_loop
+            end
+        end
+
         class Listener < ::ActionCable::SubscriptionAdapter::SubscriberMap
+          CONNECTION_ERRORS = [
+            ActiveRecord::ConnectionFailed,
+            ActiveRecord::ConnectionTimeoutError,
+            ActiveRecord::ConnectionNotEstablished
+          ]
           Stop = Class.new(Exception)
 
-          def initialize(event_loop)
-            super()
+          delegate :logger, to: :@adapter
 
-            @event_loop = event_loop
+          def initialize(adapter, executor)
+            super()
+            @adapter = adapter
+            @executor = executor
 
             # Critical section begins with 0 permits. It can be understood as
             # being "normally held" by the listener thread. It is released
             # for specific sections of code, rather than acquired.
             @critical = Concurrent::Semaphore.new(0)
 
+            @reconnect_attempt = 0
+            @last_id = last_message_id
+
             @thread = Thread.new do
               Thread.current.name = "solid_cable_listener"
               Thread.current.report_on_exception = true
 
-              listen
+              begin
+                listen
+              rescue *CONNECTION_ERRORS
+                retry if retry_connecting?
+              end
             end
           end
 
@@ -93,7 +123,7 @@ module ActionCable
 
           def add_channel(channel, on_success)
             channels[channel] = last_message_id
-            event_loop.post(&on_success) if on_success
+            on_success.call if on_success
           end
 
           def remove_channel(channel)
@@ -101,16 +131,12 @@ module ActionCable
           end
 
           def invoke_callback(*)
-            event_loop.post { super }
+            executor.post { super }
           end
 
           private
-            attr_reader :event_loop, :thread
-            attr_writer :last_id
-
-            def last_id
-              @last_id ||= last_message_id
-            end
+            attr_reader :executor, :thread
+            attr_accessor :last_id, :reconnect_attempt
 
             def last_message_id
               ::SolidCable::Message.maximum(:id) || 0
@@ -135,6 +161,7 @@ module ActionCable
                   end
 
                   broadcast(message.channel, message.payload) if should_broadcast_message
+                  self.reconnect_attempt = 0
                   self.last_id = message.id
                 end
             end
@@ -146,6 +173,22 @@ module ActionCable
                 yield
               end
             end
+
+            def reconnect_attempts
+              @reconnect_attempts ||= ::SolidCable.reconnect_attempts
+            end
+
+            def retry_connecting?
+              self.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
         end
     end
   end

data/lib/solid_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidCable
-  VERSION = "3.0.12"
+  VERSION = "4.0.1"
 end

data/lib/solid_cable.rb

@@ -48,6 +48,12 @@ module SolidCable
       2
     end
 
+    def reconnect_attempts
+      attempts = cable_config.fetch(:reconnect_attempts, 1)
+      attempts = Array.new(attempts, 0) if attempts.is_a?(Integer)
+      attempts
+    end
+
     private
       def cable_config
         Rails.application.config_for("cable")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_cable
 version: !ruby/object:Gem::Version
-  version: 3.0.12
+  version: 4.0.1
 platform: ruby
 authors:
 - Nick Pezza
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Database-backed Action Cable backend.
 email:
 - pezza@hey.com
@@ -88,7 +102,6 @@ files:
 - lib/generators/solid_cable/update/update_generator.rb
 - lib/solid_cable.rb
 - lib/solid_cable/engine.rb
-- lib/solid_cable/railtie.rb
 - lib/solid_cable/version.rb
 - lib/tasks/solid_cable_tasks.rake
 homepage: https://github.com/rails/solid_cable
@@ -105,14 +118,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Database-backed Action Cable backend.
 test_files: []

data/lib/solid_cable/railtie.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module SolidCable
-  class Railtie < ::Rails::Railtie
-  end
-end