tasks/common/persistence/visibility/visibility_manager_rate_limited.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 visibility

import (
	"context"
	"time"

	"go.temporal.io/server/common/dynamicconfig"
	"go.temporal.io/server/common/headers"
	"go.temporal.io/server/common/namespace"
	"go.temporal.io/server/common/persistence"
	"go.temporal.io/server/common/persistence/visibility/manager"
	"go.temporal.io/server/common/quotas"
)

const (
	RateLimitDefaultToken = 1
)

var _ manager.VisibilityManager = (*visibilityManagerRateLimited)(nil)

type visibilityManagerRateLimited struct {
	delegate         manager.VisibilityManager
	readRateLimiter  quotas.RequestRateLimiter
	writeRateLimiter quotas.RequestRateLimiter
}

func NewVisibilityManagerRateLimited(
	delegate manager.VisibilityManager,
	readMaxQPS dynamicconfig.IntPropertyFn,
	writeMaxQPS dynamicconfig.IntPropertyFn,
	operatorRPSRatio dynamicconfig.FloatPropertyFn,
) *visibilityManagerRateLimited {
	return &visibilityManagerRateLimited{
		delegate:         delegate,
		readRateLimiter:  newPriorityRateLimiter(readMaxQPS, operatorRPSRatio),
		writeRateLimiter: newPriorityRateLimiter(writeMaxQPS, operatorRPSRatio),
	}
}

func (m *visibilityManagerRateLimited) Close() {
	m.delegate.Close()
}

func (m *visibilityManagerRateLimited) GetReadStoreName(nsName namespace.Name) string {
	return m.delegate.GetReadStoreName(nsName)
}

func (m *visibilityManagerRateLimited) GetStoreNames() []string {
	return m.delegate.GetStoreNames()
}

func (m *visibilityManagerRateLimited) HasStoreName(stName string) bool {
	return m.delegate.HasStoreName(stName)
}

func (m *visibilityManagerRateLimited) GetIndexName() string {
	return m.delegate.GetIndexName()
}

func (m *visibilityManagerRateLimited) ValidateCustomSearchAttributes(
	searchAttributes map[string]any,
) (map[string]any, error) {
	return m.delegate.ValidateCustomSearchAttributes(searchAttributes)
}

// Below are write APIs.

func (m *visibilityManagerRateLimited) RecordWorkflowExecutionStarted(
	ctx context.Context,
	request *manager.RecordWorkflowExecutionStartedRequest,
) error {
	if ok := allow(ctx, "RecordWorkflowExecutionStarted", m.writeRateLimiter); !ok {
		return persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.RecordWorkflowExecutionStarted(ctx, request)
}

func (m *visibilityManagerRateLimited) RecordWorkflowExecutionClosed(
	ctx context.Context,
	request *manager.RecordWorkflowExecutionClosedRequest,
) error {
	if ok := allow(ctx, "RecordWorkflowExecutionClosed", m.writeRateLimiter); !ok {
		return persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.RecordWorkflowExecutionClosed(ctx, request)
}

func (m *visibilityManagerRateLimited) UpsertWorkflowExecution(
	ctx context.Context,
	request *manager.UpsertWorkflowExecutionRequest,
) error {
	if ok := allow(ctx, "UpsertWorkflowExecution", m.writeRateLimiter); !ok {
		return persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.UpsertWorkflowExecution(ctx, request)
}

func (m *visibilityManagerRateLimited) DeleteWorkflowExecution(
	ctx context.Context,
	request *manager.VisibilityDeleteWorkflowExecutionRequest,
) error {
	if ok := allow(ctx, "DeleteWorkflowExecution", m.writeRateLimiter); !ok {
		return persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.DeleteWorkflowExecution(ctx, request)
}

// Below are read APIs.

func (m *visibilityManagerRateLimited) ListOpenWorkflowExecutions(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListOpenWorkflowExecutions", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListOpenWorkflowExecutions(ctx, request)
}

func (m *visibilityManagerRateLimited) ListClosedWorkflowExecutions(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListClosedWorkflowExecutions", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListClosedWorkflowExecutions(ctx, request)
}

func (m *visibilityManagerRateLimited) ListOpenWorkflowExecutionsByType(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsByTypeRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListOpenWorkflowExecutionsByType", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListOpenWorkflowExecutionsByType(ctx, request)
}

func (m *visibilityManagerRateLimited) ListClosedWorkflowExecutionsByType(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsByTypeRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListClosedWorkflowExecutionsByType", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListClosedWorkflowExecutionsByType(ctx, request)
}

func (m *visibilityManagerRateLimited) ListOpenWorkflowExecutionsByWorkflowID(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsByWorkflowIDRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListOpenWorkflowExecutionsByWorkflowID", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListOpenWorkflowExecutionsByWorkflowID(ctx, request)
}

func (m *visibilityManagerRateLimited) ListClosedWorkflowExecutionsByWorkflowID(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsByWorkflowIDRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListClosedWorkflowExecutionsByWorkflowID", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListClosedWorkflowExecutionsByWorkflowID(ctx, request)
}

func (m *visibilityManagerRateLimited) ListClosedWorkflowExecutionsByStatus(
	ctx context.Context,
	request *manager.ListClosedWorkflowExecutionsByStatusRequest,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListClosedWorkflowExecutionsByStatus", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListClosedWorkflowExecutionsByStatus(ctx, request)
}

func (m *visibilityManagerRateLimited) ListWorkflowExecutions(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsRequestV2,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ListWorkflowExecutions", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ListWorkflowExecutions(ctx, request)
}

func (m *visibilityManagerRateLimited) ScanWorkflowExecutions(
	ctx context.Context,
	request *manager.ListWorkflowExecutionsRequestV2,
) (*manager.ListWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "ScanWorkflowExecutions", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.ScanWorkflowExecutions(ctx, request)
}

func (m *visibilityManagerRateLimited) CountWorkflowExecutions(
	ctx context.Context,
	request *manager.CountWorkflowExecutionsRequest,
) (*manager.CountWorkflowExecutionsResponse, error) {
	if ok := allow(ctx, "CountWorkflowExecutions", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.CountWorkflowExecutions(ctx, request)
}

func (m *visibilityManagerRateLimited) GetWorkflowExecution(
	ctx context.Context,
	request *manager.GetWorkflowExecutionRequest,
) (*manager.GetWorkflowExecutionResponse, error) {
	if ok := allow(ctx, "GetWorkflowExecution", m.readRateLimiter); !ok {
		return nil, persistence.ErrPersistenceLimitExceeded
	}
	return m.delegate.GetWorkflowExecution(ctx, request)
}

func allow(
	ctx context.Context,
	api string,
	rateLimiter quotas.RequestRateLimiter,
) bool {
	callerInfo := headers.GetCallerInfo(ctx)
	// Currently only CallerType is used. See common/persistence/visibility/quotas.go for rate limiter details.
	return rateLimiter.Allow(time.Now().UTC(), quotas.NewRequest(
		api,
		RateLimitDefaultToken,
		callerInfo.CallerName,
		callerInfo.CallerType,
		-1,
		callerInfo.CallOrigin,
	))
}