Capture sourcekit-lsp diagnostics

Author: plemarquand

src/commands/captureDiagnostics.ts

@@ -26,21 +26,12 @@ export async function captureDiagnostics(ctx: WorkspaceContext) {
         `vscode-diagnostics-${formatDateString(new Date())}`
     );
 
-    const environmentOutputChannel = new SwiftOutputChannel();
-    ctx.toolchain.logDiagnostics(environmentOutputChannel);
-    environmentOutputChannel.log(
-        JSON.stringify(vscode.workspace.getConfiguration("swift"), null, 2)
-    );
-
-    const logs = ctx.outputChannel.logs.join("\n");
-    const environmentLogs = environmentOutputChannel.logs.join("\n");
-    const diagnosticLogs = buildDiagnostics();
-
     try {
         await fs.mkdir(diagnosticsDir);
-        await fs.writeFile(path.join(diagnosticsDir, "logs.txt"), logs);
-        await fs.writeFile(path.join(diagnosticsDir, "environment.txt"), environmentLogs);
-        await fs.writeFile(path.join(diagnosticsDir, "diagnostics.txt"), diagnosticLogs);
+        await writeLogFile(diagnosticsDir, "logs.txt", extensionLogs(ctx));
+        await writeLogFile(diagnosticsDir, "environment.txt", environmentLogs(ctx));
+        await writeLogFile(diagnosticsDir, "sourcekit-lsp.txt", sourceKitLogs(ctx));
+        await writeLogFile(diagnosticsDir, "diagnostics.txt", diagnosticLogs());
 
         ctx.outputChannel.log(`Saved diagnostics to ${diagnosticsDir}`);
 
@@ -68,6 +59,44 @@ export async function captureDiagnostics(ctx: WorkspaceContext) {
     }
 }
 
