active_record_proxy_adapters 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d73a2213222b1689c5ff581f40e561974446e480355d582fca5daa04eccf9996
-  data.tar.gz: ee667c46d62816df1dafbe583cbe0503448097f30ebf7c6d37565fd6cb335779
+  metadata.gz: ea3aa59337aa2ed793bfb2e51666d08ef6b40ad9ccd2008453807baeac862933
+  data.tar.gz: 1e899907a68ecf3c6ca5a51380e2b7be9859d40c0b033f23b872037c6d1fd5a8
 SHA512:
-  metadata.gz: a0c1db04e45da543ff86f31a37b45a5f3c5a3e31d0c877cd7e0038f46d01207bf90124868dda9a89ce73a0701726e9c539a422ef53a6e3a9cac9f2304e20a4de
-  data.tar.gz: 1e7eeb8e61c753dd6ad8475a61c4625c90240cdf1d2cf544b40c215a34ec498df806e8403922728c579f5dc727ea5901ff9e81875a57a36fcb2f1fbb17ec4b08
+  metadata.gz: 3b9018059039d65f435a8d4571f5eea8a477e4388728a675b2176252959e5fb6afd0833cb21e65ea5bbd04e77c484f1d2ec3974d698b057c72440f7a9349150a
+  data.tar.gz: 7bf7662851cc2d6b1bcd7fcb59df5216fb87f28c368910da05476b6b734f692f2182de15bb731276f5952690b9ded4840ed2ddd2e35653fb2ff17c9c6e0a7bc4

data/lib/active_record_proxy_adapters/active_record_context.rb

@@ -40,7 +40,7 @@ module ActiveRecordProxyAdapters
     def hijackable_methods
       hijackable = %i[execute exec_query]
 
-      hijackable << :internal_exec_query if active_record_v8_0_or_greater?
+      hijackable << :internal_exec_query if active_record_v7_1_or_greater?
 
       hijackable
     end

data/lib/active_record_proxy_adapters/configuration.rb

@@ -3,6 +3,7 @@
 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.
@@ -27,6 +28,9 @@ module ActiveRecordProxyAdapters
     # @return [Proc] Prefix for the log subscriber when the replica database is used. Thread safe.
     attr_reader :log_subscriber_replica_prefix
 
+    # @return [Class] The context that is used to store the current request's state.
+    attr_reader :context_store
+
     def initialize
       @lock = Monitor.new
 
@@ -35,6 +39,7 @@ module ActiveRecordProxyAdapters
       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
     end
 
     def log_subscriber_primary_prefix=(prefix)
@@ -65,6 +70,12 @@ module ActiveRecordProxyAdapters
       end
     end
 
+    def context_store=(context_store)
+      synchronize_update(:context_store, from: @context_store, to: context_store) do
+        @context_store = context_store
+      end
+    end
+
     def cache
       block_given? ? yield(cache_configuration) : cache_configuration
     end

data/lib/active_record_proxy_adapters/context.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_record_proxy_adapters/mixin/configuration"
+
+module ActiveRecordProxyAdapters
+  # Context is a simple class that holds a registry of connection names and their last write timestamps.
+  # It is used to track the last time a write operation was performed on each connection.
+  # This allows the proxy to determine whether to route read requests to the primary or replica database
+  class Context
+    include Mixin::Configuration
+
+    # @param hash [Hash] A hash containing the connection names as keys and the last write timestamps as values.
+    #   Can be empty.
+    def initialize(hash)
+      @timestamp_registry = hash.transform_values(&:to_f)
+    end
+
+    def recent_write_to_primary?(connection_name)
+      now - self[connection_name] < proxy_delay
+    end
+
+    def update_for(connection_name)
+      self[connection_name] = now
+    end
+
+    def [](connection_name)
+      timestamp_registry[connection_name] || 0
+    end
+
+    def []=(connection_name, timestamp)
+      timestamp_registry[connection_name] = timestamp
+    end
+
+    private
+
+    attr_reader :timestamp_registry
+
+    def now
+      Time.now.utc.to_f
+    end
+  end
+end

data/lib/active_record_proxy_adapters/contextualizer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveRecordProxyAdapters
+  # A mixin for managing the context of current database connections.
+  module Contextualizer
+    module_function
+
+    # @return [ActiveRecordProxyAdapters::Context]
+    # Retrieves the context for the current thread.
+    def current_context
+      Thread.current.thread_variable_get(:arpa_context)
+    end
+
+    # @param context [ActiveRecordProxyAdapters::Context]
+    # Sets the context for the current thread.
+    def current_context=(context)
+      Thread.current.thread_variable_set(:arpa_context, context)
+    end
+  end
+end

data/lib/active_record_proxy_adapters/mixin/configuration.rb

