active_record_proxy_adapters 0.3.6 → 0.4.0

data/lib/active_record_proxy_adapters/connection_handling/trilogy.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+begin
+  require "active_record/connection_adapters/trilogy_proxy_adapter"
+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/connection_handling.rb

@@ -2,10 +2,4 @@
 
 require "active_record_proxy_adapters/connection_handling/postgresql"
 require "active_record_proxy_adapters/connection_handling/mysql2"
-
-module ActiveRecordProxyAdapters
-  # Module to extend ActiveRecord::Base with the connection handling methods.
-  # Required to make adapter work in ActiveRecord versions <= 7.2.x
-  module ConnectionHandling
-  end
-end
+require "active_record_proxy_adapters/connection_handling/trilogy"

data/lib/active_record_proxy_adapters/hijackable.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "active_record/tasks/postgresql_proxy_database_tasks"
+require "active_record/connection_adapters/postgresql_adapter"
+
 module ActiveRecordProxyAdapters
   # Defines mixins to delegate specific methods from the proxy to the adapter.
   module Hijackable

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -18,30 +18,19 @@ module ActiveRecordProxyAdapters
       /\A\s*select.+for update\Z/i, /select.+lock in share mode\Z/i,
       /\A\s*select.+(nextval|currval|lastval|get_lock|release_lock|pg_advisory_lock|pg_advisory_unlock)\(/i
     ].map(&:freeze).freeze
-
-    CTE_MATCHER = /\A\s*WITH\s+(?<CTE>\S+\s+AS\s+\(\s?[\s\S]*\))/i
     # All queries that match these patterns should be sent to the replica database
-    SQL_REPLICA_MATCHERS = [
-      /\A\s*(select)\s/i,
-      /#{CTE_MATCHER.source}\s*select/i
-    ].map(&:freeze).freeze
+    SQL_REPLICA_MATCHERS     = [/\A\s*(select|with\s[\s\S]*\)\s*select)\s/i].map(&:freeze).freeze
     # All queries that match these patterns should be sent to all databases
     SQL_ALL_MATCHERS         = [/\A\s*set\s/i].map(&:freeze).freeze
     # Local sets queries should not be sent to all datbases
     SQL_SKIP_ALL_MATCHERS    = [/\A\s*set\s+local\s/i].map(&:freeze).freeze
     # These patterns define which database statments are considered write statments, so we can shortly re-route all
     # requests to the primary database so the replica has time to replicate
-    WRITE_STATEMENT_MATCHERS = [
-      /\ABEGIN/i,
-      /\ACOMMIT/i,
-      /INSERT\s[\s\S]*INTO\s[\s\S]*/i,
-      /UPDATE\s[\s\S]*/i,
-      /DELETE\s[\s\S]*FROM\s[\s\S]*/i,
-      /DROP\s/i
-    ].map(&:freeze).freeze
+    WRITE_STATEMENT_MATCHERS = [/\ABEGIN/i, /\ACOMMIT/i, /INSERT\sINTO\s/i, /UPDATE\s/i, /DELETE\sFROM\s/i,
+                                /DROP\s/i].map(&:freeze).freeze
 
     # Abstract adapter methods that should be proxied.
-    hijack_method(*ActiveRecordContext.hijackable_methods)
+    hijack_method :execute, :exec_query
 
     def self.hijacked_methods
       @hijacked_methods.to_a
@@ -61,22 +50,6 @@ module ActiveRecordProxyAdapters
     delegate :connection_handler, to: :connection_class
     delegate :reading_role, :writing_role, to: :active_record_context
 
-    # We need to call .verify! to ensure `configure_connection` is called on the instance before attempting to use it.
-    # This is necessary because the connection may have been lazily initialized and is an unintended side effect from a
-    # change in Rails to defer connection verification: https://github.com/rails/rails/pull/44576
-    # verify! cannot be called before the object is initialized and because of how the proxy hooks into the connection
-    # instance, it has to be done lazily (hence the memoization). Ideally, we shouldn't have to worry about this at all
-    # But there is tight coupling between methods in ActiveRecord::ConnectionAdapters::AbstractAdapter and
-    # its descendants which will require significant refactoring to be decoupled.
-    # See https://github.com/rails/rails/issues/51780
-    def verified_primary_connection
-      @verified_primary_connection ||= begin
-        connected_to(role: writing_role) { primary_connection.verify! }
-
-        primary_connection
-      end
-    end
-
     def replica_pool_unavailable?
       !replica_pool
     end
