Update package index on 3rd party URLs change.

Closes #637
Closes #906

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

Author: Akos Kitta

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

@@ -302,6 +302,7 @@ import { CoreErrorHandler } from './contributions/core-error-handler';
 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';
 
 MonacoThemingService.register({
   id: 'arduino-theme',
@@ -698,6 +699,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   Contribution.configure(bind, PlotterFrontendContribution);
   Contribution.configure(bind, Format);
   Contribution.configure(bind, CompilerErrors);
+  Contribution.configure(bind, IndexesUpdateProgress);
 
   // 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/boards/boards-config.tsx

@@ -113,7 +113,7 @@ export class BoardsConfig extends React.Component<
           );
         }
       }),
-      this.props.notificationCenter.onAttachedBoardsChanged((event) =>
+      this.props.notificationCenter.onAttachedBoardsDidChange((event) =>
         this.updatePorts(
           event.newState.ports,
           AttachedBoardsChangeEvent.diff(event).detached.ports
@@ -126,19 +126,19 @@ export class BoardsConfig extends React.Component<
           );
         }
       ),
-      this.props.notificationCenter.onPlatformInstalled(() =>
+      this.props.notificationCenter.onPlatformDidInstall(() =>
         this.updateBoards(this.state.query)
       ),
-      this.props.notificationCenter.onPlatformUninstalled(() =>
+      this.props.notificationCenter.onPlatformDidUninstall(() =>
         this.updateBoards(this.state.query)
       ),
-      this.props.notificationCenter.onIndexUpdated(() =>
+      this.props.notificationCenter.onIndexDidUpdate(() =>
         this.updateBoards(this.state.query)
       ),
-      this.props.notificationCenter.onDaemonStarted(() =>
+      this.props.notificationCenter.onDaemonDidStart(() =>
         this.updateBoards(this.state.query)
       ),
-      this.props.notificationCenter.onDaemonStopped(() =>
+      this.props.notificationCenter.onDaemonDidStop(() =>
         this.setState({ searchResults: [] })
       ),
       this.props.onFilteredTextDidChangeEvent((query) =>

arduino-ide-extension/src/browser/boards/boards-data-store.ts

@@ -33,7 +33,7 @@ export class BoardsDataStore implements FrontendApplicationContribution {
   protected readonly onChangedEmitter = new Emitter<void>();
 
   onStart(): void {
-    this.notificationCenter.onPlatformInstalled(async ({ item }) => {
+    this.notificationCenter.onPlatformDidInstall(async ({ item }) => {
       let shouldFireChanged = false;
       for (const fqbn of item.boards
         .map(({ fqbn }) => fqbn)

arduino-ide-extension/src/browser/boards/boards-list-widget.ts

@@ -33,10 +33,10 @@ export class BoardsListWidget extends ListWidget<BoardsPackage> {
   protected override init(): void {
     super.init();
     this.toDispose.pushAll([
-      this.notificationCenter.onPlatformInstalled(() =>
+      this.notificationCenter.onPlatformDidInstall(() =>
         this.refresh(undefined)
       ),
-      this.notificationCenter.onPlatformUninstalled(() =>
+      this.notificationCenter.onPlatformDidUninstall(() =>
         this.refresh(undefined)
       ),
     ]);

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

@@ -74,13 +74,13 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
   readonly onAvailablePortsChanged = this.onAvailablePortsChangedEmitter.event;
 
   onStart(): void {
-    this.notificationCenter.onAttachedBoardsChanged(
+    this.notificationCenter.onAttachedBoardsDidChange(
       this.notifyAttachedBoardsChanged.bind(this)
     );
-    this.notificationCenter.onPlatformInstalled(
+    this.notificationCenter.onPlatformDidInstall(
       this.notifyPlatformInstalled.bind(this)
     );
-    this.notificationCenter.onPlatformUninstalled(
+    this.notificationCenter.onPlatformDidUninstall(
       this.notifyPlatformUninstalled.bind(this)
     );
 

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

@@ -101,8 +101,8 @@ PID: ${PID}`;
   }
 
   override onStart(): void {
-    this.notificationCenter.onPlatformInstalled(() => this.updateMenus());
-    this.notificationCenter.onPlatformUninstalled(() => this.updateMenus());
+    this.notificationCenter.onPlatformDidInstall(() => this.updateMenus());
+    this.notificationCenter.onPlatformDidUninstall(() => this.updateMenus());
     this.boardsServiceProvider.onBoardsConfigChanged(() => this.updateMenus());
     this.boardsServiceProvider.onAvailableBoardsChanged(() =>
       this.updateMenus()

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

@@ -83,8 +83,8 @@ export class Debug extends SketchContribution {
     this.boardsServiceProvider.onBoardsConfigChanged(({ selectedBoard }) =>
       this.refreshState(selectedBoard)
     );
-    this.notificationCenter.onPlatformInstalled(() => this.refreshState());
-    this.notificationCenter.onPlatformUninstalled(() => this.refreshState());
+    this.notificationCenter.onPlatformDidInstall(() => this.refreshState());
+    this.notificationCenter.onPlatformDidUninstall(() => this.refreshState());
   }
 
   override onReady(): MaybePromise<void> {

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

@@ -202,8 +202,8 @@ export class LibraryExamples extends Examples {
   protected readonly queue = new PQueue({ autoStart: true, concurrency: 1 });
 
   override onStart(): void {
-    this.notificationCenter.onLibraryInstalled(() => this.register());
-    this.notificationCenter.onLibraryUninstalled(() => this.register());
+    this.notificationCenter.onLibraryDidInstall(() => this.register());
+    this.notificationCenter.onLibraryDidUninstall(() => this.register());
   }
 
   override async onReady(): Promise<void> {

arduino-ide-extension/src/browser/contributions/include-library.ts

@@ -49,8 +49,8 @@ export class IncludeLibrary extends SketchContribution {
     this.boardsServiceClient.onBoardsConfigChanged(() =>
       this.updateMenuActions()
     );
-    this.notificationCenter.onLibraryInstalled(() => this.updateMenuActions());
-    this.notificationCenter.onLibraryUninstalled(() =>
+    this.notificationCenter.onLibraryDidInstall(() => this.updateMenuActions());
+    this.notificationCenter.onLibraryDidUninstall(() =>
       this.updateMenuActions()
     );
   }

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

@@ -0,0 +1,71 @@
+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 { NotificationCenter } from '../notification-center';
+import { Contribution } from './contribution';
+
+@injectable()
+export class IndexesUpdateProgress extends Contribution {
+  @inject(NotificationCenter)
+  private readonly notificationCenter: NotificationCenter;
+  @inject(ProgressService)
+  private readonly progressService: ProgressService;
+  private currentProgress:
+    | (Progress & Readonly<{ progressId: string }>)
+    | undefined;
+
+  override onStart(): void {
+    this.notificationCenter.onIndexWillUpdate((progressId) =>
+      this.getOrCreateProgress(progressId)
+    );
+    this.notificationCenter.onIndexUpdateDidProgress((progress) => {
+      this.getOrCreateProgress(progress).then((delegate) =>
+        delegate.report(progress)
+      );
+    });
+    this.notificationCenter.onIndexDidUpdate((progressId) => {
+      if (this.currentProgress) {
+        if (this.currentProgress.progressId !== progressId) {
+          console.warn(
+            `Mismatching progress IDs. Expected ${progressId}, got ${this.currentProgress.progressId}. Canceling anyway.`
+          );
+        }
+        this.currentProgress.cancel();
+        this.currentProgress = undefined;
+      }
+    });
+  }
+
+  private async getOrCreateProgress(
+    progressOrId: ProgressMessage | string
+  ): Promise<Progress & { progressId: string }> {
+    const progressId = ProgressMessage.is(progressOrId)
+      ? progressOrId.progressId
+      : progressOrId;
+    if (
+      this.currentProgress &&
+      this.currentProgress.progressId === progressId
+    ) {
+      return this.currentProgress;
+    }
+    if (this.currentProgress) {
+      this.currentProgress.cancel();
+    }
+    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' },
+    });
+    if (ProgressMessage.is(progressOrId)) {
+      progress.report(progressOrId); // if the client has missed the `willStart` event, report the progress immediately.
+    }
+    this.currentProgress = { ...progress, progressId };
+    return this.currentProgress;
+  }
+}