@@ -0,0 +1,59 @@
+# 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
+  module Mixin
+    # 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}.
+      # @return [ActiveSupport::Duration]
+      def proxy_delay
+        proxy_config.proxy_delay
+      end
+
+      # Helper to retrieve the checkout timeout from the configuration stored in
+      # {ActiveRecordProxyAdapters::Configuration#checkout_timeout}.
+      # @return [ActiveSupport::Duration]
+      def checkout_timeout
+        proxy_config.checkout_timeout
+      end
+
+      # Helper to retrieve the context store class from the configuration stored in
+      # {ActiveRecordProxyAdapters::Configuration#context_store}.
+      # @return [Class]
+      def context_store
+        proxy_config.context_store
+      end
+
+      # Helper to retrieve the cache store from the configuration stored in
+      # {ActiveRecordProxyAdapters::CacheConfiguration#store}.
+      # @return [ActiveSupport::Cache::Store]
+      def cache_store
+        cache_config.store
+      end
+
+      # Helper to retrieve the cache key prefix from the configuration stored in
+      # {ActiveRecordProxyAdapters::CacheConfiguration#key_prefix}.
+      # It uses the key builder to generate a cache key for the given SQL string, prepended with the key prefix.
+      # @return [String]
+      def cache_key_for(sql_string)
+        cache_config.key_builder.call(sql_string).prepend(cache_config.key_prefix)
+      end
+
+      # @!visibility private
+      def cache_config
+        proxy_config.cache
+      end
+
+      # @!visibility private
+      def proxy_config
+        ActiveRecordProxyAdapters.config
+      end
+    end
+  end
+end

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
+require "active_record_proxy_adapters/active_record_context"
 require "active_record_proxy_adapters/configuration"
+require "active_record_proxy_adapters/contextualizer"
+require "active_record_proxy_adapters/hijackable"
+require "active_record_proxy_adapters/mixin/configuration"
 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
+    include Contextualizer
+    include Mixin::Configuration
 
     # All queries that match these patterns should be sent to the primary database
     SQL_PRIMARY_MATCHERS = [
@@ -51,13 +54,12 @@ module ActiveRecordProxyAdapters
     # @param primary_connection [ActiveRecord::ConnectionAdatpers::AbstractAdapter]
     def initialize(primary_connection)
       @primary_connection    = primary_connection
-      @last_write_at         = 0
       @active_record_context = ActiveRecordContext.new
     end
 
     private
 
-    attr_reader :primary_connection, :last_write_at, :active_record_context
+    attr_reader :primary_connection, :active_record_context
 
     delegate :connection_handler, to: :connection_class
     delegate :reading_role, :writing_role, to: :active_record_context
@@ -140,10 +142,6 @@ module ActiveRecordProxyAdapters
       [reading_role, writing_role].include?(role) ? role : nil
     end
 
-    def cache_key_for(sql_string)
-      cache_config.key_builder.call(sql_string).prepend(cache_config.key_prefix)
-    end
-
     def connected_to_stack
       return connection_class.connected_to_stack if connection_class.respond_to?(:connected_to_stack)
 
@@ -221,11 +219,9 @@ module ActiveRecordProxyAdapters
       proc { |matcher| matcher.match?(sql_string) }
     end
 
-    # TODO: implement a context API to re-route requests to the primary database if a recent query was sent to it to
-    # avoid replication delay issues
     # @return Boolean
     def recent_write_to_primary?
-      Concurrent.monotonic_time - last_write_at < proxy_delay
+      proxy_context.recent_write_to_primary?(primary_connection_name)
     end
 
     def in_transaction?
@@ -233,27 +229,15 @@ module ActiveRecordProxyAdapters
     end
 
     def update_primary_latest_write_timestamp
-      @last_write_at = Concurrent.monotonic_time
-    end
-
-    def cache_store
-      cache_config.store
-    end
-
-    def cache_config
-      proxy_config.cache
-    end
-
-    def proxy_delay
-      proxy_config.proxy_delay
+      proxy_context.update_for(primary_connection_name)
     end
 
-    def checkout_timeout
-      proxy_config.checkout_timeout
+    def primary_connection_name
+      @primary_connection_name ||= primary_connection.pool.try(:db_config).try(:name).try(:to_sym)
     end
 
-    def proxy_config
-      ActiveRecordProxyAdapters.config
+    def proxy_context
+      self.current_context ||= context_store.new({})
     end
   end
 end

data/lib/active_record_proxy_adapters/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Matt Cruz
@@ -94,9 +94,12 @@ files:
 - lib/active_record_proxy_adapters/connection_handling/postgresql.rb
 - lib/active_record_proxy_adapters/connection_handling/sqlite3.rb
 - 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_tasks.rb
 - lib/active_record_proxy_adapters/hijackable.rb
 - lib/active_record_proxy_adapters/log_subscriber.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
 - lib/active_record_proxy_adapters/primary_replica_proxy.rb