Skip to content
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

Versioning3 proto updates for data plane APIs #463

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

ShahabT
Copy link
Contributor

@ShahabT ShahabT commented Oct 10, 2024

What changed?

  • Added "deployment_name" field to WorkerVersionStamp and WorkerVersionCapabilities so this info is sent in the poll requests and task completion commands coming from SDK.
  • Added versioning_behavior field to RespondWorkflowTaskCompletedRequest so SDK can sent the workflow versioning annotation to server when a workflow task completes.
  • Added build_id, versioning_behavior, and deployment_name fields to WorkflowExecutionInfo (Mutable State) so server can use the info for routing tasks.

Why?
Needed for versioning-3 API.

Breaking changes
None.

Server PR
None.

@ShahabT ShahabT requested review from a team as code owners October 10, 2024 07:12
// Workflow automatically moves to the latest version (default build ID of the task queue) when the next
// task is dispatched.
VERSIONING_BEHAVIOR_AUTO_UPGRADE = 2;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Auto-upgrade" behavior seemed a better name than "unpinned". But we can change the name later when namings are final. cc @drewhoskins-temporal @antlai-temporal

Comment on lines 355 to 357
temporal.api.enums.v1.VersioningBehavior versioning_behavior = 14;
// Default versioning behavior that is set at worker server level.
temporal.api.enums.v1.VersioningBehavior default_versioning_behavior = 15;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Asking SDK to send both explicit and default annotations so we can have visibility on what/how users set these.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cretz
Copy link
Member

cretz commented Oct 10, 2024

This all looks good to me from a syntax/consistency POV, but will defer SDK approval to @antlai-temporal.

If at all possible, would like to recommend that at least most of the implementation be done server side before this PR is merged to ensure there isn't anything missing.

@ShahabT
Copy link
Contributor Author

ShahabT commented Oct 10, 2024

Thanks @cretz, this is being merged to a feature branch right now. We'll merge it to main once the server implementation is ready.

@ShahabT ShahabT merged commit d30ca7a into versioning-3 Oct 11, 2024
2 checks passed
@ShahabT ShahabT deleted the shahab/init-proto branch October 11, 2024 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants