fix: single config update API

Author: Akos Kitta

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

@@ -44,8 +44,8 @@ import {
   isBoardListHistory,
   SelectBoardsConfigActionParams,
 } from '../../common/protocol/board-list';
-import { Defined } from '../../common/types';
-import {
+import type { Defined } from '../../common/types';
+import type {
   StartupTask,
   StartupTaskProvider,
 } from '../../electron-common/startup-task';
@@ -200,48 +200,6 @@ export class BoardsServiceProvider
     this.boardListDumper?.dispose();
   }
 
-  private async maybeUpdateSelectedBoard(platformDidInstallEvent: {
-    item: BoardsPackage;
-  }): Promise<void> {
-    const { selectedBoard } = this._boardsConfig;
-    if (
-      selectedBoard &&
-      !selectedBoard.fqbn &&
-      BoardWithPackage.is(selectedBoard)
-    ) {
-      const selectedBoardPlatformId = serializePlatformIdentifier(
-        selectedBoard.packageId
-      );
-      if (selectedBoardPlatformId === platformDidInstallEvent.item.id) {
-        const installedSelectedBoard = platformDidInstallEvent.item.boards.find(
-          (board) => board.name === selectedBoard.name
-        );
-        // if the board can be found by its name after the install event select it. otherwise unselect it
-        // historical hint: https://github.com/arduino/arduino-ide/blob/144df893d0dafec64a26565cf912a98f32572da9/arduino-ide-extension/src/browser/boards/boards-service-provider.ts#L289-L320
-        this.updateBoard(installedSelectedBoard);
-        if (!installedSelectedBoard) {
-          const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
-          const answer = await this.messageService.warn(
-            nls.localize(
-              'arduino/board/couldNotFindPreviouslySelected',
-              "Could not find previously selected board '{0}' in installed platform '{1}'. Please manually reselect the board you want to use. Do you want to reselect it now?",
-              selectedBoard.name,
-              platformDidInstallEvent.item.name
-            ),
-            nls.localize('arduino/board/reselectLater', 'Reselect later'),
-            yes
-          );
-          if (answer === yes) {
-            this.onBoardsConfigEdit({
-              query: selectedBoard.name,
-              portToSelect: this._boardsConfig.selectedPort,
-            });
-          }
-        }
-      }
-    }
-  }
-
   registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(USE_INHERITED_CONFIG, {
       execute: (
@@ -285,6 +243,48 @@ export class BoardsServiceProvider
     ];
   }
 
+  private async maybeUpdateSelectedBoard(platformDidInstallEvent: {
+    item: BoardsPackage;
+  }): Promise<void> {
+    const { selectedBoard } = this._boardsConfig;
+    if (
+      selectedBoard &&
+      !selectedBoard.fqbn &&
+      BoardWithPackage.is(selectedBoard)
+    ) {
+      const selectedBoardPlatformId = serializePlatformIdentifier(
+        selectedBoard.packageId
+      );
+      if (selectedBoardPlatformId === platformDidInstallEvent.item.id) {
+        const installedSelectedBoard = platformDidInstallEvent.item.boards.find(
+          (board) => board.name === selectedBoard.name
+        );
+        // if the board can be found by its name after the install event select it. otherwise unselect it
+        // historical hint: https://github.com/arduino/arduino-ide/blob/144df893d0dafec64a26565cf912a98f32572da9/arduino-ide-extension/src/browser/boards/boards-service-provider.ts#L289-L320
+        this.updateBoard(installedSelectedBoard);
+        if (!installedSelectedBoard) {
+          const yes = nls.localize('vscode/extensionsUtils/yes', 'Yes');
+          const answer = await this.messageService.warn(
+            nls.localize(
+              'arduino/board/couldNotFindPreviouslySelected',
+              "Could not find previously selected board '{0}' in installed platform '{1}'. Please manually reselect the board you want to use. Do you want to reselect it now?",
+              selectedBoard.name,
+              platformDidInstallEvent.item.name
+            ),
+            nls.localize('arduino/board/reselectLater', 'Reselect later'),
+            yes
+          );
+          if (answer === yes) {
+            this.onBoardsConfigEdit({
+              query: selectedBoard.name,
+              portToSelect: this._boardsConfig.selectedPort,
+            });
+          }
+        }
+      }
+    }
+  }
+
   private refreshBoardList(params?: RefreshBoardListParams): void {
     if (params?.detectedPorts) {
       this._detectedPorts = params.detectedPorts;
@@ -344,16 +344,30 @@ export class BoardsServiceProvider
         reason
       );
     } else if (selectedBoard) {
-      this.updateBoard(selectedBoard);
+      this.updateConfig(selectedBoard);
     } else if (selectedPort) {
-      this.updatePort(selectedPort);
+      this.updateConfig(selectedPort);
     }
   }
 
   updateConfig(
     boardsConfig: Defined<BoardsConfig>,
     reason?: UpdateBoardsConfigReason
+  ): boolean;
+  updateConfig(selectedBoard: BoardIdentifier): boolean;
+  updateConfig(selectedPort: PortIdentifier): boolean;
+  updateConfig(
+    arg: Defined<BoardsConfig> | BoardIdentifier | PortIdentifier,
+    reason?: UpdateBoardsConfigReason
   ): boolean {
+    if (isBoardIdentifier(arg)) {
+      return this.updateBoard(arg);
+    }
+    if (isPortIdentifier(arg)) {
+      return this.updatePort(arg);
+    }
+
+    const boardsConfig = arg;
     const selectedBoard = boardsConfig.selectedBoard;
     const previousSelectedBoard = this._boardsConfig.selectedBoard;
     const selectedPort = boardsConfig.selectedPort;
@@ -400,7 +414,9 @@ export class BoardsServiceProvider
     return true;
   }
 
