First pass at the ctxlog package

Author: Elliot Forbes

README.md

@@ -0,0 +1,15 @@
+ctx-logger
+===========
+
+
+```go
+ctx := context.Background()
+		log := ctxlog.New(
+			ctxlog.WithJSONFormat(),
+		)
+		ctx = ctxlog.WithFields(ctx, ctxlog.Fields{
+			"trace_id": "my-trace-id",
+		})
+
+		log.Info(ctx, "hello world")
+```

Taskfile.yml

@@ -0,0 +1,6 @@
+version: '3'
+
+tasks:
+  test:
+    cmds:
+      - go test ./... -v

error.go

@@ -0,0 +1,8 @@
+package ctxlog
+
+import "context"
+
+func (l *CtxLogger) Error(ctx context.Context, msg string) {
+	fields := convertFieldsToLogrusFields(getFields(ctx))
+	l.Log.WithFields(fields).Error(msg)
+}

error_test.go

@@ -0,0 +1,19 @@
+package ctxlog_test
+
+import (
+	"context"
+	"github.com/TutorialEdge/ctxlog"
+	"testing"
+)
+
+func TestErrorLogs(t *testing.T) {
+	t.Run("test error log output", func(t *testing.T) {
+		ctx := context.Background()
+		log := ctxlog.New()
+		ctx = ctxlog.WithFields(ctx, ctxlog.Fields{
+			"trace_id": "my-trace-id",
+		})
+
+		log.Error(ctx, "some error message")
+	})
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/TutorialEdge/ctxlog
+
+go 1.18
+
+require (
+	github.com/sirupsen/logrus v1.9.0 // indirect
+	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
+)

go.sum

@@ -0,0 +1,11 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
+github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

info.go

@@ -0,0 +1,10 @@
+package ctxlog
+
+import (
+	"context"
+)
+
+func (l *CtxLogger) Info(ctx context.Context, msg string) {
+	fields := convertFieldsToLogrusFields(getFields(ctx))
+	l.Log.WithFields(fields).Info(msg)
+}

info_test.go

@@ -0,0 +1 @@
+package ctxlog_test

logger.go

@@ -0,0 +1,65 @@
+package ctxlog
+
+import (
+	"context"
+
+	"github.com/sirupsen/logrus"
+)
+
+type fieldsKey struct{}
+
+type Fields map[string]any
+
+type CtxLogger struct {
+	Fields Fields
+	Log    *logrus.Logger
+}
+
+func New(options ...func(*CtxLogger)) *CtxLogger {
+	log := &CtxLogger{
+		Log: logrus.New(),
+	}
+
+	for _, o := range options {
+		o(log)
+	}
+
+	return log
+}
+
+func WithJSONFormat() func(*CtxLogger) {
+	return func(l *CtxLogger) {
+		l.Log.SetFormatter(&logrus.JSONFormatter{})
+	}
+}
+
+func getFields(ctx context.Context) Fields {
+	if val, ok := ctx.Value(fieldsKey{}).(Fields); ok {
+		return val
+	}
+	return Fields{}
+}
+
+func WithFields(ctx context.Context, newFields ...Fields) context.Context {
+	fields := Fields{}
+
+	for k, v := range getFields(ctx) {
+		fields[k] = v
+	}
+
+	for _, fieldMap := range newFields {
+		for k, v := range fieldMap {
+			fields[k] = v
+		}
+	}
+
+	return context.WithValue(ctx, fieldsKey{}, fields)
+}
+
+func convertFieldsToLogrusFields(fields Fields) logrus.Fields {
+	logrusFields := make(logrus.Fields)
+	for k, v := range fields {
+		logrusFields[k] = v
+	}
+	return logrusFields
+}

logger_test.go

@@ -0,0 +1,32 @@
+package ctxlog_test
+
+import (
+	"context"
+	"github.com/TutorialEdge/ctxlog"
+	"testing"
+)
+
+func TestLogger(t *testing.T) {
+	t.Run("test logger instantiates properly", func(t *testing.T) {
+		ctx := context.Background()
+		log := ctxlog.New()
+		ctx = ctxlog.WithFields(ctx, ctxlog.Fields{
+			"trace_id": "my-trace-id",
+		})
+
+		log.Info(ctx, "hello world")
+	})
+
+	t.Run("test logger WithJSONFormat", func(t *testing.T) {
+		ctx := context.Background()
+		log := ctxlog.New(
+			ctxlog.WithJSONFormat(),
+		)
+		ctx = ctxlog.WithFields(ctx, ctxlog.Fields{
+			"trace_id": "my-trace-id",
+		})
+
+		log.Info(ctx, "hello world")
+		log.Info(ctx, "something else")
+	})
+}