Skip to content

Commit fb1b9a0

Browse files
cmagliecmaglie
authored
[skip-changelog] Return error instead of nil in package/library manager getters (#2476)
It makes explicit that the function may fails to get the package manager or the library manager.
1 parent 6732ae0 commit fb1b9a0

26 files changed

+127
-116
lines changed

‎commands/board/details.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ import (
2828
// Details returns all details for a board including tools and HW identifiers.
2929
// This command basically gather al the information and translates it into the required grpc struct properties
3030
func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error) {
31-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
32-
if pme == nil {
33-
return nil, &cmderrors.InvalidInstanceError{}
31+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
32+
if err != nil {
33+
return nil, err
3434
}
3535
defer release()
3636

‎commands/board/list.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -205,9 +205,9 @@ func identify(pme *packagemanager.Explorer, port *discovery.Port) ([]*rpc.BoardL
205205
// In case of errors partial results from discoveries that didn't fail
206206
// are returned.
207207
func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartErrors []error, e error) {
208-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
209-
if pme == nil {
210-
return nil, nil, &cmderrors.InvalidInstanceError{}
208+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
209+
if err != nil {
210+
return nil, nil, err
211211
}
212212
defer release()
213213

@@ -260,9 +260,9 @@ func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *cores.FQBN) bool {
260260

261261
// Watch returns a channel that receives boards connection and disconnection events.
262262
func Watch(ctx context.Context, req *rpc.BoardListWatchRequest) (<-chan *rpc.BoardListWatchResponse, error) {
263-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
264-
if pme == nil {
265-
return nil, &cmderrors.InvalidInstanceError{}
263+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
264+
if err != nil {
265+
return nil, err
266266
}
267267
defer release()
268268
dm := pme.DiscoveryManager()

‎commands/board/listall.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import (
2121
"strings"
2222

2323
"github.com/arduino/arduino-cli/commands"
24-
"github.com/arduino/arduino-cli/commands/cmderrors"
2524
"github.com/arduino/arduino-cli/commands/internal/instances"
2625
"github.com/arduino/arduino-cli/internal/arduino/cores"
2726
"github.com/arduino/arduino-cli/internal/arduino/utils"
@@ -30,9 +29,9 @@ import (
3029

3130
// ListAll FIXMEDOC
3231
func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListAllResponse, error) {
33-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
34-
if pme == nil {
35-
return nil, &cmderrors.InvalidInstanceError{}
32+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
33+
if err != nil {
34+
return nil, err
3635
}
3736
defer release()
3837

‎commands/board/search.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import (
2121
"strings"
2222

2323
"github.com/arduino/arduino-cli/commands"
24-
"github.com/arduino/arduino-cli/commands/cmderrors"
2524
"github.com/arduino/arduino-cli/commands/internal/instances"
2625
"github.com/arduino/arduino-cli/internal/arduino/utils"
2726
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -32,9 +31,9 @@ import (
3231
// installed. Note that platforms that are not installed don't include boards' FQBNs.
3332
// If no search argument is used all boards are returned.
3433
func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchResponse, error) {
35-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
36-
if pme == nil {
37-
return nil, &cmderrors.InvalidInstanceError{}
34+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
35+
if err != nil {
36+
return nil, err
3837
}
3938
defer release()
4039

‎commands/compile/compile.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
5757
exportBinaries = reqExportBinaries.GetValue()
5858
}
5959

60-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
61-
if pme == nil {
62-
return nil, &cmderrors.InvalidInstanceError{}
60+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
61+
if err != nil {
62+
return nil, err
6363
}
6464
defer release()
6565

66-
lm := instances.GetLibraryManager(req.GetInstance())
67-
if lm == nil {
68-
return nil, &cmderrors.InvalidInstanceError{}
66+
lm, err := instances.GetLibraryManager(req.GetInstance())
67+
if err != nil {
68+
return nil, err
6969
}
7070

7171
logrus.Tracef("Compile %s for %s started", req.GetSketchPath(), req.GetFqbn())

‎commands/core/download.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ var tr = i18n.Tr
3030

3131
// PlatformDownload FIXMEDOC
3232
func PlatformDownload(ctx context.Context, req *rpc.PlatformDownloadRequest, downloadCB rpc.DownloadProgressCB) (*rpc.PlatformDownloadResponse, error) {
33-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
34-
if pme == nil {
35-
return nil, &cmderrors.InvalidInstanceError{}
33+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
34+
if err != nil {
35+
return nil, err
3636
}
3737
defer release()
3838

‎commands/core/install.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ import (
2929
// PlatformInstall FIXMEDOC
3030
func PlatformInstall(ctx context.Context, req *rpc.PlatformInstallRequest, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (*rpc.PlatformInstallResponse, error) {
3131
install := func() error {
32-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
33-
if pme == nil {
34-
return &cmderrors.InvalidInstanceError{}
32+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
33+
if err != nil {
34+
return err
3535
}
3636
defer release()
3737

‎commands/core/search.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import (
2121
"strings"
2222

2323
"github.com/arduino/arduino-cli/commands"
24-
"github.com/arduino/arduino-cli/commands/cmderrors"
2524
"github.com/arduino/arduino-cli/commands/internal/instances"
2625
"github.com/arduino/arduino-cli/internal/arduino/cores"
2726
"github.com/arduino/arduino-cli/internal/arduino/utils"
@@ -30,9 +29,9 @@ import (
3029

3130
// PlatformSearch FIXMEDOC
3231
func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse, error) {
33-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
34-
if pme == nil {
35-
return nil, &cmderrors.InvalidInstanceError{}
32+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
33+
if err != nil {
34+
return nil, err
3635
}
3736
defer release()
3837

‎commands/core/uninstall.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ func PlatformUninstall(ctx context.Context, req *rpc.PlatformUninstallRequest, t
3838

3939
// platformUninstall is the implementation of platform unistaller
4040
func platformUninstall(ctx context.Context, req *rpc.PlatformUninstallRequest, taskCB rpc.TaskProgressCB) error {
41-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
42-
if pme == nil {
41+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
42+
if err != nil {
4343
return &cmderrors.InvalidInstanceError{}
4444
}
4545
defer release()

‎commands/core/upgrade.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import (
1919
"context"
2020

2121
"github.com/arduino/arduino-cli/commands"
22-
"github.com/arduino/arduino-cli/commands/cmderrors"
2322
"github.com/arduino/arduino-cli/commands/internal/instances"
2423
"github.com/arduino/arduino-cli/internal/arduino/cores"
2524
"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
@@ -29,9 +28,9 @@ import (
2928
// PlatformUpgrade FIXMEDOC
3029
func PlatformUpgrade(ctx context.Context, req *rpc.PlatformUpgradeRequest, downloadCB rpc.DownloadProgressCB, taskCB rpc.TaskProgressCB) (*rpc.PlatformUpgradeResponse, error) {
3130
upgrade := func() (*cores.PlatformRelease, error) {
32-
pme, release := instances.GetPackageManagerExplorer(req.GetInstance())
33-
if pme == nil {
34-
return nil, &cmderrors.InvalidInstanceError{}
31+
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
32+
if err != nil {
33+
return nil, err
3534
}
3635
defer release()
3736

0 commit comments

Comments
 (0)