active_record_proxy_adapters 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b23e66bd5df6d979b9efad29a52139552950f29774935cc91fffdbc87805a4c
-  data.tar.gz: 5b3206ee7420635f2f76432a1bbe728e161a9ea434db42da22ac5290ae561e3d
+  metadata.gz: 5312effcf68a3305eb5e7804440112433f5b6837d6b71e7d122145eac4741619
+  data.tar.gz: 50586657daa02e76dfffebbe1faf8df5093198471faf847cec97cd16634c0c17
 SHA512:
-  metadata.gz: cb98f62ce8a62ef0d71364491d1686186c527adc0c6a8612fd5ee118710fe9360166f14ae06b348856548c8b507ef90edf413113e93a9afa56c82e84c267df1e
-  data.tar.gz: 75f30a3ce9473415be91a51acc9fc39a5aacc31b6623943a007b3fb0c41e330752c6f6b470ee759d141b6c84feb96d3b24a015939bb0b053d82ac50a22adb447
+  metadata.gz: 707b80a3618328639126d13f3f76bb8123105019b3e30c75f15c66a66a88d49aa5de4301fe70b25ff5356ef37e54ebff896f4cab0160cadbb79d08ae9cf0dc4e
+  data.tar.gz: 6b84984e33cf87abe9a12f5553bccffc32e2a9563a0c859c488cdae4be4c3a019ffce01242648620c67bb85a16dc61d982f0be8ecba83943f01c718e067743dc

data/CHANGELOG.md

@@ -1,17 +1,26 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-12-24
+
+- 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 (ea5a33997da45ac073f166b3fbd2d12426053cd6)
+- Retrieve replica pool without checking out a connection (6470ef58e851082ae1f7a860ecdb5b451ef903c8)
+
 ## [0.1.2] - 2024-12-16
 
-Fix CTE regex matcher (4b1d10b)
+- Fix CTE regex matcher (4b1d10bfd952fb1f5b102de8cc1a5bd05d25f5e9)
 
 ## [0.1.1] - 2024-11-27
 
-- Enable RubyGems MFA (2a71b1f)
+- Enable RubyGems MFA (2a71b1f4354fb966cc0aa68231ca5837814e07ee)
 
 ## [0.1.0] - 2024-11-19
 
-- Add PostgreSQLProxyAdapter (2b3bb9f)
+- Add PostgreSQLProxyAdapter (2b3bb9f7359139519b32af3018ceb07fed8c6b33)
 
 ## [0.1.0.rc2] - 2024-10-28
 
-- Add PostgreSQLProxyAdapter (2b3bb9f)
+- Add PostgreSQLProxyAdapter (2b3bb9f7359139519b32af3018ceb07fed8c6b33)

data/db/postgresql_structure.sql

@@ -0,0 +1,76 @@
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET idle_in_transaction_session_timeout = 0;
+SET client_encoding = 'UTF8';
+SET standard_conforming_strings = on;
+SELECT pg_catalog.set_config('search_path', '', false);
+SET check_function_bodies = false;
+SET xmloption = content;
+SET client_min_messages = warning;
+SET row_security = off;
+
+--
+-- Name: public; Type: SCHEMA; Schema: -; Owner: -
+--
+
+-- *not* creating schema, since initdb creates it
+
+
+SET default_tablespace = '';
+
+SET default_table_access_method = heap;
+
+--
+-- Name: users; Type: TABLE; Schema: public; Owner: -
+--
+
+CREATE TABLE public.users (
+    id integer NOT NULL,
+    name text NOT NULL,
+    email text NOT NULL,
+    created_at timestamp without time zone DEFAULT now() NOT NULL,
+    updated_at timestamp without time zone DEFAULT now() NOT NULL
+);
+
+
+--
+-- Name: users_id_seq; Type: SEQUENCE; Schema: public; Owner: -
+--
+
+CREATE SEQUENCE public.users_id_seq
+    AS integer
+    START WITH 1
+    INCREMENT BY 1
+    NO MINVALUE
+    NO MAXVALUE
+    CACHE 1;
+
+
+--
+-- Name: users_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: -
+--
+
+ALTER SEQUENCE public.users_id_seq OWNED BY public.users.id;
+
+
+--
+-- Name: users id; Type: DEFAULT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.users ALTER COLUMN id SET DEFAULT nextval('public.users_id_seq'::regclass);
+
+
+--
+-- Name: users users_pkey; Type: CONSTRAINT; Schema: public; Owner: -
+--
+
+ALTER TABLE ONLY public.users
+    ADD CONSTRAINT users_pkey PRIMARY KEY (id);
+
+
+--
+-- PostgreSQL database dump complete
+--
+
+SET search_path TO "$user", public;
+

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,15 +62,19 @@ module ActiveRecordProxyAdapters
 
     attr_reader :primary_connection, :last_write_at, :active_record_context
 
