Azure / Azure/durabletask

How can I get strong-typed history of a workflow execution?

Open
#665 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C#
Stars
1.7k
Forks
335
Avg merge
2d 23h
Merged PRs (30d)
6

Description

I'm trying to build a UI to audit the status of in-progress and completed workflows. I'd like to display the full history of the workflow.

I see that `TaskHubClient` has a method `GetOrchestrationHistoryAsync` that is nearly what I want, except it returns a json string instead of a strong-typed list of history items:

https://github.com/Azure/durabletask/blob/657586bcfe9b0c68695ec6447ee9baca338c6cf7/src/DurableTask.Core/TaskHubClient.cs#L832-L849

Digging down through the call stack, `IOrchestrationServiceClient.GetOrchestrationHistoryAsync` also returns json:

https://github.com/Azure/durabletask/blob/657586bcfe9b0c68695ec6447ee9baca338c6cf7/src/DurableTask.AzureStorage/AzureStorageOrchestrationService.cs#L1749-L1762

The next level down (at least in the case of the Azure Storage backend) is `ITrackingStore`, which is unusable to me because it's not public.

https://github.com/Azure/durabletask/blob/657586bcfe9b0c68695ec6447ee9baca338c6cf7/src/DurableTask.AzureStorage/Tracking/ITrackingStore.cs#L26

I'm currently working around the issue by deserializing the returned json. It works, but the code needed to do so is nontrivial and brittle because `HistoryEvent` is an abstract class and requires custom type mapping to deserialize properly.

It seems like there should be a "Get Orchestration History" method that returns a list of `HistoryEvent` objects, or perhaps an `OrchestrationHistory` object. Am I missing something?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.