init

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

Author: Akos Kitta

arduino-ide-extension/src/browser/contributions/add-zip-library.ts

@@ -4,11 +4,8 @@ import URI from '@theia/core/lib/common/uri';
 import { ConfirmDialog } from '@theia/core/lib/browser/dialogs';
 import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
 import { ArduinoMenus } from '../menu/arduino-menus';
-import {
-  Installable,
-  LibraryService,
-  ResponseServiceClient,
-} from '../../common/protocol';
+import { LibraryService, ResponseServiceClient } from '../../common/protocol';
+import { ExecuteWithProgress } from '../../common/progressible';
 import {
   SketchContribution,
   Command,
@@ -88,7 +85,7 @@ export class AddZipLibrary extends SketchContribution {
 
   private async doInstall(zipUri: string, overwrite?: boolean): Promise<void> {
     try {
-      await Installable.doWithProgress({
+      await ExecuteWithProgress.doWithProgress({
         messageService: this.messageService,
         progressText:
           nls.localize('arduino/common/processing', 'Processing') +

arduino-ide-extension/src/browser/contributions/burn-bootloader.ts

@@ -13,10 +13,10 @@ import { nls } from '@theia/core/lib/common';
 @injectable()
 export class BurnBootloader extends CoreServiceContribution {
   @inject(BoardsDataStore)
-  protected readonly boardsDataStore: BoardsDataStore;
+  private readonly boardsDataStore: BoardsDataStore;
 
   @inject(BoardsServiceProvider)
-  protected readonly boardsServiceClientImpl: BoardsServiceProvider;
+  private readonly boardsServiceClientImpl: BoardsServiceProvider;
 
   override registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(BurnBootloader.Commands.BURN_BOOTLOADER, {
@@ -35,32 +35,33 @@ export class BurnBootloader extends CoreServiceContribution {
     });
   }
 
-  async burnBootloader(): Promise<void> {
+  private async burnBootloader(): Promise<void> {
+    const { boardsConfig } = this.boardsServiceClientImpl;
+    const port = boardsConfig.selectedPort;
+    const [fqbn, { selectedProgrammer: programmer }, verify, verbose] =
+      await Promise.all([
+        this.boardsDataStore.appendConfigToFqbn(
+          boardsConfig.selectedBoard?.fqbn
+        ),
+        this.boardsDataStore.getData(boardsConfig.selectedBoard?.fqbn),
+        this.preferences.get('arduino.upload.verify'),
+        this.preferences.get('arduino.upload.verbose'),
+      ]);
     try {
-      const { boardsConfig } = this.boardsServiceClientImpl;
-      const port = boardsConfig.selectedPort;
-      const [fqbn, { selectedProgrammer: programmer }, verify, verbose] =
-        await Promise.all([
-          this.boardsDataStore.appendConfigToFqbn(
-            boardsConfig.selectedBoard?.fqbn
-          ),
-          this.boardsDataStore.getData(boardsConfig.selectedBoard?.fqbn),
-          this.preferences.get('arduino.upload.verify'),
-          this.preferences.get('arduino.upload.verbose'),
-        ]);
-
-      const board = {
-        ...boardsConfig.selectedBoard,
-        name: boardsConfig.selectedBoard?.name || '',
-        fqbn,
-      };
-      this.outputChannelManager.getChannel('Arduino').clear();
-      await this.coreService.burnBootloader({
-        board,
-        programmer,
-        port,
-        verify,
-        verbose,
+      await this.doWithProgress({
+        progressText: nls.localize(
+          'arduino/bootloader/burningBootloader',
+          'Burning bootloader...'
+        ),
+        task: (progressId, coreService) =>
+          coreService.burnBootloader({
+            fqbn,
+            programmer,
+            port,
+            verify,
+            verbose,
+            progressId,
+          }),
       });
       this.messageService.info(
         nls.localize(

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

@@ -49,13 +49,15 @@ import {
   Sketch,
   CoreService,
   CoreError,
+  ResponseServiceClient,
 } from '../../common/protocol';
 import { ArduinoPreferences } from '../arduino-preferences';
 import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
 import { CoreErrorHandler } from './core-error-handler';
 import { nls } from '@theia/core';
 import { OutputChannelManager } from '../theia/output/output-channel';
 import { ClipboardService } from '@theia/core/lib/browser/clipboard-service';
+import { ExecuteWithProgress } from '../../common/progressible';
 
 export {
   Command,
@@ -167,16 +169,19 @@ export abstract class SketchContribution extends Contribution {
 }
 
 @injectable()
-export class CoreServiceContribution extends SketchContribution {
-  @inject(CoreService)
-  protected readonly coreService: CoreService;
-
+export abstract class CoreServiceContribution extends SketchContribution {
   @inject(CoreErrorHandler)
-  protected readonly coreErrorHandler: CoreErrorHandler;
+  protected readonly coreErrorHandler: CoreErrorHandler; // TODO: make this `private`.
+
+  @inject(CoreService)
+  private readonly coreService: CoreService;
 
   @inject(ClipboardService)
   private readonly clipboardService: ClipboardService;
 
+  @inject(ResponseServiceClient)
+  private readonly responseService: ResponseServiceClient;
+
   protected handleError(error: unknown): void {
     this.coreErrorHandler.tryHandle(error);
     this.tryToastErrorMessage(error);
@@ -214,6 +219,30 @@ export class CoreServiceContribution extends SketchContribution {
       throw error;
     }
   }
+
+  protected async doWithProgress<T>(options: {
+    progressText: string;
+    keepOutput?: boolean;
+    task: (progressId: string, coreService: CoreService) => Promise<T>;
+  }): Promise<T> {
+    const { progressText, keepOutput, task } = options;
+    if (!keepOutput) {
+      this.resetOutput();
+    }
+    const result = await ExecuteWithProgress.doWithProgress({
+      messageService: this.messageService,
+      responseService: this.responseService,
+      progressText,
+      run: ({ progressId }) => task(progressId, this.coreService),
+    });
+    return result;
+  }
+
+  private resetOutput(): void {
+    const channel = this.outputChannelManager.getChannel('Arduino');
+    channel.clear();
+    channel.show({ preserveFocus: true });
+  }
 }
 
 export namespace Contribution {

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

@@ -16,30 +16,29 @@ import {
 import { UserFieldsDialog } from '../dialogs/user-fields/user-fields-dialog';
 import { DisposableCollection, nls } from '@theia/core/lib/common';
 import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { VerifySketch } from './verify-sketch';
 
 @injectable()
 export class UploadSketch extends CoreServiceContribution {
   @inject(MenuModelRegistry)
-  protected readonly menuRegistry: MenuModelRegistry;
+  private readonly menuRegistry: MenuModelRegistry;
 
   @inject(BoardsDataStore)
-  protected readonly boardsDataStore: BoardsDataStore;
+  private readonly boardsDataStore: BoardsDataStore;
 
   @inject(BoardsServiceProvider)
-  protected readonly boardsServiceClientImpl: BoardsServiceProvider;
+  private readonly boardsServiceClientImpl: BoardsServiceProvider;
 
   @inject(UserFieldsDialog)
-  protected readonly userFieldsDialog: UserFieldsDialog;
+  private readonly userFieldsDialog: UserFieldsDialog;
 
-  protected cachedUserFields: Map<string, BoardUserField[]> = new Map();
+  private boardRequiresUserFields = false;
+  private readonly cachedUserFields: Map<string, BoardUserField[]> = new Map();
+  private readonly menuActionsDisposables = new DisposableCollection();
 
-  protected readonly onDidChangeEmitter = new Emitter<Readonly<void>>();
-  readonly onDidChange = this.onDidChangeEmitter.event;
-
-  protected uploadInProgress = false;
-  protected boardRequiresUserFields = false;
-
-  protected readonly menuActionsDisposables = new DisposableCollection();
+  private readonly onDidChangeEmitter = new Emitter<void>();
+  private readonly onDidChange = this.onDidChangeEmitter.event;
+  private uploadInProgress = false;
 
   protected override init(): void {
     super.init();
@@ -130,7 +129,6 @@ export class UploadSketch extends CoreServiceContribution {
 
   override registerMenus(registry: MenuModelRegistry): void {
     this.menuActionsDisposables.dispose();
-
     this.menuActionsDisposables.push(
       registry.registerMenuAction(ArduinoMenus.SKETCH__MAIN_GROUP, {
         commandId: UploadSketch.Commands.UPLOAD_SKETCH.id,
@@ -153,7 +151,7 @@ export class UploadSketch extends CoreServiceContribution {
           new PlaceholderMenuNode(
             ArduinoMenus.SKETCH__MAIN_GROUP,
             // commandId: UploadSketch.Commands.UPLOAD_WITH_CONFIGURATION.id,
-            UploadSketch.Commands.UPLOAD_WITH_CONFIGURATION.label!,
+            UploadSketch.Commands.UPLOAD_WITH_CONFIGURATION.label,
             { order: '2' }
           )
         )
@@ -193,13 +191,31 @@ export class UploadSketch extends CoreServiceContribution {
   }
 
   async uploadSketch(usingProgrammer = false): Promise<void> {
-    // even with buttons disabled, better to double check if an upload is already in progress
     if (this.uploadInProgress) {
       return;
     }
 
-    const sketch = await this.sketchServiceClient.currentSketch();
-    if (!CurrentSketch.isValid(sketch)) {
+    const ref = await this.commandService.executeCommand<VerifySketch.Ref>(
+      VerifySketch.Commands.VERIFY_SKETCH.id,
+      false
+    );
+
+    if (!ref) {
+      return;
+    }
+
+    const options = await this.options(usingProgrammer, ref);
+    if (!options) {
+      return;
+    }
+
+    if (options.userFields.length === 0 && this.boardRequiresUserFields) {
+      this.messageService.error(
+        nls.localize(
+          'arduino/sketch/userFieldsNotFoundError',
+          "Can't find user fields for connected board"
+        )
+      );
       return;
     }
 
@@ -209,81 +225,14 @@ export class UploadSketch extends CoreServiceContribution {
       this.uploadInProgress = true;
       this.coreErrorHandler.reset();
       this.onDidChangeEmitter.fire();
-      const { boardsConfig } = this.boardsServiceClientImpl;
-      const [
-        fqbn,
-        { selectedProgrammer },
-        verify,
-        uploadVerbose,
-        sourceOverride,
-        optimizeForDebug,
-        compileVerbose,
-      ] = await Promise.all([
-        this.boardsDataStore.appendConfigToFqbn(
-          boardsConfig.selectedBoard?.fqbn
-        ),
-        this.boardsDataStore.getData(boardsConfig.selectedBoard?.fqbn),
-        this.preferences.get('arduino.upload.verify'),
-        this.preferences.get('arduino.upload.verbose'),
-        this.sourceOverride(),
-        this.commandService.executeCommand<boolean>(
-          'arduino-is-optimize-for-debug'
-        ),
-        this.preferences.get('arduino.compile.verbose'),
-      ]);
-
-      const verbose = { compile: compileVerbose, upload: uploadVerbose };
-      const board = {
-        ...boardsConfig.selectedBoard,
-        name: boardsConfig.selectedBoard?.name || '',
-        fqbn,
-      };
-      let options: CoreService.Upload.Options | undefined = undefined;
-      const { selectedPort } = boardsConfig;
-      const port = selectedPort;
-      const userFields =
-        this.cachedUserFields.get(this.selectedFqbnAddress()) ?? [];
-      if (userFields.length === 0 && this.boardRequiresUserFields) {
-        this.messageService.error(
-          nls.localize(
-            'arduino/sketch/userFieldsNotFoundError',
-            "Can't find user fields for connected board"
-          )
-        );
-        return;
-      }
+      await this.doWithProgress({
+        progressText: nls.localize('arduino/sketch/uploading', 'Uploading...'),
+        task: (progressId, coreService) => {
+          return coreService.upload({ ...options, progressId });
+        },
+        keepOutput: true,
+      });
 
-      if (usingProgrammer) {
-        const programmer = selectedProgrammer;
-        options = {
-          sketch,
-          board,
-          optimizeForDebug: Boolean(optimizeForDebug),
-          programmer,
-          port,
-          verbose,
-          verify,
-          sourceOverride,
-          userFields,
-        };
-      } else {
-        options = {
-          sketch,
-          board,
-          optimizeForDebug: Boolean(optimizeForDebug),
-          port,
-          verbose,
-          verify,
-          sourceOverride,
-          userFields,
-        };
-      }
-      this.outputChannelManager.getChannel('Arduino').clear();
-      if (usingProgrammer) {
-        await this.coreService.uploadUsingProgrammer(options);
-      } else {
-        await this.coreService.upload(options);
-      }
       this.messageService.info(
         nls.localize('arduino/sketch/doneUploading', 'Done uploading.'),
         { timeout: 3000 }
@@ -295,14 +244,47 @@ export class UploadSketch extends CoreServiceContribution {
       this.onDidChangeEmitter.fire();
     }
   }
+
+  private async options(
+    usingProgrammer: boolean,
+    verifyRef: VerifySketch.Ref
+  ): Promise<CoreService.Options.Upload | undefined> {
+    const sketch = await this.sketchServiceClient.currentSketch();
+    if (!CurrentSketch.isValid(sketch)) {
+      return undefined;
+    }
+    const userFields = this.userFields();
+    const { boardsConfig } = this.boardsServiceClientImpl;
+    const [fqbn, { selectedProgrammer: programmer }, verify, verbose] =
+      await Promise.all([
+        verifyRef.fqbn.decorated,
+        this.boardsDataStore.getData(verifyRef.fqbn.original),
+        this.preferences.get('arduino.upload.verify'),
+        this.preferences.get('arduino.upload.verbose'),
+      ]);
+    const port = boardsConfig.selectedPort;
+    return {
+      sketch,
+      fqbn,
+      ...(usingProgrammer && { programmer }),
+      port,
+      verbose,
+      verify,
+      userFields,
+    };
+  }
+
+  private userFields() {
+    return this.cachedUserFields.get(this.selectedFqbnAddress()) ?? [];
+  }
 }
 
 export namespace UploadSketch {
   export namespace Commands {
     export const UPLOAD_SKETCH: Command = {
       id: 'arduino-upload-sketch',
     };
-    export const UPLOAD_WITH_CONFIGURATION: Command = {
+    export const UPLOAD_WITH_CONFIGURATION: Command & { label: string } = {
       id: 'arduino-upload-with-configuration-sketch',
       label: nls.localize(
         'arduino/sketch/configureAndUpload',