Add Meilisearch integration

Directory.Build.props

@@ -13,9 +13,11 @@
     <AspireVersion>8.2.0</AspireVersion>
     <AspNetCoreVersion>8.0.7</AspNetCoreVersion>
     <OpenTelemetryVersion>1.9.0</OpenTelemetryVersion>
-
+    <TestcontainersVersion>3.10.0</TestcontainersVersion>
     <IsPackable>false</IsPackable>
     <UsePublicApiAnalyzers>true</UsePublicApiAnalyzers>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+
+    <RepoRoot>$(MSBuildThisFileDirectory)</RepoRoot>
 </PropertyGroup>
 </Project>

Directory.Packages.props

@@ -10,6 +10,8 @@
     <PackageVersion Include="JsonSchema.Net" Version="7.2.3" />
     <!-- AspNetCore packages -->
     <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="$(AspNetCoreVersion)" />
+    <PackageVersion Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.2" />
+    <PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.1" />
     <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.6.2" />
     <!-- .NET packages -->
     <PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="8.7.0" />
@@ -33,9 +35,13 @@
     <PackageVersion Include="xunit" Version="2.9.1" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
     <PackageVersion Include="xunit.extensibility.execution" Version="2.9.1" />
+    <PackageVersion Include="Xunit.SkippableFact" Version="1.4.13" />
     <!-- External packages -->
     <PackageVersion Include="OllamaSharp" Version="3.0.7" />
+    <PackageVersion Include="MeiliSearch" Version="0.15.3" />
     <!-- Build dependencies -->
     <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4" />
+    <!-- Testcontainers packages -->
+    <PackageVersion Include="Testcontainers" Version="$(TestcontainersVersion)" />
   </ItemGroup>
 </Project>

src/Aspire.CommunityToolkit.Hosting.Meilisearch/Aspire.CommunityToolkit.Hosting.Meilisearch.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <AdditionalPackageTags>integration hosting meilisearch</AdditionalPackageTags>
+    <Description>Meilisearch support for .NET Aspire.</Description>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="..\VolumeNameGenerator.cs" Link="Utils\VolumeNameGenerator.cs" />
+    <!--<Compile Include="$(ComponentsDir)Aspire.Meilisearch\MeilisearchHealthCheck.cs" Link="MeilisearchHealthCheck.cs"></Compile>-->    
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="MeiliSearch" />
+  </ItemGroup>
+
+</Project>

src/Aspire.CommunityToolkit.Hosting.Meilisearch/MeilisearchBuilderExtensions.cs

