Skip to content
This repository was archived by the owner on Mar 31, 2023. It is now read-only.

Fix JSONFormat to ensure outputting JSON on NaN and Infinities #29

Merged
merged 4 commits into from
Jan 20, 2023
Merged

Fix JSONFormat to ensure outputting JSON on NaN and Infinities #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e6798d
Fix JSONFormat to ensure outputting JSON on NaN and Infinities
itchyny Mar 14, 2022
091c151
Update JSONFormat test to cover floating-point numbers
itchyny Mar 14, 2022
0e5bdc9
Update Logfmt test to look like PlainFormat test
itchyny Mar 14, 2022
80e26a3
Update PlainFormat and Logfmt tests to cover floating-point numbers
itchyny Mar 14, 2022
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
17 changes: 15 additions & 2 deletions json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"encoding"
"encoding/json"
"fmt"
"math"
"reflect"
"strconv"
"strings"
Expand Down Expand Up @@ -182,12 +183,12 @@ func appendJSON(buf []byte, v interface{}) ([]byte, error) {
if cap(buf) < 256 {
return nil, ErrTooLarge
}
return strconv.AppendFloat(buf, float64(t), 'f', -1, 32), nil
return appendFloat(buf, float64(t), 32), nil
case float64:
if cap(buf) < 256 {
return nil, ErrTooLarge
}
return strconv.AppendFloat(buf, t, 'f', -1, 64), nil
return appendFloat(buf, t, 64), nil
case string:
if !utf8.ValidString(t) {
// the next line replaces invalid characters.
Expand Down Expand Up @@ -303,3 +304,15 @@ func appendJSON(buf []byte, v interface{}) ([]byte, error) {
// other types are just formatted as a string with "%#v".
return appendJSON(buf, fmt.Sprintf("%#v", v))
}

func appendFloat(buf []byte, v float64, bitSize int) []byte {
if math.IsNaN(v) {
return append(buf, `"NaN"`...)
} else if math.IsInf(v, 1) {
return append(buf, `"+Inf"`...)
} else if math.IsInf(v, -1) {
return append(buf, `"-Inf"`...)
} else {
return strconv.AppendFloat(buf, v, 'f', -1, bitSize)
}
}
23 changes: 22 additions & 1 deletion json_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package log
import (
"bytes"
"encoding/json"
"math"
"reflect"
"testing"
"time"
Expand Down Expand Up @@ -111,6 +112,8 @@ func TestJSONFormat(t *testing.T) {

b, err = f.Format(buf, l, ts, LvDebug, "fuga fuga", map[string]interface{}{
"abc": []int{1, 2, 3},
"float32": []float32{3.14159, float32(math.NaN()), float32(math.Inf(1)), float32(math.Inf(-1))},
"float64": []float64{3.14159, math.NaN(), math.Inf(1), math.Inf(-1)},
"invalid": "12\xc534",
"tm": testTextMarshal{},
"jm": testJSONMarshal{},
Expand Down Expand Up @@ -153,7 +156,25 @@ func TestJSONFormat(t *testing.T) {
} else {
if !reflect.DeepEqual(v.([]interface{}), []interface{}{1.0, 2.0, 3.0}) {
t.Error(`!reflect.DeepEqual(v.([]interface{}), []interface{}{1, 2, 3})`)
t.Logf("%#v", v.([]interface{}))
t.Logf("%#v", v)
}
}

if v, ok := j["float32"]; !ok {
t.Error(`v, ok := j["float32"]; !ok`)
} else {
if !reflect.DeepEqual(v.([]interface{}), []interface{}{3.14159, "NaN", "+Inf", "-Inf"}) {
t.Error(`!reflect.DeepEqual(v.([]interface{}), []interface{}{3.14159, "NaN", "+Inf", "-Inf"})`)
t.Logf("%#v", v)
}
}

if v, ok := j["float64"]; !ok {
t.Error(`v, ok := j["float64"]; !ok`)
} else {
if !reflect.DeepEqual(v.([]interface{}), []interface{}{3.14159, "NaN", "+Inf", "-Inf"}) {
t.Error(`!reflect.DeepEqual(v.([]interface{}), []interface{}{3.14159, "NaN", "+Inf", "-Inf"})`)
t.Logf("%#v", v)
}
}

Expand Down
71 changes: 44 additions & 27 deletions logfmt_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package log
import (
"bytes"
"fmt"
"math"
"testing"
"time"
"unicode/utf8"
Expand All @@ -17,56 +18,74 @@ const (
func TestAppendLogfmt(t *testing.T) {
t.Parallel()

b := make([]byte, 0, 4096)
b, _ = appendLogfmt(b, nil)
buf := make([]byte, 0, 4096)

b, _ := appendLogfmt(buf, nil)
if string(b) != "null" {
t.Error(string(b) + " != null")
}

b = b[:0]
b, _ = appendLogfmt(b, 100)
b, _ = appendLogfmt(buf, 100)
if string(b) != "100" {
t.Error(string(b) + " != 100")
}

b = b[:0]
b, _ = appendLogfmt(b, false)
b, _ = appendLogfmt(buf, false)
if string(b) != "false" {
t.Error(string(b) + " != false")
}

b = b[:0]
b, _ = appendLogfmt(b, true)
b, _ = appendLogfmt(buf, true)
if string(b) != "true" {
t.Error(string(b) + " != true")
}

b = b[:0]
b, _ = appendLogfmt(b, `"abc `)
b, _ = appendLogfmt(buf, `"abc `)
if string(b) != `"\"abc "` {
t.Error(string(b) + ` != "\"abc "`)
}

b = b[:0]
b, _ = appendLogfmt(b, []int{-100, 100, 20000})
if string(b) != `[-100 100 20000]` {
t.Error("failed to format int list")
b, _ = appendLogfmt(buf, float32(3.14159))
if string(b) != "3.14159" {
t.Error(string(b) + ` != "3.14159"`)
}

b, _ = appendLogfmt(buf, 3.14159)
if string(b) != "3.14159" {
t.Error(string(b) + ` != "3.14159"`)
}

b, _ = appendLogfmt(buf, math.NaN())
if string(b) != "NaN" {
t.Error(string(b) + ` != "NaN"`)
}

b, _ = appendLogfmt(buf, math.Inf(1))
if string(b) != "+Inf" {
t.Error(string(b) + ` != "+Inf"`)
}

b, _ = appendLogfmt(buf, math.Inf(-1))
if string(b) != "-Inf" {
t.Error(string(b) + ` != "-Inf"`)
}

b, _ = appendLogfmt(buf, []int{-100, 100, 20000})
if string(b) != "[-100 100 20000]" {
t.Error(string(b) + ` != "[-100 100 20000]"`)
}

b = b[:0]
b, _ = appendLogfmt(b, []int64{-100, 100, 20000})
if string(b) != `[-100 100 20000]` {
t.Error("failed to format int64 list")
b, _ = appendLogfmt(buf, []int64{-100, 100, 20000})
if string(b) != "[-100 100 20000]" {
t.Error(string(b) + ` != "[-100 100 20000]"`)
}

b = b[:0]
b, _ = appendLogfmt(b, []string{"abc", "def"})
b, _ = appendLogfmt(buf, []string{"abc", "def"})
if string(b) != `["abc" "def"]` {
t.Error("failed to format string list")
t.Error(string(b) + ` != ["abc" "def"]`)
}

b = b[:0]
b, _ = appendLogfmt(b, map[string]interface{}{
b, _ = appendLogfmt(buf, map[string]interface{}{
"abc": 123,
"def ghi": nil,
})
Expand All @@ -76,8 +95,7 @@ func TestAppendLogfmt(t *testing.T) {
}

invalidUtf8 := "hello" + string([]byte{0x80})
b = b[:0]
b, err := appendLogfmt(b, invalidUtf8)
b, err := appendLogfmt(buf, invalidUtf8)
if err != nil {
t.Error(err)
} else {
Expand All @@ -92,8 +110,7 @@ func TestAppendLogfmt(t *testing.T) {
}
}

b = b[:0]
b, err = appendLogfmt(b, fmt.Errorf(invalidUtf8))
b, err = appendLogfmt(buf, fmt.Errorf(invalidUtf8))
if err != nil {
t.Error(err)
} else {
Expand Down
42 changes: 39 additions & 3 deletions plain_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package log
import (
"bytes"
"fmt"
"math"
"testing"
"time"
"unicode/utf8"
Expand All @@ -15,17 +16,52 @@ func TestAppendPlain(t *testing.T) {

b, _ := appendPlain(buf, nil)
if string(b) != "null" {
t.Error(`string(b) != "null"`)
t.Error(string(b) + ` != "null"`)
}

b, _ = appendLogfmt(buf, 100)
if string(b) != "100" {
t.Error(string(b) + " != 100")
}

b, _ = appendPlain(buf, false)
if string(b) != "false" {
t.Error(string(b) + ` != "false"`)
}

b, _ = appendPlain(buf, true)
if string(b) != "true" {
t.Error(`string(b) != "true"`)
t.Error(string(b) + ` != "true"`)
}

b, _ = appendPlain(buf, int16(-12345))
if string(b) != "-12345" {
t.Error(`string(b) != "-12345"`)
t.Error(string(b) + ` != "-12345"`)
}

b, _ = appendPlain(buf, float32(3.14159))
if string(b) != "3.14159" {
t.Error(string(b) + ` != "3.14159"`)
}

b, _ = appendPlain(buf, 3.14159)
if string(b) != "3.14159" {
t.Error(string(b) + ` != "3.14159"`)
}

b, _ = appendPlain(buf, math.NaN())
if string(b) != "NaN" {
t.Error(string(b) + ` != "NaN"`)
}

b, _ = appendPlain(buf, math.Inf(1))
if string(b) != "+Inf" {
t.Error(string(b) + ` != "+Inf"`)
}

b, _ = appendPlain(buf, math.Inf(-1))
if string(b) != "-Inf" {
t.Error(string(b) + ` != "-Inf"`)
}

b, err := appendPlain(buf, []string{"abc", "def"})
Expand Down