chore(cli): update CLI to 0.35.0-rc.3

 - Adjust board discovery to new gRPC API. From now on, it's a client
 read stream, not a duplex.
 - Allow `.cxx` and `.cc` file extensions. (Closes #2265)

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

Author: Akos Kitta

arduino-ide-extension/package.json

@@ -169,7 +169,7 @@
   ],
   "arduino": {
     "arduino-cli": {
-      "version": "0.34.0"
+      "version": "0.35.0-rc.3"
     },
     "arduino-fwuploader": {
       "version": "2.4.1"

arduino-ide-extension/src/browser/boards/boards-data-store.ts

@@ -99,10 +99,16 @@ export class BoardsDataStore implements FrontendApplicationContribution {
       return BoardsDataStore.Data.EMPTY;
     }
 
+    const { programmers, defaultProgrammerId, configOptions } = boardDetails;
+    const selectedProgrammer = findDefaultProgrammer(
+      programmers,
+      defaultProgrammerId
+    );
     data = {
-      configOptions: boardDetails.configOptions,
-      programmers: boardDetails.programmers,
-      selectedProgrammer: boardDetails.programmers.find((p) => p.default),
+      configOptions,
+      programmers,
+      selectedProgrammer,
+      defaultProgrammerId,
     };
     await this.storageService.setData(key, data);
     return data;
@@ -210,11 +216,13 @@ export namespace BoardsDataStore {
     readonly configOptions: ConfigOption[];
     readonly programmers: Programmer[];
     readonly selectedProgrammer?: Programmer;
+    readonly defaultProgrammerId: string | undefined;
   }
   export namespace Data {
     export const EMPTY: Data = {
       configOptions: [],
       programmers: [],
+      defaultProgrammerId: undefined,
     };
     export function is(arg: unknown): arg is Data {
       return (
@@ -236,3 +244,17 @@ export function isEmptyData(data: BoardsDataStore.Data): boolean {
     Boolean(!data.selectedProgrammer)
   );
 }
+
+export function findDefaultProgrammer(
+  programmers: readonly Programmer[],
+  defaultProgrammerId: string | undefined | BoardsDataStore.Data
+): Programmer | undefined {
+  if (!defaultProgrammerId) {
+    return undefined;
+  }
+  const id =
+    typeof defaultProgrammerId === 'string'
+      ? defaultProgrammerId
+      : defaultProgrammerId.defaultProgrammerId;
+  return programmers.find((p) => p.id === id);
+}

arduino-ide-extension/src/browser/contributions/auto-select-programmer.ts

@@ -5,7 +5,11 @@ import {
   Programmer,
   isBoardIdentifierChangeEvent,
 } from '../../common/protocol';
-import { BoardsDataStore, isEmptyData } from '../boards/boards-data-store';
+import {
+  BoardsDataStore,
+  findDefaultProgrammer,
+  isEmptyData,
+} from '../boards/boards-data-store';
 import { BoardsServiceProvider } from '../boards/boards-service-provider';
 import { Contribution } from './contribution';
 
@@ -75,7 +79,7 @@ export async function ensureProgrammerIsSelected(
     );
     return true;
   }
-  let programmer = data.programmers.find((p) => p.default);
+  let programmer = findDefaultProgrammer(data.programmers, data);
   if (programmer) {
     // select the programmer if the default info is available
     const result = await selectProgrammer({
@@ -97,7 +101,7 @@ export async function ensureProgrammerIsSelected(
     console.debug(`Skipping. ${fqbn} does not have programmers.`);
     return false;
   }
-  programmer = reloadedData.programmers.find((p) => p.default);
+  programmer = findDefaultProgrammer(reloadedData.programmers, reloadedData);
   if (!programmer) {
     console.debug(
       `Skipping. Could not find a default programmer for ${fqbn}. Programmers were: `

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

@@ -334,6 +334,7 @@ export interface BoardDetails {
   readonly VID: string;
   readonly PID: string;
   readonly buildProperties: string[];
+  readonly defaultProgrammerId: string | undefined;
 }
 
 export interface Tool {
@@ -406,7 +407,6 @@ export interface Programmer {
   readonly name: string;
   readonly platform: string;
   readonly id: string;
-  readonly default?: boolean;
 }
 export namespace Programmer {
   export function equals(
@@ -435,9 +435,7 @@ export function isProgrammer(arg: unknown): arg is Programmer {
     (<Programmer>arg).name !== undefined &&
     typeof (<Programmer>arg).name === 'string' &&
     (<Programmer>arg).platform !== undefined &&
-    typeof (<Programmer>arg).platform === 'string' &&
-    ((<Programmer>arg).default === undefined ||
-      typeof (<Programmer>arg).default === 'boolean')
+    typeof (<Programmer>arg).platform === 'string'
   );
 }
 

arduino-ide-extension/src/common/protocol/sketches-service.ts

@@ -308,7 +308,7 @@ export namespace Sketch {
   export namespace Extensions {
     export const DEFAULT = '.ino';
     export const MAIN = [DEFAULT, '.pde'];
-    export const SOURCE = ['.c', '.cpp', '.S'];
+    export const SOURCE = ['.c', '.cpp', '.S', '.cxx', '.cc'];
     export const CODE_FILES = [
       ...MAIN,
       ...SOURCE,

arduino-ide-extension/src/node/board-discovery.ts

@@ -1,4 +1,4 @@
-import type { ClientDuplexStream } from '@grpc/grpc-js';
+import type { ClientReadableStream } from '@grpc/grpc-js';
 import {
   Disposable,
   DisposableCollection,
@@ -30,9 +30,9 @@ import type { Port as RpcPort } from './cli-protocol/cc/arduino/cli/commands/v1/
 import { CoreClientAware } from './core-client-provider';
 import { ServiceError } from './service-error';
 
-type Duplex = ClientDuplexStream<BoardListWatchRequest, BoardListWatchResponse>;
+type Stream = ClientReadableStream<BoardListWatchResponse>;
 interface StreamWrapper extends Disposable {
-  readonly stream: Duplex;
+  readonly stream: Stream;
   readonly uuid: string; // For logging only
 }
 
@@ -121,34 +121,15 @@ export class BoardDiscovery
     return Disposable.create(() => clearTimeout(timer));
   }
 
-  private async requestStartWatch(
-    req: BoardListWatchRequest,
-    duplex: Duplex
-  ): Promise<void> {
-    return new Promise<void>((resolve, reject) => {
-      if (
-        !duplex.write(req, (err: Error | undefined) => {
-          if (err) {
-            reject(err);
-            return;
-          }
-        })
-      ) {
-        duplex.once('drain', resolve);
-      } else {
-        process.nextTick(resolve);
-      }
-    });
-  }
-
   private async createWrapper(
-    client: ArduinoCoreServiceClient
+    client: ArduinoCoreServiceClient,
+    req: BoardListWatchRequest
   ): Promise<StreamWrapper> {
     if (this.wrapper) {
       throw new Error(`Duplex was already set.`);
     }
     const stream = client
-      .boardListWatch()
+      .boardListWatch(req)
       .on('end', () => {
         this.logger.info('received end');
         this.onStreamDidEndEmitter.fire();
@@ -202,14 +183,11 @@ export class BoardDiscovery
     this.watching = new Deferred();
     this.logger.info('start new deferred');
     const { client, instance } = await this.coreClient;
-    const wrapper = await this.createWrapper(client);
-    wrapper.stream.on('data', (resp) => this.onBoardListWatchResponse(resp));
-    this.logger.info('start request start watch');
-    await this.requestStartWatch(
-      new BoardListWatchRequest().setInstance(instance),
-      wrapper.stream
+    const wrapper = await this.createWrapper(
+      client,
+      new BoardListWatchRequest().setInstance(instance)
     );
-    this.logger.info('start requested start watch');
+    wrapper.stream.on('data', (resp) => this.onBoardListWatchResponse(resp));
     this.watching.resolve();
     this.logger.info('start resolved watching');
   }

arduino-ide-extension/src/node/boards-service-impl.ts

@@ -146,6 +146,7 @@ export class BoardsServiceImpl
           platform: p.getPlatform(),
         }
     );
+    const defaultProgrammerId = detailsResp.getDefaultProgrammerId();
 
     let VID = 'N/A';
     let PID = 'N/A';
@@ -168,6 +169,9 @@ export class BoardsServiceImpl
       VID,
       PID,
       buildProperties,
+      defaultProgrammerId: defaultProgrammerId
+        ? defaultProgrammerId
+        : undefined,
     };
   }
 

arduino-ide-extension/src/node/cli-protocol/cc/arduino/cli/commands/v1/board_pb.d.ts

@@ -84,6 +84,8 @@ export class BoardDetailsResponse extends jspb.Message {
     getBuildPropertiesList(): Array<string>;
     setBuildPropertiesList(value: Array<string>): BoardDetailsResponse;
     addBuildProperties(value: string, index?: number): string;
+    getDefaultProgrammerId(): string;
+    setDefaultProgrammerId(value: string): BoardDetailsResponse;
 
     serializeBinary(): Uint8Array;
     toObject(includeInstance?: boolean): BoardDetailsResponse.AsObject;
@@ -112,6 +114,7 @@ export namespace BoardDetailsResponse {
         debuggingSupported: boolean,
         identificationPropertiesList: Array<BoardIdentificationProperties.AsObject>,
         buildPropertiesList: Array<string>,
+        defaultProgrammerId: string,
     }
 }
 
@@ -488,8 +491,6 @@ export class BoardListWatchRequest extends jspb.Message {
     clearInstance(): void;
     getInstance(): cc_arduino_cli_commands_v1_common_pb.Instance | undefined;
     setInstance(value?: cc_arduino_cli_commands_v1_common_pb.Instance): BoardListWatchRequest;
-    getInterrupt(): boolean;
-    setInterrupt(value: boolean): BoardListWatchRequest;
 
     serializeBinary(): Uint8Array;
     toObject(includeInstance?: boolean): BoardListWatchRequest.AsObject;
@@ -504,7 +505,6 @@ export class BoardListWatchRequest extends jspb.Message {
 export namespace BoardListWatchRequest {
     export type AsObject = {
         instance?: cc_arduino_cli_commands_v1_common_pb.Instance.AsObject,
-        interrupt: boolean,
     }
 }
 

arduino-ide-extension/src/node/cli-protocol/cc/arduino/cli/commands/v1/board_pb.js

@@ -733,7 +733,8 @@ proto.cc.arduino.cli.commands.v1.BoardDetailsResponse.toObject = function(includ
     debuggingSupported: jspb.Message.getBooleanFieldWithDefault(msg, 14, false),
     identificationPropertiesList: jspb.Message.toObjectList(msg.getIdentificationPropertiesList(),
     proto.cc.arduino.cli.commands.v1.BoardIdentificationProperties.toObject, includeInstance),
-    buildPropertiesList: (f = jspb.Message.getRepeatedField(msg, 16)) == null ? undefined : f
+    buildPropertiesList: (f = jspb.Message.getRepeatedField(msg, 16)) == null ? undefined : f,
+    defaultProgrammerId: jspb.Message.getFieldWithDefault(msg, 17, "")
   };
 
   if (includeInstance) {
@@ -836,6 +837,10 @@ proto.cc.arduino.cli.commands.v1.BoardDetailsResponse.deserializeBinaryFromReade
       var value = /** @type {string} */ (reader.readString());
       msg.addBuildProperties(value);
       break;
+    case 17:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setDefaultProgrammerId(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -976,6 +981,13 @@ proto.cc.arduino.cli.commands.v1.BoardDetailsResponse.serializeBinaryToWriter =
       f
     );
   }
+  f = message.getDefaultProgrammerId();
+  if (f.length > 0) {
+    writer.writeString(
+      17,
+      f
+    );
+  }
 };
 
 
@@ -1386,6 +1398,24 @@ proto.cc.arduino.cli.commands.v1.BoardDetailsResponse.prototype.clearBuildProper
 };
 
 
+/**
+ * optional string default_programmer_id = 17;
+ * @return {string}
+ */
+proto.cc.arduino.cli.commands.v1.BoardDetailsResponse.prototype.getDefaultProgrammerId = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 17, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.cc.arduino.cli.commands.v1.BoardDetailsResponse} returns this
+ */
+proto.cc.arduino.cli.commands.v1.BoardDetailsResponse.prototype.setDefaultProgrammerId = function(value) {
+  return jspb.Message.setProto3StringField(this, 17, value);
+};
+
+
 
 
 
@@ -4181,8 +4211,7 @@ proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.prototype.toObject = func
  */
 proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.toObject = function(includeInstance, msg) {
   var f, obj = {
-    instance: (f = msg.getInstance()) && cc_arduino_cli_commands_v1_common_pb.Instance.toObject(includeInstance, f),
-    interrupt: jspb.Message.getBooleanFieldWithDefault(msg, 2, false)
+    instance: (f = msg.getInstance()) && cc_arduino_cli_commands_v1_common_pb.Instance.toObject(includeInstance, f)
   };
 
   if (includeInstance) {
@@ -4224,10 +4253,6 @@ proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.deserializeBinaryFromRead
       reader.readMessage(value,cc_arduino_cli_commands_v1_common_pb.Instance.deserializeBinaryFromReader);
       msg.setInstance(value);
       break;
-    case 2:
-      var value = /** @type {boolean} */ (reader.readBool());
-      msg.setInterrupt(value);
-      break;
     default:
       reader.skipField();
       break;
@@ -4265,13 +4290,6 @@ proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.serializeBinaryToWriter =
       cc_arduino_cli_commands_v1_common_pb.Instance.serializeBinaryToWriter
     );
   }
-  f = message.getInterrupt();
-  if (f) {
-    writer.writeBool(
-      2,
-      f
-    );
-  }
 };
 
 
@@ -4312,24 +4330,6 @@ proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.prototype.hasInstance = f
 };
 
 
-/**
- * optional bool interrupt = 2;
- * @return {boolean}
- */
-proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.prototype.getInterrupt = function() {
-  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 2, false));
-};
-
-
-/**
- * @param {boolean} value
- * @return {!proto.cc.arduino.cli.commands.v1.BoardListWatchRequest} returns this
- */
-proto.cc.arduino.cli.commands.v1.BoardListWatchRequest.prototype.setInterrupt = function(value) {
-  return jspb.Message.setProto3BooleanField(this, 2, value);
-};
-
-