Fixed comments

Author: torosent

Directory.Packages.props

@@ -76,6 +76,7 @@
     <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="6.0.0" />
     <PackageVersion Include="System.Linq.Async" Version="6.0.1" />
     <PackageVersion Include="System.Text.Json" Version="6.0.10" />
+    <PackageVersion Include="System.Collections.Immutable" Version="6.0.1" />
   </ItemGroup>
 
 </Project>

src/Abstractions/Abstractions.csproj

@@ -12,6 +12,7 @@
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     <PackageReference Include="System.Text.Json" />
+    <PackageReference Include="System.Collections.Immutable"/>
   </ItemGroup>
 
   <ItemGroup>

src/Abstractions/TaskOptions.cs

@@ -103,7 +103,32 @@ public SubOrchestrationOptions(TaskOptions options, string? instanceId = null)
 public record StartOrchestrationOptions(string? InstanceId = null, DateTimeOffset? StartAt = null)
 {
     /// <summary>
-    /// Gets or sets the tags to associate with the orchestration instance. Tags are key-value pairs that can be used.
+    /// Gets the tags to associate with the orchestration instance. Tags are key-value pairs that can be used.
     /// </summary>
-    public IDictionary<string, string>? Tags { get; init; } = new Dictionary<string, string>();
+    public IEnumerable<KeyValuePair<string, string>> Tags { get; private set; } = System.Collections.Immutable.ImmutableDictionary.Create<string, string>();
+
+    /// <summary>
+    /// Returns a new <see cref="StartOrchestrationOptions"/> with the provided tags added to the existing tags.
+    /// </summary>
+    /// <param name="tags">The tags to add.</param>
+    /// <returns>A new <see cref="StartOrchestrationOptions"/> with the combined tags.</returns>
+    public StartOrchestrationOptions AddTags(IEnumerable<KeyValuePair<string, string>> tags)
+    {
+        var currentTags = this.Tags as System.Collections.Immutable.ImmutableDictionary<string, string>
+            ?? System.Collections.Immutable.ImmutableDictionary.Create<string, string>();
+        return this with { Tags = currentTags.AddRange(tags) };
+    }
+
+    /// <summary>
+    /// Returns a new <see cref="StartOrchestrationOptions"/> with the provided tag added to the existing tags.
+    /// </summary>
+    /// <param name="key">The tag key.</param>
+    /// <param name="value">The tag value.</param>
+    /// <returns>A new <see cref="StartOrchestrationOptions"/> with the combined tags.</returns>
+    public StartOrchestrationOptions AddTag(string key, string value)
+    {
+        var currentTags = this.Tags as System.Collections.Immutable.ImmutableDictionary<string, string>
+            ?? System.Collections.Immutable.ImmutableDictionary.Create<string, string>();
+        return this with { Tags = currentTags.Add(key, value) };
+    }
 }

src/Client/Core/OrchestrationMetadata.cs

@@ -82,7 +82,7 @@ public OrchestrationMetadata(string name, string instanceId)
     /// <summary>
     /// Gets the tags associated with the orchestration instance.
     /// </summary>
-    public IReadOnlyDictionary<string, string> Tags { get; init; } = new Dictionary<string, string>();
+    public IDictionary<string, string> Tags { get; } = new Dictionary<string, string>();
 
     /// <summary>
     /// Gets the failure details, if any, for the orchestration instance.

src/Client/Grpc/GrpcDurableTaskClient.cs

@@ -457,7 +457,7 @@ async Task<PurgeResult> PurgeInstancesCoreAsync(
 
     OrchestrationMetadata CreateMetadata(P.OrchestrationState state, bool includeInputsAndOutputs)
     {
-        return new(state.Name, state.InstanceId)
+        var metadata = new OrchestrationMetadata(state.Name, state.InstanceId)
         {
             CreatedAt = state.CreatedTimestamp.ToDateTimeOffset(),
             LastUpdatedAt = state.LastUpdatedTimestamp.ToDateTimeOffset(),
@@ -467,7 +467,13 @@ OrchestrationMetadata CreateMetadata(P.OrchestrationState state, bool includeInp
             SerializedCustomStatus = state.CustomStatus,
             FailureDetails = state.FailureDetails.ToTaskFailureDetails(),
             DataConverter = includeInputsAndOutputs ? this.DataConverter : null,
-            Tags = state.Tags.ToDictionary(x => x.Key, x => x.Value),
         };
+
+        foreach (var tag in state.Tags)
+        {
+            metadata.Tags.Add(tag.Key, tag.Value);
+        }
+
+        return metadata;
     }
 }

src/Client/OrchestrationServiceClientShim/ShimDurableTaskClient.cs

@@ -3,7 +3,6 @@
 
 using System.Diagnostics.CodeAnalysis;
 using DurableTask.Core;
-using DurableTask.Core.Entities;
 using DurableTask.Core.History;
 using DurableTask.Core.Query;
 using Microsoft.DurableTask.Client.Entities;
@@ -176,7 +175,7 @@ public override async Task<string> ScheduleNewOrchestrationInstanceAsync(
                 Version = orchestratorName.Version,
                 OrchestrationInstance = instance,
                 ScheduledStartTime = options?.StartAt?.UtcDateTime,
-                Tags = options?.Tags,
+                Tags = options?.Tags != null ? options.Tags.ToDictionary(kvp => kvp.Key, kvp => kvp.Value) : null,
             },
         };
 

