janus-ar 8.0.0 → 8.0.1

data/spec/lib/janus-ar/query_director_spec.rb

@@ -1,59 +1,141 @@
-# frozen_string_literal: true
-
-RSpec.describe Janus::QueryDirector do
-  describe 'Constants' do
-    it { expect(described_class::SQL_SKIP_ALL_MATCHERS).to eq [/\A\s*set\s+local\s/i] }
-    it {
-      expect(described_class::SQL_PRIMARY_MATCHERS).to eq(
-        [
-          /\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
-        ]
-      )
-    }
-    it { expect(described_class::SQL_REPLICA_MATCHERS).to eq([/\A\s*(select|with.+\)\s*select)\s/i]) }
-    it { expect(described_class::SQL_ALL_MATCHERS).to eq([/\A\s*set\s/i]) }
-    it {
-      expect(described_class::WRITE_PREFIXES).to eq %w(INSERT UPDATE DELETE LOCK CREATE GRANT DROP ALTER TRUNCATE BEGIN
-                                                       SAVEPOINT FLUSH)
-    }
-
-    it { expect(described_class::ALL).to eq :all }
-    it { expect(described_class::REPLICA).to eq :replica }
-    it { expect(described_class::PRIMARY).to eq :primary }
-  end
-
-  describe '#where_to_send?' do
-    before(:each) do
-      Janus::Context.release_all
-    end
-
-    context 'when should send to all' do
-      it 'returns :all' do
-        sql = 'SET foo = bar'
-        open_transactions = 0
-        query_director = described_class.new(sql, open_transactions)
-        expect(query_director.where_to_send?).to eq(:all)
-      end
-    end
-
-    context 'when can go to replica' do
-      it 'returns :replica' do
-        sql = 'SELECT * FROM users'
-        open_transactions = 0
-        query_director = described_class.new(sql, open_transactions)
-        expect(query_director.where_to_send?).to eq(:replica)
-      end
-    end
-
-    context 'when should go to primary' do
-      it 'returns :primary' do
-        sql = 'INSERT INTO users (name) VALUES ("John")'
-        open_transactions = 0
-        query_director = described_class.new(sql, open_transactions)
-        expect(query_director.where_to_send?).to eq(:primary)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe Janus::QueryDirector do
+  describe 'Constants' do
+    it { expect(described_class::SQL_SKIP_ALL_MATCHERS).to eq [/\A\s*set\s+local\s/i] }
+    it {
+      expect(described_class::SQL_PRIMARY_MATCHERS).to eq(
+        [
+          /\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
+        ]
+      )
+    }
+    it { expect(described_class::SQL_REPLICA_MATCHERS).to eq([/\A\s*(select|with.+\)\s*select)\s/i]) }
+    it { expect(described_class::SQL_ALL_MATCHERS).to eq([/\A\s*set\s/i]) }
+
+    it { expect(described_class::ALL).to eq :all }
+    it { expect(described_class::REPLICA).to eq :replica }
+    it { expect(described_class::PRIMARY).to eq :primary }
+  end
+
+  describe '#where_to_send?' do
+    let(:open_transactions) { 0 }
+
+    before(:each) { Janus::Context.release_all }
+
+    context 'with reads' do
+      {
+        'plain select' => 'SELECT * FROM users',
+        'lower case select' => 'select * from users',
+        'CTE select' => 'WITH recent AS (SELECT * FROM users) SELECT * FROM recent',
+        'leading whitespace' => "\n\t  SELECT 1",
+      }.each do |label, query|
+        it "routes a #{label} to the replica" do
+          expect(described_class.new(query, 0).where_to_send?).to eq(:replica)
+        end
+      end
+    end
+
+    context 'with writes' do
+      # Every one of these used to be sent to the replica because the router
+      # defaulted unknown statements there. They are genuine writes and must
+      # reach the primary.
+      %w(
+        INSERT UPDATE DELETE REPLACE RENAME CALL LOAD OPTIMIZE ANALYZE REPAIR
+        CREATE DROP TRUNCATE ALTER
+      ).each do |verb|
+        it "routes #{verb} to the primary" do
+          sql = "#{verb} something that is not a read"
+          expect(described_class.new(sql, 0).where_to_send?).to eq(:primary)
+        end
+      end
+
+      it 'routes a write annotated with a leading comment to the primary' do
+        sql = '/* app:web,controller:orders */ INSERT INTO orders (id) VALUES (1)'
+        expect(described_class.new(sql, 0).where_to_send?).to eq(:primary)
+      end
+
+      it 'routes a read annotated with a leading comment to the replica' do
+        sql = '/* app:web */ SELECT * FROM orders'
+        expect(described_class.new(sql, 0).where_to_send?).to eq(:replica)
+      end
+    end
+
+    context 'with comments and whitespace around the statement' do
+      {
+        'a line (--) comment then a read' => "-- audit trail\nSELECT * FROM orders",
+        'a hash (#) comment then a read' => "# cache key\nSELECT * FROM orders",
+        'several stacked leading comments then a read' => "/* a */ /* b */\n\t SELECT 1",
+        'tabs and newlines then a read' => "\n\t  SELECT 1",
+      }.each do |label, query|
+        it "routes #{label} to the replica" do
+          expect(described_class.new(query, 0).where_to_send?).to eq(:replica)
+        end
+      end
+
+      {
+        'a line (--) comment then a write' => "-- triggered by job 42\nUPDATE orders SET state = 1",
+        'a hash (#) comment then a write' => "# backfill\nDELETE FROM orders",
+        'a block comment then a write' => "/* migration */ ALTER TABLE orders ADD COLUMN x INT",
+      }.each do |label, query|
+        it "routes #{label} to the primary" do
+          expect(described_class.new(query, 0).where_to_send?).to eq(:primary)
+        end
+      end
+    end
+
+    context 'with locking reads' do
+      it 'routes SELECT ... FOR UPDATE to the primary' do
+        expect(described_class.new('SELECT * FROM users FOR UPDATE', 0).where_to_send?).to eq(:primary)
+      end
+
+      it 'routes SELECT ... LOCK IN SHARE MODE to the primary' do
+        expect(described_class.new('SELECT * FROM users LOCK IN SHARE MODE', 0).where_to_send?).to eq(:primary)
+      end
+
+      it 'routes advisory lock reads to the primary' do
+        expect(described_class.new("SELECT get_lock('x', 0)", 0).where_to_send?).to eq(:primary)
+      end
+    end
+
+    context 'with SHOW' do
+      it 'routes SHOW statements to the primary' do
+        expect(described_class.new('SHOW TABLES', 0).where_to_send?).to eq(:primary)
+      end
+    end
+
+    context 'with SET' do
+      it 'routes SET to all connections' do
+        expect(described_class.new('SET sql_mode = ?', 0).where_to_send?).to eq(:all)
+      end
+
+      it 'does not broadcast SET LOCAL to all connections' do
+        expect(described_class.new('SET LOCAL sql_mode = ?', 0).where_to_send?).to eq(:primary)
+      end
+    end
+
+    context 'when the context is stuck to the primary' do
+      before(:each) { Janus::Context.stick_to_primary }
+
+      it 'routes an otherwise replica-bound read to the primary' do
+        expect(described_class.new('SELECT * FROM users', 0).where_to_send?).to eq(:primary)
+      end
+    end
+
+    context 'when inside a transaction' do
+      let(:open_transactions) { 1 }
+
+      it 'routes reads to the primary so they can see uncommitted writes' do
+        expect(described_class.new('SELECT * FROM users', open_transactions).where_to_send?).to eq(:primary)
+      end
+    end
+
+    context 'with an unrecognised / empty statement' do
+      it 'defaults blank input to the primary' do
+        expect(described_class.new('   ', 0).where_to_send?).to eq(:primary)
+      end
+    end
+  end
+end

