debugPort for debug adapter server in debugger settings (#1587)

* add debugPort for debug adapter server in debugger settings, add in debug doc

* dispose current debug adapter server if port is changed

Author: brianignacio5

docs_espressif/en/debugproject.rst

@@ -144,6 +144,7 @@ You can modify the configuration to suit your needs. Let's describe the configur
 
 Some additional arguments you might use are:
 
+- ``debugPort``: (Default: 43476) The port to launch the Eclipse CDT GDB Debug Adapter server. If not specified, it will use the default value of 43476.
 - ``runOpenOCD``: (Default: true). Run extension OpenOCD Server.
 - ``verifyAppBinBeforeDebug``: (Default: false) Verify that current ESP-IDF project binary is the same as binary in chip.
 - ``logFile``: Absolute path to the file to log interaction with gdb. Example: ${workspaceFolder}/gdb.log.

package.json

@@ -1878,6 +1878,11 @@
                 "type": "string",
                 "description": "Working directory (cwd) to use when launching gdb. Defaults to the directory of the 'program'"
               },
+              "debugPort": {
+                "type": "number",
+                "description": "Port for Debug Adapter server. Default: 43476",
+                "default": 43476
+              },
               "runOpenOCD": {
                 "type": "boolean",
                 "description": "Run OpenOCD Server",
@@ -2147,6 +2152,11 @@
                 "type": "string",
                 "description": "Working directory (cwd) to use when launching gdb. Defaults to the directory of the 'program'"
               },
+              "debugPort": {
+                "type": "number",
+                "description": "Port for Debug Adapter server. Default: 43476",
+                "default": 43476
+              },
               "runOpenOCD": {
                 "type": "boolean",
                 "description": "Run OpenOCD Server",

src/cdtDebugAdapter/server.ts

@@ -37,7 +37,6 @@ export class CDTDebugAdapterDescriptorFactory
     executable: DebugAdapterExecutable | undefined
   ): ProviderResult<DebugAdapterDescriptor> {
     if (!this.server) {
-      // start listening on a random port
       const portToUse = session.configuration.debugPort || DEBUG_DEFAULT_PORT;
       this.server = createServer((socket) => {
         const gdbTargetDebugSession = new GDBTargetDebugSession();
@@ -46,13 +45,30 @@ export class CDTDebugAdapterDescriptorFactory
       }).listen(portToUse);
     }
 
-    // make VS Code connect to debug server
-    return new DebugAdapterServer((<AddressInfo>this.server.address()).port);
+    const address = this.server.address();
+    if (address && typeof address === "object" && address.port) {
+      return new DebugAdapterServer((<AddressInfo>address).port);
+    } else {
+      this.dispose();
+      throw new Error("Failed to get CDT Debug Adapter server address or port.");
+    }
+  }
+
+  checkCurrentPort(port: number): boolean {
+    if (!this.server) {
+      return false;
+    }
+    const address = this.server.address();
+    if (address && typeof address === "object" && address.port) {
+      return (<AddressInfo>address).port === port;
+    }
+    return false;
   }
 
   dispose() {
     if (this.server) {
       this.server.close();
+      this.server = undefined;
     }
   }
 }

src/extension.ts

@@ -265,6 +265,8 @@ const minIdfVersionCheck = async function (
 
 let projectConfigManager: ProjectConfigurationManager | undefined;
 
+let cdtDebugAdapterFactory: CDTDebugAdapterDescriptorFactory | undefined;
+
 export async function activate(context: vscode.ExtensionContext) {
   // Always load Logger first
   Logger.init(context);
@@ -1201,6 +1203,21 @@ export async function activate(context: vscode.ExtensionContext) {
 
   vscode.workspace.onDidChangeConfiguration(async (e) => {
     const winFlag = process.platform === "win32" ? "Win" : "";
+    // Launch.json changes
+    if (e.affectsConfiguration("launch.configurations")) {
+      const config = vscode.workspace.getConfiguration("launch", workspaceRoot);
+      const configurations =
+        config.get<vscode.DebugConfiguration[]>("configurations") || [];
+      for (const conf of configurations) {
+        if (
+          conf.type === "gdbtarget" &&
+          conf.debugPort &&
+          !cdtDebugAdapterFactory.checkCurrentPort(conf.debugPort)
+        ) {
+          cdtDebugAdapterFactory.dispose();
+        }
+      }
+    }
     if (e.affectsConfiguration("idf.enableStatusBar")) {
       const enableStatusBar = idfConf.readParameter(
         "idf.enableStatusBar",
@@ -1270,10 +1287,11 @@ export async function activate(context: vscode.ExtensionContext) {
     )
   );
 
+  cdtDebugAdapterFactory = new CDTDebugAdapterDescriptorFactory();
   context.subscriptions.push(
     vscode.debug.registerDebugAdapterDescriptorFactory(
       "gdbtarget",
-      new CDTDebugAdapterDescriptorFactory()
+      cdtDebugAdapterFactory
     )
   );