Why is an “await Task.Yield()” required for Thread.CurrentPrincipal to flow correctly?

by

How interesting! It appears that Thread.CurrentPrincipal is based on the logical call context, not the per-thread call context. IMO this is quite unintuitive and I’d be curious to hear why it was implemented this way.

In .NET 4.5., async methods interact with the logical call context so that it will more properly flow with async methods. I have a blog post on the topic; AFAIK that’s the only place where it’s documented. In .NET 4.5, at the beginning of every async method, it activates a “copy-on-write” behavior for its logical call context. When (if) the logical call context is modified, it will create a local copy of itself first.

You can see the “localness” of the logical call context (i.e., whether it has been copied) by observing System.Threading.Thread.CurrentThread.ExecutionContextBelongsToCurrentScope in a watch window.

If you don’t Yield, then when you set Thread.CurrentPrincipal, you’re creating a copy of the logical call context, which is treated as “local” to that async method. When the async method returns, that local context is discarded and the original context takes its place (you can see ExecutionContextBelongsToCurrentScope returning to false).

On the other hand, if you do Yield, then the SynchronizationContext behavior takes over. What actually happens is that the HttpContext is captured and used to resume both methods. In this case, you’re not seeing Thread.CurrentPrincipal preserved from AuthenticateAsync to GetAsync; what is actually happening is HttpContext is preserved, and then HttpContext.User is overwriting Thread.CurrentPrincipal before the methods resume.

If you move the Yield into GetAsync, you see similar behavior: Thread.CurrentPrincipal is treated as a local modification scoped to AuthenticateAsync; it reverts its value when that method returns. However, HttpContext.User is still set correctly, and that value will be captured by Yield and when the method resumes, it will overwrite Thread.CurrentPrincipal.

More Related Contents:

  1. Best practice to call ConfigureAwait for all server-side code
  2. Why is HttpContext.Current null after await?
  3. Effectively use async/await with ASP.NET Web API
  4. How do you implement an async action delegate method?
  5. Set Thread.CurrentPrincipal Asynchronously?
  6. How to use (get and set) httpcontext.current.Session in the class library, within MVC web api application? [duplicate]
  7. Call asynchronous method in constructor?
  8. Handle ModelState Validation in ASP.NET Web API
  9. Is Task.Run considered bad practice in an ASP .NET MVC Web Application?
  10. Entity Framework Core: A second operation started on this context before a previous operation completed
  11. How to implement real time data for a web page
  12. Synchronously waiting for an async operation, and why does Wait() freeze the program here
  13. Set default global json serializer settings
  14. Pattern for calling WCF service using async/await
  15. WebAPI StreamContent vs PushStreamContent
  16. Awaiting Asynchronous function inside FormClosing Event
  17. Async network operations never finish
  18. Self referencing loop detected – Getting back data from WebApi to the browser
  19. Query string not working while using attribute routing
  20. Async call with await in HttpClient never returns
  21. If my interface must return Task what is the best way to have a no-operation implementation?
  22. Return content with IHttpActionResult for non-OK response
  23. ModelState.IsValid even when it should not be?
  24. An entry point cannot be marked with the ‘async’ modifier
  25. Is it possible to “await yield return DoSomethingAsync()”
  26. How to correctly write Parallel.For with async methods
  27. Converting async/await to Task.ContinueWith
  28. What’s the difference between InvokeAsync and BeginInvoke for WPF Dispatcher
  29. Task.WhenAny – What happens with remaining running tasks?
  30. Disable *all* exception handling in ASP.NET Web API 2 (to make room for my own)?

Leave a Comment