Adding the ability to specify tags and a retry policy for suborchestrations

[sophiatev]

Issues / work items

• Resolves Support for sub-orchestration tags when a retry policy is specified #559

Project checklist

• Release notes are not required for the next release
  • Otherwise: Notes added to release_notes.md
• Backport is not required
  • Otherwise: Backport tracked by issue/PR #issue_or_pr
• All required tests have been added/updated (unit tests, E2E tests)
• Breaking change?
  • If yes:
    • Impact:
    • Migration guidance:

---

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

• No
• Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
• Yes, an AI agent generated most of this PR

If AI was used:

• Tool(s):
• AI-assisted areas/files:
• What you changed after AI output:

AI verification (required if AI was used):

• I understand the code and can explain it
• I verified referenced APIs/types exist and are correct
• I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
• I reviewed concurrency/async behavior
• I checked for unintended breaking or behavior changes

[Copilot]

Pull request overview

This PR adds support for specifying tags when calling suborchestrations with retry policies, resolving issue #559. The implementation ensures tags are properly propagated when retry policies are used.

Key changes:

• Updated TaskOrchestrationContextWrapper.cs to pass tags to CreateSubOrchestrationInstanceWithRetry
• Added integration test ScheduleSubOrchestrationWithTagsAndRetryPolicy to verify the new functionality

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
src/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs	Added options.Tags parameter to the CreateSubOrchestrationInstanceWithRetry call when a retry policy is specified
test/Grpc.IntegrationTests/OrchestrationPatterns.cs	Added integration test for suborchestrations with both tags and retry policy

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (1)

test/Grpc.IntegrationTests/OrchestrationPatterns.cs:175

• The test is missing the standard "Arrange", "Act", and "Assert" comments that help structure unit tests according to the project's C# Unit Test Guidelines. These comments should be added to clearly separate the test setup, execution, and verification phases.

    public async Task ScheduleSubOrchestrationWithTagsAndRetryPolicy()
    {
        TaskName orchestratorName = nameof(ScheduleSubOrchestrationWithTagsAndRetryPolicy);

        // Schedule a new orchestration instance with tags
        SubOrchestrationOptions subOrchestrationOptions = new()
        {
            InstanceId = "instance_id",
            Tags = new Dictionary<string, string>
            {
                { "tag1", "value1" },
                { "tag2", "value2" }
            },
            Retry = new RetryPolicy(maxNumberOfAttempts: 2, firstRetryInterval: TimeSpan.FromSeconds(5))
        };

        int failCounter = 0;
        await using HostTestLifetime server = await this.StartWorkerAsync(b =>
        {
            b.AddTasks(tasks => tasks.AddOrchestratorFunc<int, int>(orchestratorName, async (ctx, input) =>
            {
                if (failCounter < 1 && input == 2)
                {
                    failCounter++;
                    throw new Exception("Simulated failure");
                }

                int result = 1;
                if (input < 2)
                {
                    // recursively call this same orchestrator
                    result += await ctx.CallSubOrchestratorAsync<int>(orchestratorName, input: input + 1, subOrchestrationOptions);
                }

                return result;
            }));
        });

        // Confirm the first attempt failed
        await server.Client.ScheduleNewOrchestrationInstanceAsync(orchestratorName, input: 1);
        OrchestrationMetadata metadata = await server.Client.WaitForInstanceCompletionAsync(
            subOrchestrationOptions.InstanceId, this.TimeoutToken);
        Assert.NotNull(metadata);
        Assert.Equal(OrchestrationRuntimeStatus.Failed, metadata.RuntimeStatus);

        // Wait for the retry to happen
        while (metadata.RuntimeStatus != OrchestrationRuntimeStatus.Completed && !this.TimeoutToken.IsCancellationRequested)
        {
            await Task.Delay(TimeSpan.FromSeconds(1), this.TimeoutToken);
            metadata = await server.Client.WaitForInstanceCompletionAsync(
                subOrchestrationOptions.InstanceId, this.TimeoutToken);
        }

        // Confirm the second attempt succeeded
        Assert.Equal(OrchestrationRuntimeStatus.Completed, metadata.RuntimeStatus);
        Assert.NotNull(metadata.Tags);
        Assert.Equal(2, metadata.Tags.Count);
        Assert.Equal("value1", metadata.Tags["tag1"]);
        Assert.Equal("value2", metadata.Tags["tag2"]);
    }

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

test/Grpc.IntegrationTests/OrchestrationPatterns.cs:177

• This test lacks Arrange, Act, and Assert section comments which are recommended in the unit test guidelines for this repository. Adding these comments would improve test readability and make the test structure clearer.

    public async Task ScheduleSubOrchestrationWithTagsAndRetryPolicy()
    {
        TaskName orchestratorName = nameof(ScheduleSubOrchestrationWithTagsAndRetryPolicy);

        // Schedule a new orchestration instance with tags and a retry policy
        SubOrchestrationOptions subOrchestrationOptions = new()
        {
            InstanceId = "instance_id",
            Tags = new Dictionary<string, string>
            {
                { "tag1", "value1" },
                { "tag2", "value2" }
            },
            Retry = new RetryPolicy(maxNumberOfAttempts: 2, firstRetryInterval: TimeSpan.FromSeconds(15))
        };

        int failCounter = 0;
        await using HostTestLifetime server = await this.StartWorkerAsync(b =>
        {
            b.AddTasks(tasks => tasks.AddOrchestratorFunc<int, int>(orchestratorName, async (ctx, input) =>
            {
                if (failCounter < 1 && input == 2)
                {
                    failCounter++;
                    throw new Exception("Simulated failure");
                }

                int result = 1;
                if (input < 2)
                {
                    // recursively call this same orchestrator
                    result += await ctx.CallSubOrchestratorAsync<int>(orchestratorName, input: input + 1, subOrchestrationOptions);
                }

                return result;
            }));
        });
        using CancellationTokenSource timeoutTokenSource = new(TimeSpan.FromMinutes(1));

        // Confirm the first attempt failed
        await server.Client.ScheduleNewOrchestrationInstanceAsync(orchestratorName, input: 1);
        OrchestrationMetadata metadata = await server.Client.WaitForInstanceCompletionAsync(
            subOrchestrationOptions.InstanceId, timeoutTokenSource.Token);
        Assert.NotNull(metadata);
        Assert.Equal(OrchestrationRuntimeStatus.Failed, metadata.RuntimeStatus);

        // Wait for the retry to happen
        while (metadata.RuntimeStatus != OrchestrationRuntimeStatus.Completed && !timeoutTokenSource.Token.IsCancellationRequested)
        {
            await Task.Delay(TimeSpan.FromSeconds(1), timeoutTokenSource.Token);
            metadata = await server.Client.WaitForInstanceCompletionAsync(
                subOrchestrationOptions.InstanceId, timeoutTokenSource.Token);
        }

        // Confirm the second attempt succeeded
        Assert.Equal(OrchestrationRuntimeStatus.Completed, metadata.RuntimeStatus);
        Assert.NotNull(metadata.Tags);
        Assert.Equal(2, metadata.Tags.Count);
        Assert.Equal("value1", metadata.Tags["tag1"]);
        Assert.Equal("value2", metadata.Tags["tag2"]);
    }

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.