chore: use 0.35.0-rc.6 CLI + new check debug API

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

Author: Akos Kitta

arduino-ide-extension/package.json

@@ -169,7 +169,7 @@
   ],
   "arduino": {
     "arduino-cli": {
-      "version": "0.35.0-rc.5"
+      "version": "0.35.0-rc.6"
     },
     "arduino-fwuploader": {
       "version": "2.4.1"

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

@@ -3,7 +3,7 @@ import { MenuModelRegistry } from '@theia/core/lib/common/menu/menu-model-regist
 import { nls } from '@theia/core/lib/common/nls';
 import { MaybePromise } from '@theia/core/lib/common/types';
 import { inject, injectable } from '@theia/core/shared/inversify';
-import { noBoardSelected, noSketchOpened } from '../../common/nls';
+import { noBoardSelected } from '../../common/nls';
 import {
   BoardDetails,
   BoardIdentifier,
@@ -193,24 +193,30 @@ export class Debug extends SketchContribution {
     }
   }
 
-  private async isDebugEnabled(): Promise<void> {
-    const sketch = this.sketchServiceClient.tryGetCurrentSketch();
-    const board = this.boardsServiceProvider.boardsConfig.selectedBoard;
-    await isDebugEnabled(
-      sketch,
+  private async isDebugEnabled(
+    board: BoardIdentifier | undefined = this.boardsServiceProvider.boardsConfig
+      .selectedBoard
+  ): Promise<string> {
+    const debugFqbn = await isDebugEnabled(
       board,
       (fqbn) => this.boardService.getBoardDetails({ fqbn }),
       (fqbn) => this.boardsDataStore.getData(fqbn),
       (fqbn) => this.boardsDataStore.appendConfigToFqbn(fqbn),
-      (params) => this.boardService.checkDebugEnabled(params),
-      (reason, sketch) => this.isSketchNotVerifiedError(reason, sketch)
+      (params) => this.boardService.checkDebugEnabled(params)
     );
+    return debugFqbn;
   }
 
   private async startDebug(
     board: BoardIdentifier | undefined = this.boardsServiceProvider.boardsConfig
-      .selectedBoard
+      .selectedBoard,
+    sketch:
+      | CurrentSketch
+      | undefined = this.sketchServiceClient.tryGetCurrentSketch()
   ): Promise<StartDebugResult> {
+    if (!CurrentSketch.isValid(sketch)) {
+      return false;
+    }
     const params = await this.createStartDebugParams(board);
     if (!params) {
       return false;
@@ -220,6 +226,20 @@ export class Debug extends SketchContribution {
       const result = await this.debug(params);
       return Boolean(result);
     } catch (err) {
+      if (await this.isSketchNotVerifiedError(err, sketch)) {
+        const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
+        const answer = await this.messageService.error(
+          sketchIsNotCompiled(sketch.name),
+          yes
+        );
+        if (answer === yes) {
+          this.commandService.executeCommand('arduino-verify-sketch');
+        }
+      } else {
+        this.messageService.error(
+          err instanceof Error ? err.message : String(err)
+        );
+      }
       console.error(err);
       this.messageService.error(
         err instanceof Error ? err.message : String(err)
@@ -272,13 +292,20 @@ export class Debug extends SketchContribution {
     if (!board || !board.fqbn) {
       return undefined;
     }
+    let debugFqbn: string | undefined = undefined;
+    try {
+      debugFqbn = await this.isDebugEnabled(board);
+    } catch {}
+    if (!debugFqbn) {
+      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;
+      return undefined;
     }
     const ideTempFolderUri = await this.sketchesService.getIdeTempFolderUri(
       sketch
@@ -289,7 +316,7 @@ export class Debug extends SketchContribution {
       this.fileService.fsPath(new URI(ideTempFolderUri)),
     ]);
     return {
-      board: { fqbn: board.fqbn, name: board.name },
+      board: { fqbn: debugFqbn, name: board.name },
       cliPath,
       sketchPath,
       launchConfigsDirPath,
@@ -329,20 +356,12 @@ export namespace Debug {
  * (non-API)
  */
 export async function isDebugEnabled(
-  sketch: CurrentSketch | undefined,
   board: BoardIdentifier | undefined,
   getDetails: (fqbn: string) => MaybePromise<BoardDetails | undefined>,
   getData: (fqbn: string) => MaybePromise<BoardsDataStore.Data>,
   appendConfigToFqbn: (fqbn: string) => MaybePromise<string | undefined>,
-  checkDebugEnabled: (params: CheckDebugEnabledParams) => MaybePromise<void>,
-  isSketchNotVerifiedError: (
-    err: unknown,
-    sketchRef: SketchRef
-  ) => MaybePromise<boolean>
-): Promise<void> {
-  if (!CurrentSketch.isValid(sketch)) {
-    throw new Error(noSketchOpened);
-  }
+  checkDebugEnabled: (params: CheckDebugEnabledParams) => MaybePromise<string>
+): Promise<string> {
   if (!board) {
     throw new Error(noBoardSelected);
   }
@@ -369,15 +388,11 @@ export async function isDebugEnabled(
   const params = {
     fqbn: fqbnWithConfig,
     programmer: data.selectedProgrammer.id,
-    sketchUri: sketch.uri,
   };
   try {
-    await checkDebugEnabled(params);
+    const debugFqbn = await checkDebugEnabled(params);
+    return debugFqbn;
   } catch (err) {
-    const sketchNotVerified = await isSketchNotVerifiedError(err, sketch);
-    if (sketchNotVerified) {
-      throw new Error(sketchIsNotCompiled(sketch.name));
-    }
     throw new Error(debuggingNotSupported(board.name));
   }
 }
@@ -388,7 +403,7 @@ export async function isDebugEnabled(
 export function sketchIsNotCompiled(sketchName: string): string {
   return nls.localize(
     'arduino/debug/sketchIsNotCompiled',
-    "Sketch '{0}' must be verified before starting a debug session",
+    "Sketch '{0}' must be verified before starting a debug session. Please verify the sketch and start debugging again. Do you want to verify the sketch now?",
     sketchName
   );
 }

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

@@ -82,15 +82,20 @@ export interface BoardsService
   }): Promise<BoardUserField[]>;
   /**
    * Checks whether the debugging is enabled with the FQBN, programmer, current sketch, and custom board options.
-   * Rejects when the debugging is unsupported.
+   *
+   * When the debugging is enabled, the promise resolves with the FQBN to use with the debugger. This is the same
+   * FQBN given in the `CheckDebugEnabledParams#fqbn` but cleaned up of the board options that do not affect the debugger configuration.
+   * It may be used by clients/IDE to group slightly different boards option selections under the same debug configuration.
    */
-  checkDebugEnabled(params: CheckDebugEnabledParams): Promise<void>;
+  checkDebugEnabled(params: CheckDebugEnabledParams): Promise<string>;
 }
 
 export interface CheckDebugEnabledParams {
+  /**
+   * The FQBN might contain custom board config options. For example, `arduino:esp32:nano_nora:USBMode=hwcdc,option2=value2`.
+   */
   readonly fqbn: string;
   readonly programmer: string;
-  readonly sketchUri: string;
 }
 
 export interface BoardSearch extends Searchable.Options {

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

@@ -1,7 +1,6 @@
 import { ILogger } from '@theia/core/lib/common/logger';
 import { nls } from '@theia/core/lib/common/nls';
 import { notEmpty } from '@theia/core/lib/common/objects';
-import { FileUri } from '@theia/core/lib/node/file-uri';
 import { inject, injectable } from '@theia/core/shared/inversify';
 import {
   Board,
@@ -42,7 +41,7 @@ import {
   PlatformSearchResponse,
   PlatformUninstallRequest,
 } from './cli-protocol/cc/arduino/cli/commands/v1/core_pb';
-import { GetDebugConfigRequest } from './cli-protocol/cc/arduino/cli/commands/v1/debug_pb';
+import { IsDebugSupportedRequest } from './cli-protocol/cc/arduino/cli/commands/v1/debug_pb';
 import {
   ListProgrammersAvailableForUploadRequest,
   ListProgrammersAvailableForUploadResponse,
@@ -173,30 +172,32 @@ export class BoardsServiceImpl
     };
   }
 
-  async checkDebugEnabled(params: CheckDebugEnabledParams): Promise<void> {
-    const { fqbn, programmer, sketchUri } = params;
-    const sketchPath = FileUri.fsPath(sketchUri);
+  async checkDebugEnabled(params: CheckDebugEnabledParams): Promise<string> {
+    const { fqbn, programmer } = params;
     const { client, instance } = await this.coreClient;
-    const req = new GetDebugConfigRequest()
+    const req = new IsDebugSupportedRequest()
       .setInstance(instance)
       .setFqbn(fqbn)
-      .setProgrammer(programmer)
-      .setSketchPath(sketchPath);
+      .setProgrammer(programmer);
     try {
-      await new Promise<void>((resolve, reject) =>
-        client.getDebugConfig(req, (err) => {
+      const debugFqbn = await new Promise<string>((resolve, reject) =>
+        client.isDebugSupported(req, (err, resp) => {
           if (err) {
             reject(err);
-          } else {
-            resolve();
+            return;
+          }
+          if (resp.getDebuggingSupported()) {
+            const debugFqbn = resp.getDebugFqbn();
+            if (debugFqbn) {
+              resolve(debugFqbn);
+            }
           }
+          reject(new Error(`Debugging is not supported.`));
         })
       );
+      return debugFqbn;
     } catch (err) {
-      console.error(
-        `Failed to get debug config: ${fqbn}, ${programmer}, ${sketchPath}`,
-        err
-      );
+      console.error(`Failed to get debug config: ${fqbn}, ${programmer}`, err);
       throw err;
     }
   }

arduino-ide-extension/src/node/cli-protocol/cc/arduino/cli/commands/v1/commands_grpc_pb.d.ts

@@ -57,6 +57,7 @@ interface IArduinoCoreServiceService extends grpc.ServiceDefinition<grpc.Untyped
     monitor: IArduinoCoreServiceService_IMonitor;
     enumerateMonitorPortSettings: IArduinoCoreServiceService_IEnumerateMonitorPortSettings;
     debug: IArduinoCoreServiceService_IDebug;
+    isDebugSupported: IArduinoCoreServiceService_IIsDebugSupported;
     getDebugConfig: IArduinoCoreServiceService_IGetDebugConfig;
 }
 
@@ -420,6 +421,15 @@ interface IArduinoCoreServiceService_IDebug extends grpc.MethodDefinition<cc_ard
     responseSerialize: grpc.serialize<cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
     responseDeserialize: grpc.deserialize<cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
 }
+interface IArduinoCoreServiceService_IIsDebugSupported extends grpc.MethodDefinition<cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse> {
+    path: "/cc.arduino.cli.commands.v1.ArduinoCoreService/IsDebugSupported";
+    requestStream: false;
+    responseStream: false;
+    requestSerialize: grpc.serialize<cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest>;
+    requestDeserialize: grpc.deserialize<cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest>;
+    responseSerialize: grpc.serialize<cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse>;
+    responseDeserialize: grpc.deserialize<cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse>;
+}
 interface IArduinoCoreServiceService_IGetDebugConfig extends grpc.MethodDefinition<cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse> {
     path: "/cc.arduino.cli.commands.v1.ArduinoCoreService/GetDebugConfig";
     requestStream: false;
@@ -473,6 +483,7 @@ export interface IArduinoCoreServiceServer extends grpc.UntypedServiceImplementa
     monitor: grpc.handleBidiStreamingCall<cc_arduino_cli_commands_v1_monitor_pb.MonitorRequest, cc_arduino_cli_commands_v1_monitor_pb.MonitorResponse>;
     enumerateMonitorPortSettings: grpc.handleUnaryCall<cc_arduino_cli_commands_v1_monitor_pb.EnumerateMonitorPortSettingsRequest, cc_arduino_cli_commands_v1_monitor_pb.EnumerateMonitorPortSettingsResponse>;
     debug: grpc.handleBidiStreamingCall<cc_arduino_cli_commands_v1_debug_pb.DebugRequest, cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
+    isDebugSupported: grpc.handleUnaryCall<cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse>;
     getDebugConfig: grpc.handleUnaryCall<cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse>;
 }
 
@@ -578,6 +589,9 @@ export interface IArduinoCoreServiceClient {
     debug(): grpc.ClientDuplexStream<cc_arduino_cli_commands_v1_debug_pb.DebugRequest, cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
     debug(options: Partial<grpc.CallOptions>): grpc.ClientDuplexStream<cc_arduino_cli_commands_v1_debug_pb.DebugRequest, cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
     debug(metadata: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientDuplexStream<cc_arduino_cli_commands_v1_debug_pb.DebugRequest, cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
+    isDebugSupported(request: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse) => void): grpc.ClientUnaryCall;
+    isDebugSupported(request: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse) => void): grpc.ClientUnaryCall;
+    isDebugSupported(request: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse) => void): grpc.ClientUnaryCall;
     getDebugConfig(request: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse) => void): grpc.ClientUnaryCall;
     getDebugConfig(request: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse) => void): grpc.ClientUnaryCall;
     getDebugConfig(request: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse) => void): grpc.ClientUnaryCall;
@@ -684,6 +698,9 @@ export class ArduinoCoreServiceClient extends grpc.Client implements IArduinoCor
     public enumerateMonitorPortSettings(request: cc_arduino_cli_commands_v1_monitor_pb.EnumerateMonitorPortSettingsRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_monitor_pb.EnumerateMonitorPortSettingsResponse) => void): grpc.ClientUnaryCall;
     public debug(options?: Partial<grpc.CallOptions>): grpc.ClientDuplexStream<cc_arduino_cli_commands_v1_debug_pb.DebugRequest, cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
     public debug(metadata?: grpc.Metadata, options?: Partial<grpc.CallOptions>): grpc.ClientDuplexStream<cc_arduino_cli_commands_v1_debug_pb.DebugRequest, cc_arduino_cli_commands_v1_debug_pb.DebugResponse>;
+    public isDebugSupported(request: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse) => void): grpc.ClientUnaryCall;
+    public isDebugSupported(request: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse) => void): grpc.ClientUnaryCall;
+    public isDebugSupported(request: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse) => void): grpc.ClientUnaryCall;
     public getDebugConfig(request: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse) => void): grpc.ClientUnaryCall;
     public getDebugConfig(request: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse) => void): grpc.ClientUnaryCall;
     public getDebugConfig(request: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: cc_arduino_cli_commands_v1_debug_pb.GetDebugConfigResponse) => void): grpc.ClientUnaryCall;

arduino-ide-extension/src/node/cli-protocol/cc/arduino/cli/commands/v1/commands_grpc_pb.js

@@ -358,6 +358,28 @@ function deserialize_cc_arduino_cli_commands_v1_InitResponse(buffer_arg) {
   return cc_arduino_cli_commands_v1_commands_pb.InitResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_cc_arduino_cli_commands_v1_IsDebugSupportedRequest(arg) {
+  if (!(arg instanceof cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest)) {
+    throw new Error('Expected argument of type cc.arduino.cli.commands.v1.IsDebugSupportedRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_cc_arduino_cli_commands_v1_IsDebugSupportedRequest(buffer_arg) {
+  return cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_cc_arduino_cli_commands_v1_IsDebugSupportedResponse(arg) {
+  if (!(arg instanceof cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse)) {
+    throw new Error('Expected argument of type cc.arduino.cli.commands.v1.IsDebugSupportedResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_cc_arduino_cli_commands_v1_IsDebugSupportedResponse(buffer_arg) {
+  return cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_cc_arduino_cli_commands_v1_LibraryDownloadRequest(arg) {
   if (!(arg instanceof cc_arduino_cli_commands_v1_lib_pb.LibraryDownloadRequest)) {
     throw new Error('Expected argument of type cc.arduino.cli.commands.v1.LibraryDownloadRequest');
@@ -1424,7 +1446,20 @@ debug: {
     responseSerialize: serialize_cc_arduino_cli_commands_v1_DebugResponse,
     responseDeserialize: deserialize_cc_arduino_cli_commands_v1_DebugResponse,
   },
-  getDebugConfig: {
+  // Determine if debugging is suported given a specific configuration.
+isDebugSupported: {
+    path: '/cc.arduino.cli.commands.v1.ArduinoCoreService/IsDebugSupported',
+    requestStream: false,
+    responseStream: false,
+    requestType: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedRequest,
+    responseType: cc_arduino_cli_commands_v1_debug_pb.IsDebugSupportedResponse,
+    requestSerialize: serialize_cc_arduino_cli_commands_v1_IsDebugSupportedRequest,
+    requestDeserialize: deserialize_cc_arduino_cli_commands_v1_IsDebugSupportedRequest,
+    responseSerialize: serialize_cc_arduino_cli_commands_v1_IsDebugSupportedResponse,
+    responseDeserialize: deserialize_cc_arduino_cli_commands_v1_IsDebugSupportedResponse,
+  },
+  // Query the debugger information given a specific configuration.
+getDebugConfig: {
     path: '/cc.arduino.cli.commands.v1.ArduinoCoreService/GetDebugConfig',
     requestStream: false,
     responseStream: false,