feat(db): implement options pattern for database connection strings chapter 2

Author: kamilbaczek

Chapter-2-modules-separation/Src/Contracts/Fitnet.Contracts.Infrastructure/Database/ContractsPersistenceOptions.cs

@@ -0,0 +1,11 @@
+namespace EvolutionaryArchitecture.Fitnet.Contracts.Infrastructure.Database;
+
+using System.ComponentModel.DataAnnotations;
+
+internal sealed class ContractsPersistenceOptions
+{
+    public const string SectionName = "Modules:Contracts:ConnectionStrings";
+
+    [Required]
+    public string Primary { get; init; } = string.Empty;
+}

Chapter-2-modules-separation/Src/Contracts/Fitnet.Contracts.Infrastructure/Database/DatabaseModule.cs

@@ -4,16 +4,23 @@ namespace EvolutionaryArchitecture.Fitnet.Contracts.Infrastructure.Database;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 using Repositories;
 
 internal static class DatabaseModule
 {
-    private const string ConnectionStringConfigurationSection = "Modules:Contracts:ConnectionStrings:Primary";
-
     internal static IServiceCollection AddDatabase(this IServiceCollection services, IConfiguration configuration)
     {
-        var connectionString = configuration.GetSection(ConnectionStringConfigurationSection).Value;
-        services.AddDbContext<ContractsPersistence>(options => options.UseNpgsql(connectionString));
+        services.Configure<ContractsPersistenceOptions>(configuration.GetSection(ContractsPersistenceOptions.SectionName));
+        services.AddOptionsWithValidateOnStart<ContractsPersistenceOptions>();
+
+        services.AddDbContext<ContractsPersistence>((serviceProvider, options) =>
+        {
+            var persistenceOptions = serviceProvider.GetRequiredService<IOptions<ContractsPersistenceOptions>>();
+            var connectionString = persistenceOptions.Value.Primary;
+            options.UseNpgsql(connectionString);
+        });
+
         services.AddRepositories();
 
         return services;

Chapter-2-modules-separation/Src/Offers/Fitnet.Offers.DataAccess/Database/DatabaseModule.cs

@@ -4,15 +4,21 @@ namespace EvolutionaryArchitecture.Fitnet.Offers.DataAccess.Database;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 
 internal static class DatabaseModule
 {
-    private const string ConnectionStringConfigurationSection = "Modules:Offers:ConnectionStrings:Primary";
-
     internal static IServiceCollection AddDatabase(this IServiceCollection services, IConfiguration configuration)
     {
-        var connectionString = configuration.GetSection(ConnectionStringConfigurationSection).Value;
-        services.AddDbContext<OffersPersistence>(options => options.UseNpgsql(connectionString));
+        services.Configure<OffersPersistenceOptions>(configuration.GetSection(OffersPersistenceOptions.SectionName));
+        services.AddOptionsWithValidateOnStart<OffersPersistenceOptions>();
+
+        services.AddDbContext<OffersPersistence>((serviceProvider, options) =>
+        {
+            var persistenceOptions = serviceProvider.GetRequiredService<IOptions<OffersPersistenceOptions>>();
+            var connectionString = persistenceOptions.Value.Primary;
+            options.UseNpgsql(connectionString);
+        });
 
         return services;
     }

Chapter-2-modules-separation/Src/Offers/Fitnet.Offers.DataAccess/Database/OffersPersistenceOptions.cs

@@ -0,0 +1,11 @@
+namespace EvolutionaryArchitecture.Fitnet.Offers.DataAccess.Database;
+
+using System.ComponentModel.DataAnnotations;
+
+internal sealed class OffersPersistenceOptions
+{
+    public const string SectionName = "Modules:Offers:ConnectionStrings";
+
+    [Required]
+    public string Primary { get; init; } = string.Empty;
+}

Chapter-2-modules-separation/Src/Offers/Fitnet.Offers.DataAccess/Fitnet.Offers.DataAccess.csproj

@@ -1,4 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
+    <ItemGroup>
+      <FrameworkReference Include="Microsoft.AspNetCore.App"/>
+    </ItemGroup>
     <ItemGroup>
         <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
         <PackageReference Include="Microsoft.EntityFrameworkCore" Version="9.0.0" />

Chapter-2-modules-separation/Src/Passes/Fitnet.Passes.DataAccess/Database/DatabaseModule.cs

@@ -4,15 +4,21 @@ namespace EvolutionaryArchitecture.Fitnet.Passes.DataAccess.Database;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 
 internal static class DatabaseModule
 {
-    private const string ConnectionStringConfigurationSection = "Modules:Passes:ConnectionStrings:Primary";
-
     internal static IServiceCollection AddDatabase(this IServiceCollection services, IConfiguration configuration)
     {
-        var connectionString = configuration.GetRequiredSection(ConnectionStringConfigurationSection).Value;
-        services.AddDbContext<PassesPersistence>(options => options.UseNpgsql(connectionString));
+        services.Configure<PassesPersistenceOptions>(configuration.GetSection(PassesPersistenceOptions.SectionName));
+        services.AddOptionsWithValidateOnStart<PassesPersistenceOptions>();
+
+        services.AddDbContext<PassesPersistence>((serviceProvider, options) =>
+        {
+            var persistenceOptions = serviceProvider.GetRequiredService<IOptions<PassesPersistenceOptions>>();
+            var connectionString = persistenceOptions.Value.Primary;
+            options.UseNpgsql(connectionString);
+        });
 
         return services;
     }

Chapter-2-modules-separation/Src/Passes/Fitnet.Passes.DataAccess/Database/PassesPersistenceOptions.cs

@@ -0,0 +1,11 @@
+namespace EvolutionaryArchitecture.Fitnet.Passes.DataAccess.Database;
+
+using System.ComponentModel.DataAnnotations;
+
+internal sealed class PassesPersistenceOptions
+{
+    public const string SectionName = "Modules:Passes:ConnectionStrings";
+
+    [Required]
+    public string Primary { get; init; } = string.Empty;
+}

Chapter-2-modules-separation/Src/Passes/Fitnet.Passes.DataAccess/Fitnet.Passes.DataAccess.csproj

@@ -1,4 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
+  <ItemGroup>
+    <FrameworkReference Include="Microsoft.AspNetCore.App"/>
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="9.0.0" />

Chapter-2-modules-separation/Src/Reports/Fitnet.Reports/DataAccess/DatabaseAccessModule.cs

@@ -1,13 +1,17 @@
 namespace EvolutionaryArchitecture.Fitnet.Reports.DataAccess;
 
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
 internal static class DatabaseAccessModule
 {
-    internal static IServiceCollection AddDataAccess(this IServiceCollection services)
+    internal static IServiceCollection AddDataAccess(this IServiceCollection services, IConfiguration configuration)
     {
+        services.Configure<ReportsPersistenceOptions>(configuration.GetSection(ReportsPersistenceOptions.SectionName));
+        services.AddOptionsWithValidateOnStart<ReportsPersistenceOptions>();
+
         services.AddSingleton<IDatabaseConnectionFactory, DatabaseConnectionFactory>();
 
         return services;
     }
-}
+}

Chapter-2-modules-separation/Src/Reports/Fitnet.Reports/DataAccess/DatabaseConnectionFactory.cs

@@ -1,13 +1,12 @@
 namespace EvolutionaryArchitecture.Fitnet.Reports.DataAccess;
 
-using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
 using System.Data;
 using System.Diagnostics.CodeAnalysis;
 using Npgsql;
 
-internal sealed class DatabaseConnectionFactory(IConfiguration configuration) : IDatabaseConnectionFactory
+internal sealed class DatabaseConnectionFactory(IOptions<ReportsPersistenceOptions> persistenceOptions) : IDatabaseConnectionFactory
 {
-    private const string ConnectionStringConfigurationSection = "Modules:Reports:ConnectionStrings:Primary";
     private NpgsqlConnection? _connection;
 
     public IDbConnection Create()
@@ -17,9 +16,8 @@ public IDbConnection Create()
             return _connection;
         }
 
-        var connectionString = configuration.GetRequiredSection(ConnectionStringConfigurationSection).Value;
-        _connection =
-            new NpgsqlConnection(connectionString);
+        var connectionString = persistenceOptions.Value.Primary;
+        _connection = new NpgsqlConnection(connectionString);
         _connection.Open();
 
         return _connection;