janus-ar 8.0.0 → 8.1.0

data/lib/janus-ar/context.rb

@@ -1,80 +1,79 @@
-# frozen_string_literal: true
-
-module Janus
-  class Context
-    THREAD_KEY = :janus_ar_context
-
-    # Stores the staged data with an expiration time based on the current time,
-    # and clears any expired entries. Returns true if any changes were made to
-    # the current store
-    def initialize(primary: false, expiry: nil)
-      @primary = primary
-      @expiry = expiry
-      @last_used_connection = :primary
-    end
-
-    def stick_to_primary
-      @primary = true
-    end
-
-    def potential_write
-      stick_to_primary
-    end
-
-    def release_all
-      @primary = false
-      @expiry = nil
-      @last_used_connection = nil
-    end
-
-    def use_primary?
-      @primary
-    end
-
-    def used_connection(connection)
-      @last_used_connection = connection
-    end
-
-    attr_reader :last_used_connection
-
-    class << self
-      def stick_to_primary
-        current.stick_to_primary
-      end
-
-      def release_all
-        current.release_all
-      end
-
-      def used_connection(connection)
-        current.used_connection(connection)
-      end
-
-      def use_primary?
-        current.use_primary?
-      end
-
-      def last_used_connection
-        current.last_used_connection
-      end
-
-      protected
-
-      def current
-        fetch(THREAD_KEY) { new }
-      end
-
-      def fetch(key)
-        get(key) || set(key, yield)
-      end
-
-      def get(key)
-        Thread.current.thread_variable_get(key)
-      end
-
-      def set(key, value)
-        Thread.current.thread_variable_set(key, value)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'active_support/isolated_execution_state'
+
+module Janus
+  # Per-execution state that records whether the current unit of work has been
+  # pinned to the primary (e.g. after a write, so subsequent reads stay
+  # consistent). State is stored in ActiveSupport::IsolatedExecutionState so it
+  # follows the application's configured isolation level (thread or fiber),
+  # matching ActiveRecord itself.
+  #
+  # Because pooled threads/fibers are reused across requests and jobs, the
+  # context MUST be released between units of work or a thread that performed a
+  # single write would keep routing every later read to the primary. The Rails
+  # integration (see Janus::Railtie) does this automatically; outside Rails,
+  # call Janus::Context.release_all yourself (e.g. in a Sidekiq middleware).
+  class Context
+    STATE_KEY = :janus_ar_context
+
+    def initialize(primary: false)
+      @primary = primary
+      @last_used_connection = :primary
+    end
+
+    def stick_to_primary
+      @primary = true
+    end
+
+    def release_all
+      @primary = false
+      @last_used_connection = nil
+    end
+
+    def use_primary?
+      @primary
+    end
+
+    def used_connection(connection)
+      @last_used_connection = connection
+    end
+
+    attr_reader :last_used_connection
+
+    class << self
+      def stick_to_primary
+        current.stick_to_primary
+      end
+
+      def release_all
+        current.release_all
+      end
+
+      def used_connection(connection)
+        current.used_connection(connection)
+      end
+
+      def use_primary?
+        current.use_primary?
+      end
+
+      def last_used_connection
+        current.last_used_connection
+      end
+
+      # Release the context at the start of every unit of work wrapped by the
+      # given ActiveSupport executor (web requests, ActiveJob and
+      # Sidekiq-on-Rails jobs all run inside it).
+      def install_reset_hook(executor)
+        executor.to_run { Janus::Context.release_all }
+      end
+
+      protected
+
+      def current
+        ActiveSupport::IsolatedExecutionState[STATE_KEY] ||= new
+      end
+    end
+  end
+end

data/lib/janus-ar/db_console_config.rb

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
-
-module Janus
-  class DbConsoleConfig
-    def initialize(config)
-      @_config = config.configuration_hash
-    end
-
-    def configuration_hash
-      @_config[:janus]['replica'].symbolize_keys
-    end
-
-    def database
-      @_config[:database]
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Janus
+  class DbConsoleConfig
+    def initialize(config)
+      @_config = config.configuration_hash
+    end
+
+    def configuration_hash
+      @_config[:janus]['replica'].symbolize_keys
+    end
+
+    def database
+      @_config[:database]
+    end
+  end
+end

