Files
tasks/common/quotas/map_request_rate_limiter_impl.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

100 lines
2.4 KiB
Go

package quotas
import (
"context"
"sync"
"time"
)
type (
// RequestRateLimiterKeyFn extracts the map key from the request
RequestRateLimiterKeyFn[K comparable] func(req Request) K
// MapRequestRateLimiterImpl is a generic wrapper rate limiter for a set of rate limiters
// identified by a key
MapRequestRateLimiterImpl[K comparable] struct {
rateLimiterGenFn RequestRateLimiterFn
rateLimiterKeyFn RequestRateLimiterKeyFn[K]
sync.RWMutex
rateLimiters map[K]RequestRateLimiter
}
)
func NewMapRequestRateLimiter[K comparable](
rateLimiterGenFn RequestRateLimiterFn,
rateLimiterKeyFn RequestRateLimiterKeyFn[K],
) *MapRequestRateLimiterImpl[K] {
return &MapRequestRateLimiterImpl[K]{
rateLimiterGenFn: rateLimiterGenFn,
rateLimiterKeyFn: rateLimiterKeyFn,
rateLimiters: make(map[K]RequestRateLimiter),
}
}
func namespaceRequestRateLimiterKeyFn(req Request) string {
return req.Caller
}
func NewNamespaceRequestRateLimiter(
rateLimiterGenFn RequestRateLimiterFn,
) *MapRequestRateLimiterImpl[string] {
return NewMapRequestRateLimiter[string](rateLimiterGenFn, namespaceRequestRateLimiterKeyFn)
}
// Allow attempts to allow a request to go through. The method returns
// immediately with a true or false indicating if the request can make
// progress
func (r *MapRequestRateLimiterImpl[_]) Allow(
now time.Time,
request Request,
) bool {
rateLimiter := r.getOrInitRateLimiter(request)
return rateLimiter.Allow(now, request)
}
// Reserve returns a Reservation that indicates how long the caller
// must wait before event happen.
func (r *MapRequestRateLimiterImpl[_]) Reserve(
now time.Time,
request Request,
) Reservation {
rateLimiter := r.getOrInitRateLimiter(request)
return rateLimiter.Reserve(now, request)
}
// Wait waits till the deadline for a rate limit token to allow the request
// to go through.
func (r *MapRequestRateLimiterImpl[_]) Wait(
ctx context.Context,
request Request,
) error {
rateLimiter := r.getOrInitRateLimiter(request)
return rateLimiter.Wait(ctx, request)
}
func (r *MapRequestRateLimiterImpl[_]) getOrInitRateLimiter(
req Request,
) RequestRateLimiter {
key := r.rateLimiterKeyFn(req)
r.RLock()
rateLimiter, ok := r.rateLimiters[key]
r.RUnlock()
if ok {
return rateLimiter
}
newRateLimiter := r.rateLimiterGenFn(req)
r.Lock()
defer r.Unlock()
rateLimiter, ok = r.rateLimiters[key]
if ok {
return rateLimiter
}
r.rateLimiters[key] = newRateLimiter
return newRateLimiter
}