data/spec/shared_examples/a_mysql_like_server.rb

@@ -82,4 +82,74 @@ RSpec.shared_examples 'a mysql like server' do
       expect(Janus::Context.last_used_connection).to eq :replica
     end
   end
+
+  describe 'ActiveRecord compatibility' do
+    before(:each) do
+      create_test_table
+      Janus::Context.release_all
+    end
+
+    it 'accepts the optional name argument on #execute' do
+      expect do
+        ActiveRecord::Base.connection.execute("SELECT * FROM `#{table_name}`;", 'CustomName')
+      end.not_to raise_error
+    end
+
+    it 'returns a usable result through the exec_query read path' do
+      ActiveRecord::Base.connection.execute("INSERT INTO `#{table_name}` SET `id` = 7;")
+      Janus::Context.release_all
+      $query_logger.flush_all
+
+      result = ActiveRecord::Base.connection.exec_query("SELECT `id` FROM `#{table_name}`")
+
+      expect(result.rows).to eq [[7]]
+      expect($query_logger.queries.first).to include '[replica]'
+    end
+  end
+
+  describe 'Transactions' do
+    before(:each) do
+      create_test_table
+      Janus::Context.release_all
+      $query_logger.flush_all
+    end
+
+    it 'routes reads inside a transaction to the primary' do
+      ActiveRecord::Base.transaction do
+        ActiveRecord::Base.connection.execute("SELECT * FROM `#{table_name}`;")
+      end
+
+      selects = $query_logger.queries.select { |q| q.downcase.include?("select * from `#{table_name}`") }
+      expect(selects).not_to be_empty
+      expect(selects).to all(include('[primary]'))
+    end
+
+    it 'keeps later reads on the primary until the context is released' do
+      ActiveRecord::Base.transaction do
+        ActiveRecord::Base.connection.execute("INSERT INTO `#{table_name}` SET `id` = 1;")
+      end
+      $query_logger.flush_all
+
+      ActiveRecord::Base.connection.execute("SELECT * FROM `#{table_name}`;")
+      expect($query_logger.queries.last).to include '[primary]'
+
+      Janus::Context.release_all
+      ActiveRecord::Base.connection.execute("SELECT * FROM `#{table_name}`;")
+      expect($query_logger.queries.last).to include '[replica]'
+    end
+  end
+
+  describe 'SET statements' do
+    before(:each) { Janus::Context.release_all }
+
+    it 'sends a session SET down the broadcast (:all) path without error' do
+      expect do
+        ActiveRecord::Base.connection.execute("SET SESSION time_zone = '+00:00'")
+      end.not_to raise_error
+
+      # `:all` means the statement ran against the replica connection too, not
+      # just the primary - a write would have been marked `:primary`.
+      expect(Janus::Context.last_used_connection).to eq :all
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: janus-ar
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.0.1
 platform: ruby
 authors:
 - Lloyd Watkin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2026-06-19 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.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.69.2
+        version: 1.88.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: 2.35.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: 2.35.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -208,22 +207,28 @@ files:
 - assets/.gitkeep
 - assets/janus-logo.png
 - bin/release.sh
+- gemfiles/activerecord_8_0.gemfile
+- gemfiles/activerecord_8_1.gemfile
 - 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/db_console_config_spec.rb
 - spec/lib/janus-ar/logging/logger_spec.rb
+- spec/lib/janus-ar/logging/subscriber_spec.rb
 - spec/lib/janus-ar/query_director_spec.rb
 - spec/shared_examples/a_mysql_like_server.rb
 - spec/spec_helper.rb
@@ -232,7 +237,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/olioex/janus-ar
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +251,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.2
 specification_version: 4
 summary: Read/Write proxy for ActiveRecord using primary/replica databases
 test_files: []