Files
tasks/common/rpc/interceptor/namespace_rate_limit.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

108 lines
3.2 KiB
Go

package interceptor
import (
"context"
"time"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/api/serviceerror"
"go.temporal.io/api/workflowservice/v1"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/headers"
"go.temporal.io/server/common/namespace"
"go.temporal.io/server/common/quotas"
"go.temporal.io/server/service/frontend/configs"
"google.golang.org/grpc"
)
const (
NamespaceRateLimitDefaultToken = 1
)
var (
ErrNamespaceRateLimitServerBusy = &serviceerror.ResourceExhausted{
Cause: enumspb.RESOURCE_EXHAUSTED_CAUSE_RPS_LIMIT,
Scope: enumspb.RESOURCE_EXHAUSTED_SCOPE_NAMESPACE,
Message: "namespace rate limit exceeded",
}
)
type (
NamespaceRateLimitInterceptor interface {
Intercept(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp any, err error)
Allow(namespaceName namespace.Name, methodName string, headerGetter headers.HeaderGetter) error
}
NamespaceRateLimitInterceptorImpl struct {
namespaceRegistry namespace.Registry
rateLimiter quotas.RequestRateLimiter
tokens map[string]int
reducePollWorkflowHistoryPriority dynamicconfig.BoolPropertyFn
}
)
var _ grpc.UnaryServerInterceptor = (*NamespaceRateLimitInterceptorImpl)(nil).Intercept
var _ NamespaceRateLimitInterceptor = (*NamespaceRateLimitInterceptorImpl)(nil)
func NewNamespaceRateLimitInterceptor(
namespaceRegistry namespace.Registry,
rateLimiter quotas.RequestRateLimiter,
tokens map[string]int,
reducePollWorkflowHistoryPriority dynamicconfig.BoolPropertyFn,
) NamespaceRateLimitInterceptor {
return &NamespaceRateLimitInterceptorImpl{
namespaceRegistry: namespaceRegistry,
rateLimiter: rateLimiter,
tokens: tokens,
reducePollWorkflowHistoryPriority: reducePollWorkflowHistoryPriority,
}
}
func (ni *NamespaceRateLimitInterceptorImpl) Intercept(
ctx context.Context,
req interface{},
info *grpc.UnaryServerInfo,
handler grpc.UnaryHandler,
) (interface{}, error) {
if ns := MustGetNamespaceName(ni.namespaceRegistry, req); ns != namespace.EmptyName {
method := info.FullMethod
if ni.reducePollWorkflowHistoryPriority() && isLongPollGetHistoryRequest(req) {
method = configs.PollWorkflowHistoryAPIName
}
if err := ni.Allow(ns, method, headers.NewGRPCHeaderGetter(ctx)); err != nil {
return nil, err
}
}
return handler(ctx, req)
}
func (ni *NamespaceRateLimitInterceptorImpl) Allow(namespaceName namespace.Name, methodName string, headerGetter headers.HeaderGetter) error {
token, ok := ni.tokens[methodName]
if !ok {
token = NamespaceRateLimitDefaultToken
}
if !ni.rateLimiter.Allow(time.Now().UTC(), quotas.NewRequest(
methodName,
token,
namespaceName.String(),
headerGetter.Get(headers.CallerTypeHeaderName),
0, // this interceptor layer does not throttle based on caller segment
"", // this interceptor layer does not throttle based on call initiation
)) {
return ErrNamespaceRateLimitServerBusy
}
return nil
}
func isLongPollGetHistoryRequest(
req interface{},
) bool {
switch request := req.(type) {
case *workflowservice.GetWorkflowExecutionHistoryRequest:
return request.GetWaitNewEvent()
}
return false
}