rails_failover 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51e57db306d29440ba74abe00ee001dc4be39121c552f3f7797cb7d0c5bfbba0
-  data.tar.gz: 10dc1a892042c6432ccd196905d744d09235abe3887cc039c46a75a1eafebcb6
+  metadata.gz: 22d00b2fbfa1a5c8fc28cae9244e93700885a41da8f1a824bf0c381d4606fafa
+  data.tar.gz: 6e9763206550dfa0101ca5680f740aae32ec9d8d452b469dc7d14c033848c56c
 SHA512:
-  metadata.gz: 8043b0080a388a26d90c06c0887455ff1e1630892beafea4171243e9aa17552b83db7d2523e95da6787c1178f883574e32b43dcc8f290e1aa1dbb0ffef153271
-  data.tar.gz: 2b604f3a8c3c4a5e2d3e33098ead78a0c426c3be6e00f9560c2753e277369f46f25523dcc20e59be664af7c59d3a82f8979f3e05bb8bb034be06f33393341835
+  metadata.gz: 4e9fafd722150cda45594b10ff642b4296c29e14bd604a8c0c8cd1fbc89706bbcd3b339c5043478056d32302c13d59b510fb77eaa0c248eb363527cf90d74715
+  data.tar.gz: 55dd5bde9d208dbf9103a73474af639ef03447e4aba5c6012937670b6f627cc5119bcd09cc8559ec6ded4b7fc895e2190d55662acf5b79e5592e8f548fb4e32d

data/.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0', '3.1', '3.2']
+        ruby: ['3.0', '3.1', '3.2']
 
     steps:
       - uses: actions/checkout@v3
@@ -59,13 +59,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2', '3.1', '3.0', '2.7']
+        ruby: ['3.2', '3.1', '3.0']
         rails: ['7.0.0']
         include:
           - ruby: '3.2'
             rails: '6.1.0'
           - ruby: '3.2'
-            rails: '6.0.0'
+            rails: 'edge'
 
     steps:
       - uses: actions/checkout@v3
@@ -97,7 +97,7 @@ jobs:
       - 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/CHANGELOG.md

@@ -5,7 +5,13 @@ 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/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [2.0.1] - 2023-05-30
+
+- FIX: Use `next` instead of `break` to avoid a local jump error
+
+## [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
 

data/README.md

@@ -37,7 +37,8 @@ production:
   replica_port: <replica db server port>
 ```
 
-The gem will automatically create an `ActiveRecord::ConnectionAdapters::ConnectionHandler` with the `ActiveRecord.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
 
@@ -53,8 +54,6 @@ 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
 
@@ -72,7 +71,7 @@ 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

data/lib/rails_failover/active_record/handler.rb

@@ -55,21 +55,15 @@ module RailsFailover
         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}'"

data/lib/rails_failover/active_record/middleware.rb

@@ -49,9 +49,8 @@ module RailsFailover
         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,
@@ -75,48 +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(
-              /#{RailsFailover::ActiveRecord.reading_role}$/,
-              RailsFailover::ActiveRecord.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(
-              /#{RailsFailover::ActiveRecord.writing_role}$/,
-              RailsFailover::ActiveRecord.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,70 +4,36 @@ 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[
-              RailsFailover::ActiveRecord.reading_role
-            ] = ::ActiveRecord::ConnectionAdapters::ConnectionHandler.new
-
-            ::ActiveRecord::Base.connection_handlers[RailsFailover::ActiveRecord.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[RailsFailover::ActiveRecord.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(RailsFailover::ActiveRecord.writing_role)
-              ::ActiveRecord::Base.connection_handler =
-                ::ActiveRecord::Base.lookup_connection_handler(:reading)
-            end
+        config = RailsFailover::ActiveRecord.config
+        next 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
 
       initializer "rails_failover.insert_middleware" do |app|
-        if app.config.active_record_rails_failover
-          ActionDispatch::DebugExceptions.register_interceptor do |request, exception|
-            RailsFailover::ActiveRecord::Interceptor.handle(request, exception)
-          end
+        next unless app.config.active_record_rails_failover
 
-          if !skip_middleware?(app.config)
-            app.middleware.unshift(::RailsFailover::ActiveRecord::Middleware)
-          end
+        ActionDispatch::DebugExceptions.register_interceptor do |request, exception|
+          RailsFailover::ActiveRecord::Interceptor.handle(request, exception)
+        end
+
+        if !skip_middleware?(app.config)
+          app.middleware.unshift(RailsFailover::ActiveRecord::Middleware)
         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

@@ -7,77 +7,73 @@ require_relative "active_record/railtie" if defined?(::Rails)
 require_relative "active_record/middleware"
 require_relative "active_record/handler"
 
-AR =
-  (
-    if ::ActiveRecord.respond_to?(:reading_role)
-      ::ActiveRecord
-    else
-      ::ActiveRecord::Base
-    end
-  )
-
 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)
-      if config[:replica_host] && config[:replica_port]
+      def verify_primary_frequency_seconds
+        @verify_primary_frequency_seconds || 5
+      end
+
+      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 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")}",
-      )
-    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.reading_role
-      AR.reading_role
-    end
+      def reading_role
+        ::ActiveRecord.try(:reading_role) || ::ActiveRecord::Base.reading_role
+      end
 
-    def self.writing_role
-      AR.writing_role
+      def writing_role
+        ::ActiveRecord.try(:writing_role) || ::ActiveRecord::Base.writing_role
+      end
     end
   end
 end

data/lib/rails_failover/version.rb

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

data/rails_failover.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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(">= 2.7.0")
+  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.
@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   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"

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: rails_failover
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Alan Tan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-08 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
@@ -237,14 +237,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.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