Add a "marker" config property to force the discovery of named clients

Author: marko-bekhta

docs/src/main/asciidoc/dev-services.adoc

@@ -174,7 +174,7 @@ The Elasticsearch Dev Service will be enabled when one of the Elasticsearch base
 is present in your application, and the server address has not been explicitly configured.
 More information can be found in the xref:elasticsearch-dev-services.adoc[Elasticsearch Dev Services Guide].
 
-include::{generated-dir}/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.devservices.adoc[opts=optional, leveloffset=+1]
+include::{generated-dir}/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc[opts=optional, leveloffset=+1]
 
 === Observability
 

docs/src/main/asciidoc/elasticsearch-dev-services.adoc

@@ -139,13 +139,13 @@ In that case, you will need to stop and remove these containers manually.
 If you want to reuse containers for some Quarkus applications but not all of them,
 or some Dev Services but not all of them,
 you can disable this feature for a specific Dev Service by setting the configuration property
-xref:elasticsearch-dev-services.adoc#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-devservices_quarkus-elasticsearch-devservices-reuse[`quarkus.elasticsearch.devservices.reuse`]
+xref:elasticsearch-dev-services.adoc#quarkus-elasticsearch-rest-client_quarkus-elasticsearch-devservices-reuse[`quarkus.elasticsearch.devservices.reuse`]
 to `false`.
 
 == Multiple Elasticsearch service instances
 
 Dev services for Elasticsearch can start multiple instances as necessary.
-Currently this is only compatible with the `quarkus-elasticsearch-rest-client` extension.
+Currently, this is only compatible with the `quarkus-elasticsearch-rest-client` extension.
 A separate Dev Service will be started for each named Elasticsearch REST client.
 
 == Current limitations
@@ -154,4 +154,4 @@ Currently, only the default backend for Hibernate Search Elasticsearch is suppor
 
 == Configuration reference
 
-include::{generated-dir}/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.devservices.adoc[opts=optional, leveloffset=+1]
+include::{generated-dir}/config/quarkus-elasticsearch-rest-client_quarkus.elasticsearch.adoc[opts=optional, leveloffset=+1]

docs/src/main/asciidoc/elasticsearch.adoc

@@ -640,6 +640,16 @@ public class FruitService {
 ----
 <1> We specify the name of the client through the `@Identifier` when injecting a `ElasticsearchClient` within the service.
 
+[NOTE]
+====
+While Quarkus will attempt to find all the named clients at the build time and prepare the required resources for them,
+in some cases, e.g. when the client is only accessed programmatically, it might not be possible to discover all of them.
+To ensure that all clients are correctly processed, you can use the `quarkus.elasticsearch.[client name].force-discovery`
+configuration property for each required client name.
+
+Those clients defined at the build time that won't be necessary at runtime can be <<client-active,deactivated>>.
+====
+
 == Hibernate Search Elasticsearch
 
 Quarkus supports Hibernate Search with Elasticsearch via the `quarkus-hibernate-search-orm-elasticsearch`

extensions/elasticsearch-java-client/deployment/src/test/java/io/quarkus/elasticsearch/javaclient/deployment/ActiveInactiveClientProgrammaticAccessOnlyTest.java

@@ -0,0 +1,35 @@
+package io.quarkus.elasticsearch.javaclient.deployment;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.elasticsearch.client.RestClient;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import co.elastic.clients.elasticsearch.ElasticsearchClient;
+import io.quarkus.arc.Arc;
+import io.quarkus.test.QuarkusUnitTest;
+import io.smallrye.common.annotation.Identifier;
+
+public class ActiveInactiveClientProgrammaticAccessOnlyTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest test = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addAsResource("active-inactive-programmatic.properties", "application.properties"));
+
+    @Test
+    void smoke() {
+        assertTrue(Arc.container().select(RestClient.class).getHandle().getBean().isActive());
+        assertFalse(
+                Arc.container().select(RestClient.class, Identifier.Literal.of("client2")).getHandle().getBean().isActive());
+        assertTrue(Arc.container().select(RestClient.class, Identifier.Literal.of("client3")).getHandle().getBean().isActive());
+
+        assertTrue(Arc.container().select(ElasticsearchClient.class).getHandle().getBean().isActive());
+        assertFalse(Arc.container().select(ElasticsearchClient.class, Identifier.Literal.of("client2")).getHandle().getBean()
+                .isActive());
+        assertFalse(Arc.container().select(ElasticsearchClient.class, Identifier.Literal.of("client3")).getHandle().getBean()
+                .isActive());
+    }
+}

