janus-ar 8.0.0 → 8.1.0

data/janus-ar.gemspec

@@ -1,36 +1,38 @@
-# frozen_string_literal: true
-
-require File.expand_path('lib/janus-ar/version.rb', __dir__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ['Lloyd Watkin']
-  gem.email         = ['lloyd@olioex.com']
-  gem.description   = 'Read/Write proxy for ActiveRecord using primary/replica databases'
-  gem.summary       = 'Read/Write proxy for ActiveRecord using primary/replica databases'
-  gem.homepage      = 'https://github.com/olioex/janus-ar'
-  gem.licenses      = %w(MIT)
-  gem.metadata      = {
-    'source_code_uri' => 'https://github.com/olioex/janus-ar',
-  }
-
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.name          = 'janus-ar'
-  gem.require_paths = %w(lib)
-  gem.version       = Janus::VERSION
-
-  gem.required_ruby_version = '>= 3.2.0'
-
-  gem.add_dependency 'activerecord', '>= 8.0', '< 9.0'
-  gem.add_development_dependency 'activesupport', '>= 8.0'
-  gem.add_development_dependency 'mysql2'
-  gem.add_development_dependency 'trilogy'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 3'
-  gem.add_development_dependency 'rubocop', '~> 1.69.2'
-  gem.add_development_dependency 'rubocop-rails', '~> 2.28.0'
-  gem.add_development_dependency 'rubocop-rspec'
-  gem.add_development_dependency 'rubocop-thread_safety'
-  gem.add_development_dependency 'rubocop-performance'
-end
+# frozen_string_literal: true
+
+require File.expand_path('lib/janus-ar/version.rb', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Lloyd Watkin']
+  gem.email         = ['lloyd@olioex.com']
+  gem.description   = 'Read/Write proxy for ActiveRecord using primary/replica databases'
+  gem.summary       = 'Read/Write proxy for ActiveRecord using primary/replica databases'
+  gem.homepage      = 'https://github.com/olioex/janus-ar'
+  gem.licenses      = %w(MIT)
+  gem.metadata      = {
+    'source_code_uri' => 'https://github.com/olioex/janus-ar',
+  }
+
+  ignored           = %r{^(bin|spec|assets|gemfiles|\.github)/|^\.}
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR).grep_v(ignored)
+  # The gem ships no executables; bin/ holds repository maintenance scripts.
+  gem.executables   = []
+  gem.name          = 'janus-ar'
+  gem.require_paths = %w(lib)
+  gem.version       = Janus::VERSION
+
+  gem.required_ruby_version = '>= 3.2.0'
+
+  gem.add_dependency 'activerecord', '>= 8.0', '< 9.0'
+  gem.add_development_dependency 'activesupport', '>= 8.0'
+  gem.add_development_dependency 'mysql2'
+  gem.add_development_dependency 'trilogy'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3'
+  gem.add_development_dependency 'rubocop', '~> 1.90.0'
+  gem.add_development_dependency 'rubocop-rails', '~> 2.37.0'
+  gem.add_development_dependency 'rubocop-rspec'
+  gem.add_development_dependency 'rubocop-thread_safety'
+  gem.add_development_dependency 'rubocop-performance'
+end

data/lib/janus-ar/active_record/connection_adapters/janus_mysql2_adapter.rb

@@ -1,149 +1,32 @@
-# frozen_string_literal: true
-
-require 'active_record/connection_adapters/abstract_adapter'
-require 'active_record/connection_adapters/mysql2_adapter'
-require_relative '../../../janus-ar'
-
-module ActiveRecord
-  module ConnectionHandling
-    def janus_mysql2_connection(config)
-      ActiveRecord::ConnectionAdapters::JanusMysql2Adapter.new(config)
-    end
-  end
-end
-
-module ActiveRecord
-  class Base
-    def self.janus_mysql2_adapter_class
-      ActiveRecord::ConnectionAdapters::JanusMysql2Adapter
-    end
-  end
-end
-
-module ActiveRecord
-  module ConnectionAdapters
-    class JanusMysql2Adapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
-      FOUND_ROWS = 'FOUND_ROWS'
-
-      attr_reader :config
-
-      class << self
-        def dbconsole(config, options = {})
-          connection_config = Janus::DbConsoleConfig.new(config)
-
-          super(connection_config, options)
-        end
-      end
-
-      def initialize(*args)
-        args[0][:janus]['replica']['database'] = args[0][:database]
-        args[0][:janus]['primary']['database'] = args[0][:database]
-
-        @replica_config = args[0][:janus]['replica']
-        args[0] = args[0][:janus]['primary']
-
-        super(*args)
-        @connection_parameters ||= args[0]
-        update_config
-      end
-
-      def with_connection(_args = {})
-        self
-      end
-
-      def raw_execute(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false,
-        materialize_transactions: true, batch: false)
-        case where_to_send?(sql)
-        when :all
-          send_to_replica(sql, connection: :all, method: :raw_execute)
-          super
-        when :replica
-          send_to_replica(sql, connection: :replica, method: :raw_execute)
-        else
-          Janus::Context.stick_to_primary if write_query?(sql)
-          Janus::Context.used_connection(:primary)
-          super
-        end
-      end
-
-      def execute(sql)
-        case where_to_send?(sql)
-        when :all
-          send_to_replica(sql, connection: :all, method: :execute)
-          super(sql)
-        when :replica
-          send_to_replica(sql, connection: :replica, method: :execute)
-        else
-          Janus::Context.stick_to_primary if write_query?(sql)
-          Janus::Context.used_connection(:primary)
-          super(sql)
-        end
-      end
-
-      def execute_and_free(sql, name = nil, async: false)
-        case where_to_send?(sql)
-        when :all
-          send_to_replica(sql, connection: :all, method: :execute)
-          super(sql, name, async:)
-        when :replica
-          send_to_replica(sql, connection: :replica, method: :execute)
-        else
-          Janus::Context.stick_to_primary if write_query?(sql)
-          Janus::Context.used_connection(:primary)
-          super(sql, name, async:)
-        end
-      end
-
-      def connect!(...)
-        replica_connection.connect!(...)
-        super
-      end
-
-      def reconnect!(...)
-        replica_connection.reconnect!(...)
-        super
-      end
-
-      def disconnect!(...)
-        replica_connection.disconnect!(...)
-        super
-      end
-
-      def clear_cache!(...)
-        replica_connection.clear_cache!(...)
-        super
-      end
-
-      def replica_connection
-        @replica_connection ||= ActiveRecord::ConnectionAdapters::Mysql2Adapter.new(@replica_config)
-      end
-
-      private
-
-      def where_to_send?(sql)
-        Janus::QueryDirector.new(sql, open_transactions).where_to_send?
-      end
-
-      def send_to_replica(sql, connection: nil, method: :exec_query)
-        Janus::Context.used_connection(connection) if connection
-        if method == :execute
-          replica_connection.execute(sql)
-        elsif method == :raw_execute
-          replica_connection.execute(sql)
-        else
-          replica_connection.exec_query(sql)
-        end
-      end
-
-      def update_config
-        @config[:flags] ||= 0
-
-        if @config[:flags].is_a? Array
-          @config[:flags].push FOUND_ROWS
-        else
-          @config[:flags] |= ::Janus::Client::FOUND_ROWS
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/mysql2_adapter'
+require_relative '../../../janus-ar'
+require_relative '../../adapter_extensions'
+
+module ActiveRecord
+  module ConnectionHandling
+    def janus_mysql2_connection(config)
+      ActiveRecord::ConnectionAdapters::JanusMysql2Adapter.new(config)
+    end
+  end
+
+  class Base
+    def self.janus_mysql2_adapter_class
+      ActiveRecord::ConnectionAdapters::JanusMysql2Adapter
+    end
+  end
+
+  module ConnectionAdapters
+    class JanusMysql2Adapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
+      include Janus::AdapterExtensions
+
+      private
+
+      def replica_adapter_class
+        ActiveRecord::ConnectionAdapters::Mysql2Adapter
+      end
+    end
+  end
+end

data/lib/janus-ar/active_record/connection_adapters/janus_trilogy_adapter.rb

@@ -1,149 +1,32 @@
-# frozen_string_literal: true
-
-require 'active_record/connection_adapters/abstract_adapter'
-require 'active_record/connection_adapters/trilogy_adapter'
-require_relative '../../../janus-ar'
-
-module ActiveRecord
-  module ConnectionHandling
-    def janus_trilogy_connection(config)
-      ActiveRecord::ConnectionAdapters::JanusTrilogyAdapter.new(config)
-    end
-  end
-end
-
-module ActiveRecord
-  class Base
-    def self.janus_trilogy_adapter_class
-      ActiveRecord::ConnectionAdapters::JanusTrilogyAdapter
-    end
-  end
-end
-
-module ActiveRecord
-  module ConnectionAdapters
-    class JanusTrilogyAdapter < ActiveRecord::ConnectionAdapters::TrilogyAdapter
-      FOUND_ROWS = 'FOUND_ROWS'
-
-      attr_reader :config
-
-      class << self
-        def dbconsole(config, options = {})
-          connection_config = Janus::DbConsoleConfig.new(config)
-
-          super(connection_config, options)
-        end
-      end
-
-      def initialize(*args)
-        args[0][:janus]['replica']['database'] = args[0][:database]
-        args[0][:janus]['primary']['database'] = args[0][:database]
-
-        @replica_config = args[0][:janus]['replica'].symbolize_keys
-        args[0] = args[0][:janus]['primary'].symbolize_keys
-
-        super(*args)
-        @connection_parameters ||= args[0]
-        update_config
-      end
-
-      def raw_execute(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false,
-        materialize_transactions: true, batch: false)
-        case where_to_send?(sql)
-        when :all
-          send_to_replica(sql, connection: :all, method: :execute)
-          super
-        when :replica
-          send_to_replica(sql, connection: :replica, method: :execute)
-        else
-          Janus::Context.stick_to_primary if write_query?(sql)
-          Janus::Context.used_connection(:primary)
-          super
-        end
-      end
-
-      def execute(sql)
-        case where_to_send?(sql)
-        when :all
-          send_to_replica(sql, connection: :all, method: :execute)
-          super(sql)
-        when :replica
-          send_to_replica(sql, connection: :replica, method: :execute)
-        else
-          Janus::Context.stick_to_primary if write_query?(sql)
-          Janus::Context.used_connection(:primary)
-          super(sql)
-        end
-      end
-
-      def execute_and_free(sql, name = nil, async: false)
-        case where_to_send?(sql)
-        when :all
-          send_to_replica(sql, connection: :all, method: :execute)
-          super(sql, name, async:)
-        when :replica
-          send_to_replica(sql, connection: :replica, method: :execute)
-        else
-          Janus::Context.stick_to_primary if write_query?(sql)
-          Janus::Context.used_connection(:primary)
-          super(sql, name, async:)
-        end
-      end
-
-      def with_connection(_args = {})
-        self
-      end
-
-      def connect!(...)
-        replica_connection.connect!(...)
-        super
-      end
-
-      def reconnect!(...)
-        replica_connection.reconnect!(...)
-        super
-      end
-
-      def disconnect!(...)
-        replica_connection.disconnect!(...)
-        super
-      end
-
-      def clear_cache!(...)
-        replica_connection.clear_cache!(...)
-        super
-      end
-
-      def replica_connection
-        @replica_connection ||= ActiveRecord::ConnectionAdapters::TrilogyAdapter.new(@replica_config)
-      end
-
-      private
-
-      def where_to_send?(sql)
-        Janus::QueryDirector.new(sql, open_transactions).where_to_send?
-      end
-
-      def send_to_replica(sql, connection: nil, method: :exec_query)
-        Janus::Context.used_connection(connection) if connection
-        if method == :execute
-          replica_connection.execute(sql)
-        elsif method == :raw_execute
-          replica_connection.execute(sql)
-        else
-          replica_connection.exec_query(sql)
-        end
-      end
-
-      def update_config
-        @config[:flags] ||= 0
-
-        if @config[:flags].is_a? Array
-          @config[:flags].push FOUND_ROWS
-        else
-          @config[:flags] |= ::Janus::Client::FOUND_ROWS
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/trilogy_adapter'
+require_relative '../../../janus-ar'
+require_relative '../../adapter_extensions'
+
+module ActiveRecord
+  module ConnectionHandling
+    def janus_trilogy_connection(config)
+      ActiveRecord::ConnectionAdapters::JanusTrilogyAdapter.new(config)
+    end
+  end
+
+  class Base
+    def self.janus_trilogy_adapter_class
+      ActiveRecord::ConnectionAdapters::JanusTrilogyAdapter
+    end
+  end
+
+  module ConnectionAdapters
+    class JanusTrilogyAdapter < ActiveRecord::ConnectionAdapters::TrilogyAdapter
+      include Janus::AdapterExtensions
+
+      private
+
+      def replica_adapter_class
+        ActiveRecord::ConnectionAdapters::TrilogyAdapter
+      end
+    end
+  end
+end

data/lib/janus-ar/adapter_extensions.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Janus
+  # Behaviour shared by the Janus MySQL2 and Trilogy adapters.
+  #
+  # Each Janus adapter subclasses the matching ActiveRecord adapter and owns the
+  # *primary* connection (reached via `super`). This module routes every
+  # statement to the primary, a lazily created replica connection, or both, and
+  # keeps Janus::Context up to date.
+  #
+  # Including adapters only need to implement #replica_adapter_class.
+  module AdapterExtensions
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def dbconsole(config, options = {})
+        super(Janus::DbConsoleConfig.new(config), options)
+      end
+    end
+
+    attr_reader :config
+
+    def initialize(*args)
+      config = args[0]
+      config[:janus]['replica']['database'] = config[:database]
+      config[:janus]['primary']['database'] = config[:database]
+
+      @replica_config = config[:janus]['replica'].symbolize_keys
+      args[0] = config[:janus]['primary'].symbolize_keys
+
+      super
+      @connection_parameters ||= args[0]
+    end
+
+    # The argument lists below intentionally use anonymous splats and a bare
+    # `super`: ActiveRecord's `raw_execute`/`execute` signatures differ between
+    # versions, so we forward whatever we are given unchanged rather than
+    # restating (and pinning ourselves to) the current signature.
+    def raw_execute(sql, *, **)
+      case where_to_send?(sql)
+      when :all
+        send_to_replica(sql, :all)
+        super
+      when :replica
+        send_to_replica(sql, :replica)
+      else
+        mark_primary(sql)
+        super
+      end
+    end
+
+    def execute(sql, *, **)
+      case where_to_send?(sql)
+      when :all
+        send_to_replica(sql, :all)
+        super
+      when :replica
+        send_to_replica(sql, :replica)
+      else
+        mark_primary(sql)
+        super
+      end
+    end
+
+    def connect!(...)
+      replica_connection.connect!(...)
+      super
+    end
+
+    def reconnect!(...)
+      replica_connection.reconnect!(...)
+      super
+    end
+
+    def discard!(...)
+      replica_connection.discard!(...)
+      super
+    end
+
+    def disconnect!(...)
+      replica_connection.disconnect!(...)
+      super
+    end
+
+    def clear_cache!(...)
+      replica_connection.clear_cache!(...)
+      super
+    end
+
+    def replica_connection
+      @replica_connection ||= replica_adapter_class.new(@replica_config)
+    end
+
+    private
+
+    def mark_primary(sql)
+      Janus::Context.stick_to_primary if write_query?(sql)
+      Janus::Context.used_connection(:primary)
+    end
+
+    def where_to_send?(sql)
+      Janus::QueryDirector.new(sql, open_transactions).where_to_send?
+    end
+
+    def send_to_replica(sql, connection)
+      Janus::Context.used_connection(connection)
+      replica_connection.execute(sql)
+    end
+  end
+end

data/lib/janus-ar/client.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-module Janus
-  class Client
-    FOUND_ROWS = 2
-  end
-end
+# frozen_string_literal: true
+module Janus
+  class Client
+    FOUND_ROWS = 2
+  end
+end