mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
## What changed? Refactor: use new `serviceerror.New...f` constructors. ## Why? Most of service errors now supports `fmt.Sprintf` format and they should be used instead of `fmt.Sprintf`. ## How did you test it? - [ ] built - [ ] run locally and tested manually - [x] covered by existing tests - [ ] added new unit test(s) - [ ] added new functional test(s)
696 lines
26 KiB
Go
696 lines
26 KiB
Go
package matching
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"strings"
|
|
"sync"
|
|
"sync/atomic"
|
|
"time"
|
|
|
|
enumspb "go.temporal.io/api/enums/v1"
|
|
"go.temporal.io/api/serviceerror"
|
|
"go.temporal.io/server/api/matchingservice/v1"
|
|
persistencespb "go.temporal.io/server/api/persistence/v1"
|
|
"go.temporal.io/server/common"
|
|
"go.temporal.io/server/common/backoff"
|
|
"go.temporal.io/server/common/clock/hybrid_logical_clock"
|
|
"go.temporal.io/server/common/future"
|
|
"go.temporal.io/server/common/goro"
|
|
"go.temporal.io/server/common/headers"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/log/tag"
|
|
"go.temporal.io/server/common/namespace"
|
|
"go.temporal.io/server/common/persistence"
|
|
"go.temporal.io/server/common/tqid"
|
|
"go.temporal.io/server/common/util"
|
|
)
|
|
|
|
const (
|
|
// userDataEnabled is the default state: user data is enabled.
|
|
userDataEnabled userDataState = iota
|
|
// userDataClosed means the task queue is closed.
|
|
userDataClosed
|
|
)
|
|
|
|
const maxFastUserDataFetches = 5
|
|
|
|
type (
|
|
userDataManager interface {
|
|
Start()
|
|
Stop()
|
|
WaitUntilInitialized(ctx context.Context) error
|
|
// GetUserData returns the user data for this task queue. Do not mutate the returned pointer, as doing so
|
|
// will cause cache inconsistency.
|
|
GetUserData() (*persistencespb.VersionedTaskQueueUserData, chan struct{}, error)
|
|
// UpdateUserData updates user data for this task queue and replicates across clusters if necessary.
|
|
// Extra care should be taken to avoid mutating the existing data in the update function.
|
|
UpdateUserData(ctx context.Context, options UserDataUpdateOptions, updateFn UserDataUpdateFunc) (int64, error)
|
|
// Handles the maybe-long-poll GetUserData RPC.
|
|
HandleGetUserDataRequest(ctx context.Context, req *matchingservice.GetTaskQueueUserDataRequest) (*matchingservice.GetTaskQueueUserDataResponse, error)
|
|
CheckTaskQueueUserDataPropagation(context.Context, int64, int, int) error
|
|
}
|
|
|
|
UserDataUpdateOptions struct {
|
|
TaskQueueLimitPerBuildId int
|
|
// Only perform the update if current version equals to supplied version.
|
|
// 0 is unset.
|
|
KnownVersion int64
|
|
Source string // informative source for logging
|
|
}
|
|
|
|
// UserDataUpdateFunc accepts the current user data for a task queue and returns the updated user data, a boolean
|
|
// indicating whether this data should be replicated, and an error.
|
|
// Extra care should be taken to avoid mutating the current user data to avoid keeping uncommitted data in memory.
|
|
UserDataUpdateFunc func(*persistencespb.TaskQueueUserData) (*persistencespb.TaskQueueUserData, bool, error)
|
|
|
|
// userDataManager is responsible for fetching and keeping user data up-to-date in-memory
|
|
// for a given TQ partition.
|
|
//
|
|
// If a partition is the root of a normal (non-sticky) task queue with workflow type,
|
|
// we say the partition "owns" user data for its task queue. All reads and writes
|
|
// to/from the persistence layer passes through userDataManager of the owning partition.
|
|
// All other partitions long-poll the latest user data from the owning partition.
|
|
userDataManagerImpl struct {
|
|
lock sync.Mutex
|
|
onFatalErr func(unloadCause)
|
|
onUserDataChanged func() // if set, call this in new goroutine when user data changes
|
|
partition tqid.Partition
|
|
userData *persistencespb.VersionedTaskQueueUserData
|
|
userDataChanged chan struct{}
|
|
userDataState userDataState
|
|
// only set if this partition owns user data of its task queue
|
|
store persistence.TaskManager
|
|
config *taskQueueConfig
|
|
namespaceRegistry namespace.Registry
|
|
logger log.Logger
|
|
matchingClient matchingservice.MatchingServiceClient
|
|
goroGroup goro.Group
|
|
// userDataReady is fulfilled once versioning data is fetched from the root partition. If this TQ is
|
|
// the root partition, it is fulfilled as soon as it is fetched from db.
|
|
userDataReady *future.FutureImpl[struct{}]
|
|
}
|
|
|
|
userDataState int
|
|
)
|
|
|
|
var _ userDataManager = (*userDataManagerImpl)(nil)
|
|
|
|
var (
|
|
errUserDataNoMutateNonRoot = serviceerror.NewInvalidArgument("can only mutate user data on root workflow task queue")
|
|
errRequestedVersionTooLarge = serviceerror.NewInvalidArgument("requested task queue user data for version greater than known version")
|
|
errTaskQueueClosed = serviceerror.NewUnavailable("task queue closed")
|
|
errUserDataUnmodified = errors.New("sentinel error for unchanged user data")
|
|
errUserDataVersionMismatch = errors.New("user data version mismatch")
|
|
)
|
|
|
|
func newUserDataManager(
|
|
store persistence.TaskManager,
|
|
matchingClient matchingservice.MatchingServiceClient,
|
|
onFatalErr func(unloadCause),
|
|
onUserDataChanged func(),
|
|
partition tqid.Partition,
|
|
config *taskQueueConfig,
|
|
logger log.Logger,
|
|
registry namespace.Registry,
|
|
) *userDataManagerImpl {
|
|
m := &userDataManagerImpl{
|
|
onFatalErr: onFatalErr,
|
|
onUserDataChanged: onUserDataChanged,
|
|
partition: partition,
|
|
userDataChanged: make(chan struct{}),
|
|
config: config,
|
|
namespaceRegistry: registry,
|
|
logger: logger,
|
|
matchingClient: matchingClient,
|
|
userDataReady: future.NewFuture[struct{}](),
|
|
}
|
|
|
|
if partition.IsRoot() && partition.TaskType() == enumspb.TASK_QUEUE_TYPE_WORKFLOW {
|
|
m.store = store
|
|
}
|
|
|
|
return m
|
|
}
|
|
|
|
func (m *userDataManagerImpl) Start() {
|
|
if m.store != nil {
|
|
m.goroGroup.Go(m.loadUserData)
|
|
} else {
|
|
m.goroGroup.Go(m.fetchUserData)
|
|
}
|
|
}
|
|
|
|
func (m *userDataManagerImpl) WaitUntilInitialized(ctx context.Context) error {
|
|
_, err := m.userDataReady.Get(ctx)
|
|
return err
|
|
}
|
|
|
|
func (m *userDataManagerImpl) Stop() {
|
|
m.goroGroup.Cancel()
|
|
// Set user data state on stop to wake up anyone blocked on the user data changed channel.
|
|
m.setUserDataState(userDataClosed, nil)
|
|
}
|
|
|
|
// GetUserData returns the user data for this task queue and a channel that signals when the data has been updated.
|
|
// Do not mutate the returned pointer, as doing so will cause cache inconsistency.
|
|
// If there is no user data, this can return a nil value with no error.
|
|
func (m *userDataManagerImpl) GetUserData() (*persistencespb.VersionedTaskQueueUserData, chan struct{}, error) {
|
|
m.lock.Lock()
|
|
defer m.lock.Unlock()
|
|
return m.getUserDataLocked()
|
|
}
|
|
|
|
func (m *userDataManagerImpl) getUserDataLocked() (*persistencespb.VersionedTaskQueueUserData, chan struct{}, error) {
|
|
switch m.userDataState {
|
|
case userDataEnabled:
|
|
return m.userData, m.userDataChanged, nil
|
|
case userDataClosed:
|
|
return nil, nil, errTaskQueueClosed
|
|
default:
|
|
// shouldn't happen
|
|
return nil, nil, serviceerror.NewInternal("unexpected user data enabled state")
|
|
}
|
|
}
|
|
|
|
func (m *userDataManagerImpl) setUserDataLocked(userData *persistencespb.VersionedTaskQueueUserData) {
|
|
m.userData = userData
|
|
close(m.userDataChanged)
|
|
m.userDataChanged = make(chan struct{})
|
|
if m.onUserDataChanged != nil {
|
|
go m.onUserDataChanged()
|
|
}
|
|
}
|
|
|
|
// Sets user data enabled/disabled and marks the future ready (if it's not ready yet).
|
|
// userDataState controls whether GetUserData return an error, and which.
|
|
// futureError is the error to set on the ready future. If this is non-nil, the task queue will
|
|
// be unloaded.
|
|
// Note that this must only be called from a single goroutine since the Ready/Set sequence is
|
|
// potentially racy otherwise.
|
|
func (m *userDataManagerImpl) setUserDataState(userDataState userDataState, futureError error) {
|
|
m.lock.Lock()
|
|
defer m.lock.Unlock()
|
|
|
|
if userDataState != m.userDataState && m.userDataState != userDataClosed {
|
|
m.userDataState = userDataState
|
|
close(m.userDataChanged)
|
|
m.userDataChanged = make(chan struct{})
|
|
}
|
|
|
|
if !m.userDataReady.Ready() {
|
|
m.userDataReady.Set(struct{}{}, futureError)
|
|
}
|
|
}
|
|
|
|
func (m *userDataManagerImpl) loadUserData(ctx context.Context) error {
|
|
ctx = m.callerInfoContext(ctx)
|
|
err := m.loadUserDataFromDB(ctx)
|
|
m.setUserDataState(userDataEnabled, err)
|
|
|
|
// At this point, it's possible that an old owner has updated user data after we read it.
|
|
// We should re-read it after a few seconds and then periodically after that to ensure that
|
|
// we notice if someone else has snuck in a write.
|
|
util.InterruptibleSleep(ctx, backoff.Jitter(m.config.GetUserDataInitialRefresh, 0.1))
|
|
|
|
for ctx.Err() == nil {
|
|
if err = m.refreshUserDataFromDB(ctx); errors.Is(err, errUserDataVersionMismatch) {
|
|
m.onFatalErr(unloadCauseConflict)
|
|
}
|
|
util.InterruptibleSleep(ctx, backoff.Jitter(m.config.GetUserDataRefresh(), 0.2))
|
|
}
|
|
|
|
return ctx.Err()
|
|
}
|
|
|
|
func (m *userDataManagerImpl) userDataFetchSource() (*tqid.NormalPartition, error) {
|
|
switch p := m.partition.(type) {
|
|
case *tqid.NormalPartition:
|
|
// change to the workflow task queue
|
|
p = p.TaskQueue().Family().TaskQueue(enumspb.TASK_QUEUE_TYPE_WORKFLOW).NormalPartition(p.PartitionId())
|
|
degree := m.config.ForwarderMaxChildrenPerNode()
|
|
parent, err := p.ParentPartition(degree)
|
|
if err == tqid.ErrNoParent {
|
|
// we're the root activity task queue, ask the root workflow task queue
|
|
return p, nil
|
|
} else if err != nil {
|
|
// invalid degree
|
|
return nil, err
|
|
}
|
|
return parent, nil
|
|
default:
|
|
normalQ := p.TaskQueue()
|
|
// Sticky queues get data from their corresponding normal queue
|
|
if normalQ.Name() == "" {
|
|
// Older SDKs don't send the normal name. That's okay, they just can't use versioning.
|
|
return nil, errMissingNormalQueueName
|
|
}
|
|
// sticky queue can only be of workflow type as of now. but to be future-proof, we make sure
|
|
// change to workflow task queue here
|
|
return normalQ.Family().TaskQueue(enumspb.TASK_QUEUE_TYPE_WORKFLOW).RootPartition(), nil
|
|
}
|
|
|
|
}
|
|
|
|
func (m *userDataManagerImpl) fetchUserData(ctx context.Context) error {
|
|
ctx = m.callerInfoContext(ctx)
|
|
|
|
// fetch from parent partition
|
|
fetchSource, err := m.userDataFetchSource()
|
|
if err != nil {
|
|
if err == errMissingNormalQueueName {
|
|
// pretend we have no user data. this is a sticky queue so the only effect is that we can't
|
|
// kick off versioned pollers.
|
|
m.setUserDataState(userDataEnabled, nil)
|
|
}
|
|
return err
|
|
}
|
|
|
|
// hasFetchedUserData is true if we have gotten a successful reply to GetTaskQueueUserData.
|
|
// It's used to control whether we do a long poll or a simple get.
|
|
hasFetchedUserData := false
|
|
userDataVersionChanged := false
|
|
|
|
op := func(ctx context.Context) error {
|
|
knownUserData, _, _ := m.GetUserData()
|
|
userDataVersionChanged = false
|
|
|
|
callCtx, cancel := context.WithTimeout(ctx, m.config.GetUserDataLongPollTimeout())
|
|
defer cancel()
|
|
|
|
res, err := m.matchingClient.GetTaskQueueUserData(callCtx, &matchingservice.GetTaskQueueUserDataRequest{
|
|
NamespaceId: m.partition.NamespaceId(),
|
|
TaskQueue: fetchSource.RpcName(),
|
|
TaskQueueType: fetchSource.TaskType(),
|
|
LastKnownUserDataVersion: knownUserData.GetVersion(),
|
|
WaitNewData: hasFetchedUserData,
|
|
})
|
|
if err != nil {
|
|
// don't log on context canceled, produces too much log spam at shutdown
|
|
if !common.IsContextCanceledErr(err) {
|
|
m.logger.Error("error fetching user data from parent", tag.Error(err))
|
|
}
|
|
var unimplErr *serviceerror.Unimplemented
|
|
if errors.As(err, &unimplErr) {
|
|
// This might happen during a deployment. The older version couldn't have had any user data,
|
|
// so we act as if it just returned an empty response and set ourselves ready.
|
|
// Return the error so that we backoff with retry, and do not set hasFetchedUserData so that
|
|
// we don't do a long poll next time.
|
|
m.setUserDataState(userDataEnabled, nil)
|
|
}
|
|
return err
|
|
}
|
|
// If the root partition returns nil here, then that means our data matched, and we don't need to update.
|
|
// If it's nil because it never existed, then we'd never have any data.
|
|
// It can't be nil due to removing versions, as that would result in a non-nil container with
|
|
// nil inner fields.
|
|
if res.GetUserData() != nil {
|
|
m.setUserDataForNonOwningPartition(res.GetUserData())
|
|
userDataVersionChanged = res.GetUserData().GetVersion() != knownUserData.GetVersion()
|
|
m.logNewUserData("fetched user data from parent", res.GetUserData())
|
|
} else {
|
|
m.logger.Debug("fetched user data from parent, no change")
|
|
}
|
|
hasFetchedUserData = true
|
|
m.setUserDataState(userDataEnabled, nil)
|
|
return nil
|
|
}
|
|
|
|
fastResponseCounter := 0
|
|
minWaitTime := m.config.GetUserDataMinWaitTime
|
|
|
|
for ctx.Err() == nil {
|
|
start := time.Now()
|
|
_ = backoff.ThrottleRetryContext(ctx, op, m.config.GetUserDataRetryPolicy, nil)
|
|
elapsed := time.Since(start)
|
|
|
|
// In general, we want to start a new call immediately on completion of the previous
|
|
// one. But if the remote is broken and returns success immediately, we might end up
|
|
// spinning. So enforce a minimum wait time that increases as long as we keep getting
|
|
// very fast replies.
|
|
// If the user data version changed it means new data was received so we skip this check.
|
|
if !userDataVersionChanged && elapsed < m.config.GetUserDataMinWaitTime {
|
|
if fastResponseCounter >= maxFastUserDataFetches {
|
|
// maxFastUserDataFetches or more consecutive fast responses, let's throttle!
|
|
util.InterruptibleSleep(ctx, minWaitTime-elapsed)
|
|
// Don't let this get near our call timeout, otherwise we can't tell the difference
|
|
// between a fast reply and a timeout.
|
|
minWaitTime = min(minWaitTime*2, m.config.GetUserDataLongPollTimeout()/2)
|
|
} else {
|
|
// Not yet maxFastUserDataFetches consecutive fast responses. A few rapid refreshes for versioned queues
|
|
// is expected when the first poller arrives. We do not want to slow down the queue
|
|
// for that.
|
|
fastResponseCounter++
|
|
}
|
|
} else {
|
|
fastResponseCounter = 0
|
|
minWaitTime = m.config.GetUserDataMinWaitTime
|
|
}
|
|
}
|
|
|
|
return ctx.Err()
|
|
}
|
|
|
|
// Loads user data from db (called only on initialization of taskQueuePartitionManager).
|
|
func (m *userDataManagerImpl) loadUserDataFromDB(ctx context.Context) error {
|
|
response, err := m.store.GetTaskQueueUserData(ctx, &persistence.GetTaskQueueUserDataRequest{
|
|
NamespaceID: m.partition.NamespaceId(),
|
|
TaskQueue: m.partition.TaskQueue().Name(),
|
|
})
|
|
if common.IsNotFoundError(err) {
|
|
// not all task queues have user data
|
|
response, err = &persistence.GetTaskQueueUserDataResponse{}, nil
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
m.lock.Lock()
|
|
defer m.lock.Unlock()
|
|
m.setUserDataLocked(response.UserData)
|
|
m.logNewUserData("loaded user data from db", response.UserData)
|
|
|
|
return nil
|
|
}
|
|
|
|
// Checks if data in db has not been modified since we loaded/modified it.
|
|
func (m *userDataManagerImpl) refreshUserDataFromDB(ctx context.Context) error {
|
|
// Lock here to ensure we're not in the middle of an update, otherwise we may incorrectly
|
|
// think the db has old data if we update between read and verify.
|
|
m.lock.Lock()
|
|
defer m.lock.Unlock()
|
|
|
|
response, err := m.store.GetTaskQueueUserData(ctx, &persistence.GetTaskQueueUserDataRequest{
|
|
NamespaceID: m.partition.NamespaceId(),
|
|
TaskQueue: m.partition.TaskQueue().Name(),
|
|
})
|
|
if common.IsNotFoundError(err) {
|
|
response, err = &persistence.GetTaskQueueUserDataResponse{}, nil
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if response.UserData.GetVersion() == m.userData.GetVersion() {
|
|
return nil
|
|
}
|
|
|
|
tags := []tag.Tag{
|
|
tag.UserDataVersion(response.UserData.GetVersion()),
|
|
tag.NewInt64("expected-user-data-version", m.userData.GetVersion()),
|
|
tag.Timestamp(hybrid_logical_clock.UTC(response.UserData.GetData().GetClock())),
|
|
tag.NewTimeTag("expected-user-data-timestamp", hybrid_logical_clock.UTC(m.userData.GetData().GetClock())),
|
|
}
|
|
|
|
if response.UserData.GetVersion() < m.userData.GetVersion() {
|
|
// We have newer data in memory than the db. This should only happen if the database
|
|
// went back in time. We should unload and start over.
|
|
m.logger.Error("user data version mismatch: db had older data; unloading", tags...)
|
|
return errUserDataVersionMismatch
|
|
}
|
|
|
|
// The db has newer data. We can just update to it.
|
|
m.setUserDataLocked(response.UserData)
|
|
m.logger.Warn("user data version mismatch: db had newer data; reloading", tags...)
|
|
|
|
return nil
|
|
}
|
|
|
|
// UpdateUserData updates user data for this task queue and replicates across clusters if necessary.
|
|
// Extra care should be taken to avoid mutating the existing data in the update function.
|
|
func (m *userDataManagerImpl) UpdateUserData(ctx context.Context, options UserDataUpdateOptions, updateFn UserDataUpdateFunc) (int64, error) {
|
|
if m.store == nil {
|
|
return 0, errUserDataNoMutateNonRoot
|
|
}
|
|
if err := m.WaitUntilInitialized(ctx); err != nil {
|
|
return 0, err
|
|
}
|
|
newData, shouldReplicate, err := m.updateUserData(ctx, updateFn, options)
|
|
if errors.Is(err, errUserDataUnmodified) {
|
|
return newData.GetVersion(), nil
|
|
} else if err != nil {
|
|
return 0, err
|
|
} else if !shouldReplicate {
|
|
return newData.GetVersion(), nil
|
|
}
|
|
|
|
// Only replicate if namespace is global and has at least 2 clusters registered.
|
|
ns, err := m.namespaceRegistry.GetNamespaceByID(namespace.ID(m.partition.NamespaceId()))
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
if ns.ReplicationPolicy() != namespace.ReplicationPolicyMultiCluster {
|
|
return newData.GetVersion(), nil
|
|
}
|
|
|
|
_, err = m.matchingClient.ReplicateTaskQueueUserData(ctx, &matchingservice.ReplicateTaskQueueUserDataRequest{
|
|
NamespaceId: m.partition.NamespaceId(),
|
|
TaskQueue: m.partition.TaskQueue().Name(),
|
|
UserData: newData.GetData(),
|
|
})
|
|
if err != nil {
|
|
m.logger.Error("Failed to publish a replication task after updating task queue user data", tag.Error(err))
|
|
return 0, serviceerror.NewUnavailable("storing task queue user data succeeded but publishing to the namespace replication queue failed, please try again")
|
|
}
|
|
return newData.GetVersion(), nil
|
|
}
|
|
|
|
// UpdateUserData allows callers to update user data (such as worker build IDs) for this task queue. The pointer passed
|
|
// to the update function is guaranteed to be non-nil.
|
|
// Note that the user data's clock may be nil and should be initialized externally where there's access to the cluster
|
|
// metadata and the cluster ID can be obtained.
|
|
//
|
|
// If knownVersion is non 0 and not equal to the current version, the update will fail.
|
|
//
|
|
// The DB write is performed remotely on an owning node for all user data updates in the namespace.
|
|
//
|
|
// On success returns a pointer to the updated data, which must *not* be mutated, and a boolean indicating whether the
|
|
// data should be replicated.
|
|
func (m *userDataManagerImpl) updateUserData(
|
|
ctx context.Context,
|
|
updateFn UserDataUpdateFunc,
|
|
options UserDataUpdateOptions,
|
|
) (*persistencespb.VersionedTaskQueueUserData, bool, error) {
|
|
m.lock.Lock()
|
|
defer m.lock.Unlock()
|
|
|
|
userData, _, err := m.getUserDataLocked()
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
|
|
preUpdateData := userData.GetData()
|
|
preUpdateVersion := userData.GetVersion()
|
|
if preUpdateData == nil {
|
|
preUpdateData = &persistencespb.TaskQueueUserData{}
|
|
}
|
|
if options.KnownVersion > 0 && preUpdateVersion != options.KnownVersion {
|
|
return nil, false, serviceerror.NewFailedPreconditionf("user data version mismatch: requested: %d, current: %d", options.KnownVersion, preUpdateVersion)
|
|
}
|
|
updatedUserData, shouldReplicate, err := updateFn(preUpdateData)
|
|
if err == errUserDataUnmodified {
|
|
return userData, false, err
|
|
}
|
|
if err != nil {
|
|
m.logger.Error("user data update function failed", tag.Error(err), tag.NewStringTag("user-data-update-source", options.Source))
|
|
return nil, false, err
|
|
}
|
|
|
|
added, removed := GetBuildIdDeltas(preUpdateData.GetVersioningData(), updatedUserData.GetVersioningData())
|
|
if options.TaskQueueLimitPerBuildId > 0 && len(added) > 0 {
|
|
// We iterate here but in practice there should only be a single build Id added when the limit is enforced.
|
|
// We do not enforce the limit when applying replication events.
|
|
for _, buildId := range added {
|
|
numTaskQueues, err := m.store.CountTaskQueuesByBuildId(ctx, &persistence.CountTaskQueuesByBuildIdRequest{
|
|
NamespaceID: m.partition.NamespaceId(),
|
|
BuildID: buildId,
|
|
})
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
if numTaskQueues >= options.TaskQueueLimitPerBuildId {
|
|
return nil, false, serviceerror.NewFailedPreconditionf("Exceeded max task queues allowed to be mapped to a single build ID: %d", options.TaskQueueLimitPerBuildId)
|
|
}
|
|
}
|
|
}
|
|
|
|
_, err = m.matchingClient.UpdateTaskQueueUserData(ctx, &matchingservice.UpdateTaskQueueUserDataRequest{
|
|
NamespaceId: m.partition.NamespaceId(),
|
|
TaskQueue: m.partition.TaskQueue().Name(),
|
|
UserData: &persistencespb.VersionedTaskQueueUserData{Version: preUpdateVersion, Data: updatedUserData},
|
|
BuildIdsAdded: added,
|
|
BuildIdsRemoved: removed,
|
|
})
|
|
if err != nil {
|
|
m.logger.Error("failed to push new user data to owning matching node for namespace", tag.Error(err))
|
|
return nil, false, err
|
|
}
|
|
|
|
updatedVersionedData := &persistencespb.VersionedTaskQueueUserData{Version: preUpdateVersion + 1, Data: updatedUserData}
|
|
m.logNewUserData("modified user data", updatedVersionedData, tag.NewStringTag("user-data-update-source", options.Source))
|
|
m.setUserDataLocked(updatedVersionedData)
|
|
|
|
return updatedVersionedData, shouldReplicate, err
|
|
}
|
|
|
|
func (m *userDataManagerImpl) HandleGetUserDataRequest(
|
|
ctx context.Context,
|
|
req *matchingservice.GetTaskQueueUserDataRequest,
|
|
) (*matchingservice.GetTaskQueueUserDataResponse, error) {
|
|
version := req.GetLastKnownUserDataVersion()
|
|
if version < 0 {
|
|
return nil, serviceerror.NewInvalidArgument("last_known_user_data_version must not be negative")
|
|
}
|
|
|
|
if req.WaitNewData {
|
|
var cancel context.CancelFunc
|
|
ctx, cancel = newChildContext(ctx, m.config.GetUserDataLongPollTimeout(), m.config.GetUserDataReturnBudget)
|
|
defer cancel()
|
|
}
|
|
|
|
for {
|
|
resp := &matchingservice.GetTaskQueueUserDataResponse{}
|
|
userData, userDataChanged, err := m.GetUserData()
|
|
if errors.Is(err, errTaskQueueClosed) {
|
|
// If we're closing, return a success with no data, as if the request expired. We shouldn't
|
|
// close due to idleness (because of the MarkAlive above), so we're probably closing due to a
|
|
// change of ownership. The caller will retry and be redirected to the new owner.
|
|
m.logger.Debug("returning empty user data (closing)", tag.NewBoolTag("long-poll", req.WaitNewData))
|
|
return resp, nil
|
|
} else if err != nil {
|
|
return nil, err
|
|
}
|
|
if userData.GetVersion() > version {
|
|
resp.UserData = userData
|
|
m.logger.Info("returning user data",
|
|
tag.NewBoolTag("long-poll", req.WaitNewData),
|
|
tag.NewInt64("request-known-version", version),
|
|
tag.UserDataVersion(userData.Version),
|
|
)
|
|
} else if userData != nil && userData.Version < version && m.store != nil {
|
|
// When m.store == nil it means this is a non-owner partition, so it is possible
|
|
// for the requested version to be greater than the known version if there are
|
|
// concurrent user data updates in flight. We do not log an error in that case.
|
|
|
|
// This is highly unlikely to happen in the owner/root partition but may happen
|
|
// due to an edge case in during ownership transfer.
|
|
// We rely on client retries in this case to let the system eventually self-heal.
|
|
m.logger.Error("requested task queue user data for version greater than known version",
|
|
tag.NewInt64("request-known-version", version),
|
|
tag.UserDataVersion(userData.Version),
|
|
)
|
|
return nil, errRequestedVersionTooLarge
|
|
}
|
|
if req.WaitNewData && userData.GetVersion() <= version {
|
|
// long-poll: wait for data to change/appear
|
|
select {
|
|
case <-ctx.Done():
|
|
m.logger.Debug("returning empty user data (expired)",
|
|
tag.NewBoolTag("long-poll", req.WaitNewData),
|
|
tag.NewInt64("request-known-version", version),
|
|
tag.UserDataVersion(userData.GetVersion()),
|
|
)
|
|
return resp, nil
|
|
case <-userDataChanged:
|
|
m.logger.Debug("user data changed while blocked in long poll")
|
|
continue
|
|
}
|
|
}
|
|
if userData == nil {
|
|
m.logger.Debug("returning empty user data (no data)", tag.NewBoolTag("long-poll", req.WaitNewData))
|
|
}
|
|
return resp, nil
|
|
}
|
|
|
|
}
|
|
|
|
func (m *userDataManagerImpl) CheckTaskQueueUserDataPropagation(
|
|
ctx context.Context,
|
|
version int64,
|
|
wfPartitions int,
|
|
actPartitions int,
|
|
) error {
|
|
if m.store == nil {
|
|
return serviceerror.NewInvalidArgument("CheckTaskQueueUserDataPropagation must be called on root workflow task queue")
|
|
} else if version < 1 {
|
|
return serviceerror.NewInvalidArgument("CheckTaskQueueUserDataPropagation must wait for version >= 1")
|
|
}
|
|
|
|
complete := make(chan error)
|
|
|
|
var waitingForPartitions atomic.Int64
|
|
waitingForPartitions.Store(int64(wfPartitions - 1 + actPartitions))
|
|
|
|
policy := backoff.NewExponentialRetryPolicy(500 * time.Millisecond)
|
|
isRetryable := func(err error) bool {
|
|
if strings.Contains(err.Error(), errRequestedVersionTooLarge.Error()) {
|
|
// It is possible that multiple updates are happening at once and this partition has not
|
|
// caught up with all the previous updates when we ask for the latest update.
|
|
return true
|
|
}
|
|
return common.IsServiceClientTransientError(err)
|
|
}
|
|
|
|
check := func(p int, tp enumspb.TaskQueueType) {
|
|
err := backoff.ThrottleRetryContext(ctx, func(ctx context.Context) error {
|
|
res, err := m.matchingClient.GetTaskQueueUserData(ctx, &matchingservice.GetTaskQueueUserDataRequest{
|
|
NamespaceId: m.partition.NamespaceId(),
|
|
TaskQueue: m.partition.TaskQueue().NormalPartition(p).RpcName(),
|
|
TaskQueueType: tp,
|
|
LastKnownUserDataVersion: version - 1,
|
|
WaitNewData: true,
|
|
OnlyIfLoaded: true,
|
|
})
|
|
if err != nil {
|
|
var failed *serviceerror.FailedPrecondition
|
|
if errors.As(err, &failed) {
|
|
// this means the partition was not loaded, so skip it (if it loads, it will get the newest data)
|
|
err = nil
|
|
}
|
|
return err
|
|
} else if res.GetUserData().GetVersion() < version {
|
|
return serviceerror.NewUnavailable("retry")
|
|
}
|
|
return nil
|
|
}, policy, isRetryable)
|
|
if err == nil {
|
|
if waitingForPartitions.Add(-1) == 0 {
|
|
complete <- nil
|
|
}
|
|
}
|
|
}
|
|
|
|
for i := 1; i < wfPartitions; i++ {
|
|
go check(i, enumspb.TASK_QUEUE_TYPE_WORKFLOW)
|
|
}
|
|
for i := 0; i < actPartitions; i++ {
|
|
go check(i, enumspb.TASK_QUEUE_TYPE_ACTIVITY)
|
|
}
|
|
|
|
select {
|
|
case <-ctx.Done():
|
|
return ctx.Err()
|
|
case err := <-complete:
|
|
return err
|
|
}
|
|
}
|
|
|
|
func (m *userDataManagerImpl) setUserDataForNonOwningPartition(userData *persistencespb.VersionedTaskQueueUserData) {
|
|
m.lock.Lock()
|
|
defer m.lock.Unlock()
|
|
m.setUserDataLocked(userData)
|
|
}
|
|
|
|
func (m *userDataManagerImpl) callerInfoContext(ctx context.Context) context.Context {
|
|
ns, _ := m.namespaceRegistry.GetNamespaceName(namespace.ID(m.partition.NamespaceId()))
|
|
return headers.SetCallerInfo(ctx, headers.NewBackgroundCallerInfo(ns.String()))
|
|
}
|
|
|
|
func (m *userDataManagerImpl) logNewUserData(message string, data *persistencespb.VersionedTaskQueueUserData, tags ...tag.Tag) {
|
|
m.logger.Info(message,
|
|
append(tags,
|
|
tag.UserDataVersion(data.GetVersion()),
|
|
tag.Timestamp(hybrid_logical_clock.UTC(data.GetData().GetClock())),
|
|
)...)
|
|
}
|