Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

convert panic when it is not error #2486

Merged
merged 1 commit into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions common/log/panic.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,15 @@ import (
"go.temporal.io/server/common/log/tag"
)

var errDefaultPanic = fmt.Errorf("panic object is not error")

// CapturePanic is used to capture panic, it will log the panic and also return the error through pointer.
// If the panic value is not error then a default error is returned
// We have to use pointer is because in golang: "recover return nil if was not called directly by a deferred function."
// And we have to set the returned error otherwise our handler will return nil as error which is incorrect
func CapturePanic(logger Logger, retError *error) {
if errPanic := recover(); errPanic != nil {
err, ok := errPanic.(error)
if panicObj := recover(); panicObj != nil {
err, ok := panicObj.(error)
if !ok {
err = errDefaultPanic
err = fmt.Errorf("panic: %v", panicObj)
}

st := string(debug.Stack())
Expand Down
53 changes: 53 additions & 0 deletions common/log/panic_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package log

import (
"fmt"
"testing"

"github.com/stretchr/testify/assert"
)

func TestCapturePanic(t *testing.T) {
fooErr := testCapture("foo")
assert.Error(t, fooErr)
assert.Equal(t, "panic: foo", fooErr.Error())

barErr := testCapture(fmt.Errorf("error: %v", "bar"))
assert.Error(t, barErr)
assert.Equal(t, "error: bar", barErr.Error())
}

func testCapture(panicObj interface{}) (retErr error) {
defer CapturePanic(NewNoopLogger(), &retErr)

testPanic(panicObj)
return nil
}

func testPanic(panicObj interface{}) {
panic(panicObj)
}