util/rand: add Shuffle func

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

.github/dependabot.yml

@@ -11,9 +11,16 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
 
   # Maintain dependencies for Golang
   - package-ecosystem: "gomod"
     directory: "/"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '34 1 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

SECURITY.md

@@ -0,0 +1,15 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 3.7.x   | :white_check_mark: |
+| < 3.7.0 | :x:                |
+
+## Reporting a Vulnerability
+
+If you find any issue, please create github issue in this repo

go.mod

@@ -9,6 +9,6 @@ require (
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/silas/dag v0.0.0-20210121180416-41cf55125c34
 	github.com/stretchr/testify v1.7.0
-	github.com/unistack-org/micro-proto v0.0.5
+	github.com/unistack-org/micro-proto v0.0.9
 	golang.org/x/net v0.0.0-20210510120150-4163338589ed
 )

go.sum

@@ -18,8 +18,8 @@ github.com/silas/dag v0.0.0-20210121180416-41cf55125c34/go.mod h1:7RTUFBdIRC9nZ7
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/unistack-org/micro-proto v0.0.5 h1:DIC97Hufa2nGjuvTsfToD9laEOKddWMRTzeCfBwJ1j8=
-github.com/unistack-org/micro-proto v0.0.5/go.mod h1:EuI7UlfGXmT1hy6WacULib9LbNgRnDYQvTCFoLgKM2I=
+github.com/unistack-org/micro-proto v0.0.9 h1:KrWLS4FUX7UAWNAilQf70uad6ZPf/0EudeddCXllRVc=
+github.com/unistack-org/micro-proto v0.0.9/go.mod h1:Cckwmzd89gvS7ThxzZp9kQR/EOdksFQcsTAtDDyKwrg=
 golang.org/x/net v0.0.0-20210510120150-4163338589ed h1:p9UgmWI9wKpfYmgaV/IZKGdXc5qEK45tDwwwDyjS26I=
 golang.org/x/net v0.0.0-20210510120150-4163338589ed/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -30,8 +30,8 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
-google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
+google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=

logger/default.go

@@ -11,15 +11,6 @@ import (
 	"time"
 )
 
