active_record_proxy_adapters 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f404b61f94eec82c838124e111eba202e7fdbea61c07596739219749e7c76ac2
-  data.tar.gz: 930327b485fb9b7637a1b810c0cb52def9d0164777103f918862a9dd4a0a89e7
+  metadata.gz: bca625e0a728907c505db941a4398b5aa144dcdd5f6866ac9a3969f0b783c4d0
+  data.tar.gz: 3ab824330a83e8309b31763b24fe7c74ba0efff2a1eff28505d2a8216442f557
 SHA512:
-  metadata.gz: 4d0c6210521feb5db9ce40fc476607fb862d818e16feb23d795e95f20f20b8db0b1311049a5895f6e9795ba2740cdef140ecb6ec67f5f1c7c7aec759e0a4c2ca
-  data.tar.gz: 1134342f6be3093cb5a3ddaba514ef702adb611e5646a3abd3c68073fcb7060459a39a5845983733b4c5f0bc24d5928f57e8333b7741bbb8b3fa812d9472f066
+  metadata.gz: 1bc0567abfff9e1877abe107074a7e3f35f574ecefc2584f188809a0940c37a9192c88f3ae71f0e682d7115de75cd8b82ef827874e75195dc635572a8a8c7173
+  data.tar.gz: 6ee734e3da7c41d458403e10589d3edd8126862ddcfa2d63034d75c884ec98e383c58e0877166c25155c44ef3a2c13e307378df850b47b0da77d103ff31d57c2

data/lib/active_record_proxy_adapters/active_record_context.rb

@@ -18,19 +18,11 @@ module ActiveRecordProxyAdapters
     end
 
     def hijackable_methods
-      hijackable = %i[execute exec_query]
-
-      hijackable << :internal_exec_query if active_record_v7_1_or_greater?
-
-      hijackable
+      %i[execute exec_query internal_exec_query]
     end
 
     def active_record_v7?
-      active_record_version >= Gem::Version.new("7.1") && active_record_version < Gem::Version.new("8.0")
-    end
-
-    def active_record_v7_1_or_greater?
-      active_record_version >= Gem::Version.new("7.1")
+      active_record_version >= Gem::Version.new("7.2") && active_record_version < Gem::Version.new("8.0")
     end
 
     def active_record_v7_2_or_greater?

data/lib/active_record_proxy_adapters/connection_handling/mysql2_proxy.rb

@@ -6,40 +6,3 @@ rescue LoadError
   # mysql2 not available
   return
 end
-
-module ActiveRecordProxyAdapters
-  module Mysql2
-    # Module to extend ActiveRecord::Base with the connection handling methods.
-    # Required to make adapter work in ActiveRecord versions <= 7.2.x
-    module ConnectionHandling
-      def mysql2_proxy_adapter_class
-        ::ActiveRecord::ConnectionAdapters::Mysql2ProxyAdapter
-      end
-
-      # This method is a copy and paste from Rails' mysql2_connection,
-      # replacing Mysql2Adapter by Mysql2ProxyAdapter
-      # This is required by ActiveRecord versions <= 7.2.x to establish a connection using the adapter.
-      def mysql2_proxy_connection(config) # rubocop:disable Metrics/MethodLength
-        config = config.symbolize_keys
-        config[:flags] ||= 0
-
-        if config[:flags].is_a? Array
-          config[:flags].push "FOUND_ROWS"
-        else
-          config[:flags] |= ::Mysql2::Client::FOUND_ROWS
-        end
-
-        mysql2_proxy_adapter_class.new(
-          mysql2_proxy_adapter_class.new_client(config),
-          logger,
-          nil,
-          config
-        )
-      end
-    end
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.extend(ActiveRecordProxyAdapters::Mysql2::ConnectionHandling)
-end

data/lib/active_record_proxy_adapters/connection_handling/postgresql_proxy.rb

@@ -6,41 +6,3 @@ rescue LoadError
   # Postgres not available
   return
 end
