Skip to main content

Task.Unwrap() - A useful proxy to avoid inner Task inside a Task

In this post we will talk about Task and what we should do when we end up with 'Task<Task<Foo>>".

Let's start with a simple example. Let's asume that we have an async method.
public async Task<int> DoSomethingAsync()
{
    return await GetNumberAsync();
}
We have the 'DoSomethingAsync' method that we need to call inside another task. If we call this method directly we will end up with Task<int>, but if we call this method in another Task than we will end up with...
Task<int> simpleCall = DoSomethingAsync();

Task<Task<int>> complexCall = new Task<Task<int>>(
    async () =>
    {
        return await DoSomethingAsync();
    });
As we can see, to be able to call a async a method in a task we will need to add the 'async' attribute to the lambda expression (function). Because of this we will get a Task of Task (Task<Task<..>) and not a simple Task<...>.

You could say that this is fine, it is not complicated to get the result of the inner task and so on. Yes, this is true, but in the same time we need to be able to handle error from both tasks and cancelation tokens.
For this cases it is recommended to use "Task.Unwrap" method, that allow us to work directly with Task<...>.
Task<int> simpleCall = DoSomethingAsync();

Task<Task<int>> complexCall = new Task<Task<int>>(
    async () =>
    {
        return await DoSomethingAsync();
    });
complexCall.Start();
Task<int> complexCallUnwrap = complexCall.Unwrap();
There is no magic behind 'Unwrap' method. You can use with success in cases when you have Task<Task<Task<...>,  also.
Behind the scene, 'Unwrap' method creates a proxy that will handle all complex cases for us. We don't need to forward the cancelation token, to check errors at different level. We can work as we would have a simple task, not a task inside another tasks.
The Task that is returned by 'Unwrap' includes all the cancelation token request and exception handling (the proxy is doing the job of connecting the task with inner task).

Another use case when 'Unwrap' is useful is in the moment when we want to create a continue action using 'ContinueWith' method. Without 'Unwrap' method we can end up easily in cases where we have inner Task inside a task. This can be avoided using 'Unwrap'.
Task<Task<int>> taskInTask = DoSomethingAsync()
                                .ContinueWith((value) => DoSomethingAsync());
Task<int> taskInTaskWithUnwrap = DoSomethingAsync()
                                            .ContinueWith((value) => DoSomethingAsync())
                                            .Unwrap();

Using 'Unwrap' method we can work directly with a proxy, that represents the entire Task<Task>, like a simple Task.

Comments

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provi...