|
| 1 | +package errors |
| 2 | + |
| 3 | +import ( |
| 4 | + stderrors "errors" |
| 5 | + "fmt" |
| 6 | + "runtime" |
| 7 | + "strconv" |
| 8 | + "strings" |
| 9 | + |
| 10 | + pkgerrors "github.com/pkg/errors" |
| 11 | +) |
| 12 | + |
| 13 | +type ValidationError struct { |
| 14 | + Message string |
| 15 | +} |
| 16 | + |
| 17 | +var _ error = ValidationError{} |
| 18 | + |
| 19 | +func NewValidationError(message string) ValidationError { |
| 20 | + return ValidationError{Message: message} |
| 21 | +} |
| 22 | + |
| 23 | +func (v ValidationError) Error() string { |
| 24 | + return v.Message |
| 25 | +} |
| 26 | + |
| 27 | +var New = stderrors.New |
| 28 | + |
| 29 | +var Errorf = fmt.Errorf |
| 30 | + |
| 31 | +func Wrap(err error, msg string) error { |
| 32 | + if err == nil { |
| 33 | + return nil |
| 34 | + } |
| 35 | + return Errorf("%s: %w", msg, err) |
| 36 | +} |
| 37 | + |
| 38 | +var As = stderrors.As |
| 39 | + |
| 40 | +var Unwrap = stderrors.Unwrap |
| 41 | + |
| 42 | +func Unwraps(err error) []error { |
| 43 | + u, ok := err.(interface { |
| 44 | + Unwrap() []error |
| 45 | + }) |
| 46 | + if !ok { |
| 47 | + return nil |
| 48 | + } |
| 49 | + return u.Unwrap() |
| 50 | +} |
| 51 | + |
| 52 | +func Root(err error) error { |
| 53 | + for Unwrap(err) != nil { |
| 54 | + err = Unwrap(err) |
| 55 | + } |
| 56 | + joinedErrs := Unwraps(err) |
| 57 | + if len(joinedErrs) == 0 { |
| 58 | + return err |
| 59 | + } |
| 60 | + return Roots(joinedErrs) |
| 61 | +} |
| 62 | + |
| 63 | +func Roots(errs []error) error { |
| 64 | + if len(errs) == 0 { |
| 65 | + return nil |
| 66 | + } |
| 67 | + rootedErrs := make([]error, len(errs)) |
| 68 | + for i, e := range errs { |
| 69 | + rootedErrs[i] = Root(e) |
| 70 | + } |
| 71 | + return Join(rootedErrs...) |
| 72 | +} |
| 73 | + |
| 74 | +// flattens error tree |
| 75 | +func Flatten(err error) []error { |
| 76 | + if err == nil { |
| 77 | + return nil |
| 78 | + } |
| 79 | + joinedErrs := Unwraps(err) |
| 80 | + if joinedErrs == nil { |
| 81 | + return []error{err} |
| 82 | + } |
| 83 | + flatErrs := []error{} |
| 84 | + for _, e := range joinedErrs { |
| 85 | + flatErrs = append(flatErrs, Flatten(e)...) |
| 86 | + } |
| 87 | + return flatErrs |
| 88 | +} |
| 89 | + |
| 90 | +// var ReturnTrace = errtrace.Wrap |
| 91 | + |
| 92 | +func Join(errs ...error) error { |
| 93 | + noNilErrs := make([]error, 0, len(errs)) |
| 94 | + for _, err := range errs { |
| 95 | + if err != nil { |
| 96 | + noNilErrs = append(noNilErrs, err) |
| 97 | + } |
| 98 | + } |
| 99 | + if len(noNilErrs) == 0 { |
| 100 | + return nil |
| 101 | + } |
| 102 | + if len(noNilErrs) == 1 { |
| 103 | + return noNilErrs[0] |
| 104 | + } |
| 105 | + return stderrors.Join(errs...) //nolint:wrapcheck // this is a wrapper |
| 106 | +} |
| 107 | + |
| 108 | +// if multi err, combine similar errors |
| 109 | +func CombineByString(err error) error { |
| 110 | + if err == nil { |
| 111 | + return nil |
| 112 | + } |
| 113 | + errs := Flatten(err) |
| 114 | + mapE := make(map[string]error) |
| 115 | + mapEList := []error{} |
| 116 | + for _, e := range errs { |
| 117 | + _, ok := mapE[e.Error()] |
| 118 | + if !ok { |
| 119 | + mapE[e.Error()] = e |
| 120 | + mapEList = append(mapEList, e) |
| 121 | + } |
| 122 | + } |
| 123 | + errsOut := make([]error, 0, len(mapE)) |
| 124 | + for _, e := range mapEList { |
| 125 | + errsOut = append(errsOut, e) |
| 126 | + } |
| 127 | + return Join(errsOut...) |
| 128 | +} |
| 129 | + |
| 130 | +var Is = stderrors.Is |
| 131 | + |
| 132 | +var WrapAndTrace = WrapAndTraceInMsg |
| 133 | + |
| 134 | +func WrapAndTraceInMsg(err error) error { |
| 135 | + if err == nil { |
| 136 | + return nil |
| 137 | + } |
| 138 | + return pkgerrors.Wrap(err, makeErrorMessage("", 0)) // this wrap also adds a stacktrace which can be nice |
| 139 | +} |
| 140 | + |
| 141 | +func WrapAndTrace2[T any](t T, err error) (T, error) { |
| 142 | + if err == nil { |
| 143 | + return t, nil |
| 144 | + } |
| 145 | + return t, pkgerrors.Wrap(err, makeErrorMessage("", 0)) |
| 146 | +} |
| 147 | + |
| 148 | +func makeErrorMessage(message string, skip int) string { |
| 149 | + skip += 2 |
| 150 | + pc, file, line, _ := runtime.Caller(skip) |
| 151 | + |
| 152 | + funcName := "unknown" |
| 153 | + fn := runtime.FuncForPC(pc) |
| 154 | + if fn != nil { |
| 155 | + funcName = fn.Name() |
| 156 | + } |
| 157 | + |
| 158 | + lineNum := strconv.Itoa(line) |
| 159 | + return fmt.Sprintf("[error] %s\n%s\n%s:%s\n", message, funcName, file, lineNum) |
| 160 | +} |
| 161 | + |
| 162 | +func HandleErrDefer(f func() error) { |
| 163 | + _ = f() |
| 164 | + // logger.L().Error("", zap.Error(err)) |
| 165 | +} |
| 166 | + |
| 167 | +func ErrorContainsAny(err error, substrs ...string) bool { |
| 168 | + for _, substr := range substrs { |
| 169 | + if ErrorContains(err, substr) { |
| 170 | + return true |
| 171 | + } |
| 172 | + } |
| 173 | + return false |
| 174 | +} |
| 175 | + |
| 176 | +func ErrorContains(err error, substr string) bool { |
| 177 | + return err != nil && strings.Contains(err.Error(), substr) |
| 178 | +} |
| 179 | + |
| 180 | +func IsErrorExcept(err error, errs ...error) bool { |
| 181 | + return err != nil && !IsAny(err, errs...) |
| 182 | +} |
| 183 | + |
| 184 | +func IsErrorExceptSubstr(err error, substr ...string) bool { |
| 185 | + return err != nil && !ErrorContainsAny(err, substr...) |
| 186 | +} |
| 187 | + |
| 188 | +func IsAny(err error, errs ...error) bool { |
| 189 | + for _, e := range errs { |
| 190 | + if Is(err, e) { |
| 191 | + return true |
| 192 | + } |
| 193 | + } |
| 194 | + return false |
| 195 | +} |
| 196 | + |
| 197 | +// TruncateErrorForLogging truncates a long error message to a more manageable size |
| 198 | +// while preserving the most important parts of the error message |
| 199 | +func TruncateErrorForLogging(err error, maxLength int) error { |
| 200 | + if err == nil { |
| 201 | + return nil |
| 202 | + } |
| 203 | + |
| 204 | + errStr := err.Error() |
| 205 | + if len(errStr) <= maxLength { |
| 206 | + return err |
| 207 | + } |
| 208 | + |
| 209 | + // Otherwise truncate with indication |
| 210 | + return New(fmt.Sprintf("ERROR (truncated): %s... (truncated)", errStr[:maxLength-20])) |
| 211 | +} |
0 commit comments