data/lib/janus-ar/logging/logger.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-module Janus
-  module Logging
-    class Logger
-      class << self
-        def log(message, format = :info)
-          logger&.send(format, "[Janus] #{message}")
-        end
-
-        attr_accessor :logger
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Janus
+  module Logging
+    class Logger
+      class << self
+        def log(message, format = :info)
+          logger&.send(format, "[Janus] #{message}")
+        end
+
+        attr_accessor :logger
+      end
+    end
+  end
+end

data/lib/janus-ar/logging/subscriber.rb

@@ -1,27 +1,27 @@
-# frozen_string_literal: true
-
-module Janus
-  module Logging
-    module Subscriber
-      IGNORE_PAYLOAD_NAMES = %w(SCHEMA EXPLAIN).freeze
-
-      def sql(event)
-        name = event.payload[:name]
-        unless IGNORE_PAYLOAD_NAMES.include?(name)
-          name = [current_wrapper_name(event), name].compact.join(' ')
-          event.payload[:name] = name
-        end
-        super(event)
-      end
-
-      protected
-
-      def current_wrapper_name(_event)
-        connection = Janus::Context.last_used_connection
-        return nil unless connection
-
-        "[#{connection}]"
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Janus
+  module Logging
+    module Subscriber
+      IGNORE_PAYLOAD_NAMES = %w(SCHEMA EXPLAIN).freeze
+
+      def sql(event)
+        name = event.payload[:name]
+        unless IGNORE_PAYLOAD_NAMES.include?(name)
+          name = [current_wrapper_name(event), name].compact.join(' ')
+          event.payload[:name] = name
+        end
+        super(event)
+      end
+
+      protected
+
+      def current_wrapper_name(_event)
+        connection = Janus::Context.last_used_connection
+        return nil unless connection
+
+        "[#{connection}]"
+      end
+    end
+  end
+end

data/lib/janus-ar/query_director.rb

