Improve Error Type Accuracy in TaskFailedException FailureDetails with .NET-Isolated app (#3070)

* initial commit

* fix index

* Fix typos in function name.

* Make TaskFailureDetails nullable in method signature

* update durabletask.abstraction ver

Author: nytian

Directory.Packages.props

@@ -64,6 +64,7 @@
     <PackageVersion Include="Microsoft.CodeAnalysis" Version="3.9.0" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="3.9.0" />
     <PackageVersion Include="Microsoft.Diagnostics.Tracing.TraceEvent" Version="2.0.65" />
+    <PackageVersion Include="Microsoft.DurableTask.Abstractions" Version="1.8.1" />
     <PackageVersion Include="Microsoft.DurableTask.Generators" Version="1.0.0-preview.1" />
     <PackageVersion Include="Microsoft.DurableTask.SqlServer.AzureFunctions" Version="1.5.0" />
     <PackageVersion Include="Microsoft.Extensions.Configuration" Version="9.0.0" />

src/Worker.Extensions.DurableTask/Exceptions/DurableSerializationException.cs

@@ -11,14 +11,20 @@ internal class DurableSerializationException : Exception
     // We set the base class properties of this exception to the same as the parent, 
     // so that methods in the worker after this can still (typically) access the same information vs w/o
     // this exception type. 
-    internal DurableSerializationException(Exception fromException) : base(fromException.Message, fromException.InnerException)
+    internal DurableSerializationException(Exception fromException) : base(CreateExceptionMessage(fromException), fromException.InnerException)
     {
         this.fromException = fromException;
     }
 
     public override string ToString()
     {
-        TaskFailureDetails? failureDetails = TaskFailureDetailsConverter.TaskFailureFromException(this.fromException);
+        return this.Message;
+    }
+
+    // Serilize FailureDetails to JSON
+    private static string CreateExceptionMessage(Exception ex)
+    {
+        TaskFailureDetails? failureDetails = TaskFailureDetailsConverter.TaskFailureFromException(ex);
         return JsonConvert.SerializeObject(failureDetails);
     }
 

test/e2e/Apps/BasicDotNetIsolated/ActivityErrorHandling.cs

@@ -46,6 +46,22 @@ public static async Task<HttpResponseData> CatchHttpStart(
         return await client.CreateCheckStatusResponseAsync(req, instanceId);
     }
 
+    [Function("CatchActivityExceptionFailureDetails_HttpStart")]
+    public static async Task<HttpResponseData> CatchFailureDetailsHttpStart(
+        [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req,
+        [DurableClient] DurableTaskClient client,
+        FunctionContext executionContext)
+    {
+        ILogger logger = executionContext.GetLogger("CatchActivityExceptionFailureDetails_HttpStart");
+
+        string instanceId = await client.ScheduleNewOrchestrationInstanceAsync(
+            nameof(CatchActivityExceptionFailureDetails));
+
+        logger.LogInformation("Started orchestration with ID = '{instanceId}'.", instanceId);
+
+        return await client.CreateCheckStatusResponseAsync(req, instanceId);
+    }
+
     [Function("RetryActivityException_HttpStart")]
     public static async Task<HttpResponseData> RetryHttpStart(
         [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req,
@@ -96,11 +112,26 @@ public static async Task<string> CatchActivityException(
             return output;
         }
         catch (TaskFailedException ex)
-        {
+        {  
             return ex.Message;
         }
     }
 
+    [Function(nameof(CatchActivityExceptionFailureDetails))]
+    public static async Task<TaskFailureDetails?> CatchActivityExceptionFailureDetails(
+        [OrchestrationTrigger] TaskOrchestrationContext context)
+    {
+        try 
+        {
+            await context.CallActivityAsync<string>(nameof(RaiseException), context.InstanceId);
+            return null;
+        }
+        catch (TaskFailedException ex)
+        {      
+            return ex.FailureDetails;
+        }
+    }
+
     [Function(nameof(RetryActivityFunction))]
     public static async Task<string> RetryActivityFunction(
         [OrchestrationTrigger] TaskOrchestrationContext context)

test/e2e/Tests/E2ETests.csproj

@@ -10,6 +10,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.DurableTask.Abstractions"/>
     <PackageReference Include="Microsoft.Extensions.Configuration" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables"  />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json"  />

test/e2e/Tests/Tests/ErrorHandlingTests.cs

@@ -1,7 +1,9 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System.Net;
+using Microsoft.DurableTask;
+using Newtonsoft.Json;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -71,6 +73,27 @@ public async Task OrchestratorWithCaughtActivityException_ShouldSucceed()
         Assert.Contains("This activity failed", orchestrationDetails.Output);
     }
 
+    [Fact]
+    public async Task OrchestratorWithCaughtActivityExceptionFailuredetails_ContainRightErrorType()
+    {
+        using HttpResponseMessage response = await HttpHelpers.InvokeHttpTrigger("CatchActivityExceptionFailureDetails_HttpStart", "");
+
+        Assert.Equal(HttpStatusCode.Accepted, response.StatusCode);
+        string statusQueryGetUri = await DurableHelpers.ParseStatusQueryGetUriAsync(response);
+
+        await DurableHelpers.WaitForOrchestrationStateAsync(statusQueryGetUri, "Completed", 30);
+
+        var orchestrationDetails = await DurableHelpers.GetRunningOrchestrationDetailsAsync(statusQueryGetUri);
+        // Deserialize the output to FailureDetails
+        var failureDetails = JsonConvert.DeserializeObject<TaskFailureDetails>(orchestrationDetails.Output);
+
+        // Check FailureDetails contains the right error type and error message,
+        // Here it should be the same one as the activity function Raise Exception throws.
+        Assert.NotNull(failureDetails);
+        Assert.Equal("System.InvalidOperationException", failureDetails.ErrorType);
+        Assert.Equal("This activity failed", failureDetails.ErrorMessage);
+    }
+
     [Fact]
     [Trait("MSSQL", "Skip")] // Durable Entities are not supported in MSSQL/Dotnet Isolated, see https://github.com/microsoft/durabletask-mssql/issues/205
     public async Task OrchestratorWithCaughtEntityException_ShouldSucceed()