mirror of
https://github.com/go-kratos/kratos.git
synced 2025-02-13 13:48:51 +02:00
unify metadata header key
This commit is contained in:
parent
b59ec79e5c
commit
0edc2de268
@ -253,9 +253,6 @@ func (client *Client) Raw(c context.Context, req *xhttp.Request, v ...string) (b
|
||||
setTimeout(req, timeout)
|
||||
req = req.WithContext(c)
|
||||
setCaller(req)
|
||||
if color := metadata.String(c, metadata.Color); color != "" {
|
||||
setColor(req, color)
|
||||
}
|
||||
metadata.Range(c,
|
||||
func(key string, value interface{}) {
|
||||
setMetadata(req, key, value)
|
||||
|
@ -9,7 +9,7 @@ import (
|
||||
|
||||
"github.com/bilibili/kratos/pkg/conf/env"
|
||||
"github.com/bilibili/kratos/pkg/log"
|
||||
criticalityPkg "github.com/bilibili/kratos/pkg/net/criticality"
|
||||
"github.com/bilibili/kratos/pkg/net/criticality"
|
||||
"github.com/bilibili/kratos/pkg/net/metadata"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
@ -18,22 +18,50 @@ import (
|
||||
const (
|
||||
// http head
|
||||
_httpHeaderUser = "x1-bmspy-user"
|
||||
_httpHeaderColor = "x1-bmspy-color"
|
||||
_httpHeaderTimeout = "x1-bmspy-timeout"
|
||||
_httpHeaderMirror = "x1-bmspy-mirror"
|
||||
_httpHeaderRemoteIP = "x-backend-bm-real-ip"
|
||||
_httpHeaderRemoteIPPort = "x-backend-bm-real-ipport"
|
||||
_httpHeaderCriticality = "x-backend-bili-criticality"
|
||||
)
|
||||
|
||||
const (
|
||||
_httpHeaderMetadata = "x-bili-metadata-"
|
||||
_httpHeaderMetadata = "x-bm-metadata-"
|
||||
)
|
||||
|
||||
var _outgoingHeader = map[string]string{
|
||||
metadata.Color: _httpHeaderColor,
|
||||
metadata.Criticality: _httpHeaderCriticality,
|
||||
metadata.Mirror: _httpHeaderMirror,
|
||||
var _parser = map[string]func(string) interface{}{
|
||||
"mirror": func(mirrorStr string) interface{} {
|
||||
if mirrorStr == "" {
|
||||
return false
|
||||
}
|
||||
val, err := strconv.ParseBool(mirrorStr)
|
||||
if err != nil {
|
||||
log.Warn("blademaster: failed to parse mirror: %+v", errors.Wrap(err, mirrorStr))
|
||||
return false
|
||||
}
|
||||
if !val {
|
||||
log.Warn("blademaster: request mirrorStr value :%s is false", mirrorStr)
|
||||
}
|
||||
return val
|
||||
},
|
||||
"criticality": func(in string) interface{} {
|
||||
if crtl := criticality.Criticality(in); crtl != criticality.EmptyCriticality {
|
||||
return string(crtl)
|
||||
}
|
||||
return string(criticality.Critical)
|
||||
},
|
||||
}
|
||||
|
||||
func parseMetadataTo(req *http.Request, to metadata.MD) {
|
||||
for rawKey := range req.Header {
|
||||
key := strings.ReplaceAll(strings.TrimLeft(strings.ToLower(rawKey), _httpHeaderMetadata), "-", "_")
|
||||
rawValue := req.Header.Get(rawKey)
|
||||
var value interface{} = rawValue
|
||||
parser, ok := _parser[key]
|
||||
if ok {
|
||||
value = parser(rawValue)
|
||||
}
|
||||
to[key] = value
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func setMetadata(req *http.Request, key string, value interface{}) {
|
||||
@ -45,47 +73,11 @@ func setMetadata(req *http.Request, key string, value interface{}) {
|
||||
req.Header.Set(header, strV)
|
||||
}
|
||||
|
||||
// mirror return true if x-bmspy-mirror in http header and its value is 1 or true.
|
||||
func mirror(req *http.Request) bool {
|
||||
mirrorStr := req.Header.Get(_httpHeaderMirror)
|
||||
if mirrorStr == "" {
|
||||
return false
|
||||
}
|
||||
val, err := strconv.ParseBool(mirrorStr)
|
||||
if err != nil {
|
||||
log.Warn("blademaster: failed to parse mirror: %+v", errors.Wrap(err, mirrorStr))
|
||||
return false
|
||||
}
|
||||
if !val {
|
||||
log.Warn("blademaster: request mirrorStr value :%s is false", mirrorStr)
|
||||
}
|
||||
return val
|
||||
}
|
||||
|
||||
// setCaller set caller into http request.
|
||||
func setCaller(req *http.Request) {
|
||||
req.Header.Set(_httpHeaderUser, env.AppID)
|
||||
}
|
||||
|
||||
// caller get caller from http request.
|
||||
func caller(req *http.Request) string {
|
||||
return req.Header.Get(_httpHeaderUser)
|
||||
}
|
||||
|
||||
// setColor set color into http request.
|
||||
func setColor(req *http.Request, color string) {
|
||||
req.Header.Set(_httpHeaderColor, color)
|
||||
}
|
||||
|
||||
// color get color from http request.
|
||||
func color(req *http.Request) string {
|
||||
c := req.Header.Get(_httpHeaderColor)
|
||||
if c == "" {
|
||||
c = env.Color
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// setTimeout set timeout into http request.
|
||||
func setTimeout(req *http.Request, timeout time.Duration) {
|
||||
td := int64(timeout / time.Millisecond)
|
||||
@ -102,12 +94,6 @@ func timeout(req *http.Request) time.Duration {
|
||||
return time.Duration(timeout) * time.Millisecond
|
||||
}
|
||||
|
||||
// criticality get criticality from http request.
|
||||
func criticality(req *http.Request) criticalityPkg.Criticality {
|
||||
raw := req.Header.Get(_httpHeaderCriticality)
|
||||
return criticalityPkg.Parse(raw)
|
||||
}
|
||||
|
||||
// remoteIP implements a best effort algorithm to return the real client IP, it parses
|
||||
// x-backend-bm-real-ip or X-Real-IP or X-Forwarded-For in order to work properly with reverse-proxies such us: nginx or haproxy.
|
||||
// Use X-Forwarded-For before X-Real-Ip as nginx uses X-Real-Ip with the proxy's IP.
|
||||
|
@ -15,7 +15,7 @@ import (
|
||||
|
||||
"github.com/bilibili/kratos/pkg/conf/dsn"
|
||||
"github.com/bilibili/kratos/pkg/log"
|
||||
criticalityPkg "github.com/bilibili/kratos/pkg/net/criticality"
|
||||
"github.com/bilibili/kratos/pkg/net/criticality"
|
||||
"github.com/bilibili/kratos/pkg/net/ip"
|
||||
"github.com/bilibili/kratos/pkg/net/metadata"
|
||||
"github.com/bilibili/kratos/pkg/stat"
|
||||
@ -262,16 +262,11 @@ func (engine *Engine) handleContext(c *Context) {
|
||||
tm = ctm
|
||||
}
|
||||
md := metadata.MD{
|
||||
metadata.Color: color(req),
|
||||
metadata.RemoteIP: remoteIP(req),
|
||||
metadata.RemotePort: remotePort(req),
|
||||
metadata.Caller: caller(req),
|
||||
metadata.Mirror: mirror(req),
|
||||
metadata.Criticality: string(criticalityPkg.Critical),
|
||||
}
|
||||
if crtl := criticality(req); crtl != criticalityPkg.EmptyCriticality {
|
||||
md[metadata.Criticality] = string(crtl)
|
||||
metadata.Criticality: string(criticality.Critical),
|
||||
}
|
||||
parseMetadataTo(req, md)
|
||||
ctx := metadata.NewContext(context.Background(), md)
|
||||
if tm > 0 {
|
||||
c.Context, cancel = context.WithTimeout(ctx, tm)
|
||||
|
@ -87,7 +87,7 @@ func TestCriticality(t *testing.T) {
|
||||
for _, testCase := range tests {
|
||||
req, err := http.NewRequest("GET", uri(SockAddr, testCase.path), nil)
|
||||
assert.NoError(t, err)
|
||||
req.Header.Set(_httpHeaderCriticality, string(testCase.crtl))
|
||||
req.Header.Set("x-bm-metadata-criticality", string(testCase.crtl))
|
||||
resp, err := client.Do(req)
|
||||
assert.NoError(t, err)
|
||||
defer resp.Body.Close()
|
||||
@ -126,7 +126,7 @@ func TestNoneCriticality(t *testing.T) {
|
||||
for _, testCase := range tests {
|
||||
req, err := http.NewRequest("GET", uri(SockAddr, testCase.path), nil)
|
||||
assert.NoError(t, err)
|
||||
req.Header.Set(_httpHeaderCriticality, string(testCase.crtl))
|
||||
req.Header.Set("x-bm-metadata-criticality", string(testCase.crtl))
|
||||
resp, err := client.Do(req)
|
||||
assert.NoError(t, err)
|
||||
defer resp.Body.Close()
|
||||
|
Loading…
x
Reference in New Issue
Block a user