feat: specialize init errors

Author: Luca Bianconi

arduino/errors.go

@@ -293,7 +293,7 @@ func (e *MissingProgrammerError) ToRPCStatus() *status.Status {
 	return status.New(codes.InvalidArgument, e.Error())
 }
 
-// ProgrammerRequiredForUploadError is returned then the upload can be done only using a programmer
+// ProgrammerRequiredForUploadError is returned when the upload can be done only using a programmer
 type ProgrammerRequiredForUploadError struct{}
 
 func (e *ProgrammerRequiredForUploadError) Error() string {
@@ -308,6 +308,42 @@ func (e *ProgrammerRequiredForUploadError) ToRPCStatus() *status.Status {
 	return st
 }
 
+// FailedInstanceInitReason specifies the reason of a failed initialization
+type FailedInstanceInitReason string
+
+const (
+	// Unspecified the error reason is not specialized
+	Unspecified FailedInstanceInitReason = "UNSPECIFIED"
+	// InvalidIndexURL a package index url is malformed
+	InvalidIndexURL FailedInstanceInitReason = "INVALID_INDEX_URL"
+	// ErrorIndexLoad failure encountered while loading an index
+	ErrorIndexLoad FailedInstanceInitReason = "INDEX_LOAD_ERROR"
+	// ErrorToolLoad failure encountered while loading a tool
+	ErrorToolLoad FailedInstanceInitReason = "TOOL_LOAD_ERROR"
+)
+
+// InitFailedError is returned when the instance initialization fails
+type InitFailedError struct {
+	Code   codes.Code
+	Cause  error
+	Reason FailedInstanceInitReason
+}
+
+func (ife *InitFailedError) Error() string {
+	return ife.Cause.Error()
+}
+
+// ToRPCStatus converts the error into a *status.Status
+func (ife *InitFailedError) ToRPCStatus() *status.Status {
+	st, _ := status.
+		New(ife.Code, ife.Cause.Error()).
+		WithDetails(&rpc.FailedInstanceInitError{
+			Reason:  string(ife.Reason),
+			Message: ife.Cause.Error(),
+		})
+	return st
+}
+
 // ProgrammerNotFoundError is returned when the programmer is not found
 type ProgrammerNotFoundError struct {
 	Programmer string
@@ -405,7 +441,9 @@ func (e *PlatformLoadingError) Error() string {
 
 // ToRPCStatus converts the error into a *status.Status
 func (e *PlatformLoadingError) ToRPCStatus() *status.Status {
-	return status.New(codes.FailedPrecondition, e.Error())
+	s, _ := status.New(codes.FailedPrecondition, e.Error()).
+		WithDetails(&rpc.PlatformLoadingError{})
+	return s
 }
 
 func (e *PlatformLoadingError) Unwrap() error {

commands/instances.go

@@ -303,23 +303,35 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		for _, u := range urls {
 			URL, err := utils.URLParse(u)
 			if err != nil {
-				s := status.Newf(codes.InvalidArgument, tr("Invalid additional URL: %v"), err)
-				responseError(s)
+				e := &arduino.InitFailedError{
+					Code:   codes.InvalidArgument,
+					Cause:  fmt.Errorf(tr("Invalid additional URL: %v", err)),
+					Reason: arduino.InvalidIndexURL,
+				}
+				responseError(e.ToRPCStatus())
 				continue
 			}
 
 			if URL.Scheme == "file" {
 				_, err := pmb.LoadPackageIndexFromFile(paths.New(URL.Path))
 				if err != nil {
-					s := status.Newf(codes.FailedPrecondition, tr("Loading index file: %v"), err)
-					responseError(s)
+					e := &arduino.InitFailedError{
+						Code:   codes.FailedPrecondition,
+						Cause:  fmt.Errorf(tr("Loading index file: %v", err)),
+						Reason: arduino.ErrorIndexLoad,
+					}
+					responseError(e.ToRPCStatus())
 				}
 				continue
 			}
 
 			if err := pmb.LoadPackageIndex(URL); err != nil {
-				s := status.Newf(codes.FailedPrecondition, tr("Loading index file: %v"), err)
-				responseError(s)
+				e := &arduino.InitFailedError{
+					Code:   codes.FailedPrecondition,
+					Cause:  fmt.Errorf(tr("Loading index file: %v", err)),
+					Reason: arduino.ErrorIndexLoad,
+				}
+				responseError(e.ToRPCStatus())
 			}
 		}
 
@@ -331,8 +343,12 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		for name, tool := range pmb.GetOrCreatePackage("builtin").Tools {
 			latest := tool.LatestRelease()
 			if latest == nil {
-				s := status.Newf(codes.Internal, tr("can't find latest release of tool %s", name))
-				responseError(s)
+				e := &arduino.InitFailedError{
+					Code:   codes.Internal,
+					Cause:  fmt.Errorf(tr("can't find latest release of tool %s", name)),
+					Reason: arduino.ErrorToolLoad,
+				}
+				responseError(e.ToRPCStatus())
 			} else if !latest.IsInstalled() {
 				builtinToolsToInstall = append(builtinToolsToInstall, latest)
 			}
@@ -342,8 +358,12 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) erro
 		if len(builtinToolsToInstall) > 0 {
 			for _, toolRelease := range builtinToolsToInstall {
 				if err := installTool(pmb.Build(), toolRelease, downloadCallback, taskCallback); err != nil {
-					s := status.Newf(codes.Internal, err.Error())
-					responseError(s)
+					e := &arduino.InitFailedError{
+						Code:   codes.Internal,
+						Cause:  err,
+						Reason: arduino.ErrorToolLoad,
+					}
+					responseError(e.ToRPCStatus())
 				}
 			}