Active Record Trilogy Adapter needs to intercept #raw_execute (#494)

* Update lockfiles for Trilogy; use the Trilogy adapter in rails

* Active Record Trilogy Adapter needs to intercept `#raw_execute`

Changes made to Rails (rails/rails@f69bbcb)
mean that most database methods no longer use the public `#execute` method
and go through `#raw_execute` instead.

* Fix Trilogy tests that now trigger circuit breaker

These tests call `connect!` in a background thread, which previously would not acquire
a resource other than the connection-scoped one. This means that
once the latency had passed, the background thread would finish calling
`#connect!` successfully, and subsequent attempts to connect would trigger
the circuit breaker.

However, with the changes to Rails, `#connect!` now calls `#raw_execute`,
which is circuit broken. Thus, when the background thread's latency has passed,
we'll see a `TrilogyAdapter::CircuitOpenError`.

Author: adrianna-chang-shopify

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Unreleased
 
-Nil
+* Active Record Trilogy adapter needs to patch `#raw_execute` instead of `#execute` for queries. (#494)
 
 # v0.19.0
 

Gemfile

@@ -17,9 +17,8 @@ group :test do
   # The last stable version for MacOS ARM darwin
   gem "grpc", "1.47.0"
   gem "mysql2", "~> 0.5"
-  gem "trilogy", github: "github/trilogy", branch: "main", glob: "contrib/ruby/*.gemspec"
+  gem "trilogy", "~> 2.4"
   gem "activerecord", github: "rails/rails", branch: "main"
-  gem "activerecord-trilogy-adapter", github: "github/activerecord-trilogy-adapter", branch: "main"
   gem "hiredis", "~> 0.6"
   # NOTE: v0.12.0 required for ruby 3.2.0. https://github.com/redis-rb/redis-client/issues/58
   gem "hiredis-client", ">= 0.12.0"

Gemfile.lock

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "activerecord-trilogy-adapter"
 require "semian"
 require "semian/activerecord_trilogy_adapter"
 require_relative "../colors"

examples/activerecord_trilogy_adapter/00_circuit_minimal.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "activerecord-trilogy-adapter"
 require "semian"
 require "semian/activerecord_trilogy_adapter"
 require_relative "../colors"

examples/activerecord_trilogy_adapter/03_circuit_open.rb

@@ -9,8 +9,7 @@ gem "mocha"
 gem "toxiproxy"
 gem "webrick"
 
-gem "trilogy", github: "github/trilogy", branch: "main", glob: "contrib/ruby/*.gemspec"
-gem "activerecord-trilogy-adapter", github: "github/activerecord-trilogy-adapter", branch: "main"
+gem "trilogy", "~> 2.4"
 gem "activerecord", github: "rails/rails"
 
 gemspec path: "../"

gemfiles/activerecord_trilogy_adapter.gemfile

@@ -9,7 +9,7 @@ gem "mocha"
 gem "toxiproxy"
 gem "webrick"
 
-gem "trilogy", github: "github/trilogy", branch: "main", glob: "contrib/ruby/*.gemspec"
+gem "trilogy", "~> 2.4"
 # we can share the Gemfile with rails mysql2 once activerecord is released with the trilogy adapter
 gem "activerecord", github: "rails/rails", branch: "main"
 

gemfiles/activerecord_trilogy_adapter.gemfile.lock

@@ -47,16 +47,16 @@ def initialize(*options)
       super
     end
 
-    def execute(sql, *)
+    def raw_execute(sql, *)
       if query_allowlisted?(sql)
         super
       else
-        acquire_semian_resource(adapter: :trilogy_adapter, scope: :execute) do
+        acquire_semian_resource(adapter: :trilogy_adapter, scope: :query) do
           super
         end
       end
     end
-    ruby2_keywords :execute
+    ruby2_keywords :raw_execute
 
     def active?
       acquire_semian_resource(adapter: :trilogy_adapter, scope: :ping) do

gemfiles/rails_trilogy.gemfile

@@ -155,7 +155,7 @@ def test_query_instrumentation
 
           assert_equal(:success, event)
           assert_equal(Semian[:mysql_testing], resource)
-          assert_equal(:execute, scope)
+          assert_equal(:query, scope)
           assert_equal(:trilogy_adapter, adapter)
         end
 
@@ -228,7 +228,9 @@ def test_resource_acquisition_for_query
 
       def test_resource_timeout_on_connect
         @proxy.downstream(:latency, latency: 500).apply do
-          background { @adapter.connect! }
+          background do
+            assert_raises(TrilogyAdapter::CircuitOpenError) { @adapter.connect! }
+          end
 
           assert_raises(TrilogyAdapter::ResourceBusyError) do
             trilogy_adapter.send(:connect) # Avoid going through connect!, which will call #active?
@@ -238,7 +240,9 @@ def test_resource_timeout_on_connect
 
       def test_circuit_breaker_on_connect
         @proxy.downstream(:latency, latency: 500).apply do
-          background { @adapter.connect! }
+          background do
+            assert_raises(TrilogyAdapter::CircuitOpenError) { @adapter.connect! }
+          end
 
           ERROR_THRESHOLD.times do
             assert_raises(TrilogyAdapter::ResourceBusyError) do
@@ -249,10 +253,6 @@ def test_circuit_breaker_on_connect
 
         yield_to_background
 
-        assert_raises(TrilogyAdapter::CircuitOpenError) do
-          trilogy_adapter.connect!
-        end
-
         time_travel(ERROR_TIMEOUT + 1) do
           trilogy_adapter.connect!
         end
@@ -385,7 +385,7 @@ def test_changes_timeout_when_half_open_and_configured
       end
 
       def test_trilogy_default_read_timeout
-        client = Trilogy.new(@configuration.slice(:username, :host, :port))
+        client = ::Trilogy.new(@configuration.slice(:username, :host, :port))
 
         assert_equal(0, client.read_timeout)
       end