rails_failover 0.8.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b0f3e010743d83bd67b2cce785fde0952ba32c82c8c1ab5fef3aa56e5baa520
-  data.tar.gz: 26cc2466069dfe48b691d8676078b3ed9ee3ce82e7a8d4447fa327436741fd39
+  metadata.gz: b769d81f278cffd6d960f9a43da2feb15d46e23dd35d2608dbef0fdb04688a70
+  data.tar.gz: a72536269e00455cf0506f68dfbbdf6c98a7b7c8a24064532a7219fa31b4bec6
 SHA512:
-  metadata.gz: 5ce28a0d758dde383537bce455502edfcbf9388ad4c2835edc17b2e259156affc885153f728e39fa66c8c25d3f9dfea34a8f489b663e7738fc092dc6c76dccb8
-  data.tar.gz: 0f0c08446e0e64c5eb6ee972e80e8776e58fbd32877254e50098a17a4d4475db64379d7ad237933b054e5eaf7c54df72785c69253e7d31be1b28d38028fcaf11
+  metadata.gz: 33f8835985676d80ba1701eda774322db0701040691e3164218bbf931901314a277ad63c926634f7ac6270f43e5899a7a90030b03f7ec53badb618bac0a187b3
+  data.tar.gz: a219d8441c37438bc1ea367fc99920cf3090728a5be482dd59a68f80a5690effa3f2a2a059085675980ed2e816e662ca3c485b12543437bde2801e07d4adfa6b

data/.github/workflows/ci.yml

@@ -4,75 +4,100 @@ on:
   pull_request:
   push:
     branches:
-      - master
       - main
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
 
