Correctly implemented 'board list' timeout option

Author: cmaglie

cli/board/list.go

@@ -41,16 +41,16 @@ func initListCommand() *cobra.Command {
 		Run:     runListCommand,
 	}
 
-	listCommand.Flags().StringVar(&listFlags.timeout, "timeout", "0s",
-		"The connected devices search timeout, raise it if your board doesn't show up (e.g. to 10s).")
+	listCommand.Flags().DurationVar(&listFlags.timeout, "timeout", 0,
+		"The connected devices search timeout, raise it if your board doesn't show up e.g.: 10s")
 	listCommand.Flags().BoolVarP(&listFlags.watch, "watch", "w", false,
 		"Command keeps running and prints list of connected boards whenever there is a change.")
 
 	return listCommand
 }
 
 var listFlags struct {
-	timeout string // Expressed in a parsable duration, is the timeout for the list and attach commands.
+	timeout time.Duration
 	watch   bool
 }
 
@@ -62,20 +62,15 @@ func runListCommand(cmd *cobra.Command, args []string) {
 		os.Exit(0)
 	}
 
-	if timeout, err := time.ParseDuration(listFlags.timeout); err != nil {
-		feedback.Errorf("Invalid timeout: %v", err)
-		os.Exit(errorcodes.ErrBadArgument)
-	} else {
-		time.Sleep(timeout)
-	}
-
 	inst := instance.CreateAndInit()
-	ports, err := board.List(inst.GetId())
+	ports, err := board.List(&rpc.BoardListRequest{
+		Instance: inst,
+		Timeout:  listFlags.timeout.Milliseconds(),
+	})
 	if err != nil {
 		feedback.Errorf("Error detecting boards: %v", err)
 		os.Exit(errorcodes.ErrNetwork)
 	}
-
 	feedback.PrintResult(result{ports})
 }
 

commands/board/list.go

@@ -23,7 +23,7 @@ import (
 	"regexp"
 	"sort"
 	"strings"
-	"sync"
+	"time"
 
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/discovery"
@@ -38,7 +38,6 @@ import (
 var (
 	// ErrNotFound is returned when the API returns 404
 	ErrNotFound = errors.New("board not found")
-	m           sync.Mutex
 	vidPidURL   = "https://builder.arduino.cc/v3/boards/byVidPid"
 	validVidPid = regexp.MustCompile(`0[xX][a-fA-F\d]{4}`)
 )
@@ -173,10 +172,7 @@ func identify(pm *packagemanager.PackageManager, port *discovery.Port) ([]*rpc.B
 }
 
 // List FIXMEDOC
-func List(instanceID int32) (r []*rpc.DetectedPort, e error) {
-	m.Lock()
-	defer m.Unlock()
-
+func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, e error) {
 	tags := map[string]string{}
 	// Use defer func() to evaluate tags map when function returns
 	// and set success flag inspecting the error named return parameter
@@ -188,21 +184,27 @@ func List(instanceID int32) (r []*rpc.DetectedPort, e error) {
 		stats.Incr("compile", stats.M(tags)...)
 	}()
 
-	pm := commands.GetPackageManager(instanceID)
+	pm := commands.GetPackageManager(req.GetInstance().Id)
 	if pm == nil {
 		return nil, errors.New("invalid instance")
 	}
 
-	if err := pm.DiscoveryManager().RunAll(); err != nil {
+	dm := pm.DiscoveryManager()
+	if err := dm.RunAll(); err != nil {
 		return nil, err
 	}
-	if err := pm.DiscoveryManager().StartAll(); err != nil {
+	if err := dm.StartAll(); err != nil {
 		return nil, err
 	}
-	ports := pm.DiscoveryManager().List()
+	defer func() {
+		if err := dm.StopAll(); err != nil {
+			logrus.Error(err)
+		}
+	}()
+	time.Sleep(time.Duration(req.GetTimeout()) * time.Millisecond)
 
 	retVal := []*rpc.DetectedPort{}
-	for _, port := range ports {
+	for _, port := range pm.DiscoveryManager().List() {
 		boards, err := identify(pm, port)
 		if err != nil {
 			return nil, err

commands/daemon/daemon.go

@@ -45,7 +45,7 @@ func (s *ArduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.Board
 
 // BoardList FIXMEDOC
 func (s *ArduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardListRequest) (*rpc.BoardListResponse, error) {
-	ports, err := board.List(req.GetInstance().GetId())
+	ports, err := board.List(req)
 	if err != nil {
 		return nil, err
 	}

rpc/cc/arduino/cli/commands/v1/board.pb.go

@@ -174,6 +174,8 @@ message BoardAttachResponse {
 message BoardListRequest {
   // Arduino Core Service instance from the `Init` response.
   Instance instance = 1;
+  // Search for boards for the given time (in milliseconds)
+  int64 timeout = 2;
 }
 
 message BoardListResponse {