Rename TestSourceKitLSPClient.handleNextRequest to handleSingleRequest

Since `handleNextRequest` handling doesn’t have to be in the order that the request handlers were specified anymore, the naming was misleading.

Author: ahoppen

Sources/SKTestSupport/TestSourceKitLSPClient.swift

@@ -147,7 +147,7 @@ public final class TestSourceKitLSPClient: MessageHandler {
         throw ConflictingDiagnosticsError()
       }
       capabilities.textDocument!.diagnostic = .init(dynamicRegistration: true)
-      self.handleNextRequest { (request: RegisterCapabilityRequest) in
+      self.handleSingleRequest { (request: RegisterCapabilityRequest) in
         XCTAssertEqual(request.registrations.only?.method, DocumentDiagnosticsRequest.method)
         return VoidResponse()
       }
@@ -258,22 +258,17 @@ public final class TestSourceKitLSPClient: MessageHandler {
     }
   }
 
-  /// Handle the next request that is sent to the client with the given handler.
+  /// Handle the next request of the given type that is sent to the client.
   ///
-  /// By default, `TestSourceKitLSPClient` emits an `XCTFail` if a request is sent
-  /// to the client, since it doesn't know how to handle it. This allows the
-  /// simulation of a single request's handling on the client.
-  ///
-  /// If the next request that is sent to the client is of a different kind than
-  /// the given handler, `TestSourceKitLSPClient` will emit an `XCTFail`.
-  public func handleNextRequest<R: RequestType>(_ requestHandler: @escaping RequestHandler<R>) {
+  /// The request handler will only handle a single request. If the request is called again, the request handler won't
+  /// call again
+  public func handleSingleRequest<R: RequestType>(_ requestHandler: @escaping RequestHandler<R>) {
     requestHandlers.value.append(requestHandler)
   }
 
   // MARK: - Conformance to MessageHandler
 
-  /// - Important: Implementation detail of `TestSourceKitLSPServer`. Do not call
-  ///   from tests.
+  /// - Important: Implementation detail of `TestSourceKitLSPServer`. Do not call from tests.
   public func handle(_ params: some NotificationType) {
     notificationYielder.yield(params)
   }

Tests/SourceKitDTests/CrashRecoveryTests.swift

@@ -75,7 +75,7 @@ final class CrashRecoveryTests: XCTestCase {
       "Sanity check failed. The Hover response did not contain foo(), even before crashing sourcekitd. Received response: \(String(describing: preCrashHoverResponse))"
     )
 
-    testClient.handleNextRequest { (request: CreateWorkDoneProgressRequest) -> VoidResponse in
+    testClient.handleSingleRequest { (request: CreateWorkDoneProgressRequest) -> VoidResponse in
       return VoidResponse()
     }
 

Tests/SourceKitLSPTests/BackgroundIndexingTests.swift

@@ -346,7 +346,7 @@ final class BackgroundIndexingTests: XCTestCase {
       capabilities: ClientCapabilities(window: WindowClientCapabilities(workDoneProgress: true)),
       serverOptions: backgroundIndexingOptions,
       preInitialization: { testClient in
-        testClient.handleNextRequest { (request: CreateWorkDoneProgressRequest) in
+        testClient.handleSingleRequest { (request: CreateWorkDoneProgressRequest) in
           workDoneProgressCreated.fulfill()
           return VoidResponse()
         }
@@ -577,7 +577,8 @@ final class BackgroundIndexingTests: XCTestCase {
     )
 
     let receivedEmptyDiagnostics = self.expectation(description: "Received diagnostic refresh request")
-    project.testClient.handleNextRequest { (_: DiagnosticsRefreshRequest) in
+
+    project.testClient.handleSingleRequest { (_: DiagnosticsRefreshRequest) in
       Task {
         let updatedDiagnostics = try await project.testClient.send(
           DocumentDiagnosticsRequest(textDocument: TextDocumentIdentifier(uri))

Tests/SourceKitLSPTests/CodeActionTests.swift

@@ -470,7 +470,7 @@ final class CodeActionTests: XCTestCase {
 
     let editReceived = self.expectation(description: "Received ApplyEdit request")
 
-    testClient.handleNextRequest { (request: ApplyEditRequest) -> ApplyEditResponse in
+    testClient.handleSingleRequest { (request: ApplyEditRequest) -> ApplyEditResponse in
       defer {
         editReceived.fulfill()
       }

Tests/SourceKitLSPTests/DefinitionTests.swift

@@ -414,7 +414,7 @@ class DefinitionTests: XCTestCase {
     // Wait until SourceKit-LSP has handled the `DidChangeWatchedFilesNotification` (which it only does after a delay
     // because it debounces these notifications), indicated by it telling us that we should refresh diagnostics.
     let diagnosticRefreshRequestReceived = self.expectation(description: "DiagnosticsRefreshRequest received")
-    project.testClient.handleNextRequest { (request: DiagnosticsRefreshRequest) in
+    project.testClient.handleSingleRequest { (request: DiagnosticsRefreshRequest) in
       diagnosticRefreshRequestReceived.fulfill()
       return VoidResponse()
     }
@@ -489,7 +489,7 @@ class DefinitionTests: XCTestCase {
     // Wait until SourceKit-LSP has handled the `DidChangeWatchedFilesNotification` (which it only does after a delay
     // because it debounces these notifications), indicated by it telling us that we should refresh diagnostics.
     let diagnosticRefreshRequestReceived = self.expectation(description: "DiagnosticsRefreshRequest received")
-    project.testClient.handleNextRequest { (request: DiagnosticsRefreshRequest) in
+    project.testClient.handleSingleRequest { (request: DiagnosticsRefreshRequest) in
       diagnosticRefreshRequestReceived.fulfill()
       return VoidResponse()
     }

Tests/SourceKitLSPTests/ExecuteCommandTests.swift

@@ -44,7 +44,7 @@ final class ExecuteCommandTests: XCTestCase {
 
     let request = ExecuteCommandRequest(command: command.command, arguments: command.arguments)
 
-    testClient.handleNextRequest { (req: ApplyEditRequest) -> ApplyEditResponse in
+    testClient.handleSingleRequest { (req: ApplyEditRequest) -> ApplyEditResponse in
       return ApplyEditResponse(applied: true, failureReason: nil)
     }
 
@@ -100,7 +100,7 @@ final class ExecuteCommandTests: XCTestCase {
 
     let request = ExecuteCommandRequest(command: command.command, arguments: command.arguments)
 
-    testClient.handleNextRequest { (req: ApplyEditRequest) -> ApplyEditResponse in
+    testClient.handleSingleRequest { (req: ApplyEditRequest) -> ApplyEditResponse in
       return ApplyEditResponse(applied: true, failureReason: nil)
     }
 

Tests/SourceKitLSPTests/LocalClangTests.swift

@@ -201,7 +201,7 @@ final class LocalClangTests: XCTestCase {
     XCTAssertEqual(command.command, "clangd.applyTweak")
 
     let applyEdit = XCTestExpectation(description: "applyEdit")
-    testClient.handleNextRequest { (request: ApplyEditRequest) -> ApplyEditResponse in
+    testClient.handleSingleRequest { (request: ApplyEditRequest) -> ApplyEditResponse in
       XCTAssertNotNil(request.edit.changes)
       applyEdit.fulfill()
       return ApplyEditResponse(applied: true, failureReason: nil)

Tests/SourceKitLSPTests/PullDiagnosticsTests.swift

@@ -161,7 +161,7 @@ final class PullDiagnosticsTests: XCTestCase {
     XCTAssert(fullReportBeforeChangingFileA.items.contains(where: { $0.message == "Cannot find 'sayHello' in scope" }))
 
     let diagnosticsRefreshRequestReceived = self.expectation(description: "DiagnosticsRefreshRequest received")
-    project.testClient.handleNextRequest { (request: DiagnosticsRefreshRequest) in
+    project.testClient.handleSingleRequest { (request: DiagnosticsRefreshRequest) in
       diagnosticsRefreshRequestReceived.fulfill()
       return VoidResponse()
     }
@@ -224,7 +224,7 @@ final class PullDiagnosticsTests: XCTestCase {
     XCTAssert(fullReportBeforeBuilding.items.contains(where: { $0.message == "No such module 'LibA'" }))
 
     let diagnosticsRefreshRequestReceived = self.expectation(description: "DiagnosticsRefreshRequest received")
-    project.testClient.handleNextRequest { (request: DiagnosticsRefreshRequest) in
+    project.testClient.handleSingleRequest { (request: DiagnosticsRefreshRequest) in
       diagnosticsRefreshRequestReceived.fulfill()
       return VoidResponse()
     }

Tests/SourceKitLSPTests/SemanticTokensTests.swift

@@ -71,7 +71,7 @@ final class SemanticTokensTests: XCTestCase {
     // We will wait for the server to dynamically register semantic tokens
 
     let registerCapabilityExpectation = expectation(description: "\(#function) - register semantic tokens capability")
-    testClient.handleNextRequest { (req: RegisterCapabilityRequest) -> VoidResponse in
+    testClient.handleSingleRequest { (req: RegisterCapabilityRequest) -> VoidResponse in
       let capabilityRegistration = req.registrations.first { reg in
         reg.method == SemanticTokensRegistrationOptions.method
       }