Make sure default platforms recommended by registries have higher preferrences than those referenced from downstream platforms

Author: aloubyansky

independent-projects/tools/devtools-testing/src/test/java/io/quarkus/devtools/project/create/QuarkusPlatformBasedOnArchivedQuarkusCoreTest.java

@@ -0,0 +1,102 @@
+package io.quarkus.devtools.project.create;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.devtools.testing.registry.client.TestRegistryClientBuilder;
+import io.quarkus.maven.dependency.ArtifactCoords;
+
+public class QuarkusPlatformBasedOnArchivedQuarkusCoreTest extends MultiplePlatformBomsTestBase {
+
+    private static final String ACME_PLATFORM_KEY = "org.acme.platform";
+    private static final String OTHER_PLATFORM_KEY = "org.other.platform";
+
+    @BeforeAll
+    public static void setup() throws Exception {
+        TestRegistryClientBuilder.newInstance()
+                //.debug()
+                .baseDir(configDir())
+                // registry
+                .newRegistry("registry.acme.org")
+                // platform key
+                .newPlatform(ACME_PLATFORM_KEY)
+                // 3.0 STREAM
+                .newStream("5.0")
+                // 3.0.5 release
+                .newRelease("5.0.5")
+                .quarkusVersion("3.0.5")
+                .newMember("acme-zoo-bom").addExtension("org.acme", "acme-rabbit", "5.0.5")
+                .release().stream().platform()
+                // not promoted later release
+                .newArchivedStream("6.0")
+                .newRelease("6.0.0")
+                .quarkusVersion("4.0.0")
+                .newMember("acme-zoo-bom").addExtension("org.acme", "acme-rabbit", "6.0.0")
+                .release().stream().platform()
+                .registry().clientBuilder()
+                // Other registry
+                .newRegistry("registry.other.org")
+                .newPlatform(OTHER_PLATFORM_KEY)
+                .newStream("4.0")
+                .newRelease("4.0.0")
+                .quarkusVersion("4.0.0")
+                .addCoreMember()
+                .addExtension("quarkus-rest")
+                .addExtension("quarkus-magic")
+                .release().stream().platform()
+                // 3.0 STREAM
+                .newArchivedStream("3.0")
+                .newRelease("3.0.5")
+                .quarkusVersion("3.0.5")
+                .addCoreMember()
+                .addExtension("quarkus-rest")
+                .addExtension("quarkus-magic")
+                .registry()
+                .clientBuilder()
+                .build();
+
+        enableRegistryClient();
+    }
+
+    protected String getMainPlatformKey() {
+        return OTHER_PLATFORM_KEY;
+    }
+
+    @Test
+    public void testLatestRecommendedQuarkusCore() throws Exception {
+        final Path projectDir = newProjectDir("latest-other-platform");
+        createProject(projectDir, List.of("quarkus-rest"));
+
+        assertModel(projectDir,
+                List.of(mainPlatformBom()),
+                List.of(ArtifactCoords.jar(OTHER_PLATFORM_KEY, "quarkus-rest", null)),
+                "4.0.0");
+    }
+
+    @Test
+    public void testLatestRecommendedAcmeRabbit() throws Exception {
+        final Path projectDir = newProjectDir("latest-acme-platform");
+        createProject(projectDir, List.of("rabbit"));
+
+        assertModel(projectDir,
+                List.of(mainPlatformBom(), ArtifactCoords.pom(ACME_PLATFORM_KEY, "acme-zoo-bom", "5.0.5")),
+                List.of(ArtifactCoords.jar("org.acme", "acme-rabbit", null)),
+                "3.0.5");
+    }
+
+    @Test
+    public void testLatestRecommendedQuarkusCoreAndAcmeRabbitCombination() throws Exception {
+        final Path projectDir = newProjectDir("latest-acme-platform");
+        createProject(projectDir, List.of("rabbit", "quarkus-rest", "quarkus-magic"));
+
+        assertModel(projectDir,
+                List.of(mainPlatformBom(), ArtifactCoords.pom(ACME_PLATFORM_KEY, "acme-zoo-bom", "5.0.5")),
+                List.of(ArtifactCoords.jar("org.acme", "acme-rabbit", null),
+                        ArtifactCoords.jar(OTHER_PLATFORM_KEY, "quarkus-rest", null),
+                        ArtifactCoords.jar(OTHER_PLATFORM_KEY, "quarkus-magic", null)),
+                "3.0.5");
+    }
+}

independent-projects/tools/registry-client/src/main/java/io/quarkus/registry/ExtensionCatalogResolver.java

