feat: Add MongoDB hosting extension with dashboard management commands by Copilot · Pull Request #87 · mpaulosky/IssueTracker

Copilot · 2026-02-17T18:22:48Z

Summary

AppHost needed reusable MongoDB registration with dashboard commands for data management during development. Current setup requires verbose chaining; no built-in data reset capabilities.

Changes

Core Extension (`src/AppHost/Extensions/MongoDBHostingExtensions.cs`)

AddMongoDBWithManagement() method encapsulates MongoDB registration, health checks, and data volume configuration
Two dashboard commands using Aspire 13.0 CommandOptions API:
- Clear All Data: Drops all collections via ListCollectionNamesAsync() + DropCollectionAsync()
- Drop Database: Drops entire database with confirmation; uses DropDatabaseAsync()
Exception handling for MongoException and OperationCanceledException

AppHost Updates

Simplified registration from:

var mongodb = builder.AddMongoDB("mongodb")
    .WithDataVolume()
    .WithHealthCheck("mongodb");

To:

var mongodb = builder.AddMongoDBWithManagement("mongodb");

Maintains identical functionality with added dashboard commands.

Testing

New AppHost.Tests project with 12 unit tests
Coverage: resource creation, parameter validation, annotation verification
All tests passing

Documentation

README.md in Extensions directory with usage, security considerations, and API reference

Technical Notes

Uses IAsyncCursor<string> iteration pattern for MongoDB collection enumeration
Dashboard commands execute async; state management via CommandOptions.UpdateState
Commands always enabled; confirmation handled by Aspire dashboard UI

Original prompt

This section details on the original issue you should resolve

<issue_title>Feature: Add to the AppHost an extension

<issue_description>In the AppHost lets create an extension that:

Registers the MongoDB database.

Creates a Dashboard command that allow clearing the data or dropping the database to allow add new data.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Feature: Add to the AppHost an extension  #85

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: mpaulosky <60372079+mpaulosky@users.noreply.github.com>

Copilot

Pull request overview

This pull request adds a reusable MongoDB hosting extension for the AppHost with integrated dashboard management commands, simplifying MongoDB configuration and providing data management capabilities during development.

Changes:

Created MongoDBHostingExtensions class with AddMongoDBWithManagement() method that encapsulates MongoDB registration, health checks, and data volumes
Added two dashboard commands: "Clear All Data" (drops all collections) and "Drop Database" (drops entire database with confirmation)
Added comprehensive unit tests in new AppHost.Tests project (12 tests covering resource creation, validation, and annotations)
Simplified AppHost Program.cs by replacing verbose chaining with single method call
Added extensive documentation in Extensions/README.md covering usage, security, and API reference

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
src/AppHost/Extensions/MongoDBHostingExtensions.cs	Core extension implementing MongoDB registration with dashboard commands for clearing data and dropping database
src/AppHost/Extensions/README.md	Comprehensive documentation covering features, usage, parameters, exception handling, testing, and security considerations
src/AppHost/Program.cs	Simplified MongoDB registration using new extension method
src/AppHost/GlobalUsings.cs	Added required global usings for Aspire and MongoDB
src/AppHost/AppHost.csproj	Added MongoDB.Driver package reference
tests/AppHost.Tests/MongoDBHostingExtensionsTests.cs	Unit tests covering resource creation, parameter validation, and annotation verification
tests/AppHost.Tests/GlobalUsings.cs	Global usings for test project
tests/AppHost.Tests/AppHost.Tests.csproj	Test project configuration with required dependencies
IssueTracker.slnx	Added AppHost.Tests project to solution

Copilot · 2026-02-17T19:01:06Z

+
+namespace AppHost.Tests;
+
+/// <summary>
+/// Tests for MongoDB hosting extensions with dashboard commands.
+/// </summary>


The test class is missing the [ExcludeFromCodeCoverage] attribute. All test classes in this repository consistently use this attribute to exclude test code from coverage metrics (see examples in DatabaseSettingsTests.cs, MongoDbContextFactoryTests.cs, etc.). Add [ExcludeFromCodeCoverage] above the class declaration to maintain consistency with the codebase conventions.

Suggested change

namespace AppHost.Tests;

