Show 'progress' indicator during verify/upload.

Closes #575 Closes #1175 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
arduino · Aug 1, 2022 · e156dcc · e156dcc
1 parent 27a2a6c
commit e156dcc
Show file tree

Hide file tree

Showing 13 changed files with 554 additions and 407 deletions.
diff --git a/arduino-ide-extension/src/browser/contributions/add-zip-library.ts b/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/protocol/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') +

diff --git a/arduino-ide-extension/src/browser/contributions/burn-bootloader.ts b/arduino-ide-extension/src/browser/contributions/burn-bootloader.ts
@@ -1,23 +1,16 @@
-import { inject, injectable } from '@theia/core/shared/inversify';
+import { nls } from '@theia/core/lib/common';
+import { injectable } from '@theia/core/shared/inversify';
+import { CoreService } from '../../common/protocol';
 import { ArduinoMenus } from '../menu/arduino-menus';
-import { BoardsDataStore } from '../boards/boards-data-store';
-import { BoardsServiceProvider } from '../boards/boards-service-provider';
 import {
-  CoreServiceContribution,
   Command,
   CommandRegistry,
+  CoreServiceContribution,
   MenuModelRegistry,
 } from './contribution';
-import { nls } from '@theia/core/lib/common';
 
 @injectable()
 export class BurnBootloader extends CoreServiceContribution {
-  @inject(BoardsDataStore)
-  protected readonly boardsDataStore: BoardsDataStore;
-
-  @inject(BoardsServiceProvider)
-  protected readonly boardsServiceClientImpl: BoardsServiceProvider;
-
   override registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(BurnBootloader.Commands.BURN_BOOTLOADER, {
       execute: () => this.burnBootloader(),
@@ -35,32 +28,19 @@ export class BurnBootloader extends CoreServiceContribution {
     });
   }
 
-  async burnBootloader(): Promise<void> {
+  private async burnBootloader(): Promise<void> {
+    const options = await this.options();
     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({
+            ...options,
+            progressId,
+          }),
       });
       this.messageService.info(
         nls.localize(
@@ -75,6 +55,27 @@ export class BurnBootloader extends CoreServiceContribution {
       this.handleError(e);
     }
   }
+
+  private async options(): Promise<CoreService.Options.Bootloader> {
+    const { boardsConfig } = this.boardsServiceProvider;
+    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'),
+      ]);
+    return {
+      fqbn,
+      programmer,
+      port,
+      verify,
+      verbose,
+    };
+  }
 }
 
 export namespace BurnBootloader {

diff --git a/arduino-ide-extension/src/browser/contributions/contribution.ts b/arduino-ide-extension/src/browser/contributions/contribution.ts
@@ -49,13 +49,16 @@ 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/protocol/progressible';
+import { BoardsServiceProvider } from '../boards/boards-service-provider';
+import { BoardsDataStore } from '../boards/boards-data-store';
 
 export {
   Command,
@@ -167,18 +170,23 @@ 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(BoardsDataStore)
+  protected readonly boardsDataStore: BoardsDataStore;
+
+  @inject(BoardsServiceProvider)
+  protected readonly boardsServiceProvider: BoardsServiceProvider;
 
-  @inject(CoreErrorHandler)
-  protected readonly coreErrorHandler: CoreErrorHandler;
+  @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 +222,25 @@ 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;
+    this.outputChannelManager
+      .getChannel('Arduino')
+      .show({ preserveFocus: true });
+    const result = await ExecuteWithProgress.doWithProgress({
+      messageService: this.messageService,
+      responseService: this.responseService,
+      progressText,
+      run: ({ progressId }) => task(progressId, this.coreService),
+      keepOutput,
+    });
+    return result;
+  }
 }
 
 export namespace Contribution {