fix: colorJson working

Author: nmccready

debug.go

@@ -15,18 +15,19 @@ import (
 )
 
 var (
-	writer     io.Writer = os.Stderr
-	reg        *regexp.Regexp
-	neg        []*regexp.Regexp
-	m          sync.Mutex
-	enabled    = false
-	cache      *goCache.Cache
-	HAS_COLORS           = true
-	HAS_TIME             = true
-	formatter  Formatter = &TextFormatter{HasColor: true}
-	negRegEx             = regexp.MustCompile(`^-.*?`)
-	textRegex            = regexp.MustCompile(`(?i)text`)
-	jsonRegex            = regexp.MustCompile(`(?i)json`)
+	writer           io.Writer = os.Stderr
+	reg              *regexp.Regexp
+	neg              []*regexp.Regexp
+	m                sync.Mutex
+	enabled          = false
+	cache            *goCache.Cache
+	HAS_COLORS                 = true
+	HAS_TIME                   = true
+	defaultFormatter           = &TextFormatter{HasColor: true}
+	formatter        Formatter = defaultFormatter
+	negRegEx                   = regexp.MustCompile(`^-.*?`)
+	textRegex                  = regexp.MustCompile(`(?i)text`)
+	jsonRegex                  = regexp.MustCompile(`(?i)json`)
 )
 
 type Fields map[string]interface{}
@@ -92,6 +93,9 @@ func Disable() {
 }
 
 func SetFormatter(f Formatter) {
+	if f == nil {
+		f = defaultFormatter
+	}
 	m.Lock()
 	defer m.Unlock()
 	formatter = f
@@ -105,7 +109,11 @@ func SetFormatterString(s string) {
 
 	if jsonRegex.MatchString(s) {
 		// default to PRETTY true
-		_f = &JSONFormatter{PrettyPrint: os.Getenv("DEBUG_FORMATTER_PRETTY_OFF") == ""}
+		j := JSONFormatter{PrettyPrint: os.Getenv("DEBUG_FORMATTER_PRETTY_OFF") == ""}
+		if j.PrettyPrint && j.Indent == 0 {
+			j.Indent = 2
+		}
+		_f = &j
 	}
 
 	SetFormatter(_f)

debug_bench_test.go

@@ -21,6 +21,30 @@ func BenchmarkMatch(b *testing.B) {
 	}
 }
 
+func BenchmarkMatchJson(b *testing.B) {
+	SetFormatter(&JSONFormatter{})
+	SetHasColors(false)
+	debug := Debug("something")
+	Enable("something")
+	for i := 0; i < b.N; i++ {
+		debug.Log("stuff")
+	}
+	SetFormatter(nil)
+	SetHasColors(true)
+}
+
+func BenchmarkMatchWithFields(b *testing.B) {
+	debug := Debug("something")
+	Enable("something")
+	debug.WithFields(map[string]interface{}{
+		"a": "one",
+		"b": "two",
+	})
+	for i := 0; i < b.N; i++ {
+		debug.Log("stuff")
+	}
+}
+
 func BenchmarkMatchError(b *testing.B) {
 	debug := Debug("something")
 	Enable("error*")

debug_test.go

@@ -342,6 +342,5 @@ func TestBuildPattern(t *testing.T) {
 			ar := *actualNegs[i]
 			assert.Equal(t, er, ar, "pattern matches")
 		}
-
 	}
 }

go.mod

@@ -3,8 +3,8 @@ module github.com/nmccready/go-debug
 go 1.14
 
 require (
-	github.com/TylerBrock/colorjson v0.0.0-20200706003622-8a50f05110d2
-	github.com/fatih/color v1.9.0 // indirect
+	github.com/fatih/color v1.9.0
+	github.com/nmccready/colorjson v0.0.4
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/stretchr/testify v1.6.1
 )

go.sum

@@ -1,14 +1,16 @@
-github.com/TylerBrock/colorjson v0.0.0-20200706003622-8a50f05110d2 h1:ZBbLwSJqkHBuFDA6DUhhse0IGJ7T5bemHyNILUjvOq4=
-github.com/TylerBrock/colorjson v0.0.0-20200706003622-8a50f05110d2/go.mod h1:VSw57q4QFiWDbRnjdX8Cb3Ow0SFncRw+bA/ofY6Q83w=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
 github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
+github.com/hokaccha/go-prettyjson v0.0.0-20190818114111-108c894c2c0e h1:0aewS5NTyxftZHSnFaJmWE5oCCrj4DyEXkAiMa1iZJM=
+github.com/hokaccha/go-prettyjson v0.0.0-20190818114111-108c894c2c0e/go.mod h1:pFlLw2CfqZiIBOx6BuCeRLCrfxBJipTY0nIOF/VbGcI=
 github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
 github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM=
 github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
