knockoff 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fb5337ef43e286ab938ab8d6e4905529607979266b8bb7673eccdba23c5d3c
-  data.tar.gz: 9990634bf328df85fe419cbb3aea20b591d4a9c94420184f89012a15649ac2af
+  metadata.gz: e921df87f0b4a745efbf78fc20ef215d3460979feb98caed591cee11a34ee2f0
+  data.tar.gz: a9766e158829c30fd0de4a488818b5e5f1bcfa5e0586f8800292ebfb258f9a9e
 SHA512:
-  metadata.gz: d7e7d9f11f4a7ea199d48e98c322d66b75db01eb2659b5218ea3928c586e1cab1d4087e3c7eb2aa1c54bdce744beb4f5c46fd2e4b43dc3972c1d735c6762acbf
-  data.tar.gz: 4a6d620cffa48322560e060e1b500704791216d9daf6a3f6f81e90adaec25546012dbf0a55ca66c427265b87f42d3f0a1818f2aa93fbb84292a89ff7cd816bd2
+  metadata.gz: 33af6faf673b2eb80408f93fac592b05202e304e644d33a14237a49aab213b5f45d6fceb82961965de6993213aeac415184adde22baf1701a5bc21fc06859d61
+  data.tar.gz: 78122861367012310acae82efc930c59b9da403b4bc0cbaf15af629e85eed621247bb073507e9da307ad9822799971c0308accdcf2ac7755d60f806ebeff437c

data/.github/workflows/ruby.yml

@@ -5,20 +5,21 @@ on: push
 jobs:
   test:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        ruby-version: ['2.4.0', '2.5.1', '2.6.6', '2.7.2']
+        ruby-version: ['2.7.8', '3.0.6', '3.1.4']
 
     steps:
       # Pin to this commit: v2
       - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
       - name: Set up Ruby
-        # Lock to this commit, v1.82.0
-        uses: ruby/setup-ruby@5e4f0a10bfc39c97cd5358121291e27e5d97e09b
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 2
+
       - name: Run tests
         run: bundle exec rake spec

data/.gitignore

@@ -1,10 +1,9 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-/spec/tmp
+/spec/tmp

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 1.5.0
+
+Update to be Rails 7.0 compatible. Drops support for ruby 2.6 and Rails 6.0-
+
+## 1.4.0
+
+Update to be Rails 6.1 compatible
+
 ## 1.1.1
 
 - Drop Ruby 2.3 support
