HttpClient.GetAsync(…) never returns when using await/async

by

You are misusing the API.

Here’s the situation: in ASP.NET, only one thread can handle a request at a time. You can do some parallel processing if necessary (borrowing additional threads from the thread pool), but only one thread would have the request context (the additional threads do not have the request context).

This is managed by the ASP.NET SynchronizationContext.

By default, when you await a Task, the method resumes on a captured SynchronizationContext (or a captured TaskScheduler, if there is no SynchronizationContext). Normally, this is just what you want: an asynchronous controller action will await something, and when it resumes, it resumes with the request context.

So, here’s why test5 fails:

  • Test5Controller.Get executes AsyncAwait_GetSomeDataAsync (within the ASP.NET request context).
  • AsyncAwait_GetSomeDataAsync executes HttpClient.GetAsync (within the ASP.NET request context).
  • The HTTP request is sent out, and HttpClient.GetAsync returns an uncompleted Task.
  • AsyncAwait_GetSomeDataAsync awaits the Task; since it is not complete, AsyncAwait_GetSomeDataAsync returns an uncompleted Task.
  • Test5Controller.Get blocks the current thread until that Task completes.
  • The HTTP response comes in, and the Task returned by HttpClient.GetAsync is completed.
  • AsyncAwait_GetSomeDataAsync attempts to resume within the ASP.NET request context. However, there is already a thread in that context: the thread blocked in Test5Controller.Get.
  • Deadlock.

Here’s why the other ones work:

  • (test1, test2, and test3): Continuations_GetSomeDataAsync schedules the continuation to the thread pool, outside the ASP.NET request context. This allows the Task returned by Continuations_GetSomeDataAsync to complete without having to re-enter the request context.
  • (test4 and test6): Since the Task is awaited, the ASP.NET request thread is not blocked. This allows AsyncAwait_GetSomeDataAsync to use the ASP.NET request context when it is ready to continue.

And here’s the best practices:

  1. In your “library” async methods, use ConfigureAwait(false) whenever possible. In your case, this would change AsyncAwait_GetSomeDataAsync to be var result = await httpClient.GetAsync("http://stackoverflow.com", HttpCompletionOption.ResponseHeadersRead).ConfigureAwait(false);
  2. Don’t block on Tasks; it’s async all the way down. In other words, use await instead of GetResult (Task.Result and Task.Wait should also be replaced with await).

That way, you get both benefits: the continuation (the remainder of the AsyncAwait_GetSomeDataAsync method) is run on a basic thread pool thread that doesn’t have to enter the ASP.NET request context; and the controller itself is async (which doesn’t block a request thread).

More information:

Update 2012-07-13: Incorporated this answer into a blog post.

More Related Contents:

  1. How and when to use ‘async’ and ‘await’
  2. If async-await doesn’t create any additional threads, then how does it make applications responsive?
  3. Should I avoid ‘async void’ event handlers?
  4. Running multiple async tasks and waiting for them all to complete
  5. How do yield and await implement flow of control in .NET?
  6. Fire and forget async method in asp.net mvc
  7. Task sequencing and re-entracy
  8. Enforce an async method to be called once
  9. Why use Async/await all the way down
  10. Async call with await in HttpClient never returns
  11. Async and await – difference between console, Windows Forms and ASP.NET
  12. Different forms of the WCF service contract interface
  13. Is async HttpClient from .Net 4.5 a bad choice for intensive load applications?
  14. Why use async and return await, when you can return Task directly?
  15. Executing tasks in parallel
  16. Should I worry about “This async method lacks ‘await’ operators and will run synchronously” warning
  17. Proper way to start and fire-and-forget asynchronous calls?
  18. Use Task.Run() in synchronous method to avoid deadlock waiting on async method?
  19. A pattern for self-cancelling and restarting task
  20. Async always WaitingForActivation
  21. What is the correct way to cancel an async operation that doesn’t accept a CancellationToken?
  22. A pattern to pause/resume an async task?
  23. Async thread body loop, It just works, but how?
  24. Converting async/await to Task.ContinueWith
  25. Horrible performance using SqlCommand Async methods with large data
  26. How to Async Files.ReadAllLines and await for results?
  27. Async and Await with For Loop [duplicate]
  28. Await and SynchronizationContext in a managed component hosted by an unmanaged app
  29. When is the best place to use Task.Result instead of awaiting Task
  30. Timeout pattern on task-based asynchronous method in C#

Leave a Comment