From 54025b38704346e1cffdecd3f2c890ad48cbda88 Mon Sep 17 00:00:00 2001
From: Charles Oliver Nutter <headius@headius.com>
Date: Mon, 9 Dec 2024 23:40:27 -0600
Subject: [PATCH] Don't double-interrupt the test HTTP server

The shutdown process here attempted to terminate the test server
by interrupting it with Thread#kill, and then proceeded to close
the server and join the thread. The kill does indeed interrupt
the accept call, but the close call could also interrupt the
thread as part of notifying blocked threads waiting on that
socket call.

In JRuby, where all of this can happen at the same time, it leads
to the following scenario:

* The server thread enters TCPServer#accept and blocks.
* The main thread calls Thread#kill to interrupt the accept call.
* The server thread wakes up and starts to propagate the kill.
  There is a slight delay between this wakeup and removing the
  server thread from the TCPServer's blocked threads list.
* The main thread calls TCPServer#close, which sees that the server
  thread is still in the blocked list, so it initiates a second
  interrupt to raise IOError "closed in another thread" on the
  server thread.
* As the kill is bubbling out, another check for interrupts occurs,
  causing it to see the new raise interrupt and propagate that
  instead of the active kill.
* Because the server is now closed and the rescue here is empty,
  the server loop will endlessly attempt and fail to call accept.

I was unable to determine how CRuby avoids this race. There may be
code that prevents an active kill interrupt from triggering
further interrupts.

In order to get these tests running on JRuby, I've made the
following changes:

* Only kill the thread; one interrupt is sufficient to break it
  out of the accept call.
* Ensure outside the server loop that the server gets closed. This
  happens within the server thread, so triggers no new interrupts.
* Minor cleanup for the pattern of using @ssl_server or @server.

This change avoids the race in JRuby (and possibly other parallel-
threaded implementations) and does not impact the behavior of the
tests.
---
 test/net/http/utils.rb | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/test/net/http/utils.rb b/test/net/http/utils.rb
index 1d43497..b41341d 100644
--- a/test/net/http/utils.rb
+++ b/test/net/http/utils.rb
@@ -27,12 +27,14 @@ def initialize(config, &block)
     def start
       @thread = Thread.new do
         loop do
-          socket = @ssl_server ? @ssl_server.accept : @server.accept
+          socket = (@ssl_server || @server).accept
           run(socket)
         rescue
         ensure
-          socket.close if socket
+          socket&.close
         end
+      ensure
+        (@ssl_server || @server).close
       end
     end
 
@@ -42,7 +44,6 @@ def run(socket)
 
     def shutdown
       @thread&.kill
-      @server&.close
       @thread&.join
     end