Browse Source
Remvoe errors package from libs (#4157)
*libs/common/errors: remove package - remove errors file from cmn pkg - use errorf instead of wrap in async function - add changelog entry - closes #3862pull/4162/head
Marko
5 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 38 additions and 347 deletions
Unified View
Diff Options
-
+24 -20CHANGELOG_PENDING.md
-
+3 -1libs/common/async.go
-
+6 -5libs/common/async_test.go
-
+0 -214libs/common/errors.go
-
+0 -101libs/common/errors_test.go
-
+2 -3lite/base_verifier.go
-
+3 -3lite/proxy/query.go
+ 24
- 20
CHANGELOG_PENDING.md
View File
+ 3
- 1
libs/common/async.go
View File
+ 6
- 5
libs/common/async_test.go
View File
+ 0
- 214
libs/common/errors.go
View File
| @ -1,214 +0,0 @@ | |||||
| package common | |||||
| import ( | |||||
| "fmt" | |||||
| "runtime" | |||||
| ) | |||||
| //---------------------------------------- | |||||
| // Convenience method. | |||||
| func ErrorWrap(cause interface{}, format string, args ...interface{}) Error { | |||||
| if causeCmnError, ok := cause.(*cmnError); ok { //nolint:gocritic | |||||
| msg := fmt.Sprintf(format, args...) | |||||
| return causeCmnError.Stacktrace().Trace(1, msg) | |||||
| } else if cause == nil { | |||||
| return newCmnError(FmtError{format, args}).Stacktrace() | |||||
| } else { | |||||
| // NOTE: causeCmnError is a typed nil here. | |||||
| msg := fmt.Sprintf(format, args...) | |||||
| return newCmnError(cause).Stacktrace().Trace(1, msg) | |||||
| } | |||||
| } | |||||
| //---------------------------------------- | |||||
| // Error & cmnError | |||||
| /* | |||||
| Usage with arbitrary error data: | |||||
| ```go | |||||
| // Error construction | |||||
| type MyError struct{} | |||||
| var err1 error = NewErrorWithData(MyError{}, "my message") | |||||
| ... | |||||
| // Wrapping | |||||
| var err2 error = ErrorWrap(err1, "another message") | |||||
| if (err1 != err2) { panic("should be the same") | |||||
| ... | |||||
| // Error handling | |||||
| switch err2.Data().(type){ | |||||
| case MyError: ... | |||||
| default: ... | |||||
| } | |||||
| ``` | |||||
| */ | |||||
| type Error interface { | |||||
| Error() string | |||||
| Stacktrace() Error | |||||
| Trace(offset int, format string, args ...interface{}) Error | |||||
| Data() interface{} | |||||
| } | |||||
| // New Error with formatted message. | |||||
| // The Error's Data will be a FmtError type. | |||||
| func NewError(format string, args ...interface{}) Error { | |||||
| err := FmtError{format, args} | |||||
| return newCmnError(err) | |||||
| } | |||||
| // New Error with specified data. | |||||
| func NewErrorWithData(data interface{}) Error { | |||||
| return newCmnError(data) | |||||
| } | |||||
| type cmnError struct { | |||||
| data interface{} // associated data | |||||
| msgtraces []msgtraceItem // all messages traced | |||||
| stacktrace []uintptr // first stack trace | |||||
| } | |||||
| var _ Error = &cmnError{} | |||||
| // NOTE: do not expose. | |||||
| func newCmnError(data interface{}) *cmnError { | |||||
| return &cmnError{ | |||||
| data: data, | |||||
| msgtraces: nil, | |||||
| stacktrace: nil, | |||||
| } | |||||
| } | |||||
| // Implements error. | |||||
| func (err *cmnError) Error() string { | |||||
| return fmt.Sprintf("%v", err) | |||||
| } | |||||
| // Captures a stacktrace if one was not already captured. | |||||
| func (err *cmnError) Stacktrace() Error { | |||||
| if err.stacktrace == nil { | |||||
| var offset = 3 | |||||
| var depth = 32 | |||||
| err.stacktrace = captureStacktrace(offset, depth) | |||||
| } | |||||
| return err | |||||
| } | |||||
| // Add tracing information with msg. | |||||
| // Set n=0 unless wrapped with some function, then n > 0. | |||||
| func (err *cmnError) Trace(offset int, format string, args ...interface{}) Error { | |||||
| msg := fmt.Sprintf(format, args...) | |||||
| return err.doTrace(msg, offset) | |||||
| } | |||||
| // Return the "data" of this error. | |||||
| // Data could be used for error handling/switching, | |||||
| // or for holding general error/debug information. | |||||
| func (err *cmnError) Data() interface{} { | |||||
| return err.data | |||||
| } | |||||
| func (err *cmnError) doTrace(msg string, n int) Error { | |||||
| pc, _, _, _ := runtime.Caller(n + 2) // +1 for doTrace(). +1 for the caller. | |||||
| // Include file & line number & msg. | |||||
| // Do not include the whole stack trace. | |||||
| err.msgtraces = append(err.msgtraces, msgtraceItem{ | |||||
| pc: pc, | |||||
| msg: msg, | |||||
| }) | |||||
| return err | |||||
| } | |||||
| func (err *cmnError) Format(s fmt.State, verb rune) { | |||||
| switch verb { | |||||
| case 'p': | |||||
| s.Write([]byte(fmt.Sprintf("%p", &err))) | |||||
| default: | |||||
| if s.Flag('#') { | |||||
| s.Write([]byte("--= Error =--\n")) | |||||
| // Write data. | |||||
| s.Write([]byte(fmt.Sprintf("Data: %#v\n", err.data))) | |||||
| // Write msg trace items. | |||||
| s.Write([]byte(fmt.Sprintf("Msg Traces:\n"))) | |||||
| for i, msgtrace := range err.msgtraces { | |||||
| s.Write([]byte(fmt.Sprintf(" %4d %s\n", i, msgtrace.String()))) | |||||
| } | |||||
| // Write stack trace. | |||||
| if err.stacktrace != nil { | |||||
| s.Write([]byte(fmt.Sprintf("Stack Trace:\n"))) | |||||
| for i, pc := range err.stacktrace { | |||||
| fnc := runtime.FuncForPC(pc) | |||||
| file, line := fnc.FileLine(pc) | |||||
| s.Write([]byte(fmt.Sprintf(" %4d %s:%d\n", i, file, line))) | |||||
| } | |||||
| } | |||||
| s.Write([]byte("--= /Error =--\n")) | |||||
| } else { | |||||
| // Write msg. | |||||
| s.Write([]byte(fmt.Sprintf("%v", err.data))) | |||||
| } | |||||
| } | |||||
| } | |||||
| //---------------------------------------- | |||||
| // stacktrace & msgtraceItem | |||||
| func captureStacktrace(offset int, depth int) []uintptr { | |||||
| var pcs = make([]uintptr, depth) | |||||
| n := runtime.Callers(offset, pcs) | |||||
| return pcs[0:n] | |||||
| } | |||||
| type msgtraceItem struct { | |||||
| pc uintptr | |||||
| msg string | |||||
| } | |||||
| func (mti msgtraceItem) String() string { | |||||
| fnc := runtime.FuncForPC(mti.pc) | |||||
| file, line := fnc.FileLine(mti.pc) | |||||
| return fmt.Sprintf("%s:%d - %s", | |||||
| file, line, | |||||
| mti.msg, | |||||
| ) | |||||
| } | |||||
| //---------------------------------------- | |||||
| // fmt error | |||||
| /* | |||||
| FmtError is the data type for NewError() (e.g. NewError().Data().(FmtError)) | |||||
| Theoretically it could be used to switch on the format string. | |||||
| ```go | |||||
| // Error construction | |||||
| var err1 error = NewError("invalid username %v", "BOB") | |||||
| var err2 error = NewError("another kind of error") | |||||
| ... | |||||
| // Error handling | |||||
| switch err1.Data().(cmn.FmtError).Format() { | |||||
| case "invalid username %v": ... | |||||
| case "another kind of error": ... | |||||
| default: ... | |||||
| } | |||||
| ``` | |||||
| */ | |||||
| type FmtError struct { | |||||
| format string | |||||
| args []interface{} | |||||
| } | |||||
| func (fe FmtError) Error() string { | |||||
| return fmt.Sprintf(fe.format, fe.args...) | |||||
| } | |||||
| func (fe FmtError) String() string { | |||||
| return fmt.Sprintf("FmtError{format:%v,args:%v}", | |||||
| fe.format, fe.args) | |||||
| } | |||||
| func (fe FmtError) Format() string { | |||||
| return fe.format | |||||
| } | |||||
+ 0
- 101
libs/common/errors_test.go
View File
| @ -1,101 +0,0 @@ | |||||
| package common | |||||
| import ( | |||||
| fmt "fmt" | |||||
| "testing" | |||||
| "github.com/stretchr/testify/assert" | |||||
| ) | |||||
| func TestErrorPanic(t *testing.T) { | |||||
| type pnk struct { | |||||
| msg string | |||||
| } | |||||
| capturePanic := func() (err Error) { | |||||
| defer func() { | |||||
| if r := recover(); r != nil { | |||||
| err = ErrorWrap(r, "This is the message in ErrorWrap(r, message).") | |||||
| } | |||||
| }() | |||||
| panic(pnk{"something"}) | |||||
| } | |||||
| var err = capturePanic() | |||||
| assert.Equal(t, pnk{"something"}, err.Data()) | |||||
| assert.Equal(t, "{something}", fmt.Sprintf("%v", err)) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), "This is the message in ErrorWrap(r, message).") | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), "Stack Trace:\n 0") | |||||
| } | |||||
| func TestErrorWrapSomething(t *testing.T) { | |||||
| var err = ErrorWrap("something", "formatter%v%v", 0, 1) | |||||
| assert.Equal(t, "something", err.Data()) | |||||
| assert.Equal(t, "something", fmt.Sprintf("%v", err)) | |||||
| assert.Regexp(t, `formatter01\n`, fmt.Sprintf("%#v", err)) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), "Stack Trace:\n 0") | |||||
| } | |||||
| func TestErrorWrapNothing(t *testing.T) { | |||||
| var err = ErrorWrap(nil, "formatter%v%v", 0, 1) | |||||
| assert.Equal(t, | |||||
| FmtError{"formatter%v%v", []interface{}{0, 1}}, | |||||
| err.Data()) | |||||
| assert.Equal(t, "formatter01", fmt.Sprintf("%v", err)) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), `Data: common.FmtError{format:"formatter%v%v", args:[]interface {}{0, 1}}`) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), "Stack Trace:\n 0") | |||||
| } | |||||
| func TestErrorNewError(t *testing.T) { | |||||
| var err = NewError("formatter%v%v", 0, 1) | |||||
| assert.Equal(t, | |||||
| FmtError{"formatter%v%v", []interface{}{0, 1}}, | |||||
| err.Data()) | |||||
| assert.Equal(t, "formatter01", fmt.Sprintf("%v", err)) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), `Data: common.FmtError{format:"formatter%v%v", args:[]interface {}{0, 1}}`) | |||||
| assert.NotContains(t, fmt.Sprintf("%#v", err), "Stack Trace") | |||||
| } | |||||
| func TestErrorNewErrorWithStacktrace(t *testing.T) { | |||||
| var err = NewError("formatter%v%v", 0, 1).Stacktrace() | |||||
| assert.Equal(t, | |||||
| FmtError{"formatter%v%v", []interface{}{0, 1}}, | |||||
| err.Data()) | |||||
| assert.Equal(t, "formatter01", fmt.Sprintf("%v", err)) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), `Data: common.FmtError{format:"formatter%v%v", args:[]interface {}{0, 1}}`) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), "Stack Trace:\n 0") | |||||
| } | |||||
| func TestErrorNewErrorWithTrace(t *testing.T) { | |||||
| var err = NewError("formatter%v%v", 0, 1) | |||||
| err.Trace(0, "trace %v", 1) | |||||
| err.Trace(0, "trace %v", 2) | |||||
| err.Trace(0, "trace %v", 3) | |||||
| assert.Equal(t, | |||||
| FmtError{"formatter%v%v", []interface{}{0, 1}}, | |||||
| err.Data()) | |||||
| assert.Equal(t, "formatter01", fmt.Sprintf("%v", err)) | |||||
| assert.Contains(t, fmt.Sprintf("%#v", err), `Data: common.FmtError{format:"formatter%v%v", args:[]interface {}{0, 1}}`) | |||||
| dump := fmt.Sprintf("%#v", err) | |||||
| assert.NotContains(t, dump, "Stack Trace") | |||||
| assert.Regexp(t, `common/errors_test\.go:[0-9]+ - trace 1`, dump) | |||||
| assert.Regexp(t, `common/errors_test\.go:[0-9]+ - trace 2`, dump) | |||||
| assert.Regexp(t, `common/errors_test\.go:[0-9]+ - trace 3`, dump) | |||||
| } | |||||
| func TestErrorWrapError(t *testing.T) { | |||||
| var err1 error = NewError("my message") | |||||
| var err2 error = ErrorWrap(err1, "another message") | |||||
| assert.Equal(t, err1, err2) | |||||
| } | |||||