How to Unwrap an AggregateException Thrown by AWS Lambdaby@zaccharles
1,770 reads
1,770 reads

How to Unwrap an AggregateException Thrown by AWS Lambda

by Zac CharlesFebruary 6th, 2019
Read on Terminal Reader
Read this story w/o Javascript
tldt arrow

Too Long; Didn't Read

If you’ve written a&nbsp;.NET Lambda function which calls async code and returns either <code class="markup--code markup--p-code">Task</code> or <code class="markup--code markup--p-code">Task&lt;T&gt;</code>, you’ve probably seen an <code class="markup--code markup--p-code">AggregateException</code> which wraps the <em>real</em> exception.

Companies Mentioned

Mention Thumbnail
Mention Thumbnail
featured image - How to Unwrap an AggregateException Thrown by AWS Lambda
Zac Charles HackerNoon profile picture

If you’ve written a .NET Lambda function which calls async code and returns either Task or Task<T>, you’ve probably seen an AggregateException which wraps the real exception.

This example comes from the handler below which calls an asnyc method that always throws a FormatException.

The AggregateException can be unwrapped, though. When AWS added .NET Core 2.1 support to Lambda, they also added an undocumented feature toggle. The only real mention of it is by the AWS .NET team on Reddit.

When the UNWRAP_AGGREGATE_EXCEPTIONS environment variable is set to 1 or true, Lambda will call GetAwaiter().GetResult() instead of using theResult property.

Note that this only works if your method returns Task or Task<T>.

This causes the first exception thrown to be returned instead of an AggregateException.

To avoid compatibility issues, this is opt-in via the environment variable. However, in the Reddit comment, the team says they plan to make it the default behaviour in future versions. I think they’ll keep the toggle, though, because it can be useful.

The reason you get an AggregateException is that a single Task can represent multiple parallel tasks, each of which can throw an exception. You’ll most often see this when using Task.WaitAll or Task.WhenAll.

This convoluted example runs three tasks in parallel, two of which throw an exception.

Setting the UNWRAP_AGGREGATE_EXCEPTIONS environment variable gets us back to just the FormatException which was thrown first. In the future, you’ll need to toggle unwrapping exceptions off when you want to see every exception.

For more like this, please follow me on Medium and Twitter.