knockoff 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95bb6904e4373aa3b026fc1e950b8f5cc9081a4abd174e58ef4ed521824fb5bb
-  data.tar.gz: 6bfeeb88cb514854c2e550f531d65c76c160bcac1225b741deab01f6183e0abf
+  metadata.gz: 955ed88bdcc6efad21cc49e650e41b7f8be0090bcfb39c58b7445c58724f03f6
+  data.tar.gz: 2780acc35a3c2e45341677238e705aaae346eb258d7696de9092b894fc1fd138
 SHA512:
-  metadata.gz: e2afdaf7285a09cb98a2946f19313160d84fe57208e86e00278732c391143c524093ab40e241a4db0c59711db789737b64e4958f2667fec6c7727f006e584663
-  data.tar.gz: ee421e025448df4043319d90be8ed9aa8f9e2979d633feaa29d8876ea8bfb24aa1411d6103aeb65d50cb25f5c549732165d60330355bfe944f53fdc6bb14f955
+  metadata.gz: 31a78e1d5d861aa232411597f0dffc02b1283c7c3f0ce7ef5df07f81dc88f8b8f081b5842df8e8e7e51e570fae0325db617e4a6f8e70743884b8e648f08eccc4
+  data.tar.gz: 10677caed4bb00ebbd243af6131b3054324ea7218abbeef2ce0db0285410d1f3a91fcda5b06403177a88d441a6a3be3d064ee1de57016dfa6b044a5ad5dc4f70

data/.github/workflows/ruby.yml

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/README.md

@@ -1,6 +1,6 @@
 # Knockoff
 
-[![Build Status](https://travis-ci.com/joinhandshake/knockoff.svg?branch=master)](https://travis-ci.com/github/joinhandshake/knockoff)
+[![Build Status](https://github.com/joinhandshake/knockoff/actions/workflows/ruby.yml/badge.svg)](https://github.com/joinhandshake/knockoff/actions)
 [![Gem Version](https://badge.fury.io/rb/knockoff.svg)](https://badge.fury.io/rb/knockoff)
 
 A gem for easily using read replicas.

data/knockoff.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'activerecord', '>= 4.0.0'
-  spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
+  spec.add_runtime_dependency 'activerecord', '>= 6', '< 7'
+  spec.add_runtime_dependency 'activesupport', '>= 6', '< 7'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/knockoff/config.rb

@@ -34,9 +34,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?
+      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.config)
+      end
+
       @replicas_configurations.each do |key, _config|
-        update_replica_config(key, new_configs)
+        update_replica_config(key, updated_config)
       end
     end
 
@@ -49,9 +52,10 @@ module Knockoff
 
     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_configurations[key].config.deep_dup.merge!(updated_config)
+      @replicas_configurations[key] = ActiveRecord::DatabaseConfigurations::HashConfig.new(key, key, merged_config)
+      ActiveRecord::Base.configurations.configurations << @replicas_configurations[key]
     end
 
     def set_replica_configs
@@ -63,50 +67,11 @@ module Knockoff
       # 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])
 
           # 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.
-          key = "knockoff_replica_#{index}"
-          config = replica_config.merge(uri_config)
-
-          if ActiveRecord::VERSION::MAJOR >= 6
-            full_config = ActiveRecord::Base.configurations.to_h.merge(key => config)
-
-            ActiveRecord::Base.configurations = full_config
-            @replicas_configurations[key] = config
-          else
-            ActiveRecord::Base.configurations[key] = config
-            @replicas_configurations[key] = config
-          end
+          to_copy = ActiveRecord::Base.configurations.configs_for(env_name: 'knockoff_replicas')&.first&.config || {}
+          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
@@ -116,5 +81,35 @@ module Knockoff
         end
       end.compact
     end
+
+    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_configurations[key] = new_config
+    end
+
+    def create_replica_copy(env_key, key, replica_config_hash)
+      uri = URI.parse(ENV[env_key])
+
+      replica_config_hash[:adapter] =
+        if uri.scheme == "postgres"
+          'postgresql'
+        else
+          uri.scheme
+        end
+
+      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

@@ -30,6 +30,12 @@ module Knockoff
       end
     end
 
+    def set_schema_cache(cache)
+      @pool.each do |_name, klass|
+        klass.connection_pool.schema_cache = cache
+      end
+    end
+
     def random_replica_connection
       @pool[@pool.keys.sample]
     end
@@ -46,7 +52,7 @@ module Knockoff
         class #{class_name} < ActiveRecord::Base
           self.abstract_class = true
           establish_connection :#{config_key}
-          def self.connection_config
+          def self.connection_db_config
             configurations[#{config_key.to_s.inspect}]
           end
         end

data/lib/knockoff/version.rb

@@ -1,3 +1,3 @@
 module Knockoff
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/knockoff.rb

@@ -49,6 +49,10 @@ module Knockoff
       @config ||= Config.new
     end
 
+    def set_schema_cache(cache)
+      replica_pool.set_schema_cache(cache)
+    end
+
     def base_transaction_depth
       @base_transaction_depth ||= begin
         testcase = ActiveSupport::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockoff
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Scott Ringwelski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,9 +113,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -140,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A gem for easily using read replicas

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-notifications:
-  email: false
-rvm:
-  - 2.4.0
-  - 2.5.1
-  - 2.6.6
-  - 2.7.2
-  - ruby-head