Buffer events from BoardListWatchResponse.

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

Author: Akos Kitta

Diff for: arduino-ide-extension/package.json

@@ -66,6 +66,7 @@
     "deep-equal": "^2.0.5",
     "deepmerge": "2.0.1",
     "electron-updater": "^4.6.5",
+    "fast-json-stable-stringify": "^2.0.0",
     "fast-safe-stringify": "^2.1.1",
     "glob": "^7.1.6",
     "google-protobuf": "^3.20.1",

Diff for: arduino-ide-extension/src/common/protocol/boards-service.ts

@@ -4,7 +4,11 @@ import { Installable } from './installable';
 import { ArduinoComponent } from './arduino-component';
 import { nls } from '@theia/core/lib/common/nls';
 import { All, Contributed, Partner, Type, Updatable } from '../nls';
+import stableJsonStringify = require('fast-json-stable-stringify');
 
+/**
+ * Keys come from `Port#keyOf`.
+ */
 export type AvailablePorts = Record<string, [Port, Array<Board>]>;
 export namespace AvailablePorts {
   export function groupByProtocol(
@@ -37,6 +41,11 @@ export namespace AvailablePorts {
       ports: availablePorts,
     };
   }
+  export function sameAs(left: AvailablePorts, right: AvailablePorts): boolean {
+    return (
+      left === right || stableJsonStringify(left) === stableJsonStringify(right)
+    );
+  }
 }
 
 export interface AttachedBoardsChangeEvent {

Diff for: arduino-ide-extension/src/node/board-discovery.ts

@@ -10,7 +10,6 @@ import { Disposable } from '@theia/core/shared/vscode-languageserver-protocol';
 import { v4 } from 'uuid';
 import { Unknown } from '../common/nls';
 import {
-  AttachedBoardsChangeEvent,
   AvailablePorts,
   Board,
   NotificationServiceServer,
@@ -78,14 +77,6 @@ export class BoardDiscovery
 
   onStart(): void {
     this.start();
-    this.onClientDidRefresh(() => this.restart());
-  }
-
-  private async restart(): Promise<void> {
-    this.logger.info('restarting before stop');
-    await this.stop();
-    this.logger.info('restarting after stop');
-    return this.start();
   }
 
   onStop(): void {
@@ -259,57 +250,14 @@ export class BoardDiscovery
       return;
     }
 
-    const detectedPort = resp.getPort();
-    if (detectedPort) {
-      const { port, boards } = this.fromRpc(detectedPort);
-      if (!port) {
-        if (!!boards.length) {
-          console.warn(
-            `Could not detect the port, but unexpectedly received discovered boards. This is most likely a bug! Response was: ${this.toJson(
-              resp
-            )}`
-          );
-        }
-        return;
-      }
-      const oldState = deepClone(this._availablePorts);
-      const newState = deepClone(this._availablePorts);
-      const key = Port.keyOf(port);
-
-      if (eventType === EventType.Add) {
-        if (newState[key]) {
-          const [, knownBoards] = newState[key];
-          this.logger.warn(
-            `Port '${Port.toString(
-              port
-            )}' was already available. Known boards before override: ${JSON.stringify(
-              knownBoards
-            )}`
-          );
-        }
-        newState[key] = [port, boards];
-      } else if (eventType === EventType.Remove) {
-        if (!newState[key]) {
-          this.logger.warn(
-            `Port '${Port.toString(port)}' was not available. Skipping`
-          );
-          return;
-        }
-        delete newState[key];
-      }
-
-      const event: AttachedBoardsChangeEvent = {
-        oldState: {
-          ...AvailablePorts.split(oldState),
-        },
-        newState: {
-          ...AvailablePorts.split(newState),
-        },
-        uploadInProgress: this.uploadInProgress,
-      };
-
-      this._availablePorts = newState;
-      this.notificationService.notifyAttachedBoardsDidChange(event);
+    const rpcDetectedPort = resp.getPort();
+    if (rpcDetectedPort) {
+      const detectedPort = this.fromRpc(rpcDetectedPort);
+      this.fireSoon({ detectedPort, eventType });
+    } else if (resp.getError()) {
+      this.logger.error(
+        `Could not extract any detected 'port' from the board list watch response. An 'error' has occurred: ${resp.getError()}`
+      );
     }
   }
 
@@ -340,6 +288,75 @@ export class BoardDiscovery
     };
     return port;
   }
