Improve error code when platform not available for OS (arduino#2933)

alessio-perugini · web-flow · commit 11b2625fc8b4 · 2025-06-12T10:13:31.000+02:00
* arduino: improve error code when platform not available for OS

* fix typo
diff --git a/commands/cmderrors/cmderrors.go b/commands/cmderrors/cmderrors.go
@@ -16,6 +16,7 @@
 package cmderrors
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -415,6 +416,26 @@ func (e *PlatformNotFoundError) Unwrap() error {
 	return e.Cause
 }
 
+// PlatformNotAvailableForOSError is returned when a platform contains a tool not available
+// for the user OS + ARCH
+type PlatformNotAvailableForOSError struct {
+	Platform string
+	Cause    error
+}
+
+func (e *PlatformNotAvailableForOSError) Error() string {
+	return composeErrorMsg(i18n.Tr("Platform '%s'", e.Platform), errors.New(i18n.Tr("platform is not available for your OS")))
+}
+
+// GRPCStatus converts the error into a *status.Status
+func (e *PlatformNotAvailableForOSError) GRPCStatus() *status.Status {
+	return status.New(codes.FailedPrecondition, e.Error())
+}
+
+func (e *PlatformNotAvailableForOSError) Unwrap() error {
+	return e.Cause
+}
+
 // PlatformLoadingError is returned when a platform has fatal errors that prevents loading
 type PlatformLoadingError struct {
 	Cause error
diff --git a/commands/service_platform_install.go b/commands/service_platform_install.go
@@ -17,6 +17,7 @@ package commands
 
 import (
 	"context"
+	"errors"
 	"fmt"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
@@ -79,6 +80,9 @@ func (s *arduinoCoreServerImpl) PlatformInstall(req *rpc.PlatformInstallRequest,
 		}
 		platformRelease, tools, err := pme.FindPlatformReleaseDependencies(ref)
 		if err != nil {
+			if errors.Is(err, packagemanager.ErrPlatformNotAvailableForOS) {
+				return &cmderrors.PlatformNotAvailableForOSError{Platform: ref.String()}
+			}
 			return &cmderrors.PlatformNotFoundError{Platform: ref.String(), Cause: err}
 		}
 
diff --git a/internal/arduino/cores/packagemanager/download.go b/internal/arduino/cores/packagemanager/download.go
@@ -26,6 +26,8 @@ import (
 	semver "go.bug.st/relaxed-semver"
 )
 
+var ErrPlatformNotAvailableForOS = errors.New("platform is not available for your OS")
+
 // PlatformReference represents a tuple to identify a Platform
 type PlatformReference struct {
 	Package              string // The package where this Platform belongs to.
@@ -89,7 +91,7 @@ func (pme *Explorer) FindPlatformReleaseDependencies(item *PlatformReference) (*
 	} else {
 		release = platform.GetLatestCompatibleRelease()
 		if release == nil {
-			return nil, nil, errors.New(i18n.Tr("platform is not available for your OS"))
+			return nil, nil, ErrPlatformNotAvailableForOS
 		}
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ package commands`
`17`	`17`
`18`	`18`	`import (`
`19`	`19`	`"context"`
	`20`	`+ "errors"`
`20`	`21`	`"fmt"`
`21`	`22`
`22`	`23`	`"github.com/arduino/arduino-cli/commands/cmderrors"`
`@@ -79,6 +80,9 @@ func (s arduinoCoreServerImpl) PlatformInstall(req rpc.PlatformInstallRequest,`
`79`	`80`	`}`
`80`	`81`	`platformRelease, tools, err := pme.FindPlatformReleaseDependencies(ref)`
`81`	`82`	`if err != nil {`
	`83`	`+ if errors.Is(err, packagemanager.ErrPlatformNotAvailableForOS) {`
	`84`	`+ return &cmderrors.PlatformNotAvailableForOSError{Platform: ref.String()}`
	`85`	`+ }`
`82`	`86`	`return &cmderrors.PlatformNotFoundError{Platform: ref.String(), Cause: err}`
`83`	`87`	`}`
`84`	`88`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ import (`
`26`	`26`	`semver "go.bug.st/relaxed-semver"`
`27`	`27`	`)`
`28`	`28`
	`29`	`+var ErrPlatformNotAvailableForOS = errors.New("platform is not available for your OS")`
	`30`	`+`
`29`	`31`	`// PlatformReference represents a tuple to identify a Platform`
`30`	`32`	`type PlatformReference struct {`
`31`	`33`	`Package string // The package where this Platform belongs to.`
`@@ -89,7 +91,7 @@ func (pme Explorer) FindPlatformReleaseDependencies(item PlatformReference) (*`
`89`	`91`	`} else {`
`90`	`92`	`release = platform.GetLatestCompatibleRelease()`
`91`	`93`	`if release == nil {`
`92`		`- return nil, nil, errors.New(i18n.Tr("platform is not available for your OS"))`
	`94`	`+ return nil, nil, ErrPlatformNotAvailableForOS`
`93`	`95`	`}`
`94`	`96`	`}`
`95`	`97`