@@ -0,0 +1,175 @@
+using System.Data.Common;
+using Aspire.CommunityToolkit.Hosting.Meilisearch;
+using Aspire.Hosting.ApplicationModel;
+using Aspire.Hosting.Utils;
+using Meilisearch;
+
+namespace Aspire.Hosting;
+
+/// <summary>
+/// Provides extension methods for adding Meilisearch resources to the application model.
+/// </summary>
+public static class MeilisearchBuilderExtensions
+{
+    private const int MeilisearchPort = 7700;
+
+    /// <summary>
+    /// Adds an Meilisearch container resource to the application model.
+    /// </summary>
+    /// <remarks>
+    /// The default image is <inheritdoc cref="MeilisearchContainerImageTags.Image"/> and the tag is <inheritdoc cref="MeilisearchContainerImageTags.Tag"/>.
+    /// </remarks>
+    /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
+    /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
+    /// <param name="port">The host port to bind the underlying container to.</param>
+    /// <param name="masterKey">The parameter used to provide the master key for the Meilisearch. If <see langword="null"/> a random master key will be generated.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
+    /// <example>
+    /// Add an Meilisearch container to the application model and reference it in a .NET project.
+    /// <code lang="csharp">
+    /// var builder = DistributedApplication.CreateBuilder(args);
+    ///
+    /// var meilisearch = builder.AddMeilisearch("meilisearch");
+    /// var api = builder.AddProject&lt;Projects.Api&gt;("api")
+    ///   .WithReference(meilisearch);
+    ///  
+    /// builder.Build().Run(); 
+    /// </code>
+    /// </example>
+    public static IResourceBuilder<MeilisearchResource> AddMeilisearch(
+        this IDistributedApplicationBuilder builder,
+        string name,
+        IResourceBuilder<ParameterResource>? masterKey = null,
+        int? port = null)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(name);
+
+        var masterKeyParameter = masterKey?.Resource ?? ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder, $"{name}-masterKey");
+
+        var meilisearch = new MeilisearchResource(name, masterKeyParameter);
+
+        //following commented section need to aspire 9.0.
+
+        //MeilisearchClient? meilisearchClient = null;
+
+        //builder.Eventing.Subscribe<ConnectionStringAvailableEvent>(meilisearch, async (@event, ct) =>
+        //{
+        //    var connectionString = await meilisearch.ConnectionStringExpression.GetValueAsync(ct).ConfigureAwait(false)
+        //    ?? throw new DistributedApplicationException($"ConnectionStringAvailableEvent was published for the '{meilisearch.Name}' resource but the connection string was null.");
+
+        //    meilisearchClient = CreateMeilisearchClient(connectionString);
+        //});
+
+        //var healthCheckKey = $"{name}_check";
+        //builder.Services.AddHealthChecks()
+        // .Add(new HealthCheckRegistration(
+        //     healthCheckKey,
+        //     sp => new MeilisearchHealthCheck(meilisearchClient!),
+        //     failureStatus: default,
+        //     tags: default,
+        //     timeout: default));
+
+        return builder.AddResource(meilisearch)
+             .WithImage(MeilisearchContainerImageTags.Image, MeilisearchContainerImageTags.Tag)
+             .WithImageRegistry(MeilisearchContainerImageTags.Registry)
+             .WithHttpEndpoint(targetPort: MeilisearchPort, port: port, name: MeilisearchResource.PrimaryEndpointName)
+             .WithEnvironment(context =>
+             {
+                 context.EnvironmentVariables["MEILI_MASTER_KEY"] = meilisearch.MasterKeyParameter;
+             });
+             //.WithHealthCheck(healthCheckKey);
+    }
+
+    /// <summary>
+    /// Adds a named volume for the data folder to a Meilisearch container resource.
+    /// </summary>
+    /// <param name="builder">The resource builder.</param>
+    /// <param name="name">The name of the volume. Defaults to an auto-generated name based on the application and resource names.</param>
+    /// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
+    /// <example>
+    /// Add an Meilisearch container to the application model and reference it in a .NET project. Additionally, in this
+    /// example a data volume is added to the container to allow data to be persisted across container restarts.
+    /// <code lang="csharp">
+    /// var builder = DistributedApplication.CreateBuilder(args);
+    ///
+    /// var meilisearch = builder.AddMeilisearch("meilisearch")
+    /// .WithDataVolume();
+    /// var api = builder.AddProject&lt;Projects.Api&gt;("api")
+    ///   .WithReference(meilisearch);
+    ///  
+    /// builder.Build().Run(); 
+    /// </code>
+    /// </example>
+    public static IResourceBuilder<MeilisearchResource> WithDataVolume(this IResourceBuilder<MeilisearchResource> builder, string? name = null)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+#pragma warning disable CTASPIRE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+        return builder.WithVolume(name ?? VolumeNameGenerator.CreateVolumeName(builder, "data"), "/meili_data");
+#pragma warning restore CTASPIRE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    }
+
+    /// <summary>
+    /// Adds a bind mount for the data folder to a Meilisearch container resource.
+    /// </summary>
+    /// <param name="builder">The resource builder.</param>
+    /// <param name="source">The source directory on the host to mount into the container.</param>
+    /// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
+    /// <example>
+    /// Add an Meilisearch container to the application model and reference it in a .NET project. Additionally, in this
+    /// example a bind mount is added to the container to allow data to be persisted across container restarts.
+    /// <code lang="csharp">
+    /// var builder = DistributedApplication.CreateBuilder(args);
+    ///
+    /// var meilisearch = builder.AddMeilisearch("meilisearch")
+    /// .WithDataBindMount("./data/meilisearch/data");
+    /// var api = builder.AddProject&lt;Projects.Api&gt;("api")
+    ///   .WithReference(meilisearch);
+    ///  
+    /// builder.Build().Run(); 
+    /// </code>
+    /// </example>
+    public static IResourceBuilder<MeilisearchResource> WithDataBindMount(this IResourceBuilder<MeilisearchResource> builder, string source)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentNullException.ThrowIfNull(source);
+
+        return builder.WithBindMount(source, "/meili_data");
+    }
+
+    internal static MeilisearchClient CreateMeilisearchClient(string? connectionString)
+    {
+        if (connectionString is null)
+        {
+            throw new InvalidOperationException("Connection string is unavailable");
+        }
+
+        Uri? endpoint = null;
+        string? masterKey = null;
+
+        if (Uri.TryCreate(connectionString, UriKind.Absolute, out var uri))
+        {
+            endpoint = uri;
+        }
+        else
+        {
+            var connectionBuilder = new DbConnectionStringBuilder
+            {
+                ConnectionString = connectionString
+            };
+
+            if (connectionBuilder.TryGetValue("Endpoint", out var endpointValue) && Uri.TryCreate(endpointValue.ToString(), UriKind.Absolute, out var serviceUri))
+            {
+                endpoint = serviceUri;
+            }
+
+            if (connectionBuilder.TryGetValue("MasterKey", out var masterKeyValue))
+            {
+                masterKey = masterKeyValue.ToString();
+            }
+        }
+
+        return new MeilisearchClient(endpoint!.ToString(), apiKey: masterKey!);
+    }
+}

