Ugrade to Quarkus 3.17.5 and Java SDK 3.7.7

README.md

@@ -25,12 +25,15 @@ This extension is currently in beta status.  It supports:
 - Dependency injecting a Couchbase `Cluster`.
 - Configuring the Cluster through `application.properties`.  Currently, a minimal set of configuration options is provided.
 - A dev service that starts a Couchbase server in a Docker container. With this you can develop your Quarkus app without having to install Couchbase on your machine.
+- GraalVM/Mandrel/native-image.
+- KV, Query, Transactions, Analytics, Search and Management operations.
+- Micrometer metrics using `quarkus-micrometer`
+- SmallRye Health checks (Readiness) using `quarkus-smallrye-health`
 
 Please try it out and provide feedback, ideas and bug reports [on Github](https://github.com/quarkiverse/quarkus-couchbase/issues).
 
 ## Native Image
-> [!IMPORTANT]
-> While the extension compiles natively, there are known issues with the produced runner which we are actively working to resolve.
+All main Cluster operations have been tested with our internal testing tools, however the extension remains in beta and some features may be missing or not be fully supported.
 
 ## Usage
 Add it to your project:
@@ -90,9 +93,13 @@ public class TestCouchbaseResource {
 
 And test http://localhost:8080/couchbase/test.
 
+## Additional Configuration
+Please refer to the [docs](https://github.com/quarkiverse/quarkus-couchbase/blob/main/docs/modules/ROOT/pages/configuration.adoc) for additional configuration options.
+
 ## Limitations
-In this a beta release the configuration options are limited to the three shown above.  
+The Cluster configuration options are limited cluster credentials, and micrometer metrics emission rate.  
 This means that a Couchbase cluster configured securely and requiring TLS or a client or server certificate, cannot currently be connected to.
+Additional Cluster connections can be created and configured using `Cluster.connect(...)`, however not all code paths have been tested and are therefore not officially supported.
 
 ## License
 All the files under `nettyhandling` directories, both in the `runtime` and `deployment` modules are

deleteMethod.sh

@@ -3,19 +3,35 @@ count_braces() {
     local file="$2"
 
     perl -ne '
-        BEGIN { $count = 0; $found = 0; $start_line = 0; }
-        if (/\b'"$method"'\s*\(/) { $found = 1; $start_line = $.; }
+        BEGIN { $count = 0; $found = 0; $in_method = 0; $start_line = 0; }
+
+        # Find the method or class name and ignore leading spaces
+        if (!$in_method && /^\s*\b'"$method"'\s*(\(\s*\))?/) {
+            $in_method = 1;
+            $start_line = $.;
+        }
+
+        # Go through each line until we find an opening brace (for multi-line method arguments)
+        if ($in_method) {
+            if (/.*\{/) {
+                $found = 1;
+                $in_method = 0;
+            }
+        }
+
+        # Once inside the body, count braces to support nested ones and print start and end when reaching the last
         if ($found) {
             $count += tr/{/{/;
             $count -= tr/}/}/;
-            if ($count == 0 && $found == 1) {
+            if ($count == 0) {
                 print "START:$start_line | END:$.\n";
                 exit;
             }
         }
     ' "$file"
 }
 
+
 delete_method() {
     local method="$1"
     local file="$2"
@@ -29,11 +45,11 @@ delete_method() {
     end_line=$(echo "$line_info" | cut -d':' -f3)
 
     if [ -n "$start_line" ] && [ -n "$end_line" ]; then
-        start_line=$((start_line - 1))
+        start_line=$((start_line - 1)) # start_line -1 to delete the annotation that comes before
         sed -i '' "${start_line},${end_line}d" "$file"
-        echo "Deleted method '$method' from $file (Lines: $start_line - $end_line)"
+        echo "Deleted method/class '$method' from $file (Lines: $start_line - $end_line)"
     else
-        echo "Method '$method' not found in $file"
+        echo "Method/Class '$method' not found in $file"
     fi
 }
 

deployment/pom.xml

@@ -18,6 +18,10 @@
       <artifactId>quarkus-couchbase</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-smallrye-health-spi</artifactId>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-junit5-internal</artifactId>
@@ -41,6 +45,9 @@
               <version>${quarkus.version}</version>
             </path>
           </annotationProcessorPaths>
+          <compilerArgs>
+            <arg>-AlegacyConfigRoot=true</arg>
+          </compilerArgs>
         </configuration>
       </plugin>
     </plugins>

deployment/src/main/java/com/couchbase/quarkus/extension/deployment/CouchbaseDevService.java

@@ -17,10 +17,13 @@
 
 import java.util.Map;
 
-import org.eclipse.microprofile.config.ConfigProvider;
+import jakarta.inject.Inject;
+
 import org.testcontainers.couchbase.CouchbaseContainer;
 import org.testcontainers.couchbase.CouchbaseService;
 
+import com.couchbase.quarkus.extension.runtime.CouchbaseConfig;
+
 import io.quarkus.deployment.IsNormal;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.BuildSteps;
@@ -37,6 +40,9 @@ public class CouchbaseDevService {
 
     static volatile RunningDevService devService;
 
+    @Inject
+    CouchbaseConfig config;
+
     @BuildStep
     DevServicesResultBuildItem startCouchBase(
             CuratedApplicationShutdownBuildItem closeBuildItem) {
@@ -52,12 +58,8 @@ DevServicesResultBuildItem startCouchBase(
     }
 
     private QuarkusCouchbaseContainer startContainer() {
-        String userName = ConfigProvider.getConfig()
-                .getOptionalValue("quarkus.couchbase.username", String.class).orElse("Administrator");
-        String password = ConfigProvider.getConfig()
-                .getOptionalValue("quarkus.couchbase.password", String.class).orElse("password");
-        String version = ConfigProvider.getConfig().getValue("quarkus.couchbase.version", String.class);
-        QuarkusCouchbaseContainer couchbase = new QuarkusCouchbaseContainer(version, userName, password);
+        QuarkusCouchbaseContainer couchbase = new QuarkusCouchbaseContainer(config.version(), config.username(),
+                config.password());
         couchbase.start();
         return couchbase;
     }

deployment/src/main/java/com/couchbase/quarkus/extension/deployment/CouchbaseDevUiProcessor.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2025 Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.couchbase.quarkus.extension.deployment;
+
+import com.couchbase.client.core.util.ConnectionString;
+import com.couchbase.quarkus.extension.runtime.CouchbaseConfig;
+
+import io.quarkus.deployment.IsDevelopment;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.devui.spi.page.CardPageBuildItem;
+import io.quarkus.devui.spi.page.Page;
+
+public class CouchbaseDevUiProcessor {
+    @BuildStep(onlyIf = IsDevelopment.class)
+    public CardPageBuildItem pages(CouchbaseConfig config) {
+        CardPageBuildItem cardPageBuildItem = new CardPageBuildItem();
+
+        var hostname = extractHostnameFromConnectionString(config.connectionString());
+        var clusterUiUrl = "http://" + hostname + ":8091/ui/index.html";
+
+        String JAVA_SDK_DOCS = "https://docs.couchbase.com/java-sdk/current/hello-world/overview.html";
+
+        cardPageBuildItem.addPage(Page.externalPageBuilder("Cluster Dashboard")
+                .url(clusterUiUrl, clusterUiUrl)
+                .doNotEmbed()
+                .icon("font-awesome-solid:database"));
+
+        cardPageBuildItem.addPage(Page.externalPageBuilder("Java SDK Docs")
+                .url(JAVA_SDK_DOCS, JAVA_SDK_DOCS)
+                .doNotEmbed()
+                .icon("font-awesome-solid:couch"));
+
+        cardPageBuildItem.addPage(Page.externalPageBuilder("Extension Guide")
+                .url("https://docs.quarkiverse.io/quarkus-couchbase/dev/index.html")
+                .isHtmlContent()
+                .icon("font-awesome-solid:book"));
+
+        return cardPageBuildItem;
+    }
+
+    /**
+     * Extracts the first hostname from the connection string to redirect to the Cluster UI Dashboard.
+     *
+     * @param connectionString The connection string specified in application.properties.
+     * @return The first hostname.
+     */
+    private String extractHostnameFromConnectionString(String connectionString) {
+        ConnectionString connStr = ConnectionString.create(connectionString);
+        return connStr.hosts().get(0).host();
+    }
+}

deployment/src/main/java/com/couchbase/quarkus/extension/deployment/CouchbaseProcessor.java

@@ -15,8 +15,12 @@
  */
 package com.couchbase.quarkus.extension.deployment;
 
+import java.util.Optional;
+
 import jakarta.enterprise.context.ApplicationScoped;
 
+import com.couchbase.client.core.api.kv.CoreKvBinaryOps;
+import com.couchbase.client.core.api.kv.CoreKvOps;
 import com.couchbase.client.java.Cluster;
 import com.couchbase.quarkus.extension.runtime.CouchbaseConfig;
 import com.couchbase.quarkus.extension.runtime.CouchbaseRecorder;
@@ -26,21 +30,120 @@
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.ExecutionTime;
 import io.quarkus.deployment.annotations.Record;
+import io.quarkus.deployment.builditem.nativeimage.NativeImageConfigBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.NativeImageProxyDefinitionBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
+import io.quarkus.deployment.metrics.MetricsCapabilityBuildItem;
+import io.quarkus.runtime.metrics.MetricsFactory;
+import io.quarkus.smallrye.health.deployment.spi.HealthBuildItem;
 
 public class CouchbaseProcessor {
 
     @BuildStep
     @Record(ExecutionTime.RUNTIME_INIT)
     public void produceCouchbaseClient(CouchbaseRecorder recorder,
             CouchbaseConfig config,
+            Optional<MetricsCapabilityBuildItem> metricsCapability,
             BuildProducer<SyntheticBeanBuildItem> syntheticBeans) {
+
+        var metricsEnabled = config.metricsEnabled()
+                && metricsCapability.isPresent()
+                && metricsCapability.get().metricsSupported(MetricsFactory.MICROMETER);
+
         syntheticBeans.produce(SyntheticBeanBuildItem
                 .configure(Cluster.class)
                 .scope(ApplicationScoped.class)
                 .unremovable()
-                .supplier(recorder.getCluster(config))
+                .supplier(recorder.getCluster(config, metricsEnabled))
                 .setRuntimeInit()
                 .done());
+    }
+
+    @BuildStep
+    HealthBuildItem addHealthCheck(CouchbaseConfig couchbaseConfig) {
+        return new HealthBuildItem("com.couchbase.quarkus.extension.runtime.health.CouchbaseReadyCheck",
+                couchbaseConfig.healthEnabled());
+    }
+
+    @BuildStep
+    NativeImageProxyDefinitionBuildItem kvProxies() {
+        return new NativeImageProxyDefinitionBuildItem(
+                CoreKvOps.class.getName(),
+                CoreKvBinaryOps.class.getName());
+    }
+
+    @BuildStep
+    NativeImageConfigBuildItem nativeConfiguration() {
+        NativeImageConfigBuildItem.Builder builder = NativeImageConfigBuildItem.builder();
+        // NettyProcessor configures UnpooledByteBufAllocator and other related Netty classes for runtime initialization,
+        // but an instance of it is making its way into the native heap through CoreHttpRequest$Builder.EMPTY_BYTE_BUFF.
+        // Therefore, we defer its initialization until runtime.
+        builder.addRuntimeInitializedClass("com.couchbase.client.core.endpoint.http.CoreHttpRequest$Builder");
+        return builder.build();
+    }
+
+    @BuildStep
+    ReflectiveClassBuildItem reflection() {
+        return ReflectiveClassBuildItem.builder(
+                new String[] {
+                        //Transactions
+                        "com.couchbase.client.core.util.ReactorOps",
+                        //Error
+                        "com.couchbase.client.core.transaction.components.ActiveTransactionRecordEntry",
+                        "com.couchbase.client.core.transaction.components.DocRecord",
+                        //Bucket Manager
+                        "com.couchbase.client.core.manager.bucket.CoreCompressionMode",
+                        "com.couchbase.client.core.manager.bucket.CoreEvictionPolicyType",
+                        "com.couchbase.client.core.manager.bucket.CoreStorageBackend",
+                        "com.couchbase.client.core.manager.bucket.CoreConflictResolutionType",
+                        "com.couchbase.client.core.manager.bucket.BucketSettings",
+                        "com.couchbase.client.java.manager.bucket.BucketSettings",
+                        "com.couchbase.client.core.manager.bucket.CoreBucketSettings",
+                        "com.couchbase.client.core.classic.manager.CoreBucketSettingsJson",
+                        "com.couchbase.client.core.config.BucketType",
+                        "com.couchbase.client.core.msg.kv.DurabilityLevel",
 
+                        "com.couchbase.client.core.config.CollectionsManifestCollection",
+                        "com.couchbase.client.core.config.CollectionsManifestScope",
+                        "com.couchbase.client.core.config.CollectionsManifest",
+                        "com.couchbase.client.core.error.ErrorCodeAndMessage",
+                        "com.couchbase.client.core.msg.BaseResponse",
+                        "com.couchbase.client.core.endpoint.http.CoreHttpResponse",
+                        "com.couchbase.client.core.endpoint.http.CoreCommonOptions",
+                        "com.couchbase.client.core.logging.RedactableArgument",
+                        "com.couchbase.client.core.msg.CancellationReason",
+                        "com.couchbase.client.core.api.manager.search.CoreSearchIndex",
+                        "com.couchbase.client.java.manager.search.SearchIndex",
+                        //Search
+                        //Result
+                        "com.couchbase.client.core.api.search.result.CoreAbstractSearchFacetResult",
+                        "com.couchbase.client.core.api.search.result.CoreDateRangeSearchFacetResult",
+                        "com.couchbase.client.core.api.search.result.CoreNumericRangeSearchFacetResult",
+                        "com.couchbase.client.core.api.search.result.CoreReactiveSearchResult",
+                        "com.couchbase.client.core.api.search.result.CoreSearchDateRange",
+                        "com.couchbase.client.core.api.search.result.CoreSearchFacetResult",
+                        "com.couchbase.client.core.api.search.result.CoreSearchMetrics",
+                        "com.couchbase.client.core.api.search.result.CoreSearchNumericRange",
+                        "com.couchbase.client.core.api.search.result.CoreSearchResult",
+                        "com.couchbase.client.core.api.search.result.CoreSearchRow",
+                        "com.couchbase.client.core.api.search.result.CoreSearchRowLocation",
+                        "com.couchbase.client.core.api.search.result.CoreSearchRowLocations",
+                        "com.couchbase.client.core.api.search.result.CoreSearchStatus",
+                        "com.couchbase.client.core.api.search.result.CoreSearchTermRange",
+                        "com.couchbase.client.core.api.search.result.CoreTermSearchFacetResult",
+                        //Facet
+                        "com.couchbase.client.core.api.search.facet.CoreDateRange",
+                        "com.couchbase.client.core.api.search.facet.CoreDateRangeFacet",
+                        "com.couchbase.client.core.api.search.facet.CoreNumericRange",
+                        "com.couchbase.client.core.api.search.facet.CoreNumericRangeFacet",
+                        "com.couchbase.client.core.api.search.facet.CoreSearchFacet",
+                        "com.couchbase.client.core.api.search.facet.CoreTermFacet",
+                        //Vector
+                        "com.couchbase.client.core.api.search.vector.CoreVector",
+                        "com.couchbase.client.core.api.search.vector.CoreVectorQuery",
+                        "com.couchbase.client.core.api.search.vector.CoreVectorQueryCombination",
+                        "com.couchbase.client.core.api.search.vector.CoreVectorSearch",
+                        "com.couchbase.client.core.api.search.vector.CoreVectorSearchOptions"
+                }).fields().methods().build();
     }
 }