/// <summary>

/// Tests for MongoDB hosting extensions with dashboard commands.

/// </summary>

using System.Diagnostics.CodeAnalysis;

namespace AppHost.Tests;

/// <summary>

/// Tests for MongoDB hosting extensions with dashboard commands.

/// </summary>

[ExcludeFromCodeCoverage]

Copilot · 2026-02-17T19:01:06Z

+					var clearedCount = 0;
+					while (await collections.MoveNextAsync(context.CancellationToken))
+					{
+						foreach (var collectionName in collections.Current)
+						{
+							await db.DropCollectionAsync(collectionName, context.CancellationToken);
+							clearedCount++;


The variable 'clearedCount' is declared and incremented but never used. Either remove this variable if it's not needed, or consider including it in the success result for logging/debugging purposes.

Suggested change

var clearedCount = 0;

while (await collections.MoveNextAsync(context.CancellationToken))

{

foreach (var collectionName in collections.Current)

{

await db.DropCollectionAsync(collectionName, context.CancellationToken);

clearedCount++;

while (await collections.MoveNextAsync(context.CancellationToken))

{

foreach (var collectionName in collections.Current)

{

await db.DropCollectionAsync(collectionName, context.CancellationToken);

Copilot · 2026-02-17T19:01:07Z

@@ -0,0 +1,155 @@
+// ============================================
+// Copyright (c) 2023. All rights reserved.


The copyright year is 2023, but this is new code being added in 2025-2026. Consider updating to the current year to accurately reflect when this code was created.

Copilot · 2026-02-17T19:01:07Z

@@ -0,0 +1,19 @@
+// ============================================
+// Copyright (c) 2023. All rights reserved.


The copyright year is 2023, but this is new code being added in 2025-2026. Consider updating to the current year to accurately reflect when this code was created.

Copilot · 2026-02-17T19:01:07Z

@@ -0,0 +1,138 @@
+// ============================================
+// Copyright (c) 2023. All rights reserved.


The copyright year is 2023, but this is new code being added in 2025-2026. Consider updating to the current year to accurately reflect when this code was created.

Copilot · 2026-02-17T19:01:07Z

+
+				try
+				{
+					var client = new MongoClient(connectionString);


The MongoClient instance created in line 65 is not disposed. MongoClient is an IDisposable resource that should be properly disposed. Consider using a 'using' statement or ensure the client is disposed after use to prevent potential resource leaks.

Suggested change

var client = new MongoClient(connectionString);

using var client = new MongoClient(connectionString);

Copilot · 2026-02-17T19:01:08Z

+
+				try
+				{
+					var client = new MongoClient(connectionString);


The MongoClient instance created in line 119 is not disposed. MongoClient is an IDisposable resource that should be properly disposed. Consider using a 'using' statement or ensure the client is disposed after use to prevent potential resource leaks.

Copilot · 2026-02-17T19:01:08Z

+var mongodb = builder.AddMongoDBWithManagement("testmongo");
+
+// Assert
+mongodb.Resource.Annotations.Should().NotBeEmpty("Resource should have annotations");


The test 'AddMongoDBWithManagement_AddsDataVolumeAnnotation' only asserts that annotations are not empty, but doesn't verify that a data volume annotation specifically exists. Consider adding a more specific assertion to verify the presence of a volume-related annotation, similar to the health check test which checks for a HealthCheck annotation type.

Suggested change

mongodb.Resource.Annotations.Should().NotBeEmpty("Resource should have annotations");

mongodb.Resource.Annotations.Should().NotBeEmpty("Resource should have annotations");

mongodb.Resource.Annotations.Should().Contain(

a => a.GetType().Name.Contains("Volume"),

"Resource should have data volume annotation");

Copilot · 2026-02-17T19:01:08Z

+### Requirements
+
+- .NET 10.0
+- Aspire.Hosting.MongoDB 13.0+


The requirements specify "Aspire.Hosting.MongoDB 13.0+", but according to Directory.Packages.props line 54, the project is using "Aspire.Hosting.MongoDB" version "13.0.0". While technically correct, consider verifying this version is available and stable. The PR description mentions using "Aspire 13.0 CommandOptions API", which aligns with this version.

Copilot · 2026-02-17T19:01:08Z

+				catch (MongoException)
+				{
+					// MongoDB-specific errors (connection, authentication, etc.)
+					return CommandResults.Failure();
+				}
+				catch (OperationCanceledException)
+				{
+					// Operation was cancelled by user or timeout
+					return CommandResults.Failure();


The exception handlers for MongoException and OperationCanceledException silently return failure without logging the error or providing any diagnostic information. Consider adding logging or including exception details in the failure result to aid in debugging when commands fail. This would help developers understand why a command failed in the dashboard.

Suggested change

catch (MongoException)

{

// MongoDB-specific errors (connection, authentication, etc.)

return CommandResults.Failure();

}

catch (OperationCanceledException)

{

// Operation was cancelled by user or timeout

return CommandResults.Failure();

catch (MongoException ex)

{

// MongoDB-specific errors (connection, authentication, etc.)

return CommandResults.Failure(

$"MongoDB error while clearing data from '{databaseName}': {ex.Message}");

}

catch (OperationCanceledException)

{

// Operation was cancelled by user or timeout

return CommandResults.Failure(

"Operation was canceled while clearing MongoDB data.");

Initial plan

0369c9b

Copilot AI assigned Copilot and mpaulosky Feb 17, 2026

Copilot started work on behalf of mpaulosky February 17, 2026 18:23 View session

Copilot AI and others added 4 commits February 17, 2026 18:28

feat: Add MongoDB extension with dashboard commands for AppHost

25bbe80

Co-authored-by: mpaulosky <60372079+mpaulosky@users.noreply.github.com>

test: Add unit tests for MongoDB hosting extensions

adb6285

Co-authored-by: mpaulosky <60372079+mpaulosky@users.noreply.github.com>

refactor: Improve exception handling in MongoDB commands

2b7031f

Co-authored-by: mpaulosky <60372079+mpaulosky@users.noreply.github.com>

docs: Add comprehensive README for MongoDB extensions

8c38ebf

Co-authored-by: mpaulosky <60372079+mpaulosky@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add MongoDB extension to AppHost with dashboard command~~ feat: Add MongoDB hosting extension with dashboard management commands Feb 17, 2026

Copilot AI requested a review from mpaulosky February 17, 2026 18:39

Copilot finished work on behalf of mpaulosky February 17, 2026 18:39

mpaulosky marked this pull request as ready for review February 17, 2026 18:54

Copilot AI review requested due to automatic review settings February 17, 2026 18:54

mpaulosky merged commit c188707 into main Feb 17, 2026
7 checks passed

mpaulosky deleted the copilot/add-mongodb-extension branch February 17, 2026 18:55

Copilot started reviewing on behalf of mpaulosky February 17, 2026 18:55 View session

Copilot AI reviewed Feb 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add MongoDB hosting extension with dashboard management commands#87

feat: Add MongoDB hosting extension with dashboard management commands#87
mpaulosky merged 5 commits intomainfrom
copilot/add-mongodb-extension

Copilot AI commented Feb 17, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,155 @@
		// ============================================
		// Copyright (c) 2023. All rights reserved.

		@@ -0,0 +1,19 @@
		// ============================================
		// Copyright (c) 2023. All rights reserved.

		@@ -0,0 +1,138 @@
		// ============================================
		// Copyright (c) 2023. All rights reserved.

	var client = new MongoClient(connectionString);
	using var client = new MongoClient(connectionString);

-mongodb.Resource.Annotations.Should().NotBeEmpty("Resource should have annotations");
+mongodb.Resource.Annotations.Should().NotBeEmpty("Resource should have annotations");
+mongodb.Resource.Annotations.Should().Contain(
+  a => a.GetType().Name.Contains("Volume"),
+  "Resource should have data volume annotation");

Conversation

Copilot AI commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Core Extension (src/AppHost/Extensions/MongoDBHostingExtensions.cs)

AppHost Updates

Testing

Documentation

Technical Notes

Comments on the Issue (you are @copilot in this section)

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 17, 2026 •

edited

Loading

Core Extension (`src/AppHost/Extensions/MongoDBHostingExtensions.cs`)