@@ -11,4 +19,4 @@
 - Allow for not checking `inside_transaction?` on primary database (https://github.com/joinhandshake/knockoff/pull/13)
 - Allow setting `Knockoff.default_target` to set the default target other than `:primary` (https://github.com/joinhandshake/knockoff/pull/11)
 - Drop Ruby 2.2 support
-- Add Ruby 2.5 support
+- Add Ruby 2.5 support

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    knockoff (1.5.0)
+      activerecord (>= 6.1, < 7.1)
+      activesupport (>= 6.1, < 7.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.8.4)
+      activesupport (= 7.0.8.4)
+    activerecord (7.0.8.4)
+      activemodel (= 7.0.8.4)
+      activesupport (= 7.0.8.4)
+    activesupport (7.0.8.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.3.4)
+    diff-lcs (1.5.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.24.1)
+    rake (10.5.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    sqlite3 (1.5.4-aarch64-linux)
+    sqlite3 (1.5.4-arm-linux)
+    sqlite3 (1.5.4-arm64-darwin)
+    sqlite3 (1.5.4-x86-linux)
+    sqlite3 (1.5.4-x86_64-darwin)
+    sqlite3 (1.5.4-x86_64-linux)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  knockoff!
+  rake (~> 10.0)
+  rspec
+  sqlite3 (~> 1.5.0)
+
+BUNDLED WITH
+   2.4.22

data/README.md

@@ -17,7 +17,29 @@ A gem for easily using read replicas.
 
 ## Supported Versions
 
-Knockoff supports Rails 4, 5 and 6
+| Knockoff version: | 1.0 | 1.1.0 | 1.1.1 | 1.4 | 1.5 |
+| --- | --- | --- | --- | --- | --- |
+| Ruby 2.2 | [x] | [ ] | [ ] | [ ] | [ ] |
+| Ruby 2.3 | [x] | [x] | [ ] | [ ] | [ ] |
+| Ruby 2.4 | [x] | [x] | [x] | [ ] | [ ] |
+| Ruby 2.5 | [ ] | [x] | [x] | [ ] | [ ] |
+| Ruby 2.6 | [ ] | [ ] | [x] | [x] | [ ] |
+| Ruby 2.7 | [ ] | [ ] | [x] | [x] | [x] |
+| Ruby 3.0 | [ ] | [ ] | [ ] | [x] | [x] |
+| Ruby 3.1 | [ ] | [ ] | [ ] | [x] | [x] |
+
+| Knockoff version: | 1.0 | 1.1.0 | 1.1.1 | 1.4 | 1.5 |
+| --- | --- | --- | --- | --- | --- |
+| Rails 4 | [x] | [x] | [ ] | [ ] | [ ] |
+| Rails 5.0 | [x] | [x] | [x] | [ ] | [ ] |
+| Rails 5.1 | [x] | [x] | [x] | [ ] | [ ] |
+| Rails 5.2 | [x] | [x] | [x] | [ ] | [ ] |
+| Rails 6.0 | [ ] | [ ] | [x] | [x] | [ ] |
+| Rails 6.1 | [ ] | [ ] | [ ] | [x] | [x] |
+| Rails 7.0 | [ ] | [ ] | [ ] | [ ] | [x] |
+| Rails 7.1 | [ ] | [ ] | [ ] | [ ] | [ ] |
+| Rails 7.2 | [ ] | [ ] | [ ] | [ ] | [ ] |
+
 
 ## Installation
 
@@ -41,7 +63,7 @@ Or install it yourself as:
 
 Add an initializer at config/knockoff.rb with the below contents
 
-```
+```ruby
 Knockoff.enabled = true # NOTE: Consider adding ENV based disabling
 ```
 
@@ -49,7 +71,7 @@ Knockoff.enabled = true # NOTE: Consider adding ENV based disabling
 
 Configuration is done using ENV properties. This makes it easy to add and remove replicas at runtime (or to fully disable if needed). First, set up ENV variables pointing to your replica databases. Consider using the [dotenv](https://github.com/bkeepers/dotenv) gem for manging ENV variables.
 
-```
+```dotenv
 # .env
 
 REPLICA_1=postgres://username:password@localhost:5432/database_name
@@ -71,7 +93,7 @@ KNOCKOFF_REPLICA_ENVS=REPLICA_1,REPLICA_2
 
 Lastly, knockoff will read the `'knockoff_replicas'` database.yml config for specifying additional params:
 
-```
+```yml
 # database.yml
 
 knockoff_replicas:
@@ -83,13 +105,13 @@ knockoff_replicas:
 
 To use one of the replica databases, use
 
-```
+```ruby
 Knockoff.on_replica { User.count }
 ```
 
 To force primary, use
 
-```
+```ruby
 Knockoff.on_primary { User.create(name: 'Bob') }
 ```
 
@@ -97,7 +119,7 @@ Knockoff.on_primary { User.create(name: 'Bob') }
 
 A common use case is to use replicas for GET requests and otherwise use primary. A simplified use case might look something like this:
 
-```
+```ruby
 # application_controller.rb
 
 around_action :choose_database
@@ -120,7 +142,7 @@ end
 
 Replicas will often be slightly behind the primary database. To compensate, consider "sticking" a user who has recently made changes to the primary for a small duration of time to the primary database. This will avoid cases where a user creates a record on primary, is redirected to view that record, and receives a 404 error since the record is not yet in the replica. A simple implementation for this could look like:
 
-```
+```ruby
 # application_record.rb
 
 after_commit :track_commit_occurred_in_request
@@ -149,13 +171,13 @@ Then, in your `should_use_primary_database?` method, consult `session[:use_leade
 
 Knockoff can be configured during runtime. This is done through the `establish_new_connections!` method which takes in a hash of new configurations to apply to each replica before re-connecting.
 
-```
+```ruby
 Knockoff.establish_new_connections!({ 'pool' => db_pool })
 ```
 
 For example, to specify a puma connection pool at bootup your code might look something like
 
-```
+```ruby
 # puma.rb
 
 db_pool = Integer(ENV['PUMA_WORKER_DB_POOL'] || threads_count)
@@ -171,7 +193,7 @@ Knockoff.establish_new_connections!({ 'pool' => db_pool })
 
 For forking servers, you may disconnect all replicas before forking with `Knockoff.disconnect_all!`.
 
-```
+```ruby
 # puma.rb
 
 before_fork do

data/knockoff.gemspec

@@ -13,16 +13,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sgringwe/knockoff"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.platform      = Gem::Platform::RUBY
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'activerecord', '>= 4.0.0', '< 6.1'
-  spec.add_runtime_dependency 'activesupport', '>= 4.0.0', '< 6.1'
+  spec.add_runtime_dependency 'activerecord', '>= 6.1', "< 7.1"
+  spec.add_runtime_dependency 'activesupport', '>= 6.1', "< 7.1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sqlite3', "~> 1.5.0"
 end

data/lib/knockoff/base.rb

@@ -28,7 +28,7 @@ module Knockoff
     end
 
     def inside_transaction?
-      open_transactions = run_on(:primary) { ActiveRecord::Base.connection.open_transactions }
+      open_transactions = run_on(:primary) { ::ActiveRecord::Base.connection.open_transactions }
       open_transactions > Knockoff.base_transaction_depth
     end
 

data/lib/knockoff/config.rb

@@ -8,11 +8,11 @@ module Knockoff
     attr_reader :replica_configs
 
     # A hash of replica configs to their config hash.
-    attr_reader :replicas_configurations
+    attr_reader :replicas_configuration_hash
 
     def initialize
       @environment = 'development'
-      @replicas_configurations = {}
+      @replicas_configuration_hash = {}
       set_replica_configs
 
       if !properly_configured? && Knockoff.enabled
@@ -21,8 +21,28 @@ module Knockoff
       end
     end
 
-    def replica_database_keys
-      @replicas_configurations.keys
+    def set_replica_configs
+      @replica_configs ||= parse_knockoff_replica_envs_to_configs
+    end
+
+    def parse_knockoff_replica_envs_to_configs
+      # As a basic prevention of crashes, attempt to parse each DB uri
+      # and don't add the uri to the final list if it can't be parsed
+      replica_env_keys.map.with_index(0) do |env_key, index|
+        begin
+
+          # Configure parameters such as prepared_statements, pool, reaping_frequency for all replicas.
+          to_copy = ActiveRecord::Base.configurations.configs_for(env_name: 'knockoff_replicas')&.first&.configuration_hash || {}
+          register_replica_copy(index, env_key, to_copy)
+
+        rescue URI::InvalidURIError
+          Rails.logger.info "LOG NOTIFIER: Invalid URL specified in follower_env_keys. Not including URI, which may result in no followers used." # URI is purposely not printed to logs
+          # Return a 'nil' which will be removed from
+          # configs with `compact`, resulting in no configs and no followers,
+          # therefore disabled since this env will not be in environments list.
+          nil
+        end
+      end.compact
     end
 
     def replica_env_keys
@@ -34,9 +54,12 @@ module Knockoff
     end
 
     def update_replica_configs(new_configs)
-      ActiveRecord::Base.configurations['knockoff_replicas'].merge(new_configs) if ActiveRecord::Base.configurations['knockoff_replicas'].present?
-      @replicas_configurations.each do |key, _config|
-        update_replica_config(key, new_configs)
+      if ActiveRecord::Base.configurations.configs_for(env_name: 'knockoff_replicas').present?
+        updated_config = new_configs.deep_dup.merge!(ActiveRecord::Base.configurations.configs_for(env_name: 'knockoff_replicas').first.configuration_hash)
+      end
+
+      @replicas_configuration_hash.each do |key, _config|
+        update_replica_config(key, updated_config)
       end
     end
 
@@ -47,80 +70,46 @@ module Knockoff
       !@replica_configs.empty?
     end
 
+    def replica_database_keys
+      @replicas_configuration_hash.keys
+    end
+
     private
 
-    def update_replica_config(key, new_configs)
-      @replicas_configurations[key].merge!(new_configs)
-      ActiveRecord::Base.configurations[key].merge!(new_configs)
+    def update_replica_config(key, updated_config)
+      merged_config = @replicas_configuration_hash[key].configuration_hash.deep_dup.merge!(updated_config)
+      @replicas_configuration_hash[key] = ActiveRecord::DatabaseConfigurations::HashConfig.new(key, key, merged_config)
+      ActiveRecord::Base.configurations.configurations << @replicas_configuration_hash[key]
     end
 
-    def set_replica_configs
-      @replica_configs ||= parse_knockoff_replica_envs_to_configs
+    def register_replica_copy(index, env_key, configuration_hash)
+      key = "knockoff_replica_#{index}"
+      new_config = create_replica_copy(env_key, key, configuration_hash.deep_dup)
+      ActiveRecord::Base.configurations.configurations << new_config
+      @replicas_configuration_hash[key] = new_config
     end
 
-    def parse_knockoff_replica_envs_to_configs
-      # As a basic prevention of crashes, attempt to parse each DB uri
-      # and don't add the uri to the final list if it can't be parsed
-      replica_env_keys.map.with_index(0) do |env_key, index|
-        begin
-          uri = URI.parse(ENV[env_key])
+    def create_replica_copy(env_key, key, replica_config_hash)
+      uri = URI.parse(ENV[env_key])
 
-          # Configure parameters such as prepared_statements, pool, reaping_frequency for all replicas.
-          replica_config = ActiveRecord::Base.configurations['knockoff_replicas'] || {}
-
-          adapter =
-            if uri.scheme == "postgres"
-              'postgresql'
-            else
-              uri.scheme
-            end
-
-          # Base config from the ENV uri. Sqlite is a special case
-          # and all others follow 'normal' config
-          uri_config =
-            if uri.scheme == 'sqlite3'
-              {
-                'adapter' => adapter,
-                'database' => uri.to_s.split(':')[1]
-              }
-            else
-              {
-                'adapter' => adapter,
-                'database' => (uri.path || "").split("/")[1],
-                'username' => uri.user,
-                'password' => uri.password,
-                'host' => uri.host,
-                'port' => uri.port
-              }
-            end
-
-          # Store the hash in configuration and use it when we establish the connection later.
-          # TODO: In ActiveRecord >= 6, this is a deprecated way to set a configuration. However
-          # there appears to be an issue when calling `ActiveRecord::Base.configurations.to_h` in
-          # version 6.0.4.8 where
-          # multi-database setup is being ignored / dropped. For example if a database.yml setup
-          # has something like..
-          #
-          # development:
-          #   primary:
-          #     ...
-          #   other:
-          #     ...
-          #
-          # then the 'other' database configuration is being dropped.
-          key = "knockoff_replica_#{index}"
-          config = replica_config.merge(uri_config)
-          ActiveRecord::Base.configurations[key] = config
-
-          @replicas_configurations[key] = config
-        rescue URI::InvalidURIError
-          Rails.logger.info "LOG NOTIFIER: Invalid URL specified in follower_env_keys. Not including URI, which may result in no followers used." # URI is purposely not printed to logs
-          # Return a 'nil' which will be removed from
-          # configs with `compact`, resulting in no configs and no followers,
-          # therefore disabled since this env will not be in environments list.
-          nil
+      replica_config_hash[:adapter] =
+        if uri.scheme == "postgres"
+          'postgresql'
+        else
+          uri.scheme
         end
-      end.compact
+
+      if uri.scheme == 'sqlite3'
+        replica_config_hash[:database] = uri.to_s.split(':')[1]
+      else
+        replica_config_hash[:database] = (uri.path || "").split("/")[1]
+        replica_config_hash[:username] = uri.user
+        replica_config_hash[:password] = uri.password
+        replica_config_hash[:host] = uri.host
+        replica_config_hash[:port] = uri.port
+      end
+
+      ActiveRecord::DatabaseConfigurations::HashConfig.new(key, key, replica_config_hash)
     end
   end
 end

data/lib/knockoff/replica_connection_pool.rb

@@ -49,11 +49,11 @@ module Knockoff
       # TODO: Hardcoding the uri string feels meh. Either set the database config
       # or reference ENV instead
       Knockoff.module_eval %Q{
-        class #{class_name} < ActiveRecord::Base
+        class #{class_name} < ::ActiveRecord::Base
           self.abstract_class = true
           establish_connection :#{config_key}
-          def self.connection_config
-            configurations[#{config_key.to_s.inspect}]
+          def self.connection_db_config
+            configurations.find_db_config #{config_key.to_s.inspect}
           end
         end
       }, __FILE__, __LINE__

data/lib/knockoff/version.rb

@@ -1,3 +1,3 @@
 module Knockoff
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockoff
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Scott Ringwelski
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,17 +96,17 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.5.0
+description:
 email:
 - me@sgringwe.com
 executables: []
@@ -119,12 +119,12 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- ci/install_modern_sqlite.sh
 - knockoff.gemspec
 - lib/knockoff.rb
 - lib/knockoff/active_record/base.rb
@@ -138,7 +138,7 @@ homepage: https://github.com/sgringwe/knockoff
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,15 +146,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.5.7
+signing_key:
 specification_version: 4
 summary: A gem for easily using read replicas
 test_files: []

data/ci/install_modern_sqlite.sh

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-set -e # halt script on error
-
-sudo apt-get autoremove sqlite3
-sudo apt-get install python-software-properties
-sudo apt-add-repository -y ppa:travis-ci/sqlite3
-sudo apt-get -y update
-sudo apt-cache show sqlite3
-sudo apt-get install sqlite3=3.7.15.1-1~travis1
-sudo sqlite3 -version
-sudo psql --version
-sudo mysql --version
-gem update bundler