micro/metadata/metadata.go

127 lines
2.6 KiB
Go
Raw Normal View History

2016-12-14 18:41:48 +03:00
// Package metadata is a way of defining message headers
2016-01-28 20:55:28 +03:00
package metadata
import (
2018-03-03 14:53:52 +03:00
"context"
2019-12-31 16:37:29 +03:00
"strings"
2016-01-28 20:55:28 +03:00
)
2020-04-12 13:16:08 +03:00
type metadataKey struct{}
2016-01-28 20:55:28 +03:00
2016-01-31 00:17:44 +03:00
// Metadata is our way of representing request headers internally.
// They're used at the RPC level and translate back and forth
// from Transport headers.
2016-01-28 20:55:28 +03:00
type Metadata map[string]string
2020-03-26 21:50:00 +03:00
func (md Metadata) Get(key string) (string, bool) {
// attempt to get as is
val, ok := md[key]
if ok {
return val, ok
}
// attempt to get lower case
val, ok = md[strings.Title(key)]
return val, ok
}
2020-04-12 13:17:23 +03:00
func (md Metadata) Set(key, val string) {
md[key] = val
}
func (md Metadata) Delete(key string) {
// delete key as-is
delete(md, key)
// delete also Title key
delete(md, strings.Title(key))
}
2019-10-26 01:27:59 +03:00
// Copy makes a copy of the metadata
2019-01-17 12:40:49 +03:00
func Copy(md Metadata) Metadata {
cmd := make(Metadata, len(md))
2019-01-17 12:40:49 +03:00
for k, v := range md {
cmd[k] = v
}
return cmd
}
// Delete key from metadata
func Delete(ctx context.Context, k string) context.Context {
return Set(ctx, k, "")
}
// Set add key with val to metadata
func Set(ctx context.Context, k, v string) context.Context {
md, ok := FromContext(ctx)
if !ok {
md = make(Metadata)
}
if v == "" {
delete(md, k)
} else {
md[k] = v
}
2020-04-12 13:16:08 +03:00
return context.WithValue(ctx, metadataKey{}, md)
}
// Get returns a single value from metadata in the context
func Get(ctx context.Context, key string) (string, bool) {
md, ok := FromContext(ctx)
if !ok {
return "", ok
}
2019-12-31 16:37:29 +03:00
// attempt to get as is
val, ok := md[key]
2019-12-31 16:37:29 +03:00
if ok {
return val, ok
}
// attempt to get lower case
val, ok = md[strings.Title(key)]
return val, ok
}
2019-10-26 01:27:59 +03:00
// FromContext returns metadata from the given context
2016-01-28 20:55:28 +03:00
func FromContext(ctx context.Context) (Metadata, bool) {
2020-04-12 13:16:08 +03:00
md, ok := ctx.Value(metadataKey{}).(Metadata)
2019-12-31 16:37:29 +03:00
if !ok {
return nil, ok
}
// capitalise all values
newMD := make(Metadata, len(md))
2019-12-31 16:37:29 +03:00
for k, v := range md {
newMD[strings.Title(k)] = v
}
return newMD, ok
2016-01-28 20:55:28 +03:00
}
2019-10-26 01:27:59 +03:00
// NewContext creates a new context with the given metadata
2016-01-28 20:55:28 +03:00
func NewContext(ctx context.Context, md Metadata) context.Context {
2020-04-12 13:16:08 +03:00
return context.WithValue(ctx, metadataKey{}, md)
2016-01-28 20:55:28 +03:00
}
2019-10-26 01:27:59 +03:00
// MergeContext merges metadata to existing metadata, overwriting if specified
func MergeContext(ctx context.Context, patchMd Metadata, overwrite bool) context.Context {
if ctx == nil {
ctx = context.Background()
}
2020-04-12 13:16:08 +03:00
md, _ := ctx.Value(metadataKey{}).(Metadata)
cmd := make(Metadata, len(md))
for k, v := range md {
cmd[k] = v
}
for k, v := range patchMd {
2019-10-25 18:27:28 +03:00
if _, ok := cmd[k]; ok && !overwrite {
// skip
} else if v != "" {
2019-10-25 18:27:28 +03:00
cmd[k] = v
} else {
delete(cmd, k)
2019-10-25 18:27:28 +03:00
}
}
2020-04-12 13:16:08 +03:00
return context.WithValue(ctx, metadataKey{}, cmd)
}