Fix the output is incorrect when writing an error log with arguments that contain the format character (#11)

mstmdev · web-flow · commit dbd14a54ec1f · 2023-02-20T15:12:54.000+08:00
diff --git a/formatter/json/json.go b/formatter/json/json.go
@@ -19,7 +19,7 @@ func newJsonFormatter() formatter.Formatter {
 func (f *jsonFormatter) Serialize(c content.Content) ([]byte, error) {
 	c.Log = fmt.Sprintf(c.Log, c.Args...)
 	if c.Error != nil {
-		c.Log = fmt.Sprintf(c.Log+". %s", c.Error)
+		c.Log = c.Log + ". " + c.Error.Error()
 	}
 	buf := new(bytes.Buffer)
 	encoder := json.NewEncoder(buf)
diff --git a/formatter/json/json_test.go b/formatter/json/json_test.go
@@ -27,6 +27,7 @@ func TestJsonFormatter_Serialize(t *testing.T) {
 		{"debug with args and append time", content.NewContentWithTime(level.DebugLevel, nil, logTimeP, "<json formatter> %s %s", "hello", "world"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello world"}`},
 		{"error no args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<json formatter> hello"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello. test error"}`},
 		{"error with args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<json formatter> %s %s", "hello", "world"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello world. test error"}`},
+		{"error with args that contain the format character", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<json formatter> %s %s", "hello%s%v", "world"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello%s%v world. test error"}`},
 	}
 	f := newJsonFormatter()
 	for _, tc := range testCases {
diff --git a/formatter/text/text.go b/formatter/text/text.go
@@ -23,7 +23,7 @@ func (f *textFormatter) Serialize(c content.Content) ([]byte, error) {
 	content := fmt.Sprintf(c.Log, c.Args...)
 	format = fmt.Sprintf(format, timeSection, c.Level.String(), content)
 	if c.Error != nil {
-		format = fmt.Sprintf(format+". %s", c.Error)
+		format = format + ". " + c.Error.Error()
 	}
 	format = formatter.AppendRowTerminator(format)
 	return []byte(format), nil
diff --git a/formatter/text/text_test.go b/formatter/text/text_test.go
@@ -27,6 +27,7 @@ func TestTextFormatter_Serialize(t *testing.T) {
 		{"debug with args and append time", content.NewContentWithTime(level.DebugLevel, nil, logTimeP, "<text formatter> %s %s", "hello", "world"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello world"},
 		{"error no args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<text formatter> hello"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello. test error"},
 		{"error with args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<text formatter> %s %s", "hello", "world"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello world. test error"},
+		{"error with args that contain the format character", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<text formatter> %s %s", "hello%s%v", "world"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello%s%v world. test error"},
 	}
 	f := newTextFormatter()
 	for _, tc := range testCases {

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ func newJsonFormatter() formatter.Formatter {`
`19`	`19`	`func (f *jsonFormatter) Serialize(c content.Content) ([]byte, error) {`
`20`	`20`	`c.Log = fmt.Sprintf(c.Log, c.Args...)`
`21`	`21`	`if c.Error != nil {`
`22`		`- c.Log = fmt.Sprintf(c.Log+". %s", c.Error)`
	`22`	`+ c.Log = c.Log + ". " + c.Error.Error()`
`23`	`23`	`}`
`24`	`24`	`buf := new(bytes.Buffer)`
`25`	`25`	`encoder := json.NewEncoder(buf)`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ func TestJsonFormatter_Serialize(t *testing.T) {`
`27`	`27`	{"debug with args and append time", content.NewContentWithTime(level.DebugLevel, nil, logTimeP, "<json formatter> %s %s", "hello", "world"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello world"}`},
`28`	`28`	{"error no args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<json formatter> hello"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello. test error"}`},
`29`	`29`	{"error with args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<json formatter> %s %s", "hello", "world"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello world. test error"}`},
	`30`	+ {"error with args that contain the format character", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<json formatter> %s %s", "hello%s%v", "world"), `{"level":"DEBUG","time":"2022-06-25 23:59:59","log":"<json formatter> hello%s%v world. test error"}`},
`30`	`31`	`}`
`31`	`32`	`f := newJsonFormatter()`
`32`	`33`	`for _, tc := range testCases {`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func (f *textFormatter) Serialize(c content.Content) ([]byte, error) {`
`23`	`23`	`content := fmt.Sprintf(c.Log, c.Args...)`
`24`	`24`	`format = fmt.Sprintf(format, timeSection, c.Level.String(), content)`
`25`	`25`	`if c.Error != nil {`
`26`		`- format = fmt.Sprintf(format+". %s", c.Error)`
	`26`	`+ format = format + ". " + c.Error.Error()`
`27`	`27`	`}`
`28`	`28`	`format = formatter.AppendRowTerminator(format)`
`29`	`29`	`return []byte(format), nil`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ func TestTextFormatter_Serialize(t *testing.T) {`
`27`	`27`	`{"debug with args and append time", content.NewContentWithTime(level.DebugLevel, nil, logTimeP, "<text formatter> %s %s", "hello", "world"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello world"},`
`28`	`28`	`{"error no args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<text formatter> hello"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello. test error"},`
`29`	`29`	`{"error with args and append time", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<text formatter> %s %s", "hello", "world"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello world. test error"},`
	`30`	`+ {"error with args that contain the format character", content.NewContentWithTime(level.DebugLevel, errors.New("test error"), logTimeP, "<text formatter> %s %s", "hello%s%v", "world"), "[2022-06-25 23:59:59] [DEBUG] <text formatter> hello%s%v world. test error"},`
`30`	`31`	`}`
`31`	`32`	`f := newTextFormatter()`
`32`	`33`	`for _, tc := range testCases {`