Skip to main content

Async/Await–.ConfigureAwait(false)

On one of my projects, a developer asked my help when he noticed that the application just hang after invoking a specific action on a Web API controller.

In this at first innocent looking piece of code he was using a combination of async and non-async code. Here is a simplified example;

If you ran the code above then you end up with a deadlock. This is what happens:

  1. Thread "A" would be given to the request to run on and "Index" would be called
  2. Thread "A" would call "DoSomethingAsync" and get a Task reference
  3. Thread "A" would then request the ".Result" property of that task and would block until the task completed
  4. The "Task.Delay" call would complete and the runtime would try to continue the "DoSomethingAsync" work
  5. The ASP.NET synchronization context would require that work continue on Thread "A" and so the work would be placed on a queue for Thread "A".

Thread "A". is waiting until the DoSomethingAsync task is completed, but the DoSomethingAsync cannot complete because it needs Thread "A". So we end up with a deadlock situation.

The root cause is that ASP.NET applications have a special synchronization context, that returns to the same thread after an async call complete

    To avoid this kind of issues it’s a good idea to set .ConfigureAwait(false). By doing this you no longer use the ASP.NET synchronization context, meaning that the work can continue on any thread available when the async work has completed.

    Remark: Be aware that this requires your code to be thread-safe.

    As most of the time you don’t care on which thread the work continues, it can be a good idea to always add ".ConfigureAwait(false)" to your await calls. If you don’t want to forget this, you can use the following analyzer in your projects: https://www.nuget.org/packages/ConfigureAwaitChecker.Analyzer. This will give you a warning when a possible ConfigureAwait(false) call is missing. The analyzer is quite smart and detects when a configureawait is possible.

    image

    Remark: When you are using ASP.NET Core, you don’t have to worry about this as the synchronization context that was used for previous versions of ASP.NET is gone.

    Labels:

    Popular posts from this blog

    Azure DevOps/ GitHub emoji

    I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
    Read more

    Podman– Command execution failed with exit code 125

    After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
    Read more

    Cleaner switch expressions with pattern matching in C#

    Ever find yourself mapping multiple string values to the same result? Being a C# developer for a long time, I sometimes forget that the C# has evolved so I still dare to chain case labels or reach for a dictionary. Of course with pattern matching this is no longer necessary. With pattern matching, you can express things inline, declaratively, and with zero repetition. A small example I was working on a small script that should invoke different actions depending on the environment. As our developers were using different variations for the same environment e.g.  "tst" alongside "test" , "prd" alongside "prod" .  We asked to streamline this a long time ago, but as these things happen, we still see variations in the wild. This brought me to the following code that is a perfect example for pattern matching: The or keyword here is a logical pattern combinator , not a boolean operator. It matches if either of the specified pattern...
    Read more