fix: Revert "chore(active-active): remove deprecated fields (#7388)" (#7397)

This reverts commit d09cb44. <!-- Describe what has changed in this PR --> **What changed?** <!-- Tell your future self why have you made these changes --> **Why?** <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** <!-- Is it notable for release? e.g. schema updates, configuration or data migration required? If so, please mention it, and also update CHANGELOG.md --> **Release notes** <!-- Is there any documentation updates should be made for config, https://cadenceworkflow.io/docs/operation-guide/setup/ ? If so, please open an PR in https://github.com/cadence-workflow/cadence-docs --> **Documentation Changes**

Author: Shaddoll

common/persistence/execution_manager_test.go

@@ -1652,10 +1652,8 @@ func sampleActiveClusterSelectionPolicyData() *DataBlob {
 
 func sampleActiveClusterSelectionPolicy() *types.ActiveClusterSelectionPolicy {
 return &types.ActiveClusterSelectionPolicy{
-ClusterAttribute: &types.ClusterAttribute{
-Scope: "region",
-Name: "us-west-1",
-},
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyRegionSticky.Ptr(),
+StickyRegion: "region-1",
 }
 }
 

common/persistence/persistence-tests/executionManagerTest.go

@@ -1498,10 +1498,8 @@ func (s *ExecutionManagerSuite) TestGetWorkflow() {
 Memo: testMemo,
 PartitionConfig: testPartitionConfig,
 ActiveClusterSelectionPolicy: &types.ActiveClusterSelectionPolicy{
-ClusterAttribute: &types.ClusterAttribute{
-Scope: "region",
-Name: "us-west-1",
-},
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyRegionSticky.Ptr(),
+StickyRegion: "region1",
 },
 },
 ExecutionStats: &p.ExecutionStats{

common/persistence/serializer_test.go

@@ -539,9 +539,9 @@ func generateActiveClusters() *types.ActiveClusters {
 
 func generateActiveClusterSelectionPolicy() *types.ActiveClusterSelectionPolicy {
 return &types.ActiveClusterSelectionPolicy{
-ClusterAttribute: &types.ClusterAttribute{
-Scope: "region",
-Name: "us-west-1",
-},
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyRegionSticky.Ptr(),
+StickyRegion: "region1",
+ExternalEntityType:  "externalEntityType1",
+ExternalEntityKey: "externalEntityKey1",
 }
 }

common/types/mapper/proto/api.go

@@ -6752,6 +6752,30 @@ func FromActiveClusterSelectionPolicy(p *types.ActiveClusterSelectionPolicy) *ap
 if p == nil {
 return nil
 }
+// TODO(active-active): Remove the switch statement once the strategy is removed
+switch p.GetStrategy() {
+case types.ActiveClusterSelectionStrategyRegionSticky:
+return &apiv1.ActiveClusterSelectionPolicy{
+Strategy: apiv1.ActiveClusterSelectionStrategy_ACTIVE_CLUSTER_SELECTION_STRATEGY_REGION_STICKY,
+StrategyConfig: &apiv1.ActiveClusterSelectionPolicy_ActiveClusterStickyRegionConfig{
+ActiveClusterStickyRegionConfig: &apiv1.ActiveClusterStickyRegionConfig{
+StickyRegion: p.StickyRegion,
+},
+},
+ClusterAttribute: FromClusterAttribute(p.ClusterAttribute),
+}
+case types.ActiveClusterSelectionStrategyExternalEntity:
+return &apiv1.ActiveClusterSelectionPolicy{
+Strategy: apiv1.ActiveClusterSelectionStrategy_ACTIVE_CLUSTER_SELECTION_STRATEGY_EXTERNAL_ENTITY,
+StrategyConfig: &apiv1.ActiveClusterSelectionPolicy_ActiveClusterExternalEntityConfig{
+ActiveClusterExternalEntityConfig: &apiv1.ActiveClusterExternalEntityConfig{
+ExternalEntityType: p.ExternalEntityType,
+ExternalEntityKey: p.ExternalEntityKey,
+},
+},
+ClusterAttribute: FromClusterAttribute(p.ClusterAttribute),
+}
+}
 return &apiv1.ActiveClusterSelectionPolicy{
 ClusterAttribute: FromClusterAttribute(p.ClusterAttribute),
 }
@@ -6761,6 +6785,22 @@ func ToActiveClusterSelectionPolicy(p *apiv1.ActiveClusterSelectionPolicy) *type
 if p == nil {
 return nil
 }
+// TODO(active-active): Remove the switch statement once the strategy is removed
+switch p.Strategy {
+case apiv1.ActiveClusterSelectionStrategy_ACTIVE_CLUSTER_SELECTION_STRATEGY_REGION_STICKY:
+return &types.ActiveClusterSelectionPolicy{
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyRegionSticky.Ptr(),
+StickyRegion: p.StrategyConfig.(*apiv1.ActiveClusterSelectionPolicy_ActiveClusterStickyRegionConfig).ActiveClusterStickyRegionConfig.StickyRegion,
+ClusterAttribute: ToClusterAttribute(p.ClusterAttribute),
+}
+case apiv1.ActiveClusterSelectionStrategy_ACTIVE_CLUSTER_SELECTION_STRATEGY_EXTERNAL_ENTITY:
+return &types.ActiveClusterSelectionPolicy{
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyExternalEntity.Ptr(),
+ExternalEntityType: p.StrategyConfig.(*apiv1.ActiveClusterSelectionPolicy_ActiveClusterExternalEntityConfig).ActiveClusterExternalEntityConfig.ExternalEntityType,
+ExternalEntityKey: p.StrategyConfig.(*apiv1.ActiveClusterSelectionPolicy_ActiveClusterExternalEntityConfig).ActiveClusterExternalEntityConfig.ExternalEntityKey,
+ClusterAttribute: ToClusterAttribute(p.ClusterAttribute),
+}
+}
 return &types.ActiveClusterSelectionPolicy{
 ClusterAttribute: ToClusterAttribute(p.ClusterAttribute),
 }

common/types/mapper/thrift/shared.go

@@ -7045,7 +7045,11 @@ func FromActiveClusterSelectionPolicy(t *types.ActiveClusterSelectionPolicy) *sh
 return nil
 }
 return &shared.ActiveClusterSelectionPolicy{
-ClusterAttribute: FromClusterAttribute(t.ClusterAttribute),
+Strategy: FromActiveClusterSelectionStrategy(t.ActiveClusterSelectionStrategy),
+ExternalEntityType: &t.ExternalEntityType,
+ExternalEntityKey: &t.ExternalEntityKey,
+StickyRegion: &t.StickyRegion,
+ClusterAttribute: FromClusterAttribute(t.ClusterAttribute),
 }
 }
 
@@ -7054,10 +7058,40 @@ func ToActiveClusterSelectionPolicy(t *shared.ActiveClusterSelectionPolicy) *typ
 return nil
 }
 return &types.ActiveClusterSelectionPolicy{
-ClusterAttribute: ToClusterAttribute(t.ClusterAttribute),
+ActiveClusterSelectionStrategy: ToActiveClusterSelectionStrategy(t.Strategy),
+ExternalEntityType: *t.ExternalEntityType,
+ExternalEntityKey: *t.ExternalEntityKey,
+StickyRegion: *t.StickyRegion,
+ClusterAttribute: ToClusterAttribute(t.ClusterAttribute),
 }
 }
 
