Register ES client

Author: kmcclellan

Elasticstretch.DependencyInjection/Elasticstretch.DependencyInjection.csproj

@@ -24,6 +24,9 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Elastic.Clients.Elasticsearch" Version="*" />
+    <PackageReference Include="Microsoft.Extensions.Options" Version="*" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="*" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="*" PrivateAssets="All" />
   </ItemGroup>
 

Elasticstretch.DependencyInjection/ElasticstretchServiceCollectionExtensions.cs

@@ -0,0 +1,56 @@
+namespace Elastic.Clients.Elasticsearch;
+
+using Elastic.Clients.Elasticsearch.Options;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+
+/// <summary>
+/// Extensions of <see cref="IServiceCollection"/> for the Elasticsearch client.
+/// </summary>
+public static class ElasticstretchServiceCollectionExtensions
+{
+    /// <summary>
+    /// Adds a singleton <see cref="ElasticsearchClient"/> to the services.
+    /// </summary>
+    /// <remarks>
+    /// <see cref="ElasticsearchNodeOptions"/> is also bound to the <c>Elasticsearch</c> configuration section.
+    /// </remarks>
+    /// <param name="services">The service collection.</param>
+    /// <param name="configureNodes">A delegate to configure Elasticsearch nodes.</param>
+    /// <param name="configureSettings">A delegate to configure additional client settings.</param>
+    /// <returns>The same services, for chaining.</returns>
+    public static IServiceCollection AddElasticsearchClient(
+        this IServiceCollection services,
+        Action<ElasticsearchNodeOptions>? configureNodes = null,
+        Action<ElasticsearchClientSettings>? configureSettings = null)
+    {
+        services.AddOptions();
+
+        TryConfigure<ElasticsearchNodeOptions, ConfigureNodesFromConfig>(services);
+        TryConfigure<ElasticsearchClientOptions, ConfigureClientFromNodes>(services);
+
+        services.TryAddSingleton(
+            x => new ElasticsearchClient(
+                x.GetRequiredService<IOptions<ElasticsearchClientOptions>>().Value.ToSettings()));
+
+        if (configureNodes != null)
+        {
+            services.Configure(configureNodes);
+        }
+
+        if (configureSettings != null)
+        {
+            services.Configure<ElasticsearchClientOptions>(x => x.ConfigureSettings += configureSettings);
+        }
+
+        return services;
+    }
+
+    static void TryConfigure<TOptions, TSetup>(IServiceCollection services)
+        where TOptions : class
+        where TSetup : class, IConfigureOptions<TOptions>
+    {
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<IConfigureOptions<TOptions>, TSetup>());
+    }
+}

Elasticstretch.DependencyInjection/GlobalSuppressions.cs

@@ -0,0 +1,13 @@
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage(
+    "Performance",
+    "CA1812:Avoid uninstantiated internal classes",
+    Scope = "type",
+    Target = "~T:Elastic.Clients.Elasticsearch.Options.ConfigureNodesFromConfig")]
+
+[assembly: SuppressMessage(
+    "Performance",
+    "CA1812:Avoid uninstantiated internal classes",
+    Scope = "type",
+    Target = "~T:Elastic.Clients.Elasticsearch.Options.ConfigureClientFromNodes")]

Elasticstretch.DependencyInjection/Options/ConfigureClientFromNodes.cs

@@ -0,0 +1,63 @@
+namespace Elastic.Clients.Elasticsearch.Options;
+
+using Elastic.Transport;
+using Microsoft.Extensions.Options;
+
+sealed class ConfigureClientFromNodes : IConfigureNamedOptions<ElasticsearchClientOptions>
+{
+    private readonly IOptionsFactory<ElasticsearchNodeOptions> nodeOptionsFactory;
+
+    public ConfigureClientFromNodes(IOptionsFactory<ElasticsearchNodeOptions> nodeOptionsFactory)
+    {
+        this.nodeOptionsFactory = nodeOptionsFactory;
+    }
+
+    public void Configure(string? name, ElasticsearchClientOptions options)
+    {
+        var nodeOptions = nodeOptionsFactory.Create(name ?? Options.DefaultName);
+
+        AuthorizationHeader? credentials = nodeOptions switch
+        {
+            { ApiKeyId: not null, ApiKey: not null } => new Base64ApiKey(nodeOptions.ApiKeyId, nodeOptions.ApiKey),
+            { ApiKey: not null } => new ApiKey(nodeOptions.ApiKey),
+            _ => null,
+        };
+
+        options.NodePool = nodeOptions switch
+        {
+            { CloudId: not null } => new CloudNodePool(nodeOptions.CloudId, credentials ?? NoAuthorization.Instance),
+            { NodeUris.Count : 0 } => options.NodePool,
+            { IsSticky : true, UseSniffing : true } => new StickySniffingNodePool(nodeOptions.NodeUris, x => 0),
+            { IsSticky : true } => new StickyNodePool(nodeOptions.NodeUris),
+            { UseSniffing : true } => new SniffingNodePool(nodeOptions.NodeUris),
+            _ => new StaticNodePool(nodeOptions.NodeUris),
+        };
+
+        if (credentials != null)
+        {
+            options.ConfigureSettings += x => x.Authentication(credentials);
+        }
+    }
+
+    public void Configure(ElasticsearchClientOptions options)
+    {
+        throw new NotSupportedException();
+    }
+
+    sealed class NoAuthorization : AuthorizationHeader
+    {
+        public static NoAuthorization Instance { get; } = new NoAuthorization();
+
+        public override string AuthScheme => throw new NotSupportedException();
+
+        private NoAuthorization()
+        {
+        }
+
+        public override bool TryGetAuthorizationParameters(out string value)
+        {
+            value = string.Empty;
+            return false;
+        }
+    }
+}

