mirror of
https://github.com/navidrome/navidrome.git
synced 2026-08-31 07:30:32 +00:00
3da2b590e7
* There has been a report about navidrome hitting listenbrainz hard
and the listenbrainz guys wanting to be able to distinguish navidrome
* feat: apply Navidrome User-Agent to all outgoing HTTP requests
Add utils/httpclient, a shared http.Client factory whose transport sets
the User-Agent header (Navidrome/{version} - https://github.com/navidrome)
on any request that does not already have one, and use it at every place
the server builds an HTTP client: Last.fm, ListenBrainz and Deezer agents
and auth routers, insights collector, backgrounds handler, and the plugin
host HTTP service. Plugin-set User-Agent values are preserved. The
per-request header lines from the previous commit are superseded by the
transport.
---------
Co-authored-by: Deluan <deluan@navidrome.org>
36 lines
929 B
Go
36 lines
929 B
Go
// Package httpclient provides a shared http.Client factory that identifies
|
|
// Navidrome via the User-Agent header on all outgoing requests.
|
|
package httpclient
|
|
|
|
import (
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/navidrome/navidrome/consts"
|
|
)
|
|
|
|
type uaTransport struct {
|
|
base http.RoundTripper
|
|
}
|
|
|
|
func (t *uaTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
if _, ok := req.Header["User-Agent"]; !ok {
|
|
req = req.Clone(req.Context())
|
|
req.Header.Set("User-Agent", consts.HTTPUserAgent)
|
|
}
|
|
return t.base.RoundTrip(req)
|
|
}
|
|
|
|
// NewTransport wraps base (or http.DefaultTransport if nil) to set the
|
|
// Navidrome User-Agent on requests that don't have one.
|
|
func NewTransport(base http.RoundTripper) http.RoundTripper {
|
|
if base == nil {
|
|
base = http.DefaultTransport
|
|
}
|
|
return &uaTransport{base: base}
|
|
}
|
|
|
|
func New(timeout time.Duration) *http.Client {
|
|
return &http.Client{Timeout: timeout, Transport: NewTransport(nil)}
|
|
}
|