.NET: fix: Expose WorkflowErrorEvent as ErrorContent #2762
Conversation
When hosted using .AsAgent(), Workflows were not exposing inner errors coming as Exceptions (through the WorkflowErrorEvent) The fix is to convert their message to an ErrorContent on the way out, rather than rely on the default "empty update" to collect the raw event.
markwallace-microsoft
added
.NET
workflows
github-actions
bot
changed the title
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug where workflows hosted using .AsAgent() were not exposing inner errors coming from exceptions through the WorkflowErrorEvent. The fix converts error events to ErrorContent objects so they can be properly surfaced to consumers.
Key Changes:
- Added an
Exceptionproperty toWorkflowErrorEventfor direct access to the underlying exception - Modified
WorkflowThread.CreateUpdateto accept a raw representation parameter - Added handling for
WorkflowErrorEventin workflow execution to convert exceptions toErrorContent
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| WorkflowErrorEvent.cs | Adds public Exception property to expose the underlying exception data |
| WorkflowThread.cs | Updates CreateUpdate signature to include raw representation and adds error event handling to convert exceptions to ErrorContent |
| WorkflowHostSmokeTests.cs | Adds comprehensive smoke tests validating both direct error content streaming and exception-to-error-content conversion |
| return new WorkflowBuilder(agent).Build(); | ||
| } | ||
|
|
||
| private async static Task InvokeAsAgentAndProcessResponseAsync(Workflow workflow) |
There was a problem hiding this comment.
The method signature does not follow the C# coding guideline for async methods. Async methods that return Task should have the 'Async' suffix in their name.
|
|
||
| private async static Task InvokeAsAgentAndProcessResponseAsync(Workflow workflow) | ||
| { | ||
| List<AgentRunResponseUpdate> updates = await workflow.AsAgent("WorkflowAgent") |
There was a problem hiding this comment.
According to the C# coding guidelines, prefer defining variables using types rather than var to help users understand the types involved.
| .ToListAsync(); | ||
|
|
||
| bool hadErrorContent = false; | ||
| foreach (AgentRunResponseUpdate update in updates) |
There was a problem hiding this comment.
According to the C# coding guidelines for unit tests, Arrange, Act, and Assert comments should be added for each test to clearly separate the test phases.
| } | ||
| } | ||
|
|
||
| private static Workflow CreateWorkflow(bool failByThrowing) |
There was a problem hiding this comment.
According to the C# coding guidelines, prefer defining variables using types rather than var to help users understand the types involved.
Motivation and Context
When hosted using
AsAgent(),Workflows were not exposing inner errors coming asExceptions (through raisedWorkflowErrorEvent)Description
The fix is to convert the
Messageproperty to anErrorContenton the way out, rather than rely on the default "empty update" to collect the raw event.Contribution Checklist
Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.