How to handle EF DbContexts with non standard constructor?

[Kralizek]

I am instrumenting an application based on EF with Aspire. The DbContexts of the application have constructors with non standard signature (either parameterless or with parameters that are not DbContextOptions and Aspire doesn't seem to like it very much.

Unhandled exception. System.InvalidOperationException: The DbContext of type 'IdentityServerOperationalContext' cannot be pooled because it does not have a public constructor accepting a single parameter of type DbContextOptions or has more than one constructor.
   at Microsoft.EntityFrameworkCore.Internal.DbContextPool`1.CreateActivator(DbContextOptions`1 options, IServiceProvider serviceProvider)

As you can imagine from the log entry above, the application is using Duende's Identity Server to handle users.

[davidfowl]

Can you show the API you are using? Are you using the Enrich methods https://learn.microsoft.com/en-us/dotnet/aspire/whats-new/preview-4#new-enrich-methods?

[Kralizek]

I was using the classic AddSqlServerDbContext<TContext>.

builder.AddSqlServerDbContext<IdentityServerConfigurationContext>("Database", ConfigureSqlServerSettings, ConfigureDbContextOptions);

static void ConfigureDbContextOptions(DbContextOptionsBuilder builder)
{
    builder.UseSqlServer(sql => sql.MigrationsAssembly(MigrationAssemblyName).EnableRetryOnFailure());
}

static void ConfigureSqlServerSettings(MicrosoftEntityFrameworkCoreSqlServerSettings settings)
{
}

I knew about the new Enrich APIs but I failed to connect them to the issue I am having. I will give it a try as soon I can spend more on the Aspire spike I'm running.

Thanks a lot!

[TheMagnificent11]

Enrich new methods no longer appears to be a anchor in this page 🤷

I've got an abstract DbContext class that looks like this (takes an extra IAuthenticatedUserService arg in the constructor to use with two of the DB interceptors it sets up).

public abstract class ApplicationDbContext<TContext> : DbContext, IApplicationDbContext
    where TContext : DbContext, IApplicationDbContext
{
    private readonly IAuthenticatedUserService authenticatedUserService;

    public ApplicationDbContext(
        DbContextOptions<TContext> options,
        IAuthenticatedUserService authenticatedUserService)
        : base(options)
    {
        this.authenticatedUserService = authenticatedUserService;
    }

    public DbSet<DomainEventReference>? DomainEventReferences { get; internal set; }
    public DbSet<QueryProjectionReference>? QueryProjectionReferences { get; internal set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        modelBuilder.ApplyConfiguration(new DomainEventReferenceConfiguration());
        modelBuilder.ApplyConfiguration(new QueryProjectionReferenceConfiguration());

        this.ConfigureDatabaseModel(modelBuilder);
    }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        base.OnConfiguring(optionsBuilder);

        optionsBuilder.AddInterceptors(new AuditDetailsSaveChangesInterceptor(this.authenticatedUserService));
        optionsBuilder.AddInterceptors(new DomainEventSaveChangesInterceptor<TContext>(this.authenticatedUserService));
    }

    protected abstract void ConfigureDatabaseModel(ModelBuilder modelBuilder);
}

And then an implementation of that abstract class that looks like this.

public sealed class PizzeriaDbContext : ApplicationDbContext<PizzeriaDbContext>
{
    public PizzeriaDbContext(
        DbContextOptions<PizzeriaDbContext> options,
        IAuthenticatedUserService authenticatedUserService)
        : base(options, authenticatedUserService)
    {
    }

    public DbSet<Pizza> Pizzas { get; set; }

    public DbSet<Order> Orders { get; set; }

    protected override void ConfigureDatabaseModel(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        modelBuilder.ApplyConfigurationsFromAssembly(typeof(PizzeriaDbContext).Assembly);
    }
}

I'm trying use Aspire Postgres in my service to add the DB context like this.

var builder = WebApplication.CreateBuilder(args);

builder.AddServiceDefaults();

builder.AddNpgsqlDbContext<PizzeriaDbContext>(ServiceNames.PizzaStoreDatabase);

I get the following error.

The type 'Aspire.Pizzeria.Data.PizzeriaDbContext' cannot be used as type parameter 'TContext' in the generic type or method 'AspireEFPostgreSqlExtensions.AddNpgsqlDbContext<TContext>(IHostApplicationBuilder, string, Action<NpgsqlEntityFrameworkCorePostgreSQLSettings>?, Action<DbContextOptionsBuilder>?)'. There is no implicit reference conversion from 'Aspire.Pizzeria.Data.PizzeriaDbContext' to 'Microsoft.EntityFrameworkCore.DbContext'.

I guess there's a way to enrich the AddNpgsqlDbContext, but the documentation must have moved.

[davidfowl]

Luckily there's a whole new EF section under integrations https://learn.microsoft.com/en-us/dotnet/aspire/database/entity-framework-core-integration-overview?pivots=sql-server-ef

[TheMagnificent11]

Thanks