+
+  private fireSoonHandle?: NodeJS.Timeout;
+  private bufferedEvents: DetectedPortChangeEvent[] = [];
+  private fireSoon(event: DetectedPortChangeEvent): void {
+    this.bufferedEvents.push(event);
+    clearTimeout(this.fireSoonHandle);
+    this.fireSoonHandle = setTimeout(() => {
+      const prevState = deepClone(this.availablePorts);
+      const newState = this.calculateNewState(this.bufferedEvents, prevState);
+      if (!AvailablePorts.sameAs(prevState, newState)) {
+        this._availablePorts = newState;
+        this.notificationService.notifyAttachedBoardsDidChange({
+          newState: AvailablePorts.split(newState),
+          oldState: AvailablePorts.split(prevState),
+          uploadInProgress: this.uploadInProgress,
+        });
+      }
+      this.bufferedEvents.length = 0;
+    }, 100);
+  }
+
+  private calculateNewState(
+    events: DetectedPortChangeEvent[],
+    prevState: AvailablePorts
+  ): AvailablePorts {
+    const newState = deepClone(prevState);
+    for (const { detectedPort, eventType } of events) {
+      if (!DetectedPort.hasPort(detectedPort)) {
+        if (!!detectedPort.boards.length) {
+          console.warn(
+            `Could not detect the port, but unexpectedly received discovered boards. This is most likely a bug! Detected port was: ${JSON.stringify(
+              detectedPort
+            )}`
+          );
+        } else {
+          console.warn(
+            `Could not detect the port. Skipping: ${JSON.stringify(
+              detectedPort
+            )}`
+          );
+        }
+        continue;
+      }
+      const { port, boards } = detectedPort;
+      const key = Port.keyOf(port);
+      if (eventType === EventType.Add) {
+        const alreadyDetectedPort = newState[key];
+        if (alreadyDetectedPort) {
+          console.warn(
+            `Detected a new port that has been already discovered. The old value will be overridden. Old value: ${JSON.stringify(
+              alreadyDetectedPort
+            )}, new value: ${JSON.stringify(detectedPort)}`
+          );
+        }
+        newState[key] = [port, boards];
+      } else if (eventType === EventType.Remove) {
+        const alreadyDetectedPort = newState[key];
+        if (!alreadyDetectedPort) {
+          console.warn(
+            `Detected a port removal but it has not been discovered. This is most likely a bug! Detected port was: ${JSON.stringify(
+              detectedPort
+            )}`
+          );
+        }
+        delete newState[key];
+      }
+    }
+    return newState;
+  }
 }
 
 enum EventType {
@@ -364,8 +381,18 @@ namespace EventType {
     }
   }
 }
-
 interface DetectedPort {
   port: Port | undefined;
   boards: Board[];
 }
+namespace DetectedPort {
+  export function hasPort(
+    detectedPort: DetectedPort
+  ): detectedPort is DetectedPort & { port: Port } {
+    return !!detectedPort.port;
+  }
+}
+interface DetectedPortChangeEvent {
+  detectedPort: DetectedPort;
+  eventType: EventType.Add | EventType.Remove;
+}

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

@@ -5,7 +5,7 @@ import {
   injectable,
   postConstruct,
 } from '@theia/core/shared/inversify';
-import { Emitter, Event } from '@theia/core/lib/common/event';
+import { Emitter } from '@theia/core/lib/common/event';
 import { ArduinoCoreServiceClient } from './cli-protocol/cc/arduino/cli/commands/v1/commands_grpc_pb';
 import { Instance } from './cli-protocol/cc/arduino/cli/commands/v1/common_pb';
 import {
@@ -53,8 +53,6 @@ export class CoreClientProvider {
   private readonly onClientReadyEmitter =
     new Emitter<CoreClientProvider.Client>();
   private readonly onClientReady = this.onClientReadyEmitter.event;
-  private readonly onClientDidRefreshEmitter =
-    new Emitter<CoreClientProvider.Client>();
 
   @postConstruct()
   protected init(): void {
@@ -90,10 +88,6 @@ export class CoreClientProvider {
     return this.pending.promise;
   }
 
-  get onClientDidRefresh(): Event<CoreClientProvider.Client> {
-    return this.onClientDidRefreshEmitter.event;
-  }
-
   /**
    * Encapsulates both the gRPC core client creation (`CreateRequest`) and initialization (`InitRequest`).
    */
@@ -259,7 +253,6 @@ export class CoreClientProvider {
         await this.initInstance(client);
         // notify clients about the index update only after the client has been "re-initialized" and the new content is available.
         progressHandler.reportEnd();
-        this.onClientDidRefreshEmitter.fire(client);
       } catch (err) {
         console.error('Failed to update indexes', err);
         progressHandler.reportError(
@@ -411,10 +404,6 @@ export abstract class CoreClientAware {
   protected get coreClient(): Promise<CoreClientProvider.Client> {
     return this.coreClientProvider.client;
   }
-
-  protected get onClientDidRefresh(): Event<CoreClientProvider.Client> {
-    return this.coreClientProvider.onClientDidRefresh;
-  }
 }
 
 class IndexUpdateRequiredBeforeInitError extends Error {