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.

Author: alessio-perugini

arduino/cores/packagemanager/download.go

@@ -89,7 +89,7 @@ func (pme *Explorer) FindPlatformReleaseDependencies(item *PlatformReference) (*
 	} else {
 		release = platform.GetLatestCompatibleRelease()
 		if release == nil {
-			return nil, nil, fmt.Errorf(tr("platform %s has no available releases for your OS"), platform.String())
+			return nil, nil, fmt.Errorf(tr("platform is not available for your OS"))
 		}
 	}
 

commands/board/search.go

@@ -41,7 +41,7 @@ func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchR
 	foundBoards := []*rpc.BoardListItem{}
 	for _, targetPackage := range pme.GetPackages() {
 		for _, platform := range targetPackage.Platforms {
-			latestPlatformRelease := platform.GetLatestRelease()
+			latestPlatformRelease := platform.GetLatestCompatibleRelease()
 			installedPlatformRelease := pme.GetInstalledPlatformRelease(platform)
 
 			if latestPlatformRelease == nil && installedPlatformRelease == nil {

commands/core/search.go

@@ -55,10 +55,7 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 
 				// Discard platforms with no releases
 				latestRelease := platform.GetLatestRelease()
-				if latestRelease == nil {
-					continue
-				}
-				if latestRelease.Name == "" {
+				if latestRelease == nil || latestRelease.Name == "" {
 					continue
 				}
 
@@ -91,29 +88,20 @@ func PlatformSearch(req *rpc.PlatformSearchRequest) (*rpc.PlatformSearchResponse
 		}
 		if installed := pme.GetInstalledPlatformRelease(platform); installed != nil {
 			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.Releases[latestCompatible.Version.String()] = commands.PlatformReleaseToRPC(latestCompatible)
+			rpcPlatformSummary.LatestVersion = latestCompatible.Version.String()
 		}
-		if req.AllVersions {
-			for _, platformRelease := range platform.GetAllReleases() {
-				rpcPlatformRelease := commands.PlatformReleaseToRPC(platformRelease)
-				rpcPlatformSummary.Releases[rpcPlatformRelease.Version] = rpcPlatformRelease
-			}
+		for _, platformRelease := range platform.GetAllReleases() {
+			rpcPlatformRelease := commands.PlatformReleaseToRPC(platformRelease)
+			rpcPlatformSummary.Releases[rpcPlatformRelease.Version] = rpcPlatformRelease
 		}
 		out = append(out, rpcPlatformSummary)
 	}
 
 	// 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].GetMetadata().GetId()) < strings.ToLower(out[j].GetMetadata().GetId())
 	})
 	sort.SliceStable(out, func(i, j int) bool {
 		return !out[i].GetMetadata().Deprecated && out[j].GetMetadata().Deprecated

commands/core/search_test.go

@@ -43,9 +43,8 @@ func TestPlatformSearch(t *testing.T) {
 
 	t.Run("SearchAllVersions", func(t *testing.T) {
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			SearchArgs:  "retrokit",
-			AllVersions: true,
+			Instance:   inst,
+			SearchArgs: "retrokit",
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
@@ -80,48 +79,13 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
-		})
-	})
-
-	t.Run("SearchNoAllVersions", func(t *testing.T) {
-		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",
 		})
 	})
 
 	t.Run("SearchThePackageMaintainer", func(t *testing.T) {
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			SearchArgs:  "Retrokits (www.retrokits.com)",
-			AllVersions: true,
+			Instance:   inst,
+			SearchArgs: "Retrokits (www.retrokits.com)",
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
@@ -155,15 +119,13 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
 	t.Run("SearchPackageName", func(t *testing.T) {
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			SearchArgs:  "Retrokits-RK002",
-			AllVersions: true,
+			Instance:   inst,
+			SearchArgs: "Retrokits-RK002",
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
@@ -197,15 +159,13 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
 	t.Run("SearchPlatformName", func(t *testing.T) {
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			SearchArgs:  "rk002",
-			AllVersions: true,
+			Instance:   inst,
+			SearchArgs: "rk002",
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
@@ -239,15 +199,13 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.0.6",
 		})
 	})
 
 	t.Run("SearchBoardName", func(t *testing.T) {
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			SearchArgs:  "Yún",
-			AllVersions: true,
+			Instance:   inst,
+			SearchArgs: "Yún",
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
@@ -299,15 +257,13 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.8.3",
 		})
 	})
 
 	t.Run("SearchBoardName2", func(t *testing.T) {
 		res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			SearchArgs:  "yun",
-			AllVersions: true,
+			Instance:   inst,
+			SearchArgs: "yun",
 		})
 		require.Nil(t, stat)
 		require.NotNil(t, res)
@@ -359,7 +315,6 @@ func TestPlatformSearch(t *testing.T) {
 				},
 			},
 			InstalledVersion: "",
-			LatestVersion:    "1.8.3",
 		})
 	})
 }
@@ -381,17 +336,16 @@ func TestPlatformSearchSorting(t *testing.T) {
 	require.NotNil(t, inst)
 
 	res, stat := PlatformSearch(&rpc.PlatformSearchRequest{
-		Instance:    inst,
-		SearchArgs:  "",
-		AllVersions: false,
+		Instance:   inst,
+		SearchArgs: "",
 	})
 	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)

internal/cli/arguments/completion.go

@@ -85,7 +85,6 @@ func GetUninstallableCores() []string {
 
 	platforms, _ := core.PlatformSearch(&rpc.PlatformSearchRequest{
 		Instance:          inst,
-		AllVersions:       false,
 		ManuallyInstalled: true,
 	})
 
@@ -106,14 +105,13 @@ func GetInstallableCores() []string {
 	inst := instance.CreateAndInit()
 
 	platforms, _ := core.PlatformSearch(&rpc.PlatformSearchRequest{
-		Instance:    inst,
-		SearchArgs:  "",
-		AllVersions: false,
+		Instance:   inst,
+		SearchArgs: "",
 	})
 	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())
 		}
 	}