-
-module ActiveRecordProxyAdapters
-  # Module to extend ActiveRecord::Base with the connection handling methods.
-  # Required to make adapter work in ActiveRecord versions <= 7.2.x
-  module PostgreSQL
-    module ConnectionHandling # rubocop:disable Style/Documentation
-      def postgresql_proxy_adapter_class
-        ::ActiveRecord::ConnectionAdapters::PostgreSQLProxyAdapter
-      end
-
-      # This method is a copy and paste from Rails' postgresql_connection,
-      # replacing PostgreSQLAdapter by PostgreSQLProxyAdapter
-      # This is required by ActiveRecord versions <= 7.2.x to establish a connection using the adapter.
-      def postgresql_proxy_connection(config) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        conn_params = config.symbolize_keys.compact
-
-        # Map ActiveRecords param names to PGs.
-        conn_params[:user]   = conn_params.delete(:username) if conn_params[:username]
-        conn_params[:dbname] = conn_params.delete(:database) if conn_params[:database]
-
-        # Forward only valid config params to PG::Connection.connect.
-        valid_conn_param_keys = PG::Connection.conndefaults_hash.keys + [:requiressl]
-        conn_params.slice!(*valid_conn_param_keys)
-
-        postgresql_proxy_adapter_class.new(
-          postgresql_proxy_adapter_class.new_client(conn_params),
-          logger,
-          conn_params,
-          config
-        )
-      end
-    end
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.extend(ActiveRecordProxyAdapters::PostgreSQL::ConnectionHandling)
-end

data/lib/active_record_proxy_adapters/connection_handling/sqlite3_proxy.rb

@@ -6,23 +6,3 @@ rescue LoadError
   # sqlite3 not available
   return
 end
-
-module ActiveRecordProxyAdapters
-  module SQLite3
-    # Module to extend ActiveRecord::Base with the connection handling methods.
-    # Required to make adapter work in ActiveRecord versions <= 7.2.x
-    module ConnectionHandling
-      def sqlite3_proxy_adapter_class
-        ActiveRecord::ConnectionAdapters::SQLite3ProxyAdapter
-      end
-
-      def sqlite3_proxy_connection(config)
-        sqlite3_proxy_adapter_class.new(config)
-      end
-    end
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.extend(ActiveRecordProxyAdapters::SQLite3::ConnectionHandling)
-end

data/lib/active_record_proxy_adapters/connection_handling/trilogy_proxy.rb

@@ -6,39 +6,3 @@ rescue LoadError
   # trilogy not available
   return
 end
-
-module ActiveRecordProxyAdapters
-  module Trilogy
-    # Module to extend ActiveRecord::Base with the connection handling methods.
-    # Required to make adapter work in ActiveRecord versions <= 7.2.x
-    module ConnectionHandling
-      def trilogy_proxy_adapter_class
-        ActiveRecord::ConnectionAdapters::TrilogyProxyAdapter
-      end
-
-      def trilogy_proxy_connection(config) # rubocop:disable Metrics/MethodLength
-        configuration = config.dup
-
-        # Set FOUND_ROWS capability on the connection so UPDATE queries returns number of rows
-        # matched rather than number of rows updated.
-        configuration[:found_rows] = true
-
-        options = [
-          configuration[:host],
-          configuration[:port],
-          configuration[:database],
-          configuration[:username],
-          configuration[:password],
-          configuration[:socket],
-          0
-        ]
-
-        trilogy_proxy_adapter_class.new nil, logger, options, configuration
-      end
-    end
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.extend(ActiveRecordProxyAdapters::Trilogy::ConnectionHandling)
-end

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -7,7 +7,6 @@ require "active_record_proxy_adapters/hijackable"
 require "active_record_proxy_adapters/mixin/configuration"
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/object/blank"
-require "timeout"
 
 module ActiveRecordProxyAdapters
   # This is the base class for all proxies. It defines the methods that should be proxied
@@ -160,8 +159,7 @@ module ActiveRecordProxyAdapters
     end
 
     def pending_migration_connection?
-      active_record_context.active_record_v7_1_or_greater? &&
-        connection_class.name == "ActiveRecord::PendingMigrationConnection"
+      connection_class.name == "ActiveRecord::PendingMigrationConnection"
     end
 
     def connection_for(role, sql_string)
@@ -224,9 +222,8 @@ module ActiveRecordProxyAdapters
 
     def match_sql?(sql_string)
       proc do |matcher|
-        # TODO: switch to regexp timeout once Ruby 3.1 support is dropped.
-        Timeout.timeout(proxy_checkout_timeout.to_f) { matcher.match?(sql_string) }
-      rescue Timeout::Error
+        Regexp.new(matcher.source, Regexp::IGNORECASE, timeout: proxy_checkout_timeout.to_f).match?(sql_string)
+      rescue Regexp::TimeoutError
         regexp_timeout_strategy.call(sql_string, matcher)
 
         false

