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

Use Time.AppendFormat when possible #786

Merged
merged 3 commits into from Feb 19, 2020
Merged

Use Time.AppendFormat when possible #786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1942475
Use Time.AppendFormat when possible
prashantv Feb 12, 2020
f88859e
Add documentation about AppendTimeLayout support for encoders
prashantv Feb 13, 2020
ee5afed
CR feedback
prashantv Feb 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 9 additions & 1 deletion buffer/buffer.go
View file
Open in desktop
Expand Up @@ -23,7 +23,10 @@
// package's zero-allocation formatters.
package buffer // import "go.uber.org/zap/buffer"

import "strconv"
import (
"strconv"
"time"
)

const _size = 1024 // by default, create 1 KiB buffers

Expand All @@ -49,6 +52,11 @@ func (b *Buffer) AppendInt(i int64) {
b.bs = strconv.AppendInt(b.bs, i, 10)
}

// AppendTime appends the time formatted using the specified layout.
func (b *Buffer) AppendTime(t time.Time, layout string) {
b.bs = t.AppendFormat(b.bs, layout)
}

// AppendUint appends an unsigned integer to the underlying buffer (assuming
// base 10).
func (b *Buffer) AppendUint(i uint64) {
Expand Down
2 changes: 2 additions & 0 deletions buffer/buffer_test.go
View file
Open in desktop
Expand Up @@ -24,6 +24,7 @@ import (
"bytes"
"strings"
"testing"
"time"

"github.com/stretchr/testify/assert"
)
Expand All @@ -46,6 +47,7 @@ func TestBufferWrites(t *testing.T) {
// Intenationally introduce some floating-point error.
{"AppendFloat32", func() { buf.AppendFloat(float64(float32(3.14)), 32) }, "3.14"},
{"AppendWrite", func() { buf.Write([]byte("foo")) }, "foo"},
{"AppendTime", func() { buf.AppendTime(time.Date(2000, 1, 2, 3, 4, 5, 6, time.UTC), time.RFC3339) }, "2000-01-02T03:04:05Z"},
}

for _, tt := range tests {
Expand Down
28 changes: 25 additions & 3 deletions zapcore/encoder.go
View file
Open in desktop
Expand Up @@ -112,21 +112,43 @@ func EpochNanosTimeEncoder(t time.Time, enc PrimitiveArrayEncoder) {
enc.AppendInt64(t.UnixNano())
}

func encodeTimeLayout(t time.Time, layout string, enc PrimitiveArrayEncoder) {
type appendTimeEncoder interface {
AppendTimeLayout(time.Time, string)
}

if enc, ok := enc.(appendTimeEncoder); ok {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fwiw: it's possible to just use an anonymous duck, ok := val.(interface { quack() }) in cases like this where aliasing the interfaces serves no other purpose

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, although the line looks kind of long and complicated.

However, I moved the interface into the method, since it's not needed outside of this method.

enc.AppendTimeLayout(t, layout)
return
}

enc.AppendString(t.Format(layout))
}

// ISO8601TimeEncoder serializes a time.Time to an ISO8601-formatted string
// with millisecond precision.
//
// If enc supports AppendTimeLayout(t time.Time,layout string), it's used
// instead of appending a pre-formatted string value.
func ISO8601TimeEncoder(t time.Time, enc PrimitiveArrayEncoder) {
enc.AppendString(t.Format("2006-01-02T15:04:05.000Z0700"))
encodeTimeLayout(t, "2006-01-02T15:04:05.000Z0700", enc)
}

// RFC3339TimeEncoder serializes a time.Time to an RFC3339-formatted string.
//
// If enc supports AppendTimeLayout(t time.Time,layout string), it's used
// instead of appending a pre-formatted string value.
func RFC3339TimeEncoder(t time.Time, enc PrimitiveArrayEncoder) {
enc.AppendString(t.Format(time.RFC3339))
encodeTimeLayout(t, time.RFC3339, enc)
}

// RFC3339NanoTimeEncoder serializes a time.Time to an RFC3339-formatted string
// with nanosecond precision.
//
// If enc supports AppendTimeLayout(t time.Time,layout string), it's used
// instead of appending a pre-formatted string value.
func RFC3339NanoTimeEncoder(t time.Time, enc PrimitiveArrayEncoder) {
enc.AppendString(t.Format(time.RFC3339Nano))
encodeTimeLayout(t, time.RFC3339Nano, enc)
}

// UnmarshalText unmarshals text to a TimeEncoder.
Expand Down
6 changes: 6 additions & 0 deletions zapcore/json_encoder.go
View file
Open in desktop
Expand Up @@ -266,6 +266,12 @@ func (enc *jsonEncoder) AppendString(val string) {
enc.buf.AppendByte('"')
}

func (enc *jsonEncoder) AppendTimeLayout(time time.Time, layout string) {
enc.buf.AppendByte('"')
enc.buf.AppendTime(time, layout)
enc.buf.AppendByte('"')
}

func (enc *jsonEncoder) AppendTime(val time.Time) {
cur := enc.buf.Len()
enc.EncodeTime(val, enc)
Expand Down
64 changes: 57 additions & 7 deletions zapcore/json_encoder_impl_test.go
View file
Open in desktop
Expand Up @@ -36,6 +36,11 @@ import (
"go.uber.org/multierr"
)

var _defaultEncoderConfig = EncoderConfig{
EncodeTime: EpochTimeEncoder,
EncodeDuration: SecondsDurationEncoder,
}

func TestJSONClone(t *testing.T) {
// The parent encoder is created with plenty of excess capacity.
parent := &jsonEncoder{buf: bufferpool.Get()}
Expand Down Expand Up @@ -224,7 +229,55 @@ func TestJSONEncoderObjectFields(t *testing.T) {

for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
assertOutput(t, tt.expected, tt.f)
assertOutput(t, _defaultEncoderConfig, tt.expected, tt.f)
})
}
}

func TestJSONEncoderTimeFormats(t *testing.T) {
date := time.Date(2000, time.January, 2, 3, 4, 5, 6, time.UTC)

f := func(e Encoder) {
e.AddTime("k", date)
e.AddArray("a", ArrayMarshalerFunc(func(enc ArrayEncoder) error {
enc.AppendTime(date)
return nil
}))
}
tests := []struct {
desc string
cfg EncoderConfig
expected string
}{
{
desc: "time.Time ISO8601",
cfg: EncoderConfig{
EncodeDuration: NanosDurationEncoder,
EncodeTime: ISO8601TimeEncoder,
},
expected: `"k":"2000-01-02T03:04:05.000Z","a":["2000-01-02T03:04:05.000Z"]`,
},
{
desc: "time.Time RFC3339",
cfg: EncoderConfig{
EncodeDuration: NanosDurationEncoder,
EncodeTime: RFC3339TimeEncoder,
},
expected: `"k":"2000-01-02T03:04:05Z","a":["2000-01-02T03:04:05Z"]`,
},
{
desc: "time.Time RFC3339Nano",
cfg: EncoderConfig{
EncodeDuration: NanosDurationEncoder,
EncodeTime: RFC3339NanoTimeEncoder,
},
expected: `"k":"2000-01-02T03:04:05.000000006Z","a":["2000-01-02T03:04:05.000000006Z"]`,
},
}

for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
assertOutput(t, tt.cfg, tt.expected, f)
})
}
}
Expand Down Expand Up @@ -324,7 +377,7 @@ func TestJSONEncoderArrays(t *testing.T) {
return nil
}))
}
assertOutput(t, `"array":`+tt.expected, func(enc Encoder) {
assertOutput(t, _defaultEncoderConfig, `"array":`+tt.expected, func(enc Encoder) {
err := f(enc)
assert.NoError(t, err, "Unexpected error adding array to JSON encoder.")
})
Expand All @@ -336,11 +389,8 @@ func assertJSON(t *testing.T, expected string, enc *jsonEncoder) {
assert.Equal(t, expected, enc.buf.String(), "Encoded JSON didn't match expectations.")
}

func assertOutput(t testing.TB, expected string, f func(Encoder)) {
enc := &jsonEncoder{buf: bufferpool.Get(), EncoderConfig: &EncoderConfig{
EncodeTime: EpochTimeEncoder,
EncodeDuration: SecondsDurationEncoder,
}}
func assertOutput(t testing.TB, cfg EncoderConfig, expected string, f func(Encoder)) {
enc := &jsonEncoder{buf: bufferpool.Get(), EncoderConfig: &cfg}
f(enc)
assert.Equal(t, expected, enc.buf.String(), "Unexpected encoder output after adding.")

Expand Down