Merge pull request #336 from benlangmuir/code-completion-server-side-filtering-5.3-20201012

[5.3-20201012] [completion] Filter completions on the server side

Author: benlangmuir

Sources/LSPTestSupport/TestJSONRPCConnection.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -18,7 +18,7 @@ import XCTest
 // Workaround ambiguity with Foundation.
 public typealias Notification = LanguageServerProtocol.Notification
 
-public struct TestJSONRPCConnection {
+public final class TestJSONRPCConnection {
   public let clientToServer: Pipe = Pipe()
   public let serverToClient: Pipe = Pipe()
   public let client: TestClient
@@ -27,11 +27,6 @@ public struct TestJSONRPCConnection {
   public let serverConnection: JSONRPCConnection
 
   public init() {
-    // FIXME: DispatchIO doesn't like when the Pipes close behind its back even after the tests
-    // finish. Until we fix the lifetime, leak.
-    _ = Unmanaged.passRetained(clientToServer)
-    _ = Unmanaged.passRetained(serverToClient)
-
     clientConnection = JSONRPCConnection(
       protocol: testMessageRegistry,
       inFD: serverToClient.fileHandleForReading.fileDescriptor,
@@ -47,8 +42,16 @@ public struct TestJSONRPCConnection {
     client = TestClient(server: clientConnection)
     server = TestServer(client: serverConnection)
 
-    clientConnection.start(receiveHandler: client)
-    serverConnection.start(receiveHandler: server)
+    clientConnection.start(receiveHandler: client) {
+      // FIXME: keep the pipes alive until we close the connection. This
+      // should be fixed systemically.
+      withExtendedLifetime(self) {}
+    }
+    serverConnection.start(receiveHandler: server) {
+      // FIXME: keep the pipes alive until we close the connection. This
+      // should be fixed systemically.
+      withExtendedLifetime(self) {}
+    }
   }
 
   public func close() {

Sources/LanguageServerProtocol/Connection.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -104,14 +104,18 @@ public final class LocalConnection {
 
 extension LocalConnection: Connection {
   public func send<Notification>(_ notification: Notification) where Notification: NotificationType {
-    precondition(state == .started)
-    handler!.handle(notification, from: ObjectIdentifier(self))
+    handler?.handle(notification, from: ObjectIdentifier(self))
   }
 
   public func send<Request>(_ request: Request, queue: DispatchQueue, reply: @escaping (LSPResult<Request.Response>) -> Void) -> RequestID where Request: RequestType {
-    precondition(state == .started)
     let id = nextRequestID()
-    handler!.handle(request, id: id, from: ObjectIdentifier(self)) { result in
+    guard let handler = handler else {
+      queue.async { reply(.failure(.cancelled)) }
+      return id
+    }
+
+    precondition(state == .started)
+    handler.handle(request, id: id, from: ObjectIdentifier(self)) { result in
       queue.async {
         reply(result)
       }

Sources/LanguageServerProtocol/Requests/CompletionRequest.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -22,6 +22,8 @@
 /// - Parameters:
 ///   - textDocument: The document to perform completion in.
 ///   - position: The location to perform completion at.
+///   - context: Optional code-completion context.
+///   - sourcekitlspOptions: **(LSP Extension)** code-completion options for sourcekit-lsp.
 ///
 /// - Returns: A list of completion items to complete the code at the given position.
 public struct CompletionRequest: TextDocumentRequest, Hashable {
@@ -34,9 +36,18 @@ public struct CompletionRequest: TextDocumentRequest, Hashable {
 
   public var context: CompletionContext?
 
-  public init(textDocument: TextDocumentIdentifier, position: Position) {
+  public var sourcekitlspOptions: SKCompletionOptions?
+
+  public init(
+    textDocument: TextDocumentIdentifier,
+    position: Position,
+    context: CompletionContext? = nil,
+    sourcekitlspOptions: SKCompletionOptions? = nil)
+  {
     self.textDocument = textDocument
     self.position = position
+    self.context = context
+    self.sourcekitlspOptions = sourcekitlspOptions
   }
 }
 

Sources/LanguageServerProtocol/SupportTypes/Position.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -56,3 +56,13 @@ extension Position: LSPAnyCodable {
     ])
   }
 }
+
+extension Position: CustomStringConvertible, CustomDebugStringConvertible {
+  public var description: String {
+    "\(line + 1):\(utf16index+1)"
+  }
+
+  public var debugDescription: String {
+    "Position(line: \(line), utf16index: \(utf16index))"
+  }
+}

Sources/LanguageServerProtocol/SupportTypes/SKCompletionOptions.swift

@@ -0,0 +1,30 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+/// Code-completion configuration.
+///
+/// **(LSP Extension)**: This is used as part of an extension to the
+/// code-completion request.
+public struct SKCompletionOptions: Codable, Hashable {
+
+  /// Whether to use server-side filtering or to return all results and let the
+  /// client handle all filtering.
+  public var serverSideFiltering: Bool
+
+  /// The maximum number of completion results to return, or `nil` for unlimited.
+  public var maxResults: Int?
+
+  public init(serverSideFiltering: Bool = true, maxResults: Int? = 200) {
+    self.serverSideFiltering = serverSideFiltering
+    self.maxResults = maxResults
+  }
+}

Sources/SKCore/BuildServerBuildSystem.swift

@@ -248,7 +248,11 @@ private func makeJSONRPCBuildServer(client: MessageHandler, serverPath: Absolute
     outFD: clientToServer.fileHandleForWriting.fileDescriptor
   )
 
-  connection.start(receiveHandler: client)
+  connection.start(receiveHandler: client) {
+    // FIXME: keep the pipes alive until we close the connection. This
+    // should be fixed systemically.
+    withExtendedLifetime((clientToServer, serverToClient)) {}
+  }
   let process = Foundation.Process()
 
   if #available(OSX 10.13, *) {

Sources/SKCore/BuildSystemManager.swift

@@ -43,7 +43,7 @@ public final class BuildSystemManager {
   weak var mainFilesProvider: MainFilesProvider?
 
   /// Build system delegate that will receive notifications about setting changes, etc.
-  var _delegate: BuildSystemDelegate?
+  weak var _delegate: BuildSystemDelegate?
 
   /// Create a BuildSystemManager that wraps the given build system. The new manager will modify the
   /// delegate of the underlying build system.

Sources/SKTestSupport/TestServer.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -19,7 +19,7 @@ import SourceKit
 import class Foundation.Pipe
 import LSPTestSupport
 
-public struct TestSourceKitServer {
+public final class TestSourceKitServer {
   public enum ConnectionKind {
     case local, jsonrpc
   }
@@ -40,6 +40,8 @@ public struct TestSourceKitServer {
   public let client: TestClient
   let connImpl: ConnectionImpl
 
+  public var hasShutdown: Bool = false
+
   /// The server, if it is in the same process.
   public let server: SourceKitServer?
 
@@ -63,11 +65,6 @@ public struct TestSourceKitServer {
         let clientToServer: Pipe = Pipe()
         let serverToClient: Pipe = Pipe()
 
-        // FIXME: DispatchIO doesn't like when the Pipes close behind its back even after the tests
-        // finish. Until we fix the lifetime, leak.
-        _ = Unmanaged.passRetained(clientToServer)
-        _ = Unmanaged.passRetained(serverToClient)
-
         let clientConnection = JSONRPCConnection(
           protocol: MessageRegistry.lspProtocol,
           inFD: serverToClient.fileHandleForReading.fileDescriptor,
@@ -84,8 +81,16 @@ public struct TestSourceKitServer {
           serverConnection.close()
         })
 
-        clientConnection.start(receiveHandler: client)
-        serverConnection.start(receiveHandler: server!)
+        clientConnection.start(receiveHandler: client) {
+          // FIXME: keep the pipes alive until we close the connection. This
+          // should be fixed systemically.
+          withExtendedLifetime((clientToServer, serverToClient)) {}
+        }
+        serverConnection.start(receiveHandler: server!) {
+          // FIXME: keep the pipes alive until we close the connection. This
+          // should be fixed systemically.
+          withExtendedLifetime((clientToServer, serverToClient)) {}
+        }
 
         connImpl = .jsonrpc(
           clientToServer: clientToServer,
@@ -95,15 +100,15 @@ public struct TestSourceKitServer {
     }
   }
 
+  deinit {
+    close()
+  }
+
   func close() {
-    switch connImpl {
-      case .local(clientConnection: let cc, serverConnection: let sc):
-      cc.close()
-      sc.close()
-
-    case .jsonrpc(clientToServer: _, serverToClient: _, clientConnection: let cc, serverConnection: let sc):
-      cc.close()
-      sc.close()
+    if !hasShutdown {
+      hasShutdown = true
+      _ = try! self.client.sendSync(ShutdownRequest())
+      self.client.send(ExitNotification())
     }
   }
 }

Sources/SourceKit/SourceKitServer+Options.swift

@@ -2,14 +2,15 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
 
+import LanguageServerProtocol
 import SKCore
 
 extension SourceKitServer {
@@ -27,10 +28,19 @@ extension SourceKitServer {
     /// Additional options for the index.
     public var indexOptions: IndexOptions
 
-    public init(buildSetup: BuildSetup = .default, clangdOptions: [String] = [], indexOptions: IndexOptions = .init()) {
+    /// Options for code-completion.
+    public var completionOptions: SKCompletionOptions
+
+    public init(
+      buildSetup: BuildSetup = .default,
+      clangdOptions: [String] = [],
+      indexOptions: IndexOptions = .init(),
+      completionOptions: SKCompletionOptions = .init())
+    {
       self.buildSetup = buildSetup
       self.clangdOptions = clangdOptions
       self.indexOptions = indexOptions
+      self.completionOptions = completionOptions
     }
   }
 }

Sources/SourceKit/SourceKitServer.swift

@@ -36,7 +36,7 @@ public final class SourceKitServer: LanguageServer {
     var language: Language
   }
 
-  let options: Options
+  var options: Options
 
   let toolchainRegistry: ToolchainRegistry
 
@@ -298,6 +298,21 @@ extension SourceKitServer {
       if case .bool(let listenToUnitEvents) = options["listenToUnitEvents"] {
         indexOptions.listenToUnitEvents = listenToUnitEvents
       }
+      if case .dictionary(let completionOptions) = options["completion"] {
+        if case .bool(let serverSideFiltering) = completionOptions["serverSideFiltering"] {
+          self.options.completionOptions.serverSideFiltering = serverSideFiltering
+        }
+        switch completionOptions["maxResults"] {
+        case .none:
+          break
+        case .some(.null):
+          self.options.completionOptions.maxResults = nil
+        case .some(.int(let maxResults)):
+          self.options.completionOptions.maxResults = maxResults
+        case .some(let invalid):
+          log("expected null or int for 'maxResults'; got \(invalid)", level: .warning)
+        }
+      }
     }
 
     // Any messages sent before initialize returns are expected to fail, so this will run before
@@ -346,7 +361,7 @@ extension SourceKitServer {
         save: TextDocumentSyncOptions.SaveOptions(includeText: false)
       ),
       hoverProvider: true,
-      completionProvider: CompletionOptions(
+      completionProvider: LanguageServerProtocol.CompletionOptions(
         resolveProvider: false,
         triggerCharacters: ["."]
       ),
@@ -406,6 +421,10 @@ extension SourceKitServer {
 
   func shutdown(_ request: Request<ShutdownRequest>) {
     _prepareForExit()
+    for service in languageService.values {
+      service.shutdown()
+    }
+    languageService = [:]
     request.reply(VoidResponse())
   }
 
@@ -781,7 +800,12 @@ public func languageService(
 
   case .swift:
     guard let sourcekitd = toolchain.sourcekitd else { return nil }
-    return try makeLocalSwiftServer(client: client, sourcekitd: sourcekitd, buildSettings: (client as? SourceKitServer)?.workspace?.buildSettings, clientCapabilities: (client as? SourceKitServer)?.workspace?.clientCapabilities)
+    return try makeLocalSwiftServer(
+      client: client,
+      sourcekitd: sourcekitd,
+      buildSettings: (client as? SourceKitServer)?.workspace?.buildSettings,
+      clientCapabilities: (client as? SourceKitServer)?.workspace?.clientCapabilities,
+      options: options)
 
   default:
     return nil

Sources/SourceKit/ToolchainLanguageServer.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -20,6 +20,7 @@ public protocol ToolchainLanguageServer: AnyObject {
 
   func initializeSync(_ initialize: InitializeRequest) throws -> InitializeResult
   func clientInitialized(_ initialized: InitializedNotification)
+  func shutdown()
 
   // MARK: - Text synchronization