调整 WithArgs 方法，支持多参数传递

Author: FishGoddess

HISTORY.md

@@ -1,5 +1,11 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.7.2
+
+> 此版本发布于 2024-08-21
+
+* 调整 WithArgs 方法，支持多参数传递
+
 ### v0.7.1
 
 > 此版本发布于 2024-08-12

README.en.md

@@ -44,7 +44,8 @@ func main() {
 
 	// Also, we provide some useful information carrier for you.
 	// 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")
+	// Remember args should be a field slice with string keys and any values.
+	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123, "timeout", "200ms")
 	fmt.Println(err)
 	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 

README.md

@@ -44,7 +44,8 @@ func main() {
 
 	// Also, we provide some useful information carrier for you.
 	// 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")
+	// Remember args should be a field slice with string keys and any values.
+	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123, "timeout", "200ms")
 	fmt.Println(err)
 	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 

_examples/basic.go

@@ -30,7 +30,8 @@ func main() {
 
 	// Also, we provide some useful information carrier for you.
 	// 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")
+	// Remember args should be a field slice with string keys and any values.
+	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123, "timeout", "200ms")
 	fmt.Println(err)
 	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 

_icons/coverage.svg

@@ -8,6 +8,7 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
+	"strconv"
 )
 
 const (
@@ -44,12 +45,36 @@ func (e *Error) With(err error) *Error {
 }
 
 // WithArgs carries some args for *Error.
-func (e *Error) WithArgs(key string, value any) *Error {
+func (e *Error) WithArgs(args ...any) *Error {
 	if e.args == nil {
 		e.args = make(map[string]any, 4)
 	}
 
-	e.args[key] = value
+	badKeys := 0
+	badKey := func() string {
+		badKeys++
+		return keyBad + "_" + strconv.Itoa(badKeys)
+	}
+
+	for len(args) > 0 {
+		// One last arg, tag it as bad key.
+		if len(args) == 1 {
+			e.args[badKey()] = args[0]
+			break
+		}
+
+		// len(kvs) >= 2, the key should be a string
+		k, v := args[0], args[1]
+		if ks, ok := k.(string); ok {
+			e.args[ks] = v
+		} else {
+			e.args[badKey()] = k
+			e.args[badKey()] = v
+		}
+
+		args = args[2:]
+	}
+
 	return e
 }
 
@@ -73,11 +98,25 @@ func (e *Error) Message() string {
 	return e.message
 }
 
-// Unwrap unwraps *Error and returns its cause error.
+// Unwrap returns the cause of *Error.
 func (e *Error) Unwrap() error {
 	return e.cause
 }
 
+// Args returns the args of *Error.
+func (e *Error) Args() map[string]any {
+	if e.args == nil {
+		return nil
+	}
+
+	args := make(map[string]any, len(e.args))
+	for k, v := range e.args {
+		args[k] = v
+	}
+
+	return args
+}
+
 // Error returns *Error as string.
 func (e *Error) Error() string {
 	return e.String()

wrap.go

@@ -5,10 +5,37 @@
 package errors
 
 import (
+	"fmt"
 	"io"
 	"testing"
 )
 
+func compareMaps(m1 map[string]any, m2 map[string]any) error {
+	for k1, v1 := range m1 {
+		v2, ok := m2[k1]
+		if !ok {
+			return fmt.Errorf("key %s not found in m2 %+v", k1, m2)
+		}
+
+		if v1 != v2 {
+			return fmt.Errorf("v1 %+v != v2 %+v", v1, v2)
+		}
+	}
+
+	for k2, v2 := range m2 {
+		v1, ok := m1[k2]
+		if !ok {
+			return fmt.Errorf("key %s not found in m1 %+v", k2, m1)
+		}
+
+		if v1 != v2 {
+			return fmt.Errorf("v1 %+v != v2 %+v", v1, v2)
+		}
+	}
+
+	return nil
+}
+
 // go test -v -cover -count=1 -test.cpu=1 -run=^TestWrap$
 func TestWrap(t *testing.T) {
 	testCases := []struct {
@@ -66,6 +93,44 @@ func TestWrapWith(t *testing.T) {
 	}
 }
 
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestWrapWithArgs$
+func TestWrapWithArgs(t *testing.T) {
+	testCases := []struct {
+		code     int32
+		message  string
+		cause    error
+		args     []any
+		wantArgs map[string]any
+	}{
+		{code: -1000, message: "eof", cause: io.EOF, args: nil, wantArgs: nil},
+		{code: 1000, message: "need login", cause: nil, args: nil, wantArgs: nil},
+		{code: 1000, message: "need login", cause: nil, args: []any{io.EOF}, wantArgs: map[string]any{keyBad + "_1": io.EOF}},
+		{code: -1000, message: "eof", cause: io.EOF, args: []any{1, true, 3.14, io.EOF}, wantArgs: map[string]any{keyBad + "_1": 1, keyBad + "_2": true, keyBad + "_3": 3.14, keyBad + "_4": io.EOF}},
+		{code: -1000, message: "eof", cause: io.EOF, args: []any{1, true, 3.14, "abc"}, wantArgs: map[string]any{keyBad + "_1": 1, keyBad + "_2": true, keyBad + "_3": 3.14, keyBad + "_4": "abc"}},
+		{code: 1000, message: "need login", cause: io.EOF, args: []any{"k1", 1, "k2", true, "k3", 3.14, "key", "abc"}, wantArgs: map[string]any{"k1": 1, "k2": true, "k3": 3.14, "key": "abc"}},
+	}
+
+	for _, testCase := range testCases {
+		err := Wrap(testCase.code, testCase.message).With(testCase.cause).WithArgs(testCase.args...)
+		if err.Code() != testCase.code {
+			t.Errorf("err.Code() %d != testCase.code %d", err.Code(), testCase.code)
+		}
+
+		if err.Message() != testCase.message {
+			t.Errorf("err.Message() %s != testCase.code %s", err.Message(), testCase.message)
+		}
+
+		if err.Unwrap() != testCase.cause {
+			t.Errorf("err.Unwrap() %+v != testCase.code %+v", err.Unwrap(), testCase.cause)
+		}
+
+		args := err.Args()
+		if merr := compareMaps(args, testCase.wantArgs); merr != nil {
+			t.Error(merr)
+		}
+	}
+}
+
 // go test -v -cover -count=1 -test.cpu=1 -run=^TestErrorError$
 func TestErrorError(t *testing.T) {
 	testCases := []struct {