Add ContinueAsNewOptions with NewVersion support by YunchuWang · Pull Request #682 · microsoft/durabletask-dotnet

wangbill (YunchuWang) · 2026-03-21T07:09:20Z

Summary

This PR adds support for specifying a new orchestration version when calling ContinueAsNew, enabling version migration scenarios for long-running orchestrations.

Fixes#672

Changes

New: `ContinueAsNewOptions` class

Added ContinueAsNewOptions with a NewVersion property that allows callers to specify the version the next generation of the orchestration should run as.

Updated: `TaskOrchestrationContext`

Added a new virtual overload: ContinueAsNew(ContinueAsNewOptions) that accepts the options class.
Default implementation delegates to the existing abstract ContinueAsNew(object?, bool) method, preserving backward compatibility.

Updated: `TaskOrchestrationContextWrapper`

Overrides the new method to call the DurableTask.Core two-parameter ContinueAsNew(string newVersion) when NewVersion is specified.

Tests

3 unit tests in TaskOrchestrationContextWrapperTests: verify version propagation, null-version fallback, and preserveUnprocessedEvents passthrough.
1 integration test (ContinueAsNewWithNewVersion): end-to-end validation that an orchestrator can migrate from no version to v2 and read back ctx.Version correctly.

E2E Testing Results