Elasticstretch.DependencyInjection/Options/ConfigureNodesFromConfig.cs

@@ -0,0 +1,12 @@
+namespace Elastic.Clients.Elasticsearch.Options;
+
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+
+sealed class ConfigureNodesFromConfig : ConfigureFromConfigurationOptions<ElasticsearchNodeOptions>
+{
+    public ConfigureNodesFromConfig(IConfiguration config)
+        : base(config.GetSection("Elasticsearch"))
+    {
+    }
+}

Elasticstretch.DependencyInjection/Options/ElasticsearchClientOptions.cs

@@ -0,0 +1,55 @@
+namespace Elastic.Clients.Elasticsearch.Options;
+
+using Elastic.Transport;
+using System.Diagnostics.CodeAnalysis;
+
+/// <summary>
+/// A model to configure Elasticsearch clients using the .NET options pattern.
+/// </summary>
+public class ElasticsearchClientOptions
+{
+    /// <summary>
+    /// Gets or sets the client node pool, or <see langword="null"/> to connect locally.
+    /// </summary>
+    public NodePool? NodePool { get; set; }
+
+    /// <summary>
+    /// Gets or sets the underlying transport connection, or <see langword="null"/> to use HTTP.
+    /// </summary>
+    public TransportClient? Connection { get; set; }
+
+    /// <summary>
+    /// Gets or sets a custom factory for the client source serializer, if any.
+    /// </summary>
+    public ElasticsearchClientSettings.SourceSerializerFactory? SourceSerializer { get; set; }
+
+    /// <summary>
+    /// Gets or sets a custom mapper for property serialization, if any.
+    /// </summary>
+    public IPropertyMappingProvider? PropertyMappingProvider { get; set; }
+
+    /// <summary>
+    /// Gets or sets the delegate to configure additional client settings.
+    /// </summary>
+    public Action<ElasticsearchClientSettings>? ConfigureSettings { get; set; }
+
+    /// <summary>
+    /// Converts the options to Elastic client settings.
+    /// </summary>
+    /// <returns>The client settings.</returns>
+    [SuppressMessage(
+        "Reliability",
+        "CA2000:Dispose objects before losing scope",
+        Justification = "Dispose ownership transferred to settings.")]
+    public IElasticsearchClientSettings ToSettings()
+    {
+        var settings = new ElasticsearchClientSettings(
+            NodePool ?? new SingleNodePool(new("localhost:9200")),
+            Connection ?? new HttpTransportClient(),
+            SourceSerializer ?? new((x, y) => x),
+            PropertyMappingProvider ?? new DefaultPropertyMappingProvider());
+
+        ConfigureSettings?.Invoke(settings);
+        return settings;
+    }
+}

Elasticstretch.DependencyInjection/Options/ElasticsearchNodeOptions.cs

@@ -0,0 +1,45 @@
+namespace Elastic.Clients.Elasticsearch.Options;
+
+using Elastic.Transport;
+
+/// <summary>
+/// Options for connecting to Elasticsearch nodes.
+/// </summary>
+public class ElasticsearchNodeOptions
+{
+    /// <summary>
+    /// Gets or sets the ID for Elastic's cloud-hosted search service.
+    /// </summary>
+    /// <remarks>
+    /// Incompatible with <see cref="NodeUris"/>.
+    /// </remarks>
+    public string? CloudId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the list of self-hosted Elasticsearch node URIs. 
+    /// </summary>
+    /// <remarks>
+    /// Incompatible with <see cref="CloudId"/>.
+    /// </remarks>
+    public ICollection<Uri> NodeUris { get; } = new List<Uri>();
+
+    /// <summary>
+    /// Gets or sets whether "sticky" node selection is used (e.g. <see cref="StickyNodePool"/>).
+    /// </summary>
+    public bool IsSticky { get; set; }
+
+    /// <summary>
+    /// Gets or sets whether "sniffing" is used to reseed nodes (e.g. <see cref="SniffingNodePool"/>).
+    /// </summary>
+    public bool UseSniffing { get; set; }
+
+    /// <summary>
+    /// Gets or sets the ID of the API key for node authentication, if any.
+    /// </summary>
+    public string? ApiKeyId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the API key for node authentication, if any.
+    /// </summary>
+    public string? ApiKey { get; set; }
+}