Fix history events buildup from version reject (#1220)

When an orchestration was being rejected due to a versioning mismatch
an issue would cause the history events of the orchestration to build
continuously. This was caused by the orchestration adding an
OrchestrationStarted event before the versioning took place and was
saved even on a rejected version.

This change causes the versioning code to exit the process method
entirely instead of just prematurely end the process loop. This avoids
the commit of the history.

Signed-off-by: halspang <[email protected]>

Author: halspang

src/DurableTask.Core/TaskOrchestrationDispatcher.cs

@@ -406,7 +406,7 @@ protected async Task<bool> OnProcessWorkItemAsync(TaskOrchestrationWorkItem work
                                 else // Abandon work item in all other cases (will be retried later).
                                 {
                                     await this.orchestrationService.AbandonTaskOrchestrationWorkItemAsync(workItem);
-                                    break;
+                                    return true;
                                 }
                             }
                         }
@@ -1059,9 +1059,10 @@ TaskMessage ProcessScheduleTaskDecision(
                 eventId: scheduleTaskOrchestratorAction.Id,
                 name: scheduleTaskOrchestratorAction.Name,
                 version: scheduleTaskOrchestratorAction.Version,
-                input: scheduleTaskOrchestratorAction.Input) {
-                    Tags = scheduleTaskOrchestratorAction.Tags
-                };
+                input: scheduleTaskOrchestratorAction.Input)
+            {
+                Tags = scheduleTaskOrchestratorAction.Tags
+            };
 
             ActivitySpanId clientSpanId = ActivitySpanId.CreateRandom();
 
@@ -1080,9 +1081,10 @@ TaskMessage ProcessScheduleTaskDecision(
                 scheduledEvent = new TaskScheduledEvent(
                     eventId: scheduleTaskOrchestratorAction.Id,
                     name: scheduleTaskOrchestratorAction.Name,
-                    version: scheduleTaskOrchestratorAction.Version) {
-                        Tags = scheduleTaskOrchestratorAction.Tags
-                    };
+                    version: scheduleTaskOrchestratorAction.Version)
+                {
+                    Tags = scheduleTaskOrchestratorAction.Tags
+                };
 
                 if (parentTraceActivity != null)
                 {

test/DurableTask.AzureStorage.Tests/AzureStorageScenarioTests.cs

@@ -2518,6 +2518,9 @@ public async Task OrchestrationRejectsWithVersionMismatch()
                 status = await client.GetStatusAsync();
                 Assert.IsTrue(OrchestrationStatus.Running == status?.OrchestrationStatus || OrchestrationStatus.Pending == status?.OrchestrationStatus);
 
+                var history = await client.GetOrchestrationHistoryAsync(client.InstanceId);
+                Assert.AreEqual(0, history.Count, "A rejected orchestration should have no history as it should never have been started.");
+
                 await host.StopAsync();
             }
         }