Merge pull request 'insert request id in context' (#101) from rr into master

Reviewed-on: #101

.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/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

.gitignore

@@ -1,9 +1,3 @@
-# Develop tools
-/.vscode/
-/.idea/
-.idea
-.vscode
-
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -11,12 +5,6 @@
 *.so
 *.dylib
 
-# Folders
-_obj
-_test
-_build
-.DS_Store
-
 # Test binary, built with `go test -c`
 *.test
 

go.mod

@@ -1,12 +1,5 @@
-module go.unistack.org/micro-wrapper-requestid/v3
+module go.unistack.org/micro-wrapper-requestid/v4
 
 go 1.20
 
-require go.unistack.org/micro/v3 v3.10.66
-
-require (
-	golang.org/x/sys v0.19.0 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240415180920-8c6c420018be // indirect
-	google.golang.org/grpc v1.63.2 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
-)
+require go.unistack.org/micro/v4 v4.0.1

go.sum

@@ -1,13 +1,2 @@
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-go.unistack.org/micro/v3 v3.10.66 h1:tiG8HnyTC71IZWSC2qT/DmLhJinZJL9qvw+4Fvpm3d4=
-go.unistack.org/micro/v3 v3.10.66/go.mod h1:erMgt3Bl7vQQ0e9UpQyR5NlLiZ9pKeEJ9+1tfYFaqUg=
-golang.org/x/net v0.21.0 h1:AQyQV4dYCvJ7vGmJyKki9+PBdyvhkSd8EIx/qb0AYv4=
-golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
-golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20240415180920-8c6c420018be h1:LG9vZxsWGOmUKieR8wPAUR3u3MpnYFQZROPIMaXh7/A=
-google.golang.org/genproto/googleapis/rpc v0.0.0-20240415180920-8c6c420018be/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY=
-google.golang.org/grpc v1.63.2 h1:MUeiw1B2maTVZthpU5xvASfTh3LDbxHd6IJ6QQVU+xM=
-google.golang.org/grpc v1.63.2/go.mod h1:WAX/8DgncnokcFUldAxq7GeB5DXHDbMF+lLvDomNkRA=
-google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
-google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
+go.unistack.org/micro/v4 v4.0.1 h1:xo1IxbVfgh8i0eY0VeYa3cbb13u5n/Mxnp3FOgWD4Jo=
+go.unistack.org/micro/v4 v4.0.1/go.mod h1:p/J5UcSJjfHsWGT31uKoghQ5rUQZzQJBAFy+Z4+ZVMs=

requestid.go

@@ -1,138 +1,133 @@
-package requestid // import "go.unistack.org/micro-wrapper-requestid/v3"
+package requestid // import "go.unistack.org/micro-wrapper-requestid/v4"
 
 import (
 	"context"
-	"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"
 	"net/textproto"
+
+	"go.unistack.org/micro/v4/client"
+	"go.unistack.org/micro/v4/metadata"
+	"go.unistack.org/micro/v4/server"
+	"go.unistack.org/micro/v4/util/id"
 )
 
-type XRequestIDKey struct{}
+var XRequestIDKey struct{}
 
-// DefaultMetadataKey contains metadata key
+// DefaultMetadataKey contains metadata key x-request-id
 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
 	}
-
-	if !cok {
-		ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
-	}
-
-	if !iok {
-		imd.Set(DefaultMetadataKey, xid)
-	}
-
-	if !ook {
-		omd.Set(DefaultMetadataKey, xid)
-	}
-
+	imd.Set(DefaultMetadataKey, v)
+	omd.Set(DefaultMetadataKey, v)
+	ctx = context.WithValue(ctx, XRequestIDKey, v)
+	ctx = metadata.NewIncomingContext(ctx, imd)
+	ctx = metadata.NewOutgoingContext(ctx, omd)
 	return ctx, nil
 }
 
-type hook struct{}
-
-func NewHook() *hook {
-	return &hook{}
+type wrapper struct {
+	client.Client
 }
 
-func (w *hook) ServerSubscriber(next server.FuncSubHandler) server.FuncSubHandler {
-	return func(ctx context.Context, msg server.Message) error {
-		var err error
-		if xid, ok := msg.Header()[DefaultMetadataKey]; ok {
-			ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
+func NewClientWrapper() client.Wrapper {
+	return func(c client.Client) client.Client {
+		handler := &wrapper{
+			Client: c,
 		}
-		if ctx, err = DefaultMetadataFunc(ctx); err != nil {
-			return err
-		}
-		return next(ctx, msg)
+		return handler
 	}
 }
 
-func (w *hook) ServerHandler(next server.FuncHandler) server.FuncHandler {
-	return func(ctx context.Context, req server.Request, rsp interface{}) error {
-		var err error
-		if ctx, err = DefaultMetadataFunc(ctx); err != nil {
-			return err
+func NewClientCallWrapper() client.CallWrapper {
+	return func(fn client.CallFunc) client.CallFunc {
+		return func(ctx context.Context, addr string, req client.Request, rsp interface{}, opts client.CallOptions) error {
+			var err error
+			if ctx, err = DefaultMetadataFunc(ctx); err != nil {
+				return err
+			}
+			return fn(ctx, addr, req, rsp, opts)
 		}
-		return next(ctx, req, rsp)
 	}
 }
 
-func (w *hook) ClientBatchPublish(next client.FuncBatchPublish) client.FuncBatchPublish {
-	return func(ctx context.Context, msgs []client.Message, opts ...client.PublishOption) error {
-		var err error
-		if ctx, err = DefaultMetadataFunc(ctx); err != nil {
-			return err
+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
+	}
+	return w.Client.Call(ctx, req, rsp, opts...)
+}
+
+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
+	}
+	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 {
+			var err error
+			if ctx, err = DefaultMetadataFunc(ctx); err != nil {
+				return err
+			}
+			return fn(ctx, req, rsp)
 		}
-		return next(ctx, msgs, opts...)
 	}
 }
 
-func (w *hook) ClientPublish(next client.FuncPublish) client.FuncPublish {
-	return func(ctx context.Context, msg client.Message, opts ...client.PublishOption) error {
-		var err error
-		if ctx, err = DefaultMetadataFunc(ctx); err != nil {
-			return err
+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)
 		}
-		return next(ctx, msg, opts...)
-	}
-}
-
-func (w *hook) ClientCall(next client.FuncCall) client.FuncCall {
-	return func(ctx context.Context, req client.Request, rsp interface{}, opts ...client.CallOption) error {
-		var err error
-		if ctx, err = DefaultMetadataFunc(ctx); err != nil {
-			return err
-		}
-		return next(ctx, req, rsp, opts...)
-	}
-}
-
-func (w *hook) ClientStream(next client.FuncStream) client.FuncStream {
-	return func(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
-		}
-		return next(ctx, req, opts...)
 	}
 }

requestid_test.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"testing"
 
-	"go.unistack.org/micro/v3/metadata"
+	"go.unistack.org/micro/v4/metadata"
 )
 
 func TestDefaultMetadataFunc(t *testing.T) {