extensions/elasticsearch-java-client/deployment/src/test/resources/active-inactive-programmatic.properties

@@ -0,0 +1,14 @@
+quarkus.elasticsearch.devservices.enabled=false
+
+quarkus.elasticsearch.active=true
+# We shouldn't need the "discovery flag" for the default client,
+#  since it is supposed to be always "discovered":
+# quarkus.elasticsearch.force-discovery=true
+quarkus.elasticsearch."client2".active=false
+quarkus.elasticsearch."client2".force-discovery=true
+quarkus.elasticsearch."client3".active=true
+quarkus.elasticsearch."client3".force-discovery=true
+
+quarkus.elasticsearch-java.active=true
+quarkus.elasticsearch-java."client2".active=false
+quarkus.elasticsearch-java."client3".active=false

extensions/elasticsearch-rest-client-common/deployment/src/main/java/io/quarkus/elasticsearch/restclient/common/deployment/ElasticsearchClientProcessorUtil.java

@@ -37,8 +37,8 @@ public static Set<String> collectReferencedClientNames(CombinedIndexBuildItem in
             BeanRegistrationPhaseBuildItem registrationPhase,
             Set<DotName> clientTypeNames, Set<DotName> configAnnotationNames) {
         Set<String> referencedNames = new HashSet<>();
-		// Always start with the default:
-		referencedNames.add(ElasticsearchClientBeanUtil.DEFAULT_ELASTICSEARCH_CLIENT_NAME);
+        // Always start with the default:
+        referencedNames.add(ElasticsearchClientBeanUtil.DEFAULT_ELASTICSEARCH_CLIENT_NAME);
         IndexView indexView = indexBuildItem.getIndex();
         for (DotName annotationName : configAnnotationNames) {
             for (AnnotationInstance annotation : indexView.getAnnotations(annotationName)) {

extensions/elasticsearch-rest-client/deployment/src/main/java/io/quarkus/elasticsearch/restclient/lowlevel/deployment/ElasticsearchLowLevelClientBuildTimeConfig.java

@@ -12,4 +12,14 @@ public interface ElasticsearchLowLevelClientBuildTimeConfig {
     @WithName("health.enabled")
     @WithDefault("true")
     boolean healthEnabled();
+
+    /**
+     * This property is to help Quarkus identify any low-level Elasticsearch REST clients
+     * that possibly are not explicitly injected in the application code with their corresponding identifier, e.g.
+     * {@code @Inject @Identifier("client-name") RestClient client;}.
+     * In such cases, this property is required to help Quarkus detect all the necessary clients at build time.
+     * The value of this configuration property is ignored.
+     */
+    @WithDefault("true")
+    boolean forceDiscovery();
 }

extensions/elasticsearch-rest-client/deployment/src/test/java/io/quarkus/elasticsearch/restclient/lowlevel/runtime/ActiveInactiveClientProgrammaticAccessOnlyTest.java

@@ -0,0 +1,28 @@
+package io.quarkus.elasticsearch.restclient.lowlevel.runtime;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.elasticsearch.client.RestClient;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.arc.Arc;
+import io.quarkus.test.QuarkusUnitTest;
+import io.smallrye.common.annotation.Identifier;
+
+public class ActiveInactiveClientProgrammaticAccessOnlyTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest test = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addAsResource("active-inactive-programmatic.properties", "application.properties"));
+
+    @Test
+    void smoke() {
+        assertTrue(Arc.container().select(RestClient.class).getHandle().getBean().isActive());
+        assertFalse(
+                Arc.container().select(RestClient.class, Identifier.Literal.of("client2")).getHandle().getBean().isActive());
+        assertTrue(Arc.container().select(RestClient.class, Identifier.Literal.of("client3")).getHandle().getBean().isActive());
+    }
+}

extensions/elasticsearch-rest-client/deployment/src/test/resources/active-inactive-programmatic.properties

@@ -0,0 +1,8 @@
+quarkus.elasticsearch.active=true
+# We shouldn't need the "discovery flag" for the default client,
+#  since it is supposed to be always "discovered":
+# quarkus.elasticsearch.force-discovery=true
+quarkus.elasticsearch."client2".active=false
+quarkus.elasticsearch."client2".force-discovery=true
+quarkus.elasticsearch."client3".active=true
+quarkus.elasticsearch."client3".force-discovery=true