better progress report for the index update.

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

Author: Akos Kitta

arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -303,6 +303,7 @@ import { CompilerErrors } from './contributions/compiler-errors';
 import { WidgetManager } from './theia/core/widget-manager';
 import { WidgetManager as TheiaWidgetManager } from '@theia/core/lib/browser/widget-manager';
 import { IndexesUpdateProgress } from './contributions/indexes-update-progress';
+import { Daemon } from './contributions/daemon';
 
 MonacoThemingService.register({
   id: 'arduino-theme',
@@ -700,6 +701,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   Contribution.configure(bind, Format);
   Contribution.configure(bind, CompilerErrors);
   Contribution.configure(bind, IndexesUpdateProgress);
+  Contribution.configure(bind, Daemon);
 
   // Disabled the quick-pick customization from Theia when multiple formatters are available.
   // Use the default VS Code behavior, and pick the first one. In the IDE2, clang-format has `exclusive` selectors.

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

@@ -0,0 +1,38 @@
+import { nls } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { ArduinoDaemon } from '../../common/protocol';
+import { Contribution, Command, CommandRegistry } from './contribution';
+
+@injectable()
+export class Daemon extends Contribution {
+  @inject(ArduinoDaemon)
+  private readonly daemon: ArduinoDaemon;
+
+  override registerCommands(registry: CommandRegistry): void {
+    registry.registerCommand(Daemon.Commands.START_DAEMON, {
+      execute: () => this.daemon.start(),
+    });
+    registry.registerCommand(Daemon.Commands.STOP_DAEMON, {
+      execute: () => this.daemon.stop(),
+    });
+    registry.registerCommand(Daemon.Commands.RESTART_DAEMON, {
+      execute: () => this.daemon.restart(),
+    });
+  }
+}
+export namespace Daemon {
+  export namespace Commands {
+    export const START_DAEMON: Command = {
+      id: 'arduino-start-daemon',
+      label: nls.localize('arduino/daemon/start', 'Start Daemon'),
+    };
+    export const STOP_DAEMON: Command = {
+      id: 'arduino-stop-daemon',
+      label: nls.localize('arduino/daemon/stop', 'Stop Daemon'),
+    };
+    export const RESTART_DAEMON: Command = {
+      id: 'arduino-restart-daemon',
+      label: nls.localize('arduino/daemon/restart', 'Restart Daemon'),
+    };
+  }
+}

arduino-ide-extension/src/browser/contributions/indexes-update-progress.ts

@@ -1,7 +1,7 @@
 import { Progress } from '@theia/core/lib/common/message-service-protocol';
 import { ProgressService } from '@theia/core/lib/common/progress-service';
 import { inject, injectable } from '@theia/core/shared/inversify';
-import { ProgressMessage } from '../../common/protocol';
+import { CoreMessages, ProgressMessage } from '../../common/protocol';
 import { NotificationCenter } from '../notification-center';
 import { Contribution } from './contribution';
 
@@ -54,16 +54,13 @@ export class IndexesUpdateProgress extends Contribution {
     }
     this.currentProgress = undefined;
     const progress = await this.progressService.showProgress({
-      text: 'Arduino',
-      // TODO: IDE2 could show the progress in `notification`, like the platform/library install and uninstall.
-      // However, the index update progress responses are not much helpful. They cannot provide a fine-grain progress.
-      // So IDE2 could report two total works only: index update and library index update.
-      // See here an example: https://github.com/arduino/arduino-ide/issues/906#issuecomment-1171145630
-      // Due to this, IDE2 shows a spinner on the status bar.
-      options: { location: 'window' },
+      text: '',
+      options: { location: 'notification' },
     });
     if (ProgressMessage.is(progressOrId)) {
-      progress.report(progressOrId); // if the client has missed the `willStart` event, report the progress immediately.
+      progress.report(progressOrId);
+    } else {
+      progress.report({ message: CoreMessages.UpdateIndex });
     }
     this.currentProgress = { ...progress, progressId };
     return this.currentProgress;

arduino-ide-extension/src/common/protocol/arduino-daemon.ts

@@ -12,4 +12,7 @@ export interface ArduinoDaemon {
    * Otherwise resolves to the CLI daemon port.
    */
   tryGetPort(): Promise<string | undefined>;
+  start(): Promise<string>;
+  stop(): Promise<void>;
+  restart(): Promise<string>;
 }

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

@@ -1,10 +1,21 @@
-import { ApplicationError } from '@theia/core';
-import { Location } from '@theia/core/shared/vscode-languageserver-protocol';
-import { BoardUserField } from '.';
-import { Board, Port } from '../../common/protocol/boards-service';
-import { ErrorInfo as CliErrorInfo } from '../../node/cli-error-parser';
-import { Programmer } from './boards-service';
-import { Sketch } from './sketches-service';
+import { nls } from '@theia/core/lib/common/nls';
+import { ApplicationError } from '@theia/core/lib/common/application-error';
+import type { Location } from '@theia/core/shared/vscode-languageserver-protocol';
+import type {
+  Board,
+  BoardUserField,
+  Port,
+} from '../../common/protocol/boards-service';
+import type { ErrorInfo as CliErrorInfo } from '../../node/cli-error-parser';
+import type { Programmer } from './boards-service';
+import type { Sketch } from './sketches-service';
+
+export namespace CoreMessages {
+  export const UpdateIndex = nls.localize(
+    'arduino/coreService/updateIndex',
+    'Updating indexes'
+  );
+}
 
 export const CompilerWarningLiterals = [
   'None',

arduino-ide-extension/src/node/arduino-daemon-impl.ts

@@ -4,7 +4,7 @@ import { inject, injectable, named } from '@theia/core/shared/inversify';
 import { spawn, ChildProcess } from 'child_process';
 import { FileUri } from '@theia/core/lib/node/file-uri';
 import { ILogger } from '@theia/core/lib/common/logger';
-import { Deferred } from '@theia/core/lib/common/promise-util';
+import { Deferred, retry } from '@theia/core/lib/common/promise-util';
 import {
   Disposable,
   DisposableCollection,
@@ -23,26 +23,26 @@ export class ArduinoDaemonImpl
 {
   @inject(ILogger)
   @named('daemon')
-  protected readonly logger: ILogger;
+  private readonly logger: ILogger;
 
   @inject(EnvVariablesServer)
-  protected readonly envVariablesServer: EnvVariablesServer;
+  private readonly envVariablesServer: EnvVariablesServer;
 
   @inject(NotificationServiceServer)
-  protected readonly notificationService: NotificationServiceServer;
+  private readonly notificationService: NotificationServiceServer;
 
-  protected readonly toDispose = new DisposableCollection();
-  protected readonly onDaemonStartedEmitter = new Emitter<string>();
-  protected readonly onDaemonStoppedEmitter = new Emitter<void>();
+  private readonly toDispose = new DisposableCollection();
+  private readonly onDaemonStartedEmitter = new Emitter<string>();
+  private readonly onDaemonStoppedEmitter = new Emitter<void>();
 
-  protected _running = false;
-  protected _port = new Deferred<string>();
-  protected _execPath: string | undefined;
+  private _running = false;
+  private _port = new Deferred<string>();
+  private _execPath: string | undefined;
 
   // Backend application lifecycle.
 
   onStart(): void {
-    this.startDaemon(); // no await
+    this.start(); // no await
   }
 
   // Daemon API
@@ -58,7 +58,7 @@ export class ArduinoDaemonImpl
     return undefined;
   }
 
-  async startDaemon(): Promise<void> {
+  async start(): Promise<string> {
     try {
       this.toDispose.dispose(); // This will `kill` the previously started daemon process, if any.
       const cliPath = await this.getExecPath();
@@ -86,24 +86,29 @@ export class ArduinoDaemonImpl
       ]);
       this.fireDaemonStarted(port);
       this.onData('Daemon is running.');
+      return port;
     } catch (err) {
-      this.onData('Failed to start the daemon.');
-      this.onError(err);
-      let i = 5; // TODO: make this better
-      while (i) {
-        this.onData(`Restarting daemon in ${i} seconds...`);
-        await new Promise((resolve) => setTimeout(resolve, 1000));
-        i--;
-      }
-      this.onData('Restarting daemon now...');
-      return this.startDaemon();
+      return retry(
+        () => {
+          this.onError(err);
+          return this.start();
+        },
+        1_000,
+        5
+      );
     }
   }
 
-  async stopDaemon(): Promise<void> {
+  async stop(): Promise<void> {
     this.toDispose.dispose();
   }
 
+  async restart(): Promise<string> {
+    return this.start();
+  }
+
+  // Backend only daemon API
+
   get onDaemonStarted(): Event<string> {
     return this.onDaemonStartedEmitter.event;
   }
@@ -275,14 +280,14 @@ export class ArduinoDaemonImpl
     return ready.promise;
   }
 
-  protected fireDaemonStarted(port: string): void {
+  private fireDaemonStarted(port: string): void {
     this._running = true;
     this._port.resolve(port);
     this.onDaemonStartedEmitter.fire(port);
     this.notificationService.notifyDaemonDidStart(port);
   }
 
-  protected fireDaemonStopped(): void {
+  private fireDaemonStopped(): void {
     if (!this._running) {
       return;
     }
@@ -297,7 +302,8 @@ export class ArduinoDaemonImpl
     this.logger.info(message);
   }
 
-  protected onError(error: any): void {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  private onError(error: any): void {
     this.logger.error(error);
   }
 }