-func init() {
-	lvl, err := GetLevel(os.Getenv("MICRO_LOG_LEVEL"))
-	if err != nil {
-		lvl = InfoLevel
-	}
-
-	DefaultLogger = NewLogger(WithLevel(lvl))
-}
-
 type defaultLogger struct {
 	enc  *json.Encoder
 	opts Options
@@ -48,6 +39,28 @@ func (l *defaultLogger) String() string {
 	return "micro"
 }
 
+func (l *defaultLogger) Clone(opts ...Option) Logger {
+	newopts := NewOptions(opts...)
+	oldopts := l.opts
+	for _, o := range opts {
+		o(&newopts)
+		o(&oldopts)
+	}
+
+	oldopts.Wrappers = newopts.Wrappers
+	l.Lock()
+	cl := &defaultLogger{opts: oldopts, logFunc: l.logFunc, logfFunc: l.logfFunc}
+	l.Unlock()
+
+	// wrap the Log func
+	for i := len(newopts.Wrappers); i > 0; i-- {
+		cl.logFunc = newopts.Wrappers[i-1].Log(cl.logFunc)
+		cl.logfFunc = newopts.Wrappers[i-1].Logf(cl.logfFunc)
+	}
+
+	return cl
+}
+
 func (l *defaultLogger) V(level Level) bool {
 	l.RLock()
 	ok := l.opts.Level.Enabled(level)
@@ -55,6 +68,12 @@ func (l *defaultLogger) V(level Level) bool {
 	return ok
 }
 
+func (l *defaultLogger) Level(level Level) {
+	l.Lock()
+	l.opts.Level = level
+	l.Unlock()
+}
+
 func (l *defaultLogger) Fields(fields ...interface{}) Logger {
 	nl := &defaultLogger{opts: l.opts, enc: l.enc}
 	if len(fields) == 0 {

logger/level.go

@@ -1,24 +1,20 @@
 package logger
 
-import (
-	"fmt"
-)
-
 // Level means logger level
 type Level int8
 
 const (
-	// TraceLevel level. Designates finer-grained informational events than the Debug.
+	// TraceLevel level usually used to find bugs, very verbose
 	TraceLevel Level = iota - 2
-	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
+	// DebugLevel level used only when enabled debugging
 	DebugLevel
-	// InfoLevel level. General operational entries about what's going on inside the application.
+	// InfoLevel level used for general info about what's going on inside the application
 	InfoLevel
-	// WarnLevel level. Non-critical entries that deserve eyes.
+	// WarnLevel level used for non-critical entries
 	WarnLevel
-	// ErrorLevel level. Used for errors that should definitely be noted.
+	// ErrorLevel level used for errors that should definitely be noted
 	ErrorLevel
-	// FatalLevel level. Logs and then calls `os.Exit(1)`. highest level of severity.
+	// FatalLevel level used for critical errors and then calls `os.Exit(1)`
 	FatalLevel
 )
 
@@ -38,7 +34,7 @@ func (l Level) String() string {
 	case FatalLevel:
 		return "fatal"
 	}
-	return ""
+	return "info"
 }
 
 // Enabled returns true if the given level is at or above this level.
@@ -46,22 +42,22 @@ func (l Level) Enabled(lvl Level) bool {
 	return lvl >= l
 }
 
-// GetLevel converts a level string into a logger Level value.
-// returns an error if the input string does not match known values.
-func GetLevel(levelStr string) (Level, error) {
-	switch levelStr {
+// ParseLevel converts a level string into a logger Level value.
+// returns an InfoLevel if the input string does not match known values.
+func ParseLevel(lvl string) Level {
+	switch lvl {
 	case TraceLevel.String():
-		return TraceLevel, nil
+		return TraceLevel
 	case DebugLevel.String():
-		return DebugLevel, nil
+		return DebugLevel
 	case InfoLevel.String():
-		return InfoLevel, nil
+		return InfoLevel
 	case WarnLevel.String():
-		return WarnLevel, nil
+		return WarnLevel
 	case ErrorLevel.String():
-		return ErrorLevel, nil
+		return ErrorLevel
 	case FatalLevel.String():
-		return FatalLevel, nil
+		return FatalLevel
 	}
-	return InfoLevel, fmt.Errorf("unknown Level String: '%s', use InfoLevel", levelStr)
+	return InfoLevel
 }

logger/logger.go

@@ -1,11 +1,14 @@
 // Package logger provides a log interface
 package logger
 
-import "context"
+import (
+	"context"
+	"os"
+)
 
 var (
 	// DefaultLogger variable
-	DefaultLogger Logger = NewLogger()
+	DefaultLogger Logger = NewLogger(WithLevel(ParseLevel(os.Getenv("MICRO_LOG_LEVEL"))))
 	// DefaultLevel used by logger
 	DefaultLevel Level = InfoLevel
 	// DefaultCallerSkipCount used by logger
@@ -16,8 +19,12 @@ var (
 type Logger interface {
 	// Init initialises options
 	Init(opts ...Option) error
+	// Clone create logger copy with new options
+	Clone(opts ...Option) Logger
 	// V compare provided verbosity level with current log level
 	V(level Level) bool
+	// Level sets the log level for logger
+	Level(level Level)
 	// The Logger options
 	Options() Options
 	// Fields set fields to always be logged with keyval pairs

logger/logger_test.go

@@ -7,6 +7,27 @@ import (
 	"testing"
 )
 
+func TestClone(t *testing.T) {
+	ctx := context.TODO()
+	buf := bytes.NewBuffer(nil)
+	l := NewLogger(WithLevel(TraceLevel), WithOutput(buf))
+	if err := l.Init(); err != nil {
+		t.Fatal(err)
+	}
+	nl := l.Clone(WithLevel(ErrorLevel))
+	if err := nl.Init(); err != nil {
+		t.Fatal(err)
+	}
+	nl.Info(ctx, "info message")
+	if len(buf.Bytes()) != 0 {
+		t.Fatal("message must not be logged")
+	}
+	l.Info(ctx, "info message")
+	if len(buf.Bytes()) == 0 {
+		t.Fatal("message must be logged")
+	}
+}
+
 func TestRedirectStdLogger(t *testing.T) {
 	buf := bytes.NewBuffer(nil)
 	l := NewLogger(WithLevel(TraceLevel), WithOutput(buf))

logger/wrapper.go

@@ -20,9 +20,7 @@ type Wrapper interface {
 	Logf(LogfFunc) LogfFunc
 }
 
-var (
-	_ Logger = &OmitLogger{}
-)
+var _ Logger = &OmitLogger{}
 
 type OmitLogger struct {
 	l Logger
@@ -40,6 +38,14 @@ func (w *OmitLogger) V(level Level) bool {
 	return w.l.V(level)
 }
 
+func (w *OmitLogger) Level(level Level) {
+	w.l.Level(level)
+}
+
+func (w *OmitLogger) Clone(opts ...Option) Logger {
+	return w.l.Clone(opts...)
+}
+
 func (w *OmitLogger) Options() Options {
 	return w.l.Options()
 }

meter/handler/handler_micro.pb.go

@@ -14,7 +14,7 @@ var (
 	MeterName = "Meter"
 
 	MeterEndpoints = []api.Endpoint{
-		api.Endpoint{
+		{
 			Name:    "Meter.Metrics",
 			Path:    []string{"/metrics"},
 			Method:  []string{"GET"},

router/dns.go

@@ -53,7 +53,7 @@ func (d *dns) Lookup(opts ...QueryOption) ([]Route, error) {
 		for i, ip := range ips {
 			result[i] = Route{
 				Service: options.Service,
-				Address: fmt.Sprintf("%s:%d", ip, uint16(p)),
+				Address: fmt.Sprintf("%s:%d", ip, p),
 			}
 		}
 		return result, nil

server/health/health_micro.pb.go

@@ -14,19 +14,19 @@ var (
 	HealthName = "Health"
 
 	HealthEndpoints = []api.Endpoint{
-		api.Endpoint{
+		{
 			Name:    "Health.Live",
 			Path:    []string{"/live"},
 			Method:  []string{"GET"},
 			Handler: "rpc",
 		},
-		api.Endpoint{
+		{
 			Name:    "Health.Ready",
 			Path:    []string{"/ready"},
 			Method:  []string{"GET"},
 			Handler: "rpc",
 		},
-		api.Endpoint{
+		{
 			Name:    "Health.Version",
 			Path:    []string{"/version"},
 			Method:  []string{"GET"},

util/id/id.go

@@ -1,15 +1,19 @@
 package id
 
 import (
+	"context"
 	"crypto/rand"
 	"errors"
 	"math"
+
+	"github.com/unistack-org/micro/v3/logger"
 )
 
 // DefaultAlphabet is the alphabet used for ID characters by default
 var DefaultAlphabet = []rune("6789BCDFGHJKLMNPQRTWbcdfghjkmnpqrtwz")
 
 // DefaultSize is the size used for ID by default
+// To get uuid like collision specify 21
 var DefaultSize = 16
 
 // getMask generates bit mask used to obtain bits from the random bytes that are used to get index of random character
@@ -63,11 +67,11 @@ func New(opts ...Option) (string, error) {
 	}
 }
 
-// Must is the same as New but panics on error
+// Must is the same as New but fatals on error
 func Must(opts ...Option) string {
 	id, err := New(opts...)
 	if err != nil {
-		panic(err)
+		logger.Fatal(context.TODO(), err)
 	}
 	return id
 }

util/rand/rand.go

@@ -1,17 +1,17 @@
 package rand
 
 import (
-	"crypto/rand"
+	crand "crypto/rand"
 	"encoding/binary"
 )
 
-// Rand is a wrapper around crypto/rand that adds some convenience functions known from math/rand.
+// Rand is a wrapper around crypto/rand that adds some convenience functions known from math/rand
 type Rand struct {
 	buf [8]byte
 }
 
 func (r *Rand) Int31() int32 {
-	_, _ = rand.Read(r.buf[:4])
+	_, _ = crand.Read(r.buf[:4])
 	return int32(binary.BigEndian.Uint32(r.buf[:4]) & ^uint32(1<<31))
 }
 
@@ -54,11 +54,11 @@ func (r *Rand) Intn(n int) int {
 }
 
 func (r *Rand) Int63() int64 {
-	_, _ = rand.Read(r.buf[:])
+	_, _ = crand.Read(r.buf[:])
 	return int64(binary.BigEndian.Uint64(r.buf[:]) & ^uint64(1<<63))
 }
 
-// copied from the standard library math/rand implementation of Int63n
+// Int31n copied from the standard library math/rand implementation of Int31n
 func (r *Rand) Int31n(n int32) int32 {
 	if n&(n-1) == 0 { // n is power of two, can mask
 		return r.Int31() & (n - 1)
@@ -71,6 +71,7 @@ func (r *Rand) Int31n(n int32) int32 {
 	return v % n
 }
 
+// Int63n copied from the standard library math/rand implementation of Int63n
 func (r *Rand) Int63n(n int64) int64 {
 	if n&(n-1) == 0 { // n is power of two, can mask
 		return r.Int63() & (n - 1)
@@ -82,3 +83,26 @@ func (r *Rand) Int63n(n int64) int64 {
 	}
 	return v % n
 }
+
+// Shuffle copied from the standard library math/rand implementation of Shuffle
+func (r *Rand) Shuffle(n int, swap func(i, j int)) {
+	if n < 0 {
+		panic("invalid argument to Shuffle")
+	}
+
+	// Fisher-Yates shuffle: https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
+	// Shuffle really ought not be called with n that doesn't fit in 32 bits.
+	// Not only will it take a very long time, but with 2³¹! possible permutations,
+	// there's no way that any PRNG can have a big enough internal state to
+	// generate even a minuscule percentage of the possible permutations.
+	// Nevertheless, the right API signature accepts an int n, so handle it as best we can.
+	i := n - 1
+	for ; i > 1<<31-1-1; i-- {
+		j := int(r.Int63n(int64(i + 1)))
+		swap(i, j)
+	}
+	for ; i > 0; i-- {
+		j := int(r.Int31n(int32(i + 1)))
+		swap(i, j)
+	}
+}