feat: use new debug -I -P CLI output

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

.eslintrc.js

@@ -18,7 +18,7 @@ module.exports = {
     'electron-app/src-gen/*',
     'electron-app/gen-webpack*.js',
     '!electron-app/webpack.config.js',
-    'plugins/*',
+    'electron-app/plugins/*',
     'arduino-ide-extension/src/node/cli-protocol',
     '**/lib/*',
   ],

arduino-ide-extension/src/browser/contributions/debug.ts

@@ -1,46 +1,75 @@
+import { Emitter, Event } from '@theia/core/lib/common/event';
+import { MenuModelRegistry } from '@theia/core/lib/common/menu/menu-model-registry';
+import { nls } from '@theia/core/lib/common/nls';
 import { inject, injectable } from '@theia/core/shared/inversify';
-import { Event, Emitter } from '@theia/core/lib/common/event';
 import { HostedPluginSupport } from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin';
-import { ArduinoToolbar } from '../toolbar/arduino-toolbar';
-import { NotificationCenter } from '../notification-center';
 import {
   Board,
   BoardIdentifier,
   BoardsService,
   ExecutableService,
+  SketchRef,
   isBoardIdentifierChangeEvent,
-  Sketch,
 } from '../../common/protocol';
+import { BoardsDataStore } from '../boards/boards-data-store';
 import { BoardsServiceProvider } from '../boards/boards-service-provider';
+import { ArduinoMenus } from '../menu/arduino-menus';
+import { NotificationCenter } from '../notification-center';
+import { CurrentSketch } from '../sketches-service-client-impl';
+import { ArduinoToolbar } from '../toolbar/arduino-toolbar';
 import {
-  URI,
   Command,
   CommandRegistry,
   SketchContribution,
   TabBarToolbarRegistry,
+  URI,
 } from './contribution';
-import { MenuModelRegistry, nls } from '@theia/core/lib/common';
-import { CurrentSketch } from '../sketches-service-client-impl';
-import { ArduinoMenus } from '../menu/arduino-menus';
 
 const COMPILE_FOR_DEBUG_KEY = 'arduino-compile-for-debug';
 
