add more checks and error messages

Author: matthewbastien

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

@@ -3,6 +3,10 @@ import * as util from "util";
 import * as vscode from "vscode";
 import * as child_process from "child_process";
 import * as fs from "node:fs/promises";
+import {
+  showErrorWithConfigureButton,
+  showLLDBDapNotFoundMessage,
+} from "./ui/error-messages";
 
 const exec = util.promisify(child_process.execFile);
 
@@ -91,12 +95,27 @@ async function getDAPExecutable(
   return undefined;
 }
 
-function getDAPArguments(
+async function getDAPArguments(
   folder: vscode.WorkspaceFolder | undefined,
   configuration: vscode.DebugConfiguration,
-): string[] {
+  userInteractive?: boolean,
+): Promise<string[] | null | undefined> {
   // Check the debug configuration for arguments first
   const debugConfigArgs = configuration.debugAdapterArgs;
+  if (debugConfigArgs) {
+    if (
+      !Array.isArray(debugConfigArgs) ||
+      debugConfigArgs.findIndex((entry) => typeof entry !== "string") !== -1
+    ) {
+      if (!userInteractive) {
+        return undefined;
+      }
+      return showErrorWithConfigureButton(
+        "The debugAdapterArgs property must be an array of string values.",
+      );
+    }
+    return debugConfigArgs;
+  }
   if (
     Array.isArray(debugConfigArgs) &&
     debugConfigArgs.findIndex((entry) => typeof entry !== "string") === -1
@@ -109,29 +128,6 @@ function getDAPArguments(
     .get<string[]>("arguments", []);
 }
 
-/**
- * Shows a modal when the debug adapter's path is not found
- */
-async function showLLDBDapNotFoundMessage(path?: string) {
-  const message =
-    path !== undefined
-      ? `Debug adapter path: ${path} is not a valid file`
-      : "Unable to find the path to the LLDB debug adapter executable.";
-  const openSettingsAction = "Open Settings";
-  const callbackValue = await vscode.window.showErrorMessage(
-    message,
-    { modal: true },
-    openSettingsAction,
-  );
-
-  if (openSettingsAction === callbackValue) {
-    vscode.commands.executeCommand(
-      "workbench.action.openSettings",
-      "lldb-dap.executable-path",
-    );
-  }
-}
-
 /**
  * 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.
@@ -176,7 +172,10 @@ export async function createDebugAdapterExecutable(
       ...env,
     },
   };
-  const dbgArgs = getDAPArguments(folder, configuration);
+  const dbgArgs = await getDAPArguments(folder, configuration, userInteractive);
+  if (!dbgArgs) {
+    return undefined;
+  }
 
   return new vscode.DebugAdapterExecutable(dapPath, dbgArgs, dbgOptions);
 }

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

@@ -3,32 +3,10 @@ import * as child_process from "child_process";
 import * as util from "util";
 import { LLDBDapServer } from "./lldb-dap-server";
 import { createDebugAdapterExecutable } from "./debug-adapter-factory";
+import { showErrorWithConfigureButton } from "./ui/error-messages";
 
 const exec = util.promisify(child_process.execFile);
 
-/**
- * Shows an error message to the user that optionally allows them to open their
- * launch.json to configure it.
- *
- * @param message The error message to display to the user
- * @returns `undefined` if the debug session should stop or `null` if the launch.json should be opened
- */
-async function showErrorWithConfigureButton(
-  message: string,
-): Promise<null | undefined> {
-  const userSelection = await vscode.window.showErrorMessage(
-    message,
-    { modal: true },
-    "Configure",
-  );
-
-  if (userSelection === "Configure") {
-    return null; // Stops the debug session and opens the launch.json for editing
-  }
-
-  return undefined; // Only stops the debug session
-}
-
 /**
  * Determines whether or not the given lldb-dap executable supports executing
  * in server mode.

lldb/tools/lldb-dap/src-ts/ui/error-messages.ts

@@ -0,0 +1,49 @@
+import * as vscode from "vscode";
+
+/**
+ * Shows a modal when the debug adapter's path is not found
+ */
+export async function showLLDBDapNotFoundMessage(path?: string) {
+  const message =
+    path !== undefined
+      ? `Debug adapter path: ${path} is not a valid file`
+      : "Unable to find the path to the LLDB debug adapter executable.";
+  const openSettingsAction = "Open Settings";
+  const callbackValue = await vscode.window.showErrorMessage(
+    message,
+    { modal: true },
+    openSettingsAction,
+  );
+
+  if (openSettingsAction === callbackValue) {
+    vscode.commands.executeCommand(
+      "workbench.action.openSettings",
+      "lldb-dap.executable-path",
+    );
+  }
+}
+
+/**
+ * Shows an error message to the user that optionally allows them to open their
+ * launch.json to configure it.
+ *
+ * Expected to be used in the context of a {@link vscode.DebugConfigurationProvider}.
+ *
+ * @param message The error message to display to the user
+ * @returns `undefined` if the debug session should stop or `null` if the launch.json should be opened
+ */
+export async function showErrorWithConfigureButton(
+  message: string,
+): Promise<null | undefined> {
+  const userSelection = await vscode.window.showErrorMessage(
+    message,
+    { modal: true },
+    "Configure",
+  );
+
+  if (userSelection === "Configure") {
+    return null; // Stops the debug session and opens the launch.json for editing
+  }
+
+  return undefined; // Only stops the debug session
+}