rails_failover 0.6.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 651969085a16547763a2df77d40285f300c602fea51089989ec4b6fe62832c3d
-  data.tar.gz: aed0094cc23da42f1870ace6b94badc64493f2bf85053ab387bd22919c5e939a
+  metadata.gz: 146164de9729fe33317969e8d3ca2c5c79980e947f93dfd32b6673a1a95061a6
+  data.tar.gz: d3e6eb2cee6bcf663115e72c9e62d62e3f869753549fdcff55381ca4405842c1
 SHA512:
-  metadata.gz: b9310d55228dee7660d2e616349b014652c5eb5559b5db0f85a915500dfdde693843d6f9c1abb3195749bb7d7b4cfe1ca3341deedb1e8b68b86c7d14c567485f
-  data.tar.gz: 81bb776dac713ab01d1833346658be050488b3c24687bd4c603b3e47b3c444e83bb709074576e4a796da637a449914e6916420b505176a022fd51b92b6a42115
+  metadata.gz: 1554851137a5251f524574f7d0120924910ad3dc755ad336e9c29c7404cf515d79dad9cb538f06b4084363d919f37586f412f5702fb92a2c85678bd161349fd3
+  data.tar.gz: 0f2a72692577a2be3d961da51be3ba150b7e7311fbe2932b062443d2a10dba6014e04268be105a815ab08169b542aa0d3a26dbe36611f036eecdc7a17bb527ac

data/.github/workflows/ci.yml

@@ -5,8 +5,7 @@ on:
   push:
     branches:
       - master
-    tags:
-      - v*
+      - main
 
 jobs:
   build:
@@ -18,22 +17,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby:
-          - 2.6
-          - 2.7
-        build_types: ["LINT", "REDIS", "ACTIVERECORD"]
-        exclude:
-          - ruby: 2.6
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        build_types: ["REDIS", "ACTIVERECORD"]
+        include:
+          - ruby: "3.1"
             build_types: "LINT"
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
 
       - name: Setup bundler
         run: gem install bundler
@@ -68,7 +64,7 @@ jobs:
         if: env.BUILD_TYPE == 'ACTIVERECORD'
 
   publish:
-    if: contains(github.ref, 'refs/tags/v')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
     needs: build
     runs-on: ubuntu-latest
 
@@ -76,6 +72,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Release Gem
-        uses: CvX/publish-rubygems-action@master
+        uses: discourse/publish-rubygems-action@v2
         env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.gitignore

@@ -16,3 +16,4 @@
 *.rdb
 
 *.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -6,6 +6,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2022-01-17
+
+- FEATURE: Compatibility with Rails 7.0+
+
+## [0.7.3] - 2021-04-15
+
+- FEATURE: Compatibility with Rails 6.1
+
+## [0.7.2] - 2021-04-14
+
+No changes.
+
+## [0.7.1] - 2021-04-14
+
+- FIX: Backward compatability with Rails 6.0
+
+## [0.7.0] - 2021-04-14
+
+- FEATURE: Partial compatibility with Rails 6.1
+
+## [0.6.5] - 2020-12-16
+
+- FIX: Catch exceptions that are not intercepted by `ActionDispatch::DebugExceptions`.
+
 ## [0.6.4] - 2020-12-09
 
 - FIX: Handle the case when the replica is set equal to the primary
@@ -31,7 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - FEATURE: Add primaries_down_count function to failover handlers
 
-  This is intended for consumption by monitoring systems (e.g. the Discourse prometheus exporter) 
+  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

data/lib/rails_failover/active_record/handler.rb

@@ -56,13 +56,20 @@ module RailsFailover
 
         primaries_down.keys.each do |handler_key|
           connection_handler = ::ActiveRecord::Base.connection_handlers[handler_key]
-          spec = connection_handler.retrieve_connection_pool(spec_name).spec
-          config = spec.config
+
+          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(spec.adapter_method, config)
+            connection = ::ActiveRecord::Base.public_send(adapter_method, config)
             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

@@ -14,10 +14,17 @@ module RailsFailover
       end
 
       def self.handle(request, exception)
+        verify_primary(
+          exception,
+          request.env[Middleware::WRITING_ROLE_HEADER]
+        )
+      end
+
+      def self.verify_primary(exception, writing_role)
         exception = resolve_cause(exception)
 
         if adapter_errors.any? { |error| exception.is_a?(error) }
