mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
9a6030809f
## What changed? Previously, all DescribeTaskQueue requests use visibility rate limiter, which is too restrictive for non-reachability requests. Fix that by checking in the interceptor. ## Why? So that people interested in only the backlog data don't have to be rate-limited as if they are querying reachability when they are not. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## 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) --> --------- Co-authored-by: David Reiss <[email protected]>
117 lines
3.4 KiB
Go
117 lines
3.4 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 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/headers"
|
|
"go.temporal.io/server/common/quotas"
|
|
"google.golang.org/grpc"
|
|
)
|
|
|
|
const (
|
|
RateLimitDefaultToken = 1
|
|
)
|
|
|
|
var (
|
|
RateLimitServerBusy = &serviceerror.ResourceExhausted{
|
|
Cause: enumspb.RESOURCE_EXHAUSTED_CAUSE_RPS_LIMIT,
|
|
Scope: enumspb.RESOURCE_EXHAUSTED_SCOPE_SYSTEM,
|
|
Message: "service rate limit exceeded",
|
|
}
|
|
)
|
|
|
|
type (
|
|
RateLimitInterceptor struct {
|
|
rateLimiter quotas.RequestRateLimiter
|
|
tokens map[string]int
|
|
}
|
|
)
|
|
|
|
var _ grpc.UnaryServerInterceptor = (*RateLimitInterceptor)(nil).Intercept
|
|
|
|
func NewRateLimitInterceptor(
|
|
rateLimiter quotas.RequestRateLimiter,
|
|
tokens map[string]int,
|
|
) *RateLimitInterceptor {
|
|
return &RateLimitInterceptor{
|
|
rateLimiter: rateLimiter,
|
|
tokens: tokens,
|
|
}
|
|
}
|
|
|
|
func (i *RateLimitInterceptor) Intercept(
|
|
ctx context.Context,
|
|
req interface{},
|
|
info *grpc.UnaryServerInfo,
|
|
handler grpc.UnaryHandler,
|
|
) (interface{}, error) {
|
|
methodName := info.FullMethod
|
|
|
|
// for DescribeTaskQueueRequest, we want to use visibility rate limit only if reachability is queried
|
|
describeTQReq, ok := req.(*workflowservice.DescribeTaskQueueRequest)
|
|
if ok && describeTQReq.GetReportTaskReachability() {
|
|
methodName += "WithReachability"
|
|
}
|
|
|
|
if err := i.Allow(methodName, headers.NewGRPCHeaderGetter(ctx)); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return handler(ctx, req)
|
|
}
|
|
|
|
func (i *RateLimitInterceptor) Allow(
|
|
methodName string,
|
|
headerGetter headers.HeaderGetter,
|
|
) error {
|
|
token, ok := i.tokens[methodName]
|
|
if !ok {
|
|
token = RateLimitDefaultToken
|
|
}
|
|
|
|
// we don't want to apply rate limiter if a method is configured with 0 tokens.
|
|
if token < 1 {
|
|
return nil
|
|
}
|
|
|
|
if !i.rateLimiter.Allow(time.Now().UTC(), quotas.NewRequest(
|
|
methodName,
|
|
token,
|
|
"", // this interceptor layer does not throttle based on caller name
|
|
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 RateLimitServerBusy
|
|
}
|
|
return nil
|
|
}
|