feat: use latest CLI API to detect port changes

Author: Akos Kitta

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

@@ -248,7 +248,7 @@ export class BoardDiscovery
     if (!rpcPort) {
       return undefined;
     }
-    const port = this.fromRpcPort(rpcPort);
+    const port = createApiPort(rpcPort);
     const boards = detectedPort.getMatchingBoardsList().map(
       (board) =>
         ({
@@ -262,17 +262,6 @@ export class BoardDiscovery
     };
   }
 
-  private fromRpcPort(rpcPort: RpcPort): Port {
-    return {
-      address: rpcPort.getAddress(),
-      addressLabel: rpcPort.getLabel(),
-      protocol: rpcPort.getProtocol(),
-      protocolLabel: rpcPort.getProtocolLabel(),
-      properties: Port.Properties.create(rpcPort.getPropertiesMap().toObject()),
-      hardwareId: rpcPort.getHardwareId() || undefined, // prefer undefined over empty string
-    };
-  }
-
   private fireSoonHandle: NodeJS.Timeout | undefined;
   private readonly bufferedEvents: DetectedPortChangeEvent[] = [];
   private fireSoon(event: DetectedPortChangeEvent): void {
@@ -352,3 +341,14 @@ interface DetectedPortChangeEvent {
   readonly detectedPort: DetectedPort;
   readonly eventType: EventType.Add | EventType.Remove;
 }
+
+export function createApiPort(rpcPort: RpcPort): Port {
+  return {
+    address: rpcPort.getAddress(),
+    addressLabel: rpcPort.getLabel(),
+    protocol: rpcPort.getProtocol(),
+    protocolLabel: rpcPort.getProtocolLabel(),
+    properties: Port.Properties.create(rpcPort.getPropertiesMap().toObject()),
+    hardwareId: rpcPort.getHardwareId() || undefined, // prefer undefined over empty string
+  };
+}

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

@@ -32,6 +32,7 @@ import {
   PortIdentifier,
   Port,
   UploadResponse as ApiUploadResponse,
+  portIdentifierEquals,
 } from '../common/protocol';
 import { ArduinoCoreServiceClient } from './cli-protocol/cc/arduino/cli/commands/v1/commands_grpc_pb';
 import { Port as RpcPort } from './cli-protocol/cc/arduino/cli/commands/v1/port_pb';
@@ -44,7 +45,7 @@ import { firstToUpperCase, notEmpty } from '../common/utils';
 import { ServiceError } from './service-error';
 import { ExecuteWithProgress, ProgressResponse } from './grpc-progressible';
 import type { Mutable } from '@theia/core/lib/common/types';
-import { BoardDiscovery } from './board-discovery';
+import { BoardDiscovery, createApiPort } from './board-discovery';
 
 namespace Uploadable {
   export type Request = UploadRequest | UploadUsingProgrammerRequest;
@@ -208,14 +209,53 @@ export class CoreServiceImpl extends CoreClientAware implements CoreService {
   ): Promise<ApiUploadResponse> {
     const uploadResponseFragment: Mutable<Partial<ApiUploadResponse>> = {
       portBeforeUpload: options.port,
+      portAfterUpload: options.port, // assume no port changes during the upload
     };
     const coreClient = await this.coreClient;
     const { client, instance } = coreClient;
     const progressHandler = this.createProgressHandler(options);
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const updateUploadResponseFragmentHandler = (_: RESP) => {
-      // TODO: update the upload response fragment with the new port.
-      // https://github.com/arduino/arduino-cli/issues/2245
+    // Track responses for port changes:
+    // No port changes are expected when uploading using a programmer.
+    // When the `updatedUploadPort` is missing, the port did not change.
+    // The CLI does not tell anything when no changes.
+    // IDE2 provides the same port for after as before when no changes.
+    const updateUploadResponseFragmentHandler = (response: RESP) => {
+      if (response instanceof UploadResponse) {
+        // TODO: this instanceof should not be here
+        if (response.hasResult()) {
+          const port = response.getResult()?.getUpdatedUploadPort();
+          if (port) {
+            const portAfterUpload = createApiPort(port);
+            if (
+              portIdentifierEquals(
+                uploadResponseFragment.portBeforeUpload,
+                portAfterUpload
+              )
+            ) {
+              console.info(
+                `Detected a port change during the upload from the CLI [${
+                  options.port ? Port.keyOf(options.port) : ''
+                }, ${options.fqbn}, ${
+                  options.sketch.name
+                }], but they are the same. Before port: ${JSON.stringify(
+                  uploadResponseFragment.portBeforeUpload
+                )}, after port: ${JSON.stringify(portAfterUpload)}`
+              );
+            } else {
+              console.info(
+                `Detected a port change during the upload from the CLI [${
+                  options.port ? Port.keyOf(options.port) : ''
+                }, ${options.fqbn}, ${
+                  options.sketch.name
+                }]. Before port: ${JSON.stringify(
+                  uploadResponseFragment.portBeforeUpload
+                )}, after port: ${JSON.stringify(portAfterUpload)}`
+              );
+              uploadResponseFragment.portAfterUpload = portAfterUpload;
+            }
+          }
+        }
+      }
     };
     const handler = this.createOnDataHandler(
       progressHandler,