active_record_proxy_adapters 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 194bba4baff1556a91940f5a5860f30313594655fe81928451ae4970f4f03f35
-  data.tar.gz: 1f8eaa86a73aab8ceded3beab0ee6a64dc099754dd3c4fad1ce380d5b511af6e
+  metadata.gz: 0650c0793e1af3d7f06f1da1708cc590942468daca491353b57a74575926a5e2
+  data.tar.gz: 44cd716171d8a8d2d430ac8ae3780f54634ecdf1ae1014ca09720f9fef95bf5b
 SHA512:
-  metadata.gz: 95e131acbfc3b48f1bcf475ebde62157978c6f6c29a0f8d616ba30bbc4eac03b866a404357314abff3fd826b1086b68ca782864512f090d77cb13e48f4f02f1b
-  data.tar.gz: '08bbf033512800954cc3ff0bd94b035d168a39ed8c790abb670b01238e438dfe431cf233c2d7e816ec28003f86c588227cc4a099eee0d9e17a922604cd6ef691'
+  metadata.gz: 68b00c13361168d78b70752002443988132725b013330d1e1161277f73c1a808f0153e76e6fb397bc7dd23c9bc8ba108a6c99ec3bdfc60d45f59a2c47902f693
+  data.tar.gz: a2bb48e98f0a57bb4f4546ca5bf821be670205a50a0b2ec439a79c98e3db1e43c28b63fe90c7d5849ba0ae048b4b20300658ce7fee62dd874e345c9ac50a0e86

data/README.md

@@ -1,5 +1,7 @@
 # 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/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, :connected_to_stack, to: :connection_class
+    delegate :connection_handler, to: :connection_class
     delegate :reading_role, :writing_role, to: :active_record_context
 
     def replica_pool_unavailable?
@@ -120,11 +120,25 @@ 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 = yield(connection)
+      result = connected_to(role:) { yield connection }
 
       update_primary_latest_write_timestamp if !replica_connection?(connection) && write_statement?(sql_string)
 
@@ -133,6 +147,12 @@ 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.4"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Matt Cruz
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,19 +57,12 @@ email:
 - matt.cruz@nasdaq.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
 files:
-- ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- 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
 - lib/active_record/tasks/postgresql_proxy_database_tasks.rb
 - lib/active_record_proxy_adapters.rb
@@ -82,9 +74,6 @@ files:
 - lib/active_record_proxy_adapters/primary_replica_proxy.rb
 - lib/active_record_proxy_adapters/railtie.rb
 - lib/active_record_proxy_adapters/version.rb
-- postgres_primary.dockerfile
-- postgres_replica.dockerfile
-- sig/active_record_proxy_adapters.rbs
 homepage: https://github.com/Nasdaq/active_record_proxy_adapters
 licenses:
 - MIT
@@ -94,7 +83,6 @@ metadata:
   source_code_uri: https://github.com/Nasdaq/active_record_proxy_adapters
   changelog_uri: https://github.com/Nasdaq/active_record_proxy_adapters/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Read replica proxy adapters for ActiveRecord!
 test_files: []

data/.rspec

@@ -1,4 +0,0 @@
---format documentation
---color
---order random
---require spec_helper

data/.rubocop.yml

@@ -1,16 +0,0 @@
-require:
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.1
-  NewCops: enable
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-RSpec/NestedGroups:
-  Enabled: true
-  Max: 5

data/CHANGELOG.md

@@ -1,20 +0,0 @@
-## [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 (2b3bb9f)
-
-## [0.1.0.rc2] - 2024-10-28
-
-- Add PostgreSQLProxyAdapter (2b3bb9f)

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/Dockerfile

@@ -1,18 +0,0 @@
-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
-
-RUN apk --update add \
-    build-base \
-    git \
-    postgresql-dev \
-    postgresql-client
-RUN gem install bundler -v 2.5.13
-
-COPY . /app
-WORKDIR /app
-
-RUN bundle install
-

data/Rakefile

@@ -1,81 +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]
-
-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

