Where to put your initialization steps in ASP.NET Core Web Api?

user_5639688 0
Viewed 2689

If you familiar with production code you always encounter logic which needs to be invoked before anything should be requested/processed in your service.

I personally wrap it up into something like this and invoke it from DI framework:

public interface IMigrator
{
    Task UpdateAsync();
}

For example:

  • database migration from code
  • static cache initializations
  • seed apply to database
  • authentication of root account,
  • ...

I'm not so proficient with Web API framework at the moment and need to know, where should one put that logic? In Startup.Configure? Is it appropriate? How things turn out if it takes, say 10 minutes?

Need your advise:

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services
            .AddControllers();
            services.Register(new CoreModule(), new DataModule());
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseHttpsRedirection();

        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "api",
                pattern: "api/v1/{controller}/{action}/{id?}");
        });

        //<- somewhere here? does it break some startup logic in IIS like winservices does when process takes longer than 1 minute?
        await _migrator.UpdateAsync();
    }
}

EDIT:

Found related article which describes how one should do initialization and where. And how to do this asynchronous - https://andrewlock.net/running-async-tasks-on-app-startup-in-asp-net-core-part-1/

asp.net-core-webapi docker iis-express c#
2 Answers

Found answer in link above. We can use IHostedService interface starting from .Net Core 3.0 especially for those tasks. Important note is that lower versions IS NOT SUITABLE, because they are not waiting StartAsync methods to complete before serving user requests:

internal sealed class Boot : IHostedService
{
   public Task StartAsync(CancellationToken token){
       //migrate db or whatever here
   }

   public Task StopAsync(CancellationToken token){
       //gracefull shutdown for 5 sec, after which token will blowup. It will still wait for method return.
   }
}

Then register it in your DI and Configure method:

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddSingleton<IBoot, Boot>();
        services.AddHostedService(x=> x.GetService<IBoot>());
    }

The pros:

  • No woo-doo magic with async wait in sync context. Everything async/cancellable, non-deadlocking.
  • It has gracefull shutdown, in case you hold some unmanaged or other resources in your initialization that needs to be disposed.
  • It has full support of Dependency Injection.

The cons:

  • StopAsync will not be invoked on exceptions. Be cautios, use Dispose too.
  • Watch for version of framework, accidental switch to lower version will cause you world of pain.
user_56396880

To answer your question, I am giving an example for applying migration on startup. you can use the same concept.

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<DataContext>(x => x.UseSqlite("Data Source=LocalDatabase.db"));

    ...
}

An instance of the EF Core DB Context service to be injected as a parameter into the Configure() method.

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env, DataContext dataContext)
{
    // migrate any database changes on startup (includes initial db creation)
    dataContext.Database.Migrate();

    ...
}
user_65270490
Related