Clients can show index update errors.

Akos Kitta · Akos Kitta · commit 3e2f048dec28 · 2022-07-01T15:58:34.000+02:00
Signed-off-by: Akos Kitta &lt;a.kitta@arduino.cc&gt;
diff --git a/arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts b/arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts
@@ -164,7 +164,7 @@ import { MonacoTextModelService } from './theia/monaco/monaco-text-model-service
 import { ResponseServiceImpl } from './response-service-impl';
 import {
   ResponseService,
-  ResponseServiceArduino,
+  ResponseServiceClient,
   ResponseServicePath,
 } from '../common/protocol/response-service';
 import { NotificationCenter } from './notification-center';
@@ -723,7 +723,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     });
 
   bind(ResponseService).toService(ResponseServiceImpl);
-  bind(ResponseServiceArduino).toService(ResponseServiceImpl);
+  bind(ResponseServiceClient).toService(ResponseServiceImpl);
 
   bind(NotificationCenter).toSelf().inSingletonScope();
   bind(FrontendApplicationContribution).toService(NotificationCenter);
diff --git a/arduino-ide-extension/src/browser/boards/boards-auto-installer.ts b/arduino-ide-extension/src/browser/boards/boards-auto-installer.ts
@@ -8,7 +8,7 @@ import {
 } from '../../common/protocol/boards-service';
 import { BoardsServiceProvider } from './boards-service-provider';
 import { BoardsConfig } from './boards-config';
-import { Installable, ResponseServiceArduino } from '../../common/protocol';
+import { Installable, ResponseServiceClient } from '../../common/protocol';
 import { BoardsListWidgetFrontendContribution } from './boards-widget-frontend-contribution';
 import { nls } from '@theia/core/lib/common';
 
@@ -27,8 +27,8 @@ export class BoardsAutoInstaller implements FrontendApplicationContribution {
   @inject(BoardsServiceProvider)
   protected readonly boardsServiceClient: BoardsServiceProvider;
 
-  @inject(ResponseServiceArduino)
-  protected readonly responseService: ResponseServiceArduino;
+  @inject(ResponseServiceClient)
+  protected readonly responseService: ResponseServiceClient;
 
   @inject(BoardsListWidgetFrontendContribution)
   protected readonly boardsManagerFrontendContribution: BoardsListWidgetFrontendContribution;
diff --git a/arduino-ide-extension/src/browser/contributions/add-zip-library.ts b/arduino-ide-extension/src/browser/contributions/add-zip-library.ts
@@ -7,7 +7,7 @@ import { ArduinoMenus } from '../menu/arduino-menus';
 import {
   Installable,
   LibraryService,
-  ResponseServiceArduino,
+  ResponseServiceClient,
 } from '../../common/protocol';
 import {
   SketchContribution,
@@ -22,8 +22,8 @@ export class AddZipLibrary extends SketchContribution {
   @inject(EnvVariablesServer)
   protected readonly envVariableServer: EnvVariablesServer;
 
-  @inject(ResponseServiceArduino)
-  protected readonly responseService: ResponseServiceArduino;
+  @inject(ResponseServiceClient)
+  protected readonly responseService: ResponseServiceClient;
 
   @inject(LibraryService)
   protected readonly libraryService: LibraryService;
diff --git a/arduino-ide-extension/src/browser/contributions/indexes-update-progress.ts b/arduino-ide-extension/src/browser/contributions/indexes-update-progress.ts
@@ -25,15 +25,11 @@ export class IndexesUpdateProgress extends Contribution {
       );
     });
     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;
-      }
+      this.cancelProgress(progressId);
+    });
+    this.notificationCenter.onIndexUpdateDidFail(({ progressId, message }) => {
+      this.cancelProgress(progressId);
+      this.messageService.error(message);
     });
   }
 
@@ -65,4 +61,16 @@ export class IndexesUpdateProgress extends Contribution {
     this.currentProgress = { ...progress, progressId };
     return this.currentProgress;
   }
+
+  private cancelProgress(progressId: string) {
+    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;
+    }
+  }
 }
diff --git a/arduino-ide-extension/src/browser/notification-center.ts b/arduino-ide-extension/src/browser/notification-center.ts
@@ -38,6 +38,10 @@ export class NotificationCenter
   protected readonly indexWillUpdateEmitter = new Emitter<string>();
   protected readonly indexUpdateDidProgressEmitter =
     new Emitter<ProgressMessage>();
