active_record_proxy_adapters 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80e3ab832bc332967c0f4840f9f35563725497e61a48339c46e4f65a15b2458
-  data.tar.gz: fc85aed94e09aa25bd15e46102ae318f9b790bc2bb67a24243c2340952ff4fa2
+  metadata.gz: 5312effcf68a3305eb5e7804440112433f5b6837d6b71e7d122145eac4741619
+  data.tar.gz: 50586657daa02e76dfffebbe1faf8df5093198471faf847cec97cd16634c0c17
 SHA512:
-  metadata.gz: 5a81cf2441d0f1548311474fbaa3326b9d2fbccc0b25c481408f0f99ce6634710dc589e0aed60f63ca55e5debe2635eb4cd6a75c2a0cf444fb7929292dc02dac
-  data.tar.gz: c4bd34a35fa68b8257a5839b99055efdd11d18ce436afea98fd695475c4dae7cfda7ecc26fc2aed61f0981258c65684f22185c6d8fddc143ceb06b400b9219b1
+  metadata.gz: 707b80a3618328639126d13f3f76bb8123105019b3e30c75f15c66a66a88d49aa5de4301fe70b25ff5356ef37e54ebff896f4cab0160cadbb79d08ae9cf0dc4e
+  data.tar.gz: 6b84984e33cf87abe9a12f5553bccffc32e2a9563a0c859c488cdae4be4c3a019ffce01242648620c67bb85a16dc61d982f0be8ecba83943f01c718e067743dc

data/CHANGELOG.md

@@ -1,37 +1,26 @@
 ## [Unreleased]
 
-- Handle PendingMigrationConnection introduced by Rails 7.2 and backported to Rails 7.1
-- Stick to same connection throughout request span
-
-## [0.2.1] - 2025-01-02
-
-- Fix replica connection pool getter when specific connection name is not found https://github.com/Nasdaq/active_record_proxy_adapters/commit/847e150dd21c5bc619745ee1d9d8fcaa9b8f2eea
-
 ## [0.2.0] - 2024-12-24
 
-- Add custom log subscriber to tag queries based on the adapter being used https://github.com/Nasdaq/active_record_proxy_adapters/commit/68b8c1f4191388eb957bf12e0f84289da667e940
-
-## [0.1.4] - 2025-01-02
-
-- Fix replica connection pool getter when specific connection name is not found https://github.com/Nasdaq/active_record_proxy_adapters/commit/88b32a282b54d420e652f638656dbcf063ac8796
+- Add custom log subscriber to tag queries based on the adapter being used (68b8c1f4191388eb957bf12e0f84289da667e940)
 
 ## [0.1.3] - 2024-12-24
 
-- Fix replica connection pool getter when database configurations have multiple replicas https://github.com/Nasdaq/active_record_proxy_adapters/commit/ea5a33997da45ac073f166b3fbd2d12426053cd6
-- Retrieve replica pool without checking out a connection https://github.com/Nasdaq/active_record_proxy_adapters/commit/6470ef58e851082ae1f7a860ecdb5b451ef903c8
+- Fix replica connection pool getter when database configurations have multiple replicas (ea5a33997da45ac073f166b3fbd2d12426053cd6)
+- Retrieve replica pool without checking out a connection (6470ef58e851082ae1f7a860ecdb5b451ef903c8)
 
 ## [0.1.2] - 2024-12-16
 
-- Fix CTE regex matcher https://github.com/Nasdaq/active_record_proxy_adapters/commit/4b1d10bfd952fb1f5b102de8cc1a5bd05d25f5e9
+- Fix CTE regex matcher (4b1d10bfd952fb1f5b102de8cc1a5bd05d25f5e9)
 
 ## [0.1.1] - 2024-11-27
 
-- Enable RubyGems MFA https://github.com/Nasdaq/active_record_proxy_adapters/commit/2a71b1f4354fb966cc0aa68231ca5837814e07ee
+- Enable RubyGems MFA (2a71b1f4354fb966cc0aa68231ca5837814e07ee)
 
 ## [0.1.0] - 2024-11-19
 
-- Add PostgreSQLProxyAdapter https://github.com/Nasdaq/active_record_proxy_adapters/commit/2b3bb9f7359139519b32af3018ceb07fed8c6b33
+- Add PostgreSQLProxyAdapter (2b3bb9f7359139519b32af3018ceb07fed8c6b33)
 
 ## [0.1.0.rc2] - 2024-10-28
 
-- Add PostgreSQLProxyAdapter https://github.com/Nasdaq/active_record_proxy_adapters/commit/2b3bb9f7359139519b32af3018ceb07fed8c6b33
+- Add PostgreSQLProxyAdapter (2b3bb9f7359139519b32af3018ceb07fed8c6b33)

