active_record_proxy_adapters 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77eed2693b334a1796b09c3484d8b8565a1f19b4ade6fb0f389cd0590bd69bac
-  data.tar.gz: 476c02aa9212953b5c877c2ccaf756731f400bf5bfe80b62f048cab8bab88d8f
+  metadata.gz: 1f614128aa280355a9bc8c83e29805fc36c81f8389c017489c848e075a5510c3
+  data.tar.gz: d28585b2d7d1f7645dfc89007890a2c35ee19c4acc6de1b850e4f3b792cc0c07
 SHA512:
-  metadata.gz: 7d501fae8d20e0fd50c9cca5151baa291573c7bb0feeb79c249feb0dd8810a0b0994c3b68133e39be4cecc5b9f92f375187b98f9c90f00bc42c38edafa19204b
-  data.tar.gz: a145dc2b7767f033aeb7eda886d2fbae8adbcb46a0c3a44872cf8a5d1b1a03a3d4a562431189192af5fc6f7da9a5233118d0f7ae03f11b53316ff3af83858182
+  metadata.gz: b3e36b3fe27bce5b1bdb9035fc399362f99d25062d97abc9024c02a30a8c6a328a2de3bdacda5682622c812f38f8b4a1da48d76e687131d3a6e07e44be4c6995
+  data.tar.gz: 053d2cfdea1db5699cd18404e8b22524a826012534eb0e077b307102021adeccde565f9e7b6417dbbe053669464a7220ab3e1e2cb3b92201cc0b296e8f23f5ce

data/.rspec

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

data/.rubocop.yml

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

@@ -0,0 +1,41 @@
+## [Unreleased]
+
+- Add Mysql2ProxyAdapter
+
+## [0.2.2, 0.1.5] - 2025-01-02
+
+- Handle PendingMigrationConnection introduced by Rails 7.2 and backported to Rails 7.1 https://github.com/Nasdaq/active_record_proxy_adapters/commit/793562694c05d554bad6e14637b34e5f9ffd2fc5
+- Stick to same connection throughout request span https://github.com/Nasdaq/active_record_proxy_adapters/commit/789742fd7a33ecd555a995e8a1e1336455caec75
+
+## [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
+
+## [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
+
+## [0.1.2] - 2024-12-16
+
+- Fix CTE regex matcher https://github.com/Nasdaq/active_record_proxy_adapters/commit/4b1d10bfd952fb1f5b102de8cc1a5bd05d25f5e9
+
+## [0.1.1] - 2024-11-27
+
+- Enable RubyGems MFA https://github.com/Nasdaq/active_record_proxy_adapters/commit/2a71b1f4354fb966cc0aa68231ca5837814e07ee
+
+## [0.1.0] - 2024-11-19
+
+- Add PostgreSQLProxyAdapter https://github.com/Nasdaq/active_record_proxy_adapters/commit/2b3bb9f7359139519b32af3018ceb07fed8c6b33
+
+## [0.1.0.rc2] - 2024-10-28
+
+- Add PostgreSQLProxyAdapter https://github.com/Nasdaq/active_record_proxy_adapters/commit/2b3bb9f7359139519b32af3018ceb07fed8c6b33

data/CODE_OF_CONDUCT.md

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

@@ -0,0 +1,20 @@
+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 \
+    postgresql17-client \
+    mariadb-client \
+    mariadb-dev
+RUN gem install bundler -v 2.5.13
+
+COPY . /app
+WORKDIR /app
+
+RUN bundle install
+

data/README.md

@@ -33,8 +33,19 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### On Rails
 
-In `config/database.yml`, use `postgresql_proxy` as the adapter for the `primary` database, and keep `postgresql` for the replica database.
+In `config/database.yml`, use `{your_database_adapter}_proxy` as the adapter for the `primary` database, and keep `{your_database_adapter}` for the replica database.
 
+Currently supported adapters:
+
+- `postgresql`
+- `mysql2`
+
+Coming soon:
+- `trilogy`
+- `sqlite`
+
+
+#### PostgreSQL
 ```yaml
 # config/database.yml
 development:
@@ -48,6 +59,20 @@ development:
     # your replica credentials here
 ```
 
