Merge pull request quarkusio#52151 from nconcetti/mongodb-panache-fix-for-multiple-client-beans

Support multiple named mongoclients while using panache

Author: gsmet

extensions/panache/mongodb-panache-common/runtime/src/main/java/io/quarkus/mongodb/panache/common/runtime/BeanUtils.java

@@ -12,6 +12,7 @@
 import io.quarkus.arc.InjectableBean;
 import io.quarkus.arc.InjectableInstance;
 import io.quarkus.arc.InstanceHandle;
+import io.quarkus.mongodb.MongoClientName;
 import io.quarkus.mongodb.panache.common.MongoDatabaseResolver;
 import io.quarkus.mongodb.panache.common.MongoEntity;
 import io.quarkus.mongodb.runtime.MongoClientBeanUtil;
@@ -34,26 +35,19 @@ public static String beanName(MongoEntity entity) {
 
     public static <T> T clientFromArc(MongoEntity entity,
             Class<T> clientClass, boolean isReactive) {
-        T mongoClient = Arc.container()
-                .instance(clientClass, MongoClientBeanUtil.clientLiteral(beanName(entity), isReactive))
-                .get();
+        // we must consider multiple instances if @MongoClientName is used in client code
+        T mongoClient = firstInstanceWithoutQualifier(
+                Arc.container().select(clientClass, MongoClientBeanUtil.clientLiteral(beanName(entity), isReactive)).handles(),
+                MongoClientName.class);
         if (mongoClient != null) {
             return mongoClient;
         }
 
         if ((entity == null || entity.clientName().isEmpty())) {
             // this case happens when there are multiple instances because they are all annotated with @Named
-            for (InstanceHandle<T> handle : Arc.container().select(clientClass).handles()) {
-                InjectableBean<T> bean = handle.getBean();
-                boolean hasNamed = false;
-                for (Annotation qualifier : bean.getQualifiers()) {
-                    if (qualifier.annotationType().equals(Named.class)) {
-                        hasNamed = true;
-                    }
-                }
-                if (!hasNamed) {
-                    return handle.get();
-                }
+            mongoClient = firstInstanceWithoutQualifier(Arc.container().select(clientClass).handles(), Named.class);
+            if (mongoClient != null) {
+                return mongoClient;
             }
             throw new IllegalStateException(String.format("Unable to find default %s bean", clientClass.getSimpleName()));
         } else {
@@ -94,4 +88,21 @@ public static Optional<String> getDatabaseNameFromResolver() {
                 .map(MongoDatabaseResolver::resolve)
                 .filter(Predicate.not(String::isBlank));
     }
+
+    private static <T> T firstInstanceWithoutQualifier(Iterable<InstanceHandle<T>> handles,
+            Class<? extends Annotation> qualifier) {
+        for (InstanceHandle<T> handle : handles) {
+            InjectableBean<T> bean = handle.getBean();
+            boolean match = false;
+            for (Annotation q : bean.getQualifiers()) {
+                if (q.annotationType().equals(qualifier)) {
+                    match = true;
+                }
+            }
+            if (!match) {
+                return handle.get();
+            }
+        }
+        return null;
+    }
 }

extensions/panache/mongodb-panache/deployment/src/test/java/io/quarkus/mongodb/panache/MultipleMongoClientsTest.java

@@ -0,0 +1,89 @@
+package io.quarkus.mongodb.panache;
+
+import static org.junit.jupiter.api.Assertions.assertAll;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import com.mongodb.client.MongoClient;
+
+import io.quarkus.mongodb.MongoClientName;
+import io.quarkus.mongodb.panache.common.MongoEntity;
+import io.quarkus.mongodb.reactive.ReactiveMongoClient;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class MultipleMongoClientsTest {
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .overrideConfigKey("quarkus.mongodb.devservices.enabled", "false")
+            .withApplicationRoot((jar) -> jar
+                    .addAsResource("named-clients.properties"));
+
+    @Inject
+    WithDefaultMongoClientEntityRepository withDefaultMongoClientEntityRepository;
+
+    @Inject
+    WithMongoClient1EntityRepository withMongoClient1EntityRepository;
+
+    @Inject
+    WithMongoClient2EntityRepository withMongoClient2EntityRepository;
+
+    @Inject
+    @MongoClientName("mongoclient1")
+    MongoClient mongoClient1;
+
+    @Inject
+    @MongoClientName("mongoclient1")
+    ReactiveMongoClient reactiveMongoClient1;
+
+    @Inject
+    @MongoClientName("mongoclient2")
+    MongoClient mongoClient2;
+
+    @Inject
+    @MongoClientName("mongoclient2")
+    ReactiveMongoClient reactiveMongoClient2;
+
+    @Test
+    public void testMongoEntity() {
+        assertAll(
+                () -> assertEquals("default-mongoclient-db", withDefaultMongoClientEntityRepository.mongoDatabase().getName()),
+                () -> assertEquals("mongoclient1-db", withMongoClient1EntityRepository.mongoDatabase().getName()),
+                () -> assertEquals("mongoclient2-db", withMongoClient2EntityRepository.mongoDatabase().getName()),
+                () -> assertNotNull(reactiveMongoClient1),
+                () -> assertNotNull(reactiveMongoClient2));
+    }
+
+    @MongoEntity(database = "default-mongoclient-db")
+    public static class WithDefaultMongoClientEntity extends PanacheMongoEntity {
+        public String field;
+    }
+
+    @MongoEntity(database = "mongoclient1-db", clientName = "mongoclient1")
+    public static class WithMongoClient1Entity extends PanacheMongoEntity {
+        public String field;
+    }
+
+    @MongoEntity(database = "mongoclient2-db", clientName = "mongoclient2")
+    public static class WithMongoClient2Entity extends PanacheMongoEntity {
+        public String field;
+    }
+
+    @ApplicationScoped
+    public static class WithDefaultMongoClientEntityRepository implements PanacheMongoRepository<WithDefaultMongoClientEntity> {
+    }
+
+    @ApplicationScoped
+    public static class WithMongoClient1EntityRepository implements PanacheMongoRepository<WithMongoClient1Entity> {
+    }
+
+    @ApplicationScoped
+    public static class WithMongoClient2EntityRepository implements PanacheMongoRepository<WithMongoClient2Entity> {
+    }
+
+}

extensions/panache/mongodb-panache/deployment/src/test/resources/named-clients.properties

@@ -0,0 +1,8 @@
+quarkus.mongodb.devservices.enabled=false
+
+quarkus.mongodb.connection-string=mongodb://localhost:27018
+quarkus.mongodb.database=default-mongoclient-db
+quarkus.mongodb.mongoclient1.connection-string=mongodb://localhost:27018
+quarkus.mongodb.mongoclient1.database=mongoclient1-db
+quarkus.mongodb.mongoclient2.connection-string=mongodb://localhost:27018
+quarkus.mongodb.mongoclient2.database=mongoclient2-db