+github.com/nmccready/colorjson v0.0.4 h1:g+oCvz7hw20bKIeCrR8eju4XXRcku2y+tY6N6R5luHQ=
+github.com/nmccready/colorjson v0.0.4/go.mod h1:n65NtVgGymxWEJz0pX5HHBJIM4GW/wHvkMUG4l83u5o=
 github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
 github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -19,6 +21,7 @@ github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 h1:YyJpGZS1sBuBCzLAR1VEpK193GlqGZbnPFnPV/5Rsb4=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

json_formatter.go

@@ -5,8 +5,8 @@ import (
 	"runtime"
 	"strconv"
 
-	"github.com/TylerBrock/colorjson"
 	"github.com/fatih/color"
+	"github.com/nmccready/colorjson"
 )
 
 // JSONFormatter formats logs into parsable json
@@ -20,6 +20,7 @@ type JSONFormatter struct {
 	// HTMLEscape allows disabling html escaping in output
 	HTMLEscape bool
 
+	Indent int
 	// FieldMap allows users to customize the names of keys for default fields.
 	// As an example:
 	// formatter := &JSONFormatter{
@@ -52,29 +53,13 @@ func (f *JSONFormatter) Format(dbg *Debugger, msg string) string {
 				"time": "20:53:24.798"
 			}
 	*/
-	finalized := finalizeFields(dbg, msg, false, func(k string, v interface{}) interface{} {
-		switch v := v.(type) {
-		case error:
-			// Otherwise errors are ignored by `encoding/json`
-			// https://github.com/sirupsen/logrus/issues/137
-			return v.Error()
-		default:
-			return nil
-		}
-	})
+	finalized := finalizeFields(dbg, msg, false, nil)
 
-	// b := &bytes.Buffer{}
-
-	// encoder := json.NewEncoder(b)
-	// encoder.SetEscapeHTML(!f.DisableHTMLEscape)
-	// if f.PrettyPrint {
-	// 	encoder.SetIndent("", "  ")
-	// }
-	// err := encoder.Encode(finalized.Fields)
 	_f := colorjson.NewFormatter()
 	_f.DisabledColor = !HAS_COLORS
 	_f.HTMLEscape = f.HTMLEscape
-	_f.Indent = 2
+	_f.Indent = f.Indent
+
 	intColor, _ := strconv.Atoi(dbg.color)
 	_f.KeyMapColors["namespace"] = color.New(color.Attribute(intColor))
 	b, err := _f.Marshal(map[string]interface{}(finalized.Fields))

json_formatter_test.go

@@ -10,6 +10,7 @@ import (
 )
 
 func TestErrorNotLost(t *testing.T) {
+	SetHasColors(false)
 	SetFormatter(&JSONFormatter{})
 
 	s := formatter.Format(Debug("error_not_lost").WithField("error", errors.New("wild walrus")), "hi")
@@ -27,6 +28,7 @@ func TestErrorNotLost(t *testing.T) {
 }
 
 func TestErrorNotLostOnFieldNotNamedError(t *testing.T) {
+	SetHasColors(false)
 	SetFormatter(&JSONFormatter{})
 
 	s := formatter.Format(Debug("mapped_field_error").WithField("omg", errors.New("wild walrus")), "hi")
@@ -44,6 +46,7 @@ func TestErrorNotLostOnFieldNotNamedError(t *testing.T) {
 }
 
 func TestFieldClashWithTime(t *testing.T) {
+	SetHasColors(false)
 	SetFormatter(&JSONFormatter{})
 
 	s := formatter.Format(Debug("clash_time").WithField("time", "right now!"), "hi")
@@ -60,6 +63,7 @@ func TestFieldClashWithTime(t *testing.T) {
 }
 
 func TestFieldClashWithMsg(t *testing.T) {
+	SetHasColors(false)
 	SetFormatter(&JSONFormatter{})
 
 	s := formatter.Format(Debug("clash_msg").WithField("msg", errors.New("wild walrus")), "hi")
@@ -72,6 +76,7 @@ func TestFieldClashWithMsg(t *testing.T) {
 }
 
 func TestFieldClashWithNamespace(t *testing.T) {
+	SetHasColors(false)
 	SetFormatter(&JSONFormatter{})
 
 	s := formatter.Format(Debug("clash_namespace").WithField("namespace", errors.New("wild walrus")), "hi")
@@ -97,6 +102,7 @@ func TestJSONEntryEndsWithNewline(t *testing.T) {
 
 func TestJSONPretty(t *testing.T) {
 	HAS_TIME = false
+	SetHasColors(false)
 	SetFormatter(&JSONFormatter{PrettyPrint: true})
 
 	s := formatter.Format(Debug("pretty").WithField("dog", "wild walrus"), "hi")