-
Notifications
You must be signed in to change notification settings - Fork 371
feat(workflow): align history propagation API with go-sdk #1825
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 13 commits
d1e40fe
b81c4ea
fcb1993
34a2c98
57c69da
b604220
36c2788
25fe1d7
6909ac2
da2f380
5987d9c
166b288
a5a24cd
ef9e588
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
|
WhitWaldo marked this conversation as resolved.
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,71 +15,121 @@ namespace Dapr.Workflow; | |
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics.CodeAnalysis; | ||
| using System.Linq; | ||
|
|
||
| /// <summary> | ||
| /// Contains the workflow history that was propagated from ancestor workflow instances. | ||
| /// Each entry corresponds to a single ancestor's history. | ||
| /// Workflow history propagated from one or more ancestor workflows to a child workflow or activity. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// A workflow receives propagated history when it is scheduled with a | ||
| /// <see cref="HistoryPropagationScope"/> other than <see cref="HistoryPropagationScope.None"/>. | ||
| /// Use <see cref="WorkflowContext.GetPropagatedHistory"/> to retrieve the propagated history | ||
| /// inside a workflow implementation. | ||
| /// A propagated history is an ordered list of <see cref="PropagatedHistoryEntry"/> values, | ||
| /// one per ancestor workflow. Order is execution order: index 0 is the oldest ancestor, | ||
| /// the last entry is the immediate parent. | ||
| /// <para> | ||
| /// Use <see cref="GetEntries"/> for the full list, the <c>FilterBy*</c> methods to narrow by | ||
| /// app, instance, or workflow name, and <see cref="TryGetLastWorkflowByName"/> for the most | ||
| /// recent entry with a given name. Mirrors the <c>PropagatedHistory</c> type in the Go and Python SDKs. | ||
| /// </para> | ||
| /// </remarks> | ||
| public sealed class PropagatedHistory | ||
| { | ||
| private readonly IReadOnlyList<PropagatedHistoryEntry> _entries; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of <see cref="PropagatedHistory"/> with the given entries. | ||
| /// Initializes a new <see cref="PropagatedHistory"/> from the given workflow entries. | ||
| /// </summary> | ||
| /// <param name="entries">The propagated history entries from ancestor workflows.</param> | ||
| /// <param name="entries"> | ||
| /// Workflow entries in execution order (ancestor first, immediate parent last). | ||
| /// </param> | ||
| public PropagatedHistory(IReadOnlyList<PropagatedHistoryEntry> entries) | ||
| { | ||
| _entries = entries ?? throw new ArgumentNullException(nameof(entries)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the ordered list of propagated history entries. | ||
| /// The first entry corresponds to the immediate parent workflow; subsequent entries | ||
| /// correspond to progressively older ancestors when <see cref="HistoryPropagationScope.Lineage"/> is used. | ||
| /// Returns every entry in the propagated history, in execution order | ||
| /// (ancestor first, immediate parent last). | ||
| /// </summary> | ||
| public IReadOnlyList<PropagatedHistoryEntry> Entries => _entries; | ||
| public IReadOnlyList<PropagatedHistoryEntry> GetEntries() => _entries; | ||
|
|
||
| /// <summary> | ||
| /// Returns a new <see cref="PropagatedHistory"/> containing only entries from the specified App ID. | ||
| /// Returns an ordered, deduplicated list of app IDs in this propagated history. | ||
| /// </summary> | ||
| /// <param name="appId">The Dapr App ID to filter by.</param> | ||
| /// <returns>A filtered <see cref="PropagatedHistory"/> instance.</returns> | ||
| public PropagatedHistory FilterByAppId(string appId) | ||
| public IReadOnlyList<string> GetAppIds() | ||
| { | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(appId); | ||
| return new PropagatedHistory( | ||
| _entries.Where(e => string.Equals(e.AppId, appId, StringComparison.OrdinalIgnoreCase)).ToList()); | ||
| var seen = new HashSet<string>(StringComparer.OrdinalIgnoreCase); | ||
| var result = new List<string>(_entries.Count); | ||
| foreach (var entry in _entries) | ||
| { | ||
| if (seen.Add(entry.AppId)) | ||
| { | ||
| result.Add(entry.AppId); | ||
| } | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns a new <see cref="PropagatedHistory"/> containing only the entry with the specified instance ID. | ||
| /// Returns every entry whose workflow name matches, in execution order. Useful when the | ||
| /// list contains the same name more than once (e.g. recursion or ContinueAsNew). | ||
| /// </summary> | ||
| /// <param name="instanceId">The workflow instance ID to filter by.</param> | ||
| /// <returns>A filtered <see cref="PropagatedHistory"/> instance.</returns> | ||
| public PropagatedHistory FilterByInstanceId(string instanceId) | ||
| /// <param name="name">The workflow name to filter by.</param> | ||
| /// <returns>An empty list when no match is found.</returns> | ||
| public IReadOnlyList<PropagatedHistoryEntry> FilterByWorkflowName(string name) | ||
| { | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(instanceId); | ||
| return new PropagatedHistory( | ||
| _entries.Where(e => string.Equals(e.InstanceId, instanceId, StringComparison.Ordinal)).ToList()); | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(name); | ||
| return _entries | ||
| .Where(e => string.Equals(e.Name, name, StringComparison.OrdinalIgnoreCase)) | ||
| .ToList(); | ||
|
WhitWaldo marked this conversation as resolved.
|
||
| } | ||
|
|
||
| /// <summary> | ||
| /// Tries to return the most recent workflow entry whose name matches. | ||
| /// </summary> | ||
| /// <param name="name">The workflow name to look up.</param> | ||
| /// <param name="result">When this method returns <see langword="true"/>, the last matching workflow entry; otherwise <see langword="null"/>.</param> | ||
| /// <returns><see langword="true"/> if a matching entry was found; otherwise <see langword="false"/>.</returns> | ||
| public bool TryGetLastWorkflowByName(string name, [NotNullWhen(true)] out PropagatedHistoryEntry? result) | ||
| { | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(name); | ||
| for (var i = _entries.Count - 1; i >= 0; i--) | ||
| { | ||
| if (string.Equals(_entries[i].Name, name, StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| result = _entries[i]; | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| result = null; | ||
| return false; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns every entry produced by the given app, in execution order. | ||
| /// </summary> | ||
| /// <param name="appId">The Dapr App ID to filter by.</param> | ||
| /// <returns>An empty list when no match is found.</returns> | ||
| public IReadOnlyList<PropagatedHistoryEntry> FilterByAppId(string appId) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Im very adamant to have consistency across sdks. Can we ensure func names are consistent and not use
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @cicoyle I'll address this in a separate PR so I can avoid playing any more telephone here :) |
||
| { | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(appId); | ||
| return _entries | ||
| .Where(e => string.Equals(e.AppId, appId, StringComparison.OrdinalIgnoreCase)) | ||
| .ToList(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns a new <see cref="PropagatedHistory"/> containing only entries for the specified workflow name. | ||
| /// Returns every entry produced by the given instance, in execution order. | ||
| /// Usually a single entry, except when the same instance reappears via ContinueAsNew. | ||
| /// </summary> | ||
| /// <param name="workflowName">The workflow name to filter by.</param> | ||
| /// <returns>A filtered <see cref="PropagatedHistory"/> instance.</returns> | ||
| public PropagatedHistory FilterByWorkflowName(string workflowName) | ||
| /// <param name="instanceId">The workflow instance ID to filter by.</param> | ||
| /// <returns>An empty list when no match is found.</returns> | ||
| public IReadOnlyList<PropagatedHistoryEntry> FilterByInstanceId(string instanceId) | ||
| { | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(workflowName); | ||
| return new PropagatedHistory( | ||
| _entries.Where(e => string.Equals(e.WorkflowName, workflowName, StringComparison.Ordinal)).ToList()); | ||
| ArgumentException.ThrowIfNullOrWhiteSpace(instanceId); | ||
| return _entries | ||
| .Where(e => string.Equals(e.InstanceId, instanceId, StringComparison.Ordinal)) | ||
| .ToList(); | ||
| } | ||
| } | ||
|
WhitWaldo marked this conversation as resolved.
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // ------------------------------------------------------------------------ | ||
| // Copyright 2026 The Dapr Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // ------------------------------------------------------------------------ | ||
|
|
||
| namespace Dapr.Workflow; | ||
|
|
||
| /// <summary> | ||
| /// A reconstructed view of a single activity invocation surfaced through propagated workflow history. | ||
| /// </summary> | ||
| /// <param name="Name">The scheduled name of the activity.</param> | ||
| /// <param name="Started">Whether the activity was scheduled in the propagated history.</param> | ||
| /// <param name="Completed">Whether the activity completed successfully.</param> | ||
| /// <param name="Failed">Whether the activity failed.</param> | ||
| /// <param name="Input">The JSON-encoded input payload, or <c>null</c> when unset.</param> | ||
| /// <param name="Output">The JSON-encoded output payload, or <c>null</c> when the activity has not completed.</param> | ||
| /// <param name="FailureDetails">The failure details when <paramref name="Failed"/> is true, otherwise <c>null</c>.</param> | ||
| /// <remarks> | ||
| /// Mirrors the <c>ActivityResult</c> type in the Go and Python SDKs so cross-language | ||
| /// quickstarts and audit patterns line up. The <see cref="Started"/> / <see cref="Completed"/> | ||
| /// / <see cref="Failed"/> flags carry that parity; <see cref="Status"/> projects them onto a | ||
| /// single value for callers that prefer to <c>switch</c> on the lifecycle. | ||
| /// </remarks> | ||
| public sealed record PropagatedHistoryActivityResult( | ||
| string Name, | ||
| bool Started, | ||
| bool Completed, | ||
| bool Failed, | ||
| string? Input, | ||
| string? Output, | ||
| WorkflowTaskFailureDetails? FailureDetails) | ||
| { | ||
| /// <summary> | ||
| /// The resolved lifecycle status of this activity, derived from the | ||
| /// <see cref="Completed"/> and <see cref="Failed"/> flags. <see cref="Failed"/> takes | ||
| /// precedence over <see cref="Completed"/>. | ||
| /// </summary> | ||
| public PropagatedHistoryTaskStatus Status => | ||
| Failed ? PropagatedHistoryTaskStatus.Failed | ||
| : Completed ? PropagatedHistoryTaskStatus.Completed | ||
| : PropagatedHistoryTaskStatus.Pending; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // ------------------------------------------------------------------------ | ||
| // Copyright 2026 The Dapr Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // ------------------------------------------------------------------------ | ||
|
|
||
| namespace Dapr.Workflow; | ||
|
|
||
| /// <summary> | ||
| /// A reconstructed view of a single child workflow invocation surfaced through propagated workflow history. | ||
| /// </summary> | ||
| /// <param name="Name">The scheduled name of the child workflow.</param> | ||
| /// <param name="Started">Whether the child workflow was scheduled in the propagated history.</param> | ||
| /// <param name="Completed">Whether the child workflow completed successfully.</param> | ||
| /// <param name="Failed">Whether the child workflow failed.</param> | ||
| /// <param name="Output">The JSON-encoded output payload, or <c>null</c> when the child workflow has not completed.</param> | ||
| /// <param name="FailureDetails">The failure details when <paramref name="Failed"/> is true, otherwise <c>null</c>.</param> | ||
| /// <remarks> | ||
| /// Mirrors the <c>ChildWorkflowResult</c> type in the Go and Python SDKs. The | ||
| /// <see cref="Started"/> / <see cref="Completed"/> / <see cref="Failed"/> flags carry that | ||
| /// parity; <see cref="Status"/> projects them onto a single value for callers that prefer to | ||
| /// <c>switch</c> on the lifecycle. | ||
| /// </remarks> | ||
| public sealed record PropagatedHistoryChildWorkflowResult( | ||
| string Name, | ||
| bool Started, | ||
| bool Completed, | ||
| bool Failed, | ||
| string? Output, | ||
| WorkflowTaskFailureDetails? FailureDetails) | ||
| { | ||
| /// <summary> | ||
| /// The resolved lifecycle status of this child workflow, derived from the | ||
| /// <see cref="Completed"/> and <see cref="Failed"/> flags. <see cref="Failed"/> takes | ||
| /// precedence over <see cref="Completed"/>. | ||
| /// </summary> | ||
| public PropagatedHistoryTaskStatus Status => | ||
| Failed ? PropagatedHistoryTaskStatus.Failed | ||
| : Completed ? PropagatedHistoryTaskStatus.Completed | ||
| : PropagatedHistoryTaskStatus.Pending; | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The protos describe the type of history event returned. Is this not something meaningful to provide to the user?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lifecycle stage is captured by
Started/Completed/Failedbooleans on each result record — covers pending (Started && !Completed && !Failed) and matches go-sdk / python-sdk.HistoryEventKindremoved.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's premature to think that this might be the final state of the lifecycle functionality. A wall of flags in which one is only ever true seems cognitively confusing. I can anticipate developers preemptively asking if there's ever a situation in which more than one flag could ever be true at once - as this reflects a specific named lifecycle, no, in which case, it feels like a simpler effect here is to simply reflect the lifecycle enums of the original implementation. They needn't all be provided as only a subset are ever exposed here, but the idea is to think about how the SDK will be consumed most easily by developers, not just what's one of many ways to expose the concept.
Further, should additional lifecycle events be added, a wall of flag evaluations must be extended to properly rule out new lifecycle flags. But if the new enums aren't necessary, they can simply be ignored.
All told, let's use enums instead of flags.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pushing back here:
Started/Completed/Failedmirrors the go-sdkActivityResultstruct and python-sdkActivityResultdataclass, which is the whole point of this PR (cross-SDK parity Cassie flagged in #1801). Restoring a .NET-only enum would drop us back out of sync. The booleans are also not mutually exclusive over time —Started=true, Completed=false, Failed=falseis the pending state — so an enum would actually lose information. Happy to switch if you want parity drift, but want to call that out explicitly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a
PropagatedHistoryTaskStatusenum (Pending/Completed/Failed) with a computedStatusproperty on bothPropagatedHistoryActivityResultandPropagatedHistoryChildWorkflowResult, so callers canswitchon a single value instead of reading the three flags — and the enum extends cleanly if the runtime adds lifecycle states later.I kept the
Started/Completed/Failedbooleans alongside it: those are the field-level parity with the go-sdkActivityResult/ChildWorkflowResultstructs and the python-sdk dataclasses, andStatusis just a projection of them (withFailedtaking precedence overCompleted). That keeps the .NET surface in sync with the other SDKs while giving developers the single enum to consume. 5987d9cUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The design decisions behind the other SDKs isn't of much concern to me - those maintainers should do what is most appropriate per their own language conventions and express the functionality in ways that make it easier for their developers to consume their SDKs.
I weigh the perceived value of parity with other SDKs with the cost of expanding the public API and having to maintain two equivalent things going forward. I don't think a wall of flags is a developer-friendly way to communicate the state of something, so I appreciate you restoring the enum here.
Please modify the visibility of the flag fields to make them internal - should there ever be a need to make them publicly accessible, we can always introduce them later, but I'd rather this remain internal and not a part of the public API today.