Skip to content

Commit ff0601e

Browse files
Copilotaaronpowell
authored and
FullStackChef
committed
Feature: Add EnrichSqliteDatabaseDbContext extension method for WebApplicationBuilder (CommunityToolkit#837)
* Initial plan * Add EnrichSqliteDatabaseDbContext extension method for WebApplicationBuilder Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> * Complete EnrichSqliteDatabaseDbContext with OpenTelemetry support Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> * Add documentation and complete test coverage for EnrichSqliteDatabaseDbContext Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> * Aligning properly with the aspire implementations --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com> Co-authored-by: Aaron Powell <me@aaron-powell.com>
1 parent 77641db commit ff0601e

File tree

7 files changed

+181
-6
lines changed

7 files changed

+181
-6
lines changed

‎Directory.Build.props‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<AspireAppHostSdkVersion>$(AspireVersion)</AspireAppHostSdkVersion>
1717
<AspNetCoreVersion>9.0.0</AspNetCoreVersion>
1818
<DotNetExtensionsVersion>9.0.4</DotNetExtensionsVersion>
19-
<OpenTelemetryVersion>1.11.1</OpenTelemetryVersion>
19+
<OpenTelemetryVersion>1.12.0</OpenTelemetryVersion>
2020
<TestContainersVersion>4.4.0</TestContainersVersion>
2121
<MEAIVersion>9.5.0</MEAIVersion>
2222
<IsPackable>false</IsPackable>

‎Directory.Packages.props‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
<PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="$(OpenTelemetryVersion)" />
5454
<PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="$(OpenTelemetryVersion)" />
5555
<PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="$(OpenTelemetryVersion)" />
56+
<PackageVersion Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" Version="1.12.0-beta.2" />
5657
<PackageVersion Include="OpenTelemetry.Instrumentation.Http" Version="$(OpenTelemetryVersion)" />
5758
<PackageVersion Include="OpenTelemetry.Instrumentation.Runtime" Version="$(OpenTelemetryVersion)" />
5859
<PackageVersion Include="OpenTelemetry.Exporter.InMemory" Version="$(OpenTelemetryVersion)" />

‎src/CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite/AspireEFSqliteExtensions.cs‎

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
using Aspire;
22
using Microsoft.EntityFrameworkCore;
3-
using Microsoft.EntityFrameworkCore.Diagnostics.Internal;
43
using Microsoft.Extensions.Configuration;
54
using Microsoft.Extensions.DependencyInjection;
5+
using OpenTelemetry.Trace;
66
using System.Diagnostics.CodeAnalysis;
77

88
namespace Microsoft.Extensions.Hosting;
@@ -58,10 +58,7 @@ public static class AspireEFSqliteExtensions
5858

5959
builder.Services.AddDbContextPool<TContext>(ConfigureDbContext);
6060

61-
if (!settings.DisableHealthChecks)
62-
{
63-
builder.TryAddHealthCheck(name: typeof(TContext).Name, static hcBuilder => hcBuilder.AddDbContextCheck<TContext>());
64-
}
61+
ConfigureInstrumentation<TContext>(builder, settings);
6562

6663
void ConfigureDbContext(DbContextOptionsBuilder dbContextOptionsBuilder)
6764
{
@@ -72,4 +69,72 @@ void ConfigureDbContext(DbContextOptionsBuilder dbContextOptionsBuilder)
7269
configureDbContextOptions?.Invoke(dbContextOptionsBuilder);
7370
}
7471
}
72+
73+
/// <summary>
74+
/// Enriches a <see cref="IHostApplicationBuilder"/> to register the <typeparamref name="TDbContext"/> as a scoped service
75+
/// with simplified configuration and optional OpenTelemetry instrumentation.
76+
/// </summary>
77+
/// <typeparam name="TDbContext">The type of the <see cref="DbContext"/>.</typeparam>
78+
/// <param name="builder">The <see cref="IHostApplicationBuilder"/> to read config from and add services to.</param>
79+
/// <param name="configureSettings">An optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration.</param>
80+
/// <exception cref="ArgumentNullException">Thrown if mandatory <paramref name="builder"/> is null.</exception>
81+
public static void EnrichSqliteDatabaseDbContext<[DynamicallyAccessedMembers(RequiredByEF)] TDbContext>(
82+
this IHostApplicationBuilder builder,
83+
Action<SqliteEntityFrameworkCoreSettings>? configureSettings = null)
84+
where TDbContext : DbContext
85+
{
86+
ArgumentNullException.ThrowIfNull(builder);
87+
88+
var settings = builder.GetDbContextSettings<TDbContext, SqliteEntityFrameworkCoreSettings>(
89+
DefaultConfigSectionName,
90+
null,
91+
(settings, section) => section.Bind(settings)
92+
);
93+
94+
configureSettings?.Invoke(settings);
95+
96+
builder.Services.AddDbContext<TDbContext>(options =>
97+
options.UseSqlite(settings.ConnectionString));
98+
ConfigureInstrumentation<TDbContext>(builder, settings);
99+
}
100+
101+
private static void ConfigureInstrumentation<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties)] TDbContext>(IHostApplicationBuilder builder, SqliteEntityFrameworkCoreSettings settings) where TDbContext : DbContext
102+
{
103+
if (!settings.DisableTracing)
104+
{
105+
builder.Services.AddOpenTelemetry()
106+
.WithTracing(tracing => tracing
107+
.AddEntityFrameworkCoreInstrumentation());
108+
}
109+
110+
if (!settings.DisableHealthChecks)
111+
{
112+
builder.TryAddHealthCheck(
113+
name: typeof(TDbContext).Name,
114+
static hcBuilder => hcBuilder.AddDbContextCheck<TDbContext>());
115+
}
116+
}
117+
118+
internal static TSettings GetDbContextSettings<TContext, TSettings>(this IHostApplicationBuilder builder, string defaultConfigSectionName, string? connectionName, Action<TSettings, IConfiguration> bindSettings)
119+
where TSettings : new()
120+
{
121+
TSettings settings = new();
122+
var configurationSection = builder.Configuration.GetSection(defaultConfigSectionName);
123+
bindSettings(settings, configurationSection);
124+
// If the connectionName is not provided, we've been called in the context
125+
// of an Enrich invocation and don't need to bind the connectionName specific settings.
126+
// Instead, we'll just bind to the TContext-specific settings.
127+
if (connectionName is not null)
128+
{
129+
var connectionSpecificConfigurationSection = configurationSection.GetSection(connectionName);
130+
bindSettings(settings, connectionSpecificConfigurationSection);
131+
}
132+
var typeSpecificConfigurationSection = configurationSection.GetSection(typeof(TContext).Name);
133+
if (typeSpecificConfigurationSection.Exists()) // https://github.com/dotnet/runtime/issues/91380
134+
{
135+
bindSettings(settings, typeSpecificConfigurationSection);
136+
}
137+
138+
return settings;
139+
}
75140
}

