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.
68 lines
2.0 KiB
Go
68 lines
2.0 KiB
Go
package probeservices
|
|
|
|
import (
|
|
"context"
|
|
"net/url"
|
|
"time"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/engine/httpx"
|
|
)
|
|
|
|
// MeasurementMetaConfig contains configuration for GetMeasurementMeta.
|
|
type MeasurementMetaConfig struct {
|
|
// ReportID is the mandatory report ID.
|
|
ReportID string
|
|
|
|
// Full indicates whether we also want the full measurement body.
|
|
Full bool
|
|
|
|
// Input is the optional input.
|
|
Input string
|
|
}
|
|
|
|
// MeasurementMeta contains measurement metadata.
|
|
type MeasurementMeta struct {
|
|
// Fields returned by the API server whenever we are
|
|
// calling /api/v1/measurement_meta.
|
|
Anomaly bool `json:"anomaly"`
|
|
CategoryCode string `json:"category_code"`
|
|
Confirmed bool `json:"confirmed"`
|
|
Failure bool `json:"failure"`
|
|
Input *string `json:"input"`
|
|
MeasurementStartTime time.Time `json:"measurement_start_time"`
|
|
ProbeASN int64 `json:"probe_asn"`
|
|
ProbeCC string `json:"probe_cc"`
|
|
ReportID string `json:"report_id"`
|
|
Scores string `json:"scores"`
|
|
TestName string `json:"test_name"`
|
|
TestStartTime time.Time `json:"test_start_time"`
|
|
|
|
// This field is only included if the user has specified
|
|
// the config.Full option, otherwise it's empty.
|
|
RawMeasurement string `json:"raw_measurement"`
|
|
}
|
|
|
|
// GetMeasurementMeta returns meta information about a measurement.
|
|
func (c Client) GetMeasurementMeta(
|
|
ctx context.Context, config MeasurementMetaConfig) (*MeasurementMeta, error) {
|
|
query := url.Values{}
|
|
query.Add("report_id", config.ReportID)
|
|
if config.Input != "" {
|
|
query.Add("input", config.Input)
|
|
}
|
|
if config.Full {
|
|
query.Add("full", "true")
|
|
}
|
|
var response MeasurementMeta
|
|
err := (&httpx.APIClientTemplate{
|
|
BaseURL: c.BaseURL,
|
|
HTTPClient: c.HTTPClient,
|
|
Logger: c.Logger,
|
|
UserAgent: c.UserAgent,
|
|
}).Build().GetJSONWithQuery(ctx, "/api/v1/measurement_meta", query, &response)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &response, nil
|
|
}
|