Add API to get orchestration history #516
Merged
+69
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR introduces a new public API method GetOrchestrationHistoryAsync to retrieve orchestration history as a list of HistoryEvent objects. The implementation spans three key areas: adding the base API declaration in DurableTaskClient, implementing the gRPC client logic in GrpcDurableTaskClient, and updating the history event conversion to include failure details in ExecutionCompletedEvent.
Key Changes
- Added virtual method
GetOrchestrationHistoryAsyncto the baseDurableTaskClientclass with comprehensive XML documentation - Implemented the method in
GrpcDurableTaskClientusing streaming gRPC calls with proper error handling - Updated
ExecutionCompletedEventconstruction in ProtoUtils to include failure details as a 4th parameter
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Client/Core/DurableTaskClient.cs | Declares the new virtual GetOrchestrationHistoryAsync method with complete exception documentation; also updates entity-related exception documentation for RewindInstanceAsync |
| src/Client/Grpc/GrpcDurableTaskClient.cs | Implements GetOrchestrationHistoryAsync using streaming gRPC calls with appropriate validation, error handling, and namespace disambiguation for ProtoUtils |
| src/Shared/Grpc/ProtoUtils.cs | Adds FailureDetails parameter to ExecutionCompletedEvent constructor to properly include failure information in history events |
Contributor
|
@sophiatev I've opened a new pull request, #518, to work on those changes. Once the pull request is ready, I'll request review from you. |
nytian
approved these changes
Dec 4, 2025
YunchuWang
approved these changes
Dec 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new API to get the orchestration history for the
GrpcDurableTaskClient. The server-side implementation of this is implemented in this PR.Note:
I only added this method to the
GrpcDurableTaskClient. In order to add it to theShimDurableTaskClientwe would need to introduce a Newtonsoft.Json dependency to this repo, which as I understand we are trying to avoid.Addresses #419