增加 args 携带方法

Author: FishGoddess

HISTORY.md

@@ -1,5 +1,11 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.7.1
+
+> 此版本发布于 2024-08-12
+
+* 增加 args 携带方法
+
 ### v0.7.0
 
 > 此版本发布于 2024-08-11

README.en.md

@@ -43,8 +43,8 @@ func main() {
 	fmt.Println(code, message)
 
 	// Also, we provide some useful information carrier for you.
-	// For examples, you can carry an error or caller information.
-	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
+	// For examples, you can carry an error, caller information or some args.
+	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123).WithArgs("timeout", "200ms")
 	fmt.Println(err)
 	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 

README.md

@@ -43,8 +43,8 @@ func main() {
 	fmt.Println(code, message)
 
 	// Also, we provide some useful information carrier for you.
-	// For examples, you can carry an error or caller information.
-	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
+	// For examples, you can carry an error, caller information or some args.
+	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123).WithArgs("timeout", "200ms")
 	fmt.Println(err)
 	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 

_examples/basic.go

@@ -29,8 +29,8 @@ func main() {
 	fmt.Println(code, message)
 
 	// Also, we provide some useful information carrier for you.
-	// For examples, you can carry an error or caller information.
-	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
+	// For examples, you can carry an error, caller information or some args.
+	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123).WithArgs("timeout", "200ms")
 	fmt.Println(err)
 	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 

_icons/coverage.svg

@@ -6,15 +6,21 @@ package errors
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
-	"strings"
+)
+
+const (
+	keyBad     = "errors.bad_key"
+	keyCaller  = "errors.caller"
+	keyCallers = "errors.callers"
 )
 
 type Error struct {
 	code    int32
 	message string
 	cause   error
-	caller  string
+	args    map[string]any
 }
 
 // Wrap returns *Error with code and message formatted with args.
@@ -31,20 +37,30 @@ func Wrap(code int32, message string, args ...any) *Error {
 	return err
 }
 
+// With carries the cause err for *Error.
 func (e *Error) With(err error) *Error {
 	e.cause = err
 	return e
 }
 
-func (e *Error) WithCaller() *Error {
-	e.caller = Caller()
+// WithArgs carries some args for *Error.
+func (e *Error) WithArgs(key string, value any) *Error {
+	if e.args == nil {
+		e.args = make(map[string]any, 4)
+	}
+
+	e.args[key] = value
 	return e
 }
 
+// WithCaller carries the top caller for *Error.
+func (e *Error) WithCaller() *Error {
+	return e.WithArgs(keyCaller, Caller())
+}
+
+// WithCallers carries all callers for *Error.
 func (e *Error) WithCallers() *Error {
-	callers := Callers()
-	e.caller = strings.Join(callers, " ¦ ")
-	return e
+	return e.WithArgs(keyCallers, Callers())
 }
 
 // Code returns the code of *Error.
@@ -67,13 +83,24 @@ func (e *Error) Error() string {
 	return e.String()
 }
 
+func (e *Error) marshalArgs() []byte {
+	args, err := json.Marshal(e.args)
+	if err == nil {
+		return args
+	}
+
+	argsString := fmt.Sprintf(`{"args":"%+v","marshal_error":"%+v"}`, e.args, err)
+	return []byte(argsString)
+}
+
 // String returns *Error as string.
 func (e *Error) String() string {
 	var buff bytes.Buffer
 	fmt.Fprintf(&buff, "%d: %s", e.code, e.message)
 
-	if e.caller != "" {
-		fmt.Fprintf(&buff, " [%s]", e.caller)
+	if len(e.args) > 0 {
+		buff.WriteByte(' ')
+		buff.Write(e.marshalArgs())
 	}
 
 	if e.cause != nil {

wrap.go

@@ -12,20 +12,24 @@ import (
 // go test -v -cover -count=1 -test.cpu=1 -run=^TestWrap$
 func TestWrap(t *testing.T) {
 	testCases := []struct {
-		code    int32
-		message string
+		code        int32
+		message     string
+		args        []any
+		wantCode    int32
+		wantMessage string
 	}{
-		{code: -1000, message: "io timeout"},
-		{code: 1000, message: "need login"},
+		{code: -1000, message: "io timeout", args: nil, wantCode: -1000, wantMessage: "io timeout"},
+		{code: 1000, message: "need login", args: nil, wantCode: 1000, wantMessage: "need login"},
+		{code: 2000, message: "with args %d %s %+v", args: []any{1, "x", true}, wantCode: 2000, wantMessage: "with args 1 x true"},
 	}
 
 	for _, testCase := range testCases {
-		err := Wrap(testCase.code, testCase.message)
-		if err.Code() != testCase.code {
+		err := Wrap(testCase.code, testCase.message, testCase.args...)
+		if err.Code() != testCase.wantCode {
 			t.Errorf("err.Code() %d != testCase.code %d", err.Code(), testCase.code)
 		}
 
-		if err.Message() != testCase.message {
+		if err.Message() != testCase.wantMessage {
 			t.Errorf("err.Message() %s != testCase.code %s", err.Message(), testCase.message)
 		}
 
@@ -43,7 +47,7 @@ func TestWrapWith(t *testing.T) {
 		cause   error
 	}{
 		{code: -1000, message: "eof", cause: io.EOF},
-		{code: 1000, message: "need login"},
+		{code: 1000, message: "need login", cause: nil},
 	}
 
 	for _, testCase := range testCases {
@@ -68,14 +72,26 @@ func TestErrorError(t *testing.T) {
 		code        int32
 		message     string
 		cause       error
+		args        map[string]any
 		errorString string
 	}{
-		{code: -1000, message: "eof", cause: io.EOF, errorString: "-1000: eof (EOF)"},
-		{code: 1000, message: "need login", errorString: "1000: need login"},
+		{code: -1000, message: "eof", cause: io.EOF, args: nil, errorString: "-1000: eof (EOF)"},
+		{code: -1000, message: "eof", cause: io.EOF, args: map[string]any{"x": 666, "y": "300ms", "z": false}, errorString: "-1000: eof {\"x\":666,\"y\":\"300ms\",\"z\":false} (EOF)"},
+		{code: 1000, message: "need login", args: nil, errorString: "1000: need login"},
+		{code: 1000, message: "need login", args: map[string]any{"x": 123, "y": "100ms", "z": true}, errorString: "1000: need login {\"x\":123,\"y\":\"100ms\",\"z\":true}"},
 	}
 
 	for _, testCase := range testCases {
 		err := Wrap(testCase.code, testCase.message).With(testCase.cause)
+
+		for key, value := range testCase.args {
+			err = err.WithArgs(key, value)
+		}
+
+		if len(err.args) != len(testCase.args) {
+			t.Errorf("len(err.args) %d != len(testCase.args) %d", len(err.args), len(testCase.args))
+		}
+
 		if err.Error() != testCase.errorString {
 			t.Errorf("err.Error() %s != testCase.errorString %s", err.Error(), testCase.errorString)
 		}