Add Aspire.Hosting.EntityFrameworkCore hosting integration for EF Core migration management #13481

Copilot · 2025-12-10T22:58:47Z

Description

New hosting integration package Aspire.Hosting.EntityFrameworkCore that provides EF Core migration management commands for Aspire AppHost projects.

Key Features

AddEFMigrations extension methods - Add migration resources to project resources with optional DbContext type specification. Supports both generic AddEFMigrations<TContext>() and string-based AddEFMigrations(name, contextTypeName) overloads.
EFMigrationResourceBuilder - Custom builder class with fluent configuration methods: RunDatabaseUpdateOnStart(), PublishAsMigrationScript(), PublishAsMigrationBundle(), WithMigrationOutputDirectory(), WithMigrationNamespace(), WithMigrationsProject()
6 resource commands on project resource - Update Database, Drop Database, Reset Database, Add Migration (with interactive prompt), Remove Migration, Get Database Status - commands are added to the original project resource with context name suffix to avoid confusion when multiple DbContexts are registered
WaitFor support with health checks - EFMigrationResource implements IResourceWithWaitSupport. When RunDatabaseUpdateOnStart() is called, a health check is registered that reports healthy only when migrations complete. Migrations wait for the project resource to be healthy before executing.
Separate migration project support - Use WithMigrationsProject() when migrations are in a different project than the startup project. Both startup and target assemblies are loaded in the same AssemblyLoadContext.
Reflection-based EF Core executor with assembly isolation - Uses collectible AssemblyLoadContext to load and execute EF Core operations, with proper unloading after each operation. Uses MSBuild for property resolution with configuration/runtime heuristics.
Interactive migration naming - Uses IInteractionService.PromptInputAsync for Add Migration command with recompilation notification via PromptNotificationAsync. Remove Migration also shows recompilation notification.
Database status display - Uses IInteractionService.PromptMessageBoxAsync to show current migration status
Event-driven startup and publishing - EFMigrationEventSubscriber handles AfterResourcesCreatedEvent for startup migrations (after project resource is healthy) and BeforePublishEvent for generating migration scripts/bundles during publish

Checklist

Original prompt

Create a new hosting integration that provides EF migration management commands. Start by creating a detailed step-by-step checklist as an .md file that should be updated as you finish tasks. Add tests for all the new functionality, including tests that use other features that could interact with this, like explicit start and wait for.

Package name: Aspire.Hosting.EFCoreCommands
Assembly name: Aspire.Hosting.EFCoreCommands

High-level feature outline
Support for producing migration scripts and/or migration bundles as part of publishing the AppHost, e.g. .PublishAsMigrationScript()
Support for running migrations on AppHost start and having other resources wait on the migrations to complete, e.g.:
var api = builder.AddProject<Api>("api");
var apiMigrations = api.AddEFMigrations("api-migrations").RunDatabaseUpdateOnStart();
Adds resource commands to resources that AddEfMigrations was called on:

"Update database": Runs the equivalent of ef database update command on the resource

"Drop database": Runs the equivalent of ef database drop command on the resource

"Reset database": Runs equivalent of ef database drop followed by dotnet ef database update on the resource

"Add migration...": Prompts for a migration name (and some options from dotnet ef migrations add) before running the equivalent of dotnet ef migrations add <NAME> on the resource. Add some notification to indicate that in order to apply the new migration the target project needs to be recompiled.

"Remove migration": Runs the equivalent of ef migrations remove on the resource to remove the last migration

"Get database status": Shows the current migration of the database or whether it hasn't been created. Whether the current migration is also the latest and whether there are any pending model changes.

AddEFMigrations should allow a context type to be specified. Multiple calls on the same resource with different context types are allowed and will add commands for each context used. Using the same context type results in an exception.

The implementation will check that the target references Microsoft.EntityFrameworkcore.Design and show an error message if it doesn't. Then it will use reflection to invoke commands on it with appropriate arguments, see https://github.com/dotnet/efcore/blob/main/src/ef/ReflectionOperationExecutor.cs

