fix: move out functions to module scope

Author: Akos Kitta

arduino-ide-extension/src/common/protocol/board-list.ts

@@ -349,12 +349,12 @@ export interface BoardList {
   /**
    * Index of the board+port item that is currently "selected". A board list item is selected, if matches the board+port combination of `boardsConfig`.
    */
-  get selectedIndex(): number;
+  readonly selectedIndex: number;
 
   /**
    * Contains all boards recognized from the detected port, and an optional unrecognized one that is derived from the detected port and the `initParam#selectedBoard`.
    */
-  get boards(): readonly (BoardListItemWithBoard | InferredBoardListItem)[];
+  readonly boards: readonly (BoardListItemWithBoard | InferredBoardListItem)[];
 
   /**
    * If `predicate` is not defined, no ports are filtered.
@@ -370,11 +370,6 @@ export interface BoardList {
     Record<'serial' | 'network' | string, ReturnType<BoardList['ports']>>
   >;
 
-  /**
-   * What's the default action when the argument item is selected in the UI.
-   */
-  // defaultAction(item: BoardListItemUI): BoardListItemAction;
-
   /**
    * For dumping the current state of board list for debugging purposes.
    */
@@ -413,87 +408,25 @@ export function createBoardList(
   items.sort(boardListItemComparator);
   const selectedIndex = findSelectedIndex(boardsConfig, items);
   const labels = createBoardListLabels(boardsConfig, items[selectedIndex]);
-
-  const length = items.length;
-  let _allPorts: DetectedPort[] | undefined;
-  const ports = (
-    predicate: (detectedPort: DetectedPort) => boolean = () => true
-  ) => {
-    if (!_allPorts) {
-      _allPorts = [];
-      // to keep the order or the detected ports
-      const visitedPortKeys = new Set<string>();
-      for (let i = 0; i < length; i++) {
-        const { port } = items[i];
-        const portKey = Port.keyOf(port);
-        if (!visitedPortKeys.has(portKey)) {
-          visitedPortKeys.add(portKey);
-          const detectedPort = detectedPorts[portKey];
-          if (detectedPort) {
-            _allPorts.push(detectedPort);
-          }
-        }
-      }
-    }
-    const ports = _allPorts.filter(predicate);
-    const matchingIndex = findMatchingPortIndex(
-      boardsConfig.selectedPort,
-      ports
-    );
-    return Object.assign(ports, { matchingIndex });
-  };
-
-  let _boards: (BoardListItemWithBoard | InferredBoardListItem)[] | undefined;
+  const boards = collectBoards(items);
+  const allPorts = collectPorts(items, detectedPorts);
   return {
     labels,
     items,
     boardsConfig,
-    get selectedIndex() {
-      return selectedIndex;
-    },
-    get boards() {
-      if (!_boards) {
-        _boards = [];
-        for (let i = 0; i < length; i++) {
-          const item = items[i];
-          if (isInferredBoardListItem(item)) {
-            _boards.push(item);
-          } else if (item.board?.fqbn) {
-            _boards.push(<Required<BoardListItem>>item);
-          }
-        }
-      }
-      return _boards;
-    },
+    boards,
+    selectedIndex,
     ports(predicate?: (detectedPort: DetectedPort) => boolean) {
-      return ports(predicate);
+      return filterPorts(allPorts, boardsConfig.selectedPort, predicate);
     },
     portsGroupedByProtocol() {
-      const result: Record<string, DetectedPort[] & { matchingIndex: number }> =
-        {};
-      const allPorts = ports();
-      for (const detectedPort of allPorts) {
-        const protocol = detectedPort.port.protocol;
-        if (!result[protocol]) {
-          result[protocol] = Object.assign([], {
-            matchingIndex: -1,
-          });
-        }
-        const portsOnProtocol = result[protocol];
-        portsOnProtocol.push(detectedPort);
-      }
-      const matchItem = allPorts[allPorts.matchingIndex];
-      // the cached match index is per all ports. Here, IDE2 needs to adjust the match index per grouped protocol
-      if (matchItem) {
-        const matchProtocol = matchItem.port.protocol;
-        const matchPorts = result[matchProtocol];
-        matchPorts.matchingIndex = matchPorts.indexOf(matchItem);
-      }
-      return result;
+      const _allPorts = filterPorts(allPorts, boardsConfig.selectedPort);
+      return portsGroupedByProtocol(_allPorts);
     },
     toString() {
       return JSON.stringify(
         {
+          labels,
           detectedPorts,
           boardsConfig,
           items,
@@ -507,6 +440,76 @@ export function createBoardList(
   };
 }
 
+function portsGroupedByProtocol(
+  allPorts: ReturnType<BoardList['ports']>
+): ReturnType<BoardList['portsGroupedByProtocol']> {
+  const result: Record<string, DetectedPort[] & { matchingIndex: number }> = {};
+  for (const detectedPort of allPorts) {
+    const protocol = detectedPort.port.protocol;
+    if (!result[protocol]) {
+      result[protocol] = Object.assign([], {
+        matchingIndex: -1,
+      });
+    }
+    const portsOnProtocol = result[protocol];
+    portsOnProtocol.push(detectedPort);
+  }
+  const matchItem = allPorts[allPorts.matchingIndex];
+  // the cached match index is per all ports. Here, IDE2 needs to adjust the match index per grouped protocol
+  if (matchItem) {
+    const matchProtocol = matchItem.port.protocol;
+    const matchPorts = result[matchProtocol];
+    matchPorts.matchingIndex = matchPorts.indexOf(matchItem);
+  }
+  return result;
+}
+
+function filterPorts(
+  allPorts: readonly DetectedPort[],
+  selectedPort: PortIdentifier | undefined,
+  predicate: (detectedPort: DetectedPort) => boolean = () => true
+): ReturnType<BoardList['ports']> {
+  const ports = allPorts.filter(predicate);
+  const matchingIndex = findMatchingPortIndex(selectedPort, ports);
+  return Object.assign(ports, { matchingIndex });
+}
+
+function collectPorts(
+  items: readonly BoardListItem[],
+  detectedPorts: DetectedPorts
+): DetectedPort[] {
+  const allPorts: DetectedPort[] = [];
+  // to keep the order or the detected ports
+  const visitedPortKeys = new Set<string>();
+  for (let i = 0; i < items.length; i++) {
+    const { port } = items[i];
+    const portKey = Port.keyOf(port);
+    if (!visitedPortKeys.has(portKey)) {
+      visitedPortKeys.add(portKey);
+      const detectedPort = detectedPorts[portKey];
+      if (detectedPort) {
+        allPorts.push(detectedPort);
+      }
+    }
+  }
+  return allPorts;
+}
+
+function collectBoards(
+  items: readonly BoardListItem[]
+): readonly (BoardListItemWithBoard | InferredBoardListItem)[] {
+  const boards: (BoardListItemWithBoard | InferredBoardListItem)[] = [];
+  for (let i = 0; i < items.length; i++) {
+    const item = items[i];
+    if (isInferredBoardListItem(item)) {
+      boards.push(item);
+    } else if (item.board?.fqbn) {
+      boards.push(<Required<BoardListItem>>item);
+    }
+  }
+  return boards;
+}
+
 function findSelectedIndex(
   boardsConfig: BoardsConfig,
   items: readonly BoardListItem[]