2 Commits

Author SHA1 Message Date
a12fb08b7e Merge pull request 'add request id in context' (#99) from rq into v3
Some checks failed
codeql / analyze (go) (push) Failing after 3m9s
build / test (push) Failing after 1m28s
build / lint (push) Failing after 2m38s
Reviewed-on: #99
2023-08-23 16:31:27 +03:00
d03bf1aa14 insert request id in context
Some checks failed
codeql / analyze (go) (pull_request) Failing after 3m15s
dependabot-automerge / automerge (pull_request) Has been skipped
prbuild / test (pull_request) Failing after 1m29s
prbuild / lint (pull_request) Failing after 2m37s
autoapprove / autoapprove (pull_request) Failing after 1m26s
automerge / automerge (pull_request) Failing after 4s
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2023-08-23 16:30:47 +03:00
4 changed files with 76 additions and 60 deletions

8
go.mod
View File

@@ -1,7 +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.14 require go.unistack.org/micro/v3 v3.10.19
require golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect

11
go.sum
View File

@@ -1,4 +1,7 @@
go.unistack.org/micro/v4 v4.0.14 h1:zN+aVfTceei3TPzuA7f2wAXLYHoSHWpx2XgW8yqaTIA= github.com/imdario/mergo v0.3.14/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
go.unistack.org/micro/v4 v4.0.14/go.mod h1:ZDgU9931vm2l7X6RN/6UuwRIVp24GRdmQ7dKmegArk4= github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI= github.com/silas/dag v0.0.0-20211117232152-9d50aa809f35/go.mod h1:7RTUFBdIRC9nZ7/3RyRNH1bdqIShrDejd1YbLwgPS+I=
golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo= 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=

View File

@@ -1,64 +1,50 @@
package requestid package requestid // import "go.unistack.org/micro-wrapper-requestid/v3"
import ( import (
"context" "context"
"net/textproto" "net/textproto"
"go.unistack.org/micro/v4/client" "go.unistack.org/micro/v3/client"
"go.unistack.org/micro/v4/logger" "go.unistack.org/micro/v3/metadata"
"go.unistack.org/micro/v4/metadata" "go.unistack.org/micro/v3/server"
"go.unistack.org/micro/v4/options" "go.unistack.org/micro/v3/util/id"
"go.unistack.org/micro/v4/server"
"go.unistack.org/micro/v4/util/id"
) )
func init() { var XRequestIDKey struct{}
logger.DefaultContextAttrFuncs = append(logger.DefaultContextAttrFuncs, func(ctx context.Context) []interface{} {
if v, ok := ctx.Value(XRequestIDKey{}).(string); ok {
return []interface{}{DefaultMetadataKey, v}
}
return nil
})
}
type XRequestIDKey struct{} // DefaultMetadataKey contains metadata key
// DefaultMetadataKey contains metadata key x-request-id
var DefaultMetadataKey = textproto.CanonicalMIMEHeaderKey("x-request-id") var DefaultMetadataKey = textproto.CanonicalMIMEHeaderKey("x-request-id")
// DefaultMetadataFunc wil be used if user not provide own func to fill metadata // DefaultMetadataFunc wil be used if user not provide own func to fill metadata
var DefaultMetadataFunc = func(ctx context.Context) (context.Context, error) { var DefaultMetadataFunc = func(ctx context.Context) (context.Context, error) {
var xid string
var err error
if _, ok := ctx.Value(XRequestIDKey{}).(string); !ok {
xid, err = id.New()
if err != nil {
return ctx, err
}
ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
}
imd, ok := metadata.FromIncomingContext(ctx) imd, ok := metadata.FromIncomingContext(ctx)
if !ok { if !ok {
imd = metadata.New(1) imd = metadata.New(1)
imd.Set(DefaultMetadataKey, xid)
ctx = metadata.NewIncomingContext(ctx, imd)
} else if _, ok = imd.Get(DefaultMetadataKey); !ok {
imd.Set(DefaultMetadataKey, xid)
} }
omd, ok := metadata.FromOutgoingContext(ctx) omd, ok := metadata.FromOutgoingContext(ctx)
if !ok { if !ok {
omd = metadata.New(1) omd = metadata.New(1)
omd.Set(DefaultMetadataKey, xid)
ctx = metadata.NewOutgoingContext(ctx, imd)
} else if _, ok = omd.Get(DefaultMetadataKey); !ok {
omd.Set(DefaultMetadataKey, xid)
} }
v, iok := imd.Get(DefaultMetadataKey)
if iok {
if _, ook := omd.Get(DefaultMetadataKey); ook {
return ctx, nil return ctx, nil
} }
}
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)
return context.WithValue(ctx, XRequestIDKey, v), nil
}
type wrapper struct { type wrapper struct {
client.Client client.Client
@@ -85,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 var err error
if ctx, err = DefaultMetadataFunc(ctx); err != nil { if ctx, err = DefaultMetadataFunc(ctx); err != nil {
return err return err
@@ -93,7 +79,7 @@ func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{},
return w.Client.Call(ctx, req, rsp, opts...) 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 var err error
if ctx, err = DefaultMetadataFunc(ctx); err != nil { if ctx, err = DefaultMetadataFunc(ctx); err != nil {
return nil, err return nil, err
@@ -101,6 +87,14 @@ func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...option
return w.Client.Stream(ctx, req, opts...) 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 { func NewServerHandlerWrapper() server.HandlerWrapper {
return func(fn server.HandlerFunc) server.HandlerFunc { return func(fn server.HandlerFunc) server.HandlerFunc {
return func(ctx context.Context, req server.Request, rsp interface{}) error { return func(ctx context.Context, req server.Request, rsp interface{}) error {
@@ -112,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)
}
}
}

View File

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