Migrate to upstream workspace/textDocumentContent

package.json

@@ -1273,7 +1273,7 @@
   "dependencies": {
     "lcov-parse": "^1.0.0",
     "plist": "^3.1.0",
-    "vscode-languageclient": "^9.0.1",
+    "vscode-languageclient": "^10.0.0-next.13",
     "xml2js": "^0.6.2"
   }
-}
+}

src/TestExplorer/LSPTestDiscovery.ts

@@ -21,7 +21,7 @@ import {
 } from "../sourcekit-lsp/lspExtensions";
 import { InitializeResult, RequestType } from "vscode-languageclient/node";
 import { SwiftPackage, TargetType } from "../SwiftPackage";
-import { Converter } from "vscode-languageclient/lib/common/protocolConverter";
+import { Converter } from "vscode-languageclient/$test/common/protocolConverter";
 
 interface ILanguageClient {
     get initializeResult(): InitializeResult | undefined;

src/sourcekit-lsp/LanguageClientManager.ts

@@ -29,7 +29,7 @@ import { DiagnosticsManager } from "../DiagnosticsManager";
 import { LSPLogger, LSPOutputChannel } from "./LSPOutputChannel";
 import { SwiftOutputChannel } from "../ui/SwiftOutputChannel";
 import { promptForDiagnostics } from "../commands/captureDiagnostics";
-import { activateGetReferenceDocument } from "./getReferenceDocument";
+import { activateLegacyGetReferenceDocument } from "./getReferenceDocument";
 
 interface SourceKitLogMessageParams extends langclient.LogMessageParams {
     logName?: string;
@@ -113,7 +113,7 @@ export class LanguageClientManager {
     private cancellationToken?: vscode.CancellationTokenSource;
     private legacyInlayHints?: vscode.Disposable;
     private peekDocuments?: vscode.Disposable;
-    private getReferenceDocument?: vscode.Disposable;
+    private legacyGetReferenceDocument?: vscode.Disposable;
     private restartedPromise?: Promise<void>;
     private currentWorkspaceFolder?: vscode.Uri;
     private waitingOnRestartCount: number;
@@ -251,7 +251,7 @@ export class LanguageClientManager {
         this.cancellationToken?.dispose();
         this.legacyInlayHints?.dispose();
         this.peekDocuments?.dispose();
-        this.getReferenceDocument?.dispose();
+        this.legacyGetReferenceDocument?.dispose();
         this.subscriptions.forEach(item => item.dispose());
         this.languageClient?.stop();
         this.namedOutputChannels.forEach(channel => channel.dispose());
@@ -402,8 +402,8 @@ export class LanguageClientManager {
         this.legacyInlayHints = undefined;
         this.peekDocuments?.dispose();
         this.peekDocuments = undefined;
-        this.getReferenceDocument?.dispose();
-        this.getReferenceDocument = undefined;
+        this.legacyGetReferenceDocument?.dispose();
+        this.legacyGetReferenceDocument = undefined;
         if (client) {
             this.cancellationToken?.cancel();
             this.cancellationToken?.dispose();
@@ -581,13 +581,19 @@ export class LanguageClientManager {
             initializationOptions: this.initializationOptions(),
         };
 
+        const client = new langclient.LanguageClient(
+            "swift.sourcekit-lsp",
+            "SourceKit Language Server",
+            serverOptions,
+            clientOptions
+        );
+
+        // TODO: Remove once LSP 3.18 is official (we currently need this for
+        // the proposed `workspace/textDocumentContent` API)
+        client.registerProposedFeatures();
+
         return {
-            client: new langclient.LanguageClient(
-                "swift.sourcekit-lsp",
-                "SourceKit Language Server",
-                serverOptions,
-                clientOptions
-            ),
+            client,
             errorHandler,
         };
     }
@@ -658,9 +664,15 @@ export class LanguageClientManager {
                     this.legacyInlayHints = activateLegacyInlayHints(client);
                 }
 
+                // TODO: This may have to be adjusted to the version
+                // https://github.com/swiftlang/sourcekit-lsp/pull/1639
+                // is merged to
+                if (this.workspaceContext.swiftVersion.isLessThan(new Version(6, 1, 0))) {
+                    this.legacyGetReferenceDocument = activateLegacyGetReferenceDocument(client);
+                    this.workspaceContext.subscriptions.push(this.legacyGetReferenceDocument);
+                }
+
                 this.peekDocuments = activatePeekDocuments(client);
-                this.getReferenceDocument = activateGetReferenceDocument(client);
-                this.workspaceContext.subscriptions.push(this.getReferenceDocument);
             })
             .catch(reason => {
                 this.workspaceContext.outputChannel.log(`${reason}`);

src/sourcekit-lsp/getReferenceDocument.ts

@@ -14,18 +14,27 @@
 
 import * as vscode from "vscode";
 import * as langclient from "vscode-languageclient/node";
-import { GetReferenceDocumentParams, GetReferenceDocumentRequest } from "./lspExtensions";
+import {
+    LegacyGetReferenceDocumentParams,
+    LegacyGetReferenceDocumentRequest,
+} from "./lspExtensions";
 
-export function activateGetReferenceDocument(client: langclient.LanguageClient): vscode.Disposable {
+export function activateLegacyGetReferenceDocument(
+    client: langclient.LanguageClient
+): vscode.Disposable {
     const getReferenceDocument = vscode.workspace.registerTextDocumentContentProvider(
         "sourcekit-lsp",
         {
             provideTextDocumentContent: async (uri, token) => {
-                const params: GetReferenceDocumentParams = {
+                const params: LegacyGetReferenceDocumentParams = {
                     uri: client.code2ProtocolConverter.asUri(uri),
                 };
 
-                const result = await client.sendRequest(GetReferenceDocumentRequest, params, token);
+                const result = await client.sendRequest(
+                    LegacyGetReferenceDocumentRequest,
+                    params,
+                    token
+                );
 
                 if (result) {
                     return result.content;

src/sourcekit-lsp/lspExtensions.ts

@@ -57,7 +57,7 @@ export const PeekDocumentsRequest = new langclient.RequestType<
 >("workspace/peekDocuments");
 
 // Get Reference Document
-export interface GetReferenceDocumentParams {
+export interface LegacyGetReferenceDocumentParams {
     /**
      * The `DocumentUri` of the custom scheme url for which content is required
      */
@@ -67,17 +67,17 @@ export interface GetReferenceDocumentParams {
 /**
  * Response containing `content` of `GetReferenceDocumentRequest`
  */
-export interface GetReferenceDocumentResult {
+export interface LegacyGetReferenceDocumentResult {
     content: string;
 }
 
 /**
  * Request from the client to the server asking for contents of a URI having a custom scheme
  * For example: "sourcekit-lsp:"
  */
-export const GetReferenceDocumentRequest = new langclient.RequestType<
-    GetReferenceDocumentParams,
-    GetReferenceDocumentResult,
+export const LegacyGetReferenceDocumentRequest = new langclient.RequestType<
+    LegacyGetReferenceDocumentParams,
+    LegacyGetReferenceDocumentResult,
     unknown
 >("workspace/getReferenceDocument");
 

test/suite/BuildFlags.test.ts

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import * as assert from "assert";
+import { strict as assert } from "assert";
 import * as vscode from "vscode";
 import { SwiftToolchain } from "../../src/toolchain/toolchain";
 import { ArgumentFilter, BuildFlags } from "../../src/toolchain/BuildFlags";

test/suite/DiagnosticsManager.test.ts

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import * as assert from "assert";
+import { strict as assert } from "assert";
 import * as vscode from "vscode";
 import { SwiftToolchain } from "../../src/toolchain/toolchain";
 import { executeTaskAndWaitForResult, waitForNoRunningTasks } from "../utilities";