Reworked function that groups ports by protocol

Author: silvanocerza

arduino-ide-extension/src/browser/contributions/board-selection.ts

@@ -247,19 +247,17 @@ PID: ${PID}`;
     }
 
     // Installed ports
-    const registerPorts = (ports: AvailablePorts) => {
+    const registerPorts = (protocol: string, ports: AvailablePorts) => {
       const addresses = Object.keys(ports);
       if (!addresses.length) {
         return;
       }
 
       // Register placeholder for protocol
-      const [port] = ports[addresses[0]];
-      const protocol = port.protocol;
       const menuPath = [...portsSubmenuPath, protocol];
       const placeholder = new PlaceholderMenuNode(
         menuPath,
-        `${firstToUpperCase(port.protocol)} ports`
+        `${firstToUpperCase(protocol)} ports`
       );
       this.menuModelRegistry.registerMenuNode(menuPath, placeholder);
       this.toDisposeBeforeMenuRebuild.push(
@@ -268,63 +266,68 @@ PID: ${PID}`;
         )
       );
 
-      for (const address of addresses) {
-        if (!!ports[address]) {
-          const [port, boards] = ports[address];
-          if (!boards.length) {
-            boards.push({
-              name: '',
-            });
-          }
-          for (const { name, fqbn } of boards) {
-            const id = `arduino-select-port--${address}${
-              fqbn ? `--${fqbn}` : ''
-            }`;
-            const command = { id };
-            const handler = {
-              execute: () => {
-                if (
-                  !Port.equals(
-                    port,
-                    this.boardsServiceProvider.boardsConfig.selectedPort
-                  )
-                ) {
-                  this.boardsServiceProvider.boardsConfig = {
-                    selectedBoard:
-                      this.boardsServiceProvider.boardsConfig.selectedBoard,
-                    selectedPort: port,
-                  };
-                }
-              },
-              isToggled: () =>
-                Port.equals(
+      for (const address of Object.keys(ports)) {
+        const [port, boards] = ports[address];
+        if (!boards.length) {
+          boards.push({ name: '' });
+        }
+        for (const { name, fqbn } of boards) {
+          const id = `arduino-select-port--${address}${
+            fqbn ? `--${fqbn}` : ''
+          }`;
+          const command = { id };
+          const handler = {
+            execute: () => {
+              if (
+                !Port.equals(
                   port,
                   this.boardsServiceProvider.boardsConfig.selectedPort
-                ),
-            };
-            const label = `${address}${name ? ` (${name})` : ''}`;
-            const menuAction = {
-              commandId: id,
-              label,
-              order: `1${label}`, // `1` comes after the placeholder which has order `0`
-            };
-            this.commandRegistry.registerCommand(command, handler);
-            this.toDisposeBeforeMenuRebuild.push(
-              Disposable.create(() =>
-                this.commandRegistry.unregisterCommand(command)
-              )
-            );
-            this.menuModelRegistry.registerMenuAction(menuPath, menuAction);
-          }
+                )
+              ) {
+                this.boardsServiceProvider.boardsConfig = {
+                  selectedBoard:
+                    this.boardsServiceProvider.boardsConfig.selectedBoard,
+                  selectedPort: port,
+                };
+              }
+            },
+            isToggled: () =>
+              Port.equals(
+                port,
+                this.boardsServiceProvider.boardsConfig.selectedPort
+              ),
+          };
+          const label = `${address}${name ? ` (${name})` : ''}`;
+          const menuAction = {
+            commandId: id,
+            label,
+            order: `1${label}`, // `1` comes after the placeholder which has order `0`
+          };
+          this.commandRegistry.registerCommand(command, handler);
+          this.toDisposeBeforeMenuRebuild.push(
+            Disposable.create(() =>
+              this.commandRegistry.unregisterCommand(command)
+            )
+          );
+          this.menuModelRegistry.registerMenuAction(menuPath, menuAction);
         }
       }
     };
 
-    const { serial, network, unknown } =
-      AvailablePorts.groupByProtocol(availablePorts);
-    registerPorts(serial);
-    registerPorts(network);
-    registerPorts(unknown);
+    const grouped = AvailablePorts.byProtocol(availablePorts);
+    // We first show serial and network ports, then all the rest
+    ['serial', 'network'].forEach((protocol) => {
+      const ports = grouped.get(protocol);
+      if (ports) {
+        registerPorts(protocol, ports);
+      }
+    });
+    grouped.forEach((ports, protocol) => {
+      if (protocol === 'serial' || protocol === 'network') {
+        return;
+      }
+      registerPorts(protocol, ports);
+    });
 
     this.mainMenuManager.update();
   }

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

@@ -6,26 +6,18 @@ import { ArduinoComponent } from './arduino-component';
 
 export type AvailablePorts = Record<string, [Port, Array<Board>]>;
 export namespace AvailablePorts {
-  export function groupByProtocol(availablePorts: AvailablePorts): {
-    serial: AvailablePorts;
-    network: AvailablePorts;
-    unknown: AvailablePorts;
-  } {
-    const serial: AvailablePorts = {};
-    const network: AvailablePorts = {};
-    const unknown: AvailablePorts = {};
-    for (const key of Object.keys(availablePorts)) {
-      const [port, boards] = availablePorts[key];
-      const { protocol } = port;
-      if (protocol === 'serial') {
-        serial[key] = [port, boards];
-      } else if (protocol === 'network') {
-        network[key] = [port, boards];
-      } else {
-        unknown[key] = [port, boards];
+  export function byProtocol(availablePorts: AvailablePorts): Map<string, AvailablePorts> {
+    const grouped = new Map<string, AvailablePorts>();
+    for (const address of Object.keys(availablePorts)) {
+      const [port, boards] = availablePorts[address];
+      let ports = grouped.get(port.protocol);
+      if (!ports) {
+        ports = {} as AvailablePorts;
       }
+      ports[address] = [port, boards];
+      grouped.set(port.protocol, ports);
     }
-    return { serial, network, unknown };
+    return grouped;
   }
 }
 

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

@@ -108,7 +108,7 @@ export class BoardDiscovery extends CoreClientAware {
         }
 
         if (eventType === 'add') {
-          if (newState[port.address] !== undefined) {
+          if (newState[port.address]) {
             const [, knownBoards] = newState[port.address];
             console.warn(
               `Port '${port.address}' was already available. Known boards before override: ${JSON.stringify(
@@ -118,7 +118,7 @@ export class BoardDiscovery extends CoreClientAware {
           }
           newState[port.address] = [port, boards];
         } else if (eventType === 'remove') {
-          if (newState[port.address] === undefined) {
+          if (!newState[port.address]) {
             console.warn(`Port '${port.address}' was not available. Skipping`);
             return;
           }
@@ -159,7 +159,6 @@ export class BoardDiscovery extends CoreClientAware {
   getAvailablePorts(state: AvailablePorts = this.state): Port[] {
     const availablePorts: Port[] = [];
     for (const address of Object.keys(state)) {
-      // tslint:disable-next-line: whitespace
       const [port] = state[address];
       availablePorts.push(port);
     }