feat: refactor provider clients to inject default app headers automatically (#235)

- Move DefaultHeaderTransport and NewHeaders utilities into a shared core/transport package
- Add automatic injection of x-app-name and x-app-version headers to outgoing HTTP requests using values from the version package
- Inject default headers in provider clients (Anthropic, Gemini, OpenAI) by wrapping HTTP client transports with DefaultHeaderTransport
- Remove duplicated DefaultHeaderTransport and NewHeaders implementations from provider code
- Set and use the App field in the version package for branding in headers

Signed-off-by: appleboy <[email protected]>

Author: appleboy

core/transport/headers.go

@@ -0,0 +1,21 @@
+package transport
+
+import (
+	"net/http"
+	"strings"
+)
+
+// NewHeaders creates a new http.Header from the given slice of headers.
+// Each header in the slice should be in the format "key=value".
+// If a header is not in the correct format, it is skipped.
+func NewHeaders(headers []string) http.Header {
+	h := make(http.Header)
+	for _, header := range headers {
+		vals := strings.Split(header, "=")
+		if len(vals) != 2 {
+			continue
+		}
+		h.Add(vals[0], vals[1])
+	}
+	return h
+}

core/transport/transport.go

@@ -0,0 +1,30 @@
+package transport
+
+import (
+	"net/http"
+)
+
+// DefaultHeaderTransport is an http.RoundTripper that adds the given headers to each request,
+// and always injects x-app-name and x-app-version headers.
+type DefaultHeaderTransport struct {
+	Origin     http.RoundTripper
+	Header     http.Header
+	AppName    string
+	AppVersion string
+}
+
+// RoundTrip implements the http.RoundTripper interface.
+func (t *DefaultHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+	for key, values := range t.Header {
+		for _, value := range values {
+			req.Header.Add(key, value)
+		}
+	}
+	if t.AppName != "" {
+		req.Header.Set("x-app-name", t.AppName)
+	}
+	if t.AppVersion != "" {
+		req.Header.Set("x-app-version", t.AppVersion)
+	}
+	return t.Origin.RoundTrip(req)
+}

provider/anthropic/anthropic.go

@@ -5,10 +5,11 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"net/http"
 
 	"github.com/appleboy/CodeGPT/core"
+	"github.com/appleboy/CodeGPT/core/transport"
 	"github.com/appleboy/CodeGPT/proxy"
+	"github.com/appleboy/CodeGPT/version"
 
 	"github.com/appleboy/com/convert"
 	"github.com/liushuangls/go-anthropic/v2"
@@ -115,35 +116,7 @@ func (c *Client) GetSummaryPrefix(ctx context.Context, content string) (*core.Re
 	}, nil
 }
 
-// DefaultHeaderTransport is an http.RoundTripper that adds the given headers to
-type DefaultHeaderTransport struct {
-	Origin http.RoundTripper
-	Header http.Header
-}
-
-// RoundTrip implements the http.RoundTripper interface.
-func (t *DefaultHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error) {
-	for key, values := range t.Header {
-		for _, value := range values {
-			req.Header.Add(key, value)
-		}
-	}
-	return t.Origin.RoundTrip(req)
-}
-
 // New creates a new Client instance with the provided options.