@@ -147,8 +120,7 @@ module ActiveRecordProxyAdapters
     end
 
     def connection_for(role, sql_string)
-      connection = verified_primary_connection if role == writing_role || replica_pool_unavailable?
-
+      connection = primary_connection if role == writing_role || replica_pool_unavailable?
       connection ||= checkout_replica_connection
 
       result = connected_to(role:) { yield connection }
@@ -182,21 +154,16 @@ module ActiveRecordProxyAdapters
     # @return [TrueClass] if there has been a write within the last {#proxy_delay} seconds
     # @return [TrueClass] if sql_string matches a write statement (i.e. INSERT, UPDATE, DELETE, SELECT FOR UPDATE)
     # @return [FalseClass] if sql_string matches a read statement (i.e. SELECT)
-    def need_primary?(sql_string) # rubocop:disable Metrics/CyclomaticComplexity
-      return true  if recent_write_to_primary?
+    def need_primary?(sql_string)
+      return true if recent_write_to_primary?
+
       return true  if in_transaction?
-      return true  if cte_for_write?(sql_string)
       return true  if SQL_PRIMARY_MATCHERS.any?(&match_sql?(sql_string))
       return false if SQL_REPLICA_MATCHERS.any?(&match_sql?(sql_string))
 
       true
     end
 
-    def cte_for_write?(sql_string)
-      CTE_MATCHER.match?(sql_string) &&
-        WRITE_STATEMENT_MATCHERS.any?(&match_sql?(sql_string))
-    end
-
     def need_all?(sql_string)
       return false if SQL_SKIP_ALL_MATCHERS.any?(&match_sql?(sql_string))
 

data/lib/active_record_proxy_adapters/railtie.rb

@@ -5,10 +5,7 @@ require "active_support"
 module ActiveRecordProxyAdapters
   # Hooks into rails boot process to extend ActiveRecord with the proxy adapter.
   class Railtie < Rails::Railtie
-    ActiveSupport.on_load :active_record do
-      require "active_record_proxy_adapters/connection_handling"
-      ActiveRecord::Base.extend(ActiveRecordProxyAdapters::ConnectionHandling)
-    end
+    require "active_record_proxy_adapters/connection_handling"
 
     config.to_prepare do
       Rails.autoloaders.each do |autoloader|

data/lib/active_record_proxy_adapters/trilogy_proxy.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_record_proxy_adapters/mysql2_proxy"
+
+module ActiveRecordProxyAdapters
+  # Proxy to the Mysql2Proxy, allowing the use of the ActiveRecordProxyAdapters::PrimaryReplicaProxy.
+  class TrilogyProxy < Mysql2Proxy
+  end
+end

data/lib/active_record_proxy_adapters/version.rb

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

data/postgres_primary.dockerfile

@@ -0,0 +1,34 @@
+FROM docker.io/postgres:17-alpine
+
+ARG REPLICA_USER=replicator
+ARG REPLICA_PASSWORD=replicator
+ARG REPLICATION_SLOT_NAME=replication_slot
+ARG INIT_SQL=00_init.sql
+ARG POSTGRES_LOGGING_COLLECTOR=
+ARG POSTGRES_LOG_DESTINATION=
+ARG POSTGRES_LOG_STATEMENT=
+ENV CONF_SAMPLE="/usr/local/share/postgresql/postgresql.conf.sample"
+
+WORKDIR /docker-entrypoint-initdb.d
+
+USER root
+
+RUN touch $INIT_SQL
+RUN chown -R postgres:postgres $INIT_SQL
+RUN echo "CREATE USER ${REPLICA_USER} WITH REPLICATION ENCRYPTED PASSWORD '${REPLICA_PASSWORD}';" > $INIT_SQL
+RUN echo "SELECT pg_create_physical_replication_slot('${REPLICATION_SLOT_NAME}');" >> $INIT_SQL
+
+# Enable logging collector if given
+RUN if [[ ! -z "${POSTGRES_LOGGING_COLLECTOR}" ]]; then sed -i "s/#\(logging_collector = \)off\(.*\)/\1${POSTGRES_LOGGING_COLLECTOR}\2/" ${CONF_SAMPLE}; fi
+
+# Override  default log destination if given
+RUN if [[ ! -z "${POSTGRES_LOG_DESTINATION}" ]]; then sed -i "s/#\(log_destination = \)'stderr'\(.*\)/\1'${POSTGRES_LOG_DESTINATION}'\2/" ${CONF_SAMPLE}; fi
+
+# Override log statement if given
+RUN if [[ ! -z "${POSTGRES_LOG_STATEMENT}" ]]; then sed -i "s/#\(log_statement = \)'none'\(.*\)/\1'${POSTGRES_LOG_STATEMENT}'\2/" ${CONF_SAMPLE}; fi
+
+WORKDIR /
+
+USER postgres
+
+CMD  ["postgres", "-c", "wal_level=replica", "-c", "hot_standby=on", "-c", "max_wal_senders=10", "-c", "max_replication_slots=10", "-c", "hot_standby_feedback=on" ]

