active_record_proxy_adapters 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 151caa80f35f53ad02ef3307a55ef0fec4f1a6f369e6afac8d063e4ea2ad5e7f
-  data.tar.gz: 60213ad52a363c435514038eeb65227bff7132b91a6dbed86b8917459449c39e
+  metadata.gz: 58d50939b1410d1d8af3dd6b2c0dd1b2b872104faf48392b2298f897b467d7f5
+  data.tar.gz: 03c3373e6d5b7eab78e628c797e35642dbc9e4a314d5b45b55dadbc018f5fcde
 SHA512:
-  metadata.gz: 7720b6fe6b2d6848d30444f77c71d2567996f2e45011c79e6c4791e043b7d9333c2d92554cdf5f6b5a48c29c6b384509a00b9f9b3b930402d47c98188744daa7
-  data.tar.gz: b73be535ad798afb4386d4027e4e92df00d9864a196d4cc1d30ad3a0a4e524c87ad12f67d214ef524a1641800ccf5bc2ab4911acf49c5606d867f51981a18fec
+  metadata.gz: 9d19e223654ee5c3bf983e27d5999348ec7458bfe7e9738ff21bac022830b68a372a743b30160c07270548aa4bf68f44ecc26b4b6f9eedd93eec0a480a15e3dd
+  data.tar.gz: 04f8f7f579ede01034073f5854c9892fbe4ebfe46ad06876d5fe2fe2c47613b94d38f79a86ddcd2b231557fbfb243e0fd0578a18bda715c5ffddc6c521694c67

data/.rubocop.yml

@@ -4,6 +4,8 @@ require:
 AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
+  Exclude:
+    - 'gemfiles/**/*'
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## [Unreleased]
 
-- Fix Active Record adapters dependency loading
+## [0.4.0] - 2025-02-24
+
+- Add load hooks for proxy adapters
+- Add TrilogyProxyAdapter
+
+## [0.3.1] - 2025-02-12
+- Fix Active Record adapters dependency loading https://github.com/Nasdaq/active_record_proxy_adapters/commit/b729f8bdb517cdc80f348c00e1fe4c5b56b76143
 
 ## [0.3.0] - 2025-01-17
 

data/Dockerfile

@@ -1,8 +1,8 @@
 ARG RUBY_VERSION=3.2.3
 ARG DOCKER_REGISTRY=docker.io
 FROM $DOCKER_REGISTRY/ruby:$RUBY_VERSION-alpine
-ARG RAILS_VERSION="~> 6.1.0"
-ENV RAILS_VERSION=$RAILS_VERSION
+ENV RAILS_VERSION="8.0.0"
+ENV RAILS_ENV=test
 
 RUN apk --update add \
     build-base \
@@ -17,4 +17,5 @@ COPY . /app
 WORKDIR /app
 
 RUN bundle install
+RUN bundle exec appraisal install
 

data/README.md

@@ -39,9 +39,9 @@ Currently supported adapters:
 
 - `postgresql`
 - `mysql2`
+- `trilogy`
 
 Coming soon:
-- `trilogy`
 - `sqlite`
 
 
