Deprecate lldb-dap.log-path setting in favour of lldb-dap.logFolder

Author: award999

lldb/tools/lldb-dap/package.json

@@ -81,10 +81,16 @@
             "description": "The path to the lldb-dap binary, e.g. /usr/local/bin/lldb-dap"
           },
           "lldb-dap.log-path": {
+            "scope": "machine-overridable",
+            "type": "string",
+            "description": "The log path for lldb-dap (if any)",
+            "markdownDeprecationMessage": "Use the `#lldb-dap.logFolder#` setting instead"
+          },
+          "lldb-dap.logFolder": {
             "order": 0,
             "scope": "machine-overridable",
             "type": "string",
-            "description": "The log path for lldb-dap (if any)"
+            "markdownDescription": "The folder to persist lldb-dap logs. If no value is provided, logs will be persisted in the [Extension Logs Folder](command:workbench.action.openExtensionLogsFolder)."
           },
           "lldb-dap.serverMode": {
             "order": 0,

lldb/tools/lldb-dap/src-ts/debug-adapter-factory.ts

@@ -5,7 +5,7 @@ import * as child_process from "child_process";
 import * as fs from "node:fs/promises";
 import { ConfigureButton, OpenSettingsButton } from "./ui/show-error-message";
 import { ErrorWithNotification } from "./ui/error-with-notification";
-import { LogFilePathProvider } from "./types";
+import { LogFilePathProvider, LogType } from "./logging";
 
 const exec = util.promisify(child_process.execFile);
 
@@ -157,22 +157,6 @@ async function getDAPArguments(
     .get<string[]>("arguments", []);
 }
 
-/**
- * Formats the given date as a string in the form "YYYYMMddTHHMMSS".
- *
- * @param date The date to format as a string.
- * @returns The formatted date.
- */
-function formatDate(date: Date): string {
-  const year = date.getFullYear().toString().padStart(4, "0");
-  const month = (date.getMonth() + 1).toString().padStart(2, "0");
-  const day = date.getDate().toString().padStart(2, "0");
-  const hour = date.getHours().toString().padStart(2, "0");
-  const minute = date.getMinutes().toString().padStart(2, "0");
-  const seconds = date.getSeconds().toString().padStart(2, "0");
-  return `${year}${month}${day}T${hour}${minute}${seconds}`;
-}
-
 /**
  * Creates a new {@link vscode.DebugAdapterExecutable} based on the provided workspace folder and
  * debug configuration. Assumes that the given debug configuration is for a local launch of lldb-dap.
@@ -200,9 +184,7 @@ export async function createDebugAdapterExecutable(
   } else if (
     vscode.workspace.getConfiguration("lldb-dap").get("captureSessionLogs", false)
   ) {
-    env["LLDBDAP_LOG"] = logFilePath(
-      `lldb-dap-session-${formatDate(new Date())}.log`,
-    );
+    env["LLDBDAP_LOG"] = logFilePath.get(LogType.DEBUG_SESSION);
   }
   const configEnvironment =
     config.get<{ [key: string]: string }>("environment") || {};
@@ -220,7 +202,7 @@ export async function createDebugAdapterExecutable(
   logger.info(`lldb-dap path: ${dapPath}`);
   logger.info(`lldb-dap args: ${dbgArgs}`);
   logger.info(`cwd: ${dbgOptions.cwd}`);
-  logger.info(`env: ${JSON.stringify(configEnvironment)}`);
+  logger.info(`env: ${JSON.stringify(dbgOptions.env)}`);
 
   return new vscode.DebugAdapterExecutable(dapPath, dbgArgs, dbgOptions);
 }

lldb/tools/lldb-dap/src-ts/debug-configuration-provider.ts

@@ -5,7 +5,7 @@ import { LLDBDapServer } from "./lldb-dap-server";
 import { createDebugAdapterExecutable } from "./debug-adapter-factory";
 import { ConfigureButton, showErrorMessage } from "./ui/show-error-message";
 import { ErrorWithNotification } from "./ui/error-with-notification";
-import { LogFilePathProvider } from "./types";
+import { LogFilePathProvider } from "./logging";
 
 const exec = util.promisify(child_process.execFile);
 

lldb/tools/lldb-dap/src-ts/extension.ts

@@ -11,7 +11,7 @@ import {
   ModulesDataProvider,
   ModuleProperty,
 } from "./ui/modules-data-provider";
-import { LogFilePathProvider } from "./types";
+import { LogFilePathProvider } from "./logging";
 
 /**
  * This class represents the extension and manages its life cycle. Other extensions
@@ -64,11 +64,10 @@ export class LLDBDapExtension extends DisposableContext {
  */
 export async function activate(context: vscode.ExtensionContext) {
   const outputChannel = vscode.window.createOutputChannel("LLDB-DAP", { log: true });
-  const logFilePath: LogFilePathProvider = (name: string) =>
-    path.join(context.logUri.fsPath, name);
-  outputChannel.info("LLDB-Dap extension activating...");
+  outputChannel.info("LLDB-DAP extension activating...");
+  const logFilePath = new LogFilePathProvider(context, outputChannel);
   context.subscriptions.push(
     new LLDBDapExtension(outputChannel, logFilePath, outputChannel),
   );
-  outputChannel.info("LLDB-Dap extension activated");
+  outputChannel.info("LLDB-DAP extension activated");
 }

lldb/tools/lldb-dap/src-ts/logging.ts

@@ -0,0 +1,67 @@
+import * as path from "path";
+import * as vscode from "vscode";
+
+/**
+ * Formats the given date as a string in the form "YYYYMMddTHHMMSS".
+ *
+ * @param date The date to format as a string.
+ * @returns The formatted date.
+ */
+function formatDate(date: Date): string {
+  const year = date.getFullYear().toString().padStart(4, "0");
+  const month = (date.getMonth() + 1).toString().padStart(2, "0");
+  const day = date.getDate().toString().padStart(2, "0");
+  const hour = date.getHours().toString().padStart(2, "0");
+  const minute = date.getMinutes().toString().padStart(2, "0");
+  const seconds = date.getSeconds().toString().padStart(2, "0");
+  return `${year}${month}${day}T${hour}${minute}${seconds}`;
+}
+
+export enum LogType {
+  DEBUG_SESSION,
+}
+
+export class LogFilePathProvider {
+  private logFolder: string = "";
+
+  constructor(
+    private context: vscode.ExtensionContext,
+    private logger: vscode.LogOutputChannel,
+  ) {
+    this.updateLogFolder();
+    context.subscriptions.push(
+        vscode.workspace.onDidChangeConfiguration(e => {
+            if (
+                e.affectsConfiguration("lldb-dap.logFolder")
+            ) {
+                this.updateLogFolder();
+            }
+        })
+    );
+  }
+
+  get(type: LogType): string {
+    const logFolder = this.logFolder || this.context.logUri.fsPath;
+    switch(type) {
+    case LogType.DEBUG_SESSION:
+        return path.join(logFolder, `lldb-dap-session-${formatDate(new Date())}.log`);
+        break;
+    }
+  }
+
+  private updateLogFolder() {
+    const config = vscode.workspace.getConfiguration("lldb-dap");
+    let logFolder =
+      config.get<string>("logFolder") || this.context.logUri.fsPath;
+    vscode.workspace.fs
+      .createDirectory(vscode.Uri.file(logFolder))
+      .then(undefined, (error) => {
+        this.logger.error(`Failed to create log folder ${logFolder}: ${error}`);
+        logFolder = this.context.logUri.fsPath;
+      })
+      .then(() => {
+        this.logFolder = logFolder;
+        this.logger.info(`Persisting lldb-dap logs to ${logFolder}`);
+      });
+  }
+}