github.com/kaydxh/golang@v0.0.131/pkg/middleware/grpc-middleware/ratelimit/ratelimit_server.interceptor.go (about)

     1  /*
     2   *Copyright (c) 2022, kaydxh
     3   *
     4   *Permission is hereby granted, free of charge, to any person obtaining a copy
     5   *of this software and associated documentation files (the "Software"), to deal
     6   *in the Software without restriction, including without limitation the rights
     7   *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   *copies of the Software, and to permit persons to whom the Software is
     9   *furnished to do so, subject to the following conditions:
    10   *
    11   *The above copyright notice and this permission notice shall be included in all
    12   *copies or substantial portions of the Software.
    13   *
    14   *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   *SOFTWARE.
    21   */
    22  package ratelimit
    23  
    24  import (
    25  	"context"
    26  	"time"
    27  
    28  	logs_ "github.com/kaydxh/golang/pkg/logs"
    29  	"google.golang.org/grpc"
    30  	"google.golang.org/grpc/codes"
    31  	"google.golang.org/grpc/status"
    32  )
    33  
    34  type Limiter interface {
    35  	Allow() bool
    36  	AllowFor(timeout time.Duration) bool
    37  	Put()
    38  }
    39  
    40  // UnaryServerInterceptor returns a new unary server interceptors that performs request rate limiting.
    41  func UnaryServerInterceptor(limiter Limiter) grpc.UnaryServerInterceptor {
    42  	return func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
    43  		if !limiter.Allow() {
    44  			logger := logs_.GetLogger(ctx)
    45  			err := status.Errorf(
    46  				codes.ResourceExhausted,
    47  				"%s is rejected by grpc_ratelimit middleware, please retry later.",
    48  				info.FullMethod,
    49  			)
    50  			logger.Errorf("%#v", err)
    51  			return nil, err
    52  		}
    53  		defer limiter.Put()
    54  		return handler(ctx, req)
    55  	}
    56  }
    57  
    58  // StreamServerInterceptor returns a new stream server interceptor that performs rate limiting on the request.
    59  func StreamServerInterceptor(limiter Limiter) grpc.StreamServerInterceptor {
    60  	return func(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
    61  		if !limiter.Allow() {
    62  			logger := logs_.GetLogger(stream.Context())
    63  			err := status.Errorf(
    64  				codes.ResourceExhausted,
    65  				"%s is rejected by grpc_ratelimit middleware, please retry later.",
    66  				info.FullMethod,
    67  			)
    68  
    69  			logger.Errorf("%#v", err)
    70  			return err
    71  		}
    72  
    73  		defer limiter.Put()
    74  		return handler(srv, stream)
    75  	}
    76  }