+#### MySQL
+```yaml
+# config/database.yml
+development:
+  primary:
+    adapter: mysql2_proxy
+    # your primary credentials here
+
+  primary_replica:
+    adapter: mysql2
+    replica: true
+    # your replica credentials here
+```
+
 ```ruby
 # app/models/application_record.rb
 class ApplicationRecord < ActiveRecord::Base
@@ -90,7 +115,7 @@ end
 
 ## Configuration
 
-The gem comes preconfigured out of the box. However, if default configuration does not suit your needs, you can modify them by using a `.configure` block:
+The gem comes preconfigured out of the box. However, if default configuration does not suit your needs, you can modify it by using a `.configure` block:
 
 ```ruby
 # config/initializers/active_record_proxy_adapters.rb
@@ -239,6 +264,7 @@ end
 
 # app/models/portal.rb
 class Portal < ApplicationRecord
+  validates :name, uniqueness: true
 end
 
 # in rails console -e test
@@ -246,13 +272,17 @@ ActiveRecord::Base.logger.formatter = proc do |_severity, _time, _progname, msg|
   "[#{Time.current.iso8601} THREAD #{Thread.current[:name]}] #{msg}\n"
 end
 
+ActiveRecordProxyAdapters.configure do |config|
+  config.proxy_delay = 2.seconds
+end
+
 def read_your_own_writes
   proc do
     Portal.all.count # should go to the replica
-    FactoryBot.create(:portal)
+    Portal.create(name: 'Read your own write')
 
     5.times do
-      Portal.all.count # first one goes the primary, last 3 should go to the replica
+      Portal.all.count # first one goes the primary, last 4 should go to the replica
       sleep(3)
     end
   end
@@ -297,9 +327,8 @@ irb(main):051:0> test_multithread_queries
 [2024-12-24T13:52:40-05:00 THREAD USE REPLICA]   [PostgreSQL Replica] Portal Count (1.4ms)  SELECT COUNT(*) FROM "portals"
 [2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQL Replica] Portal Count (0.4ms)  SELECT COUNT(*) FROM "portals"
 [2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] TRANSACTION (0.5ms)  BEGIN
-[2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] Portal Exists? (1.2ms)  SELECT 1 AS one FROM "portals" WHERE "portals"."id" IS NOT NULL AND "portals"."slug" = $1 LIMIT $2  [["slug", "portal-e065948fbbee73d3b2c576b48c2b37e021115158edc6a92390d613640460e1d4"], ["LIMIT", 1]]
-[2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] Portal Exists? (0.4ms)  SELECT 1 AS one FROM "portals" WHERE "portals"."name" = $1 LIMIT $2  [["name", "Portal-e065948fbbee73d3b2c576b48c2b37e021115158edc6a92390d613640460e1d4"], ["LIMIT", 1]]
-[2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] Portal Create (0.8ms)  INSERT INTO "portals" ("name", "slug", "logo", "created_at", "updated_at", "visible") VALUES ($1, $2, $3, $4, $5, $6) RETURNING "id"  [["name", "Portal-e065948fbbee73d3b2c576b48c2b37e021115158edc6a92390d613640460e1d4"], ["slug", "portal-e065948fbbee73d3b2c576b48c2b37e021115158edc6a92390d613640460e1d4"], ["logo", nil], ["created_at", "2024-12-24 18:52:40.428383"], ["updated_at", "2024-12-24 18:52:40.428383"], ["visible", true]]
+[2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] Portal Exists? (0.4ms)  SELECT 1 AS one FROM "portals" WHERE "portals"."name" = $1 LIMIT $2  [["name", "Read your own write"], ["LIMIT", 1]]
+[2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] Portal Create (0.8ms)  INSERT INTO "portals" ("name", "created_at", "updated_at") VALUES ($1, $2, $3) RETURNING "id"  [["name", "Read your own write"], ["created_at", "2024-12-24 18:52:40.428383"], ["updated_at", "2024-12-24 18:52:40.428383"]]
 [2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] TRANSACTION (0.7ms)  COMMIT
 [2024-12-24T13:52:40-05:00 THREAD READ YOUR OWN WRITES]   [PostgreSQLProxy Primary] Portal Count (0.6ms)  SELECT COUNT(*) FROM "portals"
 [2024-12-24T13:52:41-05:00 THREAD USE REPLICA]   [PostgreSQL Replica] Portal Count (4.4ms)  SELECT COUNT(*) FROM "portals"

