Merge pull request #8 from jsteenb2/chore/err_formatters

feat: update frame/stackframes formatter and add e and joinE formatters

Author: jsteenb2

err_impl.go

@@ -2,6 +2,8 @@ package errors
 
 import (
 	"cmp"
+	"fmt"
+	"io"
 )
 
 func newE(opts ...any) error {
@@ -71,6 +73,18 @@ func (err *e) Error() string {
 	return msg
 }
 
+func (err *e) Format(s fmt.State, verb rune) {
+	switch verb {
+	case 'v':
+		fallthrough
+	case 's':
+		io.WriteString(s, err.Error()+" ")
+		err.stackTrace().Format(s, fmtInline)
+	case 'q':
+		fmt.Fprintf(s, "%q", err.Error())
+	}
+}
+
 // Fields represents the meaningful logging fields from the error. These include
 // all the KVs, error kind, and stack trace for the error and all wrapped error
 // fields. This is an incredibly powerful tool to enhance the logging/observability

errors_stack_traces_test.go

@@ -195,8 +195,8 @@ func Test_Errors(t *testing.T) {
 			),
 			want: wants{
 				msg: `2 errors occurred:
-	* first error
-	* second error
+	* first error [ github.com/jsteenb2/errors/errors_stack_traces_test.go:189[Test_Errors], github.com/jsteenb2/errors/errors_stack_traces_test.go:190[Test_Errors] ]
+	* second error [ github.com/jsteenb2/errors/errors_stack_traces_test.go:192[Test_Errors] ]
 `,
 				fields: []any{
 					"multi_err", []any{
@@ -227,3 +227,39 @@ func Test_Errors(t *testing.T) {
 		})
 	}
 }
+
+func TestE_Format(t *testing.T) {
+	t.Run("e error", func(t *testing.T) {
+		err := errors.Wrap(
+			errors.New("inner msg"),
+			"outter",
+		)
+
+		want := `outter: inner msg [ github.com/jsteenb2/errors/errors_stack_traces_test.go:233[TestE_Format.func1], github.com/jsteenb2/errors/errors_stack_traces_test.go:234[TestE_Format.func1] ]`
+		eq(t, want, fmt.Sprintf("%v", err))
+		eq(t, want, fmt.Sprintf("%s", err))
+
+		want = `"outter: inner msg"`
+		eq(t, want, fmt.Sprintf("%q", err))
+	})
+
+	t.Run("joinE error", func(t *testing.T) {
+		err := errors.Join(
+			errors.New("simple"),
+			errors.Wrap(
+				errors.New("deep"),
+				"outter msg",
+			),
+		)
+
+		want := `2 errors occurred:
+	* simple [ github.com/jsteenb2/errors/errors_stack_traces_test.go:248[TestE_Format.func2] ]
+	* outter msg: deep [ github.com/jsteenb2/errors/errors_stack_traces_test.go:249[TestE_Format.func2], github.com/jsteenb2/errors/errors_stack_traces_test.go:250[TestE_Format.func2] ]
+[ github.com/jsteenb2/errors/errors_stack_traces_test.go:247[TestE_Format.func2] ]`
+		eq(t, want, fmt.Sprintf("%v", err))
+		eq(t, want, fmt.Sprintf("%s", err))
+
+		want = "\"2 errors occurred:\\n\\t* simple [ github.com/jsteenb2/errors/errors_stack_traces_test.go:248[TestE_Format.func2] ]\\n\\t* outter msg: deep [ github.com/jsteenb2/errors/errors_stack_traces_test.go:249[TestE_Format.func2], github.com/jsteenb2/errors/errors_stack_traces_test.go:250[TestE_Format.func2] ]\\n\""
+		eq(t, want, fmt.Sprintf("%q", err))
+	})
+}

frame.go

@@ -9,6 +9,8 @@ import (
 	"strings"
 )
 
+const fmtInline = 'i'
+
 // Frame is a single step in stack trace.
 type Frame struct {
 	FilePath string
@@ -38,18 +40,22 @@ func (f Frame) Format(s fmt.State, verb rune) {
 	case 's':
 		switch {
 		case s.Flag('+'):
-			io.WriteString(s, f.Fn)
-			io.WriteString(s, "\n\t")
-			io.WriteString(s, f.FilePath)
+			io.WriteString(s, f.String())
 		default:
 			io.WriteString(s, path.Base(f.FilePath))
 		}
 	case 'd':
 		io.WriteString(s, strconv.Itoa(f.Line))
 	case 'n':
 		io.WriteString(s, funcname(f.Fn))
+	case fmtInline:
+		io.WriteString(s, f.String())
 	case 'v':
-		f.Format(s, 's')
+		if s.Flag('+') {
+			f.Format(s, 's')
+			return
+		}
+		io.WriteString(s, path.Base(f.FilePath))
 		io.WriteString(s, ":")
 		f.Format(s, 'd')
 	}
@@ -83,10 +89,12 @@ func (f StackFrames) String() string {
 // Format formats the frame according to the fmt.Formatter interface.
 // See Frame.Format for the formatting rules.
 func (f StackFrames) Format(s fmt.State, verb rune) {
+	io.WriteString(s, "[ ")
+	defer func() { io.WriteString(s, " ]") }()
 	for i, frame := range f {
 		frame.Format(s, verb)
 		if i < len(f)-1 {
-			io.WriteString(s, "\n\n")
+			io.WriteString(s, ", ")
 		}
 	}
 }

frame_test.go

@@ -16,38 +16,27 @@ func TestStackTrace_SimpleError(t *testing.T) {
 	eq(t, "[ github.com/jsteenb2/errors/frame_test.go:11[TestStackTrace_SimpleError] ]", frames.String())
 
 	sVal := fmt.Sprintf("%s", frames)
-	eq(t, "frame_test.go", sVal)
+	eq(t, "[ frame_test.go ]", sVal)
 
 	sVal = fmt.Sprintf("%s", frames[0])
 	eq(t, "frame_test.go", sVal)
 
-	wantSPlusVal := `github.com/jsteenb2/errors_test.TestStackTrace_SimpleError
-	github.com/jsteenb2/errors/frame_test.go`
-
-	sPlusVal := fmt.Sprintf("%+s", frames)
-	eq(t, wantSPlusVal, sPlusVal)
+	wantSPlusVal := `github.com/jsteenb2/errors/frame_test.go:11[TestStackTrace_SimpleError]`
 
-	sPlusVal = fmt.Sprintf("%+s", frames[0])
-	eq(t, wantSPlusVal, sPlusVal)
+	eq(t, "[ "+wantSPlusVal+" ]", fmt.Sprintf("%+s", frames))
+	eq(t, wantSPlusVal, fmt.Sprintf("%+s", frames[0]))
 
 	wantLine := "11"
-	dVal := fmt.Sprintf("%d", frames)
-	eq(t, wantLine, dVal)
-	dVal = fmt.Sprintf("%d", frames[0])
-	eq(t, wantLine, dVal)
+	eq(t, "[ "+wantLine+" ]", fmt.Sprintf("%d", frames))
+	eq(t, wantLine, fmt.Sprintf("%d", frames[0]))
 
 	wantFile := "frame_test.go:" + wantLine
-	vVal := fmt.Sprintf("%v", frames)
-	eq(t, wantFile, vVal)
-	vVal = fmt.Sprintf("%v", frames[0])
-	eq(t, wantFile, vVal)
-
-	wantVPlusVal := `github.com/jsteenb2/errors_test.TestStackTrace_SimpleError
-	github.com/jsteenb2/errors/` + wantFile
-	vPlusVal := fmt.Sprintf("%+v", frames)
-	eq(t, wantVPlusVal, vPlusVal)
-	vPlusVal = fmt.Sprintf("%+v", frames[0])
-	eq(t, wantVPlusVal, vPlusVal)
+	eq(t, "[ "+wantFile+" ]", fmt.Sprintf("%v", frames))
+	eq(t, wantFile, fmt.Sprintf("%v", frames[0]))
+
+	wantVPlusVal := `github.com/jsteenb2/errors/` + wantFile + `[TestStackTrace_SimpleError]`
+	eq(t, "[ "+wantVPlusVal+" ]", fmt.Sprintf("%+v", frames))
+	eq(t, wantVPlusVal, fmt.Sprintf("%+v", frames[0]))
 }
 
 func TestStackTrace_WrappedError(t *testing.T) {
@@ -58,39 +47,30 @@ func TestStackTrace_WrappedError(t *testing.T) {
 	frames := errors.StackTrace(err)
 	must(t, eqLen(t, 2, frames))
 
-	wantStr := "[ github.com/jsteenb2/errors/frame_test.go:54[TestStackTrace_WrappedError], github.com/jsteenb2/errors/frame_test.go:55[TestStackTrace_WrappedError] ]"
+	wantStr := "[ github.com/jsteenb2/errors/frame_test.go:43[TestStackTrace_WrappedError], github.com/jsteenb2/errors/frame_test.go:44[TestStackTrace_WrappedError] ]"
 	eq(t, wantStr, frames.String())
 
-	eq(t, "frame_test.go\n\nframe_test.go", fmt.Sprintf("%s", frames))
+	eq(t, "[ frame_test.go, frame_test.go ]", fmt.Sprintf("%s", frames))
 	eq(t, "frame_test.go", fmt.Sprintf("%s", frames[0]))
 	eq(t, "frame_test.go", fmt.Sprintf("%s", frames[1]))
 
-	wantSPlusVal := `github.com/jsteenb2/errors_test.TestStackTrace_WrappedError
-	github.com/jsteenb2/errors/frame_test.go
-
-github.com/jsteenb2/errors_test.TestStackTrace_WrappedError
-	github.com/jsteenb2/errors/frame_test.go`
+	wantSPlusVal := `[ github.com/jsteenb2/errors/frame_test.go:43[TestStackTrace_WrappedError], github.com/jsteenb2/errors/frame_test.go:44[TestStackTrace_WrappedError] ]`
 	eq(t, wantSPlusVal, fmt.Sprintf("%+s", frames))
 
-	wantSPlusVal = `github.com/jsteenb2/errors_test.TestStackTrace_WrappedError
-	github.com/jsteenb2/errors/frame_test.go`
-	eq(t, wantSPlusVal, fmt.Sprintf("%+s", frames[0]))
-	eq(t, wantSPlusVal, fmt.Sprintf("%+s", frames[1]))
-
-	eq(t, "54\n\n55", fmt.Sprintf("%d", frames))
-	eq(t, "54", fmt.Sprintf("%d", frames[0]))
-	eq(t, "55", fmt.Sprintf("%d", frames[1]))
+	eq(t, `github.com/jsteenb2/errors/frame_test.go:43[TestStackTrace_WrappedError]`, fmt.Sprintf("%+s", frames[0]))
+	eq(t, `github.com/jsteenb2/errors/frame_test.go:44[TestStackTrace_WrappedError]`, fmt.Sprintf("%+s", frames[1]))
 
-	wantFile := `frame_test.go:54
+	eq(t, "[ 43, 44 ]", fmt.Sprintf("%d", frames))
+	eq(t, "43", fmt.Sprintf("%d", frames[0]))
+	eq(t, "44", fmt.Sprintf("%d", frames[1]))
 
-frame_test.go:55`
+	wantFile := `[ frame_test.go:43, frame_test.go:44 ]`
 	eq(t, wantFile, fmt.Sprintf("%v", frames))
-	eq(t, "frame_test.go:54", fmt.Sprintf("%v", frames[0]))
-	eq(t, "frame_test.go:55", fmt.Sprintf("%v", frames[1]))
-
-	wantVPlusFrame := `github.com/jsteenb2/errors_test.TestStackTrace_WrappedError
-	github.com/jsteenb2/errors/frame_test.go`
-	eq(t, wantVPlusFrame+":54\n\n"+wantVPlusFrame+":55", fmt.Sprintf("%+v", frames))
-	eq(t, wantVPlusFrame+":54", fmt.Sprintf("%+v", frames[0]))
-	eq(t, wantVPlusFrame+":55", fmt.Sprintf("%+v", frames[1]))
+	eq(t, "frame_test.go:43", fmt.Sprintf("%v", frames[0]))
+	eq(t, "frame_test.go:44", fmt.Sprintf("%v", frames[1]))
+
+	wantVPlusFrame := `[ github.com/jsteenb2/errors/frame_test.go:43[TestStackTrace_WrappedError], github.com/jsteenb2/errors/frame_test.go:44[TestStackTrace_WrappedError] ]`
+	eq(t, wantVPlusFrame, fmt.Sprintf("%+v", frames))
+	eq(t, "github.com/jsteenb2/errors/frame_test.go:43[TestStackTrace_WrappedError]", fmt.Sprintf("%+v", frames[0]))
+	eq(t, "github.com/jsteenb2/errors/frame_test.go:44[TestStackTrace_WrappedError]", fmt.Sprintf("%+v", frames[1]))
 }

join.go

@@ -4,6 +4,7 @@ import (
 	"cmp"
 	"errors"
 	"fmt"
+	"io"
 	"strings"
 )
 
@@ -73,6 +74,18 @@ func (err *joinE) Error() string {
 	return err.formatFn(err.msg, err.errs)
 }
 
+func (err *joinE) Format(s fmt.State, verb rune) {
+	switch verb {
+	case 'v':
+		fallthrough
+	case 's':
+		io.WriteString(s, err.Error())
+		err.stackTrace().Format(s, fmtInline)
+	case 'q':
+		fmt.Fprintf(s, "%q", err.Error())
+	}
+}
+
 func (err *joinE) Fields() []any {
 	var (
 		out  []any

join_test.go

@@ -15,7 +15,10 @@ func TestJoin(t *testing.T) {
 		err := errors.Join(errors.New("first multi error"))
 
 		gotMsg := err.Error()
-		eq(t, "1 error occurred:\n\t* first multi error\n", gotMsg)
+		wantMsg := `1 error occurred:
+	* first multi error [ github.com/jsteenb2/errors/join_test.go:15[TestJoin.func1] ]
+`
+		eq(t, wantMsg, gotMsg)
 
 		unwrappedErr := errors.Unwrap(err)
 		if unwrappedErr == nil {
@@ -33,8 +36,8 @@ func TestJoin(t *testing.T) {
 		)
 
 		wantMsg := `2 errors occurred:
-	* err 1
-	* err 2
+	* err 1 [ github.com/jsteenb2/errors/join_test.go:34[TestJoin.func2] ]
+	* err 2 [ github.com/jsteenb2/errors/join_test.go:35[TestJoin.func2] ]
 `
 		eq(t, wantMsg, err.Error())
 
@@ -58,7 +61,7 @@ func TestJoin(t *testing.T) {
 		)
 
 		wantMsg := `2 errors occurred:
-	* err 1
+	* err 1 [ github.com/jsteenb2/errors/join_test.go:59[TestJoin.func3] ]
 	* sentinel err
 `
 		eq(t, wantMsg, err.Error())
@@ -83,21 +86,21 @@ func TestJoin(t *testing.T) {
 		)
 		wantFields := []any{
 			// parent Join error
-			"kj1", "vj1", "err_kind", "foo", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:75[TestJoin.func4]"},
+			"kj1", "vj1", "err_kind", "foo", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:78[TestJoin.func4]"},
 			// first err
-			"err_0", []any{"ki1", "vi1", "err_kind", "foo", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:76[TestJoin.func4]"}},
+			"err_0", []any{"ki1", "vi1", "err_kind", "foo", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:79[TestJoin.func4]"}},
 			// third err
-			"err_2", []any{"ki3", "vi3", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:78[TestJoin.func4]"}},
+			"err_2", []any{"ki3", "vi3", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:81[TestJoin.func4]"}},
 			// fourth err
 			"err_3", []any{
-				"stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:79[TestJoin.func4]"},
-				"err_0", []any{"stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:80[TestJoin.func4]"}},
+				"stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:82[TestJoin.func4]"},
+				"err_0", []any{"stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:83[TestJoin.func4]"}},
 			},
 		}
 		eqFields(t, wantFields, errors.Fields(err))
 
 		unwrapped := errors.Unwrap(err)
-		wantFields = []any{"ki1", "vi1", "err_kind", "foo", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:76[TestJoin.func4]"}}
+		wantFields = []any{"ki1", "vi1", "err_kind", "foo", "stack_trace", []string{"github.com/jsteenb2/errors/join_test.go:79[TestJoin.func4]"}}
 		eqFields(t, wantFields, errors.Fields(unwrapped))
 
 		sentinelUnwrapped := errors.Unwrap(unwrapped)