@@ -1,54 +1,87 @@
-# frozen_string_literal: true
-module Janus
-  class QueryDirector
-    ALL = :all
-    REPLICA = :replica
-    PRIMARY = :primary
-
-    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,
-      /\A\s*show/i
-    ].freeze
-    SQL_REPLICA_MATCHERS = [/\A\s*(select|with.+\)\s*select)\s/i].freeze
-    SQL_ALL_MATCHERS = [/\A\s*set\s/i].freeze
-    SQL_SKIP_ALL_MATCHERS = [/\A\s*set\s+local\s/i].freeze
-    WRITE_PREFIXES = %w(INSERT UPDATE DELETE LOCK CREATE GRANT DROP ALTER TRUNCATE BEGIN SAVEPOINT FLUSH).freeze
-
-    def initialize(sql, open_transactions)
-      @_sql = sql
-      @_open_transactions = open_transactions
-    end
-
-    def where_to_send?
-      if should_send_to_all?
-        ALL
-      elsif can_go_to_replica?
-        REPLICA
-      else
-        PRIMARY
-      end
-    end
-
-    private
-
-    def should_send_to_all?
-      SQL_ALL_MATCHERS.any? { |matcher| @_sql =~ matcher } && SQL_SKIP_ALL_MATCHERS.none? { |matcher| @_sql =~ matcher }
-    end
-
-    def can_go_to_replica?
-      !should_go_to_primary?
-    end
-
-    def should_go_to_primary?
-      Janus::Context.use_primary? ||
-        write_query? ||
-        @_open_transactions.positive? ||
-        SQL_PRIMARY_MATCHERS.any? { |matcher| @_sql =~ matcher }
-    end
-
-    def write_query?
-      WRITE_PREFIXES.include?(@_sql.upcase.split(' ').first)
-    end
-  end
-end
+# frozen_string_literal: true
+module Janus
+  class QueryDirector
+    ALL = :all
+    REPLICA = :replica
+    PRIMARY = :primary
+
+    LOCK_FUNCTIONS = %w(
+      nextval currval lastval get_lock release_lock is_free_lock is_used_lock
+      pg_advisory_lock pg_advisory_unlock
+    ).freeze
+
+    SQL_PRIMARY_MATCHERS = [
+      /\A\s*select\b.*\bfor\s+(update|share)\b/im,
+      /\A\s*select\b.*\block\s+in\s+share\s+mode\b/im,
+      /\A\s*select\b.*\b(#{LOCK_FUNCTIONS.join('|')})\s*\(/im,
+      /\A\s*show\b/i,
+    ].freeze
+    SQL_REPLICA_MATCHERS = [/\A\s*(select|with.+\)\s*select)\s/i].freeze
+    SQL_ALL_MATCHERS = [/\A\s*set\s/i].freeze
+    SQL_SKIP_ALL_MATCHERS = [/\A\s*set\s+local\s/i].freeze
+
+    # Leading whitespace and SQL comments are stripped before matching so that an
+    # annotated statement (e.g. `/* app:web */ INSERT ...`) is classified by the
+    # statement itself rather than by the comment.
+    LEADING_NOISE = %r{\A(?:\s+|/\*.*?\*/|--[^\n]*(?:\n|\z)|\#[^\n]*(?:\n|\z))+}m
+
+    def initialize(sql, open_transactions)
+      @_sql = sql
+      @_open_transactions = open_transactions
+    end
+
+    def where_to_send?
+      if should_send_to_all?
+        ALL
+      elsif can_go_to_replica?
+        REPLICA
+      else
+        PRIMARY
+      end
+    end
+
+    private
+
+    def should_send_to_all?
+      match_any?(SQL_ALL_MATCHERS) && !match_any?(SQL_SKIP_ALL_MATCHERS)
+    end
+
+    # A replica may only serve a statement we positively recognise as a read and
+    # that nothing else forces onto the primary. Everything we do not recognise
+    # as a read defaults to the primary, which is the safe direction for a
+    # write/read proxy: a misrouted read only costs a little primary load, while
+    # a misrouted write is an error (or worse) against a read-only replica.
+    #
+    # Because this is only reached for a confirmed read, there is no need to also
+    # test for a write here.
+    def can_go_to_replica?
+      read_query? && !should_go_to_primary?
+    end
+
+    def read_query?
+      match_any?(SQL_REPLICA_MATCHERS)
+    end
+
+    def should_go_to_primary?
+      Janus::Context.use_primary? ||
+        @_open_transactions.positive? ||
+        match_any?(SQL_PRIMARY_MATCHERS)
+    end
+
+    def match_any?(matchers)
+      matchers.any? { |matcher| normalized_sql.match?(matcher) }
+    end
+
+    # Avoid copying the statement when there is no leading comment/whitespace to
+    # strip, which is the common case for ActiveRecord-generated SQL.
+    def normalized_sql
+      @normalized_sql ||= strip_leading_noise
+    end
+
+    def strip_leading_noise
+      return @_sql unless LEADING_NOISE.match?(@_sql)
+
+      @_sql.sub(LEADING_NOISE, '')
+    end
+  end
+end

data/lib/janus-ar/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Janus
+  class Railtie < ::Rails::Railtie
+    # Clear Janus' per-request primary stickiness at the start of every unit of
+    # work wrapped by the Rails executor (web requests, ActiveJob and
+    # Sidekiq-on-Rails jobs). Without this, a pooled thread that performs a
+    # write keeps routing reads to the primary for the rest of its life.
+    initializer 'janus.clear_context_per_execution' do |app|
+      Janus::Context.install_reset_hook(app.executor)
+    end
+  end
+end

data/lib/janus-ar/version.rb

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
-
-module Janus
-  unless defined?(::Janus::VERSION)
-    module VERSION
-      MAJOR = 8
-      MINOR = 0
-      PATCH = 0
-      PRE = nil
-
-      def self.to_s
-        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
-      end
-    end
-  end
-  ::Janus::VERSION
-end
+# frozen_string_literal: true
+
+module Janus
+  unless defined?(::Janus::VERSION)
+    module VERSION
+      MAJOR = 8
+      MINOR = 1
+      PATCH = 0
+      PRE = nil
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
+  ::Janus::VERSION
+end

data/lib/janus-ar.rb

@@ -1,22 +1,24 @@
-# frozen_string_literal: true
-
-require 'active_support'
-
-module Janus
-  autoload :Context, 'janus-ar/context'
-  autoload :Client, 'janus-ar/client'
-  autoload :QueryDirector, 'janus-ar/query_director'
-  autoload :VERSION, 'janus-ar/version'
-  autoload :DbConsoleConfig, 'janus-ar/db_console_config'
-
-  module Logging
-    autoload :Subscriber, 'janus-ar/logging/subscriber'
-    autoload :Logger, 'janus-ar/logging/logger'
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::LogSubscriber.log_subscribers.each do |subscriber|
-    subscriber.extend Janus::Logging::Subscriber
-  end
-end
+# frozen_string_literal: true
+
+require 'active_support'
+
+module Janus
+  autoload :Context, 'janus-ar/context'
+  autoload :Client, 'janus-ar/client'
+  autoload :QueryDirector, 'janus-ar/query_director'
+  autoload :VERSION, 'janus-ar/version'
+  autoload :DbConsoleConfig, 'janus-ar/db_console_config'
+
+  module Logging
+    autoload :Subscriber, 'janus-ar/logging/subscriber'
+    autoload :Logger, 'janus-ar/logging/logger'
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::LogSubscriber.log_subscribers.each do |subscriber|
+    subscriber.extend Janus::Logging::Subscriber
+  end
+end
+
+require 'janus-ar/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: janus-ar
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Lloyd Watkin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -120,28 +119,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.69.2
+        version: 1.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.69.2
+        version: 1.90.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: 2.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: 2.37.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -187,52 +186,34 @@ dependencies:
 description: Read/Write proxy for ActiveRecord using primary/replica databases
 email:
 - lloyd@olioex.com
-executables:
-- release.sh
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/publish.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- assets/.gitkeep
-- assets/janus-logo.png
-- bin/release.sh
 - janus-ar.gemspec
 - lib/janus-ar.rb
 - lib/janus-ar/active_record/connection_adapters/janus_mysql2_adapter.rb
 - lib/janus-ar/active_record/connection_adapters/janus_trilogy_adapter.rb
+- lib/janus-ar/adapter_extensions.rb
 - lib/janus-ar/client.rb
 - lib/janus-ar/context.rb
 - lib/janus-ar/db_console_config.rb
 - lib/janus-ar/logging/logger.rb
 - lib/janus-ar/logging/subscriber.rb
 - lib/janus-ar/query_director.rb
+- lib/janus-ar/railtie.rb
 - lib/janus-ar/version.rb
-- spec/lib/janus-ar/active_record/connection_adapters/janus_mysql_adapter_spec.rb
-- spec/lib/janus-ar/active_record/connection_adapters/janus_trilogy_adapter_spec.rb
-- spec/lib/janus-ar/client_spec.rb
-- spec/lib/janus-ar/context_spec.rb
-- spec/lib/janus-ar/logging/logger_spec.rb
-- spec/lib/janus-ar/query_director_spec.rb
-- spec/shared_examples/a_mysql_like_server.rb
-- spec/spec_helper.rb
 homepage: https://github.com/olioex/janus-ar
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/olioex/janus-ar
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Read/Write proxy for ActiveRecord using primary/replica databases
 test_files: []

data/.bundle/config

@@ -1,5 +0,0 @@
----
-BUNDLE_JOBS: "4"
-BUNDLE_BUILD__UNICODE: "--with-cflags=-Wno-incompatible-function-pointer-types"
-BUNDLE_BUILD__MYSQL2: "--with-ldflags=-L/opt/homebrew/opt/zstd/lib"
-BUNDLE_FROZEN: "false"

data/.github/dependabot.yml

@@ -1,7 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "bundler"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-