+interface StartDebugParams {
+  /**
+   * Absolute filesystem path to the Arduino CLI executable.
+   */
+  readonly cliPath: string;
+  /**
+   * The the board to debug.
+   */
+  readonly board: Readonly<{ fqbn: string; name?: string }>;
+  /**
+   * Absolute filesystem path of the sketch to debug.
+   */
+  readonly sketchPath: string;
+  /**
+   * Location where the `launch.json` will be created on the fly before starting every debug session.
+   * If not defined, it falls back to `sketchPath/.vscode/launch.json`.
+   */
+  readonly launchConfigPath?: string;
+  /**
+   * Absolute path to the `arduino-cli.yaml` file. If not specified, it falls back to `~/.arduinoIDE/arduino-cli.yaml`.
+   */
+  readonly cliConfigPath?: string;
+  /**
+   * Programmer for the debugging.
+   */
+  readonly programmer?: string;
+}
+type StartDebugResult = boolean;
+
 @injectable()
 export class Debug extends SketchContribution {
   @inject(HostedPluginSupport)
   private readonly hostedPluginSupport: HostedPluginSupport;
-
   @inject(NotificationCenter)
   private readonly notificationCenter: NotificationCenter;
-
   @inject(ExecutableService)
   private readonly executableService: ExecutableService;
-
   @inject(BoardsService)
   private readonly boardService: BoardsService;
-
   @inject(BoardsServiceProvider)
   private readonly boardsServiceProvider: BoardsServiceProvider;
+  @inject(BoardsDataStore)
+  private readonly boardsDataStore: BoardsDataStore;
 
   /**
    * If `undefined`, debugging is enabled. Otherwise, the reason why it's disabled.
@@ -175,42 +204,18 @@ export class Debug extends SketchContribution {
   private async startDebug(
     board: BoardIdentifier | undefined = this.boardsServiceProvider.boardsConfig
       .selectedBoard
-  ): Promise<void> {
-    if (!board) {
-      return;
-    }
-    const { name, fqbn } = board;
-    if (!fqbn) {
-      return;
+  ): Promise<StartDebugResult> {
+    const params = await this.createStartDebugParams(board);
+    if (!params) {
+      return false;
     }
     await this.hostedPluginSupport.didStart;
-    const [sketch, executables] = await Promise.all([
-      this.sketchServiceClient.currentSketch(),
-      this.executableService.list(),
-    ]);
-    if (!CurrentSketch.isValid(sketch)) {
-      return;
-    }
-    const ideTempFolderUri = await this.sketchesService.getIdeTempFolderUri(
-      sketch
-    );
-    const [cliPath, sketchPath, configPath] = await Promise.all([
-      this.fileService.fsPath(new URI(executables.cliUri)),
-      this.fileService.fsPath(new URI(sketch.uri)),
-      this.fileService.fsPath(new URI(ideTempFolderUri)),
-    ]);
-    const config = {
-      cliPath,
-      board: {
-        fqbn,
-        name,
-      },
-      sketchPath,
-      configPath,
-    };
     try {
-      await this.commandService.executeCommand('arduino.debug.start', config);
+      const result = await this.debug(params);
+      return Boolean(result);
     } catch (err) {
+      const sketchUri = await this.fileSystemExt.getUri(params.sketchPath);
+      const sketch = SketchRef.fromUri(sketchUri);
       if (await this.isSketchNotVerifiedError(err, sketch)) {
         const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
         const answer = await this.messageService.error(
@@ -230,6 +235,16 @@ export class Debug extends SketchContribution {
         );
       }
     }
+    return false;
+  }
+
+  private async debug(
+    params: StartDebugParams
+  ): Promise<StartDebugResult | undefined> {
+    return this.commandService.executeCommand<StartDebugResult>(
+      'arduino.debug.start',
+      params
+    );
   }
 
   get compileForDebug(): boolean {
@@ -246,7 +261,7 @@ export class Debug extends SketchContribution {
 
   private async isSketchNotVerifiedError(
     err: unknown,
-    sketch: Sketch
+    sketch: SketchRef
   ): Promise<boolean> {
     if (err instanceof Error) {
       try {
@@ -260,6 +275,37 @@ export class Debug extends SketchContribution {
     }
     return false;
   }
+
+  private async createStartDebugParams(
+    board: BoardIdentifier | undefined
+  ): Promise<StartDebugParams | undefined> {
+    if (!board || !board.fqbn) {
+      return undefined;
+    }
+    const [sketch, executables, boardsData] = await Promise.all([
+      this.sketchServiceClient.currentSketch(),
+      this.executableService.list(),
+      this.boardsDataStore.getData(board.fqbn),
+    ]);
+    if (!CurrentSketch.isValid(sketch)) {
+      return;
+    }
+    const ideTempFolderUri = await this.sketchesService.getIdeTempFolderUri(
+      sketch
+    );
+    const [cliPath, sketchPath, launchConfigPath] = await Promise.all([
+      this.fileService.fsPath(new URI(executables.cliUri)),
+      this.fileService.fsPath(new URI(sketch.uri)),
+      this.fileService.fsPath(new URI(ideTempFolderUri)),
+    ]);
+    return {
+      board: { fqbn: board.fqbn, name: board.name },
+      cliPath,
+      sketchPath,
+      launchConfigPath,
+      programmer: boardsData.selectedProgrammer?.id,
+    };
+  }
 }
 export namespace Debug {
   export namespace Commands {

arduino-ide-extension/src/common/protocol/sketches-service.ts

@@ -121,7 +121,7 @@ export interface SketchesService {
    * Hence, IDE2 has to provide multiple build paths on Windows. This hack will be obsolete when the CLI can provide error codes:
    * https://github.com/arduino/arduino-cli/issues/1762.
    */
-  tempBuildPath(sketch: Sketch): Promise<string[]>;
+  tempBuildPath(sketch: SketchRef): Promise<string[]>;
 }
 
 export interface SketchRef {

arduino-ide-extension/src/node/sketches-service-impl.ts

@@ -555,12 +555,12 @@ export class SketchesServiceImpl
     return destinationUri;
   }
 
-  async getIdeTempFolderUri(sketch: Sketch): Promise<string> {
+  async getIdeTempFolderUri(sketch: SketchRef): Promise<string> {
     const genBuildPath = await this.getIdeTempFolderPath(sketch);
     return FileUri.create(genBuildPath).toString();
   }
 
-  private async getIdeTempFolderPath(sketch: Sketch): Promise<string> {
+  private async getIdeTempFolderPath(sketch: SketchRef): Promise<string> {
     const sketchPath = FileUri.fsPath(sketch.uri);
     await fs.readdir(sketchPath); // Validates the sketch folder and rejects if not accessible.
     const suffix = crypto.createHash('md5').update(sketchPath).digest('hex');