active_record_proxy_adapters 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 265cb32e99a265497548122846934c46405747109fa3bee34d1e2e66203b14a3
-  data.tar.gz: d9de3faf7274a0a94166637032c0a967e083edf55fc275b2456123d3f9a7ee79
+  metadata.gz: 70b1c4f2efd94125b178e043fa1162ab6d8d8edb7a9041eb10b8244c606b3c59
+  data.tar.gz: fb74c76ed0dc0865c9756c3188a92dd248ce58ef4832811704c15a59b728991e
 SHA512:
-  metadata.gz: 871504b4290e8304effa5e30962a8db9fdab6663c73b4f9d9e99edf403af630755ddaaafa557619a86430812b7e54e19931274ec71dd4f86a7b4dc32b73fc669
-  data.tar.gz: f7605b374452517ae3346d896d043e092539abd0a86445eb1a04defbd7516628a70bcd5157fca10c730b7ee6fe047733d1e8e4d65a016c49651cbb12f7e8dcee
+  metadata.gz: 3730cca00342dd7f44944305bfdd53f158da2bc8d09b39883645a2b1a581297904dce121c10de5bc351e30b999b1bcd59457bd3309280074fb36d716a22bdcae
+  data.tar.gz: 07d42f0c57bdd203a260a7d55010159318db260f95ed5483049e8a6ac771908df7696d05692a3043f0a54d77f4e2623c6aa08b7ddda2db5a79e634224db78b12

data/CHANGELOG.md

@@ -1,9 +1,20 @@
+## [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)
+
+## [0.1.1] - 2024-11-27
+
+- Enable RubyGems MFA (2a71b1f)
+
 ## [0.1.0] - 2024-11-19
 
-- Add PostgreSQLProxyAdapter
+- Add PostgreSQLProxyAdapter (2b3bb9f)
 
 ## [0.1.0.rc2] - 2024-10-28
 
-- Add PostgreSQLProxyAdapter
-
-## [Unreleased]
+- Add PostgreSQLProxyAdapter (2b3bb9f)

data/Rakefile

@@ -10,3 +10,72 @@ require "rubocop/rake_task"
 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
+    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

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/postgres_replica/cmd.sh

@@ -0,0 +1,9 @@
+until pg_basebackup --pgdata=/var/lib/postgresql/data -R --slot=$PRIMARY_REPLICATION_SLOT --host=$PRIMARY_DATABASE_HOST --port=$PRIMARY_DATABASE_PORT
+do
+  echo 'Waiting for primary to connect...'
+  sleep 1s
+done
+
+echo 'Backup done, starting replica...'
+chmod 0700 /var/lib/postgresql/data
+postgres

data/docker-compose.yml

@@ -15,8 +15,8 @@ services:
   app:
     build:
       args:
-        - RUBY_VERSION=${RUBY_VERSION:-3.2.3}
-        - RAILS_VERSION=${RAILS_VERSION:-~> 6.1.0}
+        - 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

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -16,7 +16,7 @@ module ActiveRecordProxyAdapters
       /\A\s*select.+(nextval|currval|lastval|get_lock|release_lock|pg_advisory_lock|pg_advisory_unlock)\(/i
     ].map(&:freeze).freeze
     # All queries that match these patterns should be sent to the replica database
-    SQL_REPLICA_MATCHERS     = [/\A\s*(select|with.+\)\s*select)\s/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
@@ -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.1"
+  VERSION = "0.1.3"
 end

data/postgres_replica.dockerfile

@@ -4,20 +4,12 @@ ENV PRIMARY_DATABASE_HOST=localhost
 ENV PRIMARY_DATABASE_PORT=5432
 ENV PRIMARY_REPLICATION_SLOT=replication_slot
 
-USER root
-RUN printf '' > cmd.sh
 
-RUN echo 'until pg_basebackup --pgdata=/var/lib/postgresql/data -R --slot=$PRIMARY_REPLICATION_SLOT --host=$PRIMARY_DATABASE_HOST --port=$PRIMARY_DATABASE_PORT' >> cmd.sh
-RUN echo 'do' >> cmd.sh
-RUN echo "echo 'Waiting for primary to connect...'" >> cmd.sh
-RUN echo 'sleep 1s' >> cmd.sh
-RUN echo 'done' >> cmd.sh
-RUN echo "echo 'Backup done, starting replica...'" >> cmd.sh
-RUN echo 'chmod 0700 /var/lib/postgresql/data' >> cmd.sh
-RUN echo 'postgres' >> cmd.sh
+COPY docker/postgres_replica/cmd.sh cmd.sh
 
+USER root
 RUN chown -R postgres:postgres cmd.sh
 USER postgres
-RUN chmod u+rwx cmd.sh
+RUN chmod u+x cmd.sh
 
 CMD [ "./cmd.sh" ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Matt Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -68,7 +68,9 @@ 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
 - lib/active_record/tasks/postgresql_proxy_database_tasks.rb
 - lib/active_record_proxy_adapters.rb