Refactor Logger (#13294)

Refactor Logger to make a logger interface and make it possible to
wrap loggers for specific purposes.

Co-authored-by: techknowlogick <techknowlogick@gitea.io>

Author: zeripath

models/log.go

@@ -15,7 +15,7 @@ import (
 // XORMLogBridge a logger bridge from Logger to xorm
 type XORMLogBridge struct {
 	showSQL bool
-	logger  *log.Logger
+	logger  log.Logger
 }
 
 // NewXORMLogger inits a log bridge for xorm

modules/indexer/code/elastic_search.go

@@ -40,7 +40,7 @@ type ElasticSearchIndexer struct {
 }
 
 type elasticLogger struct {
-	*log.Logger
+	log.Logger
 }
 
 func (l elasticLogger) Printf(format string, args ...interface{}) {

modules/indexer/issues/elastic_search.go

@@ -27,11 +27,11 @@ type ElasticSearchIndexer struct {
 }
 
 type elasticLogger struct {
-	*log.Logger
+	log.LevelLogger
 }
 
 func (l elasticLogger) Printf(format string, args ...interface{}) {
-	_ = l.Logger.Log(2, l.Logger.GetLevel(), format, args...)
+	_ = l.Log(2, l.GetLevel(), format, args...)
 }
 
 // NewElasticSearchIndexer creates a new elasticsearch indexer

modules/log/colors.go

@@ -158,15 +158,15 @@ func ColorBytes(attrs ...ColorAttribute) []byte {
 	return bytes
 }
 
-var levelToColor = map[Level]string{
-	TRACE:    ColorString(Bold, FgCyan),
-	DEBUG:    ColorString(Bold, FgBlue),
-	INFO:     ColorString(Bold, FgGreen),
-	WARN:     ColorString(Bold, FgYellow),
-	ERROR:    ColorString(Bold, FgRed),
-	CRITICAL: ColorString(Bold, BgMagenta),
-	FATAL:    ColorString(Bold, BgRed),
-	NONE:     ColorString(Reset),
+var levelToColor = map[Level][]byte{
+	TRACE:    ColorBytes(Bold, FgCyan),
+	DEBUG:    ColorBytes(Bold, FgBlue),
+	INFO:     ColorBytes(Bold, FgGreen),
+	WARN:     ColorBytes(Bold, FgYellow),
+	ERROR:    ColorBytes(Bold, FgRed),
+	CRITICAL: ColorBytes(Bold, BgMagenta),
+	FATAL:    ColorBytes(Bold, BgRed),
+	NONE:     ColorBytes(Reset),
 }
 
 var resetBytes = ColorBytes(Reset)

modules/log/level.go

@@ -73,6 +73,16 @@ func (l Level) String() string {
 	return "info"
 }
 
+// Color returns the color string for this Level
+func (l Level) Color() *[]byte {
+	color, ok := levelToColor[l]
+	if ok {
+		return &(color)
+	}
+	none := levelToColor[NONE]
+	return &none
+}
+
 // MarshalJSON takes a Level and turns it into text
 func (l Level) MarshalJSON() ([]byte, error) {
 	buffer := bytes.NewBufferString(`"`)

modules/log/log.go

@@ -16,16 +16,16 @@ type loggerMap struct {
 	sync.Map
 }
 
-func (m *loggerMap) Load(k string) (*Logger, bool) {
+func (m *loggerMap) Load(k string) (*MultiChannelledLogger, bool) {
 	v, ok := m.Map.Load(k)
 	if !ok {
 		return nil, false
 	}
-	l, ok := v.(*Logger)
+	l, ok := v.(*MultiChannelledLogger)
 	return l, ok
 }
 
-func (m *loggerMap) Store(k string, v *Logger) {
+func (m *loggerMap) Store(k string, v *MultiChannelledLogger) {
 	m.Map.Store(k, v)
 }
 
@@ -42,7 +42,7 @@ var (
 )
 
 // NewLogger create a logger for the default logger
-func NewLogger(bufLen int64, name, provider, config string) *Logger {
+func NewLogger(bufLen int64, name, provider, config string) *MultiChannelledLogger {
 	err := NewNamedLogger(DEFAULT, bufLen, name, provider, config)
 	if err != nil {
 		CriticalWithSkip(1, "Unable to create default logger: %v", err)
@@ -83,7 +83,7 @@ func DelLogger(name string) error {
 }
 
 // GetLogger returns either a named logger or the default logger
-func GetLogger(name string) *Logger {
+func GetLogger(name string) *MultiChannelledLogger {
 	logger, ok := NamedLoggers.Load(name)
 	if ok {
 		return logger
@@ -196,7 +196,7 @@ func IsFatal() bool {
 // Pause pauses all the loggers
 func Pause() {
 	NamedLoggers.Range(func(key, value interface{}) bool {
-		logger := value.(*Logger)
+		logger := value.(*MultiChannelledLogger)
 		logger.Pause()
 		logger.Flush()
 		return true
@@ -206,7 +206,7 @@ func Pause() {
 // Resume resumes all the loggers
 func Resume() {
 	NamedLoggers.Range(func(key, value interface{}) bool {
-		logger := value.(*Logger)
+		logger := value.(*MultiChannelledLogger)
 		logger.Resume()
 		return true
 	})
@@ -216,7 +216,7 @@ func Resume() {
 func ReleaseReopen() error {
 	var accumulatedErr error
 	NamedLoggers.Range(func(key, value interface{}) bool {
-		logger := value.(*Logger)
+		logger := value.(*MultiChannelledLogger)
 		if err := logger.ReleaseReopen(); err != nil {
 			if accumulatedErr == nil {
 				accumulatedErr = fmt.Errorf("Error reopening %s: %v", key.(string), err)
@@ -250,15 +250,15 @@ func Log(skip int, level Level, format string, v ...interface{}) {
 
 // LoggerAsWriter is a io.Writer shim around the gitea log
 type LoggerAsWriter struct {
-	ourLoggers []*Logger
+	ourLoggers []*MultiChannelledLogger
 	level      Level
 }
 
 // NewLoggerAsWriter creates a Writer representation of the logger with setable log level
-func NewLoggerAsWriter(level string, ourLoggers ...*Logger) *LoggerAsWriter {
+func NewLoggerAsWriter(level string, ourLoggers ...*MultiChannelledLogger) *LoggerAsWriter {
 	if len(ourLoggers) == 0 {
 		l, _ := NamedLoggers.Load(DEFAULT)
-		ourLoggers = []*Logger{l}
+		ourLoggers = []*MultiChannelledLogger{l}
 	}
 	l := &LoggerAsWriter{
 		ourLoggers: ourLoggers,

modules/log/log_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func baseConsoleTest(t *testing.T, logger *Logger) (chan []byte, chan bool) {
+func baseConsoleTest(t *testing.T, logger *MultiChannelledLogger) (chan []byte, chan bool) {
 	written := make(chan []byte)
 	closed := make(chan bool)