data/lib/active_record_proxy_adapters/railtie.rb

@@ -11,9 +11,15 @@ module ActiveRecordProxyAdapters
   # Hooks into rails boot process to extend ActiveRecord with the proxy adapter.
   class Railtie < Rails::Railtie
     require "active_record_proxy_adapters/middleware"
+    require "active_record_proxy_adapters/rake"
 
     initializer "active_record_proxy_adapters.configure_rails_initialization" do |app|
       app.middleware.use ActiveRecordProxyAdapters::Middleware
     end
+
+    rake_tasks do
+      ActiveRecordProxyAdapters::Rake.load_tasks
+      ActiveRecordProxyAdapters::Rake.enhance_db_tasks
+    end
   end
 end

data/lib/active_record_proxy_adapters/rake.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rake"
+
+module ActiveRecordProxyAdapters
+  # Enhances all rails db rake tasks to stick to writer connection
+  module Rake
+    module_function
+
+    def load_tasks
+      Dir[rake_tasks_path].each { |rake_path| load(rake_path) }
+    end
+
+    def rake_tasks_path
+      File.join(__dir__, "tasks/**/*.rake")
+    end
+
+    def enhance_db_tasks
+      ::Rake::Task
+        .tasks
+        .select(&enhanceable_db_task?)
+        .each { |task| task.enhance([push_to_stack_rake_task.name], &pop_from_stack_and_reenable) }
+    end
+
+    def push_to_stack_rake_task
+      ::Rake::Task["arpa:push_to_stack"]
+    end
+
+    def pop_from_stack_rake_task
+      ::Rake::Task["arpa:pop_from_stack"]
+    end
+
+    def pop_from_stack_and_reenable
+      proc do
+        pop_from_stack_rake_task.invoke
+        [push_to_stack_rake_task, pop_from_stack_rake_task].each(&:reenable)
+      end
+    end
+
+    def enhanceable_db_task?
+      proc do |task|
+        task_name = task.name
+        task_name.start_with?("db:") && task_name != "db:load_config"
+      end
+    end
+  end
+end

data/lib/active_record_proxy_adapters/tasks/arpa.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+namespace :arpa do
+  desc "Pushes to connected_to stack before rake task is executed"
+  task :push_to_stack do
+    writing_role = ActiveRecordProxyAdapters::ActiveRecordContext.writing_role
+
+    ActiveRecord::Base.connected_to_stack << {
+      role: writing_role,
+      shard: nil,
+      prevent_writes: false,
+      klasses: [ActiveRecord::Base]
+    }
+
+    Thread.current.thread_variable_set(:arpa_rake_pushed_to_stack, true)
+  end
+
+  desc "Pops from connected_to stack after rake task is invoked"
+  task :pop_from_stack do
+    if Thread.current.thread_variable_get(:arpa_rake_pushed_to_stack)
+      ActiveRecord::Base.connected_to_stack.pop
+      Thread.current.thread_variable_set(:arpa_rake_pushed_to_stack, nil)
+    end
+  end
+end

data/lib/active_record_proxy_adapters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordProxyAdapters
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Matt Cruz
@@ -15,40 +15,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '8.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 7.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: digest
   requirement: !ruby/object:Gem::Requirement
@@ -91,20 +91,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: timeout
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   This gem allows automatic connection switching between a primary and one read replica database in ActiveRecord.
   It pattern matches the SQL statement being sent to decide whether it should go to the replica (SELECT) or the
@@ -154,8 +140,10 @@ files:
 - lib/active_record_proxy_adapters/railties/postgresql.rb
 - lib/active_record_proxy_adapters/railties/sqlite3.rb
 - lib/active_record_proxy_adapters/railties/trilogy.rb
+- lib/active_record_proxy_adapters/rake.rb
 - lib/active_record_proxy_adapters/sqlite3_proxy.rb
 - lib/active_record_proxy_adapters/synchronizable_configuration.rb
+- lib/active_record_proxy_adapters/tasks/arpa.rake
 - lib/active_record_proxy_adapters/trilogy_proxy.rb
 - lib/active_record_proxy_adapters/version.rb
 homepage: https://github.com/Nasdaq/active_record_proxy_adapters