go.temporal.io/server@v1.23.0/common/quotas/routing_rate_limiter_impl.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package quotas
    26  
    27  import (
    28  	"context"
    29  	"time"
    30  )
    31  
    32  type (
    33  	// RoutingRateLimiterImpl is a rate limiter special built for multi-tenancy
    34  	RoutingRateLimiterImpl struct {
    35  		apiToRateLimiter map[string]RequestRateLimiter
    36  	}
    37  )
    38  
    39  var _ RequestRateLimiter = (*RoutingRateLimiterImpl)(nil)
    40  
    41  func NewRoutingRateLimiter(
    42  	apiToRateLimiter map[string]RequestRateLimiter,
    43  ) *RoutingRateLimiterImpl {
    44  	return &RoutingRateLimiterImpl{
    45  		apiToRateLimiter: apiToRateLimiter,
    46  	}
    47  }
    48  
    49  // Allow attempts to allow a request to go through. The method returns
    50  // immediately with a true or false indicating if the request can make
    51  // progress
    52  func (r *RoutingRateLimiterImpl) Allow(
    53  	now time.Time,
    54  	request Request,
    55  ) bool {
    56  	rateLimiter, ok := r.apiToRateLimiter[request.API]
    57  	if !ok {
    58  		return true
    59  	}
    60  	return rateLimiter.Allow(now, request)
    61  }
    62  
    63  // Reserve returns a Reservation that indicates how long the caller
    64  // must wait before event happen.
    65  func (r *RoutingRateLimiterImpl) Reserve(
    66  	now time.Time,
    67  	request Request,
    68  ) Reservation {
    69  	rateLimiter, ok := r.apiToRateLimiter[request.API]
    70  	if !ok {
    71  		return NoopReservation
    72  	}
    73  	return rateLimiter.Reserve(now, request)
    74  }
    75  
    76  // Wait waits till the deadline for a rate limit token to allow the request
    77  // to go through.
    78  func (r *RoutingRateLimiterImpl) Wait(
    79  	ctx context.Context,
    80  	request Request,
    81  ) error {
    82  	rateLimiter, ok := r.apiToRateLimiter[request.API]
    83  	if !ok {
    84  		return nil
    85  	}
    86  	return rateLimiter.Wait(ctx, request)
    87  }