Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions src/Dapr.Workflow.Abstractions/ActivityResult.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// ------------------------------------------------------------------------
// 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 from propagated history.
/// </summary>
/// <param name="Name">The scheduled name of the activity.</param>
/// <param name="Started">Whether the activity was scheduled in the propagated chunk.</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> struct in the Go SDK and the
/// <c>ActivityResult</c> dataclass in the Python SDK so cross-language
/// quickstarts and chain-of-custody patterns line up.
/// </remarks>
public sealed record ActivityResult(
string Name,
bool Started,
bool Completed,
bool Failed,
string? Input,
string? Output,
WorkflowTaskFailureDetails? FailureDetails);
34 changes: 34 additions & 0 deletions src/Dapr.Workflow.Abstractions/ChildWorkflowResult.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// ------------------------------------------------------------------------
// 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 from propagated 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 chunk.</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.
/// </remarks>
public sealed record ChildWorkflowResult(
Comment thread
WhitWaldo marked this conversation as resolved.
Outdated
string Name,
bool Started,
bool Completed,
bool Failed,
string? Output,
WorkflowTaskFailureDetails? FailureDetails);
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// ------------------------------------------------------------------------
// 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;

using System;

/// <summary>
/// Thrown when a query against propagated workflow history finds no match.
/// </summary>
/// <remarks>
/// Raised by <see cref="PropagatedHistory.GetLastWorkflowByName"/>,
/// <see cref="WorkflowResult.GetLastActivityByName"/>, and
/// <see cref="WorkflowResult.GetLastChildWorkflowByName"/> when the requested
/// name is not present in the propagated history chain. Use the plural
/// <c>Get*sByName</c> variants if you want an empty-list result instead.
/// </remarks>
public sealed class PropagationNotFoundException : Exception
{
/// <summary>
/// Initializes a new instance of <see cref="PropagationNotFoundException"/>.
/// </summary>
public PropagationNotFoundException()
{
}

/// <summary>
/// Initializes a new instance of <see cref="PropagationNotFoundException"/> with a message.
/// </summary>
/// <param name="message">The exception message.</param>
public PropagationNotFoundException(string message) : base(message)
{
}

/// <summary>
/// Initializes a new instance of <see cref="PropagationNotFoundException"/> with a message
/// and inner exception.
/// </summary>
/// <param name="message">The exception message.</param>
/// <param name="innerException">The underlying cause.</param>
public PropagationNotFoundException(string message, Exception innerException) : base(message, innerException)
{
}
}
115 changes: 0 additions & 115 deletions src/Dapr.Workflow.Abstractions/HistoryEventKind.cs

Copy link
Copy Markdown
Contributor

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?

Copy link
Copy Markdown
Contributor Author

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 / Failed booleans on each result record — covers pending (Started && !Completed && !Failed) and matches go-sdk / python-sdk. HistoryEventKind removed.

Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Contributor Author

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/Failed mirrors the go-sdk ActivityResult struct and python-sdk ActivityResult dataclass, 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=false is 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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a PropagatedHistoryTaskStatus enum (Pending/Completed/Failed) with a computed Status property on both PropagatedHistoryActivityResult and PropagatedHistoryChildWorkflowResult, so callers can switch on 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/Failed booleans alongside it: those are the field-level parity with the go-sdk ActivityResult/ChildWorkflowResult structs and the python-sdk dataclasses, and Status is just a projection of them (with Failed taking precedence over Completed). That keeps the .NET surface in sync with the other SDKs while giving developers the single enum to consume. 5987d9c

@WhitWaldo WhitWaldo May 27, 2026

Copy link
Copy Markdown
Contributor

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.

This file was deleted.

