refactor: 重构trustlog-sdk目录结构到trustlog/go-trustlog
- 将所有trustlog-sdk文件移动到trustlog/go-trustlog/目录 - 更新README中所有import路径从trustlog-sdk改为go-trustlog - 更新cookiecutter配置文件中的项目名称 - 更新根目录.lefthook.yml以引用新位置的配置 - 添加go.sum文件到版本控制 - 删除过时的示例文件 这次重构与trustlog-server保持一致的目录结构， 为未来支持多语言SDK（Python、Java等）预留空间。
This commit is contained in:
ryan
194
internal/logger/logger.go
Normal file
194
internal/logger/logger.go
Normal file
@@ -0,0 +1,194 @@
|
||||
package logger
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/ThreeDotsLabs/watermill"
|
||||
"github.com/apache/pulsar-client-go/pulsar/log"
|
||||
|
||||
"go.yandata.net/iod/iod/trustlog-sdk/api/logger"
|
||||
)
|
||||
|
||||
const (
|
||||
// argsPerField 每个字段转换为args时的参数数量（key+value）.
|
||||
argsPerField = 2
|
||||
)
|
||||
|
||||
type WatermillLoggerAdapter struct {
|
||||
logger logger.Logger
|
||||
fields watermill.LogFields
|
||||
}
|
||||
|
||||
func (w WatermillLoggerAdapter) Error(msg string, err error, fields watermill.LogFields) {
|
||||
allFields := mergeFields(w.fields, fields)
|
||||
args := allFieldsToArgs(allFields)
|
||||
w.logger.Error(fmt.Sprintf("%s: %v", msg, err), args...)
|
||||
}
|
||||
|
||||
func (w WatermillLoggerAdapter) Info(msg string, fields watermill.LogFields) {
|
||||
allFields := mergeFields(w.fields, fields)
|
||||
args := allFieldsToArgs(allFields)
|
||||
w.logger.Info(msg, args...)
|
||||
}
|
||||
|
||||
func (w WatermillLoggerAdapter) Debug(msg string, fields watermill.LogFields) {
|
||||
allFields := mergeFields(w.fields, fields)
|
||||
args := allFieldsToArgs(allFields)
|
||||
w.logger.Debug(msg, args...)
|
||||
}
|
||||
|
||||
func (w WatermillLoggerAdapter) Trace(msg string, fields watermill.LogFields) {
|
||||
allFields := mergeFields(w.fields, fields)
|
||||
args := allFieldsToArgs(allFields)
|
||||
w.logger.Debug(fmt.Sprintf("[TRACE] %s", msg), args...)
|
||||
}
|
||||
|
||||
func (w WatermillLoggerAdapter) With(fields watermill.LogFields) watermill.LoggerAdapter {
|
||||
newFields := mergeFields(w.fields, fields)
|
||||
return WatermillLoggerAdapter{
|
||||
logger: w.logger,
|
||||
fields: newFields,
|
||||
}
|
||||
}
|
||||
|
||||
//nolint:funcorder // 构造函数放在此处更符合代码组织
|
||||
func NewWatermillLoggerAdapter(logger logger.Logger) *WatermillLoggerAdapter {
|
||||
return &WatermillLoggerAdapter{logger: logger, fields: watermill.LogFields{}}
|
||||
}
|
||||
|
||||
func mergeFields(base, extra watermill.LogFields) watermill.LogFields {
|
||||
merged := make(watermill.LogFields, len(base)+len(extra))
|
||||
for k, v := range base {
|
||||
merged[k] = v
|
||||
}
|
||||
for k, v := range extra {
|
||||
merged[k] = v
|
||||
}
|
||||
return merged
|
||||
}
|
||||
|
||||
func allFieldsToArgs(fields watermill.LogFields) []any {
|
||||
args := make([]any, 0, len(fields)*argsPerField)
|
||||
for k, v := range fields {
|
||||
args = append(args, k, v)
|
||||
}
|
||||
return args
|
||||
}
|
||||
|
||||
// ================= PulsarLoggerAdapter ======================
|
||||
|
||||
type PulsarLoggerAdapter struct {
|
||||
logger logger.Logger
|
||||
fields log.Fields
|
||||
err error
|
||||
}
|
||||
|
||||
func NewPulsarLoggerAdapter(l logger.Logger) *PulsarLoggerAdapter {
|
||||
return &PulsarLoggerAdapter{logger: l, fields: log.Fields{}}
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) SubLogger(fields log.Fields) log.Logger {
|
||||
return PulsarLoggerAdapter{
|
||||
logger: p.logger,
|
||||
fields: mergePulsarFields(p.fields, fields),
|
||||
err: p.err,
|
||||
}
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) WithFields(fields log.Fields) log.Entry {
|
||||
return PulsarLoggerAdapter{
|
||||
logger: p.logger,
|
||||
fields: mergePulsarFields(p.fields, fields),
|
||||
err: p.err,
|
||||
}
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) WithField(name string, value interface{}) log.Entry {
|
||||
newFields := mergePulsarFields(p.fields, log.Fields{name: value})
|
||||
return PulsarLoggerAdapter{
|
||||
logger: p.logger,
|
||||
fields: newFields,
|
||||
err: p.err,
|
||||
}
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) WithError(err error) log.Entry {
|
||||
return PulsarLoggerAdapter{
|
||||
logger: p.logger,
|
||||
fields: p.fields,
|
||||
err: err,
|
||||
}
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Debug(args ...interface{}) {
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
p.logger.Debug(fmt.Sprint(args...), fieldsArgs...)
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Info(args ...interface{}) {
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
p.logger.Info(fmt.Sprint(args...), fieldsArgs...)
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Warn(args ...interface{}) {
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
p.logger.Warn(fmt.Sprint(args...), fieldsArgs...)
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Error(args ...interface{}) {
|
||||
msg := fmt.Sprint(args...)
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
if p.err != nil {
|
||||
// 将error作为key-value对添加到args中
|
||||
fieldsArgs = append(fieldsArgs, "error", p.err)
|
||||
p.logger.Error(msg, fieldsArgs...)
|
||||
} else {
|
||||
p.logger.Error(msg, fieldsArgs...)
|
||||
}
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Debugf(format string, args ...interface{}) {
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
p.logger.Debug(fmt.Sprintf(format, args...), fieldsArgs...)
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Infof(format string, args ...interface{}) {
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
p.logger.Info(fmt.Sprintf(format, args...), fieldsArgs...)
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Warnf(format string, args ...interface{}) {
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
p.logger.Warn(fmt.Sprintf(format, args...), fieldsArgs...)
|
||||
}
|
||||
|
||||
func (p PulsarLoggerAdapter) Errorf(format string, args ...interface{}) {
|
||||
msg := fmt.Sprintf(format, args...)
|
||||
fieldsArgs := fieldsToArgs(p.fields)
|
||||
if p.err != nil {
|
||||
p.logger.Error(fmt.Sprintf("%s: %v", msg, p.err), fieldsArgs...)
|
||||
} else {
|
||||
p.logger.Error(msg, fieldsArgs...)
|
||||
}
|
||||
}
|
||||
|
||||
// 合并 Pulsar log.Fields.
|
||||
func mergePulsarFields(base, extra log.Fields) log.Fields {
|
||||
merged := make(log.Fields, len(base)+len(extra))
|
||||
for k, v := range base {
|
||||
merged[k] = v
|
||||
}
|
||||
for k, v := range extra {
|
||||
merged[k] = v
|
||||
}
|
||||
return merged
|
||||
}
|
||||
|
||||
// 将 Pulsar log.Fields 转为 args ...any 形式，适配 Adapter.
|
||||
func fieldsToArgs(fields log.Fields) []any {
|
||||
args := make([]any, 0, len(fields)*argsPerField)
|
||||
for k, v := range fields {
|
||||
args = append(args, k, v)
|
||||
}
|
||||
return args
|
||||
}
|
||||
385
internal/logger/logger_test.go
Normal file
385
internal/logger/logger_test.go
Normal file
@@ -0,0 +1,385 @@
|
||||
package logger_test
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
|
||||
apilogger "go.yandata.net/iod/iod/trustlog-sdk/api/logger"
|
||||
"go.yandata.net/iod/iod/trustlog-sdk/internal/logger"
|
||||
)
|
||||
|
||||
func TestNewWatermillLoggerAdapter(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
assert.NotNil(t, adapter)
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_Error(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
err := errors.New("test error")
|
||||
fields := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
"key2": 42,
|
||||
}
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Error("error message", err, fields)
|
||||
})
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_Info(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
fields := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
"key2": 42,
|
||||
}
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Info("info message", fields)
|
||||
})
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_Debug(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
fields := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
}
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Debug("debug message", fields)
|
||||
})
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_Trace(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
fields := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
}
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Trace("trace message", fields)
|
||||
})
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_With(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
fields1 := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
}
|
||||
fields2 := map[string]interface{}{
|
||||
"key2": "value2",
|
||||
}
|
||||
|
||||
newAdapter := adapter.With(fields1)
|
||||
assert.NotNil(t, newAdapter)
|
||||
|
||||
// Test that fields are merged
|
||||
newAdapter2 := newAdapter.With(fields2)
|
||||
assert.NotNil(t, newAdapter2)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
newAdapter2.Info("test", map[string]interface{}{})
|
||||
})
|
||||
}
|
||||
|
||||
func TestNewPulsarLoggerAdapter(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
assert.NotNil(t, adapter)
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Debug(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Debug("debug message")
|
||||
adapter.Debug("debug", "message", "with", "args")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Info(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Info("info message")
|
||||
adapter.Info("info", "message", "with", "args")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Warn(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Warn("warn message")
|
||||
adapter.Warn("warn", "message", "with", "args")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Error(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
test func()
|
||||
}{
|
||||
{
|
||||
name: "without error",
|
||||
test: func() {
|
||||
adapter.Error("error message")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "with error",
|
||||
test: func() {
|
||||
adapterWithErr := adapter.WithError(errors.New("test error"))
|
||||
adapterWithErr.Error("error message")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert.NotPanics(t, tt.test)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Debugf(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Debugf("debug %s", "message")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Infof(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Infof("info %s", "message")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Warnf(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Warnf("warn %s", "message")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_Errorf(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
test func()
|
||||
}{
|
||||
{
|
||||
name: "without error",
|
||||
test: func() {
|
||||
adapter.Errorf("error %s", "message")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "with error",
|
||||
test: func() {
|
||||
adapterWithErr := adapter.WithError(errors.New("test error"))
|
||||
adapterWithErr.Errorf("error %s", "message")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
assert.NotPanics(t, tt.test)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_SubLogger(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
fields := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
}
|
||||
|
||||
subLogger := adapter.SubLogger(fields)
|
||||
assert.NotNil(t, subLogger)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
subLogger.Info("test")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_WithFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
fields := map[string]interface{}{
|
||||
"key1": "value1",
|
||||
"key2": 42,
|
||||
}
|
||||
|
||||
entry := adapter.WithFields(fields)
|
||||
assert.NotNil(t, entry)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
entry.Info("test")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_WithField(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
entry := adapter.WithField("key", "value")
|
||||
assert.NotNil(t, entry)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
entry.Info("test")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_WithError(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
err := errors.New("test error")
|
||||
entry := adapter.WithError(err)
|
||||
assert.NotNil(t, entry)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
entry.Error("test error message")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_ChainedFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
entry1 := adapter.WithField("key1", "value1")
|
||||
entry2 := entry1.WithField("key2", "value2")
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
entry2.Info("chained fields test")
|
||||
})
|
||||
|
||||
// Test WithError separately
|
||||
entryWithErr := adapter.WithError(errors.New("test error"))
|
||||
assert.NotPanics(t, func() {
|
||||
entryWithErr.Error("chained fields test")
|
||||
})
|
||||
}
|
||||
|
||||
func TestPulsarLoggerAdapter_FormatMethods(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewPulsarLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Debugf("debug %d", 1)
|
||||
adapter.Infof("info %d", 2)
|
||||
adapter.Warnf("warn %d", 3)
|
||||
adapter.Errorf("error %d", 4)
|
||||
})
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_EmptyFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapter.Error("error", errors.New("test"), map[string]interface{}{})
|
||||
adapter.Info("info", map[string]interface{}{})
|
||||
adapter.Debug("debug", map[string]interface{}{})
|
||||
adapter.Trace("trace", map[string]interface{}{})
|
||||
})
|
||||
}
|
||||
|
||||
func TestWatermillLoggerAdapter_MergedFields(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
l := apilogger.NewNopLogger()
|
||||
adapter := logger.NewWatermillLoggerAdapter(l)
|
||||
|
||||
baseFields := map[string]interface{}{
|
||||
"base": "value",
|
||||
}
|
||||
extraFields := map[string]interface{}{
|
||||
"extra": "value",
|
||||
}
|
||||
|
||||
adapterWithBase := adapter.With(baseFields)
|
||||
adapterWithBoth := adapterWithBase.With(extraFields)
|
||||
|
||||
assert.NotPanics(t, func() {
|
||||
adapterWithBoth.Info("test", map[string]interface{}{})
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user