Initial push for adding orchestration reuse ID

Signed-off-by: Ryan Lettieri <[email protected]>

src/Abstractions/Internal/IOrchestrationSubmitter.cs

@@ -27,6 +27,7 @@ public interface IOrchestrationSubmitter
     /// The optional input to pass to the scheduled orchestration instance. This must be a serializable value.
     /// </param>
     /// <param name="options">The options to start the new orchestration with.</param>
+    /// <param name="orchestrationIdReusePolicy">The policy for reusing an orchestration ID.</param>
     /// <param name="cancellation">
     /// The cancellation token. This only cancels enqueueing the new orchestration to the backend. Does not cancel the
     /// orchestration once enqueued.
@@ -40,5 +41,6 @@ Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName,
         object? input = null,
         StartOrchestrationOptions? options = null,
+        HashSet<string>? orchestrationIdReusePolicy = null,
         CancellationToken cancellation = default);
 }

src/Client/Core/DurableTaskClient.cs

@@ -51,20 +51,25 @@ protected DurableTaskClient(string name)
     public virtual DurableEntityClient Entities =>
         throw new NotSupportedException($"{this.GetType()} does not support durable entities.");
 
-    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, CancellationToken)"/>
+    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, HashSet, CancellationToken)"/>
     public virtual Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName, CancellationToken cancellation)
-        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, null, null, cancellation);
+        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, null, null, null, cancellation);
 
-    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, CancellationToken)"/>
+    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, HashSet, CancellationToken)"/>
     public virtual Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName, object? input, CancellationToken cancellation)
-        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, input, null, cancellation);
+        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, input, null, null, cancellation);
 
-    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, CancellationToken)"/>
+    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, HashSet, CancellationToken)"/>
     public virtual Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName, StartOrchestrationOptions options, CancellationToken cancellation = default)
-        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, null, options, cancellation);
+        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, null, options, null, cancellation);
+
+    /// <inheritdoc cref="ScheduleNewOrchestrationInstanceAsync(TaskName, object, StartOrchestrationOptions, HashSet, CancellationToken)"/>
+    public virtual Task<string> ScheduleNewOrchestrationInstanceAsync(
+        TaskName orchestratorName, StartOrchestrationOptions options, HashSet<string> orchestrationIdReusePolicy, CancellationToken cancellation = default)
+        => this.ScheduleNewOrchestrationInstanceAsync(orchestratorName, null, null, orchestrationIdReusePolicy, cancellation);
 
     /// <summary>
     /// Schedules a new orchestration instance for execution.
@@ -96,6 +101,9 @@ public virtual Task<string> ScheduleNewOrchestrationInstanceAsync(
     /// The optional input to pass to the scheduled orchestration instance. This must be a serializable value.
     /// </param>
     /// <param name="options">The options to start the new orchestration with.</param>
+    /// <param name="orchestrationIdReusePolicy">
+    /// The orchestration reuse policy. This allows for the reuse of an instance ID as well as the options for it.
+    /// </param>
     /// <param name="cancellation">
     /// The cancellation token. This only cancels enqueueing the new orchestration to the backend. Does not cancel the
     /// orchestration once enqueued.
@@ -110,6 +118,7 @@ public abstract Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName,
         object? input = null,
         StartOrchestrationOptions? options = null,
+        HashSet<string>? orchestrationIdReusePolicy = null,
         CancellationToken cancellation = default);
 
     /// <inheritdoc cref="RaiseEventAsync(string, string, object, CancellationToken)"/>

src/Client/Core/Entities/DurableEntityClient.cs

@@ -31,6 +31,7 @@ protected DurableEntityClient(string name)
     /// <param name="operationName">The name of the operation.</param>
     /// <param name="input">The input for the operation.</param>
     /// <param name="options">The options to signal the entity with.</param>
+    /// <param name="orchestrationIdReusePolicy">The policy for reusing an orchestration ID.</param>
     /// <param name="cancellation">The cancellation token to cancel enqueuing of the operation.</param>
     /// <returns>A task that completes when the message has been reliably enqueued.</returns>
     /// <remarks>This does not wait for the operation to be processed by the receiving entity.</remarks>
@@ -39,6 +40,7 @@ public abstract Task SignalEntityAsync(
         string operationName,
         object? input = null,
         SignalEntityOptions? options = null,
+        HashSet<string>? orchestrationIdReusePolicy = null,
         CancellationToken cancellation = default);
 
     /// <summary>
@@ -55,7 +57,7 @@ public virtual Task SignalEntityAsync(
         string operationName,
         SignalEntityOptions options,
         CancellationToken cancellation = default)
-        => this.SignalEntityAsync(id, operationName, null, options, cancellation);
+        => this.SignalEntityAsync(id, operationName, null, options, null, cancellation);
 
     /// <summary>
     /// Signals an entity to perform an operation.
@@ -69,7 +71,7 @@ public virtual Task SignalEntityAsync(
         EntityInstanceId id,
         string operationName,
         CancellationToken cancellation)
-        => this.SignalEntityAsync(id, operationName, null, null, cancellation);
+        => this.SignalEntityAsync(id, operationName, null, null, null, cancellation);
 
     /// <summary>
     /// Tries to get the entity with ID of <paramref name="id"/>. Includes entity state by default.

src/Client/Grpc/GrpcDurableEntityClient.cs

@@ -41,6 +41,7 @@ public override async Task SignalEntityAsync(
         string operationName,
         object? input = null,
         SignalEntityOptions? options = null,
+        HashSet<string>? orchestrationIdReusePolicy = null,
         CancellationToken cancellation = default)
     {
         Check.NotNullOrEmpty(id.Name);

src/Client/Grpc/GrpcDurableTaskClient.cs

@@ -73,6 +73,7 @@ public override async Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName,
         object? input = null,
         StartOrchestrationOptions? options = null,
+        HashSet<string>? orchestrationIdReusePolicy = null,
         CancellationToken cancellation = default)
     {
         Check.NotEntity(this.options.EnableEntitySupport, options?.InstanceId);
@@ -83,6 +84,7 @@ public override async Task<string> ScheduleNewOrchestrationInstanceAsync(
             Version = orchestratorName.Version,
             InstanceId = options?.InstanceId ?? Guid.NewGuid().ToString("N"),
             Input = this.DataConverter.Serialize(input),
+            OrchestrationIdReusePolicy = { },
         };
 
         DateTimeOffset? startAt = options?.StartAt;

src/Client/OrchestrationServiceClientShim/ShimDurableTaskClient.cs

@@ -130,6 +130,7 @@ public override async Task<string> ScheduleNewOrchestrationInstanceAsync(
         TaskName orchestratorName,
         object? input = null,
         StartOrchestrationOptions? options = null,
+        HashSet<string>? orchestrationIdReusePolicy = null,
         CancellationToken cancellation = default)
     {
         cancellation.ThrowIfCancellationRequested();

test/Client/Core.Tests/DependencyInjection/DefaultDurableTaskClientBuilderTests.cs

@@ -116,6 +116,7 @@ public override Task<string> ScheduleNewOrchestrationInstanceAsync(
             TaskName orchestratorName,
             object? input = null,
             StartOrchestrationOptions? options = null,
+            HashSet<string>? orchestrationIdReusePolicy = null,
             CancellationToken cancellation = default)
         {
             throw new NotImplementedException();