-    delegate :connected_to_stack, to: :connection_class
+    delegate :connection_handler, :connected_to_stack, to: :connection_class
     delegate :reading_role, :writing_role, to: :active_record_context
 
-    def connection_class
-      active_record_context.connection_class_for(primary_connection)
+    def replica_pool_unavailable?
+      !replica_pool
     end
 
     def replica_pool
-      ActiveRecord::Base.connected_to(role: reading_role) { ActiveRecord::Base.connection_pool }
+      connection_handler.retrieve_connection_pool(connection_class.name, role: reading_role)
+    end
+
+    def connection_class
+      active_record_context.connection_class_for(primary_connection)
     end
 
     def coerce_query_to_string(sql_or_arel)
@@ -107,21 +111,12 @@ module ActiveRecordProxyAdapters
       [reading_role, writing_role].include?(role) ? role : nil
     end
 
-    def connection_for(role, sql_string) # rubocop:disable Metrics/MethodLength
-      connection = if role == writing_role
-                     primary_connection
-                   else
-                     begin
-                       replica_pool.checkout(checkout_timeout)
-                     # rescue NoDatabaseError to avoid crashing when running db:create rake task
-                     # rescue ConnectionNotEstablished to handle connectivity issues in the replica
-                     # (for example, replication delay)
-                     rescue ActiveRecord::NoDatabaseError, ActiveRecord::ConnectionNotEstablished
-                       primary_connection
-                     end
-                   end
+    def connection_for(role, sql_string)
+      connection = primary_connection if role == writing_role || replica_pool_unavailable?
+      connection ||= checkout_replica_connection
 
       result = yield(connection)
+
       update_primary_latest_write_timestamp if !replica_connection?(connection) && write_statement?(sql_string)
 
       result
@@ -130,7 +125,16 @@ module ActiveRecordProxyAdapters
     end
 
     def replica_connection?(connection)
-      connection != primary_connection
+      connection && connection != primary_connection
+    end
+
+    def checkout_replica_connection
+      replica_pool.checkout(checkout_timeout)
+    # rescue NoDatabaseError to avoid crashing when running db:create rake task
+    # rescue ConnectionNotEstablished to handle connectivity issues in the replica
+    # (for example, replication delay)
+    rescue ActiveRecord::NoDatabaseError, ActiveRecord::ConnectionNotEstablished
+      primary_connection
     end
 
     # @return [TrueClass] if there has been a write within the last {#proxy_delay} seconds

data/lib/active_record_proxy_adapters/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -67,7 +67,7 @@ files:
 - Dockerfile
 - LICENSE.txt
 - README.md
-- Rakefile
+- db/postgresql_structure.sql
 - docker-compose.yml
 - docker/postgres_replica/cmd.sh
 - lib/active_record/connection_adapters/postgresql_proxy_adapter.rb
@@ -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

data/Rakefile

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
-
-namespace :coverage do
-  desc "Collates all result sets generated by the different test runners"
-  task :report do
-    require "simplecov"
-
-    SimpleCov.collate Dir["coverage/**/.resultset.json"] do
-      add_group "PostgreSQL" do |src_file|
-        [/postgresql/, /postgre_sql/].any? { |pattern| pattern.match?(src_file.filename) }
-      end
-    end
-  end
-end