Skip to content

Commit 3f6e84d

Browse files
billfakshayjshah
authored andcommitted
Export field.AddTo() to support wrappers (uber-go#82)
1 parent fd612f8 commit 3f6e84d

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

field.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,8 @@ func Nest(key string, fields ...Field) Field {
148148
return Field{key: key, fieldType: marshalerType, obj: multiFields(fields)}
149149
}
150150

151-
func (f Field) addTo(kv KeyValue) error {
151+
// AddTo exports a field through the KeyValue interface.
152+
func (f Field) AddTo(kv KeyValue) error {
152153
switch f.fieldType {
153154
case boolType:
154155
kv.AddBool(f.key, f.ival == 1)
@@ -181,7 +182,7 @@ func (fs multiFields) MarshalLog(kv KeyValue) error {
181182
func addFields(kv KeyValue, fields []Field) error {
182183
var errs multiError
183184
for _, f := range fields {
184-
if err := f.addTo(kv); err != nil {
185+
if err := f.AddTo(kv); err != nil {
185186
errs = append(errs, err)
186187
}
187188
}

field_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func assertFieldJSON(t testing.TB, expected string, field Field) {
4646
enc := newJSONEncoder()
4747
defer enc.Free()
4848

49-
field.addTo(enc)
49+
field.AddTo(enc)
5050
assert.Equal(t, expected, string(enc.bytes),
5151
"Unexpected JSON output after applying field %+v.", field)
5252
}
@@ -55,7 +55,7 @@ func assertNotEqualFieldJSON(t testing.TB, expected string, field Field) {
5555
enc := newJSONEncoder()
5656
defer enc.Free()
5757

58-
field.addTo(enc)
58+
field.AddTo(enc)
5959
assert.NotEqual(t, expected, string(enc.bytes),
6060
"Unexpected JSON output after applying field %+v.", field)
6161
}
@@ -73,7 +73,7 @@ func assertCanBeReused(t testing.TB, field Field) {
7373
go func() {
7474
defer wg.Done()
7575
assert.NotPanics(t, func() {
76-
field.addTo(enc)
76+
field.AddTo(enc)
7777
}, "Reusing a field should not cause issues")
7878
}()
7979
}
@@ -167,7 +167,7 @@ func TestStackField(t *testing.T) {
167167
enc := newJSONEncoder()
168168
defer enc.Free()
169169

170-
Stack().addTo(enc)
170+
Stack().AddTo(enc)
171171
output := string(enc.bytes)
172172

173173
require.True(t, strings.HasPrefix(output, `"stacktrace":`), "Stacktrace added under an unexpected key.")
@@ -180,6 +180,6 @@ func TestUnknownField(t *testing.T) {
180180

181181
for _, ft := range []fieldType{unknownType, -42} {
182182
field := Field{fieldType: ft}
183-
assert.Panics(t, func() { field.addTo(enc) }, "Expected panic when using a field of unknown type.")
183+
assert.Panics(t, func() { field.AddTo(enc) }, "Expected panic when using a field of unknown type.")
184184
}
185185
}

hook.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func AddCaller() Option {
7272
func AddStacks(lvl Level) Option {
7373
return hook(func(msgLevel Level, msg string, kv KeyValue) (string, error) {
7474
if msgLevel >= lvl {
75-
Stack().addTo(kv)
75+
Stack().AddTo(kv)
7676
}
7777
return msg, nil
7878
})

0 commit comments

Comments
 (0)