Optionally add lldb-dap logs to Diagnostic Bundle (#1758)

* Optionally add lldb-dap logs to Diagnostic Bundle

* Gracefully handle folder not existing

* Consider new `lldb-dap.logFolder` setting

* Add some tests

* Update src/commands/captureDiagnostics.ts

Co-authored-by: Paul LeMarquand <[email protected]>

* Only include LLDB dap logs if it's being used as the debug adapter

* Add changelog

---------

Co-authored-by: Paul LeMarquand <[email protected]>

Author: award999

.vscode-test.js

@@ -42,6 +42,7 @@ if (process.platform === "darwin" && process.arch === "x64") {
 }
 
 const installExtensions = [];
+const extensionDependencies = [];
 let vsixPath = process.env["VSCODE_SWIFT_VSIX"];
 let versionStr = version;
 let extensionDevelopmentPath;
@@ -66,6 +67,8 @@ if (vsixPath) {
 
     extensionDevelopmentPath = `${__dirname}/.vscode-test/extensions/${publisher}.${name}-${versionStr}`;
     console.log("Running tests against extension development path " + extensionDevelopmentPath);
+} else {
+    extensionDependencies.push("vadimcn.vscode-lldb", "llvm-vs-code-extensions.lldb-dap");
 }
 
 const vscodeVersion = process.env["VSCODE_VERSION"] ?? "stable";
@@ -117,6 +120,7 @@ module.exports = defineConfig({
                     },
                 },
             },
+            installExtensions: extensionDependencies,
             skipExtensionDependencies: installConfigs.length > 0,
             reuseMachineInstall: !isCIBuild,
         },
@@ -152,6 +156,7 @@ module.exports = defineConfig({
                     },
                 },
             },
