logger: add NewStdLogger and RedirectStdLogger

Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>

config/config.go

@@ -10,8 +10,11 @@ import (
 // DefaultConfig default config
 var DefaultConfig Config = NewConfig()
 
-// DefaultWatcherInterval default interval for poll changes
-var DefaultWatcherInterval = 5 * time.Second
+// DefaultWatcherMinInterval default min interval for poll changes
+var DefaultWatcherMinInterval = 5 * time.Second
+
+// DefaultWatcherMinInterval default max interval for poll changes
+var DefaultWatcherMaxInterval = 9 * time.Second
 
 var (
 	// ErrCodecMissing is returned when codec needed and not specified

config/default.go

@@ -2,10 +2,10 @@ package config
 
 import (
 	"context"
+	"fmt"
 	"reflect"
 	"strconv"
 	"strings"
-	"time"
 
 	"github.com/imdario/mergo"
 	rutil "github.com/unistack-org/micro/v3/util/reflect"
@@ -271,17 +271,7 @@ func (c *defaultConfig) Name() string {
 }
 
 func (c *defaultConfig) Watch(ctx context.Context, opts ...WatchOption) (Watcher, error) {
-	w := &defaultWatcher{
-		opts:  c.opts,
-		wopts: NewWatchOptions(opts...),
-		done:  make(chan bool),
-		vchan: make(chan map[string]interface{}),
-		echan: make(chan error),
-	}
-
-	go w.run()
-
-	return w, nil
+	return nil, fmt.Errorf("not implemented")
 }
 
 // NewConfig returns new default config source
@@ -292,73 +282,3 @@ func NewConfig(opts ...Option) Config {
 	}
 	return &defaultConfig{opts: options}
 }
-
-type defaultWatcher struct {
-	opts   Options
-	wopts  WatchOptions
-	done   chan bool
-	ticker *time.Ticker
-	vchan  chan map[string]interface{}
-	echan  chan error
-}
-
-func (w *defaultWatcher) run() {
-	ticker := time.NewTicker(w.wopts.Interval)
-	defer ticker.Stop()
-
-	src := w.opts.Struct
-	if w.wopts.Struct != nil {
-		src = w.wopts.Struct
-	}
-
-	for {
-		select {
-		case <-w.done:
-			return
-		case <-ticker.C:
-			dst, err := rutil.Zero(src)
-			if err == nil {
-				err = fillValues(reflect.ValueOf(dst), w.opts.StructTag)
-			}
-			if err != nil {
-				w.echan <- err
-				return
-			}
-			srcmp, err := rutil.StructFieldsMap(src)
-			if err != nil {
-				w.echan <- err
-				return
-			}
-			dstmp, err := rutil.StructFieldsMap(dst)
-			if err != nil {
-				w.echan <- err
-				return
-			}
-			for sk, sv := range srcmp {
-				if reflect.DeepEqual(dstmp[sk], sv) {
-					delete(dstmp, sk)
-				}
-			}
-			w.vchan <- dstmp
-			src = dst
-		}
-	}
-}
-
-func (w *defaultWatcher) Next() (map[string]interface{}, error) {
-	select {
-	case <-w.done:
-		break
-	case v, ok := <-w.vchan:
-		if !ok {
-			break
-		}
-		return v, nil
-	}
-	return nil, ErrWatcherStopped
-}
-
-func (w *defaultWatcher) Stop() error {
-	close(w.done)
-	return nil
-}

config/default_test.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 	"testing"
-	"time"
 
 	"github.com/unistack-org/micro/v3/config"
 )
@@ -18,57 +17,6 @@ type Cfg struct {
 	IntValue int `default:"99"`
 }
 
-func TestWatch(t *testing.T) {
-	ctx := context.Background()
-
-	conf := &Cfg{IntValue: 10}
-
-	cfg := config.NewConfig(config.Struct(conf))
-	if err := cfg.Init(); err != nil {
-		t.Fatal(err)
-	}
-	if err := cfg.Load(ctx); err != nil {
-		t.Fatal(err)
-	}
-
-	w, err := cfg.Watch(ctx, config.WatchInterval(500*time.Millisecond))
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	defer func() {
-		_ = w.Stop()
-	}()
-
-	done := make(chan struct{})
-
-	go func() {
-		for {
-			mp, err := w.Next()
-			if err != nil && err != config.ErrWatcherStopped {
-				t.Fatal(err)
-			} else if err == config.ErrWatcherStopped {
-				return
-			}
-			if len(mp) != 1 {
-				t.Fatal(fmt.Errorf("default watcher err: %v", mp))
-			}
-
-			v, ok := mp["IntValue"]
-			if !ok {
-				t.Fatal(fmt.Errorf("default watcher err: %v", v))
-			}
-			if nv, ok := v.(int); !ok || nv != 99 {
-				t.Fatal(fmt.Errorf("default watcher err: %v", v))
-			}
-			close(done)
-			return
-		}
-	}()
-
-	<-done
-}
-
 func TestDefault(t *testing.T) {
 	ctx := context.Background()
 	conf := &Cfg{IntValue: 10}

config/options.go

@@ -211,8 +211,10 @@ type WatchOptions struct {
 	Context context.Context
 	// Coalesce multiple events to one
 	Coalesce bool
-	// Interval to periodically pull changes if config source not supports async notify
-	Interval time.Duration
+	// MinInterval specifies the min time.Duration interval for poll changes
+	MinInterval time.Duration
+	// MaxInterval specifies the max time.Duration interval for poll changes
+	MaxInterval time.Duration
 	// Struct for filling
 	Struct interface{}
 }
@@ -221,8 +223,9 @@ type WatchOption func(*WatchOptions)
 
 func NewWatchOptions(opts ...WatchOption) WatchOptions {
 	options := WatchOptions{
-		Context:  context.Background(),
-		Interval: DefaultWatcherInterval,
+		Context:     context.Background(),
+		MinInterval: DefaultWatcherMinInterval,
+		MaxInterval: DefaultWatcherMaxInterval,
 	}
 	for _, o := range opts {
 		o(&options)
@@ -244,10 +247,11 @@ func WatchCoalesce(b bool) WatchOption {
 	}
 }
 
-// WatchInterval specifies time.Duration for pulling changes
-func WatchInterval(td time.Duration) WatchOption {
+// WatchInterval specifies min and max time.Duration for pulling changes
+func WatchInterval(min, max time.Duration) WatchOption {
 	return func(o *WatchOptions) {
-		o.Interval = td
+		o.MinInterval = min
+		o.MaxInterval = max
 	}
 }
 

go.mod

@@ -4,7 +4,7 @@ go 1.16
 
 require (
 	github.com/ef-ds/deque v1.0.4
-	github.com/golang-jwt/jwt v3.2.1+incompatible
+	github.com/golang-jwt/jwt v3.2.2+incompatible
 	github.com/google/uuid v1.3.0
 	github.com/imdario/mergo v0.3.12
 	github.com/patrickmn/go-cache v2.1.0+incompatible

go.sum

@@ -1,7 +1,7 @@
 github.com/ef-ds/deque v1.0.4 h1:iFAZNmveMT9WERAkqLJ+oaABF9AcVQ5AjXem/hroniI=
 github.com/ef-ds/deque v1.0.4/go.mod h1:gXDnTC3yqvBcHbq2lcExjtAcVrOnJCbMcZXmuj8Z4tg=
-github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c=
-github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
+github.com/golang-jwt/jwt v3.2.2+incompatible h1:IfV12K8xAKAnZqdXVzCZ+TOjboZ2keLg81eXfW3O+oY=
+github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=

logger/default.go

@@ -40,7 +40,6 @@ func (l *defaultLogger) Init(opts ...Option) error {
 		l.logFunc = l.opts.Wrappers[i-1].Log(l.logFunc)
 		l.logfFunc = l.opts.Wrappers[i-1].Logf(l.logfFunc)
 	}
-
 	l.Unlock()
 	return nil
 }
@@ -56,26 +55,20 @@ func (l *defaultLogger) V(level Level) bool {
 	return ok
 }
 
-func (l *defaultLogger) Fields(fields map[string]interface{}) Logger {
+func (l *defaultLogger) Fields(fields ...interface{}) Logger {
 	nl := &defaultLogger{opts: l.opts, enc: l.enc}
-	nl.opts.Fields = make(map[string]interface{}, len(l.opts.Fields)+len(fields))
-	l.RLock()
-	for k, v := range l.opts.Fields {
-		nl.opts.Fields[k] = v
-	}
-	l.RUnlock()
-
-	for k, v := range fields {
-		nl.opts.Fields[k] = v
+	if len(fields) == 0 {
+		return nl
+	} else if len(fields)%2 != 0 {
+		fields = fields[:len(fields)-1]
 	}
+	nl.opts.Fields = append(l.opts.Fields, fields...)
 	return nl
 }
 
-func copyFields(src map[string]interface{}) map[string]interface{} {
-	dst := make(map[string]interface{}, len(src))
-	for k, v := range src {
-		dst[k] = v
-	}
+func copyFields(src []interface{}) []interface{} {
+	dst := make([]interface{}, len(src))
+	copy(dst, src)
 	return dst
 }
 
@@ -162,19 +155,23 @@ func (l *defaultLogger) Log(ctx context.Context, level Level, args ...interface{
 	fields := copyFields(l.opts.Fields)
 	l.RUnlock()
 
-	fields["level"] = level.String()
+	fields = append(fields, "level", level.String())
 
 	if _, file, line, ok := runtime.Caller(l.opts.CallerSkipCount); ok {
-		fields["caller"] = fmt.Sprintf("%s:%d", logCallerfilePath(file), line)
+		fields = append(fields, "caller", fmt.Sprintf("%s:%d", logCallerfilePath(file), line))
 	}
+	fields = append(fields, "timestamp", time.Now().Format("2006-01-02 15:04:05"))
 
-	fields["timestamp"] = time.Now().Format("2006-01-02 15:04:05")
 	if len(args) > 0 {
-		fields["msg"] = fmt.Sprint(args...)
+		fields = append(fields, "msg", fmt.Sprint(args...))
 	}
 
+	out := make(map[string]interface{}, len(fields)/2)
+	for i := 0; i < len(fields); i += 2 {
+		out[fields[i].(string)] = fields[i+1]
+	}
 	l.RLock()
-	_ = l.enc.Encode(fields)
+	_ = l.enc.Encode(out)
 	l.RUnlock()
 }
 
@@ -187,30 +184,30 @@ func (l *defaultLogger) Logf(ctx context.Context, level Level, msg string, args
 	fields := copyFields(l.opts.Fields)
 	l.RUnlock()
 
-	fields["level"] = level.String()
+	fields = append(fields, "level", level.String())
 
 	if _, file, line, ok := runtime.Caller(l.opts.CallerSkipCount); ok {
-		fields["caller"] = fmt.Sprintf("%s:%d", logCallerfilePath(file), line)
+		fields = append(fields, "caller", fmt.Sprintf("%s:%d", logCallerfilePath(file), line))
 	}
 
-	fields["timestamp"] = time.Now().Format("2006-01-02 15:04:05")
+	fields = append(fields, "timestamp", time.Now().Format("2006-01-02 15:04:05"))
 	if len(args) > 0 {
-		fields["msg"] = fmt.Sprintf(msg, args...)
+		fields = append(fields, "msg", fmt.Sprintf(msg, args...))
 	} else if msg != "" {
-		fields["msg"] = msg
+		fields = append(fields, "msg", msg)
+	}
+
+	out := make(map[string]interface{}, len(fields)/2)
+	for i := 0; i < len(fields); i += 2 {
+		out[fields[i].(string)] = fields[i+1]
 	}
 	l.RLock()
-	_ = l.enc.Encode(fields)
+	_ = l.enc.Encode(out)
 	l.RUnlock()
 }
 
 func (l *defaultLogger) Options() Options {
-	// not guard against options Context values
-	l.RLock()
-	opts := l.opts
-	opts.Fields = copyFields(l.opts.Fields)
-	l.RUnlock()
-	return opts
+	return l.opts
 }
 
 // NewLogger builds a new logger based on options

logger/logger.go

@@ -20,8 +20,8 @@ type Logger interface {
 	V(level Level) bool
 	// The Logger options
 	Options() Options
-	// Fields set fields to always be logged
-	Fields(fields map[string]interface{}) Logger
+	// Fields set fields to always be logged with keyval pairs
+	Fields(fields ...interface{}) Logger
 	// Info level message
 	Info(ctx context.Context, args ...interface{})
 	// Trace level message
@@ -54,6 +54,9 @@ type Logger interface {
 	String() string
 }
 
+// Field contains keyval pair
+type Field interface{}
+
 // Info writes msg to default logger on info level
 func Info(ctx context.Context, args ...interface{}) {
 	DefaultLogger.Info(ctx, args...)
@@ -125,6 +128,6 @@ func Init(opts ...Option) error {
 }
 
 // Fields create logger with specific fields
-func Fields(fields map[string]interface{}) Logger {
-	return DefaultLogger.Fields(fields)
+func Fields(fields ...interface{}) Logger {
+	return DefaultLogger.Fields(fields...)
 }

logger/logger_test.go

@@ -3,9 +3,37 @@ package logger
 import (
 	"bytes"
 	"context"
+	"log"
 	"testing"
 )
 
+func TestRedirectStdLogger(t *testing.T) {
+	buf := bytes.NewBuffer(nil)
+	l := NewLogger(WithLevel(TraceLevel), WithOutput(buf))
+	if err := l.Init(); err != nil {
+		t.Fatal(err)
+	}
+	fn := RedirectStdLogger(l, ErrorLevel)
+	defer fn()
+	log.Print("test")
+	if !bytes.Contains(buf.Bytes(), []byte(`"level":"error","msg":"test","timestamp"`)) {
+		t.Fatalf("logger error, buf %s", buf.Bytes())
+	}
+}
+
+func TestStdLogger(t *testing.T) {
+	buf := bytes.NewBuffer(nil)
+	l := NewLogger(WithLevel(TraceLevel), WithOutput(buf))
+	if err := l.Init(); err != nil {
+		t.Fatal(err)
+	}
+	lg := NewStdLogger(l, ErrorLevel)
+	lg.Print("test")
+	if !bytes.Contains(buf.Bytes(), []byte(`"level":"error","msg":"test","timestamp"`)) {
+		t.Fatalf("logger error, buf %s", buf.Bytes())
+	}
+}
+
 func TestLogger(t *testing.T) {
 	ctx := context.TODO()
 	buf := bytes.NewBuffer(nil)
@@ -15,7 +43,7 @@ func TestLogger(t *testing.T) {
 	}
 	l.Trace(ctx, "trace_msg1")
 	l.Warn(ctx, "warn_msg1")
-	l.Fields(map[string]interface{}{"error": "test"}).Info(ctx, "error message")
+	l.Fields("error", "test").Info(ctx, "error message")
 	l.Warn(ctx, "first", " ", "second")
 	if !bytes.Contains(buf.Bytes(), []byte(`"level":"trace","msg":"trace_msg1"`)) {
 		t.Fatalf("logger error, buf %s", buf.Bytes())

logger/options.go

@@ -16,7 +16,7 @@ type Options struct {
 	// Context holds exernal options
 	Context context.Context
 	// Fields holds additional metadata
-	Fields map[string]interface{}
+	Fields []interface{}
 	// Name holds the logger name
 	Name string
 	// CallerSkipCount number of frmaes to skip
@@ -31,7 +31,7 @@ type Options struct {
 func NewOptions(opts ...Option) Options {
 	options := Options{
 		Level:           DefaultLevel,
-		Fields:          make(map[string]interface{}),
+		Fields:          make([]interface{}, 0, 6),
 		Out:             os.Stderr,
 		CallerSkipCount: DefaultCallerSkipCount,
 		Context:         context.Background(),
@@ -43,7 +43,7 @@ func NewOptions(opts ...Option) Options {
 }
 
 // WithFields set default fields for the logger
-func WithFields(fields map[string]interface{}) Option {
+func WithFields(fields ...interface{}) Option {
 	return func(o *Options) {
 		o.Fields = fields
 	}

logger/stdlogger.go

@@ -0,0 +1,35 @@
+package logger
+
+import (
+	"bytes"
+	"log"
+)
+
+type stdLogger struct {
+	l     Logger
+	level Level
+}
+
+func NewStdLogger(l Logger, level Level) *log.Logger {
+	return log.New(&stdLogger{l: l, level: level}, "" /* prefix */, 0 /* flags */)
+}
+
+func (sl *stdLogger) Write(p []byte) (int, error) {
+	p = bytes.TrimSpace(p)
+	sl.l.Log(sl.l.Options().Context, sl.level, string(p))
+	return len(p), nil
+}
+
+func RedirectStdLogger(l Logger, level Level) func() {
+	flags := log.Flags()
+	prefix := log.Prefix()
+	writer := log.Writer()
+	log.SetFlags(0)
+	log.SetPrefix("")
+	log.SetOutput(&stdLogger{l: l, level: level})
+	return func() {
+		log.SetFlags(flags)
+		log.SetPrefix(prefix)
+		log.SetOutput(writer)
+	}
+}

logger/wrapper.go

@@ -44,8 +44,8 @@ func (w *OmitLogger) Options() Options {
 	return w.l.Options()
 }
 
-func (w *OmitLogger) Fields(fields map[string]interface{}) Logger {
-	return w.l.Fields(fields)
+func (w *OmitLogger) Fields(fields ...interface{}) Logger {
+	return w.l.Fields(fields...)
 }
 
 func (w *OmitLogger) Info(ctx context.Context, args ...interface{}) {

network/tunnel/broker/broker.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/unistack-org/micro/v3/broker"
 	"github.com/unistack-org/micro/v3/logger"
+	"github.com/unistack-org/micro/v3/metadata"
 	"github.com/unistack-org/micro/v3/network/transport"
 	"github.com/unistack-org/micro/v3/network/tunnel"
 )

util/jitter/random.go

@@ -7,8 +7,8 @@ import (
 	"github.com/unistack-org/micro/v3/util/rand"
 )
 
-// Do returns a random time to jitter with max cap specified
-func Do(d time.Duration) time.Duration {
+// Random returns a random time to jitter with max cap specified
+func Random(d time.Duration) time.Duration {
 	var rng rand.Rand
 	v := rng.Float64() * float64(d.Nanoseconds())
 	return time.Duration(v)

util/jitter/ticker.go

@@ -0,0 +1,65 @@
+package jitter
+
+import (
+	"time"
+
+	"github.com/unistack-org/micro/v3/util/rand"
+)
+
+// Ticker is similar to time.Ticker but ticks at random intervals between
+// the min and max duration values (stored internally as int64 nanosecond
+// counts).
+type Ticker struct {
+	C    chan time.Time
+	done chan chan struct{}
+	min  int64
+	max  int64
+	rng  rand.Rand
+}
+
+// NewTicker returns a pointer to an initialized instance of the Ticker.
+// Min and max are durations of the shortest and longest allowed
+// ticks. Ticker will run in a goroutine until explicitly stopped.
+func NewTicker(min, max time.Duration) *Ticker {
+	ticker := &Ticker{
+		C:    make(chan time.Time),
+		done: make(chan chan struct{}),
+		min:  min.Nanoseconds(),
+		max:  max.Nanoseconds(),
+	}
+	go ticker.run()
+	return ticker
+}
+
+// Stop terminates the ticker goroutine and closes the C channel.
+func (ticker *Ticker) Stop() {
+	c := make(chan struct{})
+	ticker.done <- c
+	<-c
+}
+
+func (ticker *Ticker) run() {
+	defer close(ticker.C)
+	t := time.NewTimer(ticker.nextInterval())
+	for {
+		// either a stop signal or a timeout
+		select {
+		case c := <-ticker.done:
+			t.Stop()
+			close(c)
+			return
+		case <-t.C:
+			select {
+			case ticker.C <- time.Now():
+				t.Stop()
+				t = time.NewTimer(ticker.nextInterval())
+			default:
+				// there could be noone receiving...
+			}
+		}
+	}
+}
+
+func (ticker *Ticker) nextInterval() time.Duration {
+	return time.Duration(ticker.rng.Int63n(ticker.max-ticker.min)+ticker.min) * time.Nanosecond
+}