+func FromActiveClusterSelectionStrategy(t *types.ActiveClusterSelectionStrategy) *shared.ActiveClusterSelectionStrategy {
+if t == nil {
+return nil
+}
+switch *t {
+case types.ActiveClusterSelectionStrategyRegionSticky:
+return shared.ActiveClusterSelectionStrategyRegionSticky.Ptr()
+case types.ActiveClusterSelectionStrategyExternalEntity:
+return shared.ActiveClusterSelectionStrategyExternalEntity.Ptr()
+}
+panic("unexpected enum value")
+}
+
+func ToActiveClusterSelectionStrategy(t *shared.ActiveClusterSelectionStrategy) *types.ActiveClusterSelectionStrategy {
+if t == nil {
+return nil
+}
+switch *t {
+case shared.ActiveClusterSelectionStrategyRegionSticky:
+return types.ActiveClusterSelectionStrategyRegionSticky.Ptr()
+case shared.ActiveClusterSelectionStrategyExternalEntity:
+return types.ActiveClusterSelectionStrategyExternalEntity.Ptr()
+}
+panic("unexpected enum value")
+}
+
 // FromWorkflowExecutionTerminatedEventAttributes converts internal WorkflowExecutionTerminatedEventAttributes type to thrift
 func FromWorkflowExecutionTerminatedEventAttributes(t *types.WorkflowExecutionTerminatedEventAttributes) *shared.WorkflowExecutionTerminatedEventAttributes {
 if t == nil {

common/types/mapper/thrift/shared_test.go

@@ -3595,6 +3595,8 @@ func TestActiveClusterSelectionPolicyConversion(t *testing.T) {
 testCases := []*types.ActiveClusterSelectionPolicy{
 nil,
 {},
+&testdata.ActiveClusterSelectionPolicyExternalEntity,
+&testdata.ActiveClusterSelectionPolicyRegionSticky,
 &testdata.ActiveClusterSelectionPolicyWithClusterAttribute,
 }
 

common/types/shared.go

@@ -2759,7 +2759,22 @@ func (c *ClusterAttribute) Equals(other *ClusterAttribute) bool {
 return c.Scope == other.Scope && c.Name == other.Name
 }
 
+type ActiveClusterSelectionStrategy int32
+
+const (
+ActiveClusterSelectionStrategyRegionSticky ActiveClusterSelectionStrategy = iota
+ActiveClusterSelectionStrategyExternalEntity
+)
+
 type ActiveClusterSelectionPolicy struct {
+ActiveClusterSelectionStrategy *ActiveClusterSelectionStrategy `json:"activeClusterSelectionStrategy,omitempty"`
+
+StickyRegion string `json:"stickyRegion,omitempty"`
+
+ExternalEntityType string `json:"externalEntityType,omitempty"`
+ExternalEntityKey string `json:"externalEntityKey,omitempty"`
+
+// TODO(active-active): Remove the fields above
 ClusterAttribute *ClusterAttribute `json:"clusterAttribute,omitempty" yaml:"clusterAttribute,omitempty"`
 }
 
@@ -2778,7 +2793,54 @@ func (p *ActiveClusterSelectionPolicy) Equals(other *ActiveClusterSelectionPolic
 return false
 }
 
-return p.ClusterAttribute.Equals(other.ClusterAttribute)
+return p.GetStrategy() == other.GetStrategy() &&
+p.StickyRegion == other.StickyRegion &&
+p.ExternalEntityType == other.ExternalEntityType &&
+p.ExternalEntityKey == other.ExternalEntityKey && p.ClusterAttribute.Equals(other.ClusterAttribute)
+}
+
+func (p *ActiveClusterSelectionPolicy) GetStrategy() ActiveClusterSelectionStrategy {
+if p == nil || p.ActiveClusterSelectionStrategy == nil {
+return ActiveClusterSelectionStrategyRegionSticky
+}
+return *p.ActiveClusterSelectionStrategy
+}
+
+func (e ActiveClusterSelectionStrategy) Ptr() *ActiveClusterSelectionStrategy {
+return &e
+}
+
+func (e ActiveClusterSelectionStrategy) String() string {
+switch e {
+case ActiveClusterSelectionStrategyRegionSticky:
+return "REGION_STICKY"
+case ActiveClusterSelectionStrategyExternalEntity:
+return "EXTERNAL_ENTITY"
+}
+
+return fmt.Sprintf("ActiveClusterSelectionStrategy(%d)", e)
+}
+
+func (e ActiveClusterSelectionStrategy) MarshalText() ([]byte, error) {
+return []byte(e.String()), nil
+}
+
+func (e *ActiveClusterSelectionStrategy) UnmarshalText(value []byte) error {
+switch s := strings.ToUpper(string(value)); s {
+case "REGION_STICKY":
+*e = ActiveClusterSelectionStrategyRegionSticky
+return nil
+case "EXTERNAL_ENTITY":
+*e = ActiveClusterSelectionStrategyExternalEntity
+return nil
+default:
+val, err := strconv.ParseInt(s, 10, 32)
+if err != nil {
+return fmt.Errorf("unknown enum value %q for %q: %v", s, "ActiveClusterSelectionStrategy", err)
+}
+*e = ActiveClusterSelectionStrategy(val)
+return nil
+}
 }
 
 // DomainStatus is an internal type (TBD...)

common/types/testdata/common.go

@@ -500,6 +500,15 @@ var (
 },
 ExclusiveMaxReadLevel: &TaskKey,
 }
+ActiveClusterSelectionPolicyRegionSticky = types.ActiveClusterSelectionPolicy{
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyRegionSticky.Ptr(),
+StickyRegion: "region1",
+}
+ActiveClusterSelectionPolicyExternalEntity = types.ActiveClusterSelectionPolicy{
+ActiveClusterSelectionStrategy: types.ActiveClusterSelectionStrategyExternalEntity.Ptr(),
+ExternalEntityType: "externalEntityType1",
+ExternalEntityKey: "externalEntityKey1",
+}
 ClusterAttribute = types.ClusterAttribute{
 Scope: "region",
 Name: "us-west-1",

common/types/testdata/history.go

@@ -276,7 +276,7 @@ var (
 Header: &Header,
 PartitionConfig: PartitionConfig,
 RequestID: RequestID,
-ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyWithClusterAttribute,
+ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyExternalEntity,
 CronOverlapPolicy: &CronOverlapPolicy,
 }
 WorkflowExecutionCompletedEventAttributes = types.WorkflowExecutionCompletedEventAttributes{
@@ -476,7 +476,7 @@ var (
 Header: &Header,
 Memo: &Memo,
 SearchAttributes: &SearchAttributes,
-ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyWithClusterAttribute,
+ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyExternalEntity,
 CronOverlapPolicy: &CronOverlapPolicy,
 }
 StartChildWorkflowExecutionInitiatedEventAttributes = types.StartChildWorkflowExecutionInitiatedEventAttributes{

common/types/testdata/service_frontend.go

@@ -346,7 +346,7 @@ var (
 SearchAttributes: &SearchAttributes,
 Header: &Header,
 FirstRunAtTimeStamp: &Timestamp1,
-ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyWithClusterAttribute,
+ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyExternalEntity,
 }
 StartWorkflowExecutionResponse = types.StartWorkflowExecutionResponse{
 RunID: RunID,
@@ -385,7 +385,7 @@ var (
 SearchAttributes: &SearchAttributes,
 Header: &Header,
 FirstRunAtTimestamp: &Timestamp1,
-ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyWithClusterAttribute,
+ActiveClusterSelectionPolicy: &ActiveClusterSelectionPolicyRegionSticky,
 }
 SignalWithStartWorkflowExecutionAsyncRequest = types.SignalWithStartWorkflowExecutionAsyncRequest{
 SignalWithStartWorkflowExecutionRequest: &SignalWithStartWorkflowExecutionRequest,