[release/6.0-rc2] Fix corner-case handling of cancellation exception in ForEachAsync

[github-actions]

Backport of #59065 to release/6.0-rc2

/cc @stephentoub

Customer Impact

If the body of a Parallel.ForEachAsync loop throws an OperationCanceledException using the supplied CancellationToken and it hasn't had cancellation requested, the Task returned from ForEachAsync will never complete and the calling code will effectively hang, e.g.

await Parallel.ForEachAsync(source, async (item, cancellationToken) =>
{
    ...
    throw new OperationCanceledException(cancellationToken); // when !cancellationToken.IsCancellationRequested
});

This is not a common thing to do. However, if you do happen to do it, your app will hang. The code is filtering out such exceptions, but if they're the only ones, it ends up filtering out all of them, causing the call that would have completed the returned Task to throw an exception which is then inadvertently eaten.

The fix is to change the design to simply not do such filtering: all exceptions thrown in such a case will be stored in the task.

Testing

Additional unit tests.

Risk

Relatively low.

• This is a new API in .NET 6.
• The 99.9% use case is to just await the returned task, which this won't affect, as await only throws the first exception stored in the task.
• The potential risk here is if someone is accessing the Task afterwards, they may see additional exceptions in Task.Exception.InnerExceptions that they didn't previously see.

[ghost]

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-threading-tasks
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Backport of #59065 to release/6.0-rc2

/cc @stephentoub

Customer Impact

If the body of a Parallel.ForEachAsync loop throws an OperationCanceledException using the supplied CancellationToken and it hasn't had cancellation requested, the Task returned from ForEachAsync will never complete and the calling code will effectively hang, e.g.

await Parallel.ForEachAsync(source, async (item, cancellationToken) =>
{
    ...
    throw new OperationCanceledException(cancellationToken); // when !cancellationToken.IsCancellationRequested
});

This is not a common thing to do. However, if you do happen to do it, your app will hang. The code is filtering out such exceptions, but if they're the only ones, it ends up filtering out all of them, causing the call that would have completed the returned Task to throw an exception which is then inadvertently eaten.

The fix is to change the design to simply not do such filtering: all exceptions thrown in such a case will be stored in the task.

Testing

Additional unit tests.

Risk

Relatively low.

• This is a new API in .NET 6.
• The 99.9% use case is to just await the returned task, which this won't affect, as await only throws the first exception stored in the task.
• The potential risk here is if someone is accessing the Task afterwards, they may see additional exceptions in Task.Exception.InnerExceptions that they didn't previously see.

Author:	github-actions[bot]
Assignees:	-
Labels:	area-System.Threading.Tasks
Milestone:	-

[lewing]

runtime (Mono Product Build windows x64 release) is

D:\a\_work\1\s\.dotnet\sdk\6.0.100-rc.1.21430.12\MSBuild.dll /nologo -maxcpucount /m -verbosity:m /v:minimal /bl:D:\a\_work\1\s\artifacts\log\Release\ToolsetRestore.binlog /clp:Summary /clp:ErrorsOnly;NoSummary /nr:False /p:ContinuousIntegrationBuild=True /p:TreatWarningsAsErrors=true /p:__ToolsetLocationOutputFile=D:\a\_work\1\s\artifacts\toolset\6.0.0-beta.21460.7.txt /t:__WriteToolsetLocation /warnaserror D:\a\_work\1\s\artifacts\toolset\restore.proj
D:\a\_work\1\s\artifacts\toolset\restore.proj : error : Unable to load the service index for source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public/nuget/v3/index.json.
D:\a\_work\1\s\artifacts\toolset\restore.proj : error : Unable to load the service index for source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json.
D:\a\_work\1\s\artifacts\toolset\restore.proj : error : Unable to load the service index for source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json.
D:\a\_work\1\s\artifacts\toolset\restore.proj : error : Unable to load the service index for source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6/nuget/v3/index.json.
D:\a\_work\1\s\artifacts\toolset\restore.proj : error : Unable to load the service index for source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet6-transport/nuget/v3/index.json.
D:\a\_work\1\s\artifacts\toolset\restore.proj : error : Unable to find package Microsoft.DotNet.Arcade.Sdk. No packages exist with this id in source(s): dotnet-eng, dotnet-public, dotnet-tools, dotnet6, dotnet6-transport, richnav
D:\a\_work\1\s\artifacts\toolset\restore.proj : error MSB4236: The SDK 'Microsoft.DotNet.Arcade.Sdk' specified could not be found.
Build failed with exit code 1. Check errors above.
See log: D:\a\_work\1\s\artifacts\log\Release\ToolsetRestore.binlog

😞

[stephentoub]

runtime (Mono Product Build windows x64 release) is
Unable to load the service index for source

I'm going to go ahead and assume my fix didn't cause that ;-)