feat: add ChromaDB hosting and client integrations by ali-Hamza817 · Pull Request #1132 · CommunityToolkit/Aspire

ali-Hamza817 · 2026-02-19T08:07:40Z

Pull Request: Add ChromaDB Hosting and Client Integrations

Summary

This PR adds a new hosting and client integration for ChromaDB, an open-source vector database essential for AI and RAG applications.

Features

Hosting Integration: Easily add ChromaDB as a container resource to your .NET Aspire orchestration using builder.AddChroma("chroma").
Client Integration: Provides a simple way to register ChromaClient in your application via builder.AddChromaClient("chroma").
Keyed Services: Native support for keyed client registration via builder.AddKeyedChromaClient("chroma").
Persistence: Built-in support for data persistence using both Docker volumes and bind mounts.
Health Checks: Automatic health check registration using Chroma's GetVersion() API.
Documentation: Comprehensive XML docs and README.md files for both packages.

PR Checklist

Additional information

Verified with 8 unit tests covering hosting resource creation, endpoint configuration, persistence volumes, DI registration, and health checks.

This contribution adds support for ChromaDB as a .NET Aspire resource, including: - Hosting integration for containerized ChromaDB - Client integration with health checks and keyed service support - Persistence support via volumes and bind mounts - Comprehensive unit tests and documentation

ali-Hamza817 · 2026-02-19T08:26:58Z

@dotnet-policy-service agree

aaronpowell

We need to have an example app included as part of the PR and a test covering that the sample starts and the resource becomes health.

Ideally, the sample should also actually use Chroma, so some kind of basic CRUD just to allow for more advanced testing and demonstrations.

You also need to add the test projects to the tests.yml workflow - we have a script in eng that will generate the properly formatted test list if you'd like.

But overall, a solid looking integration set.

aaronpowell · 2026-02-26T01:36:02Z

src/CommunityToolkit.Aspire.Chroma/api/CommunityToolkit.Aspire.Chroma.cs

This file is auto-generated on merging to main, so it should be removed.

aaronpowell · 2026-02-26T01:36:41Z

src/CommunityToolkit.Aspire.Chroma/AspireChromaExtensions.cs

