action-cable-redis-backport 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f6626b2fe4b7b0fd3993703be212c4f7c7f77976805827aaa11c4b1169abae9
+  data.tar.gz: 5431c9c597ee6b58a1f532482d004cda7cd2d315e82bb0dd9b6aba784523019f
+SHA512:
+  metadata.gz: 2e2c8f8e587c7cf9a4c34889affc53c5734a7f226398eda1bdfd54cbf6ed971ecbdb7fc78d4e9e20457ef5bfe021b9d30145ccc6a40959d80b92b7a21b2f58ce
+  data.tar.gz: a07efe7c9d5c81a36aea1e3604a0a86fa4e7b2642f1232eab34a5fbdd4368e3f5146428a79062f16aa03afc51fa7b01833254b64d1f3c3800d9efa9ae927fd78

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Vladimir Dementyev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+[![Gem Version](https://badge.fury.io/rb/action-cable-redis-backport.svg)](https://rubygems.org/gems/action-cable-redis-backport)
+
+# Action Cable 7.1 Redis pub/sub backport
+
+This gem backport Redis adapter with connection failure recovery support from Rails 7.1: [https://github.com/rails/rails/pull/46562](https://github.com/rails/rails/pull/46562).
+
+Works with Rails 5+.
+
+## Usage
+
+Install the gem:
+
+```ruby
+# Gemfile
+gem "action-cable-redis-backport"
+```
+
+That's it!

data/lib/action-cable-redis-backport.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "action_cable"
+
+return if ActionCable::VERSION::MAJOR >= 7 && ActionCable::VERSION::MINOR >= 1
+
+require "action_cable/subscription_adapter/redis"
+
+module ActionCableRedisBackport
+  ActionCable::SubscriptionAdapter::Redis::Listener.prepend(Module.new do
+    def initialize(*)
+      super
+
+      return if instance_variable_defined?(:@reconnect_attempt)
+
+      @subscribed_client = @raw_client = nil
+
+      @reconnect_attempt = 0
+      @reconnect_attempts = ::ActionCable.server.config.cable&.fetch("reconnect_attempts", 1)
+      @reconnect_attempts = Array.new(@reconnect_attempts, 0) if @reconnect_attempts.is_a?(Integer)
+    end
+
+    private
+      if ::Redis::VERSION < "5"
+        ConnectionError = ::Redis::ConnectionError
+      else
+        ConnectionError = RedisClient::ConnectionError
+      end
+
+      def ensure_listener_running
+        @thread ||= Thread.new do
+          Thread.current.abort_on_exception = true
+
+          begin
+            conn = @adapter.redis_connection_for_subscriptions
+            listen conn
+          rescue ConnectionError
+            reset
+            if retry_connecting?
+              when_connected { resubscribe }
+              retry
+            end
+          end
+        end
+      end
+
+      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
+        return if channels.empty?
+
+        if @subscribed_client
+          @subscribed_client.subscribe(*channels)
+        else
+          send_command("subscribe", *channels)
+        end
+      end
+
+      def reset
+        @subscription_lock.synchronize do
+          @subscribed_client = @raw_client = nil
+          @subscribe_callbacks.clear
+          @when_connected.clear
+          when_connected { @reconnect_attempt = 0 }
+        end
+      end
+  end)
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: action-cable-redis-backport
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladimir Dementyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actioncable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Backports Action Cable 7.1 Redis adapter for older versions
+email:
+- dementiev.vm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/action-cable-redis-backport.rb
+homepage: http://github.com/palkan/action-cable-redis-backport
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: http://github.com/palkan/action-cable-redis-backport/issues
+  changelog_uri: https://github.com/palkan/action-cable-redis-backport/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/action-cable-redis-backport
+  homepage_uri: http://github.com/palkan/action-cable-redis-backport
+  source_code_uri: http://github.com/palkan/action-cable-redis-backport
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Backports Action Cable 7.1 Redis adapter for older versions
+test_files: []