src/Aspire.CommunityToolkit.Hosting.Meilisearch/MeilisearchContainerImageTags.cs

@@ -0,0 +1,12 @@
+namespace Aspire.CommunityToolkit.Hosting.Meilisearch;
+
+internal static class MeilisearchContainerImageTags
+{
+    /// <summary>docker.io</summary>
+    public const string Registry = "docker.io";
+    /// <summary>getmeili/meilisearch</summary>
+    public const string Image = "getmeili/meilisearch";
+    /// <summary>v1.10</summary>
+    public const string Tag = "v1.10";
+}
+

src/Aspire.CommunityToolkit.Hosting.Meilisearch/MeilisearchResource.cs

@@ -0,0 +1,36 @@
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// A resource that represents a Meilisearch
+/// </summary>
+public class MeilisearchResource : ContainerResource, IResourceWithConnectionString
+{
+    internal const string PrimaryEndpointName = "http";
+
+    /// <param name="name">The name of the resource.</param>
+    /// <param name="masterKey">A parameter that contains the Meilisearch master key.</param>
+    public MeilisearchResource(string name, ParameterResource masterKey) : base(name)
+    {
+        ArgumentNullException.ThrowIfNull(masterKey);
+        MasterKeyParameter = masterKey;
+    }
+
+    private EndpointReference? _primaryEndpoint;
+
+    /// <summary>
+    /// Gets the primary endpoint for the Meilisearch. This endpoint is used for all API calls over HTTP.
+    /// </summary>
+    public EndpointReference PrimaryEndpoint => _primaryEndpoint ??= new(this, PrimaryEndpointName);
+
+    /// <summary>
+    /// Gets the parameter that contains the Meilisearch superuser password.
+    /// </summary>
+    public ParameterResource MasterKeyParameter { get; }
+
+    /// <summary>
+    /// Gets the connection string expression for the Meilisearch
+    /// </summary>
+    public ReferenceExpression ConnectionStringExpression =>
+        ReferenceExpression.Create($"Endpoint=http://{PrimaryEndpoint.Property(EndpointProperty.Host)}:{PrimaryEndpoint.Property(EndpointProperty.Port)};MasterKey={MasterKeyParameter}");
+}
+

src/Aspire.CommunityToolkit.Hosting.Meilisearch/PublicAPI.Shipped.txt

@@ -0,0 +1 @@
+#nullable enable

src/Aspire.CommunityToolkit.Hosting.Meilisearch/PublicAPI.Unshipped.txt

@@ -0,0 +1,10 @@
+#nullable enable
+Aspire.Hosting.ApplicationModel.MeilisearchResource
+Aspire.Hosting.ApplicationModel.MeilisearchResource.ConnectionStringExpression.get -> Aspire.Hosting.ApplicationModel.ReferenceExpression!
+Aspire.Hosting.ApplicationModel.MeilisearchResource.MasterKeyParameter.get -> Aspire.Hosting.ApplicationModel.ParameterResource!
+Aspire.Hosting.ApplicationModel.MeilisearchResource.MeilisearchResource(string! name, Aspire.Hosting.ApplicationModel.ParameterResource! masterKey) -> void
+Aspire.Hosting.ApplicationModel.MeilisearchResource.PrimaryEndpoint.get -> Aspire.Hosting.ApplicationModel.EndpointReference!
+Aspire.Hosting.MeilisearchBuilderExtensions
+static Aspire.Hosting.MeilisearchBuilderExtensions.AddMeilisearch(this Aspire.Hosting.IDistributedApplicationBuilder! builder, string! name, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource!>? masterKey = null, int? port = null) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MeilisearchResource!>!
+static Aspire.Hosting.MeilisearchBuilderExtensions.WithDataBindMount(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MeilisearchResource!>! builder, string! source) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MeilisearchResource!>!
+static Aspire.Hosting.MeilisearchBuilderExtensions.WithDataVolume(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MeilisearchResource!>! builder, string? name = null) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MeilisearchResource!>!

src/Aspire.CommunityToolkit.Hosting.Meilisearch/README.md

@@ -0,0 +1 @@
+## TODO

src/Aspire.CommunityToolkit.Meilisearch/Aspire.CommunityToolkit.Meilisearch.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <AdditionalPackageTags>Meilisearch</AdditionalPackageTags>
+    <Description>A Meilisearch client that integrates with Aspire, including health checks, logging, and telemetry.</Description>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="MeiliSearch" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Compile Include="..\HealthChecksExtensions.cs" Link="Utils\HealthChecksExtensions.cs" />
+  </ItemGroup>
+
+</Project>