mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Stephan BehnkeandGitHub
c4d83e8245
## What changed? Added a new helper `UnexpectedInternalErr` to combine logging and error construction in one go. ## Why? Observed use case in CHASM code and this collapses two separate statements (softassert and serviceerror.NewInternal) into one - which reduces friction. ## How did you test it? - [ ] built - [ ] run locally and tested manually - [x] covered by existing tests - [ ] added new unit test(s) - [ ] added new functional test(s)
57 lines
1.9 KiB
Go
57 lines
1.9 KiB
Go
package softassert
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"go.temporal.io/api/serviceerror"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/log/tag"
|
|
)
|
|
|
|
const (
|
|
// using a unique tag name to avoid potential conflicts with other tags
|
|
errorDetailsTagName = "softassert-error-details"
|
|
)
|
|
|
|
// UnexpectedInternalErr creates a serviceerror.Internal from a static message and error details.
|
|
// The error message follows the format "<staticMessage>: <optionalErr>", if optionalErr is not nil.
|
|
//
|
|
// It also logs `staticMessage` using softassert.Fail.
|
|
// `optionalErr` is added as a tag with key "softassert-error-details".
|
|
func UnexpectedInternalErr(logger log.Logger, staticMessage string, optionalErr error, tags ...tag.Tag) error {
|
|
// (1) trigger softassert
|
|
combinedTags := tags
|
|
if optionalErr != nil {
|
|
combinedTags = append([]tag.Tag{tag.NewErrorTag(errorDetailsTagName, optionalErr)}, tags...)
|
|
}
|
|
Fail(logger, staticMessage, combinedTags...)
|
|
|
|
// (2) return serviceerror
|
|
message := staticMessage
|
|
if optionalErr != nil {
|
|
message = fmt.Sprintf("%s: %s", staticMessage, optionalErr)
|
|
}
|
|
return serviceerror.NewInternal(message)
|
|
}
|
|
|
|
// UnexpectedDataLoss creates a serviceerror.DataLoss from a static message and optional error.
|
|
// The error message follows the format "<staticMessage>: <optionalErr>", if optionalErr is not nil.
|
|
//
|
|
// It also logs `staticMessage` using softassert.Fail.
|
|
// `optionalErr` is added as a tag with key "softassert-error-details".
|
|
func UnexpectedDataLoss(logger log.Logger, staticMessage string, optionalErr error, tags ...tag.Tag) error {
|
|
// (1) trigger softassert
|
|
combinedTags := tags
|
|
if optionalErr != nil {
|
|
combinedTags = append([]tag.Tag{tag.NewErrorTag(errorDetailsTagName, optionalErr)}, tags...)
|
|
}
|
|
Fail(logger, staticMessage, combinedTags...)
|
|
|
|
// (2) return serviceerror
|
|
message := staticMessage
|
|
if optionalErr != nil {
|
|
message = fmt.Sprintf("%s: %s", staticMessage, optionalErr)
|
|
}
|
|
return serviceerror.NewDataLoss(message)
|
|
}
|