test/Client/OrchestrationServiceClientShim.Tests/ShimDurableTaskClientTests.cs

@@ -316,14 +316,19 @@ public async Task ScheduleNewOrchestrationInstance_IdProvided_TagsProvided()
         StartOrchestrationOptions options = new()
         {
             InstanceId = "test-id",
-            Tags = new Dictionary<string, string>()
-            {
-                { "tag1", "value1" },
-                { "tag2", "value2" }
-            }
         };
+        options.AddTag("key", "value");
+        options.AddTag("key2", "value2");
 
         await this.RunScheduleNewOrchestrationInstanceAsync("test", "input", options);
+
+        OrchestrationMetadata metadata = await this.client.WaitForInstanceStartAsync(
+           options.InstanceId, false, default);
+
+        this.orchestrationClient.Verify(
+            m => m.CreateTaskOrchestrationAsync(MatchStartExecutionMessage("test", "input", options)),
+            Times.Once());
+        metadata.Tags.Should().HaveCount(2);
     }
 
 

test/Grpc.IntegrationTests/IntegrationTestBase.cs

@@ -40,7 +40,6 @@ public IntegrationTestBase(ITestOutputHelper output, GrpcSidecarFixture sidecarF
     void IDisposable.Dispose()
     {
         this.testTimeoutSource.Dispose();
-        this.sidecarFixture.Dispose();
         GC.SuppressFinalize(this);
     }
 

test/Grpc.IntegrationTests/OrchestrationPatterns.cs

@@ -7,6 +7,7 @@
 using Microsoft.DurableTask.Tests.Logging;
 using Microsoft.DurableTask.Worker;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 using Xunit.Abstractions;
 
 namespace Microsoft.DurableTask.Grpc.Tests;
@@ -44,14 +45,11 @@ public async Task ScheduleOrchesrationWithTags()
             b.AddTasks(tasks => tasks.AddOrchestratorFunc(orchestratorName, ctx => Task.FromResult<object?>(null)));
         });
 
-        string instanceId = await server.Client.ScheduleNewOrchestrationInstanceAsync(orchestratorName, new StartOrchestrationOptions
-        {
-            Tags = new Dictionary<string, string>()
-            {
-                { "tag1", "value1" },
-                { "tag2", "value2" }
-            }
-        });
+        // Schedule a new orchestration instance with tags
+        var options = new StartOrchestrationOptions();
+        options.AddTag("tag1", "value1");
+        options.AddTag("tag2", "value2");
+        string instanceId = await server.Client.ScheduleNewOrchestrationInstanceAsync(orchestratorName, options);
 
         OrchestrationMetadata metadata = await server.Client.WaitForInstanceCompletionAsync(
             instanceId, this.TimeoutToken);
@@ -202,14 +200,7 @@ public async Task SingleActivity()
                 .AddActivityFunc<string, string>(sayHelloActivityName, (ctx, name) => $"Hello, {name}!"));
         });
 
-        string instanceId = await server.Client.ScheduleNewOrchestrationInstanceAsync(orchestratorName, input: "World", new StartOrchestrationOptions
-        {
-            Tags = new Dictionary<string, string>()
-            {
-                { "tag1", "value1" },
-                { "tag2", "value2" }
-            }
-        });
+        string instanceId = await server.Client.ScheduleNewOrchestrationInstanceAsync(orchestratorName, input: "World");
         OrchestrationMetadata metadata = await server.Client.WaitForInstanceCompletionAsync(
             instanceId, getInputsAndOutputs: true, this.TimeoutToken);
         Assert.NotNull(metadata);