Compare commits
11 Commits
Author | SHA1 | Date | |
---|---|---|---|
a3f79a7bed | |||
72c01fe7c9 | |||
bd6ebc31d6 | |||
9c5c08c188 | |||
6bb29d8d0e | |||
c069636bf3 | |||
a34c33e25b | |||
fdffd31ed3 | |||
1a3daf4263 | |||
a7932622b2 | |||
300d1fe705 |
2
.github/workflows/codeql-analysis.yml
vendored
2
.github/workflows/codeql-analysis.yml
vendored
@@ -47,7 +47,7 @@ jobs:
|
|||||||
- name: setup
|
- name: setup
|
||||||
uses: actions/setup-go@v3
|
uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version: 1.17
|
go-version: 1.20
|
||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: init
|
- name: init
|
||||||
uses: github/codeql-action/init@v2
|
uses: github/codeql-action/init@v2
|
||||||
|
11
go.mod
11
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
|
go 1.20
|
||||||
|
|
||||||
require go.unistack.org/micro/v3 v3.10.66
|
require go.unistack.org/micro/v4 v4.0.17
|
||||||
|
|
||||||
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
|
|
||||||
)
|
|
||||||
|
15
go.sum
15
go.sum
@@ -1,13 +1,2 @@
|
|||||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
go.unistack.org/micro/v4 v4.0.17 h1:mF7uM+J4ILdG+1fcwzKYCwDlxhdbF/e1WnGzKKLnIXc=
|
||||||
go.unistack.org/micro/v3 v3.10.66 h1:tiG8HnyTC71IZWSC2qT/DmLhJinZJL9qvw+4Fvpm3d4=
|
go.unistack.org/micro/v4 v4.0.17/go.mod h1:ZDgU9931vm2l7X6RN/6UuwRIVp24GRdmQ7dKmegArk4=
|
||||||
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=
|
|
||||||
|
149
requestid.go
149
requestid.go
@@ -1,22 +1,21 @@
|
|||||||
package requestid // import "go.unistack.org/micro-wrapper-requestid/v3"
|
package requestid
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"net/textproto"
|
"net/textproto"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/client"
|
"go.unistack.org/micro/v4/client"
|
||||||
"go.unistack.org/micro/v3/logger"
|
"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() {
|
func init() {
|
||||||
requestIDLog := strings.ToLower(DefaultMetadataKey)
|
|
||||||
logger.DefaultContextAttrFuncs = append(logger.DefaultContextAttrFuncs, func(ctx context.Context) []interface{} {
|
logger.DefaultContextAttrFuncs = append(logger.DefaultContextAttrFuncs, func(ctx context.Context) []interface{} {
|
||||||
if v, ok := ctx.Value(XRequestIDKey{}).(string); ok {
|
if v, ok := ctx.Value(XRequestIDKey{}).(string); ok {
|
||||||
return []interface{}{requestIDLog, v}
|
return []interface{}{DefaultMetadataKey, v}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
@@ -24,126 +23,92 @@ func init() {
|
|||||||
|
|
||||||
type XRequestIDKey struct{}
|
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 xid string
|
||||||
|
var err error
|
||||||
|
|
||||||
cid, cok := ctx.Value(XRequestIDKey{}).(string)
|
if _, ok := ctx.Value(XRequestIDKey{}).(string); !ok {
|
||||||
if cok && cid != "" {
|
|
||||||
xid = cid
|
|
||||||
}
|
|
||||||
|
|
||||||
imd, iok := metadata.FromIncomingContext(ctx)
|
|
||||||
if !iok || imd == nil {
|
|
||||||
imd = metadata.New(1)
|
|
||||||
ctx = metadata.NewIncomingContext(ctx, imd)
|
|
||||||
}
|
|
||||||
|
|
||||||
omd, ook := metadata.FromOutgoingContext(ctx)
|
|
||||||
if !ook || omd == nil {
|
|
||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if xid == "" {
|
|
||||||
var err error
|
|
||||||
xid, err = id.New()
|
xid, err = id.New()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ctx, err
|
return ctx, err
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if !cok {
|
|
||||||
ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
|
ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !iok {
|
imd, ok := metadata.FromIncomingContext(ctx)
|
||||||
|
if !ok {
|
||||||
|
imd = metadata.New(1)
|
||||||
|
imd.Set(DefaultMetadataKey, xid)
|
||||||
|
ctx = metadata.NewIncomingContext(ctx, imd)
|
||||||
|
} else if _, ok = imd.Get(DefaultMetadataKey); !ok {
|
||||||
imd.Set(DefaultMetadataKey, xid)
|
imd.Set(DefaultMetadataKey, xid)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !ook {
|
omd, ok := metadata.FromOutgoingContext(ctx)
|
||||||
|
if !ok {
|
||||||
|
omd = metadata.New(1)
|
||||||
|
omd.Set(DefaultMetadataKey, xid)
|
||||||
|
ctx = metadata.NewOutgoingContext(ctx, imd)
|
||||||
|
} else if _, ok = omd.Get(DefaultMetadataKey); !ok {
|
||||||
omd.Set(DefaultMetadataKey, xid)
|
omd.Set(DefaultMetadataKey, xid)
|
||||||
}
|
}
|
||||||
|
|
||||||
return ctx, nil
|
return ctx, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
type Hook struct{}
|
type wrapper struct {
|
||||||
|
client.Client
|
||||||
|
}
|
||||||
|
|
||||||
var Wrapper = &Hook{}
|
func NewClientWrapper() client.Wrapper {
|
||||||
|
return func(c client.Client) client.Client {
|
||||||
func (w *Hook) ServerSubscriber(next server.FuncSubHandler) server.FuncSubHandler {
|
handler := &wrapper{
|
||||||
return func(ctx context.Context, msg server.Message) error {
|
Client: c,
|
||||||
var err error
|
|
||||||
if xid, ok := msg.Header()[DefaultMetadataKey]; ok {
|
|
||||||
ctx = context.WithValue(ctx, XRequestIDKey{}, xid)
|
|
||||||
}
|
}
|
||||||
if ctx, err = DefaultMetadataFunc(ctx); err != nil {
|
return handler
|
||||||
return err
|
|
||||||
}
|
|
||||||
return next(ctx, msg)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Hook) ServerHandler(next server.FuncHandler) server.FuncHandler {
|
func NewClientCallWrapper() client.CallWrapper {
|
||||||
return func(ctx context.Context, req server.Request, rsp interface{}) error {
|
return func(fn client.CallFunc) client.CallFunc {
|
||||||
var err error
|
return func(ctx context.Context, addr string, req client.Request, rsp interface{}, opts client.CallOptions) error {
|
||||||
if ctx, err = DefaultMetadataFunc(ctx); err != nil {
|
var err error
|
||||||
return err
|
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 {
|
func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{}, opts ...options.Option) error {
|
||||||
return func(ctx context.Context, msgs []client.Message, opts ...client.PublishOption) 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
|
|
||||||
}
|
|
||||||
return next(ctx, msgs, opts...)
|
|
||||||
}
|
}
|
||||||
|
return w.Client.Call(ctx, req, rsp, opts...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Hook) ClientPublish(next client.FuncPublish) client.FuncPublish {
|
func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...options.Option) (client.Stream, error) {
|
||||||
return func(ctx context.Context, msg client.Message, opts ...client.PublishOption) 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 err
|
|
||||||
}
|
|
||||||
return next(ctx, msg, opts...)
|
|
||||||
}
|
}
|
||||||
|
return w.Client.Stream(ctx, req, opts...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *Hook) ClientCall(next client.FuncCall) client.FuncCall {
|
func NewServerHandlerWrapper() server.HandlerWrapper {
|
||||||
return func(ctx context.Context, req client.Request, rsp interface{}, opts ...client.CallOption) error {
|
return func(fn server.HandlerFunc) server.HandlerFunc {
|
||||||
var err error
|
return func(ctx context.Context, req server.Request, rsp interface{}) error {
|
||||||
if ctx, err = DefaultMetadataFunc(ctx); err != nil {
|
var err error
|
||||||
return err
|
if ctx, err = DefaultMetadataFunc(ctx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return fn(ctx, req, rsp)
|
||||||
}
|
}
|
||||||
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...)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -4,30 +4,34 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/metadata"
|
"go.unistack.org/micro/v4/metadata"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestDefaultMetadataFunc(t *testing.T) {
|
func TestDefaultMetadataFunc(t *testing.T) {
|
||||||
ctx := context.TODO()
|
ctx := context.TODO()
|
||||||
|
var err error
|
||||||
|
|
||||||
nctx, err := DefaultMetadataFunc(ctx)
|
ctx, err = DefaultMetadataFunc(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("%v", err)
|
t.Fatalf("%v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
imd, ok := metadata.FromIncomingContext(nctx)
|
imd, ok := metadata.FromIncomingContext(ctx)
|
||||||
if !ok {
|
if !ok {
|
||||||
t.Fatalf("md missing in incoming context")
|
t.Fatalf("md missing in incoming context")
|
||||||
}
|
}
|
||||||
omd, ok := metadata.FromOutgoingContext(nctx)
|
omd, ok := metadata.FromOutgoingContext(ctx)
|
||||||
if !ok {
|
if !ok {
|
||||||
t.Fatalf("md missing in outgoing context")
|
t.Fatalf("md missing in outgoing context")
|
||||||
}
|
}
|
||||||
|
|
||||||
_, iok := imd.Get(DefaultMetadataKey)
|
iv, iok := imd.Get(DefaultMetadataKey)
|
||||||
_, ook := omd.Get(DefaultMetadataKey)
|
ov, 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")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user