cr: remove latest_compatible_version from gRPC api.

We leave only the `latest_compatible` field from the API. This field will have the same meaning the the former `latest_compatible_version`. Meaning that if the `latest_compatible` contains a version it is a release that can be installed. However it might happen that we have newer releases that cannot be installed. If the client is interested to show newer-non-installable-releases, the `releases` field can be used to infer that.
arduino · Nov 8, 2023 · edcdefa · edcdefa
1 parent 55401e9
commit edcdefa
Show file tree

Hide file tree

Showing 13 changed files with 180 additions and 207 deletions.
diff --git a/arduino/cores/packagemanager/package_manager.go b/arduino/cores/packagemanager/package_manager.go
@@ -229,14 +229,20 @@ func (pme *Explorer) GetCustomGlobalProperties() *properties.Map {
 }
 
 // FindPlatformReleaseProvidingBoardsWithVidPid FIXMEDOC
-func (pme *Explorer) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid string) []*cores.Platform {
+func (pme *Explorer) FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid string, showAllRelease bool) []*cores.Platform {
 	res := []*cores.Platform{}
 	for _, targetPackage := range pme.packages {
 		for _, targetPlatform := range targetPackage.Platforms {
-			platformRelease := targetPlatform.GetLatestRelease()
+			var platformRelease *cores.PlatformRelease
+			if showAllRelease {
+				platformRelease = targetPlatform.GetLatestRelease()
+			} else {
+				platformRelease = targetPlatform.GetLatestCompatibleRelease()
+			}
 			if platformRelease == nil {
 				continue
 			}
+
 			for _, boardManifest := range platformRelease.BoardsManifest {
 				if boardManifest.HasUsbID(vid, pid) {
 					res = append(res, targetPlatform)

diff --git a/commands/core/search.go b/commands/core/search.go
@@ -39,7 +39,7 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 	res := []*cores.Platform{}
 	if isUsb, _ := regexp.MatchString("[0-9a-f]{4}:[0-9a-f]{4}", req.SearchArgs); isUsb {
 		vid, pid := req.SearchArgs[:4], req.SearchArgs[5:]
-		res = pme.FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid)
+		res = pme.FindPlatformReleaseProvidingBoardsWithVidPid(vid, pid, req.AllVersions)
 	} else {
 		searchArgs := utils.SearchTermsFromQueryString(req.SearchArgs)
 		for _, targetPackage := range pme.GetPackages() {
@@ -53,12 +53,15 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 					continue
 				}
 
-				// Discard platforms with no releases
-				latestRelease := platform.GetLatestRelease()
-				if latestRelease == nil {
-					continue
+				// In case we ask for all versions we also show incompatible ones
+				var latestRelease *cores.PlatformRelease
+				if req.AllVersions {
+					latestRelease = platform.GetLatestRelease()
+				} else {
+					latestRelease = platform.GetLatestCompatibleRelease()
 				}
-				if latestRelease.Name == "" {
+				// Discard platforms with no releases
+				if latestRelease == nil || latestRelease.Name == "" {
 					continue
 				}
 
@@ -93,12 +96,8 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 			rpcPlatformSummary.InstalledVersion = installed.Version.String()
 			rpcPlatformSummary.Releases[installed.Version.String()] = commands.PlatformReleaseToRPC(installed)
 		}
-		if latest := platform.GetLatestRelease(); latest != nil {
-			rpcPlatformSummary.LatestVersion = latest.Version.String()
-			rpcPlatformSummary.Releases[latest.Version.String()] = commands.PlatformReleaseToRPC(latest)
-		}
 		if latestCompatible := platform.GetLatestCompatibleRelease(); latestCompatible != nil {
-			rpcPlatformSummary.LatestCompatibleVersion = latestCompatible.Version.String()
+			rpcPlatformSummary.LatestVersion = latestCompatible.Version.String()
 			rpcPlatformSummary.Releases[latestCompatible.Version.String()] = commands.PlatformReleaseToRPC(latestCompatible)
 		}
 		if req.AllVersions {
@@ -112,8 +111,7 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 
 	// Sort result alphabetically and put deprecated platforms at the bottom
 	sort.Slice(out, func(i, j int) bool {
-		return strings.ToLower(out[i].GetLatestRelease().GetName()) <
-			strings.ToLower(out[j].GetLatestRelease().GetName())
+		return strings.ToLower(out[i].GetLatestRelease().GetName()) < strings.ToLower(out[j].GetLatestRelease().GetName())
 	})
 	sort.SliceStable(out, func(i, j int) bool {
 		return !out[i].GetMetadata().Deprecated && out[j].GetMetadata().Deprecated

diff --git a/commands/core/search_test.go b/commands/core/search_test.go
@@ -80,41 +80,19 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
 	t.Run("SearchNoAllVersions", func(t *testing.T) {
+		// This platform doesn't contain any installable release
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
 			Instance:    inst,
 			SearchArgs:  "retrokit",
 			AllVersions: false,
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
-		require.Len(t, res.SearchOutput, 1)
-		require.Contains(t, res.SearchOutput, &rpc.PlatformSummary{
-			Metadata: &rpc.PlatformMetadata{
-				Id:         "Retrokits-RK002:arm",
-				Maintainer: "Retrokits (www.retrokits.com)",
-				Website:    "https://www.retrokits.com",
-				Email:      "[email protected]",
-				Indexed:    true,
-			},
-			Releases: map[string]*rpc.PlatformRelease{
-				"1.0.6": {
-					Name:       "RK002",
-					Type:       []string{"Contributed"},
-					Installed:  false,
-					Version:    "1.0.6",
-					Boards:     []*rpc.Board{{Name: "RK002"}},
-					Help:       &rpc.HelpResources{Online: "https://www.retrokits.com/rk002/arduino"},
-					Compatible: false,
-				},
-			},
-			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
-		})
+		require.Empty(t, res.SearchOutput)
 	})
 
 	t.Run("SearchThePackageMaintainer", func(t *testing.T) {
@@ -155,7 +133,6 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
@@ -197,7 +174,6 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
@@ -239,7 +215,6 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
@@ -299,7 +274,6 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.8.3",
 		})
 	})
 
@@ -359,7 +333,6 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.8.3",
 		})
 	})
 }
@@ -383,15 +356,15 @@ func TestPlatformSearchSorting(t *testing.T) {
 	res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
 		Instance:    inst,
 		SearchArgs:  "",
-		AllVersions: false,
+		AllVersions: true,
 	})
 	require.Nil(t, stat)
 	require.NotNil(t, res)
 
 	require.Len(t, res.SearchOutput, 3)
-	require.Equal(t, res.SearchOutput[0].GetLatestRelease().Name, "Arduino AVR Boards")
+	require.Equal(t, res.SearchOutput[0].GetSortedReleases()[0].Name, "Arduino AVR Boards")
 	require.Equal(t, res.SearchOutput[0].Metadata.Deprecated, false)
-	require.Equal(t, res.SearchOutput[1].GetLatestRelease().Name, "RK002")
+	require.Equal(t, res.SearchOutput[1].GetSortedReleases()[0].Name, "RK002")
 	require.Equal(t, res.SearchOutput[1].Metadata.Deprecated, false)
 	require.Equal(t, res.SearchOutput[2].GetLatestRelease().Name, "Platform")
 	require.Equal(t, res.SearchOutput[2].Metadata.Deprecated, true)

diff --git a/internal/cli/arguments/completion.go b/internal/cli/arguments/completion.go
@@ -113,7 +113,7 @@ func GetInstallableCores() []string {
 	var res []string
 	// transform the data structure for the completion
 	for _, i := range platforms.GetSearchOutput() {
-		if latest := i.GetLatestCompatibleRelease(); latest != nil {
+		if latest := i.GetLatestRelease(); latest != nil {
 			res = append(res, i.GetMetadata().GetId()+"\t"+latest.GetName())
 		}
 	}

diff --git a/internal/cli/core/list.go b/internal/cli/core/list.go
@@ -80,7 +80,7 @@ func GetList(inst *rpc.Instance, all bool, updatableOnly bool) []*rpc.PlatformSu
 		if platform.InstalledVersion == "" && !platform.GetMetadata().ManuallyInstalled {
 			continue
 		}
-		if updatableOnly && platform.InstalledVersion == platform.LatestCompatibleVersion {
+		if updatableOnly && platform.InstalledVersion == platform.LatestVersion {
 			continue
 		}
 		result = append(result, platform)
@@ -122,17 +122,15 @@ func (ir coreListResult) String() string {
 			name = installed.Name
 		}
 		if name == "" {
-			if latestCompatible := platform.GetLatestCompatibleRelease(); latestCompatible != nil {
-				name = latestCompatible.Name
-			} else if latest := platform.GetLatestRelease(); latest != nil && name == "" {
+			if latest := platform.GetLatestRelease(); latest != nil {
 				name = latest.Name
 			}
 		}
 		if platform.Deprecated {
 			name = fmt.Sprintf("[%s] %s", tr("DEPRECATED"), name)
 		}
 
-		t.AddRow(platform.Id, platform.InstalledVersion, platform.LatestCompatibleVersion, name)
+		t.AddRow(platform.Id, platform.InstalledVersion, platform.LatestVersion, name)
 	}
 
 	return t.Render()

diff --git a/internal/cli/core/search.go b/internal/cli/core/search.go
@@ -125,8 +125,8 @@ func (sr searchResults) String() string {
 	for _, platform := range sr.platforms {
 		// When allVersions is not requested we only show the latest compatible version
 		if !sr.allVersions {
-			if latestCompatible := platform.GetLatestCompatibleRelease(); latestCompatible != nil {
-				addRow(platform, latestCompatible)
+			if latest := platform.GetLatestRelease(); latest != nil {
+				addRow(platform, latest)
 			}
 			continue
 		}

diff --git a/internal/cli/core/upgrade.go b/internal/cli/core/upgrade.go
@@ -73,13 +73,13 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool, skipPreUni
 			if platform.InstalledVersion == "" {
 				continue
 			}
-			if platform.InstalledVersion == platform.LatestCompatibleVersion {
+			if platform.InstalledVersion == platform.GetLatestVersion() {
 				// if it's not updatable, skip it
 				continue
 			}
 			targets = append(targets, &rpc.Platform{
 				Metadata: platform.GetMetadata(),
-				Release:  platform.GetLatestCompatibleRelease(),
+				Release:  platform.GetLatestRelease(),
 			})
 		}
 

diff --git a/internal/cli/feedback/result/rpc.go b/internal/cli/feedback/result/rpc.go
@@ -37,17 +37,16 @@ func NewPlatformSummary(in *rpc.PlatformSummary) *PlatformSummary {
 	releases.SortKeys((*semver.Version).CompareTo)
 
 	return &PlatformSummary{
-		Id:                      in.GetMetadata().GetId(),
-		Maintainer:              in.GetMetadata().GetMaintainer(),
-		Website:                 in.GetMetadata().GetWebsite(),
-		Email:                   in.GetMetadata().GetEmail(),
-		ManuallyInstalled:       in.GetMetadata().GetManuallyInstalled(),
-		Deprecated:              in.GetMetadata().GetDeprecated(),
-		Indexed:                 in.GetMetadata().GetIndexed(),
-		Releases:                releases,
-		InstalledVersion:        semver.MustParse(in.GetInstalledVersion()),
-		LatestVersion:           semver.MustParse(in.GetLatestVersion()),
-		LatestCompatibleVersion: semver.MustParse(in.LatestCompatibleVersion),
+		Id:                in.GetMetadata().GetId(),
+		Maintainer:        in.GetMetadata().GetMaintainer(),
+		Website:           in.GetMetadata().GetWebsite(),
+		Email:             in.GetMetadata().GetEmail(),
+		ManuallyInstalled: in.GetMetadata().GetManuallyInstalled(),
+		Deprecated:        in.GetMetadata().GetDeprecated(),
+		Indexed:           in.GetMetadata().GetIndexed(),
+		Releases:          releases,
+		InstalledVersion:  semver.MustParse(in.GetInstalledVersion()),
+		LatestVersion:     semver.MustParse(in.GetLatestVersion()),
 	}
 }
 
@@ -63,21 +62,15 @@ type PlatformSummary struct {
 
 	Releases orderedmap.Map[*semver.Version, *PlatformRelease] `json:"releases,omitempty"`
 
-	InstalledVersion        *semver.Version `json:"installed_version,omitempty"`
-	LatestVersion           *semver.Version `json:"latest_version,omitempty"`
-	LatestCompatibleVersion *semver.Version `json:"latest_compatible_version,omitempty"`
+	InstalledVersion *semver.Version `json:"installed_version,omitempty"`
+	LatestVersion    *semver.Version `json:"latest_version,omitempty"`
 }
 
 // GetLatestRelease returns the latest relase of this platform or nil if none available.
 func (p *PlatformSummary) GetLatestRelease() *PlatformRelease {
 	return p.Releases.Get(p.LatestVersion)
 }
 
-// GetLatestCompatibleRelease returns the latest relase of this platform or nil if none available.
-func (p *PlatformSummary) GetLatestCompatibleRelease() *PlatformRelease {
-	return p.Releases.Get(p.LatestCompatibleVersion)
-}
-
 // GetInstalledRelease returns the installed relase of this platform or nil if none available.
 func (p *PlatformSummary) GetInstalledRelease() *PlatformRelease {
 	return p.Releases.Get(p.InstalledVersion)

diff --git a/internal/cli/outdated/outdated.go b/internal/cli/outdated/outdated.go
@@ -109,13 +109,13 @@ func (ir outdatedResult) String() string {
 	// Based on internal/cli/core/list.go
 	for _, p := range ir.Platforms {
 		name := ""
-		if latestCompatible := p.GetLatestCompatibleRelease(); latestCompatible != nil {
-			name = latestCompatible.Name
+		if latest := p.GetLatestRelease(); latest != nil {
+			name = latest.Name
 		}
 		if p.Deprecated {
 			name = fmt.Sprintf("[%s] %s", tr("DEPRECATED"), name)
 		}
-		t.AddRow(p.Id, name, p.InstalledVersion, p.LatestCompatibleVersion, "", "")
+		t.AddRow(p.Id, name, p.InstalledVersion, p.LatestVersion, "", "")
 	}
 
 	// Based on internal/cli/lib/list.go