Implement methods to get user fields for board/port combination

Author: silvanocerza

arduino-ide-extension/src/browser/boards/boards-service-provider.ts

@@ -12,6 +12,7 @@ import {
   BoardsPackage,
   AttachedBoardsChangeEvent,
   BoardWithPackage,
+  BoardUserField,
 } from '../../common/protocol';
 import { BoardsConfig } from './boards-config';
 import { naturalCompare } from '../../common/utils';
@@ -173,8 +174,8 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
         const selectedAvailableBoard = AvailableBoard.is(selectedBoard)
           ? selectedBoard
           : this._availableBoards.find((availableBoard) =>
-              Board.sameAs(availableBoard, selectedBoard)
-            );
+            Board.sameAs(availableBoard, selectedBoard)
+          );
         if (
           selectedAvailableBoard &&
           selectedAvailableBoard.selected &&
@@ -264,6 +265,18 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
     return boards;
   }
 
+  async selectedBoardUserFields(): Promise<BoardUserField[]> {
+    if (!this._boardsConfig.selectedBoard || !this._boardsConfig.selectedPort) {
+      return [];
+    }
+    const fqbn = this._boardsConfig.selectedBoard.fqbn;
+    if (!fqbn) {
+      return [];
+    }
+    const protocol = this._boardsConfig.selectedPort.protocol;
+    return await this.boardsService.getBoardUserFields({ fqbn, protocol });
+  }
+
   /**
    * `true` if the `config.selectedBoard` is defined; hence can compile against the board. Otherwise, `false`.
    */
@@ -337,14 +350,14 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
     const timeoutTask =
       !!timeout && timeout > 0
         ? new Promise<void>((_, reject) =>
-            setTimeout(
-              () => reject(new Error(`Timeout after ${timeout} ms.`)),
-              timeout
-            )
+          setTimeout(
+            () => reject(new Error(`Timeout after ${timeout} ms.`)),
+            timeout
           )
+        )
         : new Promise<void>(() => {
-            /* never */
-          });
+          /* never */
+        });
     const waitUntilTask = new Promise<void>((resolve) => {
       let candidate = find(what, this.availableBoards);
       if (candidate) {
@@ -478,9 +491,8 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
 
   protected getLastSelectedBoardOnPortKey(port: Port | string): string {
     // TODO: we lose the port's `protocol` info (`serial`, `network`, etc.) here if the `port` is a `string`.
-    return `last-selected-board-on-port:${
-      typeof port === 'string' ? port : Port.toString(port)
-    }`;
+    return `last-selected-board-on-port:${typeof port === 'string' ? port : Port.toString(port)
+      }`;
   }
 
   protected async loadState(): Promise<void> {

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

@@ -134,7 +134,7 @@ export const BoardsServicePath = '/services/boards-service';
 export const BoardsService = Symbol('BoardsService');
 export interface BoardsService
   extends Installable<BoardsPackage>,
-    Searchable<BoardsPackage> {
+  Searchable<BoardsPackage> {
   /**
    * Deprecated. `getState` should be used to correctly map a board with a port.
    * @deprecated
@@ -152,6 +152,7 @@ export interface BoardsService
     fqbn: string;
   }): Promise<BoardsPackage | undefined>;
   searchBoards({ query }: { query?: string }): Promise<BoardWithPackage[]>;
+  getBoardUserFields(options: { fqbn: string, protocol: string }): Promise<BoardUserField[]>;
 }
 
 export interface Port {
@@ -342,6 +343,14 @@ export interface Board {
   readonly port?: Port;
 }
 
+export interface BoardUserField {
+  readonly toolId: string;
+  readonly name: string;
+  readonly label: string;
+  readonly secret: boolean;
+  value: string;
+}
+
 export interface BoardWithPackage extends Board {
   readonly packageName: string;
   readonly packageId: string;

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

@@ -16,6 +16,7 @@ import {
   NotificationServiceServer,
   AvailablePorts,
   BoardWithPackage,
+  BoardUserField,
 } from '../common/protocol';
 import {
   PlatformInstallRequest,
@@ -36,6 +37,8 @@ import {
 import {
   ListProgrammersAvailableForUploadRequest,
   ListProgrammersAvailableForUploadResponse,
+  SupportedUserFieldsRequest,
+  SupportedUserFieldsResponse,
 } from './cli-protocol/cc/arduino/cli/commands/v1/upload_pb';
 import { InstallWithProgress } from './grpc-installable';
 
@@ -244,6 +247,35 @@ export class BoardsServiceImpl
     return boards;
   }
 
+  async getBoardUserFields(options: { fqbn: string, protocol: string }): Promise<BoardUserField[]> {
+    await this.coreClientProvider.initialized;
+    const coreClient = await this.coreClient();
+    const { client, instance } = coreClient;
+
+    const supportedUserFieldsReq = new SupportedUserFieldsRequest();
+    supportedUserFieldsReq.setInstance(instance);
+    supportedUserFieldsReq.setFqbn(options.fqbn);
+    supportedUserFieldsReq.setProtocol(options.protocol);
+
+    const supportedUserFieldsResp = await new Promise<SupportedUserFieldsResponse>(
+      (resolve, reject) => {
+        client.supportedUserFields(supportedUserFieldsReq, (err, resp) => {
+          (!!err ? reject : resolve)(!!err ? err : resp)
+        })
+      }
+    );
+    return supportedUserFieldsResp.getUserFieldsList().map(e => {
+      return {
+        toolId: e.getToolId(),
+        name: e.getName(),
+        label: e.getLabel(),
+        secret: e.getSecret(),
+        value: "",
+      };
+    });
+  }
+
+
   async search(options: { query?: string }): Promise<BoardsPackage[]> {
     await this.coreClientProvider.initialized;
     const coreClient = await this.coreClient();