Add mutex to server requests in tests

Author: vinistock

test/ruby_lsp_rails/code_lens_test.rb

@@ -401,9 +401,7 @@ def index
       attr_reader :ruby
 
       def generate_code_lens_for_source(source, file: "/fake.rb")
-        with_server(source, URI(file)) do |server, uri|
-          wait_for_rails_addon_activation
-
+        with_locked_server(source, URI(file)) do |server, uri|
           server.process_message(
             id: 1,
             method: "textDocument/codeLens",

test/ruby_lsp_rails/definition_test.rb

@@ -224,9 +224,7 @@ def baz; end
       private
 
       def generate_definitions_for_source(source, position)
-        with_server(source) do |server, uri|
-          wait_for_rails_addon_activation
-
+        with_locked_server(source) do |server, uri|
           server.process_message(
             id: 1,
             method: "textDocument/definition",

test/ruby_lsp_rails/document_symbol_test.rb

@@ -430,9 +430,7 @@ class FooModel < ApplicationRecord
       private
 
       def generate_document_symbols_for_source(source)
-        with_server(source) do |server, uri|
-          wait_for_rails_addon_activation
-
+        with_locked_server(source) do |server, uri|
           server.process_message(
             id: 1,
             method: "textDocument/documentSymbol",

test/ruby_lsp_rails/hover_test.rb

@@ -187,9 +187,7 @@ class User < ApplicationRecord
       private
 
       def hover_on_source(source, position)
-        with_server(source, stub_no_typechecker: true) do |server, uri|
-          wait_for_rails_addon_activation
-
+        with_locked_server(source, stub_no_typechecker: true) do |server, uri|
           server.process_message(
             id: 1,
             method: "textDocument/hover",

test/test_helper.rb

@@ -32,11 +32,40 @@ class TestCase
     extend T::Sig
     include RubyLsp::TestHelper
 
+    @server_mutex = T.let(Mutex.new, Mutex)
+
+    class << self
+      extend T::Sig
+
+      sig { returns(Mutex) }
+      attr_reader :server_mutex
+    end
+
     sig { returns(String) }
     def dummy_root
       File.expand_path("#{__dir__}/dummy")
     end
 
+    # Run requests under a mutex lock to prevent add-on concurrency issues
+    sig do
+      type_parameters(:T)
+        .params(
+          source: String,
+          uri: URI::Generic,
+          stub_no_typechecker: T::Boolean,
+          block: T.proc.params(server: RubyLsp::Server, uri: URI::Generic).returns(T.type_parameter(:T)),
+        ).returns(T.type_parameter(:T))
+    end
+    def with_locked_server(source, uri = URI("file:///fake.rb"), stub_no_typechecker: false, &block)
+      TestCase.server_mutex.synchronize do
+        with_server(source, uri, stub_no_typechecker: stub_no_typechecker) do |server, uri|
+          wait_for_rails_addon_activation
+
+          block.call(server, uri)
+        end
+      end
+    end
+
     sig { void }
     def wait_for_rails_addon_activation
       Thread.new do