From eb2dcae83d7bfcf9130961b80a1d503ad6aa247a Mon Sep 17 00:00:00 2001
From: Elric Li <liliang.illusion@hotmail.com>
Date: Fri, 6 May 2022 15:59:50 +0800
Subject: [PATCH] feat(log): Helper implemented io.Writer (#1927)

* feat(log): Add writerWrapper implementing io.Writer

* fix(kratos): fix format has wrong type

* fix(log): rename writerOption to WriterOptionFn.
---
 log/helper_writer.go      | 43 ++++++++++++++++++++++++++++++++
 log/helper_writer_test.go | 52 +++++++++++++++++++++++++++++++++++++++
 options_test.go           |  2 +-
 3 files changed, 96 insertions(+), 1 deletion(-)
 create mode 100644 log/helper_writer.go
 create mode 100644 log/helper_writer_test.go

diff --git a/log/helper_writer.go b/log/helper_writer.go
new file mode 100644
index 000000000..0c76a7bae
--- /dev/null
+++ b/log/helper_writer.go
@@ -0,0 +1,43 @@
+package log
+
+import "io"
+
+type writerWrapper struct {
+	helper *Helper
+	level  Level
+}
+
+type WriterOptionFn func(w *writerWrapper)
+
+// WithWriteLevel set writerWrapper level.
+func WithWriterLevel(level Level) WriterOptionFn {
+	return func(w *writerWrapper) {
+		w.level = level
+	}
+}
+
+// WithWriteMessageKey set writerWrapper helper message key.
+func WithWriteMessageKey(key string) WriterOptionFn {
+	return func(w *writerWrapper) {
+		if key != "" {
+			w.helper.msgKey = key
+		}
+	}
+}
+
+// NewWriter return a writer wrapper.
+func NewWriter(logger Logger, opts ...WriterOptionFn) io.Writer {
+	ww := &writerWrapper{
+		helper: NewHelper(logger, WithMessageKey(DefaultMessageKey)),
+		level:  LevelInfo, // default level
+	}
+	for _, opt := range opts {
+		opt(ww)
+	}
+	return ww
+}
+
+func (ww *writerWrapper) Write(p []byte) (int, error) {
+	ww.helper.Log(ww.level, ww.helper.msgKey, string(p))
+	return 0, nil
+}
diff --git a/log/helper_writer_test.go b/log/helper_writer_test.go
new file mode 100644
index 000000000..46bf8d194
--- /dev/null
+++ b/log/helper_writer_test.go
@@ -0,0 +1,52 @@
+package log
+
+import (
+	"bytes"
+	"io"
+	"strings"
+	"testing"
+)
+
+func TestWriterWrapper(t *testing.T) {
+	var buf bytes.Buffer
+	logger := NewStdLogger(&buf)
+	content := "ThisIsSomeTestLogMessage"
+	testCases := []struct {
+		w                io.Writer
+		acceptLevel      Level
+		acceptMessageKey string
+	}{
+		{
+			w:                NewWriter(logger),
+			acceptLevel:      LevelInfo, // default level
+			acceptMessageKey: DefaultMessageKey,
+		},
+		{
+			w:                NewWriter(logger, WithWriterLevel(LevelDebug)),
+			acceptLevel:      LevelDebug,
+			acceptMessageKey: DefaultMessageKey,
+		},
+		{
+			w:                NewWriter(logger, WithWriteMessageKey("XxXxX")),
+			acceptLevel:      LevelInfo, // default level
+			acceptMessageKey: "XxXxX",
+		},
+		{
+			w:                NewWriter(logger, WithWriterLevel(LevelError), WithWriteMessageKey("XxXxX")),
+			acceptLevel:      LevelError,
+			acceptMessageKey: "XxXxX",
+		},
+	}
+	for _, tc := range testCases {
+		_, err := tc.w.Write([]byte(content))
+		if err != nil {
+			t.Fatalf("unexpected error: %v", err)
+		}
+		if !strings.Contains(buf.String(), tc.acceptLevel.String()) {
+			t.Errorf("expected level: %s, got: %s", tc.acceptLevel, buf.String())
+		}
+		if !strings.Contains(buf.String(), tc.acceptMessageKey) {
+			t.Errorf("expected message key: %s, got: %s", tc.acceptMessageKey, buf.String())
+		}
+	}
+}
diff --git a/options_test.go b/options_test.go
index 8d2dbee1f..953c52f54 100644
--- a/options_test.go
+++ b/options_test.go
@@ -80,7 +80,7 @@ func TestLogger(t *testing.T) {
 	v := xlog.NewStdLogger(log.Writer())
 	Logger(v)(o)
 	if !reflect.DeepEqual(xlog.NewHelper(v), o.logger) {
-		t.Fatalf("o.logger:%s is not equal to xlog.NewHelper(v):%s", o.logger, xlog.NewHelper(v))
+		t.Fatalf("o.logger:%v is not equal to xlog.NewHelper(v):%v", o.logger, xlog.NewHelper(v))
 	}
 }