Update gRPC API of board command to return status.Status instead of error

per1234 · cmaglie · commit 75a60c4d06dc · 2021-07-13T16:15:47.000+02:00
diff --git a/commands/board/attach.go b/commands/board/attach.go
@@ -17,7 +17,6 @@ package board
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"net/url"
 	"strings"
@@ -30,21 +29,24 @@ import (
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	discovery "github.com/arduino/board-discovery"
 	"github.com/arduino/go-paths-helper"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 // Attach FIXMEDOC
-func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.TaskProgressCB) (*rpc.BoardAttachResponse, error) {
+func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.TaskProgressCB) (*rpc.BoardAttachResponse, *status.Status) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
-		return nil, errors.New("invalid instance")
+
+		return nil, status.New(codes.InvalidArgument, "invalid instance")
 	}
 	var sketchPath *paths.Path
 	if req.GetSketchPath() != "" {
 		sketchPath = paths.New(req.GetSketchPath())
 	}
 	sketch, err := sketches.NewSketchFromPath(sketchPath)
 	if err != nil {
-		return nil, fmt.Errorf("opening sketch: %s", err)
+		return nil, status.Newf(codes.FailedPrecondition, "opening sketch: %s", err)
 	}
 
 	boardURI := req.GetBoardUri()
@@ -60,7 +62,7 @@ func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.Ta
 	} else {
 		deviceURI, err := url.Parse(boardURI)
 		if err != nil {
-			return nil, fmt.Errorf("invalid Device URL format: %s", err)
+			return nil, status.Newf(codes.InvalidArgument, "invalid Device URL format: %s", err)
 		}
 
 		var findBoardFunc func(*packagemanager.PackageManager, *discovery.Monitor, *url.URL) *cores.Board
@@ -70,7 +72,7 @@ func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.Ta
 		case "http", "https", "tcp", "udp":
 			findBoardFunc = findNetworkConnectedBoard
 		default:
-			return nil, fmt.Errorf("invalid device port type provided")
+			return nil, status.New(codes.InvalidArgument, "invalid device port type provided")
 		}
 
 		duration, err := time.ParseDuration(req.GetSearchTimeout())
@@ -86,7 +88,7 @@ func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.Ta
 		// TODO: Handle the case when no board is found.
 		board := findBoardFunc(pm, monitor, deviceURI)
 		if board == nil {
-			return nil, fmt.Errorf("no supported board found at %s", deviceURI.String())
+			return nil, status.Newf(codes.NotFound, "no supported board found at %s", deviceURI.String())
 		}
 		taskCB(&rpc.TaskProgress{Name: "Board found: " + board.Name()})
 
@@ -101,7 +103,7 @@ func Attach(ctx context.Context, req *rpc.BoardAttachRequest, taskCB commands.Ta
 
 	err = sketch.ExportMetadata()
 	if err != nil {
-		return nil, fmt.Errorf("cannot export sketch metadata: %s", err)
+		return nil, status.Newf(codes.PermissionDenied, "cannot export sketch metadata: %s", err)
 	}
 	taskCB(&rpc.TaskProgress{Name: "Selected fqbn: " + sketch.Metadata.CPU.Fqbn, Completed: true})
 	return &rpc.BoardAttachResponse{}, nil
diff --git a/commands/board/details.go b/commands/board/details.go
@@ -17,31 +17,31 @@ package board
 
 import (
 	"context"
-	"errors"
-	"fmt"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 // Details returns all details for a board including tools and HW identifiers.
 // This command basically gather al the information and translates it into the required grpc struct properties
-func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error) {
+func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, *status.Status) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
-		return nil, errors.New("invalid instance")
+		return nil, status.New(codes.InvalidArgument, "invalid instance")
 	}
 
 	fqbn, err := cores.ParseFQBN(req.GetFqbn())
 	if err != nil {
-		return nil, fmt.Errorf("parsing fqbn: %s", err)
+		return nil, status.Newf(codes.InvalidArgument, "parsing fqbn: %s", err)
 	}
 
 	boardPackage, boardPlatform, board, boardProperties, boardRefPlatform, err := pm.ResolveFQBN(fqbn)
 
 	if err != nil {
-		return nil, fmt.Errorf("loading board data: %s", err)
+		return nil, status.Newf(codes.FailedPrecondition, "loading board data: %s", err)
 	}
 
 	details := &rpc.BoardDetailsResponse{}