-    env:
-      BUILD_TYPE: ${{ matrix.build_types }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bundle exec rubocop
+
+      - name: syntax_tree
+        if: ${{ !cancelled() }}
+        run: |
+          set -E
+          bundle exec stree check Gemfile rails_failover.gemspec $(git ls-files '*.rb')
+
+  redis:
+    name: 'Redis (Ruby ${{ matrix.ruby }})'
+    runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
-        build_types: ["REDIS", "ACTIVERECORD"]
-        include:
-          - ruby: "3.1"
-            build_types: "LINT"
+        ruby: ['3.0', '3.1', '3.2']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - name: Setup bundler
-        run: gem install bundler
-
-      - name: Setup gems
-        run: bundle install
-
-      - name: Rubocop
-        run: bundle exec rubocop
-        if: env.BUILD_TYPE == 'LINT'
+          bundler-cache: true
 
       - name: Setup redis
         run: sudo apt-get install redis-server
-        if: env.BUILD_TYPE == 'REDIS'
 
       - name: Redis specs
         run: bin/rspec redis
-        if: env.BUILD_TYPE == 'REDIS'
 
-      - name: Setup test app gems
-        run: cd spec/support/dummy_app && bundle install
-        if: env.BUILD_TYPE == 'ACTIVERECORD'
+  active_record:
+    runs-on: ubuntu-latest
+    name: 'ActiveRecord ~>${{ matrix.rails }} (Ruby ${{ matrix.ruby }})'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.1', '3.0']
+        rails: ['7.0.0']
+        include:
+          - ruby: '3.2'
+            rails: '6.1.0'
+          - ruby: '3.2'
+            rails: 'edge'
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Setup gems
+        run: bundle install
 
       - name: Setup postgres
         run: |
           make setup_pg
           make start_pg
-        if: env.BUILD_TYPE == 'ACTIVERECORD'
 
       - name: ActiveRecord specs
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
         run: bin/rspec active_record
-        if: env.BUILD_TYPE == 'ACTIVERECORD'
 
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
-    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [lint, redis, active_record]
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2
+        uses: discourse/publish-rubygems-action@v3
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           GIT_EMAIL: team@discourse.org

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - spec/support/dummy_app/**/*
+    - vendor/**/*
 
 inherit_gem:
   rubocop-discourse: default.yml

data/.streerc

@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma,disable_ternary

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2023-05-16
+
+- DEV: Compatibility with Rails 7.1+ (drop support for Rails 6.0 & ruby 2.7)
+
+## [1.0.0] - 2023-04-07
+
+- DEV: Remove the support for Ruby < 2.7
+- DEV: Compatibility with Rails 7.1+
+
 ## [0.8.0] - 2022-01-17
 
 - FEATURE: Compatibility with Rails 7.0+
@@ -20,7 +30,7 @@ No changes.
 
 ## [0.7.1] - 2021-04-14
 
-- FIX: Backward compatability with Rails 6.0
+- FIX: Backward compatibility with Rails 6.0
 
 ## [0.7.0] - 2021-04-14
 
@@ -49,6 +59,7 @@ No changes.
   Previously, a replica failing would cause it to be added to the 'primaries_down' list. The fallback handler would then continuously try and fallback the replica to itself, looping forever, and meaning that fallback to primary would never happen.
 
 ## [0.6.0] - 2020-11-09
+
 - FEATURE: Run failover/fallback callbacks once for each backend
 
   Previously the failover callback would only fire when the first backend failed, and the fallback callback would only fire when the last backend recovered. Now both failover and fallback callbacks will be triggered for each backend. The key for each backend is also passed to the callbacks for consumption by consuming applications.
@@ -58,6 +69,7 @@ No changes.
   This is intended for consumption by monitoring systems (e.g. the Discourse prometheus exporter)
 
 ## [0.5.9] - 2020-11-06
+
 - FIX: Ignore errors from the redis socket shutdown call
 
   This can fail with various i/o errors, but in all cases we want the thread to continue closing the connection with the error, and all the other connections.
@@ -67,6 +79,7 @@ No changes.
 - FIX: Handle concurrency issues during redis disconnection (#10)
 
   This handles concurrency issues which can happen during redis failover/fallback:
+
   - Previously, 'subscribed' redis clients were skipped during the disconnect process. This is resolved by directly accessing the original_client from the ::Redis instance
   - Trying to acquire the mutex on a subscribed redis client is impossible, so the close operation would never complete. Now we send the shutdown() signal to the thread, then allow up to 1 second for the mutex to be released before we close the socket
   - Failover is almost always triggered inside a redis client mutex. Failover then has its own mutex, within which we attempted to acquire mutexes for all redis clients. This logic causes a deadlock when multiple clients failover simultaneously. Now, all disconnection is performed by the Redis::Handler failover thread, outside of any other mutexes. To make this safe, the primary/replica state is stored in the connection driver, and disconnect_clients is updated to specifically target primary/replica connections.
@@ -107,4 +120,5 @@ No changes.
 ## [0.5.2] - 2020-06-23
 
 ### Changed
+
 - FIX: Only rescue from connection errors.

data/Gemfile

@@ -3,12 +3,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in rails_failover.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem 'rubocop-discourse'
-gem 'byebug'
-gem 'redis', '~> 4.1'
-gem 'pg', '~> 1.2'
-gem 'activerecord', '~> 6.0'
-gem 'rack'

data/README.md

@@ -3,7 +3,7 @@
 Automatic failover and recovery for primary/replica setup for:
 
 1. Redis
-1. ActiveRecord (PostgreSQL/MySQL Adapters)
+2. ActiveRecord (PostgreSQL/MySQL Adapters)
 
 ## Installation
 
@@ -29,7 +29,7 @@ In `config/application.rb` add `require 'rails_failover/active_record'` after `r
 
 In your database configuration, simply add `replica_host` and `replica_port` to your database configuration.
 
-```
+```yml
 production:
   host: <primary db server host>
   port: <primary db server port>
@@ -37,11 +37,12 @@ production:
   replica_port: <replica db server port>
 ```
 
-The gem will automatically create an `ActiveRecord::ConnectionAdapters::ConnectionHandler` with the `ActiveRecord::Base.reading_role` as the `handler_key`.
+The gem will automatically create a role (using `ActiveRecord.reading_role`) on
+the default `ActiveRecord` connection handler.
 
 #### Failover/Fallback Hooks
 
-```
+```ruby
 RailsFailover::ActiveRecord.on_failover do
   # Enable readonly mode
 end
@@ -53,9 +54,7 @@ end
 
 #### Multiple connection handlers
 
-Note: This API is unstable and is likely to change when Rails 6.1 is released with sharding support.
-
-```
+```yml
 # config/database.yml
 
 production:
@@ -72,20 +71,20 @@ production:
 
 # In your ActiveRecord base model or model.
 
-connects_to database: { writing: :primary, second_database_writing: :second_database_writing
+connects_to database: { writing: :primary, second_database_writing: :second_database_writing }
 ```
 
 ### Redis
 
 Add `require 'rails_failover/redis'` before creating a `Redis` instance.
 
-```
-Redis.new(host: "127.0.0.1", port: 6379, replica_host: "127.0.0.1", replica_port: 6380, connector: RailsFailover::Redis::Connector))
+```ruby
+Redis.new(host: "127.0.0.1", port: 6379, replica_host: "127.0.0.1", replica_port: 6380, connector: RailsFailover::Redis::Connector)
 ```
 
 Callbacks can be registered when the primary connection is down and when it is up.
 
-```
+```ruby
 RailsFailover::Redis.on_failover_callback do
   # Switch site to read-only mode
 end
@@ -108,8 +107,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 The ActiveRecord failover tests are run against a dummy Rails server. Run the following commands to run the test:
 
 1. `make setup_pg`
-1. `make start_pg`
-1. `bin/rspec active_record`. You may also run the tests with more unicorn workers by adding the `UNICORN_WORKERS` env variable.
+2. `make start_pg`
+3. `bin/rspec active_record`. You may also run the tests with more unicorn workers by adding the `UNICORN_WORKERS` env variable.
 
 #### Redis
 

data/lib/rails_failover/active_record/handler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require 'singleton'
-require 'monitor'
-require 'concurrent'
+require "singleton"
+require "monitor"
+require "concurrent"
 
 module RailsFailover
   module ActiveRecord
@@ -9,7 +9,7 @@ module RailsFailover
       include Singleton
       include MonitorMixin
 
-      VERIFY_FREQUENCY_BUFFER_PRECENT = 20
+      VERIFY_FREQUENCY_BUFFER_PERCENT = 20
 
       def initialize
         @primaries_down = Concurrent::Map.new
@@ -50,26 +50,20 @@ module RailsFailover
 
       def initiate_fallback_to_primary
         frequency = RailsFailover::ActiveRecord.verify_primary_frequency_seconds
-        sleep(frequency * ((rand(VERIFY_FREQUENCY_BUFFER_PRECENT) + 100) / 100.0))
+        sleep(frequency * ((rand(VERIFY_FREQUENCY_BUFFER_PERCENT) + 100) / 100.0))
 
         active_handler_keys = []
 
         primaries_down.keys.each do |handler_key|
-          connection_handler = ::ActiveRecord::Base.connection_handlers[handler_key]
-
-          connection_pool = connection_handler.retrieve_connection_pool(spec_name)
-          if connection_pool.respond_to?(:db_config)
-            config = connection_pool.db_config.configuration_hash
-            adapter_method = connection_pool.db_config.adapter_method
-          else
-            config = connection_pool.spec.config
-            adapter_method = connection_pool.spec.adapter_method
-          end
           logger.debug "#{Process.pid} Checking server for '#{handler_key} #{spec_name}'..."
           connection_active = false
 
           begin
-            connection = ::ActiveRecord::Base.public_send(adapter_method, config)
+            connection =
+              ::ActiveRecord::Base.connection_handler.retrieve_connection(
+                spec_name,
+                role: handler_key,
+              )
             connection_active = connection.active?
           rescue => e
             logger.debug "#{Process.pid} Connection to server for '#{handler_key} #{spec_name}' failed with '#{e.message}'"
@@ -83,9 +77,7 @@ module RailsFailover
           end
         end
 
-        active_handler_keys.each do |handler_key|
-          primary_up(handler_key)
-        end
+        active_handler_keys.each { |handler_key| primary_up(handler_key) }
       end
 
       def all_primaries_up
@@ -108,10 +100,11 @@ module RailsFailover
 
       def primaries_down
         ancestor_pids = nil
-        value = @primaries_down.compute_if_absent(Process.pid) do
-          ancestor_pids = @primaries_down.keys
-          @primaries_down.values.first || Concurrent::Map.new
-        end
+        value =
+          @primaries_down.compute_if_absent(Process.pid) do
+            ancestor_pids = @primaries_down.keys
+            @primaries_down.values.first || Concurrent::Map.new
+          end
 
         ancestor_pids&.each do |pid|
           @primaries_down.delete(pid)&.each_key { |key| verify_primary(key) }

data/lib/rails_failover/active_record/middleware.rb

@@ -4,20 +4,18 @@ module RailsFailover
   module ActiveRecord
     class Interceptor
       def self.adapter_errors
-        @adapter_errors ||= begin
-          if defined?(::PG)
-            [::PG::UnableToSend, ::PG::ConnectionBad]
-          elsif defined?(::Mysql2)
-            [::Mysql2::Error::ConnectionError]
+        @adapter_errors ||=
+          begin
+            if defined?(::PG)
+              [::PG::UnableToSend, ::PG::ConnectionBad]
+            elsif defined?(::Mysql2)
+              [::Mysql2::Error::ConnectionError]
+            end
           end
-        end
       end
 
       def self.handle(request, exception)
-        verify_primary(
-          exception,
-          request.env[Middleware::WRITING_ROLE_HEADER]
-        )
+        verify_primary(exception, request.env[Middleware::WRITING_ROLE_HEADER])
       end
 
       def self.verify_primary(exception, writing_role)
@@ -29,11 +27,7 @@ module RailsFailover
       end
 
       def self.resolve_cause(exception)
-        if exception.cause
-          resolve_cause(exception.cause)
-        else
-          exception
-        end
+        exception.cause ? resolve_cause(exception.cause) : exception
       end
     end
 
@@ -50,14 +44,18 @@ module RailsFailover
       end
 
       def call(env)
-        current_role = ::ActiveRecord::Base.current_role || ::ActiveRecord::Base.writing_role
-        is_writing_role = current_role.to_s.end_with?(::ActiveRecord::Base.writing_role.to_s)
+        current_role = ::ActiveRecord::Base.current_role || RailsFailover::ActiveRecord.writing_role
+        is_writing_role = current_role.to_s.end_with?(RailsFailover::ActiveRecord.writing_role.to_s)
         writing_role = resolve_writing_role(current_role, is_writing_role)
 
         role =
-          if primary_down = self.class.force_reading_role_callback&.call(env) || Handler.instance.primary_down?(writing_role)
+          if self.class.force_reading_role_callback&.call(env) ||
+               Handler.instance.primary_down?(writing_role)
             reading_role = resolve_reading_role(current_role, is_writing_role)
-            ensure_reading_connection_established!(writing_role: writing_role, reading_role: reading_role)
+            ensure_reading_connection_established!(
+              writing_role: writing_role,
+              reading_role: reading_role,
+            )
             reading_role
           else
             writing_role
@@ -76,42 +74,39 @@ module RailsFailover
       private
 
       def ensure_reading_connection_established!(writing_role:, reading_role:)
-        ::ActiveRecord::Base.connection_handlers[reading_role] ||= begin
-          handler = ::ActiveRecord::ConnectionAdapters::ConnectionHandler.new
-
-          ::ActiveRecord::Base.connection_handlers[writing_role].connection_pools.each do |pool|
-            if pool.respond_to?(:db_config)
-              config = pool.db_config.configuration_hash
-            else
-              config = pool.spec.config
-            end
-            ::RailsFailover::ActiveRecord.establish_reading_connection(handler, config)
+        connection_handler = ::ActiveRecord::Base.connection_handler
+        connection_handler
+          .connection_pools(writing_role)
+          .each do |connection_pool|
+            config = connection_pool.db_config.configuration_hash
+            RailsFailover::ActiveRecord.establish_reading_connection(
+              connection_handler,
+              config,
+              role: reading_role,
+            )
           end
-
-          handler
-        end
       end
 
       def resolve_writing_role(current_role, is_writing_role)
-        if is_writing_role
-          current_role
-        else
-          current_role.to_s.sub(
-            /#{::ActiveRecord::Base.reading_role}$/,
-            ::ActiveRecord::Base.writing_role.to_s
-          ).to_sym
-        end
+        return current_role if is_writing_role
+        current_role
+          .to_s
+          .sub(
+            /#{RailsFailover::ActiveRecord.reading_role}$/,
+            RailsFailover::ActiveRecord.writing_role.to_s,
+          )
+          .to_sym
       end
 
       def resolve_reading_role(current_role, is_writing_role)
-        if is_writing_role
-          current_role.to_s.sub(
-            /#{::ActiveRecord::Base.writing_role}$/,
-            ::ActiveRecord::Base.reading_role.to_s
-          ).to_sym
-        else
-          current_role
-        end
+        return current_role unless is_writing_role
+        current_role
+          .to_s
+          .sub(
+            /#{RailsFailover::ActiveRecord.writing_role}$/,
+            RailsFailover::ActiveRecord.reading_role.to_s,
+          )
+          .to_sym
       end
     end
   end

data/lib/rails_failover/active_record/railtie.rb

@@ -4,48 +4,18 @@ module RailsFailover
   module ActiveRecord
     class Railtie < ::Rails::Railtie
       initializer "rails_failover.init", after: "active_record.initialize_database" do |app|
-
-        # AR 6.0 / 6.1 compat
-        config =
-          if ::ActiveRecord::Base.respond_to? :connection_db_config
-            ::ActiveRecord::Base.connection_db_config.configuration_hash
-          else
-            ::ActiveRecord::Base.connection_config
-          end
-
         app.config.active_record_rails_failover = false
-
-        if !!(config[:replica_host] && config[:replica_port])
-          app.config.active_record_rails_failover = true
-
-          ::ActiveSupport.on_load(:active_record) do
-            Handler.instance
-
-            # We are doing this manually for now since we're awaiting Rails 6.1 to be released which will
-            # have more stable ActiveRecord APIs for handling multiple databases with different roles.
-            ::ActiveRecord::Base.connection_handlers[::ActiveRecord::Base.reading_role] =
-              ::ActiveRecord::ConnectionAdapters::ConnectionHandler.new
-
-            ::ActiveRecord::Base.connection_handlers[::ActiveRecord::Base.writing_role].connection_pools.each do |connection_pool|
-              if connection_pool.respond_to?(:db_config)
-                config = connection_pool.db_config.configuration_hash
-              else
-                config = connection_pool.spec.config
-              end
-              RailsFailover::ActiveRecord.establish_reading_connection(
-                ::ActiveRecord::Base.connection_handlers[::ActiveRecord::Base.reading_role],
-                config
-              )
-            end
-
-            begin
-              ::ActiveRecord::Base.connection
-            rescue ::ActiveRecord::NoDatabaseError
-              # Do nothing since database hasn't been created
-            rescue ::PG::Error, ::ActiveRecord::ConnectionNotEstablished
-              Handler.instance.verify_primary(::ActiveRecord::Base.writing_role)
-              ::ActiveRecord::Base.connection_handler = ::ActiveRecord::Base.lookup_connection_handler(:reading)
-            end
+        config = RailsFailover::ActiveRecord.config
+        break unless config[:replica_host] && config[:replica_port]
+
+        app.config.active_record_rails_failover = true
+        ::ActiveSupport.on_load(:active_record) do
+          begin
+            ::ActiveRecord::Base.connection
+          rescue ::ActiveRecord::NoDatabaseError
+            # Do nothing since database hasn't been created
+          rescue ::PG::Error, ::ActiveRecord::ConnectionNotEstablished
+            Handler.instance.verify_primary(RailsFailover::ActiveRecord.writing_role)
           end
         end
       end
@@ -57,14 +27,13 @@ module RailsFailover
           end
 
           if !skip_middleware?(app.config)
-            app.middleware.unshift(::RailsFailover::ActiveRecord::Middleware)
+            app.middleware.unshift(RailsFailover::ActiveRecord::Middleware)
           end
         end
       end
 
       def skip_middleware?(config)
-        return false if !config.respond_to?(:skip_rails_failover_active_record_middleware)
-        config.skip_rails_failover_active_record_middleware
+        config.try(:skip_rails_failover_active_record_middleware)
       end
     end
   end

data/lib/rails_failover/active_record.rb

@@ -1,65 +1,79 @@
 # frozen_string_literal: true
 
-require 'active_record'
+require "active_record"
 
-if defined?(::Rails)
-  require_relative 'active_record/railtie'
-end
+require_relative "active_record/railtie" if defined?(::Rails)
 
-require_relative 'active_record/middleware'
-require_relative 'active_record/handler'
+require_relative "active_record/middleware"
+require_relative "active_record/handler"
 
 module RailsFailover
   module ActiveRecord
-    def self.logger=(logger)
-      @logger = logger
-    end
+    class << self
+      def config
+        ::ActiveRecord::Base.connection_db_config.configuration_hash
+      end
 
-    def self.logger
-      @logger || Rails.logger
-    end
+      def logger=(logger)
+        @logger = logger
+      end
 
-    def self.verify_primary_frequency_seconds=(seconds)
-      @verify_primary_frequency_seconds = seconds
-    end
+      def logger
+        @logger || Rails.logger
+      end
 
-    def self.verify_primary_frequency_seconds
-      @verify_primary_frequency_seconds || 5
-    end
+      def verify_primary_frequency_seconds=(seconds)
+        @verify_primary_frequency_seconds = seconds
+      end
 
-    def self.establish_reading_connection(handler, config)
+      def verify_primary_frequency_seconds
+        @verify_primary_frequency_seconds || 5
+      end
 
-      if config[:replica_host] && config[:replica_port]
+      def establish_reading_connection(handler, config, role: reading_role)
+        return unless config[:replica_host] && config[:replica_port]
         replica_config = config.dup
         replica_config[:host] = replica_config.delete(:replica_host)
         replica_config[:port] = replica_config.delete(:replica_port)
         replica_config[:replica] = true
-        handler.establish_connection(replica_config)
+        handler.establish_connection(replica_config, role: role)
       end
-    end
 
-    def self.register_force_reading_role_callback(&block)
-      Middleware.force_reading_role_callback = block
-    end
+      def register_force_reading_role_callback(&block)
+        Middleware.force_reading_role_callback = block
+      end
 
-    def self.on_failover(&block)
-      @on_failover_callback = block
-    end
+      def on_failover(&block)
+        @on_failover_callback = block
+      end
 
-    def self.on_failover_callback!(key)
-      @on_failover_callback&.call(key)
-    rescue => e
-      logger.warn("RailsFailover::ActiveRecord.on_failover failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
-    end
+      def on_failover_callback!(key)
+        @on_failover_callback&.call(key)
+      rescue => e
+        logger.warn(
+          "RailsFailover::ActiveRecord.on_failover failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}",
+        )
+      end
 
-    def self.on_fallback(&block)
-      @on_fallback_callback = block
-    end
+      def on_fallback(&block)
+        @on_fallback_callback = block
+      end
+
+      def on_fallback_callback!(key)
+        @on_fallback_callback&.call(key)
+      rescue => e
+        logger.warn(
+          "RailsFailover::ActiveRecord.on_fallback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}",
+        )
+      end
 
-    def self.on_fallback_callback!(key)
-      @on_fallback_callback&.call(key)
-    rescue => e
-      logger.warn("RailsFailover::ActiveRecord.on_fallback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
+      def reading_role
+        ::ActiveRecord.try(:reading_role) || ::ActiveRecord::Base.reading_role
+      end
+
+      def writing_role
+        ::ActiveRecord.try(:writing_role) || ::ActiveRecord::Base.writing_role
+      end
     end
   end
 end

data/lib/rails_failover/redis/connector.rb

@@ -1,22 +1,21 @@
 # frozen_string_literal: true
 
-require_relative 'handler'
+require_relative "handler"
 
 module RailsFailover
   class Redis
     class Connector < ::Redis::Client::Connector
       def initialize(options)
-        orignal_driver = options[:driver]
+        original_driver = options[:driver]
         options[:primary_host] = options[:host]
         options[:primary_port] = options[:port]
 
         options[:driver] = Class.new(options[:driver]) do
           def self.connect(options)
-            is_primary = (options[:host] == options[:primary_host]) &&
-                         (options[:port] == options[:primary_port])
-            super(options).tap do |conn|
-              conn.rails_failover_role = is_primary ? PRIMARY : REPLICA
-            end
+            is_primary =
+              (options[:host] == options[:primary_host]) &&
+                (options[:port] == options[:primary_port])
+            super(options).tap { |conn| conn.rails_failover_role = is_primary ? PRIMARY : REPLICA }
           rescue ::Redis::TimeoutError,
                  SocketError,
                  Errno::EADDRNOTAVAIL,
@@ -27,7 +26,6 @@ module RailsFailover
                  Errno::ENOENT,
                  Errno::ETIMEDOUT,
                  Errno::EINVAL => e
-
             Handler.instance.verify_primary(options) if is_primary
             raise e
           end
@@ -40,7 +38,7 @@ module RailsFailover
           end
         end
 
-        options[:original_driver] = orignal_driver
+        options[:original_driver] = original_driver
         options.delete(:connector)
         options[:id] ||= "#{options[:host]}:#{options[:port]}"
         @replica_options = replica_options(options)
@@ -48,11 +46,7 @@ module RailsFailover
       end
 
       def resolve
-        if Handler.instance.primary_down?(@options)
-          @replica_options
-        else
-          @options
-        end
+        Handler.instance.primary_down?(@options) ? @replica_options : @options
       end
 
       def check(client)

data/lib/rails_failover/redis/handler.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'monitor'
-require 'singleton'
-require 'concurrent'
+require "monitor"
+require "singleton"
+require "concurrent"
 
 module RailsFailover
   class Redis
@@ -12,7 +12,7 @@ module RailsFailover
 
       PRIMARY_ROLE_STATUS = "role:master"
       PRIMARY_LOADED_STATUS = "loading:0"
-      VERIFY_FREQUENCY_BUFFER_PRECENT = 20
+      VERIFY_FREQUENCY_BUFFER_PERCENT = 20
       SOFT_DISCONNECT_TIMEOUT_SECONDS = 1
       SOFT_DISCONNECT_POLL_SECONDS = 0.05
 
@@ -67,7 +67,7 @@ module RailsFailover
 
       def try_fallback_to_primary
         frequency = RailsFailover::Redis.verify_primary_frequency_seconds
-        sleep(frequency * ((rand(VERIFY_FREQUENCY_BUFFER_PRECENT) + 100) / 100.0))
+        sleep(frequency * ((rand(VERIFY_FREQUENCY_BUFFER_PERCENT) + 100) / 100.0))
 
         active_primaries_keys = {}
 
@@ -114,10 +114,11 @@ module RailsFailover
 
       def primaries_down
         ancestor_pids = nil
-        value = @primaries_down.compute_if_absent(Process.pid) do
-          ancestor_pids = @primaries_down.keys
-          @primaries_down.values.first || Concurrent::Map.new
-        end
+        value =
+          @primaries_down.compute_if_absent(Process.pid) do
+            ancestor_pids = @primaries_down.keys
+            @primaries_down.values.first || Concurrent::Map.new
+          end
 
         ancestor_pids&.each do |pid|
           @primaries_down.delete(pid)&.each { |id, options| verify_primary(options) }
@@ -132,10 +133,11 @@ module RailsFailover
 
       def clients
         ancestor_pids = nil
-        clients_for_pid = @clients.compute_if_absent(Process.pid) do
-          ancestor_pids = @clients.keys
-          Concurrent::Map.new
-        end
+        clients_for_pid =
+          @clients.compute_if_absent(Process.pid) do
+            ancestor_pids = @clients.keys
+            Concurrent::Map.new
+          end
         ancestor_pids&.each { |k| @clients.delete(k) }
         clients_for_pid
       end
@@ -149,9 +151,8 @@ module RailsFailover
       def disconnect_clients(options, role)
         id = options[:id]
 
-        matched_clients = clients_for_id(id)&.keys
-          &.filter { |c| c.connection.rails_failover_role == role }
-          &.to_set
+        matched_clients =
+          clients_for_id(id)&.keys&.filter { |c| c.connection.rails_failover_role == role }&.to_set
 
         return if matched_clients.nil? || matched_clients.empty?
 

data/lib/rails_failover/redis.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'redis'
+require "redis"
 
-supported_version = '4'
+supported_version = "4"
 
 if Gem::Version.new(Redis::VERSION) < Gem::Version.new(supported_version)
   raise "redis #{Redis::VERSION} is not supported. Please upgrade to Redis #{supported_version}."
 end
 
 require_relative "../redis/patches/client"
-require_relative 'redis/connector'
+require_relative "redis/connector"
 
 module RailsFailover
   class Redis
@@ -43,7 +43,9 @@ module RailsFailover
     def self.on_failover_callback!(key)
       @on_failover_callback&.call(key)
     rescue => e
-      logger.warn("RailsFailover::Redis.on_failover failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
+      logger.warn(
+        "RailsFailover::Redis.on_failover failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}",
+      )
     end
 
     def self.on_fallback(&block)
@@ -53,7 +55,9 @@ module RailsFailover
     def self.on_fallback_callback!(key)
       @on_fallback_callback&.call(key)
     rescue => e
-      logger.warn("RailsFailover::Redis.on_fallback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}")
+      logger.warn(
+        "RailsFailover::Redis.on_fallback failed: #{e.class} #{e.message}\n#{e.backtrace.join("\n")}",
+      )
     end
 
     # For testing

data/lib/rails_failover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsFailover
-  VERSION = "0.8.1"
+  VERSION = "2.0.0"
 end

data/lib/rails_failover.rb

@@ -3,5 +3,6 @@
 require "rails_failover/version"
 
 module RailsFailover
-  class Error < StandardError; end
+  class Error < StandardError
+  end
 end

data/lib/redis/patches/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'redis'
+require "redis"
 
 # See https://github.com/redis/redis-rb/pull/908
 class Redis::Client

data/makefile

@@ -9,13 +9,13 @@ test_active_record:
 	@ACTIVE_RECORD=1 bundle exec rspec --tag type:active_record ${RSPEC_PATH}
 
 setup_dummy_rails_server:
-	@cd spec/support/dummy_app && bundle install --quiet && yarn install && RAILS_ENV=production $(BUNDLER_BIN) exec rails db:create db:migrate db:seed
+	@cd spec/support/dummy_app && BUNDLE_GEMFILE=Gemfile bundle install --quiet && yarn install && BUNDLE_GEMFILE=Gemfile RAILS_ENV=production $(BUNDLER_BIN) exec rails db:create db:migrate db:seed
 
 start_dummy_rails_server:
-	@cd spec/support/dummy_app && BUNDLE_GEMFILE=Gemfile UNICORN_WORKERS=5 SECRET_KEY_BASE=somekey bundle exec unicorn -c config/unicorn.conf.rb -D -E production
+	@cd spec/support/dummy_app && BUNDLE_GEMFILE=Gemfile SECRET_KEY_BASE=somekey bundle exec unicorn -c config/unicorn.conf.rb -D -E production
 
 stop_dummy_rails_server:
 	@kill -TERM $(shell cat spec/support/dummy_app/tmp/pids/unicorn.pid)
 
 teardown_dummy_rails_server:
-	@cd spec/support/dummy_app && (! (bundle check > /dev/null 2>&1) || DISABLE_DATABASE_ENVIRONMENT_CHECK=1 RAILS_ENV=production $(BUNDLER_BIN) exec rails db:drop)
+	@cd spec/support/dummy_app && (! (bundle check > /dev/null 2>&1) || BUNDLE_GEMFILE=Gemfile DISABLE_DATABASE_ENVIRONMENT_CHECK=1 RAILS_ENV=production $(BUNDLER_BIN) exec rails db:drop)

data/rails_failover.gemspec

@@ -1,29 +1,39 @@
 # frozen_string_literal: true
 
-require_relative 'lib/rails_failover/version'
+require_relative "lib/rails_failover/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "rails_failover"
-  spec.version       = RailsFailover::VERSION
-  spec.authors       = ["Alan Tan"]
-  spec.email         = ["tgx@discourse.org"]
+  spec.name = "rails_failover"
+  spec.version = RailsFailover::VERSION
+  spec.authors = ["Alan Tan"]
+  spec.email = ["tgx@discourse.org"]
 
-  spec.summary       = %q{Failover for ActiveRecord and Redis}
-  spec.homepage      = "https://github.com/discourse/rails_failover"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.summary = "Failover for ActiveRecord and Redis"
+  spec.homepage = "https://github.com/discourse/rails_failover"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files =
+    Dir.chdir(File.expand_path("..", __FILE__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "> 6.0", "< 7.1"
-  spec.add_dependency "railties", "> 6.0", "< 7.1"
-
+  spec.add_dependency "activerecord", ">= 6.1", "<= 7.1"
+  spec.add_dependency "railties", ">= 6.1", "<= 7.1"
   spec.add_dependency "concurrent-ruby"
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "redis", "~> 4.1"
+  spec.add_development_dependency "pg", "~> 1.2"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rubocop-discourse"
+  spec.add_development_dependency "syntax_tree"
+  spec.add_development_dependency "syntax_tree-disable_ternary"
 end

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: rails_failover
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Alan Tan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
+        version: '6.1'
+    - - "<="
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
+        version: '6.1'
+    - - "<="
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
+        version: '6.1'
+    - - "<="
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
+        version: '6.1'
+    - - "<="
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
@@ -64,6 +64,132 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-discourse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree-disable_ternary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tgx@discourse.org
@@ -75,6 +201,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".streerc"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -110,14 +237,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Failover for ActiveRecord and Redis