Merge pull request 'add request id in context' (#99) from rq into v3

Reviewed-on: #99

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     - name: setup
       uses: actions/setup-go@v3
       with:
-        go-version: 1.20
+        go-version: 1.17
     - name: checkout
       uses: actions/checkout@v3
     - name: cache

.github/workflows/codeql-analysis.yml

@@ -47,7 +47,7 @@ jobs:
     - name: setup
       uses: actions/setup-go@v3
       with:
-        go-version: 1.20
+        go-version: 1.17
     # Initializes the CodeQL tools for scanning.
     - name: init
       uses: github/codeql-action/init@v2

.github/workflows/pr.yml

@@ -12,7 +12,7 @@ jobs:
     - name: setup
       uses: actions/setup-go@v3
       with:
-        go-version: 1.20
+        go-version: 1.17
     - name: checkout
       uses: actions/checkout@v3
     - name: cache

go.mod

@@ -1,5 +1,5 @@
-module go.unistack.org/micro-wrapper-requestid/v4
+module go.unistack.org/micro-wrapper-requestid/v3
 
-go 1.20
+go 1.16
 
-require go.unistack.org/micro/v4 v4.0.17
+require go.unistack.org/micro/v3 v3.10.19

go.sum

@@ -1,2 +1,7 @@
-go.unistack.org/micro/v4 v4.0.17 h1:mF7uM+J4ILdG+1fcwzKYCwDlxhdbF/e1WnGzKKLnIXc=
-go.unistack.org/micro/v4 v4.0.17/go.mod h1:ZDgU9931vm2l7X6RN/6UuwRIVp24GRdmQ7dKmegArk4=
+github.com/imdario/mergo v0.3.14/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
+github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
+github.com/silas/dag v0.0.0-20211117232152-9d50aa809f35/go.mod h1:7RTUFBdIRC9nZ7/3RyRNH1bdqIShrDejd1YbLwgPS+I=
+go.unistack.org/micro/v3 v3.10.19 h1:JtPacglETxHyb+GiuMdfxqGtnWSTYXPQm6PlDQfNIl8=
+go.unistack.org/micro/v3 v3.10.19/go.mod h1:XIArw29f0b3uvF4cq96X/nQt2f0J2OGnjh8J+DBbC0s=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

requestid.go

@@ -1,85 +1,49 @@
-package requestid
+package requestid // import "go.unistack.org/micro-wrapper-requestid/v3"
 
 import (
 	"context"
 	"net/textproto"
-	"strings"
 
-	"go.unistack.org/micro/v4/client"
-	"go.unistack.org/micro/v4/logger"
-	"go.unistack.org/micro/v4/metadata"
-	"go.unistack.org/micro/v4/options"
-	"go.unistack.org/micro/v4/server"
-	"go.unistack.org/micro/v4/util/id"
+	"go.unistack.org/micro/v3/client"
+	"go.unistack.org/micro/v3/metadata"
+	"go.unistack.org/micro/v3/server"
+	"go.unistack.org/micro/v3/util/id"
 )
 
-func init() {
-	requestIDLog := strings.ToLower(DefaultMetadataKey)
-	logger.DefaultContextAttrFuncs = append(logger.DefaultContextAttrFuncs, func(ctx context.Context) []interface{} {
-		if v, ok := ctx.Value(XRequestIDKey{}).(string); ok {
-			return []interface{}{requestIDLog, v}
-		}
-		return nil
-	})
-}
+var XRequestIDKey struct{}
 
-type XRequestIDKey struct{}
-
-// DefaultMetadataKey contains metadata key x-request-id
+// DefaultMetadataKey contains metadata key
 var DefaultMetadataKey = textproto.CanonicalMIMEHeaderKey("x-request-id")
 
 // DefaultMetadataFunc wil be used if user not provide own func to fill metadata
 var DefaultMetadataFunc = func(ctx context.Context) (context.Context, error) {
-	var xid string
-
-	cid, cok := ctx.Value(XRequestIDKey{}).(string)
-	if cok && cid != "" {
-		xid = cid
-	}
-
-	imd, iok := metadata.FromIncomingContext(ctx)
-	if !iok || imd == nil {
+	imd, ok := metadata.FromIncomingContext(ctx)
+	if !ok {
 		imd = metadata.New(1)
-		ctx = metadata.NewIncomingContext(ctx, imd)
 	}
-
-	omd, ook := metadata.FromOutgoingContext(ctx)
-	if !ook || omd == nil {
+	omd, ok := metadata.FromOutgoingContext(ctx)
+	if !ok {
 		omd = metadata.New(1)
-		ctx = metadata.NewOutgoingContext(ctx, omd)
 	}
-
-	if xid == "" {
-		var id string
-		if id, iok = imd.Get(DefaultMetadataKey); iok && id != "" {
-			xid = id
-		}
-		if id, ook = omd.Get(DefaultMetadataKey); ook && id != "" {
-			xid = id
+	v, iok := imd.Get(DefaultMetadataKey)
+	if iok {
+		if _, ook := omd.Get(DefaultMetadataKey); ook {
+			return ctx, nil
 		}
 	}
-
-	if xid == "" {
-		var err error
-		xid, err = id.New()
+	if !iok {
+		uid, err := id.New()
 		if err != nil {
 			return ctx, err
 		}
+		v = uid
 	}
+	imd.Set(DefaultMetadataKey, v)
+	omd.Set(DefaultMetadataKey, v)
+	ctx = metadata.NewIncomingContext(ctx, imd)
+	ctx = metadata.NewOutgoingContext(ctx, omd)
 
-	if !cok {
-		ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
-	}
-
-	if !iok {
-		imd.Set(DefaultMetadataKey, xid)
-	}
-
-	if !ook {
-		omd.Set(DefaultMetadataKey, xid)
-	}
-
-	return ctx, nil
+	return context.WithValue(ctx, XRequestIDKey, v), nil
 }
 
 type wrapper struct {
@@ -107,7 +71,7 @@ func NewClientCallWrapper() client.CallWrapper {
 	}
 }
 
-func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{}, opts ...options.Option) error {
+func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{}, opts ...client.CallOption) error {
 	var err error
 	if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 		return err
@@ -115,7 +79,7 @@ func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{},
 	return w.Client.Call(ctx, req, rsp, opts...)
 }
 
-func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...options.Option) (client.Stream, error) {
+func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...client.CallOption) (client.Stream, error) {
 	var err error
 	if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 		return nil, err
@@ -123,6 +87,14 @@ func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...option
 	return w.Client.Stream(ctx, req, opts...)
 }
 
+func (w *wrapper) Publish(ctx context.Context, msg client.Message, opts ...client.PublishOption) error {
+	var err error
+	if ctx, err = DefaultMetadataFunc(ctx); err != nil {
+		return err
+	}
+	return w.Client.Publish(ctx, msg, opts...)
+}
+
 func NewServerHandlerWrapper() server.HandlerWrapper {
 	return func(fn server.HandlerFunc) server.HandlerFunc {
 		return func(ctx context.Context, req server.Request, rsp interface{}) error {
@@ -134,3 +106,28 @@ func NewServerHandlerWrapper() server.HandlerWrapper {
 		}
 	}
 }
+
+func NewServerSubscriberWrapper() server.SubscriberWrapper {
+	return func(fn server.SubscriberFunc) server.SubscriberFunc {
+		return func(ctx context.Context, msg server.Message) error {
+			var err error
+			imd, ok := metadata.FromIncomingContext(ctx)
+			if !ok {
+				imd = metadata.New(1)
+			}
+			omd, ok := metadata.FromOutgoingContext(ctx)
+			if !ok {
+				omd = metadata.New(1)
+			}
+			if id, ok := msg.Header()[DefaultMetadataKey]; ok {
+				imd.Set(DefaultMetadataKey, id)
+				omd.Set(DefaultMetadataKey, id)
+				ctx = metadata.NewIncomingContext(ctx, imd)
+				ctx = metadata.NewOutgoingContext(ctx, omd)
+			} else if ctx, err = DefaultMetadataFunc(ctx); err != nil {
+				return err
+			}
+			return fn(ctx, msg)
+		}
+	}
+}

requestid_test.go

@@ -4,34 +4,30 @@ import (
 	"context"
 	"testing"
 
-	"go.unistack.org/micro/v4/metadata"
+	"go.unistack.org/micro/v3/metadata"
 )
 
 func TestDefaultMetadataFunc(t *testing.T) {
 	ctx := context.TODO()
-	var err error
 
-	ctx, err = DefaultMetadataFunc(ctx)
+	nctx, err := DefaultMetadataFunc(ctx)
 	if err != nil {
 		t.Fatalf("%v", err)
 	}
 
-	imd, ok := metadata.FromIncomingContext(ctx)
+	imd, ok := metadata.FromIncomingContext(nctx)
 	if !ok {
 		t.Fatalf("md missing in incoming context")
 	}
-	omd, ok := metadata.FromOutgoingContext(ctx)
+	omd, ok := metadata.FromOutgoingContext(nctx)
 	if !ok {
 		t.Fatalf("md missing in outgoing context")
 	}
 
-	iv, iok := imd.Get(DefaultMetadataKey)
-	ov, ook := omd.Get(DefaultMetadataKey)
+	_, iok := imd.Get(DefaultMetadataKey)
+	_, ook := omd.Get(DefaultMetadataKey)
 
 	if !iok || !ook {
 		t.Fatalf("missing metadata key value")
 	}
-	if iv != ov {
-		t.Fatalf("invalid metadata key value")
-	}
 }