active_record_proxy_adapters 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70b1c4f2efd94125b178e043fa1162ab6d8d8edb7a9041eb10b8244c606b3c59
-  data.tar.gz: fb74c76ed0dc0865c9756c3188a92dd248ce58ef4832811704c15a59b728991e
+  metadata.gz: 5312effcf68a3305eb5e7804440112433f5b6837d6b71e7d122145eac4741619
+  data.tar.gz: 50586657daa02e76dfffebbe1faf8df5093198471faf847cec97cd16634c0c17
 SHA512:
-  metadata.gz: 3730cca00342dd7f44944305bfdd53f158da2bc8d09b39883645a2b1a581297904dce121c10de5bc351e30b999b1bcd59457bd3309280074fb36d716a22bdcae
-  data.tar.gz: 07d42f0c57bdd203a260a7d55010159318db260f95ed5483049e8a6ac771908df7696d05692a3043f0a54d77f4e2623c6aa08b7ddda2db5a79e634224db78b12
+  metadata.gz: 707b80a3618328639126d13f3f76bb8123105019b3e30c75f15c66a66a88d49aa5de4301fe70b25ff5356ef37e54ebff896f4cab0160cadbb79d08ae9cf0dc4e
+  data.tar.gz: 6b84984e33cf87abe9a12f5553bccffc32e2a9563a0c859c488cdae4be4c3a019ffce01242648620c67bb85a16dc61d982f0be8ecba83943f01c718e067743dc

data/CHANGELOG.md

@@ -1,20 +1,26 @@
 ## [Unreleased]
 
-- Fix replica connection pool getter when database configurations have multiple replicas
-- Retrieve replica pool without checking out a connection
+## [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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Cruz
@@ -67,7 +67,6 @@ files:
 - Dockerfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - db/postgresql_structure.sql
 - docker-compose.yml
 - docker/postgres_replica/cmd.sh
@@ -78,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,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