-
Notifications
You must be signed in to change notification settings - Fork 19
Add upgrade-on-continue-as-new snippet for docs #739
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bchav
wants to merge
4
commits into
main
Choose a base branch
from
add-upgrade-on-can-snippet
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
features/deployment_versioning/upgrade_on_continue_as_new/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Upgrade on Continue-as-New | ||
|
|
||
| This snippet demonstrates how a pinned Workflow can upgrade to a new Worker Deployment Version at Continue-as-New boundaries. | ||
|
|
||
| ## Pattern | ||
|
|
||
| Long-running Workflows that use Continue-as-New can upgrade to newer Worker Deployment Versions without patching by: | ||
|
|
||
| 1. Checking `GetContinueAsNewSuggested()` periodically | ||
| 2. Looking for `ContinueAsNewSuggestedReasonTargetWorkerDeploymentVersionChanged` | ||
| 3. Using `ContinueAsNewVersioningBehaviorAutoUpgrade` when continuing | ||
|
|
||
| ## Use Cases | ||
|
|
||
| - Entity Workflows running for months or years | ||
| - Batch processing Workflows that checkpoint with Continue-as-New | ||
| - AI agent Workflows with long sleeps waiting for user input |
175 changes: 175 additions & 0 deletions
175
features/deployment_versioning/upgrade_on_continue_as_new/feature.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| package upgrade_on_continue_as_new | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/temporalio/features/features/deployment_versioning" | ||
| "github.com/temporalio/features/harness/go/harness" | ||
| "go.temporal.io/sdk/client" | ||
| "go.temporal.io/sdk/worker" | ||
| "go.temporal.io/sdk/workflow" | ||
| ) | ||
|
|
||
| var Feature = harness.Feature{ | ||
| Workflows: []interface{}{ | ||
| harness.WorkflowWithOptions{ | ||
| Workflow: ContinueAsNewWithVersionUpgrade, | ||
| Options: workflow.RegisterOptions{ | ||
| Name: "ContinueAsNewWithVersionUpgrade", | ||
| VersioningBehavior: workflow.VersioningBehaviorPinned, | ||
| }, | ||
| }, | ||
| }, | ||
| WorkerOptions: worker.Options{ | ||
| DeploymentOptions: worker.DeploymentOptions{ | ||
| UseVersioning: true, | ||
| Version: v1, | ||
| }, | ||
| }, | ||
| Execute: Execute, | ||
| ExpectRunResult: "v2.0", | ||
| } | ||
|
|
||
| // @@@SNIPSTART upgrade-on-continue-as-new-go | ||
| // ContinueAsNewWithVersionUpgrade demonstrates how a pinned Workflow can | ||
| // upgrade to a new Worker Deployment Version at Continue-as-New boundaries. | ||
| // The Workflow checks for the TARGET_WORKER_DEPLOYMENT_VERSION_CHANGED reason | ||
| // and uses AutoUpgrade behavior to move to the new version. | ||
| func ContinueAsNewWithVersionUpgrade(ctx workflow.Context, attempt int) (string, error) { | ||
| if attempt > 0 { | ||
| // After continuing as new, return the version | ||
| return "v1.0", nil | ||
| } | ||
|
|
||
| // Check continue-as-new-suggested periodically | ||
| for { | ||
| err := workflow.Sleep(ctx, 10*time.Millisecond) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| info := workflow.GetInfo(ctx) | ||
| if info.GetContinueAsNewSuggested() { | ||
| for _, reason := range info.GetContinueAsNewSuggestedReasons() { | ||
| if reason == workflow.ContinueAsNewSuggestedReasonTargetWorkerDeploymentVersionChanged { | ||
| // A new Worker Deployment Version is available | ||
| // Continue-as-New with upgrade to the new version | ||
| return "", workflow.NewContinueAsNewErrorWithOptions( | ||
| ctx, | ||
| workflow.ContinueAsNewErrorOptions{ | ||
| InitialVersioningBehavior: workflow.ContinueAsNewVersioningBehaviorAutoUpgrade, | ||
| }, | ||
| "ContinueAsNewWithVersionUpgrade", | ||
| attempt+1, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // @@@SNIPEND | ||
|
|
||
| func ContinueAsNewWithVersionUpgradeV2( | ||
| ctx workflow.Context, | ||
| attempt int, | ||
| ) (string, error) { | ||
| return "v2.0", nil | ||
| } | ||
|
|
||
| var deploymentName = uuid.NewString() | ||
| var v1 = worker.WorkerDeploymentVersion{ | ||
| DeploymentName: deploymentName, | ||
| BuildID: "1.0", | ||
| } | ||
| var v2 = worker.WorkerDeploymentVersion{ | ||
| DeploymentName: deploymentName, | ||
| BuildID: "2.0", | ||
| } | ||
|
|
||
| var worker2 worker.Worker | ||
|
|
||
| func Execute(ctx context.Context, r *harness.Runner) (client.WorkflowRun, error) { | ||
| if supported := deployment_versioning.ServerSupportsDeployments(ctx, r); !supported { | ||
| return nil, r.Skip(fmt.Sprintf("server does not support deployment versioning")) | ||
| } | ||
|
|
||
| // Two workers: | ||
| // 1.0) and 2.0) both with no default versioning behavior | ||
| // SetCurrent to 1.0 | ||
| // Workflow (annotated as Pinned): | ||
| // - Start and wait for continue-as-new-suggested boolean | ||
| // - If continue-as-new-suggested is true and the reason is version-changed, continue as new with AutoUpgrade behavior | ||
| // Verify workflow returns 2.0. | ||
|
|
||
| // Define v2.0 of the workflow and start polling | ||
| worker2 = worker.New(r.Client, r.TaskQueue, worker.Options{ | ||
| DeploymentOptions: worker.DeploymentOptions{ | ||
| UseVersioning: true, | ||
| Version: v2, | ||
| }, | ||
| }) | ||
| worker2.RegisterWorkflowWithOptions(ContinueAsNewWithVersionUpgradeV2, workflow.RegisterOptions{ | ||
| Name: "ContinueAsNewWithVersionUpgrade", | ||
| VersioningBehavior: workflow.VersioningBehaviorPinned, | ||
| }) | ||
| if err := worker2.Start(); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Wait for the deployment to be ready | ||
| dHandle := r.Client.WorkerDeploymentClient().GetHandle(deploymentName) | ||
| if err := deployment_versioning.WaitForDeployment(r, ctx, dHandle); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Wait for version 1.0 to be ready | ||
| if err := deployment_versioning.WaitForDeploymentVersion(r, ctx, dHandle, v1); err != nil { | ||
| return nil, err | ||
| } | ||
| // Set version 1.0 as current | ||
| if err := deployment_versioning.SetCurrent(r, ctx, deploymentName, v1); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Wait for v1.0-as-Current Deployment Routing Config to be propagated to all task queues | ||
| if err := deployment_versioning.WaitForWorkerDeploymentRoutingConfigPropagation(r, ctx, deploymentName, v1.BuildID, ""); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| run, err := r.Client.ExecuteWorkflow(ctx, client.StartWorkflowOptions{ | ||
| TaskQueue: r.TaskQueue, | ||
| ID: "continueasnew-with-version-upgrade", | ||
| WorkflowExecutionTimeout: 1 * time.Minute, | ||
| }, "ContinueAsNewWithVersionUpgrade", 0) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // Wait for workflow to complete one WFT on v1.0 | ||
| if err := deployment_versioning.WaitForWorkflowRunning(r, ctx, run); err != nil { | ||
| return nil, err | ||
| } | ||
| // Wait for version 2.0 to be ready | ||
| if err := deployment_versioning.WaitForDeploymentVersion(r, ctx, dHandle, v2); err != nil { | ||
| return nil, err | ||
| } | ||
| // Set version 2.0 as current | ||
| if err := deployment_versioning.SetCurrent(r, ctx, deploymentName, v2); err != nil { | ||
| return nil, err | ||
| } | ||
| // Wait for v2.0-as-Current Deployment Routing Config to be propagated to all task queues | ||
| if err := deployment_versioning.WaitForWorkerDeploymentRoutingConfigPropagation(r, ctx, deploymentName, v2.BuildID, ""); err != nil { | ||
| return nil, err | ||
| } | ||
| return run, nil | ||
| } | ||
|
|
||
| func CheckHistory(ctx context.Context, r *harness.Runner, run client.WorkflowRun) error { | ||
| // Shut down the 2.0 worker | ||
| worker2.Stop() | ||
| return r.CheckHistoryDefault(ctx, run) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The features repo is for asserting conformance across languages. It's basically a test suite. There is no assertion aspect or even use of this workflow. I wonder if
samples-gowould fit what you're wanting a bit more.