Commit 5765a92

committed

Removed useless ErrNotFound from apiByVidPid

The `apiByVidPid` function now masks the odd behavior of the builder-api returning an HTTP 404 if the request succeed but the result is empty.

1 parent 781c0b0 commit 5765a92Copy full SHA for 5765a92

File tree

2 files changed

+10

-32

lines changed

commands/board
- list.go
- list_test.go

2 files changed

+10

-32

lines changed

`‎commands/board/list.go‎`

Lines changed: 7 additions & 28 deletions

Original file line number	Diff line number	Diff line change
`@@ -38,15 +38,7 @@ import (`
`38`	`38`	`"github.com/sirupsen/logrus"`
`39`	`39`	`)`
`40`	`40`
`41`		`-type boardNotFoundError struct{}`
`42`		`-`
`43`		`-func (e *boardNotFoundError) Error() string {`
`44`		`- return tr("board not found")`
`45`		`-}`
`46`		`-`
`47`	`41`	`var (`
`48`		`- // ErrNotFound is returned when the API returns 404`
`49`		`- ErrNotFound = &boardNotFoundError{}`
`50`	`42`	`vidPidURL = "https://builder.arduino.cc/v3/boards/byVidPid"`
`51`	`43`	validVidPid = regexp.MustCompile(`0[xX][a-fA-F\d]{4}`)
`52`	`44`	`)`
`@@ -59,9 +51,6 @@ func cachedAPIByVidPid(vid, pid string) ([]*rpc.BoardListItem, error) {`
`59`	`51`	`ts := inventory.Store.GetTime(cacheKey + ".ts")`
`60`	`52`	`if time.Since(ts) < time.Hour*24 {`
`61`	`53`	`// Use cached response`
`62`		`- if cachedResp == "ErrNotFound" {`
`63`		`- return nil, ErrNotFound`
`64`		`- }`
`65`	`54`	`if err := json.Unmarshal([]byte(cachedResp), &resp); err == nil {`
`66`	`55`	`return resp, nil`
`67`	`56`	`}`
`@@ -70,11 +59,7 @@ func cachedAPIByVidPid(vid, pid string) ([]*rpc.BoardListItem, error) {`
`70`	`59`
`71`	`60`	`resp, err := apiByVidPid(vid, pid) // Perform API requrest`
`72`	`61`
`73`		`- if err == ErrNotFound {`
`74`		`- inventory.Store.Set(cacheKey+".data", "ErrNotFound")`
`75`		`- inventory.Store.Set(cacheKey+".ts", time.Now())`
`76`		`- inventory.WriteStore()`
`77`		`- } else if err == nil {`
	`62`	`+ if err == nil {`
`78`	`63`	`if cachedResp, err := json.Marshal(resp); err == nil {`
`79`	`64`	`inventory.Store.Set(cacheKey+".data", string(cachedResp))`
`80`	`65`	`inventory.Store.Set(cacheKey+".ts", time.Now())`
`@@ -109,10 +94,11 @@ func apiByVidPid(vid, pid string) ([]*rpc.BoardListItem, error) {`
`109`	`94`	`if err != nil {`
`110`	`95`	`return nil, errors.Wrap(err, tr("error querying Arduino Cloud Api"))`
`111`	`96`	`}`
	`97`	`+ if res.StatusCode == 404 {`
	`98`	`+ // This is not an error, it just means that the board is not recognized`
	`99`	`+ return nil, nil`
	`100`	`+ }`
`112`	`101`	`if res.StatusCode >= 400 {`
`113`		`- if res.StatusCode == 404 {`
`114`		`- return nil, ErrNotFound`
`115`		`- }`
`116`	`102`	`return nil, errors.Errorf(tr("the server responded with status %s"), res.Status)`
`117`	`103`	`}`
`118`	`104`
`@@ -146,7 +132,7 @@ func identifyViaCloudAPI(port discovery.Port) ([]rpc.BoardListItem, error) {`
`146`	`132`	`// If the port is not USB do not try identification via cloud`
`147`	`133`	`id := port.Properties`
`148`	`134`	`if !id.ContainsKey("vid") \|\| !id.ContainsKey("pid") {`
`149`		`- return nil, ErrNotFound`
	`135`	`+ return nil, nil`
`150`	`136`	`}`
`151`	`137`
`152`	`138`	`logrus.Debug("Querying builder API for board identification...")`
`@@ -181,17 +167,10 @@ func identify(pme packagemanager.Explorer, port discovery.Port) ([]*rpc.BoardL`
`181`	`167`	`// the builder API if the board is a USB device port`
`182`	`168`	`if len(boards) == 0 {`
`183`	`169`	`items, err := identifyViaCloudAPI(port)`
`184`		`- if errors.Is(err, ErrNotFound) {`
`185`		`- // the board couldn't be detected, print a warning`
`186`		`- logrus.Debug("Board not recognized")`
`187`		`- } else if err != nil {`
	`170`	`+ if err != nil {`
`188`	`171`	`// this is bad, but keep going`
`189`	`172`	`logrus.WithError(err).Debug("Error querying builder API")`
`190`	`173`	`}`
`191`		`-`
`192`		- // add a DetectedPort entry in any case: the `Boards` field will
`193`		`- // be empty but the port will be shown anyways (useful for 3rd party`
`194`		`- // boards)`
`195`	`174`	`boards = items`
`196`	`175`	`}`
`197`	`176`

`‎commands/board/list_test.go‎`

Lines changed: 3 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -71,9 +71,8 @@ func TestGetByVidPidNotFound(t *testing.T) {`
`71`	`71`
`72`	`72`	`vidPidURL = ts.URL`
`73`	`73`	`res, err := apiByVidPid("0x0420", "0x0069")`
`74`		`- require.NotNil(t, err)`
`75`		`- require.Equal(t, "board not found", err.Error())`
`76`		`- require.Len(t, res, 0)`
	`74`	`+ require.NoError(t, err)`
	`75`	`+ require.Empty(t, res)`
`77`	`76`	`}`
`78`	`77`
`79`	`78`	`func TestGetByVidPid5xx(t *testing.T) {`
`@@ -108,7 +107,7 @@ func TestBoardDetectionViaAPIWithNonUSBPort(t *testing.T) {`
`108`	`107`	`Properties: properties.NewMap(),`
`109`	`108`	`}`
`110`	`109`	`items, err := identifyViaCloudAPI(port)`
`111`		`- require.ErrorIs(t, err, ErrNotFound)`
	`110`	`+ require.NoError(t, err)`
`112`	`111`	`require.Empty(t, items)`
`113`	`112`	`}`
`114`	`113`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 5765a92

File tree

2 files changed

2 files changed

`‎commands/board/list.go‎`

`‎commands/board/list_test.go‎`

0 commit comments