data/db/mysql_structure.sql

@@ -0,0 +1,41 @@
+/*M!999999\- enable the sandbox mode */ 
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!40101 SET NAMES utf8mb4 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*M!100616 SET @OLD_NOTE_VERBOSITY=@@NOTE_VERBOSITY, NOTE_VERBOSITY=0 */;
+DROP TABLE IF EXISTS `schema_migrations`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!40101 SET character_set_client = utf8 */;
+CREATE TABLE `schema_migrations` (
+  `version` varchar(255) NOT NULL
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_uca1400_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+DROP TABLE IF EXISTS `users`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!40101 SET character_set_client = utf8 */;
+CREATE TABLE `users` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+  `name` text NOT NULL,
+  `email` text NOT NULL,
+  `created_at` timestamp NULL DEFAULT current_timestamp(),
+  `updated_at` timestamp NULL DEFAULT current_timestamp(),
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_uca1400_ai_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*M!100616 SET NOTE_VERBOSITY=@OLD_NOTE_VERBOSITY */;
+

data/db/postgresql_structure.sql

@@ -0,0 +1,86 @@
+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);
+SET check_function_bodies = false;
+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: -
+--
+
+CREATE TABLE public.schema_migrations (
+    version character varying(255) NOT NULL
+);
+
+
+--
+-- 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);
+
+
+--
+-- 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
+--
+
+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

@@ -0,0 +1,98 @@
+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
+      MYSQL_PRIMARY_USER: root
+      MYSQL_PRIMARY_PASSWORD: mysql
+      MYSQL_PRIMARY_HOST: mysql_primary
+      MYSQL_PRIMARY_PORT: 3306
+      MYSQL_REPLICA_USER: root
+      MYSQL_REPLICA_PASSWORD: mysql
+      MYSQL_REPLICA_HOST: mysql_primary
+      MYSQL_REPLICA_PORT: 3306
+    depends_on:
+      - postgres_primary
+      - postgres_replica
+      - mariadb
+    networks:
+      - app
+      - postgres
+      - mariadb
+    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
+    container_name: postgres_primary
+    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
+  # TODO: create mysql replica images
+  mariadb:
+    image: mariadb:11.4
+    container_name: mysql_primary
+    environment:
+      MARIADB_ROOT_PASSWORD: mysql
+      MARIADB_DATABASE: mysql
+    ports:
+      - "3306:3306"
+    networks:
+      - mariadb
+
+networks:
+  app:
+  postgres:
+  mariadb:

data/lib/active_record/connection_adapters/mysql2_proxy_adapter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_record/tasks/mysql2_proxy_database_tasks"
+require "active_record/connection_adapters/mysql2_adapter"
+require "active_record_proxy_adapters/active_record_context"
+require "active_record_proxy_adapters/hijackable"
+require "active_record_proxy_adapters/mysql2_proxy"
+
+module ActiveRecord
+  module ConnectionAdapters
+    # This adapter is a proxy to the original Mysql2Adapter, allowing the use of the
+    # ActiveRecordProxyAdapters::PrimaryReplicaProxy.
+    class Mysql2ProxyAdapter < Mysql2Adapter
+      include ActiveRecordProxyAdapters::Hijackable
+
+      ADAPTER_NAME = "Mysql2Proxy"
+
+      delegate_to_proxy :execute, :exec_query
+
+      def initialize(...)
+        @proxy = ActiveRecordProxyAdapters::Mysql2Proxy.new(self)
+
+        super
+      end
+
+      private
+
+      attr_reader :proxy
+    end
+  end
+end
+
+if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2_or_greater?
+  ActiveRecord::ConnectionAdapters.register(
+    "mysql2_proxy",
+    "ActiveRecord::ConnectionAdapters::Mysql2ProxyAdapter",
+    "active_record/connection_adapters/mysql2_proxy_adapter"
+  )
+end

data/lib/active_record/connection_adapters/postgresql_proxy_adapter.rb

