Fix versioning stuff

Author: gow

temporalcli/commands.gen.go

@@ -315,15 +315,17 @@ func (v *QueryModifiersOptions) buildFlags(cctx *CommandContext, f *pflag.FlagSe
 }
 
 type WorkflowUpdateOptionsOptions struct {
-	VersioningOverrideBehavior      StringEnum
-	VersioningOverridePinnedVersion string
+	VersioningOverrideBehavior       StringEnum
+	VersioningOverrideDeploymentName string
+	VersioningOverrideBuildId        string
 }
 
 func (v *WorkflowUpdateOptionsOptions) buildFlags(cctx *CommandContext, f *pflag.FlagSet) {
-	v.VersioningOverrideBehavior = NewStringEnum([]string{"pinned", "auto_upgrade"}, "")
-	f.Var(&v.VersioningOverrideBehavior, "versioning-override-behavior", "Override the versioning behavior of a Workflow. Accepted values: pinned, auto_upgrade. Required.")
+	v.VersioningOverrideBehavior = NewStringEnum([]string{"unspecified", "pinned", "auto_upgrade"}, "")
+	f.Var(&v.VersioningOverrideBehavior, "versioning-override-behavior", "Override the versioning behavior of a Workflow. Accepted values: unspecified, pinned, auto_upgrade. Required.")
 	_ = cobra.MarkFlagRequired(f, "versioning-override-behavior")
-	f.StringVar(&v.VersioningOverridePinnedVersion, "versioning-override-pinned-version", "", "Override Pinned Version for a Worker Deployment (Only for pinned).")
+	f.StringVar(&v.VersioningOverrideDeploymentName, "versioning-override-deployment-name", "", "When overriding to a `pinned` behavior, specifies the Deployment Name of the version to target.")
+	f.StringVar(&v.VersioningOverrideBuildId, "versioning-override-build-id", "", "When overriding to a `pinned` behavior, specifies the Build ID of the version to target.")
 }
 
 type TemporalCommand struct {

temporalcli/commands.workflow_reset_update_options.go

@@ -3,7 +3,7 @@ package temporalcli
 import (
 	"fmt"
 
-	"go.temporal.io/api/enums/v1"
+	deploymentpb "go.temporal.io/api/deployment/v1"
 	workflowpb "go.temporal.io/api/workflow/v1"
 	"google.golang.org/protobuf/types/known/fieldmaskpb"
 )
@@ -14,11 +14,15 @@ func (c *TemporalWorkflowResetWithWorkflowUpdateOptionsCommand) run(cctx *Comman
 		return err
 	}
 
-	if c.VersioningOverrideBehavior.Value == "pinned" && c.VersioningOverridePinnedVersion == "" {
-		return fmt.Errorf("missing version with 'pinned' behavior")
+	if c.VersioningOverrideBehavior.Value == "pinned" {
+		if c.VersioningOverrideDeploymentName == "" || c.VersioningOverrideBuildId == "" {
+			return fmt.Errorf("deployment name and build id are required with 'pinned' behavior")
+		}
 	}
-	if c.VersioningOverrideBehavior.Value != "pinned" && c.VersioningOverridePinnedVersion != "" {
-		return fmt.Errorf("cannot set pinned version with %v behavior", c.VersioningOverrideBehavior)
+	if c.VersioningOverrideBehavior.Value != "pinned" {
+		if c.VersioningOverrideDeploymentName != "" || c.VersioningOverrideBuildId != "" {
+			return fmt.Errorf("cannot set deployment name or build id with %v behavior", c.VersioningOverrideBehavior.Value)
+		}
 	}
 
 	cl, err := c.Parent.Parent.ClientOptions.dialClient(cctx)
@@ -27,12 +31,22 @@ func (c *TemporalWorkflowResetWithWorkflowUpdateOptionsCommand) run(cctx *Comman
 	}
 	defer cl.Close()
 
-	var behavior enums.VersioningBehavior
+	VersioningOverride := &workflowpb.VersioningOverride{}
 	switch c.VersioningOverrideBehavior.Value {
 	case "pinned":
-		behavior = enums.VERSIONING_BEHAVIOR_PINNED
+		VersioningOverride.Override = &workflowpb.VersioningOverride_Pinned{
+			Pinned: &workflowpb.VersioningOverride_PinnedOverride{
+				Behavior: workflowpb.VersioningOverride_PINNED_OVERRIDE_BEHAVIOR_PINNED,
+				Version: &deploymentpb.WorkerDeploymentVersion{
+					DeploymentName: c.VersioningOverrideDeploymentName,
+					BuildId:        c.VersioningOverrideBuildId,
+				},
+			},
+		}
 	case "auto_upgrade":
-		behavior = enums.VERSIONING_BEHAVIOR_AUTO_UPGRADE
+		VersioningOverride.Override = &workflowpb.VersioningOverride_AutoUpgrade{
+			AutoUpgrade: true,
+		}
 	default:
 		return fmt.Errorf("invalid deployment behavior: %v, valid values are: 'pinned', and 'auto_upgrade'", c.VersioningOverrideBehavior)
 	}
@@ -47,10 +61,7 @@ func (c *TemporalWorkflowResetWithWorkflowUpdateOptionsCommand) run(cctx *Comman
 		Variant: &workflowpb.PostResetOperation_UpdateWorkflowOptions_{
 			UpdateWorkflowOptions: &workflowpb.PostResetOperation_UpdateWorkflowOptions{
 				WorkflowExecutionOptions: &workflowpb.WorkflowExecutionOptions{
-					VersioningOverride: &workflowpb.VersioningOverride{
-						Behavior:      behavior,
-						PinnedVersion: c.VersioningOverridePinnedVersion,
-					},
+					VersioningOverride: VersioningOverride,
 				},
 				UpdateMask: protoMask,
 			},

temporalcli/commands.workflow_reset_update_options_test.go

@@ -35,7 +35,7 @@ func (s *SharedServerSuite) TestWorkflow_ResetWithWorkflowUpdateOptions_Validate
 		"--versioning-override-behavior", "pinned",
 	)
 	require.Error(s.T(), res.Err)
-	require.Contains(s.T(), res.Err.Error(), "missing version with 'pinned' behavior")
+	require.Contains(s.T(), res.Err.Error(), "deployment name and build id are required with 'pinned' behavior")
 }
 
 func (s *SharedServerSuite) TestWorkflow_ResetWithWorkflowUpdateOptions_ValidatesArguments_AutoUpgradeWithVersion() {
@@ -46,10 +46,10 @@ func (s *SharedServerSuite) TestWorkflow_ResetWithWorkflowUpdateOptions_Validate
 		"-t", "FirstWorkflowTask",
 		"--reason", "test-reset",
 		"--versioning-override-behavior", "auto_upgrade",
-		"--versioning-override-pinned-version", "some-version",
+		"--versioning-override-deployment-name", "some-deployment",
 	)
 	require.Error(s.T(), res.Err)
-	require.Contains(s.T(), res.Err.Error(), "cannot set pinned version with")
+	require.Contains(s.T(), res.Err.Error(), "cannot set deployment name or build id with auto_upgrade behavior")
 }
 
 func (s *SharedServerSuite) TestWorkflow_ResetWithWorkflowUpdateOptions_Single_AutoUpgradeBehavior() {
@@ -122,15 +122,17 @@ func (s *SharedServerSuite) TestWorkflow_ResetWithWorkflowUpdateOptions_Single_P
 	s.Equal(1, wfExecutions)
 
 	// Reset with pinned versioning behavior and properly formatted version
-	pinnedVersion := "test-deployment.v1.0"
+	pinnedDeploymentName := "test-deployment"
+	pinnedBuildId := "v1.0"
 	res := s.Execute(
 		"workflow", "reset", "with-workflow-update-options",
 		"--address", s.Address(),
 		"-w", run.GetID(),
 		"-t", "FirstWorkflowTask",
 		"--reason", "test-reset-with-pinned-version",
 		"--versioning-override-behavior", "pinned",
-		"--versioning-override-pinned-version", pinnedVersion,
+		"--versioning-override-deployment-name", pinnedDeploymentName,
+		"--versioning-override-build-id", pinnedBuildId,
 	)
 	require.NoError(s.T(), res.Err)
 
@@ -150,8 +152,7 @@ func (s *SharedServerSuite) TestWorkflow_ResetWithWorkflowUpdateOptions_Single_P
 
 		info := descResult.GetWorkflowExecutionInfo()
 		pinnedVersionOverride := info.VersioningInfo.VersioningOverride.GetPinned().GetVersion()
-		pinnedVersionOverrideString := pinnedVersionOverride.GetDeploymentName() + "." + pinnedVersionOverride.GetBuildId()
-		return pinnedVersionOverrideString == pinnedVersion // the second execution should have the pinned version override.
+		return pinnedVersionOverride.GetDeploymentName() == pinnedDeploymentName && pinnedVersionOverride.GetBuildId() == pinnedBuildId
 	}, 5*time.Second, 100*time.Millisecond)
 }
 
