Skip to content

Fix the workflow execution order #1684

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
WhitWaldo merged 2 commits into from
Jan 27, 2026
Merged

Fix the workflow execution order #1684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
613b492
Fix the workflow execution order.
zglp Jan 26, 2026
eb68fa6
Add unit tests
zglp Jan 26, 2026
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
8 changes: 4 additions & 4 deletions src/Dapr.Workflow/Worker/WorkflowWorker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,17 +147,17 @@ private async Task<OrchestratorResponse> HandleOrchestratorResponseAsync(Orchest
object? input = string.IsNullOrEmpty(serializedInput)
? null
: _serializer.Deserialize(serializedInput, workflow!.InputType);

// Replay the old history to rebuild the local state of the orchestration.
context.ProcessEvents(allPastEvents, true);

// Execute the workflow
// IMPORTANT: Durable orchestrations intentionally "block" on incomplete tasks (activities, timers, events)
// during the first execution pass. We must NOT await indefinitely here; we need to return the pending actions.
// We run the workflow BEFORE processing new events so that the code reaches the 'await' points and registers tasks
// in _openTasks. Then, ProcessEvents(NewEvents) can satisfy those tasks.
var runTask = workflow!.RunAsync(context, input);


// Replay the old history to rebuild the local state of the orchestration.
context.ProcessEvents(allPastEvents, true);

// Play the newly arrived events to determine the next action to take.
context.ProcessEvents(request.NewEvents, false);

Expand Down
4 changes: 2 additions & 2 deletions test/Dapr.Workflow.Test/Worker/Internal/WorkflowOrchestrationContextTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ public async Task WaitForExternalEventAsync_ShouldReturnDeserializedValue_WhenEv
}

[Fact]
public async Task WaitForExternalEventAsync_ShouldReturnUncompletedTask_WhenEventInHistory()
public async Task WaitForExternalEventAsync_ShouldReturnCompletedTask_WhenEventInHistory()
{
var serializer = new JsonWorkflowSerializer(new JsonSerializerOptions(JsonSerializerDefaults.Web));

Expand Down Expand Up @@ -518,7 +518,7 @@ public async Task WaitForExternalEventAsync_ShouldReturnUncompletedTask_WhenEven
}

[Fact]
public async Task WaitForExternalEventAsync_WithTimeoutOverload_ShouldCancel_WhenEventReceived()
public async Task WaitForExternalEventAsync_WithTimeoutOverload_ShouldReturnCompletedTask_WhenEventReceived()
{
var serializer = new JsonWorkflowSerializer(new JsonSerializerOptions(JsonSerializerDefaults.Web));

Expand Down
240 changes: 240 additions & 0 deletions test/Dapr.Workflow.Test/Worker/WorkflowWorkerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -910,6 +910,246 @@ public async Task HandleOrchestratorResponseAsync_ShouldUseFirstEventTimestamp_W
Assert.Equal(string.Empty, complete.Result);
}

[Fact]
public async Task HandleOrchestratorResponseAsync_ShouldAdvanceCurrentUtcDateTime_WhenTimerFires()
{
var sp = new ServiceCollection().BuildServiceProvider();
var serializer = new JsonWorkflowSerializer(new JsonSerializerOptions(JsonSerializerDefaults.Web));
var options = new WorkflowRuntimeOptions();
var beginDateTime = new DateTime(2025, 01, 01, 12, 0, 0, DateTimeKind.Utc);

var factory = new StubWorkflowsFactory();
factory.AddWorkflow("wf", new InlineWorkflow(
inputType: typeof(int),
run: async (ctx, input) =>
{
Assert.Equal(beginDateTime, ctx.CurrentUtcDateTime);
await ctx.CreateTimer(TimeSpan.FromSeconds(5));
Assert.Equal(beginDateTime.AddSeconds(5), ctx.CurrentUtcDateTime);

return null;
}));

var worker = new WorkflowWorker(
CreateGrpcClientMock().Object,
factory,
NullLoggerFactory.Instance,
serializer,
sp,
options);

var request = new OrchestratorRequest
{
InstanceId = "i",
PastEvents =
{
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime),
ExecutionStarted = new ExecutionStartedEvent
{
Name = "wf",
Input = "123"
}
},
new HistoryEvent
{
EventId = 0,
TimerCreated = new TimerCreatedEvent
{
FireAt = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5))
}
},
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5)),
OrchestratorStarted = new OrchestratorStartedEvent()
},
new HistoryEvent
{
TimerFired = new TimerFiredEvent
{
TimerId = 0,
FireAt = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5))
}
}
}
};

var response = await InvokeHandleOrchestratorResponseAsync(worker, request);

Assert.Equal("i", response.InstanceId);
var complete = response.Actions.Single(a => a.CompleteOrchestration != null).CompleteOrchestration!;
Assert.Equal(OrchestrationStatus.Completed, complete.OrchestrationStatus);
Assert.Equal(string.Empty, complete.Result);
}

[Fact]
public async Task HandleOrchestratorResponseAsync_ShouldCompleted_WhenEventReceived()
{
var sp = new ServiceCollection().BuildServiceProvider();
var serializer = new JsonWorkflowSerializer(new JsonSerializerOptions(JsonSerializerDefaults.Web));
var options = new WorkflowRuntimeOptions();
var beginDateTime = new DateTime(2025, 01, 01, 12, 0, 0, DateTimeKind.Utc);

var factory = new StubWorkflowsFactory();
factory.AddWorkflow("wf", new InlineWorkflow(
inputType: typeof(int),
run: async (ctx, input) =>
{
await ctx.WaitForExternalEventAsync<object>("MyEvent", TimeSpan.FromSeconds(5));
return null;
}));

var worker = new WorkflowWorker(
CreateGrpcClientMock().Object,
factory,
NullLoggerFactory.Instance,
serializer,
sp,
options);

var request = new OrchestratorRequest
{
InstanceId = "i",
PastEvents =
{
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime),
ExecutionStarted = new ExecutionStartedEvent
{
Name = "wf",
Input = "123"
}
},
new HistoryEvent
{
EventId = 0,
TimerCreated = new TimerCreatedEvent
{
FireAt = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5))
}
},
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(2)),
OrchestratorStarted = new OrchestratorStartedEvent()
},
new HistoryEvent
{
EventRaised = new EventRaisedEvent
{
Name = "myevent"
}
},
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5)),
OrchestratorStarted = new OrchestratorStartedEvent()
},
new HistoryEvent
{
TimerFired = new TimerFiredEvent
{
TimerId = 0,
FireAt = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5))
}
}
}
};

var response = await InvokeHandleOrchestratorResponseAsync(worker, request);

Assert.Equal("i", response.InstanceId);
var complete = response.Actions.Single(a => a.CompleteOrchestration != null).CompleteOrchestration!;
Assert.Equal(OrchestrationStatus.Completed, complete.OrchestrationStatus);
Assert.Equal(string.Empty, complete.Result);
}

[Fact]
public async Task HandleOrchestratorResponseAsync_ShouldReturnFailureDetails_WhenTimerFires()
{
var sp = new ServiceCollection().BuildServiceProvider();
var serializer = new JsonWorkflowSerializer(new JsonSerializerOptions(JsonSerializerDefaults.Web));
var options = new WorkflowRuntimeOptions();
var beginDateTime = new DateTime(2025, 01, 01, 12, 0, 0, DateTimeKind.Utc);

var factory = new StubWorkflowsFactory();
factory.AddWorkflow("wf", new InlineWorkflow(
inputType: typeof(int),
run: async (ctx, input) =>
{
await ctx.WaitForExternalEventAsync<object>("MyEvent", TimeSpan.FromSeconds(5));
return null;
}));

var worker = new WorkflowWorker(
CreateGrpcClientMock().Object,
factory,
NullLoggerFactory.Instance,
serializer,
sp,
options);

var request = new OrchestratorRequest
{
InstanceId = "i",
PastEvents =
{
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime),
ExecutionStarted = new ExecutionStartedEvent
{
Name = "wf",
Input = "123"
}
},
new HistoryEvent
{
EventId = 0,
TimerCreated = new TimerCreatedEvent
{
FireAt = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5))
}
},
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5)),
OrchestratorStarted = new OrchestratorStartedEvent()
},
new HistoryEvent
{
TimerFired = new TimerFiredEvent
{
TimerId = 0,
FireAt = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(5))
}
},
new HistoryEvent
{
Timestamp = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(beginDateTime.AddSeconds(10)),
OrchestratorStarted = new OrchestratorStartedEvent()
},
new HistoryEvent
{
EventRaised = new EventRaisedEvent
{
Name = "myevent"
}
}
}
};

var response = await InvokeHandleOrchestratorResponseAsync(worker, request);

Assert.Equal("i", response.InstanceId);
var complete = response.Actions.Single(a => a.CompleteOrchestration != null).CompleteOrchestration!;
Assert.Equal(OrchestrationStatus.Failed, complete.OrchestrationStatus);
Assert.NotNull(complete.FailureDetails);
}

[Fact]
public async Task HandleActivityResponseAsync_ShouldUseEmptyInstanceId_WhenOrchestrationInstanceIsNull_AndReturnEmptyResult_WhenOutputIsNull()
{
Expand Down