Files
tasks/common/authorization/frontend_api.go
993bd25b7f Exclude gRPC health check requests from rate limiting in history & matching service (#6036)
## What changed?
The rate limit interceptor will now ignore gRPC health check requests
and doesn't apply any rate limiters.

## Why?
Health check requests should never be rate limited.

## How did you test it?
Added unit tests to assert interceptor behavior.

## Potential risks
N/A

## Documentation
N/A

## Is hotfix candidate?
no

---------

Co-authored-by: Tim Deeb-Swihart <[email protected]>
Co-authored-by: David Reiss <[email protected]>
2024-06-04 19:26:44 +00:00

54 lines
2.1 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 authorization
import (
healthpb "google.golang.org/grpc/health/grpc_health_v1"
"go.temporal.io/server/common/api"
)
var healthCheckAPI = map[string]struct{}{
healthpb.Health_Check_FullMethodName: {},
"/temporal.api.workflowservice.v1.WorkflowService/GetSystemInfo": {},
}
func IsReadOnlyNamespaceAPI(workflowServiceMethod string) bool {
fullApiName := api.WorkflowServicePrefix + workflowServiceMethod
metadata := api.GetMethodMetadata(fullApiName)
return metadata.Scope == api.ScopeNamespace && metadata.Access == api.AccessReadOnly
}
func IsReadOnlyGlobalAPI(workflowServiceMethod string) bool {
fullApiName := api.WorkflowServicePrefix + workflowServiceMethod
metadata := api.GetMethodMetadata(fullApiName)
return metadata.Scope == api.ScopeCluster && metadata.Access == api.AccessReadOnly
}
func IsHealthCheckAPI(fullApi string) bool {
_, found := healthCheckAPI[fullApi]
return found
}