Add configure and upload step when uploading to board requiring user fields

Author: silvanocerza

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

@@ -1,6 +1,6 @@
-import { inject, injectable } from 'inversify';
+import { inject, injectable, postConstruct } from 'inversify';
 import { Emitter } from '@theia/core/lib/common/event';
-import { CoreService } from '../../common/protocol';
+import { BoardUserField, CoreService } from '../../common/protocol';
 import { ArduinoMenus } from '../menu/arduino-menus';
 import { ArduinoToolbar } from '../toolbar/arduino-toolbar';
 import { BoardsDataStore } from '../boards/boards-data-store';
@@ -14,6 +14,7 @@ import {
   KeybindingRegistry,
   TabBarToolbarRegistry,
 } from './contribution';
+import { UserFieldsDialog } from '../dialogs/user-fields/user-fields-dialog';
 
 @injectable()
 export class UploadSketch extends SketchContribution {
@@ -29,16 +30,81 @@ export class UploadSketch extends SketchContribution {
   @inject(BoardsServiceProvider)
   protected readonly boardsServiceClientImpl: BoardsServiceProvider;
 
+  @inject(UserFieldsDialog)
+  protected readonly userFieldsDialog: UserFieldsDialog;
+
+  protected cachedUserFields: Map<string, BoardUserField[]> = new Map();
+
   protected readonly onDidChangeEmitter = new Emitter<Readonly<void>>();
   readonly onDidChange = this.onDidChangeEmitter.event;
 
   protected uploadInProgress = false;
+  protected boardRequiresUserFields = false;
+
+  @postConstruct()
+  protected init(): void {
+    this.boardsServiceClientImpl.onBoardsConfigChanged(async () => {
+      const userFields = await this.boardsServiceClientImpl.selectedBoardUserFields();
+      this.boardRequiresUserFields = userFields.length > 0;
+    })
+  }
+
+  private selectedFqbnAddress(): string {
+    const { boardsConfig } = this.boardsServiceClientImpl;
+    const fqbn = boardsConfig.selectedBoard?.fqbn;
+    if (!fqbn) {
+      return "";
+    }
+    const address = boardsConfig.selectedBoard?.port?.address
+    if (!address) {
+      return "";
+    }
+    return fqbn + "|" + address;
+  }
 
   registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(UploadSketch.Commands.UPLOAD_SKETCH, {
-      execute: () => this.uploadSketch(),
+      execute: async () => {
+        const key = this.selectedFqbnAddress();
+        if (!key) {
+          return;
+        }
+        if (this.boardRequiresUserFields && !this.cachedUserFields.has(key)) {
+          // Deep clone the array of board fields to avoid editing the cached ones
+          this.userFieldsDialog.value = (await this.boardsServiceClientImpl.selectedBoardUserFields()).map(f => ({ ...f }));
+          const result = await this.userFieldsDialog.open();
+          if (!result) {
+            return;
+          }
+          this.cachedUserFields.set(key, result);
+        }
+        this.uploadSketch();
+      },
       isEnabled: () => !this.uploadInProgress,
     });
+    registry.registerCommand(
+      UploadSketch.Commands.UPLOAD_WITH_CONFIGURATION,
+      {
+        execute: async () => {
+          const key = this.selectedFqbnAddress();
+          if (!key) {
+            return;
+          }
+
+          const cached = this.cachedUserFields.get(key);
+          // Deep clone the array of board fields to avoid editing the cached ones
+          this.userFieldsDialog.value = (cached ?? await this.boardsServiceClientImpl.selectedBoardUserFields()).map(f => ({ ...f }));
+
+          const result = await this.userFieldsDialog.open()
+          if (!result) {
+            return;
+          }
+          this.cachedUserFields.set(key, result);
+          this.uploadSketch();
+        },
+        isEnabled: () => !this.uploadInProgress && this.boardRequiresUserFields,
+      }
+    );
     registry.registerCommand(
       UploadSketch.Commands.UPLOAD_SKETCH_USING_PROGRAMMER,
       {
@@ -62,10 +128,15 @@ export class UploadSketch extends SketchContribution {
       label: 'Upload',
       order: '1',
     });
+    registry.registerMenuAction(ArduinoMenus.SKETCH__MAIN_GROUP, {
+      commandId: UploadSketch.Commands.UPLOAD_WITH_CONFIGURATION.id,
+      label: UploadSketch.Commands.UPLOAD_WITH_CONFIGURATION.label,
+      order: '2',
+    });
     registry.registerMenuAction(ArduinoMenus.SKETCH__MAIN_GROUP, {
       commandId: UploadSketch.Commands.UPLOAD_SKETCH_USING_PROGRAMMER.id,
       label: 'Upload Using Programmer',
-      order: '2',
+      order: '3',
     });
   }
 
@@ -131,6 +202,11 @@ export class UploadSketch extends SketchContribution {
       const optimizeForDebug = this.editorMode.compileForDebug;
       const { selectedPort } = boardsConfig;
       const port = selectedPort;
+      const userFields = this.cachedUserFields.get(this.selectedFqbnAddress());
+      if (!userFields) {
+        this.messageService.error("Can't find user fields for connected board");
+        return;
+      }
 
       if (usingProgrammer) {
         const programmer = selectedProgrammer;
@@ -143,6 +219,7 @@ export class UploadSketch extends SketchContribution {
           verbose,
           verify,
           sourceOverride,
+          userFields,
         };
       } else {
         options = {
@@ -153,6 +230,7 @@ export class UploadSketch extends SketchContribution {
           verbose,
           verify,
           sourceOverride,
+          userFields,
         };
       }
       this.outputChannelManager.getChannel('Arduino').clear();
@@ -196,6 +274,11 @@ export namespace UploadSketch {
     export const UPLOAD_SKETCH: Command = {
       id: 'arduino-upload-sketch',
     };
+    export const UPLOAD_WITH_CONFIGURATION: Command = {
+      id: 'arduino-upload-with-configuration-sketch',
+      label: 'Configure And Upload',
+      category: 'Arduino',
+    }
     export const UPLOAD_SKETCH_USING_PROGRAMMER: Command = {
       id: 'arduino-upload-sketch-using-programmer',
     };

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

@@ -1,3 +1,4 @@
+import { BoardUserField } from '.';
 import { Port } from '../../common/protocol/boards-service';
 import { Programmer } from './boards-service';
 
@@ -43,6 +44,7 @@ export namespace CoreService {
       readonly port?: Port | undefined;
       readonly programmer?: Programmer | undefined;
       readonly verify: boolean;
+      readonly userFields: BoardUserField[];
     }
   }
 

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

@@ -146,6 +146,11 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
     }
     req.setVerbose(options.verbose);
     req.setVerify(options.verify);
+
+    options.userFields.forEach(e => {
+      req.getUserFieldsMap().set(e.name, e.value);
+    });
+
     const result = responseHandler(client, req);
 
     try {