-          Handler.instance.verify_primary(request.env[Middleware::WRITING_ROLE_HEADER])
+          Handler.instance.verify_primary(writing_role)
         end
       end
 
@@ -61,6 +68,9 @@ module RailsFailover
           env[WRITING_ROLE_HEADER] = writing_role
           @app.call(env)
         end
+      rescue => e
+        Interceptor.verify_primary(e, writing_role) if writing_role
+        raise e
       end
 
       private
@@ -70,7 +80,12 @@ module RailsFailover
           handler = ::ActiveRecord::ConnectionAdapters::ConnectionHandler.new
 
           ::ActiveRecord::Base.connection_handlers[writing_role].connection_pools.each do |pool|
-            ::RailsFailover::ActiveRecord.establish_reading_connection(handler, pool.spec)
+            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)
           end
 
           handler

data/lib/rails_failover/active_record/railtie.rb

@@ -4,7 +4,15 @@ module RailsFailover
   module ActiveRecord
     class Railtie < ::Rails::Railtie
       initializer "rails_failover.init", after: "active_record.initialize_database" do |app|
-        config = ::ActiveRecord::Base.connection_config
+
+        # 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])
@@ -19,9 +27,14 @@ module RailsFailover
               ::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],
-                connection_pool.spec
+                config
               )
             end
 
@@ -29,7 +42,7 @@ module RailsFailover
               ::ActiveRecord::Base.connection
             rescue ::ActiveRecord::NoDatabaseError
               # Do nothing since database hasn't been created
-            rescue ::PG::Error => e
+            rescue ::PG::Error, ::ActiveRecord::ConnectionNotEstablished
               Handler.instance.verify_primary(::ActiveRecord::Base.writing_role)
               ::ActiveRecord::Base.connection_handler = ::ActiveRecord::Base.lookup_connection_handler(:reading)
             end

data/lib/rails_failover/active_record.rb

@@ -27,8 +27,7 @@ module RailsFailover
       @verify_primary_frequency_seconds || 5
     end
 
-    def self.establish_reading_connection(handler, connection_spec)
-      config = connection_spec.config
+    def self.establish_reading_connection(handler, config)
 
       if config[:replica_host] && config[:replica_port]
         replica_config = config.dup

data/lib/rails_failover/version.rb

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

data/makefile

@@ -9,7 +9,7 @@ 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 --without test --without development && yarn install && RAILS_ENV=production $(BUNDLER_BIN) exec rails db:create db:migrate db:seed
+	@cd spec/support/dummy_app && bundle install --quiet && yarn install && 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

data/rails_failover.gemspec

@@ -9,8 +9,9 @@ Gem::Specification.new do |spec|
   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.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.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.
@@ -21,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  ["activerecord", "railties"].each do |gem_name|
-    spec.add_dependency gem_name, "~> 6.0"
-  end
+  spec.add_dependency "activerecord", "> 6.0", "< 7.1"
+  spec.add_dependency "railties", "> 6.0", "< 7.1"
+
   spec.add_dependency "concurrent-ruby"
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rails_failover
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Alan Tan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2022-01-17 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'
+    - - "<"
+      - !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'
+    - - "<"
+      - !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'
+    - - "<"
+      - !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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +78,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -87,7 +98,7 @@ files:
 - postgresql.mk
 - rails_failover.gemspec
 - redis.mk
-homepage: 
+homepage: https://github.com/discourse/rails_failover
 licenses:
 - MIT
 metadata: {}
@@ -99,14 +110,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Failover for ActiveRecord and Redis

data/Gemfile.lock

@@ -1,123 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rails_failover (0.6.4)
-      activerecord (~> 6.0)
-      concurrent-ruby
-      railties (~> 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (6.0.3.1)
-      actionview (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.1)
-      activesupport (= 6.0.3.1)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activerecord (6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
-    builder (3.2.4)
-    byebug (11.1.3)
-    concurrent-ruby (1.1.6)
-    crass (1.0.6)
-    diff-lcs (1.3)
-    erubi (1.10.0)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    loofah (2.7.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    pg (1.2.3)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    redis (4.1.4)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.83.0)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-discourse (2.1.2)
-      rubocop (>= 0.69.0)
-      rubocop-rspec (>= 1.39.0)
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 6.0)
-  byebug
-  pg (~> 1.2)
-  rack
-  rails_failover!
-  rake (~> 12.0)
-  redis (~> 4.1)
-  rspec (~> 3.0)
-  rubocop-discourse
-
-BUNDLED WITH
-   2.1.4