-// It validates the configuration, sets up the HTTP transport with optional
-// proxy settings, and initializes the Client with the specified parameters.
-//
-// Parameters:
-//
-//	opts - A variadic list of Option functions to configure the Client.
-//
-// Returns:
-//
-//	c - A pointer to the newly created Client instance.
-//	err - An error if the configuration is invalid or if there is an issue
-//	      setting up the HTTP transport or proxy.
 func New(opts ...Option) (c *Client, err error) {
 	// Create a new config object with the given options.
 	cfg := newConfig(opts...)
@@ -163,6 +136,14 @@ func New(opts ...Option) (c *Client, err error) {
 		return nil, fmt.Errorf("can't create a new HTTP client: %w", err)
 	}
 
+	// Inject x-app-name and x-app-version headers using core/transport.DefaultHeaderTransport
+	httpClient.Transport = &transport.DefaultHeaderTransport{
+		Origin:     httpClient.Transport,
+		Header:     nil,
+		AppName:    version.App,
+		AppVersion: version.Version,
+	}
+
 	// Create a new client instance with the necessary fields.
 	engine := &Client{
 		client: anthropic.NewClient(

provider/gemini/gemini.go

@@ -3,9 +3,12 @@ package gemini
 import (
 	"context"
 	"fmt"
+	"net/http"
 	"strings"
 
 	"github.com/appleboy/CodeGPT/core"
+	"github.com/appleboy/CodeGPT/core/transport"
+	"github.com/appleboy/CodeGPT/version"
 	"github.com/appleboy/com/convert"
 
 	"github.com/google/generative-ai-go/genai"
@@ -117,7 +120,17 @@ func New(ctx context.Context, opts ...Option) (c *Client, err error) {
 		temperature: cfg.temperature,
 	}
 
-	client, err := genai.NewClient(ctx, option.WithAPIKey(cfg.token))
+	// Inject x-app-name and x-app-version headers using core/transport.DefaultHeaderTransport
+	httpClient := &http.Client{
+		Transport: &transport.DefaultHeaderTransport{
+			Origin:     http.DefaultTransport,
+			Header:     nil,
+			AppName:    version.App,
+			AppVersion: version.Version,
+		},
+	}
+
+	client, err := genai.NewClient(ctx, option.WithAPIKey(cfg.token), option.WithHTTPClient(httpClient))
 	if err != nil {
 		return nil, err
 	}

provider/openai/client.go

@@ -7,7 +7,9 @@ import (
 	"strings"
 
 	"github.com/appleboy/CodeGPT/core"
+	"github.com/appleboy/CodeGPT/core/transport"
 	"github.com/appleboy/CodeGPT/proxy"
+	"github.com/appleboy/CodeGPT/version"
 
 	openai "github.com/sashabaranov/go-openai"
 )
@@ -19,23 +21,13 @@ var _ core.Generative = (*Client)(nil)
 
 // Client is a struct that represents an OpenAI client.
 type Client struct {
-	client      *openai.Client
-	model       string
-	maxTokens   int
-	temperature float32
-
-	// An alternative to sampling with temperature, called nucleus sampling,
-	// where the model considers the results of the tokens with top_p probability mass.
-	// So 0.1 means only the tokens comprising the top 10% probability mass are considered.
-	topP float32
-	// Number between -2.0 and 2.0.
-	// Positive values penalize new tokens based on whether they appear in the text so far,
-	// increasing the model's likelihood to talk about new topics.
-	presencePenalty float32
-	// Number between -2.0 and 2.0.
-	// Positive values penalize new tokens based on their existing frequency in the text so far,
-	// decreasing the model's likelihood to repeat the same line verbatim.
+	client           *openai.Client
+	model            string
+	maxTokens        int
+	temperature      float32
+	topP             float32
 	frequencyPenalty float32
+	presencePenalty  float32
 }
 
 type Response struct {
@@ -205,9 +197,12 @@ func New(opts ...Option) (*Client, error) {
 
 	// Create a new client instance with the necessary fields.
 	engine := &Client{
-		model:       cfg.model,
-		maxTokens:   cfg.maxTokens,
-		temperature: cfg.temperature,
+		model:            cfg.model,
+		maxTokens:        cfg.maxTokens,
+		temperature:      cfg.temperature,
+		topP:             cfg.topP,
+		frequencyPenalty: cfg.frequencyPenalty,
+		presencePenalty:  cfg.presencePenalty,
 	}
 
 	// Create a new OpenAI config object with the given API token and other optional fields.
@@ -230,6 +225,15 @@ func New(opts ...Option) (*Client, error) {
 		return nil, fmt.Errorf("can't create a new HTTP client: %w", err)
 	}
 
+	// Inject x-app-name and x-app-version headers using core/transport.DefaultHeaderTransport
+	// Always wrap the proxy's httpClient.Transport
+	httpClient.Transport = &transport.DefaultHeaderTransport{
+		Origin:     httpClient.Transport,
+		Header:     nil,
+		AppName:    version.App,
+		AppVersion: version.Version,
+	}
+
 	// Set the OpenAI client to use the default configuration with Azure-specific options, if the provider is Azure.
 	if cfg.provider == core.Azure {
 		defaultAzureConfig := openai.DefaultAzureConfig(cfg.token, cfg.baseURL)

provider/openai/openai.go

@@ -1,6 +1,7 @@
 package version
 
 var (
+	App       string = "CodeGPT"
 	Version   string
 	GitCommit string
 	BuildTime string