diff --git a/commands/board/list.go b/commands/board/list.go
@@ -33,6 +33,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/segmentio/stats/v4"
 	"github.com/sirupsen/logrus"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 var (
@@ -173,7 +175,7 @@ func identify(pm *packagemanager.PackageManager, port *discovery.Port) ([]*rpc.B
 }
 
 // List FIXMEDOC
-func List(instanceID int32) (r []*rpc.DetectedPort, e error) {
+func List(instanceID int32) (r []*rpc.DetectedPort, e *status.Status) {
 	m.Lock()
 	defer m.Unlock()
 
@@ -190,19 +192,19 @@ func List(instanceID int32) (r []*rpc.DetectedPort, e error) {
 
 	pm := commands.GetPackageManager(instanceID)
 	if pm == nil {
-		return nil, errors.New("invalid instance")
+		return nil, status.New(codes.InvalidArgument, "invalid instance")
 	}
 
 	ports, err := commands.ListBoards(pm)
 	if err != nil {
-		return nil, errors.Wrap(err, "error getting port list from serial-discovery")
+		return nil, status.New(codes.FailedPrecondition, errors.Wrap(err, "error getting port list from serial-discovery").Error())
 	}
 
 	retVal := []*rpc.DetectedPort{}
 	for _, port := range ports {
 		boards, err := identify(pm, port)
 		if err != nil {
-			return nil, err
+			return nil, status.New(codes.Internal, err.Error())
 		}
 
 		// boards slice can be empty at this point if neither the cores nor the
@@ -222,11 +224,11 @@ func List(instanceID int32) (r []*rpc.DetectedPort, e error) {
 
 // Watch returns a channel that receives boards connection and disconnection events.
 // The discovery process can be interrupted by sending a message to the interrupt channel.
-func Watch(instanceID int32, interrupt <-chan bool) (<-chan *rpc.BoardListWatchResponse, error) {
+func Watch(instanceID int32, interrupt <-chan bool) (<-chan *rpc.BoardListWatchResponse, *status.Status) {
 	pm := commands.GetPackageManager(instanceID)
 	eventsChan, err := commands.WatchListBoards(pm)
 	if err != nil {
-		return nil, err
+		return nil, status.New(codes.FailedPrecondition, err.Error())
 	}
 
 	outChan := make(chan *rpc.BoardListWatchResponse)
diff --git a/commands/board/listall.go b/commands/board/listall.go
@@ -17,23 +17,24 @@ package board
 
 import (
 	"context"
-	"errors"
 	"strings"
 
 	"github.com/arduino/arduino-cli/arduino/utils"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 // maximumSearchDistance is the maximum Levenshtein distance accepted when using fuzzy search.
 // This value is completely arbitrary and picked randomly.
 const maximumSearchDistance = 20
 
 // ListAll FIXMEDOC
-func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListAllResponse, error) {
+func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListAllResponse, *status.Status) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
-		return nil, errors.New("invalid instance")
+		return nil, status.New(codes.InvalidArgument, "invalid instance")
 	}
 
 	searchArgs := []string{}
@@ -101,7 +102,7 @@ func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListA
 				toTest := append(toTest, board.Name())
 				toTest = append(toTest, board.FQBN())
 				if ok, err := match(toTest); err != nil {
-					return nil, err
+					return nil, status.New(codes.InvalidArgument, err.Error())
 				} else if !ok {
 					continue
 				}
diff --git a/commands/board/search.go b/commands/board/search.go
@@ -17,23 +17,24 @@ package board
 
 import (
 	"context"
-	"errors"
 	"sort"
 	"strings"
 
 	"github.com/arduino/arduino-cli/arduino/utils"
 	"github.com/arduino/arduino-cli/commands"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 // Search returns all boards that match the search arg.
 // Boards are searched in all platforms, including those in the index that are not yet
 // installed. Note that platforms that are not installed don't include boards' FQBNs.
 // If no search argument is used all boards are returned.
-func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchResponse, error) {
+func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchResponse, *status.Status) {
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	if pm == nil {
-		return nil, errors.New("invalid instance")
+		return nil, status.New(codes.InvalidArgument, "invalid instance")
 	}
 
 	searchArgs := strings.Split(strings.Trim(req.SearchArgs, " "), " ")
@@ -91,7 +92,7 @@ func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchR
 
 					toTest := append(strings.Split(board.Name(), " "), board.Name(), board.FQBN())
 					if ok, err := match(toTest); err != nil {
-						return nil, err
+						return nil, status.New(codes.InvalidArgument, err.Error())
 					} else if !ok {
 						continue
 					}
@@ -107,7 +108,7 @@ func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchR
 				for _, board := range latestPlatformRelease.BoardsManifest {
 					toTest := append(strings.Split(board.Name, " "), board.Name)
 					if ok, err := match(toTest); err != nil {
-						return nil, err
+						return nil, status.New(codes.InvalidArgument, err.Error())
 					} else if !ok {
 						continue
 					}
diff --git a/commands/daemon/daemon.go b/commands/daemon/daemon.go
@@ -40,14 +40,19 @@ type ArduinoCoreServerImpl struct {
 
 // BoardDetails FIXMEDOC
 func (s *ArduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error) {
-	return board.Details(ctx, req)
+	resp, err := board.Details(ctx, req)
+	if err != nil {
+		return nil, err.Err()
+	}
+
+	return resp, nil
 }
 
 // BoardList FIXMEDOC
 func (s *ArduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardListRequest) (*rpc.BoardListResponse, error) {
 	ports, err := board.List(req.GetInstance().GetId())
 	if err != nil {
-		return nil, err
+		return nil, err.Err()
 	}
 
 	return &rpc.BoardListResponse{
@@ -57,12 +62,22 @@ func (s *ArduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardLis
 
 // BoardListAll FIXMEDOC
 func (s *ArduinoCoreServerImpl) BoardListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListAllResponse, error) {
-	return board.ListAll(ctx, req)
+	resp, err := board.ListAll(ctx, req)
+	if err != nil {
+		return nil, err.Err()
+	}
+
+	return resp, nil
 }
 
 // BoardSearch exposes to the gRPC interface the board search command
 func (s *ArduinoCoreServerImpl) BoardSearch(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchResponse, error) {
-	return board.Search(ctx, req)
+	resp, err := board.Search(ctx, req)
+	if err != nil {
+		return nil, err.Err()
+	}
+
+	return resp, nil
 }
 
 // BoardListWatch FIXMEDOC
@@ -109,9 +124,9 @@ func (s *ArduinoCoreServerImpl) BoardListWatch(stream rpc.ArduinoCoreService_Boa
 		}
 	}()
 
-	eventsChan, err := board.Watch(msg.Instance.Id, interrupt)
-	if err != nil {
-		return err
+	eventsChan, stat := board.Watch(msg.Instance.Id, interrupt)
+	if stat != nil {
+		return stat.Err()
 	}
 
 	for event := range eventsChan {
@@ -131,7 +146,7 @@ func (s *ArduinoCoreServerImpl) BoardAttach(req *rpc.BoardAttachRequest, stream
 		func(p *rpc.TaskProgress) { stream.Send(&rpc.BoardAttachResponse{TaskProgress: p}) },
 	)
 	if err != nil {
-		return err
+		return err.Err()
 	}
 	return stream.Send(resp)
 }