‎src/CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite/CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite.csproj‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks.EntityFrameworkCore" />
1212
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
1313
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
14+
<PackageReference Include="OpenTelemetry.Extensions.Hosting" />
15+
<PackageReference Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" />
1416
</ItemGroup>
1517

1618
<ItemGroup>

‎src/CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,36 @@ dotnet add package CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite
1919

2020
### Example usage
2121

22+
#### Option 1: Using IHostApplicationBuilder (Traditional Aspire Pattern)
23+
2224
In the _Program.cs_ file of your project, call the `AddSqliteDbContext<TDbContext>` extension method to register the `TDbContext` implementation in the DI container. This method takes the connection name as a parameter:
2325

2426
```csharp
2527
builder.AddSqliteDbContext<BloggingContext>("sqlite");
2628
```
2729

30+
#### Option 2: Using WebApplicationBuilder (New Simplified Pattern)
31+
32+
For ASP.NET Core applications, you can use the simplified `EnrichSqliteDatabaseDbContext<TDbContext>` extension method:
33+
34+
```csharp
35+
// Basic usage with default connection string name "DefaultConnection"
36+
builder.EnrichSqliteDatabaseDbContext<BloggingContext>();
37+
38+
// With custom connection string name
39+
builder.EnrichSqliteDatabaseDbContext<BloggingContext>("MyConnection");
40+
41+
// Disable OpenTelemetry instrumentation
42+
builder.EnrichSqliteDatabaseDbContext<BloggingContext>(enableOpenTelemetry: false);
43+
```
44+
45+
The `EnrichSqliteDatabaseDbContext` method provides:
46+
47+
- **Simplified API**: Works directly with `WebApplicationBuilder`
48+
- **Default connection string**: Uses "DefaultConnection" by default
49+
- **OpenTelemetry integration**: Automatically adds EF Core instrumentation for distributed tracing
50+
- **Parameter validation**: Proper error handling for missing connection strings
51+
2852
Then, in your service, inject `TDbContext` and use it to interact with the database:
2953