@@ -226,7 +227,8 @@ func (s *SharedServerSuite) TestWorkflow_ResetBatchWithWorkflowUpdateOptions_Pin
 	s.Equal(1, wfExecutions)
 
 	// Reset batch with pinned versioning behavior and properly formatted version
-	pinnedVersion := "batch-deployment.v1.0"
+	pinnedDeploymentName := "batch-deployment"
+	pinnedBuildId := "v1.0"
 	s.CommandHarness.Stdin.WriteString("y\n")
 	res := s.Execute(
 		"workflow", "reset", "with-workflow-update-options",
@@ -235,7 +237,8 @@ func (s *SharedServerSuite) TestWorkflow_ResetBatchWithWorkflowUpdateOptions_Pin
 		"-t", "FirstWorkflowTask",
 		"--reason", "test-batch-reset-with-pinned-version",
 		"--versioning-override-behavior", "pinned",
-		"--versioning-override-pinned-version", pinnedVersion,
+		"--versioning-override-deployment-name", pinnedDeploymentName,
+		"--versioning-override-build-id", pinnedBuildId,
 	)
 	require.NoError(s.T(), res.Err)
 
@@ -255,8 +258,7 @@ func (s *SharedServerSuite) TestWorkflow_ResetBatchWithWorkflowUpdateOptions_Pin
 
 		info := descResult.GetWorkflowExecutionInfo()
 		pinnedVersionOverride := info.VersioningInfo.VersioningOverride.GetPinned().GetVersion()
-		pinnedVersionOverrideString := pinnedVersionOverride.GetDeploymentName() + "." + pinnedVersionOverride.GetBuildId()
-		return pinnedVersionOverrideString == pinnedVersion // the second execution should have the pinned version override.
+		return pinnedVersionOverride.GetDeploymentName() == pinnedDeploymentName && pinnedVersionOverride.GetBuildId() == pinnedBuildId
 	}, 5*time.Second, 100*time.Millisecond)
 }
 

temporalcli/commandsgen/commands.yml

@@ -4517,10 +4517,15 @@ option-sets:
           Override the versioning behavior of a Workflow.
         required: true
         enum-values:
+          - unspecified
           - pinned
           - auto_upgrade
-      - name: versioning-override-pinned-version
+      - name: versioning-override-deployment-name
         type: string
-        description: Override Pinned Version for a Worker Deployment (Only for pinned).
-
+        description: When overriding to a `pinned` behavior, specifies the Deployment Name of the
+          version to target.
+      - name: versioning-override-build-id
+        type: string
+        description: When overriding to a `pinned` behavior, specifies the Build ID of the
+          version to target.