fix(netxlite): do not mutate outgoing requests (#508)
I have recently seen a data race related our way of mutating the outgoing request to set the host header. Unfortunately, I've lost track of the race output, because I rebooted my Linux box before saving it. Though, after inspecting why and and where we're mutating outgoing requets, I've found that: 1. we add the host header when logging to have it logged, which is not a big deal since we already emit the URL rather than just the URL path when logging a request, and so we can safely zap this piece of code; 2. as a result, in measurements we may omit the host header but again this is pretty much obvious from the URL itself and so it should not be very important (nonetheless, avoid surprises and keep the existing behavior); 3. when the User-Agent header is not set, we default to a `miniooni/0.1.0-dev` user agent, which is probably not very useful anyway, so we can actually remove it. Part of https://github.com/ooni/probe/issues/1733 (this diff has been extracted from https://github.com/ooni/probe-cli/pull/506).
This commit is contained in:
@@ -52,7 +52,7 @@ type SaverMetadataHTTPTransport struct {
|
||||
// RoundTrip implements RoundTripper.RoundTrip
|
||||
func (txp SaverMetadataHTTPTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
txp.Saver.Write(trace.Event{
|
||||
HTTPHeaders: req.Header,
|
||||
HTTPHeaders: txp.CloneHeaders(req),
|
||||
HTTPMethod: req.Method,
|
||||
HTTPURL: req.URL.String(),
|
||||
Transport: txp.Transport,
|
||||
@@ -72,6 +72,19 @@ func (txp SaverMetadataHTTPTransport) RoundTrip(req *http.Request) (*http.Respon
|
||||
return resp, err
|
||||
}
|
||||
|
||||
// CloneHeaders returns a clone of the headers where we have
|
||||
// also set the host header, which normally is not set by
|
||||
// golang until it serializes the request itself.
|
||||
func (txp SaverMetadataHTTPTransport) CloneHeaders(req *http.Request) http.Header {
|
||||
header := req.Header.Clone()
|
||||
if req.Host != "" {
|
||||
header.Set("Host", req.Host)
|
||||
} else {
|
||||
header.Set("Host", req.URL.Host)
|
||||
}
|
||||
return header
|
||||
}
|
||||
|
||||
// SaverTransactionHTTPTransport is a RoundTripper that saves
|
||||
// events related to the HTTP transaction
|
||||
type SaverTransactionHTTPTransport struct {
|
||||
|
||||
@@ -5,6 +5,7 @@ import (
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
@@ -429,3 +430,35 @@ func TestSaverBodyResponseReadError(t *testing.T) {
|
||||
t.Fatal("invalid Time")
|
||||
}
|
||||
}
|
||||
|
||||
func TestCloneHeaders(t *testing.T) {
|
||||
t.Run("with req.Host set", func(t *testing.T) {
|
||||
req := &http.Request{
|
||||
Host: "www.example.com",
|
||||
URL: &url.URL{
|
||||
Host: "www.kernel.org",
|
||||
},
|
||||
Header: http.Header{},
|
||||
}
|
||||
txp := httptransport.SaverMetadataHTTPTransport{}
|
||||
header := txp.CloneHeaders(req)
|
||||
if header.Get("Host") != "www.example.com" {
|
||||
t.Fatal("did not set Host header correctly")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("with only req.URL.Host set", func(t *testing.T) {
|
||||
req := &http.Request{
|
||||
Host: "",
|
||||
URL: &url.URL{
|
||||
Host: "www.kernel.org",
|
||||
},
|
||||
Header: http.Header{},
|
||||
}
|
||||
txp := httptransport.SaverMetadataHTTPTransport{}
|
||||
header := txp.CloneHeaders(req)
|
||||
if header.Get("Host") != "www.kernel.org" {
|
||||
t.Fatal("did not set Host header correctly")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
package httptransport
|
||||
|
||||
import (
|
||||
"github.com/ooni/probe-cli/v3/internal/netxlite"
|
||||
)
|
||||
|
||||
// UserAgentTransport is a transport that ensures that we always
|
||||
// set an OONI specific default User-Agent header.
|
||||
type UserAgentTransport = netxlite.UserAgentTransport
|
||||
Reference in New Issue
Block a user