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

Less verbose output for multierr #470

Merged
merged 2 commits into from
Jul 7, 2017
Merged

Less verbose output for multierr #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8df53e
Less verbose output for multierr
Jul 6, 2017
fa33d3b
Use type switch
Jul 7, 2017
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
18 changes: 5 additions & 13 deletions zapcore/error.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,25 +46,17 @@ func encodeError(key string, err error, enc ObjectEncoder) error {
basic := err.Error()
enc.AddString(key, basic)

if fancy, ok := err.(fmt.Formatter); ok {
verbose := fmt.Sprintf("%+v", fancy)
switch e := err.(type) {
case errorGroup:
return enc.AddArray(key+"Causes", errArray(e.Errors()))
case fmt.Formatter:
verbose := fmt.Sprintf("%+v", e)
if verbose != basic {
// This is a rich error type, like those produced by
// github.com/pkg/errors.
enc.AddString(key+"Verbose", verbose)
}
}

switch e := err.(type) {
case errorGroup:
return enc.AddArray(key+"Causes", errArray(e.Errors()))
case causer:
el := newErrArrayElem(e.Cause())
err := enc.AddArray(key+"Causes", el)
el.Free()
return err
}

return nil
}

Expand Down
56 changes: 3 additions & 53 deletions zapcore/error_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import (

richErrors "github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"go.uber.org/multierr"
. "go.uber.org/zap/zapcore"
Expand Down Expand Up @@ -88,10 +87,6 @@ func TestErrorEncoding(t *testing.T) {
),
want: map[string]interface{}{
"err": "foo; bar; baz",
"errVerbose": "the following errors occurred:\n" +
" - foo\n" +
" - bar\n" +
" - baz",
"errCauses": []interface{}{
map[string]interface{}{"error": "foo"},
map[string]interface{}{"error": "bar"},
Expand All @@ -108,9 +103,6 @@ func TestErrorEncoding(t *testing.T) {
map[string]interface{}{"error": "foo"},
map[string]interface{}{
"error": "bar; baz",
"errorVerbose": "the following errors occurred:\n" +
" - bar\n" +
" - baz",
"errorCauses": []interface{}{
map[string]interface{}{"error": "bar"},
map[string]interface{}{"error": "baz"},
Expand All @@ -123,14 +115,8 @@ func TestErrorEncoding(t *testing.T) {
k: "k",
iface: richErrors.WithMessage(errors.New("egad"), "failed"),
want: map[string]interface{}{
"k": "failed: egad",
"kVerbose": "egad\n" +
"failed",
"kCauses": []interface{}{
map[string]interface{}{
"error": "egad",
},
},
"k": "failed: egad",
"kVerbose": "egad\nfailed",
},
},
{
Expand All @@ -145,42 +131,16 @@ func TestErrorEncoding(t *testing.T) {
),
want: map[string]interface{}{
"error": "hello: foo; bar; baz; world: qux",
"errorVerbose": "the following errors occurred:\n" +
" - the following errors occurred:\n" +
" - foo\n" +
" - bar\n" +
" hello\n" +
" - baz\n" +
" - qux\n" +
" world",
"errorCauses": []interface{}{
map[string]interface{}{
"error": "hello: foo; bar",
"errorVerbose": "the following errors occurred:\n" +
" - foo\n" +
" - bar\n" +
"hello",
"errorCauses": []interface{}{
map[string]interface{}{
"error": "foo; bar",
"errorVerbose": "the following errors occurred:\n" +
" - foo\n" +
" - bar",
"errorCauses": []interface{}{
map[string]interface{}{"error": "foo"},
map[string]interface{}{"error": "bar"},
},
},
},
},
map[string]interface{}{"error": "baz"},
map[string]interface{}{
"error": "world: qux",
"errorVerbose": "qux\nworld",
"errorCauses": []interface{}{
map[string]interface{}{"error": "qux"},
},
},
map[string]interface{}{"error": "world: qux", "errorVerbose": "qux\nworld"},
},
},
},
Expand Down Expand Up @@ -214,14 +174,4 @@ func TestRichErrorSupport(t *testing.T) {
assert.Regexp(t, `egad`, serialized, "Expected original error message to be present.")
assert.Regexp(t, `failed`, serialized, "Expected error annotation to be present.")
assert.Regexp(t, `TestRichErrorSupport`, serialized, "Expected calling function to be present in stacktrace.")

arr, ok := enc.Fields["kCauses"].([]interface{})
require.True(t, ok, "Expected causes array to be present")
require.Len(t, arr, 1, "Expected a single cause")

cause, ok := arr[0].(map[string]interface{})
require.True(t, ok, "Expected cause object")
assert.Equal(t, "egad", cause["error"], "Expected error message to match")
assert.Regexp(t, `egad`, cause["errorVerbose"], "Expected verbose message to match")
assert.Regexp(t, `TestRichErrorSupport`, cause["errorVerbose"], "Expected verbose message to match")
}