mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Shahab TajikandGitHub
7dd52ee852
## What changed? <!-- Describe what has changed in this PR --> Adding a check in `RecordActivityTaskStarted` to make sure the workflow TQ's current deployment is the samewith the activity poller's deployment before starting to transition the workflow. (The check is only applicable when poller's deployment is different from the workflows effective deployment). ## Why? <!-- Tell your future self why have you made these changes --> Activities belonging to different deployments are versioned independently and should start on the current deployment of their task queues without interference with versioning of the workflow. **Before this change, the workflow would be stuck in a busy loop of activity and workflow tasks,** because activity started a transition to it's own deployment but then the next wf task would change the transition to it's own deployment and reschedule the activity. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> Added functional test. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> None. This only affects workflows who use versioning 3. The single place in the code that is changed is within `if` blocks that can activate only when workflows/workers are using versioning 3. ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> Yes. Ideally should be added to the release 125 because other wise workflows who use versioning 3 and also run activities belonging to TQs in other deployments will generate explosive load to server and user's workers.
353 lines
10 KiB
Go
353 lines
10 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 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 testvars
|
|
|
|
import (
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/pborman/uuid"
|
|
commonpb "go.temporal.io/api/common/v1"
|
|
"go.temporal.io/api/deployment/v1"
|
|
enumspb "go.temporal.io/api/enums/v1"
|
|
namespacepb "go.temporal.io/api/namespace/v1"
|
|
taskqueuepb "go.temporal.io/api/taskqueue/v1"
|
|
updatepb "go.temporal.io/api/update/v1"
|
|
persistencespb "go.temporal.io/server/api/persistence/v1"
|
|
"go.temporal.io/server/common/namespace"
|
|
"go.temporal.io/server/common/primitives/timestamp"
|
|
"google.golang.org/protobuf/types/known/durationpb"
|
|
)
|
|
|
|
type (
|
|
TestVars struct {
|
|
testName string
|
|
testHash uint32
|
|
an Any
|
|
kv sync.Map
|
|
}
|
|
testNamer interface {
|
|
Name() string
|
|
}
|
|
)
|
|
|
|
func New(testNamer testNamer) *TestVars {
|
|
return newFromName(testNamer.Name())
|
|
}
|
|
|
|
func newFromName(testName string) *TestVars {
|
|
th := hash(testName)
|
|
return &TestVars{
|
|
testName: testName,
|
|
testHash: th,
|
|
an: newAny(testName, th),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) key(typ string, key []string) string {
|
|
if len(key) == 0 {
|
|
return typ
|
|
}
|
|
return typ + "_" + strings.Join(key, "_")
|
|
}
|
|
|
|
func (tv *TestVars) getOrCreate(typ string, key []string, initialVal ...any) any {
|
|
kvKey := tv.key(typ, key)
|
|
var kvVal any
|
|
if len(initialVal) == 0 {
|
|
kvVal = tv.defaultStringVal(kvKey)
|
|
} else {
|
|
kvVal = initialVal[0]
|
|
}
|
|
v, _ := tv.kv.LoadOrStore(kvKey, kvVal)
|
|
return v
|
|
}
|
|
|
|
func (tv *TestVars) defaultStringVal(key string) string {
|
|
return tv.testName + "_" + key
|
|
}
|
|
|
|
func (tv *TestVars) set(typ string, key []string, val any) {
|
|
kvKey := tv.key(typ, key)
|
|
tv.kv.Store(kvKey, val)
|
|
}
|
|
|
|
func (tv *TestVars) clone() *TestVars {
|
|
tv2 := newFromName(tv.testName)
|
|
tv.kv.Range(func(key, value any) bool {
|
|
tv2.kv.Store(key, value)
|
|
return true
|
|
})
|
|
|
|
return tv2
|
|
}
|
|
|
|
func (tv *TestVars) cloneSet(typ string, key []string, val any) *TestVars {
|
|
newTv := tv.clone()
|
|
newTv.set(typ, key, val)
|
|
return newTv
|
|
}
|
|
|
|
// ----------- Methods for every "type" ------------
|
|
// TODO: add more as you need them.
|
|
|
|
func (tv *TestVars) NamespaceID(key ...string) namespace.ID {
|
|
return tv.getOrCreate("namespace_id", key, namespace.ID(uuid.New())).(namespace.ID)
|
|
}
|
|
|
|
func (tv *TestVars) WithNamespaceID(namespaceID namespace.ID, key ...string) *TestVars {
|
|
return tv.cloneSet("namespace_id", key, namespaceID)
|
|
}
|
|
|
|
func (tv *TestVars) NamespaceName(key ...string) namespace.Name {
|
|
const typ = "namespace_name"
|
|
return tv.getOrCreate(typ, key, namespace.Name(tv.defaultStringVal(tv.key(typ, key)))).(namespace.Name)
|
|
}
|
|
|
|
func (tv *TestVars) WithNamespaceName(namespaceName namespace.Name, key ...string) *TestVars {
|
|
return tv.cloneSet("namespace_name", key, namespaceName)
|
|
}
|
|
|
|
func (tv *TestVars) Namespace(key ...string) *namespace.Namespace {
|
|
return namespace.NewLocalNamespaceForTest(
|
|
&persistencespb.NamespaceInfo{
|
|
Id: tv.NamespaceID(key...).String(),
|
|
Name: tv.NamespaceName(key...).String(),
|
|
},
|
|
&persistencespb.NamespaceConfig{
|
|
Retention: timestamp.DurationFromDays(int32(tv.Any().Int())),
|
|
BadBinaries: &namespacepb.BadBinaries{
|
|
Binaries: map[string]*namespacepb.BadBinaryInfo{
|
|
tv.Any().String(): nil,
|
|
},
|
|
},
|
|
},
|
|
tv.Global().ClusterName(),
|
|
)
|
|
}
|
|
|
|
func (tv *TestVars) WorkflowID(key ...string) string {
|
|
return tv.getOrCreate("workflow_id", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) BuildId(key ...string) string {
|
|
//revive:disable-next-line:unchecked-type-assertion
|
|
return tv.getOrCreate("build_id", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithBuildId(buildId string, key ...string) *TestVars {
|
|
return tv.cloneSet("build_id", key, buildId)
|
|
}
|
|
|
|
func (tv *TestVars) DeploymentSeries(key ...string) string {
|
|
//revive:disable-next-line:unchecked-type-assertion
|
|
return tv.getOrCreate("deployment_series", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithDeploymentSeries(series string, key ...string) *TestVars {
|
|
return tv.cloneSet("deployment_series", key, series)
|
|
}
|
|
|
|
func (tv *TestVars) Deployment(key ...string) *deployment.Deployment {
|
|
//revive:disable-next-line:unchecked-type-assertion
|
|
return &deployment.Deployment{
|
|
SeriesName: tv.DeploymentSeries(key...),
|
|
BuildId: tv.BuildId(key...),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) WithWorkflowID(workflowID string, key ...string) *TestVars {
|
|
return tv.cloneSet("workflow_id", key, workflowID)
|
|
}
|
|
|
|
func (tv *TestVars) RunID(key ...string) string {
|
|
return tv.getOrCreate("run_id", key, "").(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithRunID(runID string, key ...string) *TestVars {
|
|
return tv.cloneSet("run_id", key, runID)
|
|
}
|
|
|
|
func (tv *TestVars) WorkflowExecution(key ...string) *commonpb.WorkflowExecution {
|
|
return &commonpb.WorkflowExecution{
|
|
WorkflowId: tv.WorkflowID(key...),
|
|
RunId: tv.RunID(key...),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) UpdateRef(key ...string) *updatepb.UpdateRef {
|
|
return &updatepb.UpdateRef{
|
|
UpdateId: tv.UpdateID(key...),
|
|
WorkflowExecution: tv.WorkflowExecution(),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) TaskQueue(key ...string) *taskqueuepb.TaskQueue {
|
|
return &taskqueuepb.TaskQueue{
|
|
Name: tv.getOrCreate("task_queue", key).(string),
|
|
Kind: enumspb.TASK_QUEUE_KIND_NORMAL,
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) WithTaskQueue(taskQueue string, key ...string) *TestVars {
|
|
return tv.cloneSet("task_queue", key, taskQueue)
|
|
}
|
|
|
|
func (tv *TestVars) StickyTaskQueue(key ...string) *taskqueuepb.TaskQueue {
|
|
return &taskqueuepb.TaskQueue{
|
|
Name: tv.getOrCreate("sticky_task_queue", key).(string),
|
|
Kind: enumspb.TASK_QUEUE_KIND_STICKY,
|
|
NormalName: tv.getOrCreate("task_queue", key).(string),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) StickyExecutionAttributes(timeout time.Duration, key ...string) *taskqueuepb.StickyExecutionAttributes {
|
|
return &taskqueuepb.StickyExecutionAttributes{
|
|
WorkerTaskQueue: tv.StickyTaskQueue(key...),
|
|
ScheduleToStartTimeout: durationpb.New(timeout),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) WithStickyTaskQueue(stickyTaskQueue string, key ...string) *TestVars {
|
|
return tv.cloneSet("sticky_task_queue", key, stickyTaskQueue)
|
|
}
|
|
|
|
func (tv *TestVars) WorkflowType(key ...string) *commonpb.WorkflowType {
|
|
return &commonpb.WorkflowType{
|
|
Name: tv.getOrCreate("workflow_type", key).(string),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) WithWorkflowType(workflowType string, key ...string) *TestVars {
|
|
return tv.cloneSet("workflow_type", key, workflowType)
|
|
}
|
|
|
|
func (tv *TestVars) ActivityID(key ...string) string {
|
|
return tv.getOrCreate("activity_id", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithActivityID(activityID string, key ...string) *TestVars {
|
|
return tv.cloneSet("activity_id", key, activityID)
|
|
}
|
|
|
|
func (tv *TestVars) ActivityType(key ...string) *commonpb.ActivityType {
|
|
return &commonpb.ActivityType{
|
|
Name: tv.getOrCreate("activity_type", key).(string),
|
|
}
|
|
}
|
|
|
|
func (tv *TestVars) WithActivityType(workflowType string, key ...string) *TestVars {
|
|
return tv.cloneSet("activity_type", key, workflowType)
|
|
}
|
|
|
|
func (tv *TestVars) MessageID(key ...string) string {
|
|
return tv.getOrCreate("message_id", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithMessageID(messageID string, key ...string) *TestVars {
|
|
return tv.cloneSet("message_id", key, messageID)
|
|
}
|
|
|
|
func (tv *TestVars) UpdateID(key ...string) string {
|
|
return tv.getOrCreate("update_id", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithUpdateID(updateID string, key ...string) *TestVars {
|
|
return tv.cloneSet("update_id", key, updateID)
|
|
}
|
|
|
|
func (tv *TestVars) HandlerName(key ...string) string {
|
|
return tv.getOrCreate("handler_name", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithHandlerName(handlerName string, key ...string) *TestVars {
|
|
return tv.cloneSet("handler_name", key, handlerName)
|
|
}
|
|
|
|
//revive:disable:unchecked-type-assertion
|
|
func (tv *TestVars) ClientIdentity(key ...string) string {
|
|
return tv.getOrCreate("client_identity", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithClientIdentity(identity string, key ...string) *TestVars {
|
|
return tv.cloneSet("client_identity", key, identity)
|
|
}
|
|
|
|
func (tv *TestVars) WorkerIdentity(key ...string) string {
|
|
return tv.getOrCreate("worker_identity", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithWorkerIdentity(identity string, key ...string) *TestVars {
|
|
return tv.cloneSet("worker_identity", key, identity)
|
|
}
|
|
|
|
func (tv *TestVars) TimerID(key ...string) string {
|
|
return tv.getOrCreate("timer_id", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithTimerID(timerID string, key ...string) *TestVars {
|
|
return tv.cloneSet("timer_id", key, timerID)
|
|
}
|
|
|
|
func (tv *TestVars) QueryType(key ...string) string {
|
|
return tv.getOrCreate("query_type", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithQueryType(queryType string, key ...string) *TestVars {
|
|
return tv.cloneSet("query_type", key, queryType)
|
|
}
|
|
|
|
func (tv *TestVars) IndexName(key ...string) string {
|
|
return tv.getOrCreate("index_name", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithIndexName(indexName string, key ...string) *TestVars {
|
|
return tv.cloneSet("index_name", key, indexName)
|
|
}
|
|
|
|
// ----------- Generic methods ------------
|
|
|
|
func (tv *TestVars) InfiniteTimeout() *durationpb.Duration {
|
|
t := 10 * time.Hour
|
|
return durationpb.New(t)
|
|
}
|
|
|
|
func (tv *TestVars) Any() Any {
|
|
return tv.an
|
|
}
|
|
|
|
func (tv *TestVars) Global() Global {
|
|
return newGlobal()
|
|
}
|
|
|
|
func (tv *TestVars) String(key ...string) string {
|
|
return tv.getOrCreate("string", key).(string)
|
|
}
|
|
|
|
func (tv *TestVars) WithString(str string, key ...string) *TestVars {
|
|
return tv.cloneSet("string", key, str)
|
|
}
|