+
+    private static ChromaClient CreateClient(IServiceProvider sp, ChromaClientSettings settings, string connectionName)
+    {
+        if (settings.Endpoint == null)


Suggested change

if (settings.Endpoint == null)

if (settings.Endpoint is null)

aaronpowell · 2026-02-26T01:38:26Z

src/CommunityToolkit.Aspire.Hosting.Chroma/api/CommunityToolkit.Aspire.Hosting.Chroma.cs

This file is generated when merging to main so it should be removed.

aaronpowell · 2026-02-26T01:40:20Z

src/CommunityToolkit.Aspire.Hosting.Chroma/ChromaResource.cs

+    public ChromaResource(string name) : base(name)
+    {
+    }


Can you use a primary constructor to be consistent with the coding style

- Removed auto-generated api files. - Refactored ChromaResource to use a primary constructor. - Corrected style for null checks (is null). - Added example app with CRUD operations in examples/chromadb. - Added integration tests for health and CRUD verification. - Updated tests.yml workflow to include new tests.

Copilot

Pull request overview

This PR adds comprehensive ChromaDB hosting and client integrations to the Aspire Community Toolkit, enabling developers to easily orchestrate and consume ChromaDB vector database services in their .NET Aspire applications.

Changes:

New hosting integration package (CommunityToolkit.Aspire.Hosting.Chroma) providing resource orchestration for ChromaDB containers with configurable persistence options
New client integration package (CommunityToolkit.Aspire.Chroma) providing ChromaClient registration with health checks and configuration support
Comprehensive test coverage including unit tests, integration tests, and AppHost tests
Example application demonstrating end-to-end usage with collection creation and querying

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/CommunityToolkit.Aspire.Hosting.Chroma/ChromaResource.cs	Defines the ChromaDB container resource with connection string support
src/CommunityToolkit.Aspire.Hosting.Chroma/ChromaBuilderExtensions.cs	Provides AddChroma extension method and persistence configuration helpers
src/CommunityToolkit.Aspire.Hosting.Chroma/ChromaContainerImageTags.cs	Defines ChromaDB container image details (chromadb/chroma:0.5.0)
src/CommunityToolkit.Aspire.Chroma/AspireChromaExtensions.cs	Implements ChromaClient DI registration with keyed service support
src/CommunityToolkit.Aspire.Chroma/ChromaHealthCheck.cs	Provides health check implementation using GetVersion API
src/CommunityToolkit.Aspire.Chroma/ChromaClientSettings.cs	Configuration model supporting endpoint, health checks, and timeout settings
tests/CommunityToolkit.Aspire.Hosting.Chroma.Tests/AddChromaTests.cs	Unit tests for hosting resource configuration and annotations
tests/CommunityToolkit.Aspire.Hosting.Chroma.Tests/AppHostTests.cs	Integration tests verifying ChromaDB startup and API service interaction
tests/CommunityToolkit.Aspire.Chroma.Tests/ChromaClientExtensionsTests.cs	Unit tests for client registration and health check behavior
examples/chromadb/CommunityToolkit.Aspire.Hosting.Chroma.AppHost/Program.cs	Example AppHost orchestrating ChromaDB and API service
examples/chromadb/CommunityToolkit.Aspire.Hosting.Chroma.ApiService/Program.cs	Example API service demonstrating ChromaDB operations
Directory.Packages.props	Adds ChromaDB.Client 1.0.0 package reference
CommunityToolkit.Aspire.slnx	Adds new projects to solution
.github/workflows/tests.yaml	Adds test projects to CI workflow

Copilot · 2026-02-26T08:09:00Z

src/CommunityToolkit.Aspire.Chroma/ChromaClientSettings.cs

+    public bool DisableHealthChecks { get; set; }
+
+    /// <summary>
+    /// Gets or sets a integer value that indicates the ChromaDB health check timeout in milliseconds.


Grammar issue: "a integer" should be "an integer".

Suggested change

/// Gets or sets a integer value that indicates the ChromaDB health check timeout in milliseconds.

/// Gets or sets an integer value that indicates the ChromaDB health check timeout in milliseconds.

Copilot · 2026-02-26T08:09:01Z

tests/CommunityToolkit.Aspire.Chroma.Tests/ChromaClientExtensionsTests.cs

+
+namespace CommunityToolkit.Aspire.Chroma.Tests;
+
+public class AspireChromaClientExtensionsTests


The class name AspireChromaClientExtensionsTests does not match the file name ChromaClientExtensionsTests.cs. For consistency with the codebase (e.g., AspireMeilisearchClientExtensionsTest), consider either:

Renaming the class to ChromaClientExtensionsTests to match the file name, or

Renaming the file to AspireChromaClientExtensionsTests.cs to match the class name.

The former approach (matching the file name without the "Aspire" prefix) appears more common in client integration tests.

Suggested change

public class AspireChromaClientExtensionsTests

public class ChromaClientExtensionsTests

aaronpowell

Code-wise, this looks great, thanks for the contribution!

aaronpowell

Just some test failures and then it should be good to merge

aaronpowell · 2026-03-02T01:05:44Z

tests/CommunityToolkit.Aspire.Hosting.Chroma.Tests/AddChromaTests.cs

+        var appBuilder = DistributedApplication.CreateBuilder();
+
+        appBuilder.AddChroma("chroma")
+            .WithDataBindMount("C:/chroma/data");


You'll need to set a relative path here so it doesn't error on CI

…Settings.json for ApiService

aaronpowell · 2026-03-04T05:42:16Z

Looks like

Aspire/tests/CommunityToolkit.Aspire.Hosting.Chroma.Tests/AppHostTests.cs

Line 33 in af045b5

var rns = fixture.ResourceNotificationService;

is still failing

ali-Hamza817 · 2026-03-08T01:25:50Z

@aaronpowell
3 workflows waiting for approval please

github-actions bot added the Stale label Feb 25, 2026

aaronpowell removed the Stale label Feb 26, 2026

aaronpowell requested changes Feb 26, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings February 26, 2026 08:02

Copilot started reviewing on behalf of ali-Hamza817 February 26, 2026 08:03 View session

Copilot AI reviewed Feb 26, 2026

View reviewed changes

Address Copilot feedback: fix grammar and rename test class

5d46073

aaronpowell approved these changes Mar 2, 2026

View reviewed changes

aaronpowell reviewed Mar 2, 2026

View reviewed changes

Fix CI test failures: use relative path for bind mount and add launch…

7206d70

…Settings.json for ApiService

ali-Hamza817 added 2 commits March 4, 2026 06:18

fix(chroma): resolve health check 404 and address review feedback

044a2a3

fix(chroma): resolve health check 404 and address review feedback

a1d56bf

	if (settings.Endpoint == null)
	if (settings.Endpoint is null)

	/// Gets or sets a integer value that indicates the ChromaDB health check timeout in milliseconds.
	/// Gets or sets an integer value that indicates the ChromaDB health check timeout in milliseconds.


		namespace CommunityToolkit.Aspire.Chroma.Tests;

		public class AspireChromaClientExtensionsTests

	public class AspireChromaClientExtensionsTests
	public class ChromaClientExtensionsTests

Conversation

ali-Hamza817 commented Feb 19, 2026

Pull Request: Add ChromaDB Hosting and Client Integrations

Summary

Features

PR Checklist

Additional information

Uh oh!

ali-Hamza817 commented Feb 19, 2026

Uh oh!

aaronpowell left a comment

Choose a reason for hiding this comment

Uh oh!

aaronpowell Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

aaronpowell Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

aaronpowell Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

aaronpowell Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

aaronpowell left a comment

Choose a reason for hiding this comment

Uh oh!

aaronpowell left a comment

Choose a reason for hiding this comment

Uh oh!

aaronpowell Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

aaronpowell commented Mar 4, 2026

Uh oh!

ali-Hamza817 commented Mar 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ali-Hamza817 commented Mar 8, 2026 •

edited

Loading