Skip to content

Workflow versioning #21

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Nov 27, 2025
Merged

Workflow versioning #21

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bfb2843
Workflow patches
acroca Oct 22, 2025
dd9692d
Moved versioning information to OrchestratorStartedEvent
acroca Nov 10, 2025
7d26724
Added `VERSION_PENDING` state for workflows waiting for actor dissemi…
acroca Nov 11, 2025
330ef46
Rename to PendingVersion
acroca Nov 25, 2025
872e097
Removed workflowType field, as it's not implemented yet
acroca Nov 25, 2025
c6ce25c
Use pendingReason to identify the reason why an orchestration is pending
acroca Nov 25, 2025
094c6ee
group response versioning information in a specific message
acroca Nov 26, 2025
5bb8e1c
Removed unnecessary `patchMismatch` and reuse versioning information
acroca Nov 26, 2025
229b7c2
Renamed fields to be more specific
acroca Nov 27, 2025
7b90a17
Renamed state to stalled
acroca Nov 27, 2025
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
14 changes: 13 additions & 1 deletion protos/orchestrator_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ message TaskRouter {
optional string targetAppID = 2;
}

message OrchestrationVersioningInformation {
Copy link

@JoshVanL JoshVanL Nov 27, 2025

Choose a reason for hiding this comment

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

Information is superfluous. Should use the noun "Version".

Suggested change
message OrchestrationVersioningInformation {
message OrchestrationVersion {

repeated string patches = 1;
}

message OrchestrationInstance {
string instanceId = 1;
google.protobuf.StringValue executionId = 2;
Expand Down Expand Up @@ -57,6 +61,7 @@ enum OrchestrationStatus {
ORCHESTRATION_STATUS_TERMINATED = 5;
ORCHESTRATION_STATUS_PENDING = 6;
ORCHESTRATION_STATUS_SUSPENDED = 7;
ORCHESTRATION_STATUS_PENDING_PATCH_MISMATCH = 8;
Copy link
Member Author

@acroca acroca Nov 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Q: Based on this comment, do we really want to have different PENDING_ status every time we add a new reason for a workflow to enter a temporary pending status?

Copy link

@JoshVanL JoshVanL Nov 27, 2025

Choose a reason for hiding this comment

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

Makes sense, let's have a single PENDING OrchestrationStatus, with typed enum reasons.

}

message ParentInstanceInfo {
Expand Down Expand Up @@ -162,7 +167,7 @@ message TimerFiredEvent {
}

message OrchestratorStartedEvent {
// No payload data
optional OrchestrationVersioningInformation versioningInformation = 1;
Copy link

@JoshVanL JoshVanL Nov 27, 2025

Choose a reason for hiding this comment

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

Suggested change
optional OrchestrationVersioningInformation versioningInformation = 1;
optional OrchestrationVersion version = 1;

}

message OrchestratorCompletedEvent {
Expand Down Expand Up @@ -200,6 +205,10 @@ message ExecutionResumedEvent {
google.protobuf.StringValue input = 1;
}

message ExecutionPendingVersionEvent {
Copy link

@JoshVanL JoshVanL Nov 27, 2025

Choose a reason for hiding this comment

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

Suggested change
message ExecutionPendingVersionEvent {
message ExecutionPending {
PendingReason reason = 1;
// Ideally we would have more stringy information here which would tell the user what went wrong, which will be surfaced in `dapr workfow history` etc.
}

// No payload data
}

message EntityOperationSignaledEvent {
string requestId = 1;
string operation = 2;
Expand Down Expand Up @@ -276,6 +285,7 @@ message HistoryEvent {
EntityLockRequestedEvent entityLockRequested = 27;
EntityLockGrantedEvent entityLockGranted = 28;
EntityUnlockSentEvent entityUnlockSent = 29;
ExecutionPendingVersionEvent executionPendingVersion = 31;
Copy link

@JoshVanL JoshVanL Nov 27, 2025

Choose a reason for hiding this comment

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

Suggested change
ExecutionPendingVersionEvent executionPendingVersion = 31;
ExecutionPending executionPending = 31;

}
optional TaskRouter router = 30;
}
Expand Down Expand Up @@ -364,6 +374,8 @@ message OrchestratorResponse {
// The number of work item events that were processed by the orchestrator.
// This field is optional. If not set, the service should assume that the orchestrator processed all events.
google.protobuf.Int32Value numEventsProcessed = 5;

optional OrchestrationVersioningInformation versioningInformation = 6;
}

message CreateInstanceRequest {
Expand Down
5 changes: 5 additions & 0 deletions protos/runtime_state.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ import "orchestrator_service.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";

enum PendingReason {
PATCH_MISMATCH = 0;
}

// OrchestrationRuntimeState holds the current state for an orchestration.
message OrchestrationRuntimeState {
string instanceId = 1;
Expand All @@ -42,6 +46,7 @@ message OrchestrationRuntimeState {
bool isSuspended = 13;

google.protobuf.StringValue customStatus = 14;
optional PendingReason pendingReason = 15;
}

// OrchestrationRuntimeStateMessage holds an OrchestratorMessage and the target instance ID.
Expand Down