active_record_proxy_adapters 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b23e66bd5df6d979b9efad29a52139552950f29774935cc91fffdbc87805a4c
-  data.tar.gz: 5b3206ee7420635f2f76432a1bbe728e161a9ea434db42da22ac5290ae561e3d
+  metadata.gz: 194bba4baff1556a91940f5a5860f30313594655fe81928451ae4970f4f03f35
+  data.tar.gz: 1f8eaa86a73aab8ceded3beab0ee6a64dc099754dd3c4fad1ce380d5b511af6e
 SHA512:
-  metadata.gz: cb98f62ce8a62ef0d71364491d1686186c527adc0c6a8612fd5ee118710fe9360166f14ae06b348856548c8b507ef90edf413113e93a9afa56c82e84c267df1e
-  data.tar.gz: 75f30a3ce9473415be91a51acc9fc39a5aacc31b6623943a007b3fb0c41e330752c6f6b470ee759d141b6c84feb96d3b24a015939bb0b053d82ac50a22adb447
+  metadata.gz: 95e131acbfc3b48f1bcf475ebde62157978c6f6c29a0f8d616ba30bbc4eac03b866a404357314abff3fd826b1086b68ca782864512f090d77cb13e48f4f02f1b
+  data.tar.gz: '08bbf033512800954cc3ff0bd94b035d168a39ed8c790abb670b01238e438dfe431cf233c2d7e816ec28003f86c588227cc4a099eee0d9e17a922604cd6ef691'

data/CHANGELOG.md

@@ -1,8 +1,11 @@
 ## [Unreleased]
 
+- Fix replica connection pool getter when database configurations have multiple replicas
+- Retrieve replica pool without checking out a connection
+
 ## [0.1.2] - 2024-12-16
 
-Fix CTE regex matcher (4b1d10b)
+- Fix CTE regex matcher (4b1d10b)
 
 ## [0.1.1] - 2024-11-27
 

data/Rakefile

@@ -11,6 +11,62 @@ RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
 
+desc "Prepares the database environment for use"
+task :environment do
+  $LOAD_PATH << File.expand_path("lib", __dir__)
+  require "active_record_proxy_adapters"
+  require "active_record_proxy_adapters/connection_handling"
+  ActiveRecord::Base.extend ActiveRecordProxyAdapters::ConnectionHandling
+  require_relative "spec/test_helper"
+
+  TestHelper.setup_active_record_config
+
+  $stdout.puts "Environment loaded: #{TestHelper.env_name}"
+end
+
+namespace :db do # rubocop:disable Metrics/BlockLength
+  desc "Drops all databases"
+  task drop: %i[drop:postgresql]
+
+  namespace :drop do
+    desc "Drops the postgresql database"
+    task postgresql: :environment do
+      TestHelper.drop_database
+    end
+  end
+
+  desc "Creates all databases"
+  task create: %i[create:postgresql]
+
+  namespace :create do
+    desc "Creates the postgresql database"
+    task postgresql: :environment do
+      TestHelper.create_database
+    end
+  end
+
+  namespace :schema do
+    desc "Loads all schemas onto their respective databases"
+    task load: %i[load:postgresql]
+
+    namespace :load do
+      desc "Loads the schema into the postgresql database from schema_path. Default is db/postgresql_structure.sql"
+      task :postgresql, [:schema_path] => :environment do |_task, args|
+        args.with_defaults(schema_path: "db/postgresql_structure.sql")
+        TestHelper.load_schema(args.schema_path)
+      end
+    end
+  end
+
+  desc "Creates a all databases and loads their schemas"
+  task setup: %i[create schema:load]
+
+  namespace :setup do
+    desc "Creates the postgresql database and loads the schema"
+    task postgresql: %i[create:postgresql schema:load:postgresql]
+  end
+end
+
 namespace :coverage do
   desc "Collates all result sets generated by the different test runners"
   task :report do

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/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -62,15 +62,28 @@ 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 }
+      # 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
 
     def coerce_query_to_string(sql_or_arel)
@@ -107,21 +120,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 +134,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.1.4"
 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.1.4
 platform: ruby
 authors:
 - Matt Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -68,6 +68,7 @@ files:
 - 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