IOperationReporter should be used to capture the output of the operations

💡 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.

…anagement - Create EFMigrationResource with IResourceWithWaitSupport - Add AddEFMigrations extension methods for project resources - Implement 6 resource commands: Update, Drop, Reset, Add, Remove, Status - Add RunDatabaseUpdateOnStart and PublishAs* configuration methods - Add EFCoreOperationExecutor for command execution - Create comprehensive test suite with 36 passing tests - Add detailed implementation checklist documentation Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

AndriySvyryd

@copilot Continue implementation according to the checklist

Aspire.slnx

src/Aspire.Hosting.EFCoreCommands/README.md

src/Aspire.Hosting.EntityFrameworkCore/README.md

src/Aspire.Hosting.EFCoreCommands/README.md

src/Aspire.Hosting.EFCoreCommands/EFMigrationsBuilderExtensions.cs

docs/specs/EFCoreCommands-Implementation-Checklist.md

- Reorganize README.md with Prerequisites section first, add PublishAsMigrationBundle example - Move "Running migrations on startup" to separate subsection after Resource Commands - Update prerequisites to recommend manual project file reference for Microsoft.EntityFrameworkCore.Design - Add TODO comment for documentation link update - Add remarks about multiple calls with different context types in extension methods - Fix error message format for duplicate context registration - Update implementation checklist with IDistributedApplicationEventingSubscriber note - Add EFCoreCommands demo to SqlServerEndToEnd playground Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

Copilot · 2025-12-11T00:19:46Z

@copilot Continue implementation according to the checklist

All review comments have been addressed in 5c8b132. Added EFCoreCommands demo to SqlServerEndToEnd playground and addressed all documentation feedback.

docs/specs/EFCoreCommands-Implementation-Checklist.md

docs/specs/EntityFrameworkCore-Implementation-Checklist.md

… dialog - Create EFMigrationEventSubscriber using IDistributedApplicationEventingSubscriber - Implement resource state transitions (Pending → Running → Finished/FailedToStart) - Add IInteractionService.PromptInputAsync for migration name prompt - Support custom migration name parameter in AddMigrationAsync - Update implementation checklist with links and completion status - Add test for event subscriber registration - All 37 tests pass Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

- Update code example to use GetService instead of GetRequiredService - Add fallback logic example matching actual implementation Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

src/Aspire.Hosting.EFCoreCommands/EFMigrationsBuilderExtensions.cs

docs/specs/EntityFrameworkCore-Implementation-Checklist.md

src/Aspire.Hosting.EFCoreCommands/EFMigrationAnnotations.cs

playground/SqlServerEndToEnd/SqlServerEndToEnd.AppHost/Program.cs

- Create IEFMigrationResourceBuilder interface that stores ContextTypeName - Create EFMigrationResourceBuilder implementation wrapping inner builder - Update AddEFMigrations to return IEFMigrationResourceBuilder - Add string overload AddEFMigrations(name, contextTypeName) for runtime discovery - Add ContextTypeName property to EFMigrationResource - Add recompilation notification after migration is added (via logs) - Add 5 new tests for string context type overload - All 42 tests pass Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResourceBuilder.cs

- Rename method WithMigrationProject to WithMigrationsProject - Rename property MigrationProject to MigrationsProject in EFMigrationsOptions - Update all references in extensions, event subscriber, README, and tests - All 50 tests pass Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationEventSubscriber.cs

The EFMigrationEventSubscriber now waits for the project resource (the one on which AddEFMigrations was called) to be healthy before attempting to apply migrations. This ensures the database connection is available when migrations run. - Use resourceNotificationService.WaitForResourceHealthyAsync before ApplyMigrationsAsync - Log message indicating waiting for project resource to be healthy - All 50 tests pass Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

davidfowl · 2025-12-12T00:25:23Z

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationEventSubscriber.cs

