Skip to content
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

fix: Set Go SDK's User-Agent header #1285

Merged
merged 3 commits into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
9 changes: 8 additions & 1 deletion go/rtl/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,16 @@ func (s *AuthSession) Do(result interface{}, method, ver, path string, reqPars m
return err
}

// set content-type header
// set headers
req.Header.Add("Content-Type", contentTypeHeader)

if s.Config.AgentTag != "" {
req.Header.Set("User-Agent", s.Config.AgentTag)
}
if options != nil && options.AgentTag != "" {
req.Header.Set("User-Agent", options.AgentTag)
}

// set query params
setQuery(req.URL, reqPars)

Expand Down
64 changes: 64 additions & 0 deletions go/rtl/auth_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,70 @@ func TestAuthSession_Do_Authorization(t *testing.T) {
})
}

func TestAuthSession_Do_UserAgent(t *testing.T) {
const path = "/someMethod"
const apiVersion = "/4.0"

t.Run("Do() sets User-Agent header with AuthSession config's AgentTag", func(t *testing.T) {
mux := http.NewServeMux()
setupApi40Login(mux, foreverValidTestToken, http.StatusOK)
server := httptest.NewServer(mux)
defer server.Close()

mux.HandleFunc("/api"+apiVersion+path, func(w http.ResponseWriter, r *http.Request) {
userAgentHeader := r.Header.Get("User-Agent")
expectedHeader := "some-agent-tag"
if userAgentHeader != expectedHeader {
t.Errorf("User-Agent header not correct. got=%v want=%v", userAgentHeader, expectedHeader)
}
})

s := NewAuthSession(ApiSettings{
BaseUrl: server.URL,
ApiVersion: apiVersion,
AgentTag: "some-agent-tag",
})

var r string
err := s.Do(&r, "GET", apiVersion, path, nil, nil, nil)

if err != nil {
t.Errorf("Do() call failed: %v", err)
}
})

t.Run("Do() sets User-Agent header with Do's option's AgentTag, which will overwrite AuthSession config", func(t *testing.T) {
mux := http.NewServeMux()
setupApi40Login(mux, foreverValidTestToken, http.StatusOK)
server := httptest.NewServer(mux)
defer server.Close()

mux.HandleFunc("/api"+apiVersion+path, func(w http.ResponseWriter, r *http.Request) {
userAgentHeader := r.Header.Get("User-Agent")
expectedHeader := "new-agent-tag"
if userAgentHeader != expectedHeader {
t.Errorf("User-Agent header not correct. got=%v want=%v", userAgentHeader, expectedHeader)
}
})

s := NewAuthSession(ApiSettings{
BaseUrl: server.URL,
ApiVersion: apiVersion,
AgentTag: "some-agent-tag",
})

var r string
options := ApiSettings{
AgentTag: "new-agent-tag",
}
err := s.Do(&r, "GET", apiVersion, path, nil, nil, &options)

if err != nil {
t.Errorf("Do() call failed: %v", err)
}
})
}

func TestAuthSession_Do_Parse(t *testing.T) {
type stringStruct struct {
Field *string `json:"field"`
Expand Down