3054
```csharp
@@ -42,3 +66,4 @@ public class MyService(BloggingContext context)
4266
## Feedback & contributing
4367

4468
https://github.com/CommunityToolkit/Aspire
69+

‎src/CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite/SqliteEntityFrameworkCoreSettings.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,10 @@ public sealed class SqliteEntityFrameworkCoreSettings
2222
/// Gets or sets the default timeout for the database operations.
2323
/// </summary>
2424
public int DefaultTimeout { get; set; }
25+
26+
/// <summary>
27+
/// Gets or sets a boolean value that indicates whether tracing is disabled or not.
28+
/// </summary>
29+
public bool DisableTracing { get; set; }
30+
2531
}

‎tests/CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite.Tests/EnrichSqliteDatabaseDbContextTests.cs‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
using Microsoft.AspNetCore.Builder;
2+
using Microsoft.EntityFrameworkCore;
3+
using Microsoft.Extensions.Configuration;
4+
using Microsoft.Extensions.DependencyInjection;
5+
using Microsoft.Extensions.Hosting;
6+
7+
namespace CommunityToolkit.Aspire.Microsoft.EntityFrameworkCore.Sqlite.Tests;
8+
9+
public class EnrichSqliteDatabaseDbContextTests
10+
{
11+
[Fact]
12+
public void EnrichSqliteDatabaseDbContext_RegistersDbContext()
13+
{
14+
// Arrange
15+
var builder = WebApplication.CreateBuilder();
16+
builder.Configuration.AddInMemoryCollection([
17+
new KeyValuePair<string, string?>("ConnectionStrings:DefaultConnection", "Data Source=:memory:")
18+
]);
19+
20+
// Act
21+
builder.EnrichSqliteDatabaseDbContext<TestDbContext>();
22+
23+
// Assert
24+
var app = builder.Build();
25+
var dbContext = app.Services.GetRequiredService<TestDbContext>();
26+
Assert.NotNull(dbContext);
27+
}
28+
29+
[Fact]
30+
public void EnrichSqliteDatabaseDbContext_ThrowsWhenBuilderIsNull()
31+
{
32+
// Act & Assert
33+
Assert.Throws<ArgumentNullException>(() =>
34+
AspireEFSqliteExtensions.EnrichSqliteDatabaseDbContext<TestDbContext>(null!));
35+
}
36+
37+
[Fact]
38+
public void EnrichSqliteDatabaseDbContext_DisablesOpenTelemetryWhenFalse()
39+
{
40+
// Arrange
41+
var builder = WebApplication.CreateBuilder();
42+
builder.Configuration.AddInMemoryCollection([
43+
new KeyValuePair<string, string?>("ConnectionStrings:DefaultConnection", "Data Source=:memory:")
44+
]);
45+
46+
// Act
47+
builder.EnrichSqliteDatabaseDbContext<TestDbContext>(settings => settings.DisableTracing = true);
48+
49+
// Assert - The test passes if no exceptions are thrown and DbContext is registered
50+
var app = builder.Build();
51+
var dbContext = app.Services.GetRequiredService<TestDbContext>();
52+
Assert.NotNull(dbContext);
53+
}
54+
55+
[Fact]
56+
public void EnrichSqliteDatabaseDbContext_EnablesOpenTelemetryByDefault()
57+
{
58+
// Arrange
59+
var builder = WebApplication.CreateBuilder();
60+
builder.Configuration.AddInMemoryCollection([
61+
new KeyValuePair<string, string?>("ConnectionStrings:DefaultConnection", "Data Source=:memory:")
62+
]);
63+
64+
// Act
65+
builder.EnrichSqliteDatabaseDbContext<TestDbContext>(settings => settings.DisableTracing = false);
66+
67+
// Assert - The test passes if no exceptions are thrown and OpenTelemetry services are registered
68+
var app = builder.Build();
69+
var dbContext = app.Services.GetRequiredService<TestDbContext>();
70+
Assert.NotNull(dbContext);
71+
72+
// Verify OpenTelemetry services are registered (basic smoke test)
73+
var services = app.Services.GetServices<IHostedService>().ToList();
74+
Assert.True(services.Count > 0, "Services should be registered");
75+
}
76+
}

0 commit comments

Comments
 (0)