@@ -15,7 +15,7 @@ module ActiveRecord
 
       ADAPTER_NAME = "PostgreSQLProxy"
 
-      delegate_to_proxy(*ActiveRecordProxyAdapters::ActiveRecordContext.hijackable_methods)
+      delegate_to_proxy :execute, :exec_query
 
       unless ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v8_0_or_greater?
         delegate_to_proxy :exec_no_cache, :exec_cache

data/lib/active_record/tasks/mysql2_proxy_database_tasks.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_record_proxy_adapters/database_tasks"
+
+module ActiveRecord
+  module Tasks
+    # Defines the mysql tasks for dropping, creating, loading schema and dumping schema.
+    # Bypasses all the proxy logic to send all requests to primary.
+    class Mysql2ProxyDatabaseTasks < MySQLDatabaseTasks
+      include ActiveRecordProxyAdapters::DatabaseTasks
+    end
+  end
+end
+
+# Allow proxy adapter to run rake tasks, i.e. db:drop, db:create, db:schema:load db:migrate, etc...
+ActiveRecord::Tasks::DatabaseTasks.register_task(
+  /mysql2_proxy/,
+  "ActiveRecord::Tasks::Mysql2ProxyDatabaseTasks"
+)

data/lib/active_record/tasks/postgresql_proxy_database_tasks.rb

@@ -1,39 +1,13 @@
 # frozen_string_literal: true
 
+require "active_record_proxy_adapters/database_tasks"
+
 module ActiveRecord
   module Tasks
     # Defines the postgresql tasks for dropping, creating, loading schema and dumping schema.
     # Bypasses all the proxy logic to send all requests to primary.
     class PostgreSQLProxyDatabaseTasks < PostgreSQLDatabaseTasks
-      def create(...)
-        sticking_to_primary { super }
-      end
-
-      def drop(...)
-        sticking_to_primary { super }
-      end
-
-      def structure_dump(...)
-        sticking_to_primary { super }
-      end
-
-      def structure_load(...)
-        sticking_to_primary { super }
-      end
-
-      def purge(...)
-        sticking_to_primary { super }
-      end
-
-      private
-
-      def sticking_to_primary(&)
-        ActiveRecord::Base.connected_to(role: context.writing_role, &)
-      end
-
-      def context
-        ActiveRecordProxyAdapters::ActiveRecordContext.new
-      end
+      include ActiveRecordProxyAdapters::DatabaseTasks
     end
   end
 end

data/lib/active_record_proxy_adapters/active_record_context.rb

@@ -23,8 +23,6 @@ module ActiveRecordProxyAdapters
     end
 
     def connection_class_for(connection)
-      return connection.connection_descriptor.name.constantize if active_record_v8_0_2_or_greater?
-
       connection.connection_class || ActiveRecord::Base
     end
 
@@ -35,18 +33,6 @@ module ActiveRecordProxyAdapters
       ActiveRecord
     end
 
-    def hijackable_methods
-      hijackable = %i[execute exec_query]
-
-      hijackable << :internal_exec_query if active_record_v8_0_or_greater?
-
-      hijackable
-    end
-
-    def active_record_v7?
-      active_record_version >= Gem::Version.new("7.0") && active_record_version < Gem::Version.new("8.0")
-    end
-
     def active_record_v7_1_or_greater?
       active_record_version >= Gem::Version.new("7.1")
     end
@@ -58,9 +44,5 @@ module ActiveRecordProxyAdapters
     def active_record_v8_0_or_greater?
       active_record_version >= Gem::Version.new("8.0")
     end
-
-    def active_record_v8_0_2_or_greater?
-      active_record_version >= Gem::Version.new("8.0.2")
-    end
   end
 end

data/lib/active_record_proxy_adapters/connection_handling.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_record/connection_adapters/postgresql_proxy_adapter"
+require "active_record/connection_adapters/mysql2_proxy_adapter"
 
 module ActiveRecordProxyAdapters
   # Module to extend ActiveRecord::Base with the connection handling methods.
@@ -31,5 +32,30 @@ module ActiveRecordProxyAdapters
         config
       )
     end
