forked from cadence-workflow/cadence
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add task isolation leaking (cadence-workflow#6544)
Add taskIsolationDuration, the time during which tasks will only be routed to pollers belonging to the same isolation group as them*. Additionally replace the hardcoded constants of 1 minute and 10s for startup flexibilility and recent poller lookback respectively with a single value: TaskIsolationPollerWindow. For the sake of measuring impact we now include the original partition group within the partition config prior to dispatching the task. This value isn't persisted within the tasks table and is only necessary so that a task that is forwarded after abandoning isolation will emit the correct metric. No behavior depends on this value, it is only used in metrics. Add integration tests for tasklist isolation, as well as unit tests for getIsolationGroupForTask. Update the matching simulator to include this new value.
- Loading branch information
Showing
26 changed files
with
852 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| // 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 host | ||
|
|
||
| import ( | ||
| "errors" | ||
| "flag" | ||
| "strconv" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/pborman/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/stretchr/testify/suite" | ||
| "go.uber.org/yarpc" | ||
|
|
||
| "github.com/uber/cadence/common" | ||
| "github.com/uber/cadence/common/dynamicconfig" | ||
| "github.com/uber/cadence/common/types" | ||
| ) | ||
|
|
||
| const ( | ||
| tl = "integration-task-list-isolation-tl" | ||
| ) | ||
|
|
||
| func TestTaskListIsolationSuite(t *testing.T) { | ||
| flag.Parse() | ||
|
|
||
| var isolationGroups = []any{ | ||
| "a", "b", "c", | ||
| } | ||
| clusterConfig, err := GetTestClusterConfig("testdata/task_list_isolation_test_cluster.yaml") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| testCluster := NewPersistenceTestCluster(t, clusterConfig) | ||
| clusterConfig.FrontendDynamicConfigOverrides = map[dynamicconfig.Key]interface{}{ | ||
| dynamicconfig.EnableTasklistIsolation: true, | ||
| dynamicconfig.AllIsolationGroups: isolationGroups, | ||
| dynamicconfig.MatchingNumTasklistWritePartitions: 1, | ||
| dynamicconfig.MatchingNumTasklistReadPartitions: 1, | ||
| } | ||
| clusterConfig.HistoryDynamicConfigOverrides = map[dynamicconfig.Key]interface{}{ | ||
| dynamicconfig.EnableTasklistIsolation: true, | ||
| dynamicconfig.AllIsolationGroups: isolationGroups, | ||
| dynamicconfig.MatchingNumTasklistWritePartitions: 1, | ||
| dynamicconfig.MatchingNumTasklistReadPartitions: 1, | ||
| } | ||
| clusterConfig.MatchingDynamicConfigOverrides = map[dynamicconfig.Key]interface{}{ | ||
| dynamicconfig.EnableTasklistIsolation: true, | ||
| dynamicconfig.AllIsolationGroups: isolationGroups, | ||
| dynamicconfig.TaskIsolationDuration: time.Second * 5, | ||
| dynamicconfig.MatchingNumTasklistWritePartitions: 1, | ||
| dynamicconfig.MatchingNumTasklistReadPartitions: 1, | ||
| } | ||
|
|
||
| s := new(TaskListIsolationIntegrationSuite) | ||
| params := IntegrationBaseParams{ | ||
| DefaultTestCluster: testCluster, | ||
| VisibilityTestCluster: testCluster, | ||
| TestClusterConfig: clusterConfig, | ||
| } | ||
| s.IntegrationBase = NewIntegrationBase(params) | ||
| suite.Run(t, s) | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) SetupSuite() { | ||
| s.setupSuite() | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) TearDownSuite() { | ||
| s.tearDownSuite() | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) SetupTest() { | ||
| // Have to define our overridden assertions in the test setup. If we did it earlier, s.T() will return nil | ||
| s.Assertions = require.New(s.T()) | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) TestTaskListIsolation() { | ||
| aPoller := s.createPoller("a") | ||
| bPoller := s.createPoller("b") | ||
|
|
||
| cancelB := bPoller.PollAndProcessDecisions() | ||
| defer cancelB() | ||
| cancelA := aPoller.PollAndProcessDecisions() | ||
| defer cancelA() | ||
|
|
||
| // Give pollers time to start | ||
| time.Sleep(time.Second) | ||
|
|
||
| // Running a single workflow is a bit of a coinflip: if isolation didn't work, it would pass 50% of the time. | ||
| // Run 10 workflows to demonstrate that we consistently isolate tasks to the correct poller | ||
| for i := 0; i < 10; i++ { | ||
| runID := s.startWorkflow("a").RunID | ||
| result, err := s.getWorkflowResult(runID) | ||
| s.NoError(err) | ||
| s.Equal("a", result) | ||
| } | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) TestTaskListIsolationLeak() { | ||
| runID := s.startWorkflow("a").RunID | ||
|
|
||
| bPoller := s.createPoller("b") | ||
| // B will get the task as there are no pollers from A | ||
| cancelB := bPoller.PollAndProcessDecisions() | ||
| defer cancelB() | ||
|
|
||
| result, err := s.getWorkflowResult(runID) | ||
| s.NoError(err) | ||
| s.Equal("b", result) | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) createPoller(group string) *TaskPoller { | ||
| return &TaskPoller{ | ||
| Engine: s.engine, | ||
| Domain: s.domainName, | ||
| TaskList: &types.TaskList{Name: tl, Kind: types.TaskListKindNormal.Ptr()}, | ||
| Identity: group, | ||
| DecisionHandler: func(execution *types.WorkflowExecution, wt *types.WorkflowType, previousStartedEventID, startedEventID int64, history *types.History) ([]byte, []*types.Decision, error) { | ||
| // Complete the workflow with the group name | ||
| return []byte(strconv.Itoa(0)), []*types.Decision{{ | ||
| DecisionType: types.DecisionTypeCompleteWorkflowExecution.Ptr(), | ||
| CompleteWorkflowExecutionDecisionAttributes: &types.CompleteWorkflowExecutionDecisionAttributes{ | ||
| Result: []byte(group), | ||
| }, | ||
| }}, nil | ||
| }, | ||
| Logger: s.Logger, | ||
| T: s.T(), | ||
| CallOptions: []yarpc.CallOption{withIsolationGroup(group)}, | ||
| } | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) startWorkflow(group string) *types.StartWorkflowExecutionResponse { | ||
| identity := "test" | ||
|
|
||
| request := &types.StartWorkflowExecutionRequest{ | ||
| RequestID: uuid.New(), | ||
| Domain: s.domainName, | ||
| WorkflowID: s.T().Name(), | ||
| WorkflowType: &types.WorkflowType{ | ||
| Name: "integration-task-list-isolation-type", | ||
| }, | ||
| TaskList: &types.TaskList{ | ||
| Name: tl, | ||
| Kind: types.TaskListKindNormal.Ptr(), | ||
| }, | ||
| Input: nil, | ||
| ExecutionStartToCloseTimeoutSeconds: common.Int32Ptr(10), | ||
| TaskStartToCloseTimeoutSeconds: common.Int32Ptr(1), | ||
| Identity: identity, | ||
| WorkflowIDReusePolicy: types.WorkflowIDReusePolicyAllowDuplicate.Ptr(), | ||
| } | ||
|
|
||
| ctx, cancel := createContext() | ||
| defer cancel() | ||
| result, err := s.engine.StartWorkflowExecution(ctx, request, withIsolationGroup(group)) | ||
| s.Nil(err) | ||
|
|
||
| return result | ||
| } | ||
|
|
||
| func (s *TaskListIsolationIntegrationSuite) getWorkflowResult(runID string) (string, error) { | ||
| ctx, cancel := createContext() | ||
| historyResponse, err := s.engine.GetWorkflowExecutionHistory(ctx, &types.GetWorkflowExecutionHistoryRequest{ | ||
| Domain: s.domainName, | ||
| Execution: &types.WorkflowExecution{ | ||
| WorkflowID: s.T().Name(), | ||
| RunID: runID, | ||
| }, | ||
| HistoryEventFilterType: types.HistoryEventFilterTypeCloseEvent.Ptr(), | ||
| WaitForNewEvent: true, | ||
| }) | ||
| cancel() | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| history := historyResponse.History | ||
|
|
||
| lastEvent := history.Events[len(history.Events)-1] | ||
| if *lastEvent.EventType != types.EventTypeWorkflowExecutionCompleted { | ||
| return "", errors.New("workflow didn't complete") | ||
| } | ||
|
|
||
| return string(lastEvent.WorkflowExecutionCompletedEventAttributes.Result), nil | ||
|
|
||
| } | ||
|
|
||
| func withIsolationGroup(group string) yarpc.CallOption { | ||
| return yarpc.WithHeader(common.ClientIsolationGroupHeaderName, group) | ||
| } |
Oops, something went wrong.