Skip to content

Commit 58187ad

Browse files
MarkDaoustcopybara-github
authored andcommitted
fix(interactions): align SDK User-Agent and x-goog-api-client headers
Replace the generator's default User-Agent with the parent SDK's `google-genai-sdk/<version> gl-<lang>/<version>` header across all languages while preserving caller-supplied User-Agent overrides. PiperOrigin-RevId: 1009148467
1 parent 5407437 commit 58187ad

3 files changed

Lines changed: 26 additions & 6 deletions

File tree

‎client.go‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -411,12 +411,15 @@ func newInteractionsClient(apiClient *InternalAPIClient) *interactions.GenAI {
411411
if cc.APIKey != "" {
412412
sec.APIKey = &cc.APIKey
413413
}
414+
headers := make(http.Header)
414415
if cc.HTTPOptions.Headers != nil {
415-
sec.DefaultHeaders = make(map[string]string)
416-
for key, values := range cc.HTTPOptions.Headers {
417-
if len(values) > 0 {
418-
sec.DefaultHeaders[key] = values[0]
419-
}
416+
headers = cc.HTTPOptions.Headers.Clone()
417+
}
418+
appendSDKHeaders(headers)
419+
sec.DefaultHeaders = make(map[string]string, len(headers))
420+
for key, values := range headers {
421+
if len(values) > 0 {
422+
sec.DefaultHeaders[key] = strings.Join(values, " ")
420423
}
421424
}
422425
if sec.APIKey != nil || len(sec.DefaultHeaders) > 0 {

‎interaction_test.go‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ func TestInteractionsWorkflow(t *testing.T) {
4444
if r.Method != "POST" {
4545
t.Errorf("Method unexpected: %s", r.Method)
4646
}
47+
ua := r.Header.Get("User-Agent")
48+
if !strings.HasPrefix(ua, "google-genai-sdk/") || !strings.Contains(ua, "gl-go/") {
49+
t.Errorf("Unexpected User-Agent header: %q", ua)
50+
}
51+
apiClient := r.Header.Get("X-Goog-Api-Client")
52+
if apiClient != ua {
53+
t.Errorf("Expected X-Goog-Api-Client %q to match User-Agent %q", apiClient, ua)
54+
}
4755

4856
// Return a mock response
4957
resp := map[string]any{
@@ -106,6 +114,14 @@ func TestInteractionsWorkflow_Vertex(t *testing.T) {
106114
if r.Method != "POST" {
107115
t.Errorf("Method unexpected: %s", r.Method)
108116
}
117+
ua := r.Header.Get("User-Agent")
118+
if !strings.HasPrefix(ua, "google-genai-sdk/") || !strings.Contains(ua, "gl-go/") {
119+
t.Errorf("Unexpected User-Agent header: %q", ua)
120+
}
121+
apiClient := r.Header.Get("X-Goog-Api-Client")
122+
if apiClient != ua {
123+
t.Errorf("Expected X-Goog-Api-Client %q to match User-Agent %q", apiClient, ua)
124+
}
109125

110126
// Return a mock response
111127
resp := map[string]any{

‎interactions/internal/hooks/google_genai_auth.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ func (h *GoogleGenAIAuthHook) BeforeRequest(hookCtx BeforeRequestContext, req *h
5353

5454
// Apply default headers
5555
for key, value := range security.DefaultHeaders {
56-
if req.Header.Get(key) == "" {
56+
existing := req.Header.Get(key)
57+
if existing == "" || (strings.EqualFold(key, "User-Agent") && existing == hookCtx.SDKConfiguration.UserAgent) {
5758
req.Header.Set(key, value)
5859
}
5960
}

0 commit comments

Comments
 (0)