fix: handle missing platform on monitor start

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

Author: Akos Kitta

Diff for: arduino-ide-extension/src/browser/monitor-manager-proxy-client-impl.ts

@@ -73,9 +73,11 @@ export class MonitorManagerProxyClientImpl
    * @param addressPort port of the WebSocket
    */
   async connect(addressPort: number): Promise<void> {
-    if (!!this.webSocket) {
-      if (this.wsPort === addressPort) return;
-      else this.disconnect();
+    if (this.webSocket) {
+      if (this.wsPort === addressPort) {
+        return;
+      }
+      this.disconnect();
     }
     try {
       this.webSocket = new WebSocket(`ws://localhost:${addressPort}`);
@@ -111,13 +113,19 @@ export class MonitorManagerProxyClientImpl
    * Disconnects the WebSocket if connected.
    */
   disconnect(): void {
-    if (!this.webSocket) return;
+    if (!this.webSocket) {
+      return;
+    }
     this.onBoardsConfigChanged?.dispose();
     this.onBoardsConfigChanged = undefined;
     try {
-      this.webSocket?.close();
+      this.webSocket.close();
       this.webSocket = undefined;
-    } catch {
+    } catch (err) {
+      console.error(
+        'Could not close the websocket connection for the monitor.',
+        err
+      );
       this.messageService.error(
         nls.localize(
           'arduino/monitor/unableToCloseWebSocket',

Diff for: arduino-ide-extension/src/node/monitor-service.ts

@@ -1,4 +1,4 @@
-import { ClientDuplexStream } from '@grpc/grpc-js';
+import { ClientDuplexStream, status } from '@grpc/grpc-js';
 import {
   ApplicationError,
   Disposable,
@@ -134,7 +134,7 @@ export class MonitorService extends CoreClientAware implements Disposable {
         this.updateClientsSettings(this.settings);
       });
 
-    this.portMonitorSettings(this.port.protocol, this.board.fqbn!).then(
+    this.portMonitorSettings(this.port.protocol, this.board.fqbn!, true).then(
       async (settings) => {
         this.settings = {
           ...this.settings,
@@ -205,51 +205,53 @@ export class MonitorService extends CoreClientAware implements Disposable {
     }
 
     this.logger.info('starting monitor');
-    this.updateClientsSettings({
-      monitorUISettings: { connectionStatus: 'connecting' },
-    });
 
-    // get default monitor settings from the CLI
-    const defaultSettings = await this.portMonitorSettings(
-      this.port.protocol,
-      this.board.fqbn
-    );
-    // get actual settings from the settings provider
-    this.settings = {
-      ...this.settings,
-      pluggableMonitorSettings: {
-        ...this.settings.pluggableMonitorSettings,
-        ...(await this.monitorSettingsProvider.getSettings(
-          this.monitorID,
-          defaultSettings
-        )),
-      },
-    };
+    try {
+      // get default monitor settings from the CLI
+      const defaultSettings = await this.portMonitorSettings(
+        this.port.protocol,
+        this.board.fqbn
+      );
 
-    const coreClient = await this.coreClient;
+      this.updateClientsSettings({
+        monitorUISettings: { connectionStatus: 'connecting' },
+      });
 
-    const { instance } = coreClient;
-    const monitorRequest = new MonitorRequest();
-    monitorRequest.setInstance(instance);
-    if (this.board?.fqbn) {
-      monitorRequest.setFqbn(this.board.fqbn);
-    }
-    if (this.port?.address && this.port?.protocol) {
-      const rpcPort = new RpcPort();
-      rpcPort.setAddress(this.port.address);
-      rpcPort.setProtocol(this.port.protocol);
-      monitorRequest.setPort(rpcPort);
-    }
-    const config = new MonitorPortConfiguration();
-    for (const id in this.settings.pluggableMonitorSettings) {
-      const s = new MonitorPortSetting();
-      s.setSettingId(id);
-      s.setValue(this.settings.pluggableMonitorSettings[id].selectedValue);
-      config.addSettings(s);
-    }
-    monitorRequest.setPortConfiguration(config);
+      // get actual settings from the settings provider
+      this.settings = {
+        ...this.settings,
+        pluggableMonitorSettings: {
+          ...this.settings.pluggableMonitorSettings,
+          ...(await this.monitorSettingsProvider.getSettings(
+            this.monitorID,
+            defaultSettings
+          )),
+        },
+      };
+
+      const coreClient = await this.coreClient;
+
+      const { instance } = coreClient;
+      const monitorRequest = new MonitorRequest();
+      monitorRequest.setInstance(instance);
+      if (this.board?.fqbn) {
+        monitorRequest.setFqbn(this.board.fqbn);
+      }
+      if (this.port?.address && this.port?.protocol) {
+        const rpcPort = new RpcPort();
+        rpcPort.setAddress(this.port.address);
+        rpcPort.setProtocol(this.port.protocol);
+        monitorRequest.setPort(rpcPort);
+      }
+      const config = new MonitorPortConfiguration();
+      for (const id in this.settings.pluggableMonitorSettings) {
+        const s = new MonitorPortSetting();
+        s.setSettingId(id);
+        s.setValue(this.settings.pluggableMonitorSettings[id].selectedValue);
+        config.addSettings(s);
+      }
+      monitorRequest.setPortConfiguration(config);
 
-    try {
       await this.pollWriteToStream(monitorRequest);
       // Only store the config, if the monitor has successfully started.
       this.currentPortConfigSnapshot = MonitorPortConfiguration.toObject(
@@ -282,7 +284,11 @@ export class MonitorService extends CoreClientAware implements Disposable {
         ? err
         : createConnectionFailedError(
             this.port,
-            err instanceof Error ? err.message : String(err)
+            ServiceError.is(err)
+              ? err.details
+              : err instanceof Error
+              ? err.message
+              : String(err)
           );
       this.creating.reject(appError);
       this.updateClientsSettings({
@@ -485,7 +491,8 @@ export class MonitorService extends CoreClientAware implements Disposable {
    */
   private async portMonitorSettings(
     protocol: string,
-    fqbn: string
+    fqbn: string,
+    swallowsPlatformNotFoundError = false
   ): Promise<PluggableMonitorSettings> {
     const coreClient = await this.coreClient;
     const { client, instance } = coreClient;
@@ -494,19 +501,33 @@ export class MonitorService extends CoreClientAware implements Disposable {
     req.setPortProtocol(protocol);
     req.setFqbn(fqbn);
 
-    const res = await new Promise<EnumerateMonitorPortSettingsResponse>(
-      (resolve, reject) => {
-        client.enumerateMonitorPortSettings(req, (err, resp) => {
-          if (!!err) {
-            reject(err);
+    const resp = await new Promise<
+      EnumerateMonitorPortSettingsResponse | undefined
+    >((resolve, reject) => {
+      client.enumerateMonitorPortSettings(req, async (err, resp) => {
+        if (err) {
+          // Check whether the platform is installed: https://github.com/arduino/arduino-ide/issues/1974.
+          // No error codes. Look for `Unknown FQBN: platform arduino:mbed_nano is not installed` message similarities: https://github.com/arduino/arduino-cli/issues/1762.
+          if (
+            swallowsPlatformNotFoundError &&
+            ServiceError.is(err) &&
+            err.code === status.NOT_FOUND &&
+            err.details.includes('FQBN') &&
+            err.details.includes(fqbn.split(':', 2).join(':')) // create a platform ID from the FQBN
+          ) {
+            resolve(undefined);
           }
-          resolve(resp);
-        });
-      }
-    );
+          reject(err);
+        }
+        resolve(resp);
+      });
+    });
 
     const settings: PluggableMonitorSettings = {};
-    for (const iterator of res.getSettingsList()) {
+    if (!resp) {
+      return settings;
+    }
+    for (const iterator of resp.getSettingsList()) {
       settings[iterator.getSettingId()] = {
         id: iterator.getSettingId(),
         label: iterator.getLabel(),