39

I have a Web API's action where I need to run some task and forget about this task. This is how my method is organized now:

public async Task<SomeType> DoSth() { await Task.Run(...); ..... //Do some other work } 

The thing is that obviously it stops at the await line waiting when it's done and only then continues the work. And I need to "fire and forget" Should I just call Task.Run() without any async-await?

0

7 Answers 7

40

And I need to "fire and forget"

I have a blog post that goes into details of several different approaches for fire-and-forget on ASP.NET.

In summary: first, try not to do fire-and-forget at all. It's almost always a bad idea. Do you really want to "forget"? As in, not care whether it completes successfully or not? Ignore any errors? Accept occasional "lost work" without any log notifications? Almost always, the answer is no, fire-and-forget is not the appropriate approach.

A reliable solution is to build a proper distributed architecture. That is, construct a message that represents the work to be done and queue that message to a reliable queue (e.g., Azure Queue, MSMQ, etc). Then have an independent backend that process that queue (e.g., Azure WebJob, Win32 service, etc).

Should I just call Task.Run() without any async-await?

No. This is the worst possible solution. If you must do fire-and-forget, and you're not willing to build a distributed architecture, then consider Hangfire. If that doesn't work for you, then at the very least you should register your cowboy background work with the ASP.NET runtime via HostingEnvironment.QueueBackgroundWorkItem or my ASP.NET Background Tasks library. Note that QBWI and AspNetBackgroundTasks are both unreliable solutions; they just minimize the chance that you'll lose work, not prevent it.

Sign up to request clarification or add additional context in comments.

16 Comments

Is Task.Run() acceptable if the fire and forget task is non-critical to the web api functioning? eg. looking up values for additional logging. Plus if I know the app pool won't recycle itself that often?
@sgarg: Why wouldn't you use HostingEnvironment.QueueBackgroundWorkItem? It's just as easy to use and at least a little safer than Task.Run. You still shouldn't use it for anything critical, but sure, unimportant work can go there. On a side note, you don't know how often the app pool will recycle - IIRC, it's every 19 hours by default, but ASP.NET will do it more often if it thinks your app isn't working right.
I don't like the sentiment that people are saying fire-and-forget is almost always a bad idea, but I do agree with the warning. In my case, I do requests and logging beforehand and the user is notified if the tasks succeeds, or a job lets them know if it fails. They can also check the status and be prohibited to continue if it did not succeed and they must try again. Why is that a bad idea? Just have the design in place to account for failures so they can be addressed.
@Mark: Fire-and-forget on ASP.NET is inherently unreliable. Your users may never get success or failure notifications for jobs that just disappear. Bottom line: ASP.NET recycles your process occasionally (waiting for existing requests to complete), so if your process is doing work outside of a request, it can just suddenly disappear.
@Mark: Sorry, that's exactly the scenario we're talking about here. The proper (read: only truly-reliable) solution is to use a reliable queue with an independent backend process. You could look into Hangfire, which tries to lower the bar to entry (with tradeoffs).
|
25

For fire and forget, use this

Task.Factory.StartNew(async () => { using (HttpClient client = new HttpClient()) { await client.PostAsync("http://localhost/api/action", new StringContent("")); } }); 

4 Comments

Thanks, at least an answer that is just to the point, all those others screaming about "don't do it" seem to not see the benefits
Ok, use it as an example, but please, don't create a new HttpClient instance everytime like this. Remember HttpClient is meant to be re-used as a singleton, or you may face socket exhaustion. For more information check these two blog posts: aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong nimaara.com/beware-of-the-net-httpclient
creating new HttpClient every time causes issues. learn.microsoft.com/en-us/dotnet/architecture/microservices/…. Also thread will be preempted by GC after controller scope is completed.
Why do you prefer Task.Factory.StartNew over Task.Run? The later is less cumbersome, and also it doesn't require passing an explicit scheduler like the former.
12

True fire and forget tasks can be difficult in asp.net as they can often die along with the request that they were created as part of.

If you are using 4.5.2+ then you can use QueueBackgroundWorkItem to run the task. By registering tasks via this method the AppDomain will try to delay shutting down until they have all completed but there can still be instances when they will be killed before they are completed. This is probably the simplest thing to do but worth reading into to see exactly what instances can cause jobs to be cancelled.

HostingEnvironment.QueueBackgroundWorkItem(async cancellationToken => { await Task.Run(...); }); 

There is an tool called hangfire that uses a persistent store to ensure that a task has completed and has built-in retry and error recording functionality. This is more for "background tasks" but does suit fire and forget. This is relatively easy to setup and offers a variety of backing stores, I can't recall the exact details but some require a license and some don't (like MSSQL).

2 Comments

fire and forget in ASP.NET WebForms and windows.close() ?
Why do tasks "die along with the request that they were created as part of"?
6

I use HangFire.

This is best for me.

An easy way to perform background processing in .NET and .NET Core applications. No Windows Service or separate process required.

Backed by persistent storage. Open and free for commercial use.

Comments

2

I agree with others that you should not just forget about your call. However, to answer your question, if you remove await from the Task.Run() line, the call will not be blocking as shown here

public async Task<SomeType> DoSth() { Task.Run(...); ..... //Do some other work while Task.Run() continues in parallel. } 

1 Comment

It's sometimes perfectly fine to forget about a call. For example if you are sending a heartbeat signal in an IOT app, you usually don't care about the response.
1

Never fire and forget, because then you won't get to see any errors, which makes for some very awkward troubleshooting if something goes wrong (having the task method do its own exception handling isn't guaranteed to work, because the task may not successfully start in the first place). Unless you really don't mind if the task does anything or not, but that's quite unusual (since, if you truly didn't care, why run the task in the first place)? At the very least, create your task with a continuation:

Task.Run(...) .ContinueWith(t => logException(t.Exception.GetBaseException()), TaskContinuationOptions.OnlyOnFaulted ) ; 

You can make this more sophisticated as your needs dictate.

In the specific case of a web API, you may actually want to wait for your background tasks to finish before you complete your request. If you don't, you're leaving stuff running in the background that may misrepresent how much load your service can really take, or even stop working altogether if clients fire too many requests and you don't do anything to throttle them. You can gather tasks up and issue an await Task.WhenAll(...) at the end to achieve that; this way, you can continue to do useful work while your background tasks plod away, but you don't return until everything's done.

1 Comment

I want to fire and forget because I have actions that can get the status of the process. It is not critical for me because the essential database updates are done first, and THEN the tasks are run. If the tasks fail, the user cannot continue because the database was not updated, and they will be asked to try again.
0

For invoking a fire and forget WebApi method, I used the following code to ensure that it returns an OK response. I my case, the bearer authorization token created at login is stored in a cookie:

... FireAndForget().Wait(); ... private async Task FireAndForget() { using (var httpClient = new HttpClient()) { HttpCookie cookie = this.Request.Cookies["AuthCookieName"]; var authToken = cookie["AuthTokenPropertyName"] as string; httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", authToken); using (var response = await httpClient.GetAsync("http://localhost/api/FireAndForgetApiMethodName")) { //will throw an exception if not successful response.EnsureSuccessStatusCode(); } } } 

2 Comments

This is not any kind of "FireAndForget" (other than the method is named such). This is actually a blocking call by using Wait().
In hindsight, I have to agree that I made a mistake.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.