Merge pull request #15 from cdr/refactor

Refactor Sink and move all loggers to subpkgs

Author: nhooyr

README.md

@@ -20,7 +20,7 @@ go get go.coder.com/slog
 - First class [context.Context](https://blog.golang.org/context) support
 - Beautiful logging output by default
 - Multiple adapters
-- First class [\*testing.T](https://godoc.org/go.coder.com/slog/testlog) support
+- First class [\*testing.T](https://godoc.org/go.coder.com/slog/slogtest) support
 
 ## Example
 

ci/.codecov.yml

@@ -1,4 +1,4 @@
-comment: off
+.comment: off
 coverage:
   status:
     # Prevent small changes in coverage from failing CI.

ci/test.sh

@@ -11,6 +11,7 @@ argv=(
   "--format=short-verbose"
   --
   "-vet=off"
+  "./..."
 )
 # Interactive usage does not want to turn off vet or use gotestsum.
 if [[ $# -gt 0 ]]; then

examples_test.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"go.coder.com/slog"
-	"go.coder.com/slog/slogtest"
+	"go.coder.com/slog/sloggers/slogtest"
 )
 
 func Example_test() {

fields.go

@@ -2,15 +2,18 @@ package humanfmt
 
 import (
 	"fmt"
+	"io"
 	"path/filepath"
 
 	"github.com/fatih/color"
 	"go.opencensus.io/trace"
+	"golang.org/x/crypto/ssh/terminal"
 
-	"go.coder.com/slog/slogcore"
+	"go.coder.com/slog"
+	"go.coder.com/slog/slogval"
 )
 
-func Entry(ent slogcore.Entry, enableColor bool) string {
+func Entry(ent slog.Entry, enableColor bool) string {
 	var ents string
 	if ent.File != "" {
 		ents += fmt.Sprintf("%v:%v: ", filepath.Base(ent.File), ent.Line)
@@ -21,7 +24,7 @@ func Entry(ent slogcore.Entry, enableColor bool) string {
 		cl := levelColor(ent.Level)
 		ents += color.New(cl).Sprint(ent.Level)
 	} else {
-		ents += string(ent.Level)
+		ents += ent.Level.String()
 	}
 
 	ents += "]"
@@ -45,20 +48,20 @@ func Entry(ent slogcore.Entry, enableColor bool) string {
 	return ents
 }
 
-func pinnedFields(ent slogcore.Entry) string {
-	pinned := slogcore.Map{}
+func pinnedFields(ent slog.Entry) string {
+	pinned := slogval.Map{}
 
 	if ent.SpanContext != (trace.SpanContext{}) {
-		pinned = pinned.Append("trace", slogcore.String(ent.SpanContext.TraceID.String()))
-		pinned = pinned.Append("span", slogcore.String(ent.SpanContext.SpanID.String()))
+		pinned = pinned.Append("trace", slogval.String(ent.SpanContext.TraceID.String()))
+		pinned = pinned.Append("span", slogval.String(ent.SpanContext.SpanID.String()))
 	}
 
-	return Fields(pinned)
+	return humanFields(pinned)
 }
 
-func stringFields(ent slogcore.Entry) string {
+func stringFields(ent slog.Entry) string {
 	pinned := pinnedFields(ent)
-	fields := Fields(ent.Fields)
+	fields := humanFields(slogval.Reflect(ent.Fields))
 
 	if pinned == "" {
 		return fields
@@ -74,20 +77,21 @@ func stringFields(ent slogcore.Entry) string {
 // Same as time.StampMilli but the days in the month padded by zeros.
 const timestampMilli = "Jan 02 15:04:05.000"
 
-func panicf(f string, v ...interface{}) {
-	f = "humanfmt: " + f
-	s := fmt.Sprintf(f, v...)
-	panic(s)
-}
-
-func levelColor(level slogcore.Level) color.Attribute {
+func levelColor(level slog.Level) color.Attribute {
 	switch level {
-	case slogcore.Debug, slogcore.Info:
+	case slog.Debug, slog.Info:
 		return color.FgBlue
-	case slogcore.Warn:
+	case slog.Warn:
 		return color.FgYellow
-	case slogcore.Error, slogcore.Critical, slogcore.Fatal:
+	case slog.LevelError, slog.Critical, slog.Fatal:
 		return color.FgRed
 	}
 	panic("humanfmt: unexpected level: " + string(level))
 }
+
+func IsTTY(w io.Writer) bool {
+	f, ok := w.(interface {
+		Fd() uintptr
+	})
+	return ok && terminal.IsTerminal(int(f.Fd()))
+}

internal/humanfmt/humanfmt.go

@@ -1,10 +1,11 @@
 package humanfmt
 
 import (
+	"fmt"
 	"strconv"
 	"strings"
 
-	"go.coder.com/slog/slogcore"
+	"go.coder.com/slog/slogval"
 )
 
 // consoleMarshaller marshals a fieldValue into a human readable format.
@@ -13,7 +14,7 @@ type consoleMarshaller struct {
 	indentstr string
 }
 
-func Fields(m slogcore.Map) string {
+func humanFields(m slogval.Map) string {
 	var y consoleMarshaller
 	y.marshal(m)
 	return y.out.String()
@@ -43,23 +44,23 @@ func (y *consoleMarshaller) unindent() {
 	y.indentstr = y.indentstr[:len(y.indentstr)-2]
 }
 
-func (y *consoleMarshaller) marshal(v slogcore.Value) {
+func (y *consoleMarshaller) marshal(v slogval.Value) {
 	switch v := v.(type) {
-	case slogcore.String:
+	case slogval.String:
 		// Ensures indentation.
 		y.indent()
 		// Replaces every newline with a newline plus the correct indentation.
 		y.s(strings.ReplaceAll(string(v), "\n", "\n"+y.indentstr))
 		y.unindent()
-	case slogcore.Bool:
+	case slogval.Bool:
 		y.s(strconv.FormatBool(bool(v)))
-	case slogcore.Float:
+	case slogval.Float:
 		y.s(strconv.FormatFloat(float64(v), 'f', -1, 64))
-	case slogcore.Int:
+	case slogval.Int:
 		y.s(strconv.FormatInt(int64(v), 10))
-	case slogcore.Uint:
+	case slogval.Uint:
 		y.s(strconv.FormatUint(uint64(v), 10))
-	case slogcore.Map:
+	case slogval.Map:
 		for i, f := range v {
 			if i > 0 {
 				// Add newline before every field except first.
@@ -70,13 +71,13 @@ func (y *consoleMarshaller) marshal(v slogcore.Value) {
 
 			y.marshalSub(f.Value, true)
 		}
-	case slogcore.List:
+	case slogval.List:
 		y.indent()
 		for _, v := range v {
 			y.line()
 			y.s("-")
 
-			if _, ok := v.(slogcore.List); !ok {
+			if _, ok := v.(slogval.List); !ok {
 				// Non list values begin with the -.
 				y.s(" ")
 			}
@@ -90,9 +91,9 @@ func (y *consoleMarshaller) marshal(v slogcore.Value) {
 	}
 }
 
-func (y *consoleMarshaller) marshalSub(v slogcore.Value, isParentMap bool) {
+func (y *consoleMarshaller) marshalSub(v slogval.Value, isParentMap bool) {
 	switch v := v.(type) {
-	case slogcore.Map:
+	case slogval.Map:
 		if isParentMap && len(v) == 0 {
 			// Nothing to output for this field. Without this line, we get additional newlines due to below code as
 			// the map field is expected to start on the next line given it is in a parentMap.
@@ -108,7 +109,7 @@ func (y *consoleMarshaller) marshalSub(v slogcore.Value, isParentMap bool) {
 			// it with the `-` of the list.
 			y.line()
 		}
-	case slogcore.List:
+	case slogval.List:
 	default:
 		if isParentMap {
 			// Non map and non list values in structs begin on the same line with a space between the key and value.
@@ -118,7 +119,7 @@ func (y *consoleMarshaller) marshalSub(v slogcore.Value, isParentMap bool) {
 
 	y.marshal(v)
 
-	if _, ok := v.(slogcore.Map); ok {
+	if _, ok := v.(slogval.Map); ok {
 		y.unindent()
 	}
 }
@@ -144,3 +145,9 @@ func quote(key string) string {
 	}
 	return quoted
 }
+
+func panicf(f string, v ...interface{}) {
+	f = "humanfmt: " + f
+	s := fmt.Sprintf(f, v...)
+	panic(s)
+}

internal/humanfmt/marshal.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"go.coder.com/slog/internal/diff"
-	"go.coder.com/slog/slogcore"
+	"go.coder.com/slog/slogval"
 )
 
 func Test_marshalFields(t *testing.T) {
@@ -116,8 +116,8 @@ dsamkld`,
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()
 
-			v := slogcore.Reflect(tc.in)
-			actOut := Fields(v.(slogcore.Map))
+			v := slogval.ReflectUnsafe(tc.in)
+			actOut := humanFields(v.(slogval.Map))
 			t.Logf("yaml:\n%v", actOut)
 			if diff := diff.Diff(tc.out, actOut); diff != "" {
 				t.Fatalf("unexpected output: %v", diff)

internal/humanfmt/marshal_test.go

@@ -0,0 +1,19 @@
+package stdlibctx
+
+import (
+	"context"
+)
+
+type stdlibKey struct{}
+
+// With appends to the skip offset in the context and returns
+// a new context with the new skip offset.
+func With(ctx context.Context) context.Context {
+	return context.WithValue(ctx, stdlibKey{}, true)
+}
+
+// From returns the skip offset.
+func From(ctx context.Context) bool {
+	b, _ := ctx.Value(stdlibKey{}).(bool)
+	return b
+}