active_record_proxy_adapters 0.6.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea3aa59337aa2ed793bfb2e51666d08ef6b40ad9ccd2008453807baeac862933
-  data.tar.gz: 1e899907a68ecf3c6ca5a51380e2b7be9859d40c0b033f23b872037c6d1fd5a8
+  metadata.gz: b4a4d2396f46900885e67814c350db6d85c447838294152b62a747bdbc3908d5
+  data.tar.gz: 85efcfa7b1f10b8a8b10311d6a0cbeb91972856814124dcf347eb75aabfdac0f
 SHA512:
-  metadata.gz: 3b9018059039d65f435a8d4571f5eea8a477e4388728a675b2176252959e5fb6afd0833cb21e65ea5bbd04e77c484f1d2ec3974d698b057c72440f7a9349150a
-  data.tar.gz: 7bf7662851cc2d6b1bcd7fcb59df5216fb87f28c368910da05476b6b734f692f2182de15bb731276f5952690b9ded4840ed2ddd2e35653fb2ff17c9c6e0a7bc4
+  metadata.gz: 372f71443a70435637770a3eb81e947e23fad2bf353f2ffd42a4af6d6feaea8ebed21e5ab0d8c03948c452e8f4e51695e9f01fb852b9e561cf129df6989f08a2
+  data.tar.gz: 5e1851d10b5b2042f18a4f48f01fc0c8597511e4bd5228535b163e4edcb9100e474e259214e5259e6c8bd4c00a06e8f8a9c7e394b42141680910adf741b8c28f

data/README.md

@@ -6,7 +6,7 @@ A set of ActiveRecord adapters that leverage Rails native multiple database setu
 
 ## Why do I need this?
 
-Maybe you don't. Rails already provides, since version 6.0, a [Rack middleware](https://guides.rubyonrails.org/active_record_multiple_databases.html#activating-automatic-role-switching) that switches between primary and replica automatically based on the HTTP request (`GET` and `HEAD` requests go the primary, everything else goes to the replica).
+Maybe you don't. Rails already provides, since version 6.0, a [Rack middleware](https://guides.rubyonrails.org/active_record_multiple_databases.html#activating-automatic-role-switching) that switches between primary and replica automatically based on the HTTP request (`GET` and `HEAD` requests go the replica, everything else goes to the primary).
 
 The caveat is: you are not allowed do any writes in any `GET` or `HEAD` requests (including controller callbacks).
 Which means, for example, your `devise` callbacks that save user metadata will now crash.
@@ -150,6 +150,25 @@ ActiveRecordProxyAdapters.configure do |config|
 end
 ```
 
+### Configuring multiple connections
+General settings are automatically applied to the `primary` database by default.
+
+If your application has multiple databases that need separate proxy settings, you can use the `database` block for individual database settings.
+
+```ruby
+ActiveRecordProxyAdapters.configure do |config|
+  config.database :primary do |primary_config|
+    primary_config.proxy_delay = 2.seconds
+  end
+
+  config.database :secondary do |secondary_config|
+     secondary_config.proxy_delay = 5.seconds
+  end
+end
+```
+
+With those settings, any model that `connects_to database: { writing: :primary }` will have a 2-second delay, and any model that `connects_to database: { writing: :secondary }` will have a 5-second delay.
+
 ## Logging
 
 ```ruby
@@ -157,8 +176,8 @@ end
 require "active_record_proxy_adapters/log_subscriber"
 
 ActiveRecordProxyAdapters.configure do |config|
-  config.log_subscriber_primary_prefix = "My primary tag" # defaults to "#{adapter_name} Primary", i.e "PostgreSQL Primary"
-  config.log_subscriber_replica_prefix = "My replica tag" # defaults to "#{adapter_name} Replica", i.e "PostgreSQL Replica"
+  config.log_subscriber_primary_prefix = "My primary tag" # defaults to ActiveRecord configuration name", i.e "primary"
+  config.log_subscriber_replica_prefix = "My replica tag" # defaults to ActiveRecord configuration name", i.e "primary_replica"
 end
 
 # You may want to remove duplicate logs

data/lib/active_record_proxy_adapters/cache_configuration.rb

@@ -7,12 +7,8 @@ module ActiveRecordProxyAdapters
     include SynchronizableConfiguration
 
     # Sets the cache store to use for caching SQL statements.