+        else if (executionContext.IsPublishMode)
+        {
+            // In publish mode, generate migration scripts/bundles
+            eventing.Subscribe<BeforePublishEvent>(OnBeforePublishAsync);


@copilot This should happen in a step not in an event.

cc @AndriySvyryd

@davidfowl I think copilot gave up on this PR

src/Aspire.Hosting.EntityFrameworkCore/EFCoreOperationExecutor.cs

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationEventSubscriber.cs

github-actions · 2025-12-12T02:11:39Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 13481

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 13481"

AndriySvyryd · 2025-12-13T01:04:33Z

This is how it looks right now

AndriySvyryd · 2025-12-16T03:07:20Z

This is the database status dialog:

AndriySvyryd · 2025-12-16T05:20:56Z

src/Aspire.Hosting.EntityFrameworkCore/README.md

+
+```csharp
+var startup = builder.AddProject<Projects.Api>("api");
+var dataProject = builder.AddProject<Projects.Data>("data");


@davidfowl How can I mark a project resource as "non-runnable"?

Copilot

Pull request overview

This PR introduces a new hosting integration package Aspire.Hosting.EntityFrameworkCore that provides comprehensive EF Core migration management for Aspire AppHost projects.

Key additions:

Extension methods (AddEFMigrations<TContext>() with multiple overloads) to attach migration management to project resources
6 dashboard resource commands (Update/Drop/Reset Database, Add/Remove Migration, Get Status) with interactive prompts
Reflection-based executor using collectible AssemblyLoadContext for EF Core operations
WaitFor support with health checks for migration dependencies
Event-driven startup migrations and publish pipeline integration
50 comprehensive unit tests covering all functionality

Reviewed changes

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

Show a summary per file

File	Description
src/Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.csproj	New project file multi-targeting net8.0/9.0/10.0 with package validation disabled
src/Aspire.Hosting.EntityFrameworkCore/README.md	Hosting integration documentation following standard structure with usage examples
src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.cs	Resource class implementing IResourceWithWaitSupport with configuration properties
src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResourceBuilder.cs	Custom builder with fluent configuration methods (RunDatabaseUpdateOnStart, Publish*, etc.)
src/Aspire.Hosting.EntityFrameworkCore/EFResourceBuilderExtensions.cs	Extension methods for AddEFMigrations with 4 overloads and command registration
src/Aspire.Hosting.EntityFrameworkCore/EFMigrationHealthCheck.cs	Health check implementation for migration state monitoring
src/Aspire.Hosting.EntityFrameworkCore/EFMigrationEventSubscriber.cs	Event subscriber handling startup migrations via BeforeResourceStartedEvent
src/Aspire.Hosting.EntityFrameworkCore/EFCoreOperationExecutor.cs	Reflection-based EF operation executor using AssemblyLoadContext isolation
tests/Aspire.Hosting.EntityFrameworkCore.Tests/*.cs	Comprehensive test suite (50 tests) covering resource creation, configuration, commands, and WaitFor
playground/SqlServerEndToEnd/*	Example integration showing AddEFMigrations usage with WaitFor dependencies
Aspire.slnx	Solution file updated with new projects

src/Aspire.Hosting.EntityFrameworkCore/README.md

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationHealthCheck.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Initial plan

e308872

Copilot AI assigned Copilot and AndriySvyryd Dec 10, 2025

Copilot started work on behalf of AndriySvyryd December 10, 2025 22:59 View session

Copilot AI and others added 2 commits December 10, 2025 23:29

Remove duplicate implementation checklist file

47f76e0

Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add hosting integration for EF migration management commands~~ Add Aspire.Hosting.EFCoreCommands hosting integration for EF Core migration management Dec 10, 2025

Copilot AI requested a review from AndriySvyryd December 10, 2025 23:34

Copilot finished work on behalf of AndriySvyryd December 10, 2025 23:34

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

Copilot started work on behalf of AndriySvyryd December 11, 2025 00:08 View session

Copilot AI requested a review from AndriySvyryd December 11, 2025 00:22

Copilot finished work on behalf of AndriySvyryd December 11, 2025 00:22

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

docs/specs/EFCoreCommands-Implementation-Checklist.md Outdated Show resolved Hide resolved

docs/specs/EFCoreCommands-Implementation-Checklist.md Outdated Show resolved Hide resolved

docs/specs/EntityFrameworkCore-Implementation-Checklist.md Show resolved Hide resolved

Copilot started work on behalf of AndriySvyryd December 11, 2025 00:27 View session

Copilot AI and others added 2 commits December 11, 2025 00:41

Fix documentation to match implementation in checklist

ebb3cd3

- Update code example to use GetService instead of GetRequiredService - Add fallback logic example matching actual implementation Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>

Copilot AI requested a review from AndriySvyryd December 11, 2025 00:45

Copilot finished work on behalf of AndriySvyryd December 11, 2025 00:45

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

Copilot started work on behalf of AndriySvyryd December 11, 2025 00:50 View session

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

src/Aspire.Hosting.EFCoreCommands/EFMigrationAnnotations.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

playground/SqlServerEndToEnd/SqlServerEndToEnd.AppHost/Program.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

playground/SqlServerEndToEnd/SqlServerEndToEnd.AppHost/Program.cs Show resolved Hide resolved

Copilot AI requested a review from AndriySvyryd December 11, 2025 01:06

Copilot finished work on behalf of AndriySvyryd December 11, 2025 01:06

Copilot started work on behalf of AndriySvyryd December 11, 2025 01:06 View session

Copilot finished work on behalf of AndriySvyryd December 11, 2025 23:30

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResourceBuilder.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of AndriySvyryd December 11, 2025 23:47 View session

Copilot finished work on behalf of AndriySvyryd December 11, 2025 23:55

Copilot AI requested a review from AndriySvyryd December 11, 2025 23:55

AndriySvyryd reviewed Dec 11, 2025

View reviewed changes

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationEventSubscriber.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of AndriySvyryd December 11, 2025 23:59 View session

Copilot AI requested a review from AndriySvyryd December 12, 2025 00:12

Copilot finished work on behalf of AndriySvyryd December 12, 2025 00:12

davidfowl reviewed Dec 12, 2025

View reviewed changes

AndriySvyryd reviewed Dec 12, 2025

View reviewed changes

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationEventSubscriber.cs Outdated Show resolved Hide resolved

React to PR feedback

fb648d8

Flatten EFMigrationsOptions

8b3df97

AndriySvyryd added 2 commits December 12, 2025 18:28

Fix tests

018f8eb

Fix assembly loading

2bbc7b6

Disable commands after adding a migration

47b87b9

AndriySvyryd reviewed Dec 16, 2025

View reviewed changes

AndriySvyryd marked this pull request as ready for review December 16, 2025 05:21

Copilot AI review requested due to automatic review settings December 16, 2025 05:21

Copilot started reviewing on behalf of AndriySvyryd December 16, 2025 05:21 View session

Copilot AI reviewed Dec 16, 2025

View reviewed changes

src/Aspire.Hosting.EntityFrameworkCore/README.md Outdated Show resolved Hide resolved

src/Aspire.Hosting.EntityFrameworkCore/EFMigrationHealthCheck.cs Outdated Show resolved Hide resolved

AndriySvyryd and others added 3 commits December 16, 2025 10:33

Update src/Aspire.Hosting.EntityFrameworkCore/README.md

0be4ecf

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/Aspire.Hosting.EntityFrameworkCore/EFMigrationHealthCheck.cs

d4d3447

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix test

87f29c1

Add Aspire.Hosting.EntityFrameworkCore hosting integration for EF Core migration management #13481

Are you sure you want to change the base?

Add Aspire.Hosting.EntityFrameworkCore hosting integration for EF Core migration management #13481

Conversation

Copilot AI commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Key Features

Checklist

High-level feature outline

Uh oh!

AndriySvyryd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Dec 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidfowl Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

AndriySvyryd Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndriySvyryd commented Dec 13, 2025

Uh oh!

AndriySvyryd commented Dec 16, 2025

Uh oh!

AndriySvyryd Dec 16, 2025

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!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Dec 10, 2025 •

edited

Loading

github-actions bot commented Dec 12, 2025 •

edited

Loading