@@ -404,26 +404,10 @@ private void collectPlatformExtensions(final ExtensionCatalogBuilder catalogBuil
             throws RegistryResolutionException {
         final RegistryExtensionResolver registry = registries.get(registryIndex);
 
-        final List<PlatformCatalog> downstreamPreferences = new ArrayList<>(catalogBuilder.upstreamQuarkusVersions.size());
-        for (String quarkusVersion : catalogBuilder.upstreamQuarkusVersions) {
-            if (!registry.isAcceptsQuarkusVersionQueries(quarkusVersion)) {
-                continue;
-            }
-            final PlatformCatalog pc = registry.resolvePlatformCatalog(quarkusVersion);
-            if (pc == null) {
-                continue;
-            }
-            downstreamPreferences.add(pc);
-        }
-
-        PlatformCatalog pc = registry.resolvePlatformCatalog();
-        if (pc == null && downstreamPreferences.isEmpty()) {
+        final PlatformCatalog pc = resolvePlatformCatalog(registry, catalogBuilder.upstreamQuarkusVersions);
+        if (pc == null) {
             return;
         }
-        if (!downstreamPreferences.isEmpty()) {
-            downstreamPreferences.add(pc);
-            pc = CatalogMergeUtility.mergePlatformCatalogs(downstreamPreferences);
-        }
 
         int platformIndex = 0;
         for (Platform platform : pc.getPlatforms()) {
@@ -446,7 +430,7 @@ private void collectPlatformExtensions(final ExtensionCatalogBuilder catalogBuil
                     int memberIndex = 0;
                     for (ArtifactCoords bom : release.getMemberBoms()) {
                         memberIndex++;
-                        final ExtensionCatalog.Mutable ec = (ExtensionCatalog.Mutable) registry.resolvePlatformExtensions(bom);
+                        final ExtensionCatalog.Mutable ec = registry.resolvePlatformExtensions(bom);
                         if (ec != null) {
                             final OriginPreference originPreference = new OriginPreference(registryIndex, platformIndex,
                                     releaseIndex, memberIndex, compatiblityCode);
@@ -461,9 +445,53 @@ private void collectPlatformExtensions(final ExtensionCatalogBuilder catalogBuil
         }
     }
 
-    private void addOriginPreference(final ExtensionCatalog.Mutable ec, OriginPreference originPreference) {
-        Map<String, Object> metadata = ec.getMetadata();
-        metadata.put("origin-preference", originPreference);
+    /**
+     * Resolves a platform catalog from a given registry. The method may return null in case the registry does not
+     * provide platforms.
+     *
+     * <p>
+     * It starts by resolving the default platform catalog. If a list of Quarkus core versions is provided,
+     * it will also resolve platform catalogs for each Quarkus core version (if the registry recognizes
+     * those Quarkus core versions), merge all the resolved platform catalogs into a single one and return the result.
+     *
+     * @param registry the registry to resolve the catalogs from
+     * @param quarkusVersions optional extra Quarkus core versions
+     * @return platform catalog or null if the registry does not provide any platforms
+     * @throws RegistryResolutionException in case a registry querying failed or some other error happened
+     */
+    private static PlatformCatalog resolvePlatformCatalog(RegistryExtensionResolver registry, List<String> quarkusVersions)
+            throws RegistryResolutionException {
+        // default registry recommendations
+        PlatformCatalog defaultCatalog = registry.resolvePlatformCatalog();
+        if (quarkusVersions.isEmpty()) {
+            return defaultCatalog;
+        }
+
+        List<PlatformCatalog> catalogsToMerge = List.of();
+        for (int i = 0; i < quarkusVersions.size(); ++i) {
+            var quarkusVersion = quarkusVersions.get(i);
+            if (registry.isAcceptsQuarkusVersionQueries(quarkusVersion)) {
+                final PlatformCatalog pcForQuarkusVersion = registry.resolvePlatformCatalog(quarkusVersion);
+                if (pcForQuarkusVersion != null) {
+                    if (catalogsToMerge.isEmpty()) {
+                        catalogsToMerge = new ArrayList<>(quarkusVersions.size() - i + 1);
+                        if (defaultCatalog != null) {
+                            catalogsToMerge.add(defaultCatalog);
+                        }
+                    }
+                    catalogsToMerge.add(pcForQuarkusVersion);
+                }
+            }
+        }
+
+        if (catalogsToMerge.isEmpty()) {
+            return defaultCatalog;
+        }
+        return CatalogMergeUtility.mergePlatformCatalogs(catalogsToMerge);
+    }
+
+    private static void addOriginPreference(final ExtensionCatalog.Mutable ec, OriginPreference originPreference) {
+        ec.getMetadata().put("origin-preference", originPreference);
     }
 
     public ExtensionCatalog resolveExtensionCatalog(String quarkusCoreVersion) throws RegistryResolutionException {
@@ -740,15 +768,15 @@ private void ensureRegistriesConfigured() throws RegistryResolutionException {
         }
     }
 
-    private void appendNonPlatformExtensions(
+    private static void appendNonPlatformExtensions(
             ExtensionCatalogBuilder catalogBuilder,
             String quarkusVersion) throws RegistryResolutionException {
         for (RegistryExtensionResolver registry : catalogBuilder.getRegistriesForQuarkusCore(quarkusVersion)) {
             appendNonPlatformExtensions(registry, catalogBuilder, quarkusVersion);
         }
     }
 
-    private void appendNonPlatformExtensions(RegistryExtensionResolver registry, ExtensionCatalogBuilder catalogBuilder,
+    private static void appendNonPlatformExtensions(RegistryExtensionResolver registry, ExtensionCatalogBuilder catalogBuilder,
             String quarkusVersion) throws RegistryResolutionException {
         final ExtensionCatalog.Mutable nonPlatformCatalog = registry.resolveNonPlatformExtensions(quarkusVersion);
         if (nonPlatformCatalog == null) {
@@ -777,7 +805,7 @@ private int getRegistryIndex(String registryId) {
         throw new IllegalStateException(buf.toString());
     }
 
-    private void collectPlatformExtensions(String quarkusCoreVersion, ExtensionCatalogBuilder catalogBuilder,
+    private static void collectPlatformExtensions(String quarkusCoreVersion, ExtensionCatalogBuilder catalogBuilder,
             Set<String> processedPlatformKeys)
             throws RegistryResolutionException {
         final List<RegistryExtensionResolver> quarkusVersionRegistries = catalogBuilder
@@ -803,7 +831,7 @@ private void collectPlatformExtensions(String quarkusCoreVersion, ExtensionCatal
         }
     }
 
-    private void collectPlatformExtensions(ExtensionCatalogBuilder catalogBuilder,
+    private static void collectPlatformExtensions(ExtensionCatalogBuilder catalogBuilder,
             RegistryExtensionResolver registry, int platformIndex,
             Platform p) throws RegistryResolutionException {