Add AspireCouchbaseClientBuilder for client registration extensibility

Author: brantburnett

src/Couchbase.Aspire.Client/AspireCouchbaseClientBuilder.cs

@@ -0,0 +1,31 @@
+using Couchbase.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+
+namespace Couchbase.Aspire.Client;
+
+/// <summary>
+/// Provides a builder for configuring Couchbase client services in an Aspire application.
+/// </summary>
+/// <param name="hostBuilder">The <see cref="IHostApplicationBuilder"/> with which services are being registered.</param>
+/// <param name="settings">The <see cref="CouchbaseClientSettings"/> to configure the Couchbase client.</param>
+/// <param name="serviceKey">The service key used to register the <see cref="IClusterProvider"/> service, if any.</param>
+public sealed class AspireCouchbaseClientBuilder(
+    IHostApplicationBuilder hostBuilder,
+    CouchbaseClientSettings settings,
+    string? serviceKey)
+{
+    /// <summary>
+    /// Gets the <see cref="IHostApplicationBuilder"/> with which services are being registered.
+    /// </summary>
+    public IHostApplicationBuilder HostBuilder { get; } = hostBuilder ?? throw new ArgumentNullException(nameof(hostBuilder));
+
+    /// <summary>
+    /// Gets the <see cref="CouchbaseClientSettings"/> used to configure the Couchbase client.
+    /// </summary>
+    public CouchbaseClientSettings Settings { get; } = settings;
+
+    /// <summary>
+    /// Gets the service key used to register the <see cref="IClusterProvider"/> service, if any.
+    /// </summary>
+    public string? ServiceKey { get; } = serviceKey;
+}

src/Couchbase.Aspire.Client/AspireCouchbaseExtensions.cs

@@ -29,6 +29,22 @@ public static class AspireCouchbaseExtensions
     /// <param name="configureClusterOptions">An optional method that can be used for customizing the <see cref="ClusterOptions"/>. It's invoked after the options are read from the configuration.</param>
     /// <remarks>Reads the configuration from "Aspire:Couchbase:Client" section.</remarks>
     public static void AddCouchbaseClient(
+        this IHostApplicationBuilder builder,
+        string connectionName,
+        Action<CouchbaseClientSettings>? configureSettings = null,
+        Action<ClusterOptions>? configureClusterOptions = null)
+        => AddCouchbaseClientBuilder(builder, connectionName, configureSettings, configureClusterOptions);
+
+    /// <summary>
+    /// Registers <see cref="IClusterProvider"/> as a singleton in the services provided by the <paramref name="builder"/>.
+    /// Enables retries, corresponding health check, logging, and telemetry.
+    /// </summary>
+    /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
+    /// <param name="connectionName">A name used to retrieve the connection string from the ConnectionStrings configuration section.</param>
+    /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="CouchbaseClientSettings"/>. It's invoked after the settings are read from the configuration.</param>
+    /// <param name="configureClusterOptions">An optional method that can be used for customizing the <see cref="ClusterOptions"/>. It's invoked after the options are read from the configuration.</param>
+    /// <remarks>Reads the configuration from "Aspire:Couchbase:Client" section.</remarks>
+    public static AspireCouchbaseClientBuilder AddCouchbaseClientBuilder(
         this IHostApplicationBuilder builder,
         string connectionName,
         Action<CouchbaseClientSettings>? configureSettings = null,
@@ -49,13 +65,30 @@ public static void AddKeyedCouchbaseClient(
         string name,
         Action<CouchbaseClientSettings>? configureSettings = null,
         Action<ClusterOptions>? configureClusterOptions = null)
+        => AddKeyedCouchbaseClientBuilder(builder, name, configureSettings, configureClusterOptions);
+
+
+    /// <summary>
+    /// Registers <see cref="IClusterProvider"/> as a keyed singleton for the given <paramref name="name"/> in the services provided by the <paramref name="builder"/>.
+    /// Enables retries, corresponding health check, logging, and telemetry.
+    /// </summary>
+    /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
+    /// <param name="name">The name of the component, which is used as the <see cref="ServiceDescriptor.ServiceKey"/> of the service and also to retrieve the connection string from the ConnectionStrings configuration section.</param>
+    /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="CouchbaseClientSettings"/>. It's invoked after the settings are read from the configuration.</param>
+    /// <param name="configureClusterOptions">An optional method that can be used for customizing the <see cref="ClusterOptions"/>. It's invoked after the options are read from the configuration.</param>
+    /// <remarks>Reads the configuration from "Aspire:Couchbase:Client:{name}" section.</remarks>
+    public static AspireCouchbaseClientBuilder AddKeyedCouchbaseClientBuilder(
+        this IHostApplicationBuilder builder,
+        string name,
+        Action<CouchbaseClientSettings>? configureSettings = null,
+        Action<ClusterOptions>? configureClusterOptions = null)
     {
         ArgumentException.ThrowIfNullOrEmpty(name);
 
-        AddCouchbaseClient(builder, configureSettings, configureClusterOptions, connectionName: name, serviceKey: name);
+        return AddCouchbaseClient(builder, configureSettings, configureClusterOptions, connectionName: name, serviceKey: name);
     }
 
-    private static void AddCouchbaseClient(
+    private static AspireCouchbaseClientBuilder AddCouchbaseClient(
         IHostApplicationBuilder builder,
         Action<CouchbaseClientSettings>? configureSettings,
         Action<ClusterOptions>? configureClusterOptions,
@@ -210,6 +243,8 @@ ValueTask<ICluster> ClusterFactory(CancellationToken ct)
                 failureStatus: default,
                 tags: default));
         }
+
+        return new AspireCouchbaseClientBuilder(builder, settings, serviceKey);
     }
 
     private static void ApplyNodeRequirement(