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

import (
	"context"
	"time"
)

type (
	RequestRateLimiterAdapterImpl struct {
		rateLimiter RateLimiter
	}
)

var _ RequestRateLimiter = (*RequestRateLimiterAdapterImpl)(nil)

func NewRequestRateLimiterAdapter(
	rateLimiter RateLimiter,
) RequestRateLimiter {
	return &RequestRateLimiterAdapterImpl{
		rateLimiter: rateLimiter,
	}
}

func (r *RequestRateLimiterAdapterImpl) Allow(
	now time.Time,
	request Request,
) bool {
	return r.rateLimiter.AllowN(now, request.Token)
}

func (r *RequestRateLimiterAdapterImpl) Reserve(
	now time.Time,
	request Request,
) Reservation {
	return r.rateLimiter.ReserveN(now, request.Token)
}

func (r *RequestRateLimiterAdapterImpl) Wait(
	ctx context.Context,
	request Request,
) error {
	return r.rateLimiter.WaitN(ctx, request.Token)
}