+            installExtensions: extensionDependencies,
             skipExtensionDependencies: installConfigs.length > 0,
             reuseMachineInstall: !isCIBuild,
         },

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - New `swift.createTasksForLibraryProducts` setting that when enabled causes the extension to automatically create and provide tasks for library products ([#1741](https://github.com/swiftlang/vscode-swift/pull/1741))
 - New `swift.outputChannelLogLevel` setting to control the verbosity of the `Swift` output channel ([#1746](https://github.com/swiftlang/vscode-swift/pull/1746))
+- Optionally include LLDB DAP logs in the Swift diagnostics bundle ([#1768](https://github.com/swiftlang/vscode-swift/pull/1758))
 
 ### Changed
 - Added log levels and improved Swift extension logging so a logfile is produced in addition to logging messages to the existing `Swift` output channel. Deprecated the `swift.diagnostics` setting in favour of the new `swift.outputChannelLogLevel` setting ([#1746](https://github.com/swiftlang/vscode-swift/pull/1746))

assets/test/logs/lldb-dap-session-123456789.log

@@ -0,0 +1 @@
+Very important logging data

src/commands/captureDiagnostics.ts

@@ -25,6 +25,8 @@ import { Version } from "../utilities/version";
 import { destructuredPromise, execFileStreamOutput } from "../utilities/utilities";
 import configuration from "../configuration";
 import { FolderContext } from "../FolderContext";
+import { Extension } from "../utilities/extensions";
+import { DebugAdapter } from "../debugger/debugAdapter";
 
 export async function captureDiagnostics(
     ctx: WorkspaceContext,
@@ -44,13 +46,26 @@ export async function captureDiagnostics(
         );
 
         await fsPromises.mkdir(diagnosticsDir);
-        await copyLogFile(diagnosticsDir, extensionLogFile(ctx));
 
         const singleFolderWorkspace = ctx.folders.length === 1;
         const zipDir = await createDiagnosticsZipDir();
         const zipFilePath = path.join(zipDir, `${path.basename(diagnosticsDir)}.zip`);
         const { archive, done: archivingDone } = configureZipArchiver(zipFilePath);
 
+        const archivedLldbDapLogFolders = new Set<string>();
+        const includeLldbDapLogs = DebugAdapter.getLaunchConfigType(
+            ctx.globalToolchainSwiftVersion
+        );
+        if (captureMode === "Full" && includeLldbDapLogs) {
+            for (const defaultLldbDapLogs of [defaultLldbDapLogFolder(ctx), lldbDapLogFolder()]) {
+                if (!defaultLldbDapLogs || archivedLldbDapLogFolders.has(defaultLldbDapLogs)) {
+                    continue;
+                }
+                archivedLldbDapLogFolders.add(defaultLldbDapLogs);
+                await copyLogFolder(ctx, diagnosticsDir, defaultLldbDapLogs);
+            }
+        }
+
         for (const folder of ctx.folders) {
             const baseName = path.basename(folder.folder.fsPath);
             const guid = Math.random().toString(36).substring(2, 10);
@@ -70,14 +85,31 @@ export async function captureDiagnostics(
                 // The `sourcekit-lsp diagnose` command is only available in 6.0 and higher.
                 if (folder.toolchain.swiftVersion.isGreaterThanOrEqual(new Version(6, 0, 0))) {
                     await sourcekitDiagnose(folder, outputDir);
-                } else {
+                } else if (
+                    vscode.workspace
+                        .getConfiguration("sourcekit-lsp")
+                        .get<string>("trace.server", "off") !== "off"
+                ) {
                     const logFile = sourceKitLogFile(folder);
                     if (logFile) {
                         await copyLogFile(outputDir, logFile);
                     }
                 }
+
+                const includeLldbDapLogs = DebugAdapter.getLaunchConfigType(folder.swiftVersion);
+                if (!includeLldbDapLogs) {
+                    continue;
+                }
+                // Copy lldb-dap logs
+                const lldbDapLogs = lldbDapLogFolder(folder.workspaceFolder);
+                if (lldbDapLogs && !archivedLldbDapLogFolders.has(lldbDapLogs)) {
+                    archivedLldbDapLogFolders.add(lldbDapLogs);
+                    await copyLogFolder(ctx, outputDir, lldbDapLogs);
+                }
             }
         }
+        // Leave at end in case log above
+        await copyLogFile(diagnosticsDir, extensionLogFile(ctx));
 
         archive.directory(diagnosticsDir, false);
         void archive.finalize();
@@ -137,24 +169,24 @@ async function captureDiagnosticsMode(
     ctx: WorkspaceContext,
     allowMinimalCapture: boolean
 ): Promise<"Minimal" | "Full" | undefined> {
-    if (
-        ctx.globalToolchainSwiftVersion.isGreaterThanOrEqual(new Version(6, 0, 0)) ||
-        vscode.workspace.getConfiguration("sourcekit-lsp").get<string>("trace.server", "off") !==
-            "off"
-    ) {
-        const fullButton = allowMinimalCapture ? "Capture Full Diagnostics" : "Capture Diagnostics";
+    if (ctx.globalToolchainSwiftVersion.isGreaterThanOrEqual(new Version(6, 0, 0))) {
+        const fullButton = "Capture Full Diagnostics";
         const minimalButton = "Capture Minimal Diagnostics";
         const buttons = allowMinimalCapture ? [fullButton, minimalButton] : [fullButton];
         const fullCaptureResult = await vscode.window.showInformationMessage(
             `A Diagnostic Bundle collects information that helps the developers of the Swift for VS Code extension diagnose and fix issues.
 
-This information contains:
+This information includes:
 - Extension logs
+- Extension settings
 - Versions of Swift installed on your system
+
+If you allow capturing a Full Diagnostic Bundle, the information will also include:
 - Crash logs from SourceKit
 - Log messages emitted by SourceKit
 - If possible, a minimized project that caused SourceKit to crash
 - If possible, a minimized project that caused the Swift compiler to crash
+- If available, log messages emitted by LLDB DAP
 
 All information is collected locally and you can inspect the diagnose bundle before sharing it with developers of the Swift for VS Code extension.
 
@@ -211,6 +243,19 @@ async function copyLogFile(dir: string, filePath: string) {
     await fsPromises.copyFile(filePath, path.join(dir, path.basename(filePath)));
 }
 
+async function copyLogFolder(ctx: WorkspaceContext, dir: string, folderPath: string) {
+    try {
+        const lldbLogFiles = await fsPromises.readdir(folderPath);
+        for (const log of lldbLogFiles) {
+            await copyLogFile(dir, path.join(folderPath, log));
+        }
+    } catch (error) {
+        if ((error as NodeJS.ErrnoException).code !== "ENOENT") {
+            ctx.logger.error(`Failed to read log files from ${folderPath}: ${error}`);
+        }
+    }
+}
+
 /**
  * Creates a directory for diagnostics zip files, located in the system's temporary directory.
  */
@@ -224,6 +269,31 @@ function extensionLogFile(ctx: WorkspaceContext): string {
     return ctx.logger.logFilePath;
 }
 
+function defaultLldbDapLogFolder(ctx: WorkspaceContext): string {
+    const rootLogFolder = path.dirname(ctx.loggerFactory.logFolderUri.fsPath);
+    return path.join(rootLogFolder, Extension.LLDBDAP);
+}
+
+function lldbDapLogFolder(workspaceFolder?: vscode.WorkspaceFolder): string | undefined {
+    const config = vscode.workspace.workspaceFile
+        ? vscode.workspace.getConfiguration("lldb-dap")
+        : vscode.workspace.getConfiguration("lldb-dap", workspaceFolder);
+    let logFolder = config.get<string>("logFolder");
+    if (!logFolder) {
+        return;
+    } else if (!path.isAbsolute(logFolder)) {
+        const logFolderSettingInfo = config.inspect<string>("logFolder");
+        if (logFolderSettingInfo?.workspaceFolderValue && workspaceFolder) {
+            logFolder = path.join(workspaceFolder.uri.fsPath, logFolder);
+        } else if (logFolderSettingInfo?.workspaceValue && vscode.workspace.workspaceFile) {
+            logFolder = path.join(path.dirname(vscode.workspace.workspaceFile.fsPath), logFolder);
+        } else if (vscode.workspace.workspaceFolders?.length) {
+            logFolder = path.join(vscode.workspace.workspaceFolders[0].uri.fsPath, logFolder);
+        }
+    }
+    return logFolder;
+}
+
 function settingsLogs(ctx: FolderContext): string {
     const settings = JSON.stringify(vscode.workspace.getConfiguration("swift"), null, 2);
     return `${ctx.toolchain.diagnostics}\nSettings:\n${settings}`;

src/logging/SwiftLoggerFactory.ts

@@ -19,7 +19,7 @@ import { SwiftOutputChannel } from "./SwiftOutputChannel";
 import { SwiftLogger } from "./SwiftLogger";
 
 export class SwiftLoggerFactory {
-    constructor(private logFolderUri: vscode.Uri) {}
+    constructor(public readonly logFolderUri: vscode.Uri) {}
 
     create(name: string, logFilename: string): SwiftLogger;
     create(name: string, logFilename: string, options: { outputChannel: true }): SwiftOutputChannel;

src/utilities/extensions.ts

@@ -0,0 +1,18 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2025 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+export enum Extension {
+    CODELLDB = "vadimcn.vscode-lldb",
+    LLDBDAP = "llvm-vs-code-extensions.lldb-dap",
+}