@@ -1,76 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,77 +0,0 @@
-name: active_record_proxy_adapters
-
-x-postgres-common: &postgres-common
-  restart: always
-  user: postgres
-  healthcheck:
-    test: 'pg_isready -U postgres_primary_test --dbname=postgres'
-    interval: 10s
-    timeout: 5s
-    retries: 5
-  networks:
-    - postgres
-
-services:
-  app:
-    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
-    depends_on:
-      - postgres_primary
-      - postgres_replica
-    networks:
-      - app
-      - postgres
-    volumes:
-      - .:/app
-  postgres_primary:
-    <<: *postgres-common
-    build:
-      context: .
-      dockerfile: postgres_primary.dockerfile
-      args:
-        - POSTGRES_LOGGING_COLLECTOR=${POSTGRES_LOGGING_COLLECTOR:-}
-        - POSTGRES_LOG_DESTINATION=${POSTGRES_LOG_DESTINATION:-}
-        - POSTGRES_LOG_STATEMENT=${POSTGRES_LOG_STATEMENT:-}
-        - REPLICA_USER=replicator
-        - REPLICA_PASSWORD=replicator
-    environment:
-      POSTGRES_DB: postgres
-      POSTGRES_USER: postgres_primary_test
-      POSTGRES_PASSWORD: postgres_primary_test
-      POSTGRES_HOST_AUTH_METHOD: "scram-sha-256\nhost replication all 0.0.0.0/0 md5"
-      POSTGRES_INITDB_ARGS: "--auth-host=scram-sha-256"
-
-  postgres_replica:
-    <<: *postgres-common
-    build:
-      context: .
-      dockerfile: postgres_replica.dockerfile
-    container_name: postgres_replica
-    environment:
-      PGUSER: replicator
-      PGPASSWORD: replicator
-      PRIMARY_DATABASE_HOST: postgres_primary
-    depends_on:
-      - postgres_primary
-networks:
-  app:
-  postgres:
-
-volumes:
-  postgres_primary:

data/postgres_primary.dockerfile

@@ -1,34 +0,0 @@
-FROM docker.io/postgres:14-alpine
-
-ARG REPLICA_USER=replicator
-ARG REPLICA_PASSWORD=replicator
-ARG REPLICATION_SLOT_NAME=replication_slot
-ARG INIT_SQL=00_init.sql
-ARG POSTGRES_LOGGING_COLLECTOR=
-ARG POSTGRES_LOG_DESTINATION=
-ARG POSTGRES_LOG_STATEMENT=
-ENV CONF_SAMPLE="/usr/local/share/postgresql/postgresql.conf.sample"
-
-WORKDIR /docker-entrypoint-initdb.d
-
-USER root
-
-RUN touch $INIT_SQL
-RUN chown -R postgres:postgres $INIT_SQL
-RUN echo "CREATE USER ${REPLICA_USER} WITH REPLICATION ENCRYPTED PASSWORD '${REPLICA_PASSWORD}';" > $INIT_SQL
-RUN echo "SELECT pg_create_physical_replication_slot('${REPLICATION_SLOT_NAME}');" >> $INIT_SQL
-
-# Enable logging collector if given
-RUN if [[ ! -z "${POSTGRES_LOGGING_COLLECTOR}" ]]; then sed -i "s/#\(logging_collector = \)off\(.*\)/\1${POSTGRES_LOGGING_COLLECTOR}\2/" ${CONF_SAMPLE}; fi
-
-# Override  default log destination if given
-RUN if [[ ! -z "${POSTGRES_LOG_DESTINATION}" ]]; then sed -i "s/#\(log_destination = \)'stderr'\(.*\)/\1'${POSTGRES_LOG_DESTINATION}'\2/" ${CONF_SAMPLE}; fi
-
-# Override log statement if given
-RUN if [[ ! -z "${POSTGRES_LOG_STATEMENT}" ]]; then sed -i "s/#\(log_statement = \)'none'\(.*\)/\1'${POSTGRES_LOG_STATEMENT}'\2/" ${CONF_SAMPLE}; fi
-
-WORKDIR /
-
-USER postgres
-
-CMD  ["postgres", "-c", "wal_level=replica", "-c", "hot_standby=on", "-c", "max_wal_senders=10", "-c", "max_replication_slots=10", "-c", "hot_standby_feedback=on" ]

data/postgres_replica.dockerfile

@@ -1,15 +0,0 @@
-FROM docker.io/postgres:14-alpine
-
-ENV PRIMARY_DATABASE_HOST=localhost
-ENV PRIMARY_DATABASE_PORT=5432
-ENV PRIMARY_REPLICATION_SLOT=replication_slot
-
-
-COPY docker/postgres_replica/cmd.sh cmd.sh
-
-USER root
-RUN chown -R postgres:postgres cmd.sh
-USER postgres
-RUN chmod u+x cmd.sh
-
-CMD [ "./cmd.sh" ]

data/sig/active_record_proxy_adapters.rbs

@@ -1,4 +0,0 @@
-module ActiveRecordProxyAdapters
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end