Skip to content

Reuse TaskList Partition Weighting in IsolationLoadBalancer #6811

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 15, 2025
Merged

Reuse TaskList Partition Weighting in IsolationLoadBalancer #6811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions client/matching/isolation_loadbalancer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,27 @@ import (
)

type isolationLoadBalancer struct {
provider PartitionConfigProvider
fallback LoadBalancer
domainIDToName func(string) (string, error)
isolationEnabled func(string) bool
provider PartitionConfigProvider
fallback WeightedLoadBalancer
domainIDToName func(string) (string, error)
isolationAssignmentEnabled func(string) bool
}

func NewIsolationLoadBalancer(fallback LoadBalancer, provider PartitionConfigProvider, domainIDToName func(string) (string, error), config *dynamicconfig.Collection) LoadBalancer {
isolationEnabled := config.GetBoolPropertyFilteredByDomain(dynamicproperties.EnablePartitionIsolationGroupAssignment)
func NewIsolationLoadBalancer(fallback WeightedLoadBalancer, provider PartitionConfigProvider, domainIDToName func(string) (string, error), config *dynamicconfig.Collection) LoadBalancer {
isolationAssignmentEnabled := config.GetBoolPropertyFilteredByDomain(dynamicproperties.EnablePartitionIsolationGroupAssignment)
return &isolationLoadBalancer{
provider: provider,
fallback: fallback,
domainIDToName: domainIDToName,
isolationEnabled: isolationEnabled,
provider: provider,
fallback: fallback,
domainIDToName: domainIDToName,
isolationAssignmentEnabled: isolationAssignmentEnabled,
}
}

func (i *isolationLoadBalancer) PickWritePartition(taskListType int, req WriteRequest) string {
taskList := *req.GetTaskList()

domainName, err := i.domainIDToName(req.GetDomainUUID())
if err != nil || !i.isolationEnabled(domainName) {
if err != nil || !i.isolationAssignmentEnabled(domainName) {
return i.fallback.PickWritePartition(taskListType, req)
}

Expand All @@ -62,13 +62,16 @@ func (i *isolationLoadBalancer) PickWritePartition(taskListType int, req WriteRe
}

config := i.provider.GetPartitionConfig(req.GetDomainUUID(), taskList, taskListType)
if len(config.WritePartitions) == 1 {
return taskList.GetName()
}

partitions := getPartitionsForGroup(taskGroup, config.WritePartitions)
if len(partitions) == 0 {
return i.fallback.PickWritePartition(taskListType, req)
}

p := pickBetween(partitions)
p := pickRandom(partitions)

return getPartitionTaskListName(taskList.GetName(), p)
}
Expand All @@ -77,18 +80,28 @@ func (i *isolationLoadBalancer) PickReadPartition(taskListType int, req ReadRequ
taskList := *req.GetTaskList()

domainName, err := i.domainIDToName(req.GetDomainUUID())
if err != nil || !i.isolationEnabled(domainName) || isolationGroup == "" {
if err != nil || !i.isolationAssignmentEnabled(domainName) || isolationGroup == "" {
return i.fallback.PickReadPartition(taskListType, req, isolationGroup)
}

config := i.provider.GetPartitionConfig(req.GetDomainUUID(), taskList, taskListType)
if len(config.ReadPartitions) == 1 {
return taskList.GetName()
}

partitions := getPartitionsForGroup(isolationGroup, config.ReadPartitions)
if len(partitions) == 0 {
return i.fallback.PickReadPartition(taskListType, req, isolationGroup)
}

p := pickBetween(partitions)
p := partitions[0]
if len(partitions) > 1 {
p = i.fallback.PickBetween(req.GetDomainUUID(), taskList.GetName(), taskListType, partitions)

if p == -1 {
p = pickRandom(partitions)
}
}

return getPartitionTaskListName(taskList.GetName(), p)
}
Expand All @@ -103,16 +116,16 @@ func getPartitionsForGroup(taskGroup string, partitions map[int]*types.TaskListP
}

var res []int
for id, p := range partitions {
for id := range len(partitions) {
p := partitions[id]
if partitionAcceptsGroup(p, taskGroup) {
res = append(res, id)
}
}
return res
}

func pickBetween(partitions []int) int {
// Could alternatively use backlog weights to make a smarter choice
func pickRandom(partitions []int) int {
picked := rand.Intn(len(partitions))
return partitions[picked]
}
Expand Down
133 changes: 64 additions & 69 deletions client/matching/isolation_loadbalancer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,18 @@ import (
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/mock/gomock"

"github.com/uber/cadence/common/dynamicconfig"
"github.com/uber/cadence/common/dynamicconfig/dynamicproperties"
"github.com/uber/cadence/common/isolationgroup"
"github.com/uber/cadence/common/log/testlogger"
"github.com/uber/cadence/common/types"
)

var testDomain = "domainID"

func TestIsolationPickWritePartition(t *testing.T) {
tl := "tl"
cases := []struct {
Expand All @@ -52,27 +58,6 @@ func TestIsolationPickWritePartition(t *testing.T) {
},
allowed: []string{tl},
},
{
name: "single partition - allowed",
group: "a",
config: &types.TaskListPartitionConfig{
WritePartitions: map[int]*types.TaskListPartition{
0: {[]string{"a"}},
},
},
allowed: []string{tl},
},
{
name: "single partition - not allowed",
group: "a",
config: &types.TaskListPartitionConfig{
WritePartitions: map[int]*types.TaskListPartition{
0: {[]string{"b"}},
},
},
shouldFallback: true,
allowed: []string{"fallback"},
},
{
name: "single partition - isolation disabled",
group: "a",
Expand Down Expand Up @@ -107,6 +92,18 @@ func TestIsolationPickWritePartition(t *testing.T) {
},
allowed: []string{tl, getPartitionTaskListName(tl, 1)},
},
{
name: "multiple partitions - no match",
group: "c",
config: &types.TaskListPartitionConfig{
WritePartitions: map[int]*types.TaskListPartition{
0: {[]string{"a"}},
1: {[]string{"b"}},
},
},
shouldFallback: true,
allowed: []string{"fallback"},
},
{
name: "fallback - no group",
config: &types.TaskListPartitionConfig{
Expand All @@ -123,7 +120,7 @@ func TestIsolationPickWritePartition(t *testing.T) {
t.Run(tc.name, func(t *testing.T) {
lb, fallback := createWithMocks(t, !tc.disableIsolation, tc.config)
req := &types.AddDecisionTaskRequest{
DomainUUID: "domainId",
DomainUUID: testDomain,
TaskList: &types.TaskList{
Name: tl,
Kind: types.TaskListKindSticky.Ptr(),
Expand All @@ -150,8 +147,8 @@ func TestIsolationPickReadPartition(t *testing.T) {
group string
config *types.TaskListPartitionConfig
disableIsolation bool
shouldFallback bool
allowed []string
allowance func(balancer *MockWeightedLoadBalancer)
expected string
}{
{
name: "single partition",
Expand All @@ -161,28 +158,7 @@ func TestIsolationPickReadPartition(t *testing.T) {
0: {},
},
},
allowed: []string{tl},
},
{
name: "single partition - allowed",
group: "a",
config: &types.TaskListPartitionConfig{
ReadPartitions: map[int]*types.TaskListPartition{
0: {[]string{"a"}},
},
},
allowed: []string{tl},
},
{
name: "single partition - not allowed",
group: "a",
config: &types.TaskListPartitionConfig{
ReadPartitions: map[int]*types.TaskListPartition{
0: {[]string{"b"}},
},
},
shouldFallback: true,
allowed: []string{"fallback"},
expected: tl,
},
{
name: "single partition - isolation disabled",
Expand All @@ -193,8 +169,10 @@ func TestIsolationPickReadPartition(t *testing.T) {
},
},
disableIsolation: true,
shouldFallback: true,
allowed: []string{"fallback"},
allowance: func(balancer *MockWeightedLoadBalancer) {
balancer.EXPECT().PickReadPartition(gomock.Any(), gomock.Any(), gomock.Any()).Return("fallback")
},
expected: "fallback",
},
{
name: "multiple partitions - single option",
Expand All @@ -205,7 +183,7 @@ func TestIsolationPickReadPartition(t *testing.T) {
1: {[]string{"b"}},
},
},
allowed: []string{getPartitionTaskListName(tl, 1)},
expected: getPartitionTaskListName(tl, 1),
},
{
name: "multiple partitions - multiple options",
Expand All @@ -214,9 +192,27 @@ func TestIsolationPickReadPartition(t *testing.T) {
ReadPartitions: map[int]*types.TaskListPartition{
0: {[]string{"a"}},
1: {[]string{"a"}},
2: {[]string{"b"}},
},
},
allowed: []string{tl, getPartitionTaskListName(tl, 1)},
allowance: func(balancer *MockWeightedLoadBalancer) {
balancer.EXPECT().PickBetween(testDomain, tl, 0, []int{0, 1}).Return(1)
},
expected: getPartitionTaskListName(tl, 1),
},
{
name: "multiple partitions - no matching",
group: "c",
config: &types.TaskListPartitionConfig{
ReadPartitions: map[int]*types.TaskListPartition{
0: {[]string{"a"}},
1: {[]string{"b"}},
},
},
allowance: func(balancer *MockWeightedLoadBalancer) {
balancer.EXPECT().PickReadPartition(gomock.Any(), gomock.Any(), gomock.Any()).Return("fallback")
},
expected: "fallback",
},
{
name: "fallback - no group",
Expand All @@ -226,25 +222,27 @@ func TestIsolationPickReadPartition(t *testing.T) {
1: {[]string{"b"}},
},
},
shouldFallback: true,
allowed: []string{"fallback"},
allowance: func(balancer *MockWeightedLoadBalancer) {
balancer.EXPECT().PickReadPartition(gomock.Any(), gomock.Any(), gomock.Any()).Return("fallback")
},
expected: "fallback",
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
lb, fallback := createWithMocks(t, !tc.disableIsolation, tc.config)
req := &types.MatchingQueryWorkflowRequest{
DomainUUID: "domainId",
DomainUUID: testDomain,
TaskList: &types.TaskList{
Name: tl,
Kind: types.TaskListKindSticky.Ptr(),
},
}
if tc.shouldFallback {
fallback.EXPECT().PickReadPartition(int(types.TaskListTypeDecision), req, tc.group).Return("fallback").Times(1)
if tc.allowance != nil {
tc.allowance(fallback)
}
p := lb.PickReadPartition(0, req, tc.group)
assert.Contains(t, tc.allowed, p)
actual := lb.PickReadPartition(0, req, tc.group)
assert.Equal(t, tc.expected, actual)
})
}
}
Expand Down Expand Up @@ -339,20 +337,17 @@ func TestIsolationGetPartitionsForGroup(t *testing.T) {
}
}

func createWithMocks(t *testing.T, isolationEnabled bool, config *types.TaskListPartitionConfig) (*isolationLoadBalancer, *MockLoadBalancer) {
func createWithMocks(t *testing.T, isolationEnabled bool, config *types.TaskListPartitionConfig) (*isolationLoadBalancer, *MockWeightedLoadBalancer) {
ctrl := gomock.NewController(t)
fallback := NewMockLoadBalancer(ctrl)
fallback := NewMockWeightedLoadBalancer(ctrl)
cfg := NewMockPartitionConfigProvider(ctrl)
cfg.EXPECT().GetPartitionConfig(gomock.Any(), gomock.Any(), gomock.Any()).Return(config).AnyTimes()
dynamicClient := dynamicconfig.NewInMemoryClient()
require.NoError(t, dynamicClient.UpdateValue(dynamicproperties.EnablePartitionIsolationGroupAssignment, isolationEnabled))
dc := dynamicconfig.NewCollection(dynamicClient, testlogger.New(t))
lb := NewIsolationLoadBalancer(fallback, cfg, func(s string) (string, error) {
return s, nil
}, dc).(*isolationLoadBalancer)

return &isolationLoadBalancer{
provider: cfg,
fallback: fallback,
domainIDToName: func(s string) (string, error) {
return s, nil
},
isolationEnabled: func(s string) bool {
return isolationEnabled
},
}, fallback
return lb, fallback
}
6 changes: 5 additions & 1 deletion client/matching/loadbalancer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

//go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination loadbalancer_mock.go -package matching github.com/uber/cadence/client/matching LoadBalancer
//go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination loadbalancer_mock.go -package matching github.com/uber/cadence/client/matching LoadBalancer,WeightedLoadBalancer

package matching

Expand Down Expand Up @@ -76,6 +76,10 @@ type (
info *types.LoadBalancerHints,
)
}
WeightedLoadBalancer interface {
LoadBalancer
PickBetween(domainID, taskListName string, taskListType int, partitions []int) int
}

defaultLoadBalancer struct {
provider PartitionConfigProvider
Expand Down
Loading