+async function writeLogFile(dir: string, name: string, logs: string) {
+    if (logs.length === 0) {
+        return;
+    }
+    await fs.writeFile(path.join(dir, name), logs);
+}
+
+function extensionLogs(ctx: WorkspaceContext): string {
+    return ctx.outputChannel.logs.join("\n");
+}
+
+function environmentLogs(ctx: WorkspaceContext): string {
+    const environmentOutputChannel = new SwiftOutputChannel("Swift");
+    ctx.toolchain.logDiagnostics(environmentOutputChannel);
+    environmentOutputChannel.log("Extension Settings:");
+    environmentOutputChannel.log(
+        JSON.stringify(vscode.workspace.getConfiguration("swift"), null, 2)
+    );
+    return environmentOutputChannel.logs.join("\n");
+}
+
+function diagnosticLogs(): string {
+    const diagnosticToString = (diagnostic: vscode.Diagnostic) => {
+        return `${severityToString(diagnostic.severity)} - ${diagnostic.message} [Ln ${diagnostic.range.start.line}, Col ${diagnostic.range.start.character}]`;
+    };
+
+    return vscode.languages
+        .getDiagnostics()
+        .map(
+            ([uri, diagnostics]) => `${uri}\n\t${diagnostics.map(diagnosticToString).join("\n\t")}`
+        )
+        .join("\n");
+}
+
+function sourceKitLogs(ctx: WorkspaceContext) {
+    return (ctx.languageClientManager.languageClientOutputChannel?.logs ?? []).join("\n");
+}
+
 function showDirectoryCommand(dir: string): string {
     switch (process.platform) {
         case "win32":
@@ -90,19 +119,6 @@ function showCommandType(): string {
     }
 }
 
-function buildDiagnostics(): string {
-    const diagnosticToString = (diagnostic: vscode.Diagnostic) => {
-        return `${severityToString(diagnostic.severity)} - ${diagnostic.message} [Ln ${diagnostic.range.start.line}, Col ${diagnostic.range.start.character}]`;
-    };
-
-    return vscode.languages
-        .getDiagnostics()
-        .map(
-            ([uri, diagnostics]) => `${uri}\n\t${diagnostics.map(diagnosticToString).join("\n\t")}`
-        )
-        .join("\n");
-}
-
 function severityToString(severity: vscode.DiagnosticSeverity): string {
     switch (severity) {
         case vscode.DiagnosticSeverity.Error:

src/extension.ts

@@ -50,7 +50,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api |
     try {
         console.debug("Activating Swift for Visual Studio Code...");
 
-        const outputChannel = new SwiftOutputChannel();
+        const outputChannel = new SwiftOutputChannel("Swift");
         const toolchain: SwiftToolchain | undefined = await SwiftToolchain.create()
             .then(toolchain => {
                 toolchain.logDiagnostics(outputChannel);

src/sourcekit-lsp/LanguageClientManager.ts

@@ -24,6 +24,7 @@ import { FolderContext } from "../FolderContext";
 import { LanguageClient } from "vscode-languageclient/node";
 import { ArgumentFilter, BuildFlags } from "../toolchain/BuildFlags";
 import { DiagnosticsManager } from "../DiagnosticsManager";
+import { SwiftOutputChannel } from "../ui/SwiftOutputChannel";
 
 /** Manages the creation and destruction of Language clients as we move between
  * workspace folders
@@ -96,7 +97,6 @@ export class LanguageClientManager {
      * null means in the process of restarting
      */
     private languageClient: langclient.LanguageClient | null | undefined;
-    private initializeResult?: langclient.InitializeResult;
     private cancellationToken?: vscode.CancellationTokenSource;
     private legacyInlayHints?: vscode.Disposable;
     private restartedPromise?: Promise<void>;
@@ -238,6 +238,10 @@ export class LanguageClientManager {
         await this.setLanguageClientFolder(this.currentWorkspaceFolder, true);
     }
 
+    get languageClientOutputChannel(): SwiftOutputChannel | undefined {
+        return this.languageClient?.outputChannel as SwiftOutputChannel | undefined;
+    }
+
     private async addFolder(folderContext: FolderContext) {
         if (!folderContext.isRootFolder) {
             this.useLanguageClient(async client => {
@@ -439,6 +443,7 @@ export class LanguageClientManager {
             documentSelector: LanguageClientManager.documentSelector,
             revealOutputChannelOn: langclient.RevealOutputChannelOn.Never,
             workspaceFolder: workspaceFolder,
+            outputChannel: new SwiftOutputChannel("SourceKit Language Server"),
             middleware: {
                 provideDocumentSymbols: async (document, token, next) => {
                     const result = await next(document, token);
@@ -534,7 +539,6 @@ export class LanguageClientManager {
                 if (this.workspaceContext.swiftVersion.isLessThan(new Version(5, 7, 0))) {
                     this.legacyInlayHints = activateLegacyInlayHints(client);
                 }
-                this.initializeResult = client.initializeResult;
             })
             .catch(reason => {
                 this.workspaceContext.outputChannel.log(`${reason}`);

src/ui/SwiftOutputChannel.ts

@@ -15,12 +15,54 @@
 import * as vscode from "vscode";
 import configuration from "../configuration";
 
-export class SwiftOutputChannel {
+export class SwiftOutputChannel implements vscode.OutputChannel {
     private channel: vscode.OutputChannel;
     private logStore = new RollingLog(1024 * 1024 * 5);
 
-    constructor() {
-        this.channel = vscode.window.createOutputChannel("Swift");
+    public name: string;
+
+    /**
+     * Creates a vscode.OutputChannel that allows for later retrival of logs.
+     * @param name
+     */
+    constructor(name: string) {
+        this.name = name;
+        this.channel = vscode.window.createOutputChannel(name);
+    }
+
+    append(value: string): void {
+        this.channel.append(value);
+        this.logStore.append(value);
+
+        if (process.env["CI"] !== "1") {
+            console.log(value);
+        }
+    }
+
+    appendLine(value: string): void {
+        this.channel.appendLine(value);
+        this.logStore.appendLine(value);
+
+        if (process.env["CI"] !== "1") {
+            console.log(value);
+        }
+    }
+
+    replace(value: string): void {
+        this.channel.replace(value);
+        this.logStore.replace(value);
+    }
+
+    clear(): void {
+        this.channel.clear();
+    }
+
+    show(column?: unknown, preserveFocus?: boolean | undefined): void {
+        this.channel.show(preserveFocus);
+    }
+
+    hide(): void {
+        this.channel.hide();
     }
 
     dispose() {
@@ -34,7 +76,7 @@ export class SwiftOutputChannel {
         } else {
             fullMessage = message;
         }
-        this.sendLog(`${this.nowFormatted}: ${fullMessage}`);
+        this.appendLine(`${this.nowFormatted}: ${fullMessage}`);
     }
 
     logDiagnostic(message: string, label?: string) {
@@ -47,16 +89,7 @@ export class SwiftOutputChannel {
         } else {
             fullMessage = message;
         }
-        this.sendLog(`${this.nowFormatted}: ${fullMessage}`);
-    }
-
-    private sendLog(line: string) {
-        this.channel.appendLine(line);
-        this.logStore.append(line);
-
-        if (process.env["CI"] !== "1") {
-            console.log(line);
-        }
+        this.appendLine(`${this.nowFormatted}: ${fullMessage}`);
     }
 
     get nowFormatted(): string {
@@ -83,7 +116,7 @@ class RollingLog {
         return [...this._logs];
     }
 
-    append(log: string) {
+    appendLine(log: string) {
         // It can be costly to calculate the actual memory size of a string in Node so just
         // use the total number of characters in the logs as a huristic for total size.
         const logSize = log.length;
@@ -99,4 +132,15 @@ class RollingLog {
 
         this.currentLogLength += logSize;
     }
+
+    append(log: string) {
+        const line = this._logs.pop();
+        this.currentLogLength -= line?.length ?? 0;
+        this.appendLine((line ?? "") + log);
+    }
+
+    replace(log: string) {
+        this._logs = [log];
+        this.currentLogLength = log.length;
+    }
 }