-
Notifications
You must be signed in to change notification settings - Fork 772
/
default-partitioner.go
144 lines (124 loc) · 5.32 KB
/
default-partitioner.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
// The MIT License (MIT)
// Copyright (c) 2017-2020 Uber Technologies Inc.
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package partition
import (
"context"
"errors"
"fmt"
"sort"
"github.com/dgryski/go-farm"
"github.com/uber/cadence/common/isolationgroup"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/log/tag"
"github.com/uber/cadence/common/types"
)
const (
IsolationGroupKey = "isolation-group"
WorkflowIDKey = "wf-id"
)
// ErrNoIsolationGroupsAvailable is returned when there are no available isolation-groups
// this usually indicates a misconfiguration
var ErrNoIsolationGroupsAvailable = errors.New("no isolation-groups are available")
// ErrInvalidPartitionConfig is returned when the required partitioning configuration
// is missing due to misconfiguration
var ErrInvalidPartitionConfig = errors.New("invalid partition config")
// DefaultWorkflowPartitionConfig Is the default dataset expected to be passed around in the
// execution records for workflows which is used for partitioning. It contains the IsolationGroup
// where the workflow was started, and is expected to be pinned, and a workflow ID for a fallback means
// to partition data deterministically.
type defaultWorkflowPartitionConfig struct {
WorkflowStartIsolationGroup string
WFID string
}
// defaultPartitioner is a business-agnostic implementation of partitioning
// which is used by the Cadence system to allocate workflows in matching by isolation-group
type defaultPartitioner struct {
log log.Logger
isolationGroupState isolationgroup.State
}
func NewDefaultPartitioner(
logger log.Logger,
isolationGroupState isolationgroup.State,
) Partitioner {
return &defaultPartitioner{
log: logger,
isolationGroupState: isolationGroupState,
}
}
func (r *defaultPartitioner) GetIsolationGroupByDomainID(ctx context.Context, domainID string, wfPartitionData PartitionConfig, availablePollerIsolationGroups []string) (string, error) {
if wfPartitionData == nil {
return "", ErrInvalidPartitionConfig
}
wfPartition := mapPartitionConfigToDefaultPartitionConfig(wfPartitionData)
if wfPartition.WorkflowStartIsolationGroup == "" || wfPartition.WFID == "" {
return "", ErrInvalidPartitionConfig
}
available, err := r.isolationGroupState.AvailableIsolationGroupsByDomainID(ctx, domainID, availablePollerIsolationGroups)
if err != nil {
return "", fmt.Errorf("failed to get available isolation groups: %w", err)
}
if len(available) == 0 {
return "", ErrNoIsolationGroupsAvailable
}
ig := r.pickIsolationGroup(wfPartition, available)
return ig, nil
}
func mapPartitionConfigToDefaultPartitionConfig(config PartitionConfig) defaultWorkflowPartitionConfig {
isolationGroup, _ := config[IsolationGroupKey]
wfID, _ := config[WorkflowIDKey]
return defaultWorkflowPartitionConfig{
WorkflowStartIsolationGroup: isolationGroup,
WFID: wfID,
}
}
// picks an isolation group to run in. if the workflow was started there, it'll attempt to pin it, unless there is an explicit
// drain.
func (r *defaultPartitioner) pickIsolationGroup(wfPartition defaultWorkflowPartitionConfig, available types.IsolationGroupConfiguration) string {
_, isAvailable := available[wfPartition.WorkflowStartIsolationGroup]
if isAvailable {
return wfPartition.WorkflowStartIsolationGroup
}
// it's drained, fall back to picking a deterministic but random group
var availableList []string
for k := range available {
availableList = append(availableList, k)
}
// sort the slice to ensure it's deterministic
sort.Slice(availableList, func(i int, j int) bool {
return availableList[i] > availableList[j]
})
fallback := pickIsolationGroupFallback(availableList, wfPartition)
r.log.Debug("isolation group falling back to an available zone",
tag.FallbackIsolationGroup(fallback),
tag.IsolationGroup(wfPartition.WorkflowStartIsolationGroup),
tag.PollerGroupsConfiguration(available),
tag.WorkflowID(wfPartition.WFID),
)
return fallback
}
// Simple deterministic isolationGroup picker
// which will pick a random healthy isolationGroup and place the workflow there
func pickIsolationGroupFallback(available []string, wfConfig defaultWorkflowPartitionConfig) string {
if len(available) == 0 {
return ""
}
hashv := farm.Hash32([]byte(wfConfig.WFID))
return available[int(hashv)%len(available)]
}