-    #
-    # @param store [ActiveSupport::Cache::Store] The cache store to use for caching SQL statements.
-    #   Defaults to ActiveSupport::Cache::NullStore, which does not cache anything.
-    #   Thread safe.
+    #   Defaults to {ActiveSupport::Cache::NullStore}, which does not cache anything.
     # @return [ActiveSupport::Cache::Store] The cache store to use for caching SQL statements.
-    #   Defaults to ActiveSupport::Cache::NullStore, which does not cache anything.
     #   Thread safe.
     attr_reader :store
 
@@ -51,5 +47,9 @@ module ActiveRecordProxyAdapters
     def bust
       store.delete_matched("#{key_prefix}*")
     end
+
+    private
+
+    attr_reader :lock
   end
 end

data/lib/active_record_proxy_adapters/configuration.rb

@@ -1,32 +1,18 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/integer/time"
-require "active_record_proxy_adapters/synchronizable_configuration"
 require "active_record_proxy_adapters/cache_configuration"
 require "active_record_proxy_adapters/context"
+require "active_record_proxy_adapters/database_configuration"
+require "active_record_proxy_adapters/synchronizable_configuration"
+require "active_support/core_ext/integer/time"
 
 module ActiveRecordProxyAdapters
   # Provides a global configuration object to configure how the proxy should behave.
   class Configuration
     include SynchronizableConfiguration
 
-    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. Thread safe.
-    attr_reader :proxy_delay
-    # @return [ActiveSupport::Duration] How long the proxy should wait for a connection from the replica pool.
-    #   Defaults to CHECKOUT_TIMEOUT. Thread safe.
-    attr_reader :checkout_timeout
-
-    # @return [Proc] Prefix for the log subscriber when the primary database is used. Thread safe.
-    attr_reader :log_subscriber_primary_prefix
-
-    # @return [Proc] Prefix for the log subscriber when the replica database is used. Thread safe.
-    attr_reader :log_subscriber_replica_prefix
+    DEFAULT_DATABASE_NAME         = :primary
+    DEFAULT_REPLICA_DATABASE_NAME = :primary_replica
 
     # @return [Class] The context that is used to store the current request's state.
     attr_reader :context_store
@@ -34,46 +20,48 @@ module ActiveRecordProxyAdapters
     def initialize
       @lock = Monitor.new
 
-      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
-      self.cache_configuration           = CacheConfiguration.new(@lock)
-      self.context_store                 = ActiveRecordProxyAdapters::Context
+      self.cache_configuration = CacheConfiguration.new(@lock)
+      self.context_store       = ActiveRecordProxyAdapters::Context
+      @database_configurations = {}
     end
 
     def log_subscriber_primary_prefix=(prefix)
-      prefix_proc = prefix.is_a?(Proc) ? prefix : proc { prefix.to_s }
+      default_database_config.log_subscriber_prefix = prefix
+    end
 
-      synchronize_update(:log_subscriber_primary_prefix, from: @log_subscriber_primary_prefix, to: prefix_proc) do
-        @log_subscriber_primary_prefix = prefix_proc
-      end
+    def log_subscriber_primary_prefix
+      default_database_config.log_subscriber_prefix
     end
 
     def log_subscriber_replica_prefix=(prefix)
-      prefix_proc = prefix.is_a?(Proc) ? prefix : proc { prefix.to_s }
+      default_replica_config.log_subscriber_prefix = prefix
+    end
 
-      synchronize_update(:log_subscriber_replica_prefix, from: @log_subscriber_replica_prefix, to: prefix_proc) do
-        @log_subscriber_replica_prefix = prefix_proc
-      end
+    def log_subscriber_replica_prefix
+      default_replica_config.log_subscriber_prefix
+    end
+
+    def proxy_delay
+      default_database_config.proxy_delay
     end
 
     def proxy_delay=(proxy_delay)
-      synchronize_update(:proxy_delay, from: @proxy_delay, to: proxy_delay) do
-        @proxy_delay = proxy_delay
-      end
+      default_database_config.proxy_delay = proxy_delay
+    end
+
+    def checkout_timeout
+      default_database_config.checkout_timeout
     end
 
     def checkout_timeout=(checkout_timeout)
-      synchronize_update(:checkout_timeout, from: @checkout_timeout, to: checkout_timeout) do
-        @checkout_timeout = checkout_timeout
-      end
+      default_database_config.checkout_timeout = checkout_timeout
     end
 
