new-worker

Create New Background Worker

Scaffold a hosted background service following .NET patterns.

Required Pattern

public sealed partial class {Name}Worker(
    IServiceScopeFactory scopeFactory,
    ILogger<{Name}Worker> logger) : BackgroundService
{
    private static readonly TimeSpan Interval = TimeSpan.FromMinutes(5);

    [LoggerMessage(Level = LogLevel.Information, Message = "{Name}Worker started — interval {Interval}")]
    partial void LogStarted(TimeSpan interval);

    [LoggerMessage(Level = LogLevel.Error, Message = "{Name}Worker iteration failed")]
    partial void LogIterationFailed(Exception ex);

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        LogStarted(Interval);
        using var timer = new PeriodicTimer(Interval);

        while (await timer.WaitForNextTickAsync(stoppingToken))
        {
            try
            {
                await using var scope = scopeFactory.CreateAsyncScope();
                var service = scope.ServiceProvider.GetRequiredService<I{Name}Service>();
                await service.ProcessAsync(stoppingToken);
            }
            catch (OperationCanceledException) when (stoppingToken.IsCancellationRequested)
            {
                break; // Graceful shutdown
            }
            catch (Exception ex)
            {
                LogIterationFailed(ex);
                // Don't rethrow — keep the worker alive
            }
        }
    }
}

Registration

// In Program.cs
builder.Services.AddHostedService<{Name}Worker>();
builder.Services.AddScoped<I{Name}Service, {Name}Service>();

Health Check Integration

public class {Name}HealthCheck(/* state */) : IHealthCheck
{
    public Task<HealthCheckResult> CheckHealthAsync(
        HealthCheckContext context, CancellationToken ct = default)
    {
        var lastRun = /* get last successful run time */;
        var isHealthy = DateTime.UtcNow - lastRun < TimeSpan.FromMinutes(15);
        return Task.FromResult(isHealthy
            ? HealthCheckResult.Healthy($"Last run: {lastRun}")
            : HealthCheckResult.Unhealthy($"Last run: {lastRun}"));
    }
}