@@ -87,11 +87,7 @@ end
 ```ruby
 # In your application setup
 require "active_record_proxy_adapters"
-
-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"
 
 # in your base model
 class ApplicationRecord << ActiveRecord::Base

data/docker-compose.yml

@@ -16,29 +16,29 @@ services:
     build:
       args:
         - RUBY_VERSION=${RUBY_VERSION:-3.3.6}
-        - RAILS_VERSION=${RAILS_VERSION:-8.0.0}
     container_name: app
     image: active_record_proxy_adapters-app:${ENV_TAG:-latest}
     tty: true
     stdin_open: true
     environment:
-      PGHOST: postgres_primary
-      PG_PRIMARY_USER: postgres_primary_test
-      PG_PRIMARY_PASSWORD: postgres_primary_test
-      PG_PRIMARY_HOST: postgres_primary
-      PG_PRIMARY_PORT: 5432
-      PG_REPLICA_USER: postgres_primary_test
-      PG_REPLICA_PASSWORD: postgres_primary_test
-      PG_REPLICA_HOST: postgres_replica
-      PG_REPLICA_PORT: 5432
-      MYSQL_PRIMARY_USER: root
-      MYSQL_PRIMARY_PASSWORD: mysql
-      MYSQL_PRIMARY_HOST: mysql_primary
-      MYSQL_PRIMARY_PORT: 3306
-      MYSQL_REPLICA_USER: root
-      MYSQL_REPLICA_PASSWORD: mysql
-      MYSQL_REPLICA_HOST: mysql_primary
-      MYSQL_REPLICA_PORT: 3306
+      - RAILS_VERSION=${RAILS_VERSION:-8.0.0}
+      - PGHOST=postgres_primary
+      - PG_PRIMARY_USER=postgres_primary_test
+      - PG_PRIMARY_PASSWORD=postgres_primary_test
+      - PG_PRIMARY_HOST=postgres_primary
+      - PG_PRIMARY_PORT=5432
+      - PG_REPLICA_USER=postgres_primary_test
+      - PG_REPLICA_PASSWORD=postgres_primary_test
+      - PG_REPLICA_HOST=postgres_replica
+      - PG_REPLICA_PORT=5432
+      - MYSQL_PRIMARY_USER=root
+      - MYSQL_PRIMARY_PASSWORD=mysql
+      - MYSQL_PRIMARY_HOST=mysql_primary
+      - MYSQL_PRIMARY_PORT=3306
+      - MYSQL_REPLICA_USER=root
+      - MYSQL_REPLICA_PASSWORD=mysql
+      - MYSQL_REPLICA_HOST=mysql_primary
+      - MYSQL_REPLICA_PORT=3306
     depends_on:
       - postgres_primary
       - postgres_replica

data/lib/active_record/connection_adapters/mysql2_proxy_adapter.rb

@@ -37,3 +37,5 @@ if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2_or_greater?
     "active_record/connection_adapters/mysql2_proxy_adapter"
   )
 end
+
+ActiveSupport.run_load_hooks(:active_record_mysql2proxyadapter, ActiveRecord::ConnectionAdapters::Mysql2ProxyAdapter)

data/lib/active_record/connection_adapters/postgresql_proxy_adapter.rb

@@ -41,3 +41,6 @@ if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2_or_greater?
     "active_record/connection_adapters/postgresql_proxy_adapter"
   )
 end
+
+ActiveSupport.run_load_hooks(:active_record_postgresqlproxyadapter,
+                             ActiveRecord::ConnectionAdapters::PostgreSQLProxyAdapter)

data/lib/active_record/connection_adapters/trilogy_proxy_adapter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "active_record/tasks/trilogy_proxy_database_tasks"
+require "active_record/connection_adapters/trilogy_adapter"
+require "active_record_proxy_adapters/active_record_context"
+require "active_record_proxy_adapters/hijackable"
+require "active_record_proxy_adapters/trilogy_proxy"
+
+module ActiveRecord
+  module ConnectionAdapters
+    # This adapter is a proxy to the original TrilogyAdapter, allowing the use of the
+    # ActiveRecordProxyAdapters::PrimaryReplicaProxy.
+    class TrilogyProxyAdapter < TrilogyAdapter
+      include ActiveRecordProxyAdapters::Hijackable
+
+      ADAPTER_NAME = "TrilogyProxy"
+
+      delegate_to_proxy :execute, :exec_query
+
+      def initialize(...)
+        @proxy = ActiveRecordProxyAdapters::TrilogyProxy.new(self)
+
+        super
+      end
+
+      private
+
+      attr_reader :proxy
+    end
+  end
+end
+
+if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2_or_greater?
+  ActiveRecord::ConnectionAdapters.register(
+    "trilogy_proxy",
+    "ActiveRecord::ConnectionAdapters::TrilogyProxyAdapter",
+    "active_record/connection_adapters/trilogy_proxy_adapter"
+  )
+end
+
+ActiveSupport.run_load_hooks(:active_record_trilogyproxyadapter, ActiveRecord::ConnectionAdapters::TrilogyProxyAdapter)

data/lib/active_record/tasks/trilogy_proxy_database_tasks.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_record_proxy_adapters/database_tasks"
+
+module ActiveRecord
+  module Tasks
+    # Defines the trilogy tasks for dropping, creating, loading schema and dumping schema.
+    # Bypasses all the proxy logic to send all requests to primary.
+    class TrilogyProxyDatabaseTasks < MySQLDatabaseTasks
+      include ActiveRecordProxyAdapters::DatabaseTasks
+    end
+  end
+end
+
+# Allow proxy adapter to run rake tasks, i.e. db:drop, db:create, db:schema:load db:migrate, etc...
+ActiveRecord::Tasks::DatabaseTasks.register_task(
+  /trilogy_proxy/,
+  "ActiveRecord::Tasks::TrilogyProxyDatabaseTasks"
+)

data/lib/active_record_proxy_adapters/connection_handling/mysql2.rb

@@ -8,32 +8,38 @@ rescue LoadError
 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 ConnectionHandling
-    def mysql2_proxy_adapter_class
-      ::ActiveRecord::ConnectionAdapters::Mysql2ProxyAdapter
-    end
+  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
+      # 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
+        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
-      )
+        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.rb

@@ -10,31 +10,37 @@ 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 ConnectionHandling
-    def postgresql_proxy_adapter_class
-      ::ActiveRecord::ConnectionAdapters::PostgreSQLProxyAdapter
-    end
+  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
+      # 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]
+        # 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)
+        # 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
-      )
+        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/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/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.1"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Matt Cruz
 bindir: exe
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,14 +72,17 @@ files:
 - docker/postgres_replica/cmd.sh
 - 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
@@ -87,6 +90,7 @@ 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