-    def context_store=(context_store)
-      synchronize_update(:context_store, from: @context_store, to: context_store) do
-        @context_store = context_store
-      end
+    def database(database_name)
+      key = database_name.to_s
+      lock.synchronize { @database_configurations[key] ||= DatabaseConfiguration.new }
+
+      block_given? ? yield(database_configurations[key]) : database_configurations[key]
     end
 
     def cache
@@ -82,13 +70,26 @@ module ActiveRecordProxyAdapters
 
     private
 
-    # @return [CacheConfiguration] The cache configuration for the proxy adapters.
-    attr_reader :cache_configuration
+    attr_reader :cache_configuration, :database_configurations, :lock
+
+    def default_database_config
+      database(DEFAULT_DATABASE_NAME)
+    end
+
+    def default_replica_config
+      database(DEFAULT_REPLICA_DATABASE_NAME)
+    end
 
     def cache_configuration=(cache_configuration)
       synchronize_update(:cache_configuration, from: @cache_configuration, to: cache_configuration) do
         @cache_configuration = cache_configuration
       end
     end
+
+    def context_store=(context_store)
+      synchronize_update(:context_store, from: @context_store, to: context_store) do
+        @context_store = context_store
+      end
+    end
   end
 end

data/lib/active_record_proxy_adapters/context.rb

@@ -16,19 +16,23 @@ module ActiveRecordProxyAdapters
     end
 
     def recent_write_to_primary?(connection_name)
-      now - self[connection_name] < proxy_delay
+      now - self[connection_name.to_s] < proxy_delay(connection_name)
     end
 
     def update_for(connection_name)
-      self[connection_name] = now
+      self[connection_name.to_s] = now
     end
 
     def [](connection_name)
-      timestamp_registry[connection_name] || 0
+      timestamp_registry[connection_name.to_s] || 0
     end
 
     def []=(connection_name, timestamp)
-      timestamp_registry[connection_name] = timestamp
+      timestamp_registry[connection_name.to_s] = timestamp
+    end
+
+    def to_h
+      timestamp_registry.dup
     end
 
     private

data/lib/active_record_proxy_adapters/database_configuration.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/integer/time"
+require "active_record_proxy_adapters/synchronizable_configuration"
+require "active_record_proxy_adapters/cache_configuration"
+require "active_record_proxy_adapters/context"
+
+module ActiveRecordProxyAdapters
+  # Provides a global configuration object to configure how the proxy should behave.
+  class DatabaseConfiguration
+    include SynchronizableConfiguration
+
+    PROXY_DELAY      = 2.seconds.freeze
+    CHECKOUT_TIMEOUT = 2.seconds.freeze
+    DEFAULT_PREFIX   = proc do |event|
+      connection = event.payload[:connection]
+
+      connection.pool.try(:db_config).try(:name) || connection.class::ADAPTER_NAME
+    end
+
+    # @return [ActiveSupport::Duration] How long the proxy should reroute all read requests to the primary database
+    #   since the latest write. Defaults to PROXY_DELAY. Thread safe.
+    attr_reader :proxy_delay
+    # @return [ActiveSupport::Duration] How long the proxy should wait for a connection from the replica pool.
+    #   Defaults to CHECKOUT_TIMEOUT. Thread safe.
+    attr_reader :checkout_timeout
+
+    # @return [Proc] Prefix for the log subscriber when the database is used. Thread safe.
+    attr_reader :log_subscriber_prefix
+
+    def initialize
+      @lock                      = Monitor.new
+      self.proxy_delay           = PROXY_DELAY
+      self.checkout_timeout      = CHECKOUT_TIMEOUT
+      self.log_subscriber_prefix = DEFAULT_PREFIX
+    end
+
+    def proxy_delay=(proxy_delay)
+      synchronize_update(:proxy_delay, from: @proxy_delay, to: proxy_delay) do
+        @proxy_delay = proxy_delay
+      end
+    end
+
+    def checkout_timeout=(checkout_timeout)
+      synchronize_update(:checkout_timeout, from: @checkout_timeout, to: checkout_timeout) do
+        @checkout_timeout = checkout_timeout
+      end
+    end
+
+    def log_subscriber_prefix=(prefix)
+      prefix_proc = prefix.is_a?(Proc) ? prefix : proc { prefix.to_s }
+
+      synchronize_update(:log_subscriber_prefix, from: @log_subscriber_prefix, to: prefix_proc) do
+        @log_subscriber_prefix = prefix_proc
+      end
+    end
+
+    private
+
+    attr_reader :lock
+  end
+end