Test	Backend	Result
`ContinueAsNewWithNewVersion` (in-process)	Core dispatcher + emulator	PASSED
Azure Functions + Azurite	Azure Storage via Core dispatcher	Data flow verified — logs confirm gen 1 sends `NewVersion='v2'` and Core creates `ExecutionStartedEvent` with `version=v2`. Gen 2 rejected by extension's default `versionMatchStrategy: CurrentOrOlder` (see note below), so orchestration never completed E2E.
DTS Beskar integration test	In-memory Beskar backend	PASSED (with PR #3 fix) — `Assert.Equal("v2", metadata.ReadOutputAs<string>())`

Azure Functions versionMatchStrategy note: When gen 2 arrives with version v2 and the worker has no declared version, the default CurrentOrOlder strategy rejects it. Users must set "versionMatchStrategy": "None" in host.json or deploy a new worker with the target version. This is a pre-existing config constraint, not a bug in these PRs.

Downstream Changes Required

Release Order: This PR (#1) must merge first and publish a new NuGet package. Then PRs #2 and #3 can be merged (they depend on the ContinueAsNewOptions type from this package).

#	Repo	PR	What's Needed	Status
1	`durabletask-dotnet`	This PR (#682)	SDK: `ContinueAsNewOptions` + `TaskOrchestrationContextWrapper` override	Ready for review
2	`azure-functions-durable-extension`	#3404	`FunctionsOrchestrationContext` override to delegate new 3-param `ContinueAsNew` to inner context	Depends on #1 NuGet publish
3	`AAPT-DTMB`	ADO PR #15133055	`PartitionGrain.WorkItems.cs`: use `action.CompleteOrchestration.NewVersion` in `ExecutionStartedEvent` + integration test	Depends on #1 NuGet publish

History

ContinueAsNew(string newVersion, object input) has existed in DurableTask.Core since Oct 2014 (initial commit by Affan Dar)
CompleteOrchestrationAction.newVersion (proto field 4) has existed since Jan 2022 (initial protobuf commit by Chris Gillum)
The portable SDK abstraction in durabletask-dotnet was the only layer that never exposed newVersion — until now

Motivation

See #672 — users need to evolve orchestration logic over time. The underlying infrastructure (proto field CompleteOrchestrationAction.newVersion, Core dispatcher, gRPC sidecar) all already support version changes on ContinueAsNew, but the portable SDK abstraction layer (TaskOrchestrationContext) had no way to pass a new version through.

Copilot

Pull request overview

This PR adds an SDK-level mechanism to specify a target orchestration version when calling ContinueAsNew, enabling version migration for long-running (eternal) orchestrations while keeping existing ContinueAsNew(object?, bool) implementations working.

Changes:

Introduces ContinueAsNewOptions with a NewVersion property in the public abstractions layer.
Adds a new TaskOrchestrationContext.ContinueAsNew(ContinueAsNewOptions, object?, bool) overload and wires it through TaskOrchestrationContextWrapper to DurableTask.Core’s versioned ContinueAsNew.
Adds unit + integration tests validating version propagation and fallback behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/Abstractions/ContinueAsNewOptions.cs	Adds a new options type carrying `NewVersion`.
src/Abstractions/TaskOrchestrationContext.cs	Adds a virtual `ContinueAsNew` overload that accepts `ContinueAsNewOptions`.
src/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs	Implements the versioned continue-as-new behavior when `NewVersion` is provided.
test/Worker/Core.Tests/Shims/TaskOrchestrationContextWrapperTests.cs	Unit tests validating wrapper behavior with/without version.
test/Grpc.IntegrationTests/OrchestrationPatterns.cs	End-to-end integration test validating version migration via `ContinueAsNew`.
src/Abstractions/TaskOrchestrator.cs	Updates XML doc cref to reference the intended `ContinueAsNew` overload explicitly.

…rsion migration

…st class

Copilot

Pull request overview

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

Copilot

Pull request overview

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

…ity with ContinueAsNew(null, false)

Address review feedback from cgillum: fold newInput and preserveUnprocessedEvents into ContinueAsNewOptions so the new overload takes a single ContinueAsNewOptions parameter. - Add NewInput and PreserveUnprocessedEvents properties to ContinueAsNewOptions - Change ContinueAsNew(ContinueAsNewOptions?, object?, bool) to ContinueAsNew(ContinueAsNewOptions) - Update TaskOrchestrationContextWrapper to match - Update unit and integration tests

Copilot

Pull request overview

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

…ationContext Forward the new ContinueAsNew overload that accepts ContinueAsNewOptions (with NewVersion) to the inner context. Without this override, the base class default silently drops the options, preventing version migration via ContinueAsNew from working in Azure Functions isolated worker. Depends on: microsoft/durabletask-dotnet#682 (adds ContinueAsNewOptions) Requires bumping Microsoft.DurableTask.Worker.Grpc to the version that includes ContinueAsNewOptions.

Update Microsoft.DurableTask.Client.Grpc, Worker.Grpc, and Abstractions from 1.23.0 to 1.23.1 in Directory.Packages.props (CPM). Version 1.23.1 includes ContinueAsNewOptions from microsoft/durabletask-dotnet#682. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings March 21, 2026 07:09

Copilotstarted reviewing on behalf of wangbill (YunchuWang)March 21, 2026 07:10 View session

github-code-qualityBot found potential problems Mar 21, 2026
View reviewed changes

Comment threadsrc/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs Fixed
Comment threadsrc/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs Fixed

CopilotAI reviewed Mar 21, 2026
View reviewed changes

Add ContinueAsNewOptions with NewVersion support for orchestration ve…
32efcc8
…rsion migration

wangbill (YunchuWang)force-pushed the wangbill/continue-as-new-version branch from 9256bad to 32efcc8Compare March 21, 2026 07:14

Address PR review: fix nullability, remove default, fix typo, seal te…
a8a98e9
…st class

CopilotAI review requested due to automatic review settings March 21, 2026 07:24

Copilotstarted reviewing on behalf of wangbill (YunchuWang)March 21, 2026 07:25 View session

CopilotAI reviewed Mar 21, 2026
View reviewed changes

Comment threadsrc/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs Outdated
Comment threadsrc/Abstractions/TaskOrchestrationContext.cs Outdated
Comment threadtest/Worker/Core.Tests/Shims/TaskOrchestrationContextWrapperTests.cs

Address round 2: guard empty version, update XML docs
c344e34

CopilotAI review requested due to automatic review settings March 21, 2026 16:29

wangbill (YunchuWang)force-pushed the wangbill/continue-as-new-version branch from 4708a53 to c344e34Compare March 21, 2026 16:29

Copilotstarted reviewing on behalf of wangbill (YunchuWang)March 21, 2026 16:30 View session

CopilotAI reviewed Mar 21, 2026
View reviewed changes

Comment threadsrc/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs Outdated
Comment threadsrc/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs Outdated

Update src/Worker/Core/Shims/TaskOrchestrationContextWrapper.cs
d5f10a7
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings March 21, 2026 16:56

Copilotstarted reviewing on behalf of wangbill (YunchuWang)March 21, 2026 16:56 View session

CopilotAI reviewed Mar 21, 2026
View reviewed changes

Comment threadsrc/Abstractions/TaskOrchestrationContext.cs Outdated

wangbill (YunchuWang) mentioned this pull request Mar 21, 2026
Add .github/copilot-review-instructions.md to reduce noisy automated PR comments #683
Closed

Remove preserveUnprocessedEvents default to eliminate overload ambigu…
916e1e3
…ity with ContinueAsNew(null, false)

wangbill (YunchuWang) mentioned this pull request Mar 21, 2026
Add ContinueAsNew(ContinueAsNewOptions) override to FunctionsOrchestrationContext Azure/azure-functions-durable-extension#3404
Merged

wangbill (YunchuWang) added the ready for review label Mar 22, 2026

Chris Gillum (cgillum) reviewed Mar 23, 2026
View reviewed changes

Comment threadsrc/Abstractions/TaskOrchestrationContext.cs Outdated

CopilotAI review requested due to automatic review settings March 23, 2026 22:59

Copilotstarted reviewing on behalf of wangbill (YunchuWang)March 23, 2026 23:00 View session

CopilotAI reviewed Mar 23, 2026
View reviewed changes

Comment threadsrc/Abstractions/TaskOrchestrationContext.cs

wangbill (YunchuWang) requested a review from Chris Gillum (cgillum)March 23, 2026 23:31

Chris Gillum (cgillum) approved these changes Mar 24, 2026
View reviewed changes

wangbill (YunchuWang) merged commit c3aa262 into mainMar 24, 2026
12 checks passed

wangbill (YunchuWang) deleted the wangbill/continue-as-new-version branch March 24, 2026 17:42

This was referenced Apr 1, 2026
[nuget][Find]- Bump the find-package-updates group with 7 updates DFE-Digital/single-unique-identifier#548
Closed
[nuget][Find]- Bump the find-package-updates group with 8 updates DFE-Digital/single-unique-identifier#560
Closed

This was referenced May 7, 2026
[nuget][Find]- Bump Azure.Identity and 23 others DFE-Digital/single-unique-identifier#605
Closed
[nuget][Find]- Bump the find-package-updates group with 24 updates DFE-Digital/single-unique-identifier#610
Closed

This was referenced May 19, 2026
[nuget][Find]- Bump the find-package-updates group with 25 updates DFE-Digital/single-unique-identifier#630
Closed
[nuget][Find]- Bump the find-package-updates group with 25 updates DFE-Digital/single-unique-identifier#636
Closed

This was referenced Jun 3, 2026
[nuget][Find]- Bump the find-package-updates group with 25 updates DFE-Digital/single-unique-identifier#653
Closed
[nuget][Find]- Bump Azure.Identity and 24 others DFE-Digital/single-unique-identifier#666
Closed

dependabotBot mentioned this pull request Jun 16, 2026
[nuget][Find]- Bump Azure.Identity and 24 others DFE-Digital/single-unique-identifier#676
Closed

dependabotBot mentioned this pull request Jul 14, 2026
[nuget][Find]- Bump the find-package-updates group with 6 updates DFE-Digital/single-unique-identifier#713
Closed

Navigation Menu

Uh oh!

Add ContinueAsNewOptions with NewVersion support - #682

Add ContinueAsNewOptions with NewVersion support#682
wangbill (YunchuWang) merged 6 commits into
mainfrom
wangbill/continue-as-new-version

wangbill (YunchuWang) commented Mar 21, 2026•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

wangbill (YunchuWang) commented Mar 21, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

New: ContinueAsNewOptions class

Updated: TaskOrchestrationContext

Updated: TaskOrchestrationContextWrapper

Tests

E2E Testing Results

Downstream Changes Required

History

Motivation

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wangbill (YunchuWang) commented Mar 21, 2026•
edited
Loading

New: `ContinueAsNewOptions` class

Updated: `TaskOrchestrationContext`

Updated: `TaskOrchestrationContextWrapper`