eed51978ca
As mentioned in https://github.com/ooni/probe/issues/1951, one of the main issues I did see with httpx.APIClient is that in some cases it's used in a very fragile way by probeservices.Client. This happens in psiphon.go and tor.go, where we create a copy of the APIClient and then modify it's Authorization field. If we ever refactor probeservices.Client to take a pointer to httpx.Client, we are now mutating the httpx.Client. Of course, we don't want that to happen. This diff attempts to address such a problem as follows: 1. we create a new APIClientTemplate type that holds the same fields of an APIClient and allows to build an APIClient 2. we modify every user of APIClient to use APIClientTemplate 3. when we need an APIClient, we build it from the corresponding template and, when we need to use a specific Authorization, we use a build factory that sets APIClient.Authorization 4. we hide APIClient by renaming it apiClient and by defining an interface called APIClient that allows to use it So, now the codebase always uses the opaque APIClient interface to issue API calls and always uses the APIClientTemplate to build an opaque APIClient. Boom! We have separated construction from usage and we are not mutating in weird ways the APIClient anymore.
87 lines
3.0 KiB
Go
87 lines
3.0 KiB
Go
package webconnectivity
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/engine/geolocate"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/httpx"
|
|
legacyerrorsx "github.com/ooni/probe-cli/v3/internal/engine/legacy/errorsx"
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
"github.com/ooni/probe-cli/v3/internal/netxlite"
|
|
)
|
|
|
|
// ControlRequest is the request that we send to the control
|
|
type ControlRequest struct {
|
|
HTTPRequest string `json:"http_request"`
|
|
HTTPRequestHeaders map[string][]string `json:"http_request_headers"`
|
|
TCPConnect []string `json:"tcp_connect"`
|
|
}
|
|
|
|
// ControlTCPConnectResult is the result of the TCP connect
|
|
// attempt performed by the control vantage point.
|
|
type ControlTCPConnectResult struct {
|
|
Status bool `json:"status"`
|
|
Failure *string `json:"failure"`
|
|
}
|
|
|
|
// ControlHTTPRequestResult is the result of the HTTP request
|
|
// performed by the control vantage point.
|
|
type ControlHTTPRequestResult struct {
|
|
BodyLength int64 `json:"body_length"`
|
|
Failure *string `json:"failure"`
|
|
Title string `json:"title"`
|
|
Headers map[string]string `json:"headers"`
|
|
StatusCode int64 `json:"status_code"`
|
|
}
|
|
|
|
// ControlDNSResult is the result of the DNS lookup
|
|
// performed by the control vantage point.
|
|
type ControlDNSResult struct {
|
|
Failure *string `json:"failure"`
|
|
Addrs []string `json:"addrs"`
|
|
ASNs []int64 `json:"-"` // not visible from the JSON
|
|
}
|
|
|
|
// ControlResponse is the response from the control service.
|
|
type ControlResponse struct {
|
|
TCPConnect map[string]ControlTCPConnectResult `json:"tcp_connect"`
|
|
HTTPRequest ControlHTTPRequestResult `json:"http_request"`
|
|
DNS ControlDNSResult `json:"dns"`
|
|
}
|
|
|
|
// Control performs the control request and returns the response.
|
|
func Control(
|
|
ctx context.Context, sess model.ExperimentSession,
|
|
thAddr string, creq ControlRequest) (out ControlResponse, err error) {
|
|
clnt := &httpx.APIClientTemplate{
|
|
BaseURL: thAddr,
|
|
HTTPClient: sess.DefaultHTTPClient(),
|
|
Logger: sess.Logger(),
|
|
UserAgent: sess.UserAgent(),
|
|
}
|
|
sess.Logger().Infof("control for %s...", creq.HTTPRequest)
|
|
// make sure error is wrapped
|
|
err = legacyerrorsx.SafeErrWrapperBuilder{
|
|
Error: clnt.Build().PostJSON(ctx, "/", creq, &out),
|
|
Operation: netxlite.TopLevelOperation,
|
|
}.MaybeBuild()
|
|
sess.Logger().Infof("control for %s... %+v", creq.HTTPRequest, err)
|
|
(&out.DNS).FillASNs(sess)
|
|
return
|
|
}
|
|
|
|
// FillASNs fills the ASNs array of ControlDNSResult. For each Addr inside
|
|
// of the ControlDNSResult structure, we obtain the corresponding ASN.
|
|
//
|
|
// This is very useful to know what ASNs were the IP addresses returned by
|
|
// the control according to the probe's ASN database.
|
|
func (dns *ControlDNSResult) FillASNs(sess model.ExperimentSession) {
|
|
dns.ASNs = []int64{}
|
|
for _, ip := range dns.Addrs {
|
|
// TODO(bassosimone): this would be more efficient if we'd open just
|
|
// once the database and then reuse it for every address.
|
|
asn, _, _ := geolocate.LookupASN(ip)
|
|
dns.ASNs = append(dns.ASNs, int64(asn))
|
|
}
|
|
}
|