From c30aeafd9db40bfbd848430359285547a1b1f605 Mon Sep 17 00:00:00 2001
From: Alan Guo Xiang Tan <gxtan1990@gmail.com>
Date: Thu, 15 Feb 2024 16:36:12 +0800
Subject: [PATCH] DEV: Block all incoming requests before resetting Capybara
 session (#25692)

Why this change?

We have been debugging flaky system tests and noticed in https://github.com/discourse/discourse/actions/runs/7911902047/job/21596791343?pr=25690
that ActiveRecord connection checkout timeouts are encountered because
the Capybara server thread is processing requests even after
`Capybara.reset_session!` and ActiveRecord's `teardown_fixtures` have already been call.
The theory here is that an inflight request can still hit the Capybara
server even after `Capybara.reset_session!` has been called and end up
eating up an ActiveRecord connection for too long and also messing with
the database outside of a transaction.

What does this change do?

This change adds a `BlockRequestsMiddleware` middleware in the test
environment which is enabled to reject all incoming requests at the end
of each system test and before `Capybara.reset_session!` is called. At
the start of each RSpec test, the middleware is disabled again.
---
 config/initializers/200-first_middlewares.rb | 27 ++++++++++++++++++++
 spec/rails_helper.rb                         |  5 ++++
 2 files changed, 32 insertions(+)

diff --git a/config/initializers/200-first_middlewares.rb b/config/initializers/200-first_middlewares.rb
index ea011a6f8af..79bbb199040 100644
--- a/config/initializers/200-first_middlewares.rb
+++ b/config/initializers/200-first_middlewares.rb
@@ -28,8 +28,35 @@ if Rails.env.test?
       super(env)
     end
   end
+
   Rails.configuration.middleware.unshift TestMultisiteMiddleware,
                                          RailsMultisite::DiscoursePatches.config
+
+  class BlockRequestsMiddleware
+    @@block_requests = false
+
+    def self.block_requests!
+      @@block_requests = true
+    end
+
+    def self.allow_requests!
+      @@block_requests = false
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if @@block_requests
+        [503, { "Content-Type" => "text/plain" }, ["Blocked by BlockRequestsMiddleware"]]
+      else
+        @app.call(env)
+      end
+    end
+  end
+
+  Rails.configuration.middleware.unshift BlockRequestsMiddleware
 elsif Rails.configuration.multisite
   assets_hostnames = GlobalSetting.cdn_hostnames
 
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
index 67ec956addf..dbf92bd38a4 100644
--- a/spec/rails_helper.rb
+++ b/spec/rails_helper.rb
@@ -608,6 +608,7 @@ RSpec.configure do |config|
     driven_by driver.join("_").to_sym
 
     setup_system_test
+    BlockRequestsMiddleware.allow_requests!
   end
 
   config.after(:each, type: :system) do |example|
@@ -663,6 +664,10 @@ RSpec.configure do |config|
     end
 
     page.execute_script("if (typeof MessageBus !== 'undefined') { MessageBus.stop(); }")
+
+    # Block all incoming requests before resetting Capybara session which will wait for all requests to finish
+    BlockRequestsMiddleware.block_requests!
+
     Capybara.reset_session!
     MessageBus.backend_instance.reset! # Clears all existing backlog from memory backend
     Discourse.redis.flushdb