data/Dockerfile

@@ -8,7 +8,7 @@ RUN apk --update add \
     build-base \
     git \
     postgresql-dev \
-    postgresql17-client
+    postgresql-client
 RUN gem install bundler -v 2.5.13
 
 COPY . /app

data/README.md

@@ -1,7 +1,5 @@
 # ActiveRecordProxyAdapters
 
-[![Run Test Suite](https://github.com/Nasdaq/active_record_proxy_adapters/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Nasdaq/active_record_proxy_adapters/actions/workflows/test.yml)
-
 A set of ActiveRecord adapters that leverage Rails native multiple database setup to allow automatic connection switching from _one_ primary pool to _one_ replica pool at the database statement level.
 
 ## Installation

data/db/postgresql_structure.sql

@@ -1,7 +1,6 @@
 SET statement_timeout = 0;
 SET lock_timeout = 0;
 SET idle_in_transaction_session_timeout = 0;
-SET transaction_timeout = 0;
 SET client_encoding = 'UTF8';
 SET standard_conforming_strings = on;
 SELECT pg_catalog.set_config('search_path', '', false);
@@ -10,18 +9,16 @@ SET xmloption = content;
 SET client_min_messages = warning;
 SET row_security = off;
 
-SET default_tablespace = '';
-
-SET default_table_access_method = heap;
-
 --
--- Name: schema_migrations; Type: TABLE; Schema: public; Owner: -
+-- Name: public; Type: SCHEMA; Schema: -; Owner: -
 --
 
-CREATE TABLE public.schema_migrations (
-    version character varying(255) NOT NULL
-);
+-- *not* creating schema, since initdb creates it
+
+
+SET default_tablespace = '';
 
+SET default_table_access_method = heap;
 
 --
 -- Name: users; Type: TABLE; Schema: public; Owner: -
@@ -71,13 +68,6 @@ ALTER TABLE ONLY public.users
     ADD CONSTRAINT users_pkey PRIMARY KEY (id);
 
 
---
--- Name: unique_schema_migrations; Type: INDEX; Schema: public; Owner: -
---
-
-CREATE UNIQUE INDEX unique_schema_migrations ON public.schema_migrations USING btree (version);
-
-
 --
 -- PostgreSQL database dump complete
 --

data/docker-compose.yml

@@ -50,6 +50,7 @@ services:
         - POSTGRES_LOG_STATEMENT=${POSTGRES_LOG_STATEMENT:-}
         - REPLICA_USER=replicator
         - REPLICA_PASSWORD=replicator
+    container_name: postgres_primary
     environment:
       POSTGRES_DB: postgres
       POSTGRES_USER: postgres_primary_test

data/lib/active_record_proxy_adapters/configuration.rb

@@ -5,8 +5,10 @@ require "active_support/core_ext/integer/time"
 module ActiveRecordProxyAdapters
   # Provides a global configuration object to configure how the proxy should behave.
   class Configuration
-    PROXY_DELAY      = 2.seconds.freeze
-    CHECKOUT_TIMEOUT = 2.seconds.freeze
+    PROXY_DELAY                   = 2.seconds.freeze
+    CHECKOUT_TIMEOUT              = 2.seconds.freeze
+    LOG_SUBSCRIBER_PRIMARY_PREFIX = proc { |event| "#{event.payload[:connection].class::ADAPTER_NAME} Primary" }.freeze
+    LOG_SUBSCRIBER_REPLICA_PREFIX = proc { |event| "#{event.payload[:connection].class::ADAPTER_NAME} Replica" }.freeze
 
     # @return [ActiveSupport::Duration] How long the proxy should reroute all read requests to the primary database
     #   since the latest write. Defaults to PROXY_DELAY.
@@ -15,9 +17,25 @@ module ActiveRecordProxyAdapters
     #   Defaults to CHECKOUT_TIMEOUT.
     attr_accessor :checkout_timeout
 
+    # @return [Proc] Prefix for the log subscriber when the primary database is used.
+    attr_reader :log_subscriber_primary_prefix
+
+    # @return [Proc] Prefix for the log subscriber when the replica database is used.
+    attr_reader :log_subscriber_replica_prefix
+
     def initialize
-      self.proxy_delay      = PROXY_DELAY
-      self.checkout_timeout = CHECKOUT_TIMEOUT
+      self.proxy_delay                   = PROXY_DELAY
+      self.checkout_timeout              = CHECKOUT_TIMEOUT
+      self.log_subscriber_primary_prefix = LOG_SUBSCRIBER_PRIMARY_PREFIX
+      self.log_subscriber_replica_prefix = LOG_SUBSCRIBER_REPLICA_PREFIX
+    end
+
+    def log_subscriber_primary_prefix=(prefix)
+      @log_subscriber_primary_prefix = prefix.is_a?(Proc) ? prefix : proc { prefix.to_s }
+    end
+
+    def log_subscriber_replica_prefix=(prefix)
+      @log_subscriber_replica_prefix = prefix.is_a?(Proc) ? prefix : proc { prefix.to_s }
     end
   end
 end

data/lib/active_record_proxy_adapters/log_subscriber.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActiveRecordProxyAdapters
+  class LogSubscriber < ActiveRecord::LogSubscriber # rubocop:disable Style/Documentation
+    attach_to :active_record
+
+    IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
+
+    def sql(event)
+      payload = event.payload
+      name = payload[:name]
+      unless IGNORE_PAYLOAD_NAMES.include?(name)
+        name = [database_instance_prefix_for(event), name].compact.join(" ")
+        payload[:name] = name
+      end
+      super
+    end
+
+    protected
+
+    def database_instance_prefix_for(event)
+      connection = event.payload[:connection]
+      config = connection.instance_variable_get(:@config)
+      prefix = if config[:replica] || config["replica"]
+                 log_subscriber_replica_prefix
+               else
+                 log_subscriber_primary_prefix
+               end
+
+      "[#{prefix.call(event)}]"
+    end
+
+    private
+
+    delegate :log_subscriber_primary_prefix, :log_subscriber_replica_prefix, to: :config
+
+    def config
+      ActiveRecordProxyAdapters.config
+    end
+  end
+end

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -62,7 +62,7 @@ module ActiveRecordProxyAdapters
 
     attr_reader :primary_connection, :last_write_at, :active_record_context
 
-    delegate :connection_handler, to: :connection_class
+    delegate :connection_handler, :connected_to_stack, to: :connection_class
     delegate :reading_role, :writing_role, to: :active_record_context
 
     def replica_pool_unavailable?
@@ -70,18 +70,9 @@ module ActiveRecordProxyAdapters
     end
 
     def replica_pool
-      # use default handler if the connection pool for specific class is not found
-      specific_replica_pool || default_replica_pool
-    end
-
-    def specific_replica_pool
       connection_handler.retrieve_connection_pool(connection_class.name, role: reading_role)
     end
 
-    def default_replica_pool
-      connection_handler.retrieve_connection_pool(ActiveRecord::Base.name, role: reading_role)
-    end
-
     def connection_class
       active_record_context.connection_class_for(primary_connection)
     end
@@ -120,25 +111,11 @@ module ActiveRecordProxyAdapters
       [reading_role, writing_role].include?(role) ? role : nil
     end
 
-    def connected_to_stack
-      return connection_class.connected_to_stack if connection_class.respond_to?(:connected_to_stack)
-
-      # handle Rails 7.2+ pending migrations Connection
-      return [{ role: writing_role }] if pending_migration_connection?
-
-      []
-    end
-
-    def pending_migration_connection?
-      active_record_context.active_record_v7_1_or_greater? &&
-        connection_class.name == "ActiveRecord::PendingMigrationConnection"
-    end
-
     def connection_for(role, sql_string)
       connection = primary_connection if role == writing_role || replica_pool_unavailable?
       connection ||= checkout_replica_connection
 
-      result = connected_to(role:) { yield connection }
+      result = yield(connection)
 
       update_primary_latest_write_timestamp if !replica_connection?(connection) && write_statement?(sql_string)
 
@@ -147,12 +124,6 @@ module ActiveRecordProxyAdapters
       replica_connection?(connection) && replica_pool.checkin(connection)
     end
 
-    def connected_to(role:, &block)
-      return block.call unless connection_class.respond_to?(:connected_to)
-
-      connection_class.connected_to(role:, &block)
-    end
-
     def replica_connection?(connection)
       connection && connection != primary_connection
     end

data/lib/active_record_proxy_adapters/version.rb

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

data/postgres_primary.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/postgres:17-alpine
+FROM docker.io/postgres:14-alpine
 
 ARG REPLICA_USER=replicator
 ARG REPLICA_PASSWORD=replicator

data/postgres_replica.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/postgres:17-alpine
+FROM docker.io/postgres:14-alpine
 
 ENV PRIMARY_DATABASE_HOST=localhost
 ENV PRIMARY_DATABASE_PORT=5432

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,6 +77,7 @@ files:
 - lib/active_record_proxy_adapters/configuration.rb
 - lib/active_record_proxy_adapters/connection_handling.rb
 - lib/active_record_proxy_adapters/hijackable.rb
+- lib/active_record_proxy_adapters/log_subscriber.rb
 - lib/active_record_proxy_adapters/postgresql_proxy.rb
 - lib/active_record_proxy_adapters/primary_replica_proxy.rb
 - lib/active_record_proxy_adapters/railtie.rb