Reduce priority for IDE-bundled platform releases (arduino#579)

cmaglie · web-flow · commit c1dcf01822e9 · 2020-02-12T10:46:38.000+01:00
Fix arduino/Arduino#9724
diff --git a/arduino/cores/cores.go b/arduino/cores/cores.go
@@ -47,6 +47,7 @@ type PlatformRelease struct {
 	Programmers    map[string]*properties.Map `json:"-"`
 	Menus          *properties.Map            `json:"-"`
 	InstallDir     *paths.Path                `json:"-"`
+	IsIDEBundled   bool                       `json:"-"`
 }
 
 // BoardManifest contains information about a board. These metadata are usually
diff --git a/arduino/cores/packagemanager/loader.go b/arduino/cores/packagemanager/loader.go
@@ -179,6 +179,7 @@ func (pm *PackageManager) loadPlatforms(targetPackage *cores.Package, packageDir
 			}
 
 			// check if package_bundled_index.json exists
+			isIDEBundled := false
 			packageBundledIndexPath := packageDir.Parent().Join("package_index_bundled.json")
 			if packageBundledIndexPath.Exist() {
 				// particular case: ARCHITECTURE/boards.txt with package_bundled_index.json
@@ -204,13 +205,19 @@ func (pm *PackageManager) loadPlatforms(targetPackage *cores.Package, packageDir
 				} else {
 					version = tmpPlatformRelease.Version
 				}
+
+				isIDEBundled = true
 			}
 
 			platform := targetPackage.GetOrCreatePlatform(architecture)
 			release, err := platform.GetOrCreateRelease(version)
 			if err != nil {
 				return fmt.Errorf("loading platform release: %s", err)
 			}
+			release.IsIDEBundled = isIDEBundled
+			if isIDEBundled {
+				pm.Log.Infof("Package is built-in")
+			}
 			if err := pm.loadPlatformRelease(release, platformPath); err != nil {
 				return fmt.Errorf("loading platform release: %s", err)
 			}
diff --git a/arduino/cores/packagemanager/package_manager.go b/arduino/cores/packagemanager/package_manager.go
@@ -323,23 +323,42 @@ func (tr *ToolReleaseActions) Get() (*cores.ToolRelease, error) {
 
 // GetInstalledPlatformRelease returns the PlatformRelease installed (it is chosen)
 func (pm *PackageManager) GetInstalledPlatformRelease(platform *cores.Platform) *cores.PlatformRelease {
+	pm.Log.Infof("Selecting installed platform release for %s", platform)
 	releases := platform.GetAllInstalled()
 	if len(releases) == 0 {
 		return nil
 	}
+
+	log := func(msg string, pl *cores.PlatformRelease) {
+		pm.Log.WithField("bundle", pl.IsIDEBundled).
+			WithField("version", pl.Version).
+			WithField("managed", pm.IsManagedPlatformRelease(pl)).
+			Infof("%s: %s", msg, pl)
+	}
+
 	best := releases[0]
 	bestIsManaged := pm.IsManagedPlatformRelease(best)
+	log("current best", best)
+
 	for _, candidate := range releases[1:] {
 		candidateIsManaged := pm.IsManagedPlatformRelease(candidate)
+		log("candidate", candidate)
+		// TODO: Disentangle this algorithm and make it more straightforward
 		if bestIsManaged == candidateIsManaged {
-			if candidate.Version.GreaterThan(best.Version) {
+			if best.IsIDEBundled == candidate.IsIDEBundled {
+				if candidate.Version.GreaterThan(best.Version) {
+					best = candidate
+				}
+			}
+			if best.IsIDEBundled && !candidate.IsIDEBundled {
 				best = candidate
 			}
 		}
 		if !bestIsManaged && candidateIsManaged {
 			best = candidate
 			bestIsManaged = true
 		}
+		log("current best", best)
 	}
 	return best
 }

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ type PlatformRelease struct {`
`47`	`47`	Programmers map[string]*properties.Map `json:"-"`
`48`	`48`	Menus *properties.Map `json:"-"`
`49`	`49`	InstallDir *paths.Path `json:"-"`
	`50`	+ IsIDEBundled bool `json:"-"`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`// BoardManifest contains information about a board. These metadata are usually`
Original file line number	Diff line number	Diff line change
`@@ -179,6 +179,7 @@ func (pm PackageManager) loadPlatforms(targetPackage cores.Package, packageDir`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`// check if package_bundled_index.json exists`
	`182`	`+ isIDEBundled := false`
`182`	`183`	`packageBundledIndexPath := packageDir.Parent().Join("package_index_bundled.json")`
`183`	`184`	`if packageBundledIndexPath.Exist() {`
`184`	`185`	`// particular case: ARCHITECTURE/boards.txt with package_bundled_index.json`
`@@ -204,13 +205,19 @@ func (pm PackageManager) loadPlatforms(targetPackage cores.Package, packageDir`
`204`	`205`	`} else {`
`205`	`206`	`version = tmpPlatformRelease.Version`
`206`	`207`	`}`
	`208`	`+`
	`209`	`+ isIDEBundled = true`
`207`	`210`	`}`
`208`	`211`
`209`	`212`	`platform := targetPackage.GetOrCreatePlatform(architecture)`
`210`	`213`	`release, err := platform.GetOrCreateRelease(version)`
`211`	`214`	`if err != nil {`
`212`	`215`	`return fmt.Errorf("loading platform release: %s", err)`
`213`	`216`	`}`
	`217`	`+ release.IsIDEBundled = isIDEBundled`
	`218`	`+ if isIDEBundled {`
	`219`	`+ pm.Log.Infof("Package is built-in")`
	`220`	`+ }`
`214`	`221`	`if err := pm.loadPlatformRelease(release, platformPath); err != nil {`
`215`	`222`	`return fmt.Errorf("loading platform release: %s", err)`
`216`	`223`	`}`