go.temporal.io/server@v1.23.0/common/log/panic.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package log
    26  
    27  import (
    28  	"fmt"
    29  	"runtime/debug"
    30  
    31  	"go.temporal.io/api/serviceerror"
    32  
    33  	"go.temporal.io/server/common/log/tag"
    34  )
    35  
    36  // CapturePanic is used to capture panic, it will log the panic and also return the error through pointer.
    37  // If the panic value is not error then a default error is returned
    38  // We have to use pointer is because in golang: "recover return nil if was not called directly by a deferred function."
    39  // And we have to set the returned error otherwise our handler will return nil as error which is incorrect
    40  func CapturePanic(logger Logger, retError *error) {
    41  	if panicObj := recover(); panicObj != nil {
    42  		err, ok := panicObj.(error)
    43  		if !ok {
    44  			err = fmt.Errorf("panic: %v", panicObj)
    45  		}
    46  
    47  		st := string(debug.Stack())
    48  
    49  		logger.Error("Panic is captured", tag.SysStackTrace(st), tag.Error(err))
    50  
    51  		*retError = serviceerror.NewInternal(err.Error())
    52  	}
    53  }