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.

Sign up for GitHub

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

Jump to bottom

Add an option to print args with default verbs #25

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add an option to print args with default verbs #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ac2032
Add an option to print args with default verbs
overvenus Sep 4, 2020
6645dcb
terror: add default format verbs option
overvenus Sep 4, 2020
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
19 changes: 18 additions & 1 deletion terror_error.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ type Error struct {
codeText ErrCodeText
// message is a template of the description of this error.
// printf-style formatting is enabled.
message string
message string
defaultFmt bool
// The workaround field: how to work around this error.
// It's used to teach the users how to solve the error if occurring in the real environment.
workaround string
Expand Down Expand Up @@ -126,6 +127,12 @@ func (e *Error) Error() string {

func (e *Error) GetMsg() string {
if len(e.args) > 0 {
if e.defaultFmt {
args := make([]interface{}, 0, 1+len(e.args))
args = append(args, e.message+": ")
args = append(args, e.args...)
return fmt.Sprint(args...)
}
return fmt.Sprintf(e.message, e.args...)
}
return e.message
Expand All @@ -147,6 +154,8 @@ func (e *Error) fillLineAndFile(skip int) {
func (e *Error) GenWithStack(format string, args ...interface{}) error {
err := *e
err.message = format
// Always enable printf style message.
err.defaultFmt = false
err.args = args
err.fillLineAndFile(1)
return AddStack(&err)
Expand All @@ -165,6 +174,8 @@ func (e *Error) GenWithStackByArgs(args ...interface{}) error {
func (e *Error) FastGen(format string, args ...interface{}) error {
err := *e
err.message = format
// Always enable printf style message.
err.defaultFmt = false
err.args = args
return SuspendStack(&err)
}
Expand Down Expand Up @@ -340,6 +351,12 @@ func MySQLErrorCode(code int) NormalizeOption {
}
}

func MessageDefaultFormat() NormalizeOption {
return func(e *Error) {
e.defaultFmt = true
}
}

// Normalize creates a new Error object.
func Normalize(message string, opts ...NormalizeOption) *Error {
e := &Error{
Expand Down
14 changes: 14 additions & 0 deletions terror_test/terror_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,17 @@ func (*testTErrorSuite) TestWarpAndField(c *C) {
errWithWarpedCause := errors.Annotate(ErrGetLeader, causeErr.Error())
c.Assert(errWithWarpedCause.Error(), Equals, "load from etcd meet error: [member:ErrGetLeader]fail to get leader")
}

func (*testTErrorSuite) TestMessageDefaultFormat(c *C) {
causeErr := errors.New("load from etcd meet error")
ErrGetLeader := errors.Normalize("fail to get leader", errors.RFCCodeText("member:ErrGetLeader"), errors.MessageDefaultFormat())

errAnnotate := errors.Annotate(ErrGetLeader, causeErr.Error())
c.Assert(errAnnotate.Error(), Equals, "load from etcd meet error: [member:ErrGetLeader]fail to get leader")

errFastGenByArgs := ErrGetLeader.FastGenByArgs(causeErr.Error())
c.Assert(errFastGenByArgs.Error(), Equals, "[member:ErrGetLeader]fail to get leader: load from etcd meet error")

errFastGen := ErrGetLeader.FastGen("caused by: %s", causeErr.Error())
c.Assert(errFastGen.Error(), Equals, "[member:ErrGetLeader]caused by: load from etcd meet error")
}