+  protected readonly indexUpdateDidFailEmitter = new Emitter<{
+    progressId: string;
+    message: string;
+  }>();
   protected readonly daemonDidStartEmitter = new Emitter<string>();
   protected readonly daemonDidStopEmitter = new Emitter<void>();
   protected readonly configDidChangeEmitter = new Emitter<{
@@ -67,6 +71,7 @@ export class NotificationCenter
     this.indexWillUpdateEmitter,
     this.indexUpdateDidProgressEmitter,
     this.indexDidUpdateEmitter,
+    this.indexUpdateDidFailEmitter,
     this.daemonDidStartEmitter,
     this.daemonDidStopEmitter,
     this.configDidChangeEmitter,
@@ -80,6 +85,7 @@ export class NotificationCenter
   readonly onIndexDidUpdate = this.indexDidUpdateEmitter.event;
   readonly onIndexWillUpdate = this.indexDidUpdateEmitter.event;
   readonly onIndexUpdateDidProgress = this.indexUpdateDidProgressEmitter.event;
+  readonly onIndexUpdateDidFail = this.indexUpdateDidFailEmitter.event;
   readonly onDaemonDidStart = this.daemonDidStartEmitter.event;
   readonly onDaemonDidStop = this.daemonDidStopEmitter.event;
   readonly onConfigDidChange = this.configDidChangeEmitter.event;
@@ -118,6 +124,16 @@ export class NotificationCenter
     this.indexDidUpdateEmitter.fire(progressId);
   }
 
+  notifyIndexUpdateDidFail({
+    progressId,
+    message,
+  }: {
+    progressId: string;
+    message: string;
+  }): void {
+    this.indexUpdateDidFailEmitter.fire({ progressId, message });
+  }
+
   notifyDaemonDidStart(port: string): void {
     this.daemonDidStartEmitter.fire(port);
   }
