Skip to content

Support partners in SDK #925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions useragent/user_agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ 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")
Expand Down Expand Up @@ -114,19 +118,7 @@ func (d data) With(key, value string) data {
if err := matchAlphanumOrSemVer(value); err != nil {
panic(err)
}
var c data
var found bool
for _, i := range d {
if i.Key == key {
i.Value = value
found = true
}
c = append(c, i)
}
if !found {
c = append(c, info{key, value})
}
return c
return append(d, info{key, value})
}

func (d data) String() string {
Expand Down
12 changes: 10 additions & 2 deletions useragent/user_agent_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ func TestFromContext_Custom(t *testing.T) {
userAgent2 := FromContext(ctx2)

// tests may be developed and run on different versions of different things
expectedFormat := "unit-tests/0.0.1 databricks-sdk-go/%s go/%s os/%s pulumi/3.8.4 terraform/1.3.6 a/e"
expectedFormat := "unit-tests/0.0.1 databricks-sdk-go/%s go/%s os/%s pulumi/3.8.4 terraform/1.3.4 terraform/1.3.5 terraform/1.3.6 a/b a/d a/e"
expected := fmt.Sprintf(expectedFormat, version.Version, goVersion(), runtime.GOOS)
assert.Equal(t, expected, userAgent)

expectedFormat2 := "unit-tests/0.0.1 databricks-sdk-go/%s go/%s os/%s pulumi/3.8.4 terraform/1.3.6 a/f foo/bar"
expectedFormat2 := "unit-tests/0.0.1 databricks-sdk-go/%s go/%s os/%s pulumi/3.8.4 terraform/1.3.4 terraform/1.3.5 terraform/1.3.6 a/b a/d a/e a/f foo/bar"
expected2 := fmt.Sprintf(expectedFormat2, version.Version, goVersion(), runtime.GOOS)
assert.Equal(t, expected2, userAgent2)

Expand All @@ -74,3 +74,11 @@ func TestFromContext_Custom(t *testing.T) {
func TestDefaultsAreValid(t *testing.T) {
WithProduct(productName, productVersion)
}

func TestMultiplePartners(t *testing.T) {
WithPartner("partner1")
WithPartner("partner2")
userAgent := FromContext(context.Background())
assert.Contains(t, userAgent, "partner/partner1")
assert.Contains(t, userAgent, "partner/partner2")
}