+
+    def mysql2_proxy_adapter_class
+      ::ActiveRecord::ConnectionAdapters::Mysql2ProxyAdapter
+    end
+
+    # This method is a copy and paste from Rails' mysql2_connection,
+    # replacing Mysql2Adapter by Mysql2ProxyAdapter
+    # This is required by ActiveRecord versions <= 7.2.x to establish a connection using the adapter.
+    def mysql2_proxy_connection(config) # rubocop:disable Metrics/MethodLength
+      config = config.symbolize_keys
+      config[:flags] ||= 0
+
+      if config[:flags].is_a? Array
+        config[:flags].push "FOUND_ROWS"
+      else
+        config[:flags] |= Mysql2::Client::FOUND_ROWS
+      end
+
+      mysql2_proxy_adapter_class.new(
+        mysql2_proxy_adapter_class.new_client(config),
+        logger,
+        nil,
+        config
+      )
+    end
   end
 end

data/lib/active_record_proxy_adapters/database_tasks.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActiveRecordProxyAdapters
+  module DatabaseTasks # rubocop:disable Style/Documentation
+    extend ActiveSupport::Concern
+
+    included do
+      def create(...)
+        sticking_to_primary { super }
+      end
+
+      def drop(...)
+        sticking_to_primary { super }
+      end
+
+      def structure_dump(...)
+        sticking_to_primary { super }
+      end
+
+      def structure_load(...)
+        sticking_to_primary { super }
+      end
+
+      def purge(...)
+        sticking_to_primary { super }
+      end
+
+      private
+
+      def sticking_to_primary(&)
+        ActiveRecord::Base.connected_to(role: context.writing_role, &)
+      end
+
+      def context
+        ActiveRecordProxyAdapters::ActiveRecordContext.new
+      end
+    end
+  end
+end

data/lib/active_record_proxy_adapters/hijackable.rb

@@ -2,14 +2,13 @@
 
 require "active_record/tasks/postgresql_proxy_database_tasks"
 require "active_record/connection_adapters/postgresql_adapter"
-require "active_record_proxy_adapters/primary_replica_proxy"
 
 module ActiveRecordProxyAdapters
   # Defines mixins to delegate specific methods from the proxy to the adapter.
   module Hijackable
     extend ActiveSupport::Concern
 
-    class_methods do
+    class_methods do # rubocop:disable Metrics/BlockLength
       # Renames the methods from the original Adapter using the proxy suffix (_unproxied)
       # and delegate the original method name to the proxy.
       # Example: delegate_to_proxy(:execute) creates a method `execute_unproxied`,
@@ -32,10 +31,40 @@ module ActiveRecordProxyAdapters
         delegate(*method_names, to: :proxy)
       end
 
+      # Defines which methods should be hijacked from the original adapter and use the proxy
+      # @param method_names [Array<Symbol>] the list of method names from the adapter
+      def hijack_method(*method_names) # rubocop:disable Metrics/MethodLength
+        @hijacked_methods ||= Set.new
+        @hijacked_methods += Set.new(method_names)
+
+        method_names.each do |method_name|
+          define_method(method_name) do |*args, **kwargs, &block|
+            proxy_bypass_method = "#{method_name}#{unproxied_method_suffix}"
+            sql_string          = coerce_query_to_string(args.first)
+
+            appropriate_connection(sql_string) do |conn|
+              method_to_call = conn == primary_connection ? proxy_bypass_method : method_name
+
+              conn.send(method_to_call, *args, **kwargs, &block)
+            end
+          end
+        end
+      end
+
+      def unproxied_method_suffix
+        "_unproxied"
+      end
+
       private
 
       def proxy_method_name_for(method_name)
-        :"#{method_name}#{ActiveRecordProxyAdapters::PrimaryReplicaProxy::UNPROXIED_METHOD_SUFFIX}"
+        :"#{method_name}#{unproxied_method_suffix}"
+      end
+    end
+
+    included do
+      def unproxied_method_suffix
+        self.class.unproxied_method_suffix
       end
     end
   end

data/lib/active_record_proxy_adapters/mysql2_proxy.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_record_proxy_adapters/primary_replica_proxy"
+
+module ActiveRecordProxyAdapters
+  # Proxy to the original Mysql2Adapter, allowing the use of the ActiveRecordProxyAdapters::PrimaryReplicaProxy.
+  class Mysql2Proxy < PrimaryReplicaProxy
+  end
+end

