Merge pull request rails#43546 from Shopify/as-test-case-executor-wrap

Call Executor#wrap around each test

Author: byroot

activerecord/lib/active_record/query_logs/test_helper.rb

@@ -380,11 +380,6 @@ class Railtie < Rails::Railtie # :nodoc:
           app.reloader.before_class_unload { ActiveRecord::QueryLogs.clear_context }
           app.executor.to_run              { ActiveRecord::QueryLogs.clear_context }
           app.executor.to_complete         { ActiveRecord::QueryLogs.clear_context }
-
-          ActiveSupport.on_load(:active_support_test_case) do
-            require "active_record/query_logs/test_helper"
-            include ActiveRecord::QueryLogs::TestHelper
-          end
         end
       end
     end

activerecord/lib/active_record/railtie.rb

@@ -2,19 +2,19 @@
 
 require "cases/helper"
 require "models/dashboard"
-require "active_record/query_logs/test_helper"
 
 class QueryLogsTest < ActiveRecord::TestCase
-  # Automatically included in Rails apps via railtie but that don't run here.
-  include ActiveRecord::QueryLogs::TestHelper
-
   fixtures :dashboards
 
   ActiveRecord::QueryLogs.taggings[:application] = -> {
     "active_record"
   }
 
   def setup
+    # QueryLogs context is automatically reset in Rails app via an executor hooks set in railtie
+    # But not in Active Record's own test suite.
+    ActiveRecord::QueryLogs.clear_context
+
     # Enable the query tags logging
     @original_transformers = ActiveRecord.query_transformers
     @original_prepend = ActiveRecord::QueryLogs.prepend_comment
@@ -28,6 +28,9 @@ def teardown
     ActiveRecord.query_transformers = @original_transformers
     ActiveRecord::QueryLogs.prepend_comment = @original_prepend
     ActiveRecord::QueryLogs.tags = []
+    # QueryLogs context is automatically reset in Rails app via an executor hooks set in railtie
+    # But not in Active Record's own test suite.
+    ActiveRecord::QueryLogs.clear_context
   end
 
   def test_escaping_good_comment

activerecord/test/cases/query_logs_test.rb

@@ -1,3 +1,9 @@
+*   `Rails.application.executor` hooks are now called around every tests.
+
+    This helps to better simulate request or job local state being reset.
+
+    *Jean Boussier*
+
 *   Fix the `Digest::UUID.uuid_from_hash` behavior for namespace IDs that are different from the ones defined on `Digest::UUID`.
 
     The new behavior will be enabled by setting the

activesupport/CHANGELOG.md

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveSupport::Executor::TestHelper # :nodoc:
+  def run(...)
+    Rails.application.executor.wrap { super }
+  end
+end

activesupport/lib/active_support/current_attributes/test_helper.rb

@@ -33,8 +33,8 @@ class Railtie < Rails::Railtie # :nodoc:
       app.executor.to_complete         { ActiveSupport::CurrentAttributes.reset_all }
 
       ActiveSupport.on_load(:active_support_test_case) do
-        require "active_support/current_attributes/test_helper"
-        include ActiveSupport::CurrentAttributes::TestHelper
+        require "active_support/executor/test_helper"
+        include ActiveSupport::Executor::TestHelper
       end
     end
 

activesupport/lib/active_support/executor/test_helper.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
 require_relative "abstract_unit"
-require "active_support/current_attributes/test_helper"
 
 class CurrentAttributesTest < ActiveSupport::TestCase
-  # Automatically included in Rails apps via railtie but that don't run here.
-  include ActiveSupport::CurrentAttributes::TestHelper
+  # CurrentAttributes is automatically reset in Rails app via executor hooks set in railtie
+  # But not in Active Support's own test suite.
+  setup do
+    ActiveSupport::CurrentAttributes.reset_all
+  end
+
+  teardown do
+    ActiveSupport::CurrentAttributes.reset_all
+  end
 
   Person = Struct.new(:id, :name, :time_zone)