go.uber.org/yarpc@v1.72.1/transport/http/ttl.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package http
    22  
    23  import (
    24  	"context"
    25  	"fmt"
    26  	"strconv"
    27  	"time"
    28  
    29  	"go.uber.org/yarpc/api/transport"
    30  	"go.uber.org/yarpc/yarpcerrors"
    31  )
    32  
    33  // parseTTL takes a context parses the given TTL, clamping the context to that
    34  // TTL and as a side-effect, tracking any errors encountered while attempting
    35  // to parse and validate that TTL.
    36  //
    37  // Leaves the context unchanged if the TTL is empty.
    38  func parseTTL(ctx context.Context, req *transport.Request, ttl string) (_ context.Context, cancel func(), _ error) {
    39  	if ttl == "" {
    40  		return ctx, func() {}, nil
    41  	}
    42  
    43  	ttlms, err := strconv.Atoi(ttl)
    44  	if err != nil {
    45  		return ctx, func() {}, newInvalidTTLError(
    46  			req.Service,
    47  			req.Procedure,
    48  			ttl,
    49  		)
    50  	}
    51  
    52  	// negative TTLs are invalid
    53  	if ttlms < 0 {
    54  		return ctx, func() {}, newInvalidTTLError(
    55  			req.Service,
    56  			req.Procedure,
    57  			fmt.Sprint(ttlms),
    58  		)
    59  	}
    60  
    61  	ctx, cancel = context.WithTimeout(ctx, time.Duration(ttlms)*time.Millisecond)
    62  	return ctx, cancel, nil
    63  }
    64  
    65  func newInvalidTTLError(service string, procedure string, ttl string) error {
    66  	return yarpcerrors.Newf(yarpcerrors.CodeInvalidArgument, "invalid TTL %q for service %q and procedure %q", ttl, service, procedure)
    67  }