github.com/team-ide/go-dialect@v1.9.20/vitess/vterrors/grpc.go (about)

     1  /*
     2  Copyright 2019 The Vitess Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package vterrors
    18  
    19  import (
    20  	"fmt"
    21  )
    22  
    23  // This file contains functions to convert errors to and from gRPC codes.
    24  // Use these methods to return an error through gRPC and still
    25  // retain its code.
    26  
    27  // truncateError shortens errors because gRPC has a size restriction on them.
    28  func truncateError(err error) string {
    29  	// For more details see: https://github.com/grpc/grpc-go/issues/443
    30  	// The gRPC spec says "Clients may limit the size of Response-Headers,
    31  	// Trailers, and Trailers-Only, with a default of 8 KiB each suggested."
    32  	// Therefore, we assume 8 KiB minus some headroom.
    33  	GRPCErrorLimit := 8*1024 - 512
    34  	if len(err.Error()) <= GRPCErrorLimit {
    35  		return err.Error()
    36  	}
    37  	truncateInfo := "[...] [remainder of the error is truncated because gRPC has a size limit on errors.]"
    38  	truncatedErr := err.Error()[:GRPCErrorLimit]
    39  	return fmt.Sprintf("%v %v", truncatedErr, truncateInfo)
    40  }