Add API to get orchestration history in .NET Isolated #3268
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
nytian
reviewed
Dec 5, 2025
Collaborator
nytian
left a comment
nytian
left a comment
There was a problem hiding this comment.
Thanks for the PR! Overall looks good to me and I will go back here once the dotnet sdk is released. Left some small comments.
| { | ||
| return false; | ||
| } | ||
| return other.CallEntities == this.CallEntities |
Collaborator
There was a problem hiding this comment.
Can you fix the indexing here?
| jsonHistory, | ||
| new JsonSerializerSettings() | ||
| { | ||
| // I had to make the HistoryEventJsonConverter public to use it here. Is this a good reason? |
Collaborator
There was a problem hiding this comment.
Maybe try InternalsVisibleTo attribute?
| /// <returns>The enumerable of history chunks representing the orchestration's history.</returns> | ||
| public virtual Task<IEnumerable<string>> StreamOrchestrationHistoryAsync(string instanceId, JsonFormatter jsonFormatter, CancellationToken cancellationToken) | ||
| { | ||
| throw this.GetNotImplementedException(nameof(this.StreamOrchestrationHistoryAsync)); |
Collaborator
There was a problem hiding this comment.
I guess we would expect a PR at other backends repo? Can you link those in the PR description too when they are done?
| [Trait("Python", "Skip")] // The GetOrchestrationHistory API is not implemented in Python | ||
| [Trait("PowerShell", "Skip")] // The GetOrchestrationHistory API is not implemented in PowerShell | ||
| [Trait("Node", "Skip")] // The GetOrchestrationHistory API is not implemented in Node | ||
| public async Task GetOrchestrationHistory_FailedOrchestration() |
Collaborator
There was a problem hiding this comment.
Can you add a brief description of the test coverage scenario?
| /// <inheritdoc/> | ||
| public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer) | ||
| { | ||
| throw new NotImplementedException(); |
Collaborator
There was a problem hiding this comment.
We don't support write because we don't need this converter to write, right?
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 the server-side implementation of a new API to retrieve orchestration history in .NET isolated. The client-side implementation is in this PR.
The server-side call is implemented in the
TaskHubGrpcServer. We also introduce a new method to stream the orchestration history in theDurabilityProvider. If the backend (so far only DTS) has an orchestration history streaming API implemented, then we will use that. If not, we will fall back to the "old method" (retrieving a JSON string of the orchestration history, deserializing it, converting it to protos, and sending that).Note:
The method added to the
DurabilityProviderclass returns an enumerable of strings. Ideally, this would be an enumerable of the proto objects that we can then just forward on to the client. However, I get a "CS0050: Return type is less accessible than the method" error if I try to do this. That being said, we now have an extra unnecessary level of serialization introduced because of this (the backend converts the protos to strings, and theTaskHubGrpcServerconverts these strings back to the same protos before sending them to the client).Issue describing the changes in this PR
resolves #issue_for_this_pr
Pull request checklist
pending_docs.mdrelease_notes.md/src/Worker.Extensions.DurableTask/AssemblyInfo.csdevandmainbranches and will not be merged into thev2.xbranch.