feat(pkg/board): add custom name property in network mode (#537)

Author: lucarin91

cmd/arduino-app-cli/board/board.go

@@ -27,30 +27,31 @@ func NewBoardCmd() *cobra.Command {
 		Use:   "board",
 		Short: "Manage boards",
 		Long:  "",
-		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 			if host != "" {
 				conn, err := adb.FromHost(host, "")
 				if err != nil {
 					panic(fmt.Errorf("failed to connect to ADB host %s: %w", host, err))
 				}
 				cmd.SetContext(context.WithValue(cmd.Context(), remoteConnKey, conn))
-				return
+				return nil
 			}
 
 			boards, err := board.FromFQBN(cmd.Context(), fqbn)
 			if err != nil {
-				panic(err)
+				return fmt.Errorf("failed to get boards for FQBN %s: %w", fqbn, err)
 			}
 			if len(boards) == 0 {
-				panic(fmt.Errorf("no boards found for FQBN %s", fqbn))
+				return fmt.Errorf("no boards found for FQBN %s", fqbn)
 			}
 			conn, err := boards[0].GetConnection()
 			if err != nil {
-				panic(fmt.Errorf("failed to connect to board: %w", err))
+				return fmt.Errorf("failed to connect to board %s: %w", boards[0].BoardName, err)
 			}
 
 			cmd.SetContext(context.WithValue(cmd.Context(), remoteConnKey, conn))
 			cmd.SetContext(context.WithValue(cmd.Context(), boardsListKey, boards))
+			return nil
 		},
 	}
 	fsCmd.PersistentFlags().StringVarP(&fqbn, "fqbn", "b", "arduino:zephyr:unoq", "fqbn of the board")

pkg/board/board.go

@@ -83,16 +83,37 @@ func FromFQBN(ctx context.Context, fqbn string) ([]Board, error) {
 			switch port.GetPort().GetProtocol() {
 			case SerialProtocol:
 				serial := strings.ToLower(port.GetPort().GetHardwareId()) // in windows this is uppercase.
+
+				// TODO: we should store the board custom name in the product id so we can get it from the discovery service.
+				var customName string
+				if conn, err := adb.FromSerial(serial, ""); err == nil {
+					if name, err := GetCustomName(ctx, conn); err == nil {
+						customName = name
+					}
+				}
+
 				boards = append(boards, Board{
-					Protocol:  SerialProtocol,
-					Serial:    serial,
-					BoardName: boardName,
+					Protocol:   SerialProtocol,
+					Serial:     serial,
+					BoardName:  boardName,
+					CustomName: customName,
 				})
 			case NetworkProtocol:
+				var customName string
+				if name, ok := port.GetPort().GetProperties()["hostname"]; ok {
+					// take the part before the first dot as custom name
+					idx := strings.Index(name, ".")
+					if idx == -1 {
+						idx = len(name)
+					}
+					customName = name[:idx]
+				}
+
 				boards = append(boards, Board{
-					Protocol:  NetworkProtocol,
-					Address:   port.GetPort().GetAddress(),
-					BoardName: boardName,
+					Protocol:   NetworkProtocol,
+					Address:    port.GetPort().GetAddress(),
+					BoardName:  boardName,
+					CustomName: customName,
 				})
 			default:
 				slog.Warn("unknown protocol", "protocol", port.GetPort().GetProtocol())
@@ -108,22 +129,6 @@ func FromFQBN(ctx context.Context, fqbn string) ([]Board, error) {
 			}
 		})
 
-		// Get board names
-		for i := range boards {
-			switch boards[i].Protocol {
-			case SerialProtocol:
-				// TODO: we should store the board custom name in the product id so we can get it from the discovery service.
-				var name string
-				if conn, err := adb.FromSerial(boards[i].Serial, ""); err == nil {
-					if name, err = GetCustomName(ctx, conn); err == nil {
-						boards[i].CustomName = name
-					}
-				}
-			case NetworkProtocol:
-				// TODO: get from mDNS
-			}
-		}
-
 		return boards, nil
 	}