Round #719

Implement schema migration on startup using IHostedService that runs DbContext.Database.MigrateAsync before the host accepts traffic.

**Schema Migration using IHostedService** ====================================== To implement schema migration on startup using `IHostedService`, you can create a hosted service that runs `DbContext.Database.MigrateAsync` before the host accepts traffic. **MigrationHostedService.cs** ```csharp using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Hosting; using System.Threading; using System.Threading.Tasks; public class MigrationHostedService : IHostedService { private readonly DbContext _dbContext; public MigrationHostedService(DbContext dbContext) { _dbContext = dbContext; } public async Task StartAsync(CancellationToken cancellationToken) { await _dbContext.Database.MigrateAsync(cancellationToken); } public Task StopAsync(CancellationToken cancellationToken) { return Task.CompletedTask; } } ``` **Program.cs** ```csharp using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; public class Program { public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); }); } ``` **Startup.cs** ```csharp using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } public void ConfigureServices(IServiceCollection services) { services.AddDbContext<MyDbContext>(options => options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection"))); services.AddHostedService<MigrationHostedService>(); services.AddControllers(); } public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseRouting(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); } } ``` **MyDbContext.cs** ```csharp using Microsoft.EntityFrameworkCore; public class MyDbContext : DbContext { public MyDbContext(DbContextOptions<MyDbContext> options) : base(options) { } public DbSet<MyEntity> MyEntities { get; set; } } ``` In this example, `MigrationHostedService` is a hosted service that runs `DbContext.Database.MigrateAsync` when the application starts. The `MyDbContext` is registered in the `Startup.cs` file, and the `MigrationHostedService` is added to the services collection. When the application starts, the `MigrationHostedService` will run `DbContext.Database.MigrateAsync` before the host accepts traffic, ensuring that the database schema is up-to-date. **Note:** Make sure to replace `MyDbContext` and `MyEntity` with your actual DbContext and entity classes. **Example Use Case:** 1. Create a new ASP.NET Core Web API project. 2. Install the `Microsoft.EntityFrameworkCore` and `Microsoft.EntityFrameworkCore.SqlServer` NuGet packages. 3. Create a new DbContext class (e.g., `MyDbContext.cs`) and add your entity classes. 4. Create a new hosted service class (e.g., `MigrationHostedService.cs`) and add the code above. 5. Register the DbContext and hosted service in the `Startup.cs` file. 6. Run the application and verify that the database schema is migrated correctly.

Here's a complete implementation of schema migration on startup using `IHostedService`: ```csharp using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; using System.Threading; using System.Threading.Tasks; public class DatabaseMigrationService : IHostedService { private readonly ILogger<DatabaseMigrationService> _logger; private readonly IServiceProvider _services; public DatabaseMigrationService(ILogger<DatabaseMigrationService> logger, IServiceProvider services) { _logger = logger; _services = services; } public async Task StartAsync(CancellationToken cancellationToken) { using var scope = _services.CreateScope(); var dbContext = scope.ServiceProvider.GetRequiredService<YourDbContext>(); try { await dbContext.Database.MigrateAsync(cancellationToken); _logger.LogInformation("Database migration completed successfully."); } catch (Exception ex) { _logger.LogError(ex, "Error migrating database."); throw; } } public Task StopAsync(CancellationToken cancellationToken) { return Task.CompletedTask; } } public static class DatabaseMigrationServiceExtensions { public static void AddDatabaseMigration(this IServiceCollection services) { services.AddHostedService<DatabaseMigrationService>(); } } ``` In the above code: * We create a `DatabaseMigrationService` class that implements `IHostedService`. * In the `StartAsync` method, we create a scope to resolve the `YourDbContext` instance. * We then call `MigrateAsync` on the database to apply any pending migrations. * If an exception occurs during migration, we log the error and rethrow the exception to prevent the host from starting. * We also provide an extension method `AddDatabaseMigration` to register the `DatabaseMigrationService` as a hosted service in the DI container. To use this service, you would add the following line to your `Startup.cs` file in the `ConfigureServices` method: ```csharp services.AddDatabaseMigration(); ``` Replace `YourDbContext` with the actual name of your DbContext class. This implementation ensures that database migrations are applied before the host starts accepting traffic, providing a robust and reliable way to manage schema changes in your application. **Explanation:** * The `DatabaseMigrationService` class is designed to run as a hosted service, which allows it to execute before the host starts accepting traffic. * By using `IHostedService`, we can ensure that the migration process completes before the application becomes available. * The `StartAsync` method is where the migration logic is executed. It creates a scope to resolve the DbContext instance and then applies any pending migrations using `MigrateAsync`. * Error handling is implemented to catch and log any exceptions that occur during migration. If an exception occurs, the host will not start, ensuring that the application does not become available with an inconsistent database state. * The `AddDatabaseMigration` extension method provides a convenient way to register the `DatabaseMigrationService` as a hosted service in the DI container.