data/lib/active_record_proxy_adapters/log_subscriber.rb

@@ -2,6 +2,8 @@
 
 module ActiveRecordProxyAdapters
   class LogSubscriber < ActiveRecord::LogSubscriber # rubocop:disable Style/Documentation
+    include Mixin::Configuration
+
     attach_to :active_record
 
     IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
@@ -19,23 +21,23 @@ module ActiveRecordProxyAdapters
     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
+      connection      = event.payload[:connection]
+      db_config       = connection.pool.try(:db_config) || NullConfig.new # AR 7.0.x does not support "NullConfig"
+      connection_name = db_config.name
+
+      prefix = log_subscriber_prefix(connection_name)
 
       "[#{prefix.call(event)}]"
     end
 
-    private
-
-    delegate :log_subscriber_primary_prefix, :log_subscriber_replica_prefix, to: :config
+    class NullConfig # rubocop:disable Style/Documentation
+      def method_missing(...)
+        nil
+      end
 
-    def config
-      ActiveRecordProxyAdapters.config
+      def respond_to_missing?(*)
+        true
+      end
     end
   end
 end

data/lib/active_record_proxy_adapters/middleware.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "rack"
+require "json"
+require "active_record_proxy_adapters/context"
+require "active_record_proxy_adapters/contextualizer"
+require "active_record_proxy_adapters/mixin/configuration"
+
+module ActiveRecordProxyAdapters
+  class Middleware # rubocop:disable Style/Documentation
+    include Contextualizer
+    include Mixin::Configuration
+
+    COOKIE_NAME   = "arpa_context"
+    COOKIE_BUFFER = 5.seconds.freeze
+    DEFAULT_COOKIE_OPTIONS = {
+      path: "/",
+      http_only: true
+    }.freeze
+
+    class << self
+      include Mixin::Configuration
+    end
+
+    COOKIE_READER = lambda do |rack_env|
+      rack_request = Rack::Request.new(rack_env)
+      arpa_cookie  = rack_request.cookies[COOKIE_NAME]
+      JSON.parse(arpa_cookie || "{}")
+    rescue JSON::ParserError
+      {}
+    end.freeze
+
+    COOKIE_WRITER = lambda do |headers, cookie_hash, options|
+      cookie           = DEFAULT_COOKIE_OPTIONS.merge(options)
+      max_value        = cookie_hash.values.max || 0
+      then_time        = Time.at(max_value).utc
+      expires          = then_time + proxy_delay(cookie_hash.key(max_value)) + COOKIE_BUFFER
+      max_age          = expires - then_time
+      cookie[:expires] = expires
+      cookie[:max_age] = max_age
+      cookie[:value]   = cookie_hash.to_json
+
+      Rack::Utils.set_cookie_header!(headers, COOKIE_NAME, cookie)
+    end.freeze
+
+    def initialize(app, cookie_options = {})
+      @app = app
+      @cookie_options = cookie_options
+    end
+
+    def call(env)
+      return @app.call(env) if ignore_request?(env)
+
+      self.current_context = context_store.new(COOKIE_READER.call(env))
+
+      status, headers, body = @app.call(env)
+
+      update_cookie_from_context(headers)
+
+      [status, headers, body]
+    end
+
+    private
+
+    def update_cookie_from_context(headers)
+      COOKIE_WRITER.call(headers, current_context.to_h, @cookie_options)
+    end
+
+    def ignore_request?(env)
+      return false unless defined?(Rails)
+      return false unless asset_prefix
+
+      /^#{asset_prefix}/.match?(env["PATH_INFO"].to_s)
+    end
+
+    def asset_prefix
+      Rails.try(:application).try(:config).try(:assets).try(:prefix)
+    end
+  end
+end

data/lib/active_record_proxy_adapters/mixin/configuration.rb

@@ -10,17 +10,27 @@ module ActiveRecordProxyAdapters
     # Provides helpers to access to reduce boilerplate while retrieving configuration properties.
     module Configuration
       # Helper to retrieve the proxy delay from the configuration stored in