116 changes: 80 additions & 36 deletions src/Dapr.Workflow.Abstractions/PropagatedHistory.cs
Comment thread
WhitWaldo marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -18,68 +18,112 @@ namespace Dapr.Workflow;
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 a parent workflow 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 composed of one or more chunks, each owned by a distinct
/// workflow instance. Chunks preserve execution order: index 0 is the oldest ancestor,
/// the last chunk is the immediate parent.
/// <para>
/// Use the <c>Get*</c> methods to walk the chain by app, instance, or workflow name.
/// Mirrors the <c>PropagatedHistory</c> type in the Go and Python SDKs.
/// </para>
/// </remarks>
public sealed class PropagatedHistory
{
private readonly IReadOnlyList<PropagatedHistoryEntry> _entries;
private readonly IReadOnlyList<WorkflowResult> _workflows;

/// <summary>
/// Initializes a new instance of <see cref="PropagatedHistory"/> with the given entries.
/// Initializes a new <see cref="PropagatedHistory"/> from the given workflow chunks.
/// </summary>
/// <param name="entries">The propagated history entries from ancestor workflows.</param>
public PropagatedHistory(IReadOnlyList<PropagatedHistoryEntry> entries)
/// <param name="workflows">
/// Workflow chunks in execution order (ancestor first, immediate parent last).
/// </param>
public PropagatedHistory(IReadOnlyList<WorkflowResult> workflows)
{
_entries = entries ?? throw new ArgumentNullException(nameof(entries));
_workflows = workflows ?? throw new ArgumentNullException(nameof(workflows));
}

/// <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 workflow chunk in the chain, in execution order
/// (ancestor first, immediate parent last).
/// </summary>
public IReadOnlyList<PropagatedHistoryEntry> Entries => _entries;
public IReadOnlyList<WorkflowResult> GetWorkflows() => _workflows;

/// <summary>
/// Returns a new <see cref="PropagatedHistory"/> containing only entries from the specified App ID.
/// Returns an ordered, deduplicated list of app IDs in the propagated chain.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"chain" -> "list of propagated history events"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done — applied verbatim.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we know for a fact that propagated history will never include anything other than workflows? I don't know that and we have no roadmap indicating if this feature will evolve in the future. As this is a public method, I would rather retain the more generic "GetEntries()" name to keep our option open without introducing future breaking changes.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushing back here too: GetWorkflows() matches the go-sdk PropagatedHistory.GetWorkflows() and python-sdk equivalents. Renaming to GetEntries() puts .NET out of sync with the other SDKs and undoes the parity goal. If/when the runtime extends propagated history beyond workflows, all SDKs would rev together. Keeping the current name.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed GetWorkflows()GetEntries() so the name stays scope-neutral if propagated history ever carries non-workflow entries. Applied the same reasoning to the sibling filters (see the FilterByWorkflowName thread). 5987d9c

/// </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.Ordinal);
Comment thread
nelson-parente marked this conversation as resolved.
Outdated
var result = new List<string>(_workflows.Count);
foreach (var workflow in _workflows)
{
if (seen.Add(workflow.AppId))
{
result.Add(workflow.AppId);
}
}

return result;
}

/// <summary>
/// Returns a new <see cref="PropagatedHistory"/> containing only the entry with the specified instance ID.
/// Returns every workflow whose name matches, in execution order. Useful when the
/// chain contains the same name more than once (e.g. recursion or ContinueAsNew).
Comment thread
WhitWaldo marked this conversation as resolved.
Outdated
/// </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<WorkflowResult> GetWorkflowsByName(string name)
{
ArgumentException.ThrowIfNullOrWhiteSpace(instanceId);
return new PropagatedHistory(
_entries.Where(e => string.Equals(e.InstanceId, instanceId, StringComparison.Ordinal)).ToList());
ArgumentException.ThrowIfNullOrWhiteSpace(name);
return _workflows
.Where(w => string.Equals(w.Name, name, StringComparison.Ordinal))
.ToList();
Comment thread
WhitWaldo marked this conversation as resolved.
}

/// <summary>
/// Returns the most recent workflow in the chain whose name matches.
/// </summary>
/// <param name="name">The workflow name to look up.</param>
/// <returns>The last matching workflow chunk.</returns>
/// <exception cref="PropagationNotFoundException">No workflow with the given name is present in the chain.</exception>
public WorkflowResult GetLastWorkflowByName(string name)
{
ArgumentException.ThrowIfNullOrWhiteSpace(name);
var matches = GetWorkflowsByName(name);
if (matches.Count == 0)
{
throw new PropagationNotFoundException($"no workflow named '{name}' in propagated history");
}

return matches[^1];
}

/// <summary>
/// Returns every workflow chunk 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<WorkflowResult> GetWorkflowsByAppId(string appId)
{
ArgumentException.ThrowIfNullOrWhiteSpace(appId);
return _workflows
.Where(w => string.Equals(w.AppId, appId, StringComparison.Ordinal))
.ToList();
Comment thread
nelson-parente marked this conversation as resolved.
Outdated
}

/// <summary>
/// Returns a new <see cref="PropagatedHistory"/> containing only entries for the specified workflow name.
/// Returns every workflow chunk produced by the given instance, in execution order.
Comment thread
WhitWaldo marked this conversation as resolved.
Outdated
/// 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<WorkflowResult> GetWorkflowsByInstanceId(string instanceId)
{
ArgumentException.ThrowIfNullOrWhiteSpace(workflowName);
return new PropagatedHistory(
_entries.Where(e => string.Equals(e.WorkflowName, workflowName, StringComparison.Ordinal)).ToList());
ArgumentException.ThrowIfNullOrWhiteSpace(instanceId);
return _workflows
.Where(w => string.Equals(w.InstanceId, instanceId, StringComparison.Ordinal))
.ToList();
}
}
Loading
Loading