go.uber.org/yarpc@v1.72.1/pkg/errors/errors.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 contains helper functions for working with YARPC errors
    22  // for encoding and transport implementations.
    23  package errors
    24  
    25  import "go.uber.org/yarpc/yarpcerrors"
    26  
    27  // WrapHandlerError is a convenience function to help wrap errors returned
    28  // from a handler.
    29  //
    30  // If err is nil, WrapHandlerError returns nil.
    31  // If err is a YARPC error, WrapHandlerError returns err with no changes.
    32  // If err is not a YARPC error, WrapHandlerError returns a new YARPC error
    33  // with code yarpcerrors.CodeUnknown and message err.Error(), along with
    34  // service and procedure information.
    35  func WrapHandlerError(err error, service string, procedure string) error {
    36  	if err == nil {
    37  		return nil
    38  	}
    39  	if yarpcerrors.IsStatus(err) {
    40  		return err
    41  	}
    42  	return yarpcerrors.Newf(yarpcerrors.CodeUnknown, "error for service %q and procedure %q: %s", service, procedure, err.Error())
    43  }