-  updateBoard(selectedBoard: BoardIdentifier | undefined): boolean {
+  // `undefined` is special case when a non installed board is selected (no FQBN), the platform is installed,
+  // but there is no way to determine the FQBN from the previous partial data, and IDE2 unsets the board.
+  private updateBoard(selectedBoard: BoardIdentifier | undefined): boolean {
     const previousSelectedBoard = this._boardsConfig.selectedBoard;
     if (boardIdentifierEquals(previousSelectedBoard, selectedBoard)) {
       // NOOP if they're the same
@@ -416,7 +432,7 @@ export class BoardsServiceProvider
     return true;
   }
 
-  updatePort(selectedPort: PortIdentifier | undefined): boolean {
+  private updatePort(selectedPort: PortIdentifier): boolean {
     const selectedBoard = this._boardsConfig.selectedBoard;
     const previousSelectedPort = this._boardsConfig.selectedPort;
     if (selectedPort && selectedBoard) {

arduino-ide-extension/src/browser/contributions/board-selection.ts

@@ -248,7 +248,7 @@ SN: ${SN}
             const command = { id };
             const handler = {
               execute: () =>
-                this.boardsServiceProvider.updateBoard({
+                this.boardsServiceProvider.updateConfig({
                   name: name,
                   fqbn: fqbn,
                 }),
@@ -320,7 +320,7 @@ SN: ${SN}
         const command = { id };
         const handler = {
           execute: () => {
-            this.boardsServiceProvider.updatePort({
+            this.boardsServiceProvider.updateConfig({
               protocol: port.protocol,
               address: port.address,
             });

arduino-ide-extension/src/browser/contributions/upload-sketch.ts

@@ -153,7 +153,7 @@ export class UploadSketch extends CoreServiceContribution {
         )
       ) {
         // https://github.com/arduino/arduino-cli/issues/2245
-        this.boardsServiceProvider.updatePort(uploadResponse.portAfterUpload);
+        this.boardsServiceProvider.updateConfig(uploadResponse.portAfterUpload);
       }
 
       this.messageService.info(