data/lib/active_record_proxy_adapters/postgresql_proxy.rb

@@ -7,8 +7,6 @@ module ActiveRecordProxyAdapters
   # Proxy to the original PostgreSQLAdapter, allowing the use of the ActiveRecordProxyAdapters::PrimaryReplicaProxy.
   class PostgreSQLProxy < PrimaryReplicaProxy
     # ActiveRecord::PostgreSQLAdapter methods that should be proxied.
-    hijack_method(*ActiveRecordContext.hijackable_methods)
-
     hijack_method :exec_no_cache, :exec_cache unless ActiveRecordContext.active_record_v8_0_or_greater?
   end
 end

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -5,59 +5,32 @@ require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/object/blank"
 require "concurrent-ruby"
 require "active_record_proxy_adapters/active_record_context"
+require "active_record_proxy_adapters/hijackable"
 
 module ActiveRecordProxyAdapters
   # This is the base class for all proxies. It defines the methods that should be proxied
   # and the logic to determine which database to use.
   class PrimaryReplicaProxy # rubocop:disable Metrics/ClassLength
+    include Hijackable
+
     # All queries that match these patterns should be sent to the primary database
     SQL_PRIMARY_MATCHERS = [
       /\A\s*select.+for update\Z/i, /select.+lock in share mode\Z/i,
       /\A\s*select.+(nextval|currval|lastval|get_lock|release_lock|pg_advisory_lock|pg_advisory_unlock)\(/i
     ].map(&:freeze).freeze
-
-    CTE_MATCHER = /\A\s*WITH\s+(?<CTE>\S+\s+AS\s+\(\s?[\s\S]*\))/i
     # All queries that match these patterns should be sent to the replica database
-    SQL_REPLICA_MATCHERS = [
-      /\A\s*(select)\s/i,
-      /#{CTE_MATCHER.source}\s*select/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
     SQL_SKIP_ALL_MATCHERS    = [/\A\s*set\s+local\s/i].map(&:freeze).freeze
     # These patterns define which database statments are considered write statments, so we can shortly re-route all
     # requests to the primary database so the replica has time to replicate
-    WRITE_STATEMENT_MATCHERS = [
-      /\ABEGIN/i,
-      /\ACOMMIT/i,
-      /INSERT\s[\s\S]*INTO\s[\s\S]*/i,
-      /UPDATE\s[\s\S]*/i,
-      /DELETE\s[\s\S]*FROM\s[\s\S]*/i,
-      /DROP\s/i
-    ].map(&:freeze).freeze
-
-    UNPROXIED_METHOD_SUFFIX = "_unproxied"
+    WRITE_STATEMENT_MATCHERS = [/\ABEGIN/i, /\ACOMMIT/i, /INSERT\sINTO\s/i, /UPDATE\s/i, /DELETE\sFROM\s/i,
+                                /DROP\s/i].map(&:freeze).freeze
 
-    # Defines which methods should be hijacked from the original adapter and use the proxy
-    # @param method_names [Array<Symbol>] the list of method names from the adapter
-    def self.hijack_method(*method_names) # rubocop:disable Metrics/MethodLength
-      @hijacked_methods ||= Set.new
-      @hijacked_methods += Set.new(method_names)
-
-      method_names.each do |method_name|
-        define_method(method_name) do |*args, **kwargs, &block|
-          proxy_bypass_method = "#{method_name}#{UNPROXIED_METHOD_SUFFIX}"
-          sql_string          = coerce_query_to_string(args.first)
-
-          appropriate_connection(sql_string) do |conn|
-            method_to_call = conn == primary_connection ? proxy_bypass_method : method_name
-
-            conn.send(method_to_call, *args, **kwargs, &block)
-          end
-        end
-      end
-    end
+    # Abstract adapter methods that should be proxied.
+    hijack_method :execute, :exec_query
 
     def self.hijacked_methods
       @hijacked_methods.to_a
@@ -77,22 +50,6 @@ module ActiveRecordProxyAdapters
     delegate :connection_handler, to: :connection_class
     delegate :reading_role, :writing_role, to: :active_record_context
 
-    # We need to call .verify! to ensure `configure_connection` is called on the instance before attempting to use it.
-    # This is necessary because the connection may have been lazily initialized and is an unintended side effect from a
-    # change in Rails to defer connection verification: https://github.com/rails/rails/pull/44576
-    # verify! cannot be called before the object is initialized and because of how the proxy hooks into the connection
-    # instance, it has to be done lazily (hence the memoization). Ideally, we shouldn't have to worry about this at all
-    # But there is tight coupling between methods in ActiveRecord::ConnectionAdapters::AbstractAdapter and
-    # its descendants which will require significant refactoring to be decoupled.
-    # See https://github.com/rails/rails/issues/51780
-    def verified_primary_connection
-      @verified_primary_connection ||= begin
-        connected_to(role: writing_role) { primary_connection.verify! }
-
-        primary_connection
-      end
-    end
-
     def replica_pool_unavailable?
       !replica_pool
     end
@@ -163,8 +120,7 @@ module ActiveRecordProxyAdapters
     end
 
     def connection_for(role, sql_string)
-      connection = verified_primary_connection if role == writing_role || replica_pool_unavailable?
-
+      connection = primary_connection if role == writing_role || replica_pool_unavailable?
       connection ||= checkout_replica_connection
 
       result = connected_to(role:) { yield connection }
@@ -198,21 +154,16 @@ module ActiveRecordProxyAdapters
     # @return [TrueClass] if there has been a write within the last {#proxy_delay} seconds
     # @return [TrueClass] if sql_string matches a write statement (i.e. INSERT, UPDATE, DELETE, SELECT FOR UPDATE)
     # @return [FalseClass] if sql_string matches a read statement (i.e. SELECT)
-    def need_primary?(sql_string) # rubocop:disable Metrics/CyclomaticComplexity
-      return true  if recent_write_to_primary?
+    def need_primary?(sql_string)
+      return true if recent_write_to_primary?
+
       return true  if in_transaction?
-      return true  if cte_for_write?(sql_string)
       return true  if SQL_PRIMARY_MATCHERS.any?(&match_sql?(sql_string))
       return false if SQL_REPLICA_MATCHERS.any?(&match_sql?(sql_string))
 
       true
     end
 
-    def cte_for_write?(sql_string)
-      CTE_MATCHER.match?(sql_string) &&
-        WRITE_STATEMENT_MATCHERS.any?(&match_sql?(sql_string))
-    end
-
     def need_all?(sql_string)
       return false if SQL_SKIP_ALL_MATCHERS.any?(&match_sql?(sql_string))
 

data/lib/active_record_proxy_adapters/version.rb

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

data/postgres_primary.dockerfile

@@ -0,0 +1,34 @@
+FROM docker.io/postgres:17-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

@@ -0,0 +1,15 @@
+FROM docker.io/postgres:17-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

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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Cruz
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -57,24 +58,38 @@ email:
 - matt.cruz@nasdaq.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE.txt
+extra_rdoc_files: []
 files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
 - LICENSE.txt
 - README.md
+- db/mysql_structure.sql
+- db/postgresql_structure.sql
+- docker-compose.yml
+- docker/postgres_replica/cmd.sh
+- lib/active_record/connection_adapters/mysql2_proxy_adapter.rb
 - lib/active_record/connection_adapters/postgresql_proxy_adapter.rb
+- lib/active_record/tasks/mysql2_proxy_database_tasks.rb
 - lib/active_record/tasks/postgresql_proxy_database_tasks.rb
 - lib/active_record_proxy_adapters.rb
 - lib/active_record_proxy_adapters/active_record_context.rb
 - lib/active_record_proxy_adapters/configuration.rb
 - lib/active_record_proxy_adapters/connection_handling.rb
+- lib/active_record_proxy_adapters/database_tasks.rb
 - lib/active_record_proxy_adapters/hijackable.rb
 - lib/active_record_proxy_adapters/log_subscriber.rb
+- lib/active_record_proxy_adapters/mysql2_proxy.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
 - 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
@@ -84,6 +99,7 @@ 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
@@ -98,7 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Read replica proxy adapters for ActiveRecord!
 test_files: []