How can blocking async calls cause a deadlock if async calls aren't necessarily executed on a different thread?

Question

I recently read Stephen Cleary's post regarding possible deadlocks that occur when we call async code in synchronous methods here: https://blog.stephencleary.com/2012/07/dont-block-on-async-code.html

Regarding a slightly modified example here (all I added was a writeline code):

// My "library" method.
public static async Task<JObject> GetJsonAsync(Uri uri)
{
  Console.WriteLine("Before await");
  using (var client = new HttpClient())
  {
    var jsonString = await client.GetStringAsync(uri).ConfigureAwait(true);
    return JObject.Parse(jsonString);
  }
}

// My "top-level" method.
public void Button1_Click(...)
{
  var jsonTask = GetJsonAsync(...);
  textBox1.Text = jsonTask.Result;
}

His explanation is that the top-level method is blocking the UI thread waiting for GetJsonAsync to finish whereas GetJsonAsync is waiting for the UI thread to be freed so it can finish executing.

My question is, isn't GetJsonAsync already on the UI thread? Why would it need to wait for it to be freed? According to this post here calling async functions don't necessarily create another thread for the method to execute on. So how would it cause an issue with the UI thread if GetJsonAsync was executing on the UI thread the entire time? Like when Console.WriteLine() is executed where is this done, if not on the UI thread? I feel like I'm missing something here but don't know what.

Clarification: At which point does the execution leave the UI thread/context and need to return? There so much discussion about needing to return but never when it leaves the thread/context.

Stephen's explanation was for the original code, not for your modified example — user585968
– user585968, Commented Feb 5, 2021 at 1:30
You added ConfigureAwait(false) which is actually half of the fix and not the full code that was causing the block. You are applying the original author's conclusion to modified code whilst giving the impression that he wrote it. Neither is helpful. Probably would have been better with a fresh example. — user585968
– user585968, Commented Feb 5, 2021 at 1:41
The original article explains the problem quite well. Not sure how it can be improved upon here — user585968
– user585968, Commented Feb 5, 2021 at 1:41
@MickyD I'm not sure what you are seeing but it clearly says ConfigureAwait(true) in the modified example, which is implied when he wrote the await call. I just wanted to be more specific. — avhhh
– avhhh, Commented Feb 5, 2021 at 1:44
@avhhh, GetJsonAsync executed on UI thread until first await, then context of GetJsonAsync is saved into state machine and added to the message loop. Message loop will verify all state machines on "every loop" and when complete it will load it's context into UI thread and continue execution on UI thread. — Fabio
– Fabio, Commented Feb 5, 2021 at 2:46

Stephen Cleary · Accepted Answer · 2021-02-05 13:59:32Z

5

What I'm asking is, where is GetJsonAsync executing when it's called from Button1_Click if this call doesn't create a new thread for it to execute on. Before the await within GetJsonAsync, isn't it executing the Console.WriteLine(...) within the UI context still?

I recommend reading my async intro. In summary:

Every asynchronous method begins executing synchronously. This code:

public void Button1_Click(...)
{
  var jsonTask = GetJsonAsync(...);
  textBox1.Text = jsonTask.Result;
}

calls GetJsonAsync on the UI thread, and it does begin executing on the UI thread. It executes Console.WriteLine on the UI thread, news up a client on the UI thread, and even calls GetStringAsync on the UI thread. It gets a task back from that method, and then awaits it (I'm ignoring the ConfigureAwait(true) for simplicity).

The await is the point at which things may become asynchronous. The task isn't complete (i.e., the client hasn't received the string yet), so GetJsonAsync returns an incomplete task to its caller. Then Button1_Click blocks the UI thread, waiting for that task to complete (by calling .Result).

So, the state is currently GetJsonAsync is no longer running on the UI thread. It is not actually "running" anywhere.

Later, when that string result arrives, the task that was returned from GetStringAsync is completed, and GetJsonAsync needs to resume executing. It's not already on the UI thread; it's not anywhere at the moment. Since the await captured a UI context, it will attempt to resume on that context (on the UI thread).

answered Feb 5, 2021 at 13:59

Stephen Cleary

460k78 gold badges721 silver badges858 bronze badges

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

1 Comment

avhhh Over a year ago

This particular explanation here: "So, the state is currently GetJsonAsync is no longer running on the UI thread. It is not actually "running" anywhere." was the exact answer I was looking for. Thank you!

Collectives™ on Stack Overflow

How can blocking async calls cause a deadlock if async calls aren't necessarily executed on a different thread?

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related