data/postgres_replica.dockerfile

@@ -0,0 +1,15 @@
+FROM docker.io/postgres:17-alpine
+
+ENV PRIMARY_DATABASE_HOST=localhost
+ENV PRIMARY_DATABASE_PORT=5432
+ENV PRIMARY_REPLICATION_SLOT=replication_slot
+
+
+COPY docker/postgres_replica/cmd.sh cmd.sh
+
+USER root
+RUN chown -R postgres:postgres cmd.sh
+USER postgres
+RUN chmod u+x cmd.sh
+
+CMD [ "./cmd.sh" ]

data/sig/active_record_proxy_adapters.rbs

@@ -0,0 +1,4 @@
+module ActiveRecordProxyAdapters
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Cruz
 bindir: exe
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -57,22 +57,41 @@ email:
 - matt.cruz@nasdaq.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE.txt
+extra_rdoc_files: []
 files:
+- ".rspec"
+- ".rubocop.yml"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
 - LICENSE.txt
 - README.md
+- db/mysql_structure.sql
+- db/postgresql_structure.sql
+- docker-compose.yml
+- docker/postgres_replica/cmd.sh
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.0.gemfile.lock
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.1.gemfile.lock
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_7.2.gemfile.lock
+- gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.0.gemfile.lock
 - lib/active_record/connection_adapters/mysql2_proxy_adapter.rb
 - lib/active_record/connection_adapters/postgresql_proxy_adapter.rb
+- lib/active_record/connection_adapters/trilogy_proxy_adapter.rb
 - lib/active_record/tasks/mysql2_proxy_database_tasks.rb
 - lib/active_record/tasks/postgresql_proxy_database_tasks.rb
+- lib/active_record/tasks/trilogy_proxy_database_tasks.rb
 - lib/active_record_proxy_adapters.rb
 - lib/active_record_proxy_adapters/active_record_context.rb
 - lib/active_record_proxy_adapters/configuration.rb
 - lib/active_record_proxy_adapters/connection_handling.rb
 - lib/active_record_proxy_adapters/connection_handling/mysql2.rb
 - lib/active_record_proxy_adapters/connection_handling/postgresql.rb
+- lib/active_record_proxy_adapters/connection_handling/trilogy.rb
 - lib/active_record_proxy_adapters/database_tasks.rb
 - lib/active_record_proxy_adapters/hijackable.rb
 - lib/active_record_proxy_adapters/log_subscriber.rb
@@ -80,7 +99,11 @@ files:
 - lib/active_record_proxy_adapters/postgresql_proxy.rb
 - lib/active_record_proxy_adapters/primary_replica_proxy.rb
 - lib/active_record_proxy_adapters/railtie.rb
+- lib/active_record_proxy_adapters/trilogy_proxy.rb
 - lib/active_record_proxy_adapters/version.rb
+- postgres_primary.dockerfile
+- postgres_replica.dockerfile
+- sig/active_record_proxy_adapters.rbs
 homepage: https://github.com/Nasdaq/active_record_proxy_adapters
 licenses:
 - MIT