Merge pull request #934 from ahoppen/ahoppen/no-sendsync

Remove `SourceKitD.sendSync`

Author: ahoppen

Sources/SourceKitD/SourceKitD.swift

@@ -65,21 +65,6 @@ extension SourceKitD {
 
   // MARK: - Convenience API for requests.
 
-  /// Send the given request and synchronously receive a reply dictionary (or error).
-  public func sendSync(_ req: SKDRequestDictionary) throws -> SKDResponseDictionary {
-    logRequest(req)
-
-    let resp = SKDResponse(api.send_request_sync(req.dict), sourcekitd: self)
-
-    logResponse(resp)
-
-    guard let dict = resp.value else {
-      throw resp.error!
-    }
-
-    return dict
-  }
-
   public func send(_ req: SKDRequestDictionary) async throws -> SKDResponseDictionary {
     logRequest(req)
 

Sources/SourceKitLSP/Swift/CodeCompletionSession.swift

@@ -120,7 +120,7 @@ class CodeCompletionSession {
         }
         // The sessions aren't compatible. Close the existing session and open
         // a new one below.
-        session.close()
+        await session.close()
       }
       if mustReuse {
         logger.error("triggerFromIncompleteCompletions with no existing completion session")
@@ -264,7 +264,7 @@ class CodeCompletionSession {
     return dict
   }
 
-  private func close() {
+  private func close() async {
     switch self.state {
     case .closed:
       // Already closed, nothing to do.
@@ -275,7 +275,7 @@ class CodeCompletionSession {
       req[keys.offset] = self.utf8StartOffset
       req[keys.name] = self.snapshot.uri.pseudoPath
       logger.info("Closing code completion session: \(self, privacy: .private)")
-      _ = try? sourcekitd.sendSync(req)
+      _ = try? await sourcekitd.send(req)
       self.state = .closed
     }
   }

Sources/SourceKitLSP/Swift/SwiftLanguageServer.swift

@@ -259,10 +259,10 @@ extension SwiftLanguageServer {
   }
 
   /// Tell sourcekitd to crash itself. For testing purposes only.
-  public func _crash() {
+  public func _crash() async {
     let req = SKDRequestDictionary(sourcekitd: sourcekitd)
     req[sourcekitd.keys.request] = sourcekitd.requests.crash_exit
-    _ = try? sourcekitd.sendSync(req)
+    _ = try? await sourcekitd.send(req)
   }
 
   // MARK: - Build System Integration
@@ -276,7 +276,7 @@ extension SwiftLanguageServer {
     let closeReq = SKDRequestDictionary(sourcekitd: self.sourcekitd)
     closeReq[keys.request] = self.requests.editor_close
     closeReq[keys.name] = path
-    _ = try? self.sourcekitd.sendSync(closeReq)
+    _ = try? await self.sourcekitd.send(closeReq)
 
     let openReq = SKDRequestDictionary(sourcekitd: self.sourcekitd)
     openReq[keys.request] = self.requests.editor_open
@@ -286,7 +286,7 @@ extension SwiftLanguageServer {
       openReq[keys.compilerargs] = compileCmd.compilerArgs
     }
 
-    _ = try? self.sourcekitd.sendSync(openReq)
+    _ = try? await self.sourcekitd.send(openReq)
 
     publishDiagnosticsIfNeeded(for: snapshot.uri)
   }
@@ -336,7 +336,7 @@ extension SwiftLanguageServer {
       req[keys.compilerargs] = compilerArgs
     }
 
-    _ = try? self.sourcekitd.sendSync(req)
+    _ = try? await self.sourcekitd.send(req)
     publishDiagnosticsIfNeeded(for: note.textDocument.uri)
   }
 
@@ -354,7 +354,7 @@ extension SwiftLanguageServer {
     req[keys.request] = self.requests.editor_close
     req[keys.name] = uri.pseudoPath
 
-    _ = try? self.sourcekitd.sendSync(req)
+    _ = try? await self.sourcekitd.send(req)
   }
 
   /// Cancels any in-flight tasks to send a `PublishedDiagnosticsNotification` after edits.
@@ -422,46 +422,66 @@ extension SwiftLanguageServer {
     cancelInFlightPublishDiagnosticsTask(for: note.textDocument.uri)
 
     let keys = self.keys
-    var edits: [IncrementalEdit] = []
+    struct Edit {
+      let offset: Int
+      let length: Int
+      let replacement: String
+    }
+
+    var edits: [Edit] = []
 
     let editResult = self.documentManager.edit(note) {
       (before: LineTable, edit: TextDocumentContentChangeEvent) in
-      let req = SKDRequestDictionary(sourcekitd: self.sourcekitd)
-      req[keys.request] = self.requests.editor_replacetext
-      req[keys.name] = note.textDocument.uri.pseudoPath
-      req[keys.syntactic_only] = 1
-
       if let range = edit.range {
         guard let offset = before.utf8OffsetOf(line: range.lowerBound.line, utf16Column: range.lowerBound.utf16index),
           let end = before.utf8OffsetOf(line: range.upperBound.line, utf16Column: range.upperBound.utf16index)
         else {
           fatalError("invalid edit \(range)")
         }
-
-        let length = end - offset
-        req[keys.offset] = offset
-        req[keys.length] = length
-
-        edits.append(IncrementalEdit(offset: offset, length: length, replacementLength: edit.text.utf8.count))
+        edits.append(
+          Edit(
+            offset: offset,
+            length: end - offset,
+            replacement: edit.text
+          )
+        )
       } else {
-        // Full text
-        let length = before.content.utf8.count
-        req[keys.offset] = 0
-        req[keys.length] = length
-
-        edits.append(IncrementalEdit(offset: 0, length: length, replacementLength: edit.text.utf8.count))
+        edits.append(
+          Edit(
+            offset: 0,
+            length: before.content.utf8.count,
+            replacement: edit.text
+          )
+        )
       }
-
-      req[keys.sourcetext] = edit.text
-      _ = try? self.sourcekitd.sendSync(req)
     }
+    for edit in edits {
+      let req = SKDRequestDictionary(sourcekitd: self.sourcekitd)
+      req[keys.request] = self.requests.editor_replacetext
+      req[keys.name] = note.textDocument.uri.pseudoPath
+      req[keys.syntactic_only] = 1
+      req[keys.offset] = edit.offset
+      req[keys.length] = edit.length
+      req[keys.sourcetext] = edit.replacement
+      do {
+        _ = try await self.sourcekitd.send(req)
+      } catch {
+        fatalError("failed to apply edit")
+      }
+    }
+
     guard let (preEditSnapshot, postEditSnapshot) = editResult else {
       return
     }
+    let concurrentEdits = ConcurrentEdits(
+      fromSequential: edits.map {
+        IncrementalEdit(offset: $0.offset, length: $0.length, replacementLength: $0.replacement.utf8.count)
+      }
+    )
     await syntaxTreeManager.registerEdit(
       preEditSnapshot: preEditSnapshot,
       postEditSnapshot: postEditSnapshot,
-      edits: ConcurrentEdits(fromSequential: edits)
+      edits: concurrentEdits
     )
 
     publishDiagnosticsIfNeeded(for: note.textDocument.uri)

Tests/SourceKitDTests/SourceKitDTests.swift

@@ -36,7 +36,7 @@ final class SourceKitDTests: XCTestCase {
       .trimmingCharacters(in: .whitespacesAndNewlines)
   }
 
-  func testMultipleNotificationHandlers() throws {
+  func testMultipleNotificationHandlers() async throws {
     let sourcekitd = try SourceKitDImpl.getOrCreate(dylibPath: SourceKitDTests.sourcekitdPath)
     let keys = sourcekitd.keys
     let path = DocumentURI.for(.swift).pseudoPath
@@ -88,14 +88,14 @@ final class SourceKitDTests: XCTestCase {
     args.append(path)
     req[keys.compilerargs] = args
 
-    _ = try sourcekitd.sendSync(req)
+    _ = try await sourcekitd.send(req)
 
-    waitForExpectations(timeout: defaultTimeout)
+    try await fulfillmentOfOrThrow([expectation1, expectation2])
 
     let close = SKDRequestDictionary(sourcekitd: sourcekitd)
     close[keys.request] = sourcekitd.requests.editor_close
     close[keys.name] = path
-    _ = try sourcekitd.sendSync(close)
+    _ = try await sourcekitd.send(close)
   }
 }