diff --git a/arduino-ide-extension/src/browser/response-service-impl.ts b/arduino-ide-extension/src/browser/response-service-impl.ts
@@ -7,19 +7,19 @@ import {
 import {
   OutputMessage,
   ProgressMessage,
-  ResponseServiceArduino,
+  ResponseServiceClient,
 } from '../common/protocol/response-service';
 
 @injectable()
-export class ResponseServiceImpl implements ResponseServiceArduino {
+export class ResponseServiceImpl implements ResponseServiceClient {
   @inject(OutputChannelManager)
   private readonly outputChannelManager: OutputChannelManager;
 
   private readonly progressDidChangeEmitter = new Emitter<ProgressMessage>();
 
   readonly onProgressDidChange = this.progressDidChangeEmitter.event;
 
-  clearArduinoChannel(): void {
+  clearOutput(): void {
     this.outputChannelManager.getChannel('Arduino').clear();
   }
 
diff --git a/arduino-ide-extension/src/browser/widgets/component-list/filterable-list-container.tsx b/arduino-ide-extension/src/browser/widgets/component-list/filterable-list-container.tsx
@@ -11,7 +11,7 @@ import { SearchBar } from './search-bar';
 import { ListWidget } from './list-widget';
 import { ComponentList } from './component-list';
 import { ListItemRenderer } from './list-item-renderer';
-import { ResponseServiceArduino } from '../../../common/protocol';
+import { ResponseServiceClient } from '../../../common/protocol';
 import { nls } from '@theia/core/lib/common';
 
 export class FilterableListContainer<
@@ -162,7 +162,7 @@ export namespace FilterableListContainer {
     readonly resolveFocus: (element: HTMLElement | undefined) => void;
     readonly filterTextChangeEvent: Event<string | undefined>;
     readonly messageService: MessageService;
-    readonly responseService: ResponseServiceArduino;
+    readonly responseService: ResponseServiceClient;
     readonly install: ({
       item,
       progressId,
diff --git a/arduino-ide-extension/src/browser/widgets/component-list/list-widget.tsx b/arduino-ide-extension/src/browser/widgets/component-list/list-widget.tsx
@@ -1,5 +1,9 @@
 import * as React from '@theia/core/shared/react';
-import { injectable, postConstruct, inject } from '@theia/core/shared/inversify';
+import {
+  injectable,
+  postConstruct,
+  inject,
+} from '@theia/core/shared/inversify';
 import { Widget } from '@theia/core/shared/@phosphor/widgets';
 import { Message } from '@theia/core/shared/@phosphor/messaging';
 import { Deferred } from '@theia/core/lib/common/promise-util';
@@ -12,7 +16,7 @@ import {
   Installable,
   Searchable,
   ArduinoComponent,
-  ResponseServiceArduino,
+  ResponseServiceClient,
 } from '../../../common/protocol';
 import { FilterableListContainer } from './filterable-list-container';
 import { ListItemRenderer } from './list-item-renderer';
@@ -21,15 +25,15 @@ import { NotificationCenter } from '../../notification-center';
 @injectable()
 export abstract class ListWidget<
   T extends ArduinoComponent
-  > extends ReactWidget {
+> extends ReactWidget {
   @inject(MessageService)
   protected readonly messageService: MessageService;
 
   @inject(CommandService)
   protected readonly commandService: CommandService;
 
-  @inject(ResponseServiceArduino)
-  protected readonly responseService: ResponseServiceArduino;
+  @inject(ResponseServiceClient)
+  protected readonly responseService: ResponseServiceClient;
 
   @inject(NotificationCenter)
   protected readonly notificationCenter: NotificationCenter;
diff --git a/arduino-ide-extension/src/common/protocol/installable.ts b/arduino-ide-extension/src/common/protocol/installable.ts
@@ -1,13 +1,13 @@
 import * as semver from 'semver';
-import { Progress } from '@theia/core/lib/common/message-service-protocol';
+import type { Progress } from '@theia/core/lib/common/message-service-protocol';
 import {
   CancellationToken,
   CancellationTokenSource,
 } from '@theia/core/lib/common/cancellation';
 import { naturalCompare } from './../utils';
-import { ArduinoComponent } from './arduino-component';
-import { MessageService } from '@theia/core';
-import { ResponseServiceArduino } from './response-service';
+import type { ArduinoComponent } from './arduino-component';
+import type { MessageService } from '@theia/core/lib/common/message-service';
+import type { ResponseServiceClient } from './response-service';
 
 export interface Installable<T extends ArduinoComponent> {
   /**
@@ -44,7 +44,7 @@ export namespace Installable {
   >(options: {
     installable: Installable<T>;
     messageService: MessageService;
-    responseService: ResponseServiceArduino;
+    responseService: ResponseServiceClient;
     item: T;
     version: Installable.Version;
   }): Promise<void> {
@@ -66,7 +66,7 @@ export namespace Installable {
   >(options: {
     installable: Installable<T>;
     messageService: MessageService;
-    responseService: ResponseServiceArduino;
+    responseService: ResponseServiceClient;
     item: T;
   }): Promise<void> {
     const { item } = options;
@@ -86,7 +86,7 @@ export namespace Installable {
   export async function doWithProgress(options: {
     run: ({ progressId }: { progressId: string }) => Promise<void>;
     messageService: MessageService;
-    responseService: ResponseServiceArduino;
+    responseService: ResponseServiceClient;
     progressText: string;
   }): Promise<void> {
     return withProgress(
@@ -103,7 +103,7 @@ export namespace Installable {
           }
         );
         try {
-          options.responseService.clearArduinoChannel();
+          options.responseService.clearOutput();
           await options.run({ progressId });
         } finally {
           toDispose.dispose();
diff --git a/arduino-ide-extension/src/common/protocol/notification-service.ts b/arduino-ide-extension/src/common/protocol/notification-service.ts
@@ -12,6 +12,13 @@ export interface NotificationServiceClient {
   notifyIndexWillUpdate(progressId: string): void;
   notifyIndexUpdateDidProgress(progressMessage: ProgressMessage): void;
   notifyIndexDidUpdate(progressId: string): void;
+  notifyIndexUpdateDidFail({
+    progressId,
+    message,
+  }: {
+    progressId: string;
+    message: string;
+  }): void;
   notifyDaemonDidStart(port: string): void;
   notifyDaemonDidStop(): void;
   notifyConfigDidChange(event: { config: Config | undefined }): void;
diff --git a/arduino-ide-extension/src/common/protocol/response-service.ts b/arduino-ide-extension/src/common/protocol/response-service.ts
@@ -43,8 +43,8 @@ export interface ResponseService {
   reportProgress(message: ProgressMessage): void;
 }
 
-export const ResponseServiceArduino = Symbol('ResponseServiceArduino');
-export interface ResponseServiceArduino extends ResponseService {
+export const ResponseServiceClient = Symbol('ResponseServiceClient');
+export interface ResponseServiceClient extends ResponseService {
   onProgressDidChange: Event<ProgressMessage>;
-  clearArduinoChannel: () => void;
+  clearOutput: () => void;
 }
diff --git a/arduino-ide-extension/src/node/core-client-provider.ts b/arduino-ide-extension/src/node/core-client-provider.ts
@@ -1,3 +1,4 @@
+import { join } from 'path';
 import * as grpc from '@grpc/grpc-js';
 import {
   inject,
@@ -30,6 +31,8 @@ import { DisposableCollection } from '@theia/core/lib/common/disposable';
 import { Disposable } from '@theia/core/shared/vscode-languageserver-protocol';
 import { v4 } from 'uuid';
 import { InstallWithProgress } from './grpc-installable';
+import type { DefaultCliConfig } from './cli-config';
+import { ServiceError } from './service-error';
 
 @injectable()
 export class CoreClientProvider {
@@ -228,8 +231,12 @@ export class CoreClientProvider {
   }
 
   private evaluateErrorStatus(status: RpcStatus[]): Error | undefined {
-    const error = isIndexUpdateRequiredBeforeInit(status); // put future error matching here
-    return error;
+    const { cliConfiguration } = this.configService;
+    if (!cliConfiguration) {
+      // If the CLI config is not available, do not even try to guess what went wrong.
+      return new Error(`Could not read the CLI configuration file.`);
+    }
+    return isIndexUpdateRequiredBeforeInit(status, cliConfiguration); // put future error matching here
   }
 
   private async updateIndexes(
@@ -281,10 +288,15 @@ export class CoreClientProvider {
         this.updateLibraryIndex(client, progressId, onDidProgressEmitter),
       ]);
       this.notificationService.notifyIndexDidUpdate(progressId);
-      return client;
+    } catch (err) {
+      this.notificationService.notifyIndexUpdateDidFail({
+        progressId,
+        message: ServiceError.is(err) ? err.details : String(err),
+      });
     } finally {
       toDispose.dispose();
     }
+    return client;
   }
 
   private async updateIndex(
@@ -425,13 +437,14 @@ ${causes
 }
 
 function isIndexUpdateRequiredBeforeInit(
-  status: RpcStatus[]
+  status: RpcStatus[],
+  cliConfig: DefaultCliConfig
 ): IndexUpdateRequiredBeforeInitError | undefined {
   const causes = status
     .filter((s) =>
-      IndexUpdateRequiredBeforeInit.map((predicate) => predicate(s)).some(
-        Boolean
-      )
+      IndexUpdateRequiredBeforeInit.map((predicate) =>
+        predicate(s, cliConfig)
+      ).some(Boolean)
     )
     .map((s) => RpcStatus.toObject(false, s));
   return causes.length
@@ -442,9 +455,14 @@ const IndexUpdateRequiredBeforeInit = [
   isPackageIndexMissingStatus,
   isDiscoveryNotFoundStatus,
 ];
-function isPackageIndexMissingStatus(status: RpcStatus): boolean {
+function isPackageIndexMissingStatus(
+  status: RpcStatus,
+  { directories: { data } }: DefaultCliConfig
+): boolean {
   const predicate = ({ message }: RpcStatus.AsObject) =>
-    message.includes('loading json index file');
+    message.includes('loading json index file') &&
+    (message.includes(join(data, 'package_index.json')) ||
+      message.includes(join(data, 'library_index.json')));
   // https://github.com/arduino/arduino-cli/blob/f0245bc2da6a56fccea7b2c9ea09e85fdcc52cb8/arduino/cores/packagemanager/package_manager.go#L247
   return evaluate(status, predicate);
 }
@@ -461,5 +479,6 @@ function evaluate(
   predicate: (error: RpcStatus.AsObject) => boolean
 ): boolean {
   const status = RpcStatus.toObject(false, subject);
-  return predicate(status);
+  const result = predicate(status);
+  return result;
 }
diff --git a/arduino-ide-extension/src/node/notification-service-server.ts b/arduino-ide-extension/src/node/notification-service-server.ts