internal/cli/arguments/reference.go

@@ -96,8 +96,7 @@ func ParseReference(arg string) (*Reference, error) {
 	// try to use core.PlatformList to optimize what the user typed
 	// (by replacing the PackageName and Architecture in ret with the content of core.GetPlatform())
 	platforms, _ := core.PlatformSearch(&rpc.PlatformSearchRequest{
-		Instance:    instance.CreateAndInit(),
-		AllVersions: false,
+		Instance: instance.CreateAndInit(),
 	})
 	foundPlatforms := []string{}
 	for _, platform := range platforms.GetSearchOutput() {

internal/cli/compile/compile.go

@@ -370,9 +370,8 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 				res.Error += fmt.Sprintln()
 
 				if platform, err := core.PlatformSearch(&rpc.PlatformSearchRequest{
-					Instance:    inst,
-					SearchArgs:  platformErr.Platform,
-					AllVersions: false,
+					Instance:   inst,
+					SearchArgs: platformErr.Platform,
 				}); err != nil {
 					res.Error += err.Error()
 				} else if len(platform.GetSearchOutput()) > 0 {

internal/cli/core/list.go

@@ -16,7 +16,6 @@
 package core
 
 import (
-	"fmt"
 	"os"
 
 	"github.com/arduino/arduino-cli/commands/core"
@@ -63,7 +62,6 @@ func List(inst *rpc.Instance, all bool, updatableOnly bool) {
 func GetList(inst *rpc.Instance, all bool, updatableOnly bool) []*rpc.PlatformSummary {
 	platforms, err := core.PlatformSearch(&rpc.PlatformSearchRequest{
 		Instance:          inst,
-		AllVersions:       true,
 		ManuallyInstalled: true,
 	})
 	if err != nil {
@@ -80,7 +78,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)
@@ -117,22 +115,11 @@ func (ir coreListResult) String() string {
 	t := table.New()
 	t.SetHeader(tr("ID"), tr("Installed"), tr("Latest"), tr("Name"))
 	for _, platform := range ir.platforms {
-		var name string
-		if installed := platform.GetInstalledRelease(); installed != nil {
-			name = installed.Name
+		latestVersion := platform.LatestVersion.String()
+		if latestVersion == "" {
+			latestVersion = "n/a"
 		}
-		if name == "" {
-			if latestCompatible := platform.GetLatestCompatibleRelease(); latestCompatible != nil {
-				name = latestCompatible.Name
-			} else if latest := platform.GetLatestRelease(); latest != nil && name == "" {
-				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, latestVersion, platform.GetPlatformName())
 	}
 
 	return t.Render()

internal/cli/core/search.go

@@ -72,9 +72,8 @@ func runSearchCommand(cmd *cobra.Command, args []string, allVersions bool) {
 	logrus.Infof("Executing `arduino-cli core search` with args: '%s'", arguments)
 
 	resp, err := core.PlatformSearch(&rpc.PlatformSearchRequest{
-		Instance:    inst,
-		SearchArgs:  arguments,
-		AllVersions: allVersions,
+		Instance:   inst,
+		SearchArgs: arguments,
 	})
 	if err != nil {
 		feedback.Fatal(tr("Error searching for platforms: %v", err), feedback.ErrGeneric)
@@ -115,19 +114,17 @@ func (sr searchResults) String() string {
 	t.SetHeader(tr("ID"), tr("Version"), tr("Name"))
 
 	addRow := func(platform *result.PlatformSummary, release *result.PlatformRelease) {
-		name := release.Name
-		if release.Deprecated {
-			name = fmt.Sprintf("[%s] %s", tr("DEPRECATED"), release.Name)
+		if release == nil {
+			t.AddRow(platform.Id, "n/a", platform.GetPlatformName())
+			return
 		}
-		t.AddRow(platform.Id, release.Version, name)
+		t.AddRow(platform.Id, release.Version, release.FormatName())
 	}
 
 	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)
-			}
+			addRow(platform, platform.GetLatestRelease())
 			continue
 		}
 

internal/cli/core/upgrade.go

@@ -61,8 +61,7 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool, skipPreUni
 	// if no platform was passed, upgrade allthethings
 	if len(args) == 0 {
 		platforms, err := core.PlatformSearch(&rpc.PlatformSearchRequest{
-			Instance:    inst,
-			AllVersions: false,
+			Instance: inst,
 		})
 		if err != nil {
 			feedback.Fatal(tr("Error retrieving core list: %v", err), feedback.ErrGeneric)
@@ -73,14 +72,14 @@ func Upgrade(inst *rpc.Instance, args []string, skipPostInstall bool, skipPreUni
 			if platform.InstalledVersion == "" {
 				continue
 			}
-			if platform.InstalledVersion == platform.LatestCompatibleVersion {
-				// if it's not updatable, skip it
-				continue
+			// if it's not updatable, skip it
+			latestRelease := platform.GetLatestRelease()
+			if latestRelease != nil && platform.InstalledVersion != latestRelease.Version {
+				targets = append(targets, &rpc.Platform{
+					Metadata: platform.GetMetadata(),
+					Release:  latestRelease,
+				})
 			}
-			targets = append(targets, &rpc.Platform{
-				Metadata: platform.GetMetadata(),
-				Release:  platform.GetLatestCompatibleRelease(),
-			})
 		}
 
 		if len(targets) == 0 {