faked the fine grained index update progress.

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

Author: Akos Kitta

arduino-ide-extension/src/node/core-client-provider.ts

@@ -231,21 +231,31 @@ export class CoreClientProvider {
   ): Promise<CoreClientProvider.Client> {
     const progressId = v4();
     // Note: at this point, the IDE2 backend might not have any connected clients, so this notification is not delivered to anywhere
-    // Hence, clients must handle gracefully when no `willUpdate` is received only `didProgress`.
+    // Hence, clients must handle gracefully when no `willUpdate` is received before any `didProgress`.
     this.notificationService.notifyIndexWillUpdate(progressId);
-
+    // The index update progress responses are not much helpful from the CLI. 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 fakes the progress to provide slightly better UX.
+    const totalPlatformIndexCount =
+      (this.configService.cliConfiguration?.board_manager?.additional_urls
+        ?.length ?? 0) + 1; // +1 for the `package_index.tar.bz2` when updating the platform index.
+    // The `library_index.json.gz` and `library_index.json.sig` when running the library index update.
+    const totalLibraryIndexCount = 2;
     let work = {
       done: 0,
-      total: 2, // index update and library index update
+      total: totalPlatformIndexCount + totalLibraryIndexCount + 1, // +1 for better UX, leave the last step complete when all subtasks are done.
     };
-    let lastMessage = '';
-    const reportProgress = () => {
+    const reportProgress = ({
+      progressId,
+      message,
+    }: Omit<ProgressMessage, 'work'>) => {
       work = {
         ...work,
         done: work.done + 1,
       };
       this.notificationService.notifyIndexUpdateDidProgress({
-        message: lastMessage,
+        message,
         progressId,
         work,
       });
@@ -256,21 +266,13 @@ export class CoreClientProvider {
       const onDidProgress = onDidProgressEmitter.event;
       toDispose.pushAll([
         onDidProgressEmitter,
-        onDidProgress(({ message, progressId }) => {
-          this.notificationService.notifyIndexUpdateDidProgress({
-            message,
-            progressId,
-          });
-          lastMessage = message;
-        }),
+        onDidProgress(({ message, progressId }) =>
+          reportProgress({ progressId, message })
+        ),
       ]);
       await Promise.all([
-        this.updateIndex(client, progressId, onDidProgressEmitter).then(
-          reportProgress
-        ),
-        this.updateLibraryIndex(client, progressId, onDidProgressEmitter).then(
-          reportProgress
-        ),
+        this.updateIndex(client, progressId, onDidProgressEmitter),
+        this.updateLibraryIndex(client, progressId, onDidProgressEmitter),
       ]);
       this.notificationService.notifyIndexDidUpdate(progressId);
       return client;
@@ -290,7 +292,8 @@ export class CoreClientProvider {
           new UpdateIndexRequest().setInstance(client.instance)
         ),
       progressId,
-      onDidProgressEmitter
+      onDidProgressEmitter,
+      'platform-index'
     );
   }
 
@@ -305,7 +308,8 @@ export class CoreClientProvider {
           new UpdateLibrariesIndexRequest().setInstance(client.instance)
         ),
       progressId,
-      onDidProgressEmitter
+      onDidProgressEmitter,
+      'library-index'
     );
   }
 
@@ -317,7 +321,8 @@ export class CoreClientProvider {
   >(
     responseProvider: () => grpc.ClientReadableStream<R>,
     progressId: string,
-    onDidProgressEmitter: Emitter<ProgressMessage>
+    onDidProgressEmitter: Emitter<ProgressMessage>,
+    task?: string
   ): Promise<void> {
     return retry(
       () =>
@@ -328,7 +333,10 @@ export class CoreClientProvider {
               InstallWithProgress.createDataCallback({
                 responseService: {
                   appendToOutput: (message) => {
-                    console.log('core-client-provider', message.chunk);
+                    console.log(
+                      `core-client-provider${task ? ` [${task}]` : ''}`,
+                      message.chunk
+                    );
                     onDidProgressEmitter.fire({
                       message: message.chunk,
                       progressId,