Merge pull request #56 from ThreeDotsLabs/added-decorators

Added decorators

Author: roblaszczak

docker/app-prod/Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.17
+FROM golang:1.18
 
 ARG SERVICE
 

docker/app/Dockerfile

@@ -1,6 +1,6 @@
-FROM golang:1.17
+FROM golang:1.18
 
-RUN go get github.com/cespare/reflex
+RUN go install github.com/cespare/reflex@v0.3.1
 COPY reflex.conf /
 
 COPY start.sh /

docker/web/start.sh

@@ -1,4 +1,4 @@
-set -e
+set -ex
 
-npm install
+yarn install
 yarn serve

internal/common/decorator/command.go

@@ -0,0 +1,27 @@
+package decorator
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/sirupsen/logrus"
+)
+
+func ApplyCommandDecorators[H any](handler CommandHandler[H], logger *logrus.Entry, metricsClient MetricsClient) CommandHandler[H] {
+	return commandLoggingDecorator[H]{
+		base: commandMetricsDecorator[H]{
+			base:   handler,
+			client: metricsClient,
+		},
+		logger: logger,
+	}
+}
+
+type CommandHandler[C any] interface {
+	Handle(ctx context.Context, cmd C) error
+}
+
+func generateActionName(handler any) string {
+	return strings.Split(fmt.Sprintf("%T", handler), ".")[1]
+}

internal/common/decorator/logging.go

@@ -0,0 +1,56 @@
+package decorator
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/sirupsen/logrus"
+)
+
+type commandLoggingDecorator[C any] struct {
+	base   CommandHandler[C]
+	logger *logrus.Entry
+}
+
+func (d commandLoggingDecorator[C]) Handle(ctx context.Context, cmd C) (err error) {
+	handlerType := generateActionName(cmd)
+
+	logger := d.logger.WithFields(logrus.Fields{
+		"command":      handlerType,
+		"command_body": fmt.Sprintf("%#v", cmd),
+	})
+
+	logger.Debug("Executing command")
+	defer func() {
+		if err == nil {
+			logger.Info("Command executed successfully")
+		} else {
+			logger.WithError(err).Error("Failed to execute command")
+		}
+	}()
+
+	return d.base.Handle(ctx, cmd)
+}
+
+type queryLoggingDecorator[C any, R any] struct {
+	base   QueryHandler[C, R]
+	logger *logrus.Entry
+}
+
+func (d queryLoggingDecorator[C, R]) Handle(ctx context.Context, cmd C) (result R, err error) {
+	logger := d.logger.WithFields(logrus.Fields{
+		"query":      generateActionName(cmd),
+		"query_body": fmt.Sprintf("%#v", cmd),
+	})
+
+	logger.Debug("Executing query")
+	defer func() {
+		if err == nil {
+			logger.Info("Query executed successfully")
+		} else {
+			logger.WithError(err).Error("Failed to execute query")
+		}
+	}()
+
+	return d.base.Handle(ctx, cmd)
+}

internal/common/decorator/metrics.go

@@ -0,0 +1,62 @@
+package decorator
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"time"
+)
+
+type MetricsClient interface {
+	Inc(key string, value int)
+}
+
+type commandMetricsDecorator[C any] struct {
+	base   CommandHandler[C]
+	client MetricsClient
+}
+
+func (d commandMetricsDecorator[C]) Handle(ctx context.Context, cmd C) (err error) {
+	start := time.Now()
+
+	actionName := strings.ToLower(generateActionName(cmd))
+
+	defer func() {
+		end := time.Since(start)
+
+		d.client.Inc(fmt.Sprintf("commands.%s.duration", actionName), int(end.Seconds()))
+
+		if err == nil {
+			d.client.Inc(fmt.Sprintf("commands.%s.success", actionName), 1)
+		} else {
+			d.client.Inc(fmt.Sprintf("commands.%s.failure", actionName), 1)
+		}
+	}()
+
+	return d.base.Handle(ctx, cmd)
+}
+
+type queryMetricsDecorator[C any, R any] struct {
+	base   QueryHandler[C, R]
+	client MetricsClient
+}
+
+func (d queryMetricsDecorator[C, R]) Handle(ctx context.Context, query C) (result R, err error) {
+	start := time.Now()
+
+	actionName := strings.ToLower(generateActionName(query))
+
+	defer func() {
+		end := time.Since(start)
+
+		d.client.Inc(fmt.Sprintf("querys.%s.duration", actionName), int(end.Seconds()))
+
+		if err == nil {
+			d.client.Inc(fmt.Sprintf("querys.%s.success", actionName), 1)
+		} else {
+			d.client.Inc(fmt.Sprintf("querys.%s.failure", actionName), 1)
+		}
+	}()
+
+	return d.base.Handle(ctx, query)
+}

internal/common/decorator/query.go

@@ -0,0 +1,21 @@
+package decorator
+
+import (
+	"context"
+
+	"github.com/sirupsen/logrus"
+)
+
+func ApplyQueryDecorators[H any, R any](handler QueryHandler[H, R], logger *logrus.Entry, metricsClient MetricsClient) QueryHandler[H, R] {
+	return queryLoggingDecorator[H, R]{
+		base: queryMetricsDecorator[H, R]{
+			base:   handler,
+			client: metricsClient,
+		},
+		logger: logger,
+	}
+}
+
+type QueryHandler[Q any, R any] interface {
+	Handle(ctx context.Context, q Q) (R, error)
+}

internal/common/go.mod

@@ -1,6 +1,6 @@
 module github.com/ThreeDotsLabs/wild-workouts-go-ddd-example/internal/common
 
-go 1.17
+go 1.18
 
 require (
 	cloud.google.com/go v0.75.0

internal/common/logs/logrus.go

@@ -9,7 +9,13 @@ import (
 )
 
 func Init() {
-	logrus.SetFormatter(&logrus.JSONFormatter{
+	SetFormatter(logrus.StandardLogger())
+
+	logrus.SetLevel(logrus.DebugLevel)
+}
+
+func SetFormatter(logger *logrus.Logger) {
+	logger.SetFormatter(&logrus.JSONFormatter{
 		FieldMap: logrus.FieldMap{
 			logrus.FieldKeyTime:  "time",
 			logrus.FieldKeyLevel: "severity",
@@ -18,10 +24,8 @@ func Init() {
 	})
 
 	if isLocalEnv, _ := strconv.ParseBool(os.Getenv("LOCAL_ENV")); isLocalEnv {
-		logrus.SetFormatter(&prefixed.TextFormatter{
+		logger.SetFormatter(&prefixed.TextFormatter{
 			ForceFormatting: true,
 		})
 	}
-
-	logrus.SetLevel(logrus.DebugLevel)
 }

internal/common/metrics/dummy.go

@@ -0,0 +1,7 @@
+package metrics
+
+type NoOp struct{}
+
+func (d NoOp) Inc(_ string, _ int) {
+	// todo - add some implementation!
+}