Add the textEdit parameter to code completion responses

Author: ahoppen

Sources/SourceKit/sourcekitd/SwiftLanguageServer.swift

@@ -373,7 +373,7 @@ extension SwiftLanguageServer {
             return true // continue
           }
 
-          let filterName: String? = value[self.keys.name]
+          var filterName: String? = value[self.keys.name]
           let insertText: String? = value[self.keys.sourcetext]
           let typeName: String? = value[self.keys.typename]
 
@@ -384,13 +384,35 @@ extension SwiftLanguageServer {
           }
           let isInsertTextSnippet = clientSupportsSnippets && text != insertText
 
+          let textEdit: TextEdit?
+          if let text = text {
+            let bytesToErase: Int = value[self.keys.num_bytes_to_erase] ?? 0
+            assert(bytesToErase <= completionPos.utf16index, "Deleting more bytes than are in the current line")
+            let textEditRangeStart = Position(line: completionPos.line, utf16index: completionPos.utf16index - bytesToErase)
+            textEdit = TextEdit(range: textEditRangeStart..<req.params.position, newText: text)
+
+            if bytesToErase != 0 && filterName != nil {
+              // To support the case where the client is doing prefix matching on the TextEdit range,
+              // we need to prepend the deleted text to filterText.
+              // This also works around a behaviour in VS Code that causes completions to not show up
+              // if a '.' is being replaced for Optional completion.
+              let line = snapshot.lineTable[completionPos.line]
+              let startIndex = line.utf16.index(line.startIndex, offsetBy: textEditRangeStart.utf16index)
+              let endIndex = line.utf16.index(startIndex, offsetBy: bytesToErase)
+              let filterPrefix = line[startIndex..<endIndex]
+              filterName = filterPrefix + filterName!
+            }
+          } else {
+            textEdit = nil
+          }
+
           let kind: sourcekitd_uid_t? = value[self.keys.kind]
           result.items.append(CompletionItem(
             label: name,
             detail: typeName,
             sortText: nil,
             filterText: filterName,
-            textEdit: nil,
+            textEdit: textEdit,
             insertText: text,
             insertTextFormat: isInsertTextSnippet ? .snippet : .plain,
             kind: kind?.asCompletionItemKind(self.values) ?? .value,

Sources/SourceKit/sourcekitd/SwiftSourceKitFramework.swift

@@ -241,6 +241,14 @@ struct sourcekitd_keys {
   let edits: sourcekitd_uid_t
   let text: sourcekitd_uid_t
 
+  // Code Completion related keys.
+  let context: sourcekitd_uid_t
+  let doc: sourcekitd_uid_t
+  let not_recommended: sourcekitd_uid_t
+  let num_bytes_to_erase: sourcekitd_uid_t
+  let associated_usrs: sourcekitd_uid_t
+
+
   init(api: sourcekitd_functions_t) {
     request = api.uid_get_from_cstr("key.request")!
     compilerargs = api.uid_get_from_cstr("key.compilerargs")!
@@ -280,6 +288,13 @@ struct sourcekitd_keys {
     categorizededits = api.uid_get_from_cstr("key.categorizededits")!
     edits = api.uid_get_from_cstr("key.edits")!
     text = api.uid_get_from_cstr("key.text")!
+
+    // Code Completion related keys.
+    context = api.uid_get_from_cstr("key.context")!
+    doc = api.uid_get_from_cstr("key.doc.brief")!
+    not_recommended = api.uid_get_from_cstr("key.not_recommended")!
+    num_bytes_to_erase = api.uid_get_from_cstr("key.num_bytes_to_erase")!
+    associated_usrs = api.uid_get_from_cstr("key.associated_usrs")!
   }
 }
 

Tests/SourceKitTests/SourceKitTests.swift

@@ -156,7 +156,7 @@ final class SKTests: XCTestCase {
         detail: "Void",
         sortText: nil,
         filterText: "method(a:)",
-        textEdit: nil,
+        textEdit: TextEdit(range: Position(line: 1, utf16index: 14)..<Position(line: 1, utf16index: 14), newText: "method(a: )"),
         insertText: "method(a: )",
         insertTextFormat: .plain,
         kind: .method,
@@ -166,7 +166,7 @@ final class SKTests: XCTestCase {
         detail: "A",
         sortText: nil,
         filterText: "self",
-        textEdit: nil,
+        textEdit: TextEdit(range: Position(line: 1, utf16index: 14)..<Position(line: 1, utf16index: 14), newText: "self"),
         insertText: "self",
         insertTextFormat: .plain,
         kind: .keyword,

Tests/SourceKitTests/SwiftCompletionTests.swift

@@ -101,8 +101,7 @@ final class SwiftCompletionTests: XCTestCase {
       XCTAssertEqual(abc.kind, .property)
       XCTAssertEqual(abc.detail, "Int")
       XCTAssertEqual(abc.filterText, "abc")
-      // FIXME:
-      XCTAssertNil(abc.textEdit)
+      XCTAssertEqual(abc.textEdit, TextEdit(range: Position(line: 4, utf16index: 9)..<Position(line: 4, utf16index: 9), newText: "abc"))
       XCTAssertEqual(abc.insertText, "abc")
       XCTAssertEqual(abc.insertTextFormat, .plain)
     }
@@ -111,8 +110,18 @@ final class SwiftCompletionTests: XCTestCase {
       let inIdent = try! sk.sendSync(CompletionRequest(
         textDocument: TextDocumentIdentifier(url),
         position: Position(line: 4, utf16index: col)))
+      guard let abc = inIdent.items.first(where: { $0.label == "abc" }) else {
+        XCTFail("No completion item with label 'abc'")
+        return
+      }
+
       // If we switch to server-side filtering this will change.
-      XCTAssertEqual(inIdent, selfDot)
+      XCTAssertEqual(abc.kind, .property)
+      XCTAssertEqual(abc.detail, "Int")
+      XCTAssertEqual(abc.filterText, "abc")
+      XCTAssertEqual(abc.textEdit, TextEdit(range: Position(line: 4, utf16index: 9)..<Position(line: 4, utf16index: col), newText: "abc"))
+      XCTAssertEqual(abc.insertText, "abc")
+      XCTAssertEqual(abc.insertTextFormat, .plain)
     }
 
     let after = try! sk.sendSync(CompletionRequest(
@@ -150,8 +159,7 @@ final class SwiftCompletionTests: XCTestCase {
       XCTAssertEqual(test.kind, .method)
       XCTAssertEqual(test.detail, "Void")
       XCTAssertEqual(test.filterText, "test(a:)")
-      // FIXME:
-      XCTAssertNil(test.textEdit)
+        XCTAssertEqual(test.textEdit, TextEdit(range: Position(line: 4, utf16index: 9)..<Position(line: 4, utf16index: 9), newText: "test(a: ${1:Int})"))
       XCTAssertEqual(test.insertText, "test(a: ${1:Int})")
       XCTAssertEqual(test.insertTextFormat, .snippet)
     }
@@ -162,8 +170,7 @@ final class SwiftCompletionTests: XCTestCase {
       XCTAssertEqual(test.kind, .method)
       XCTAssertEqual(test.detail, "Void")
       XCTAssertEqual(test.filterText, "test(:)")
-      // FIXME:
-      XCTAssertNil(test.textEdit)
+      XCTAssertEqual(test.textEdit, TextEdit(range: Position(line: 8, utf16index: 9)..<Position(line: 8, utf16index: 9), newText: "test(${1:b: Int})"))
       XCTAssertEqual(test.insertText, "test(${1:b: Int})")
       XCTAssertEqual(test.insertTextFormat, .snippet)
     }
@@ -179,8 +186,7 @@ final class SwiftCompletionTests: XCTestCase {
       XCTAssertEqual(test.kind, .method)
       XCTAssertEqual(test.detail, "Void")
       XCTAssertEqual(test.filterText, "test(a:)")
-      // FIXME:
-      XCTAssertNil(test.textEdit)
+      XCTAssertEqual(test.textEdit, TextEdit(range: Position(line: 4, utf16index: 9)..<Position(line: 4, utf16index: 9), newText: "test(a: )"))
       XCTAssertEqual(test.insertText, "test(a: )")
       XCTAssertEqual(test.insertTextFormat, .plain)
     }
@@ -192,7 +198,7 @@ final class SwiftCompletionTests: XCTestCase {
       XCTAssertEqual(test.detail, "Void")
       XCTAssertEqual(test.filterText, "test(:)")
       // FIXME:
-      XCTAssertNil(test.textEdit)
+        XCTAssertEqual(test.textEdit, TextEdit(range: Position(line: 8, utf16index: 9)..<Position(line: 8, utf16index: 9), newText: "test()"))
       XCTAssertEqual(test.insertText, "test()")
       XCTAssertEqual(test.insertTextFormat, .plain)
     }
@@ -221,4 +227,30 @@ final class SwiftCompletionTests: XCTestCase {
       position: Position(line: 1, utf16index: 0)))
     XCTAssertTrue(outOfRange2.isIncomplete)
   }
+
+  func testCompletionOptional() {
+    initializeServer()
+    let url = URL(fileURLWithPath: "/a.swift")
+    let text = """
+    struct Foo {
+      let bar: Int
+    }
+    let a: Foo? = Foo(bar: 1)
+    a.ba
+    """
+    openDocument(text: text, url: url)
+
+    for col in 2...4 {
+      let response = try! sk.sendSync(CompletionRequest(
+        textDocument: TextDocumentIdentifier(url),
+        position: Position(line: 4, utf16index: col)))
+      XCTAssertFalse(response.isIncomplete)
+      guard let item = response.items.first(where: { $0.label == "bar" }) else {
+        XCTFail("No completion item with label 'bar'")
+        return
+      }
+      XCTAssertEqual(item.filterText, ".bar")
+      XCTAssertEqual(item.textEdit, TextEdit(range: Position(line: 4, utf16index: 1)..<Position(line: 4, utf16index: col), newText: "?.bar"))
+    }
+  }
 }

Tests/SourceKitTests/SwiftPMIntegration.swift

@@ -37,7 +37,7 @@ final class SwiftPMIntegrationTests: XCTestCase {
         detail: "Void",
         sortText: nil,
         filterText: "foo()",
-        textEdit: nil,
+        textEdit: TextEdit(range: Position(line: 2, utf16index: 24)..<Position(line: 2, utf16index: 24), newText: "foo()"),
         insertText: "foo()",
         insertTextFormat: .plain,
         kind: .method,
@@ -47,7 +47,7 @@ final class SwiftPMIntegrationTests: XCTestCase {
         detail: "Lib",
         sortText: nil,
         filterText: "self",
-        textEdit: nil,
+        textEdit: TextEdit(range: Position(line: 2, utf16index: 24)..<Position(line: 2, utf16index: 24), newText: "self"),
         insertText: "self",
         insertTextFormat: .plain,
         kind: .keyword,