go.uber.org/yarpc@v1.72.1/pkg/errors/client.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 errors
    22  
    23  import (
    24  	"fmt"
    25  	"strings"
    26  
    27  	"go.uber.org/yarpc/api/transport"
    28  	"go.uber.org/yarpc/yarpcerrors"
    29  )
    30  
    31  // RequestBodyEncodeError builds a YARPC error with code
    32  // yarpcerrors.CodeInvalidArgument that represents a failure to encode
    33  // the request body.
    34  func RequestBodyEncodeError(req *transport.Request, err error) error {
    35  	return newClientEncodingError(req, false /*isResponse*/, false /*isHeader*/, err)
    36  }
    37  
    38  // ResponseBodyDecodeError builds a YARPC error with code
    39  // yarpcerrors.CodeInvalidArgument that represents a failure to decode
    40  // the response body.
    41  func ResponseBodyDecodeError(req *transport.Request, err error) error {
    42  	return newClientEncodingError(req, true /*isResponse*/, false /*isHeader*/, err)
    43  }
    44  
    45  // RequestHeadersEncodeError builds a YARPC error with code
    46  // yarpcerrors.CodeInvalidArgument that represents a failure to
    47  // encode the request headers.
    48  func RequestHeadersEncodeError(req *transport.Request, err error) error {
    49  	return newClientEncodingError(req, false /*isResponse*/, true /*isHeader*/, err)
    50  }
    51  
    52  // ResponseHeadersDecodeError builds a YARPC error with code
    53  // yarpcerrors.CodeInvalidArgument that represents a failure to
    54  // decode the response headers.
    55  func ResponseHeadersDecodeError(req *transport.Request, err error) error {
    56  	return newClientEncodingError(req, true /*isResponse*/, true /*isHeader*/, err)
    57  }
    58  
    59  func newClientEncodingError(req *transport.Request, isResponse bool, isHeader bool, err error) error {
    60  	parts := []string{"failed to"}
    61  	if isResponse {
    62  		parts = append(parts, fmt.Sprintf("decode %q response", string(req.Encoding)))
    63  	} else {
    64  		parts = append(parts, fmt.Sprintf("encode %q request", string(req.Encoding)))
    65  	}
    66  	if isHeader {
    67  		parts = append(parts, "headers")
    68  	} else {
    69  		parts = append(parts, "body")
    70  	}
    71  	parts = append(parts,
    72  		fmt.Sprintf("for procedure %q of service %q: %v",
    73  			req.Procedure, req.Service, err))
    74  	return yarpcerrors.Newf(yarpcerrors.CodeInvalidArgument, strings.Join(parts, " "))
    75  }