go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/grpc/grpcutil/paniccatcher.go (about)

     1  // Copyright 2017 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package grpcutil
    16  
    17  import (
    18  	"context"
    19  
    20  	"google.golang.org/grpc/codes"
    21  	"google.golang.org/grpc/status"
    22  
    23  	"go.chromium.org/luci/common/logging"
    24  	"go.chromium.org/luci/common/runtime/paniccatcher"
    25  )
    26  
    27  // PanicCatcherInterceptor is a UnifiedServerInterceptor that catches panics
    28  // in RPC handlers, recovers them and returns codes.Internal gRPC errors
    29  // instead.
    30  func PanicCatcherInterceptor(ctx context.Context, fullMethod string, handler func(ctx context.Context) error) (err error) {
    31  	defer paniccatcher.Catch(func(p *paniccatcher.Panic) {
    32  		logging.Fields{
    33  			"panic.error": p.Reason,
    34  		}.Errorf(ctx, "Caught panic during handling of %q: %s\n%s", fullMethod, p.Reason, p.Stack)
    35  		err = status.Error(codes.Internal, "panic in the request handler")
    36  	})
    37  	return handler(ctx)
    38  }
    39  
    40  var (
    41  	// UnaryServerPanicCatcherInterceptor is a grpc.UnaryServerInterceptor that
    42  	// catches panics in RPC handlers, recovers them and returns codes.Internal gRPC
    43  	// errors instead.
    44  	UnaryServerPanicCatcherInterceptor = UnifiedServerInterceptor(PanicCatcherInterceptor).Unary()
    45  
    46  	// StreamServerPanicCatcherInterceptor is a grpc.StreamServerInterceptor that
    47  	// catches panics in RPC handlers, recovers them and returns codes.Internal gRPC
    48  	// errors instead.
    49  	StreamServerPanicCatcherInterceptor = UnifiedServerInterceptor(PanicCatcherInterceptor).Stream()
    50  )