Search code examples
c#asp.net-coreasp.net-core-mvcbackground-processdnx

Alternative solution to HostingEnvironment.QueueBackgroundWorkItem in .NET Core


We are working with .NET Core Web Api, and looking for a lightweight solution to log requests with variable intensity into database, but don't want client's to wait for the saving process.
Unfortunately there's no HostingEnvironment.QueueBackgroundWorkItem(..) implemented in dnx, and Task.Run(..) is not safe.
Is there any elegant solution?


Solution

  • QueueBackgroundWorkItem is gone, but we've got IApplicationLifetime instead of IRegisteredObject, which is being used by the former one. And it looks quite promising for such scenarios, I think.

    The idea (and I'm still not quite sure, if it's a pretty bad one; thus, beware!) is to register a singleton, which spawns and observes new tasks. Within that singleton we can furthermore register a "stopped event" in order to proper await still running tasks.

    This "concept" could be used for short running stuff like logging, mail sending, and the like. Things, that should not take much time, but would produce unnecessary delays for the current request.

    public class BackgroundPool
    {
        protected ILogger<BackgroundPool> Logger { get; }
    
        public BackgroundPool(ILogger<BackgroundPool> logger, IApplicationLifetime lifetime)
        {
            if (logger == null)
                throw new ArgumentNullException(nameof(logger));
            if (lifetime == null)
                throw new ArgumentNullException(nameof(lifetime));
    
            lifetime.ApplicationStopped.Register(() =>
            {
                lock (currentTasksLock)
                {
                    Task.WaitAll(currentTasks.ToArray());
                }
    
                logger.LogInformation(BackgroundEvents.Close, "Background pool closed.");
            });
    
            Logger = logger;
        }
    
        private readonly object currentTasksLock = new object();
    
        private readonly List<Task> currentTasks = new List<Task>();
    
        public void SendStuff(Stuff whatever)
        {
            var task = Task.Run(async () =>
            {
                Logger.LogInformation(BackgroundEvents.Send, "Sending stuff...");
    
                try
                {
                    // do THE stuff
    
                    Logger.LogInformation(BackgroundEvents.SendDone, "Send stuff returns.");
                }
                catch (Exception ex)
                {
                    Logger.LogError(BackgroundEvents.SendFail, ex, "Send stuff failed.");
                }
            });
    
            lock (currentTasksLock)
            {
                currentTasks.Add(task);
    
                currentTasks.RemoveAll(t => t.IsCompleted);
            }
        }
    }
    

    Such a BackgroundPool should be registered as a singleton and can be used by any other component via DI. I'm currently using it for sending mails and it works fine (tested mail sending during app shutdown too).

    Note: accessing stuff like the current HttpContext within the background task should not work. The old solution uses UnsafeQueueUserWorkItem to prohibit that anyway.

    What do you think?

    Update:

    With ASP.NET Core 2.0 there's new stuff for background tasks, which get's better with ASP.NET Core 2.1: Implementing background tasks in .NET Core 2.x webapps or microservices with IHostedService and the BackgroundService class