-
Notifications
You must be signed in to change notification settings - Fork 41
/
user_agent.go
130 lines (110 loc) · 3.02 KB
/
user_agent.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
package useragent
import (
"context"
"fmt"
"os"
"runtime"
"strings"
"github.com/databricks/databricks-sdk-go/version"
"golang.org/x/mod/semver"
)
const (
RuntimeKey = "runtime"
CicdKey = "cicd"
AuthKey = "auth"
)
// WithProduct sets the product name and product version globally.
// It should be called by developers to differentiate their application from others.
func WithProduct(name, version string) {
if err := matchAlphanum(name); err != nil {
panic(err)
}
if err := matchSemVer(version); err != nil {
panic(err)
}
productName = name
productVersion = version
}
var productName = "unknown"
var productVersion = "0.0.0"
const sdkName = "databricks-sdk-go"
const sdkVersion = version.Version
// extra holds per-process static extra information
// bits, that are agreed upfront with Databricks.
var extra data
// private type for user agent info in the context
type key int
// context key for holding volatile part of user agent data
const ctxAgent key = 5
// WithUserAgentExtra sets per-process extra user agent data,
// which integration developers have agreed with Databricks.
func WithUserAgentExtra(key, value string) {
extra = extra.With(key, value)
}
func WithPartner(partner string) {
WithUserAgentExtra("partner", partner)
}
func getUpstreamUserAgentInfo() []info {
product := os.Getenv("DATABRICKS_SDK_UPSTREAM")
version := os.Getenv("DATABRICKS_SDK_UPSTREAM_VERSION")
if product == "" || version == "" {
return nil
}
return []info{
{"upstream", product},
{"upstream-version", version},
}
}
// InContext populates context with user agent dimension,
// usually to differentiate subsets of functionality and
// agreed with Databricks.
func InContext(ctx context.Context, key, value string) context.Context {
uac, _ := ctx.Value(ctxAgent).(data)
uac = uac.With(key, value)
return context.WithValue(ctx, ctxAgent, uac)
}
// FromContext gets compliant user-agent string in a given context
func FromContext(ctx context.Context) string {
base := data{
{productName, productVersion},
{sdkName, sdkVersion},
{"go", goVersion()},
{"os", runtime.GOOS},
}
base = append(base, extra...)
base = append(base, getUpstreamUserAgentInfo()...)
uac, _ := ctx.Value(ctxAgent).(data)
return append(base, uac...).String()
}
func goVersion() string {
gv := runtime.Version()
ssv := strings.ReplaceAll(gv, "go", "v")
sv := semver.Canonical(ssv)
return strings.TrimPrefix(sv, "v")
}
type info struct {
Key string
Value string
}
func (u info) String() string {
return fmt.Sprintf("%s/%s", u.Key, u.Value)
}
type data []info
// With always uses the latest value for a given alphanumeric key.
// Panics if key or value don't satisfy alphanumeric or semver format.
func (d data) With(key, value string) data {
if err := matchAlphanum(key); err != nil {
panic(err)
}
if err := matchAlphanumOrSemVer(value); err != nil {
panic(err)
}
return append(d, info{key, value})
}
func (d data) String() string {
pairs := []string{}
for _, v := range d {
pairs = append(pairs, v.String())
}
return strings.Join(pairs, " ")
}