-      # {ActiveRecordProxyAdapters::Configuration#proxy_delay}.
+      # {ActiveRecordProxyAdapters::DatabaseConfiguration#log_subscriber_prefix}.
+      # @param database_name [Symbol, String] The name of the database to retrieve the prefix.
+      # @return [Proc]
+      def log_subscriber_prefix(database_name)
+        database_config(database_name).log_subscriber_prefix
+      end
+
+      # Helper to retrieve the proxy delay from the configuration stored in
+      # {ActiveRecordProxyAdapters::DatabaseConfiguration#proxy_delay}.
+      # @param database_name [Symbol, String] The name of the database to retrieve the proxy delay for.
       # @return [ActiveSupport::Duration]
-      def proxy_delay
-        proxy_config.proxy_delay
+      def proxy_delay(database_name)
+        database_config(database_name).proxy_delay
       end
 
       # Helper to retrieve the checkout timeout from the configuration stored in
-      # {ActiveRecordProxyAdapters::Configuration#checkout_timeout}.
+      # {ActiveRecordProxyAdapters::DatabaseConfiguration#checkout_timeout}.
+      # @param database_name [Symbol, String] The name of the database to retrieve the checkout timeout for.
       # @return [ActiveSupport::Duration]
-      def checkout_timeout
-        proxy_config.checkout_timeout
+      def checkout_timeout(database_name)
+        database_config(database_name).checkout_timeout
       end
 
       # Helper to retrieve the context store class from the configuration stored in
@@ -50,6 +60,11 @@ module ActiveRecordProxyAdapters
         proxy_config.cache
       end
 
+      # @!visibility private
+      def database_config(database_name)
+        proxy_config.database(database_name)
+      end
+
       # @!visibility private
       def proxy_config
         ActiveRecordProxyAdapters.config

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -181,7 +181,7 @@ module ActiveRecordProxyAdapters
     end
 
     def checkout_replica_connection
-      replica_pool.checkout(checkout_timeout)
+      replica_pool.checkout(checkout_timeout(primary_connection_name))
     # rescue NoDatabaseError to avoid crashing when running db:create rake task
     # rescue ConnectionNotEstablished to handle connectivity issues in the replica
     # (for example, replication delay)
@@ -189,7 +189,6 @@ module ActiveRecordProxyAdapters
       primary_connection
     end
 
-    # @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)
@@ -233,7 +232,7 @@ module ActiveRecordProxyAdapters
     end
 
     def primary_connection_name
-      @primary_connection_name ||= primary_connection.pool.try(:db_config).try(:name).try(:to_sym)
+      @primary_connection_name ||= primary_connection.pool.try(:db_config).try(:name).try(:to_s)
     end
 
     def proxy_context

data/lib/active_record_proxy_adapters/railtie.rb

@@ -6,6 +6,7 @@ module ActiveRecordProxyAdapters
   # Hooks into rails boot process to extend ActiveRecord with the proxy adapter.
   class Railtie < Rails::Railtie
     require "active_record_proxy_adapters/connection_handling"
+    require "active_record_proxy_adapters/middleware"
 
     config.to_prepare do
       Rails.autoloaders.each do |autoloader|
@@ -17,5 +18,9 @@ module ActiveRecordProxyAdapters
         )
       end
     end
+
+    initializer "active_record_proxy_adapters.configure_rails_initialization" do |app|
+      app.middleware.use ActiveRecordProxyAdapters::Middleware
+    end
   end
 end

data/lib/active_record_proxy_adapters/synchronizable_configuration.rb

@@ -7,8 +7,6 @@ module ActiveRecordProxyAdapters
     included do
       private
 
-      attr_reader :lock
-
       def synchronize_update(attribute, from:, to:, &block)
         ActiveSupport::Notifications.instrument(
           "active_record_proxy_adapters.configuration_update",

data/lib/active_record_proxy_adapters/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Matt Cruz
@@ -63,6 +63,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   This gem allows automatic connection switching between a primary and one read replica database in ActiveRecord.
   It pattern matches the SQL statement being sent to decide whether it should go to the replica (SELECT) or the
@@ -96,9 +110,11 @@ files:
 - lib/active_record_proxy_adapters/connection_handling/trilogy.rb
 - lib/active_record_proxy_adapters/context.rb
 - lib/active_record_proxy_adapters/contextualizer.rb
+- lib/active_record_proxy_adapters/database_configuration.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/middleware.rb
 - lib/active_record_proxy_adapters/mixin/configuration.rb
 - lib/active_record_proxy_adapters/mysql2_proxy.rb
 - lib/active_record_proxy_adapters/postgresql_proxy.rb