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.
116 lines
3.0 KiB
Go
116 lines
3.0 KiB
Go
// Command apitool is a simple tool to fetch individual OONI measurements.
|
|
//
|
|
// This tool IS NOT intended for batch downloading.
|
|
//
|
|
// Please, see https://ooni.org/data for information pertaining how to
|
|
// access OONI data in bulk. Please see https://explorer.ooni.org if your
|
|
// intent is to navigate and explore OONI data
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"flag"
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
|
|
"github.com/apex/log"
|
|
"github.com/ooni/probe-cli/v3/internal/atomicx"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/httpx"
|
|
"github.com/ooni/probe-cli/v3/internal/engine/probeservices"
|
|
"github.com/ooni/probe-cli/v3/internal/kvstore"
|
|
"github.com/ooni/probe-cli/v3/internal/netxlite"
|
|
"github.com/ooni/probe-cli/v3/internal/version"
|
|
)
|
|
|
|
func newclient() probeservices.Client {
|
|
txp := netxlite.NewHTTPTransportStdlib(log.Log)
|
|
ua := fmt.Sprintf("apitool/%s ooniprobe-engine/%s", version.Version, version.Version)
|
|
return probeservices.Client{
|
|
APIClientTemplate: httpx.APIClientTemplate{
|
|
BaseURL: "https://ams-pg.ooni.org/",
|
|
HTTPClient: &http.Client{Transport: txp},
|
|
Logger: log.Log,
|
|
UserAgent: ua,
|
|
},
|
|
LoginCalls: &atomicx.Int64{},
|
|
RegisterCalls: &atomicx.Int64{},
|
|
StateFile: probeservices.NewStateFile(&kvstore.Memory{}),
|
|
}
|
|
}
|
|
|
|
var osExit = os.Exit
|
|
|
|
func fatalOnError(err error, message string) {
|
|
if err != nil {
|
|
log.WithError(err).Error(message)
|
|
osExit(1) // overridable from tests
|
|
}
|
|
}
|
|
|
|
var (
|
|
debug = flag.Bool("v", false, "Enable verbose mode")
|
|
input = flag.String("input", "", "Input of the measurement")
|
|
mode = flag.String("mode", "", "One of: check, meta, raw")
|
|
reportid = flag.String("report-id", "", "Report ID of the measurement")
|
|
)
|
|
|
|
var logmap = map[bool]log.Level{
|
|
true: log.DebugLevel,
|
|
false: log.InfoLevel,
|
|
}
|
|
|
|
func main() {
|
|
flag.Parse()
|
|
log.SetLevel(logmap[*debug])
|
|
client := newclient()
|
|
switch *mode {
|
|
case "check":
|
|
check(client)
|
|
case "meta":
|
|
meta(client)
|
|
case "raw":
|
|
raw(client)
|
|
default:
|
|
fatalOnError(fmt.Errorf("invalid -mode flag value: %s", *mode), "usage error")
|
|
}
|
|
}
|
|
|
|
func check(c probeservices.Client) {
|
|
found, err := c.CheckReportID(context.Background(), *reportid)
|
|
fatalOnError(err, "c.CheckReportID failed")
|
|
fmt.Printf("%+v\n", found)
|
|
}
|
|
|
|
func meta(c probeservices.Client) {
|
|
pprint(mmeta(c, false))
|
|
}
|
|
|
|
func raw(c probeservices.Client) {
|
|
m := mmeta(c, true)
|
|
rm := []byte(m.RawMeasurement)
|
|
var opaque interface{}
|
|
err := json.Unmarshal(rm, &opaque)
|
|
fatalOnError(err, "json.Unmarshal failed")
|
|
pprint(opaque)
|
|
}
|
|
|
|
func pprint(opaque interface{}) {
|
|
data, err := json.MarshalIndent(opaque, "", " ")
|
|
fatalOnError(err, "json.MarshalIndent failed")
|
|
fmt.Printf("%s\n", data)
|
|
}
|
|
|
|
func mmeta(c probeservices.Client, full bool) *probeservices.MeasurementMeta {
|
|
config := probeservices.MeasurementMetaConfig{
|
|
ReportID: *reportid,
|
|
Full: full,
|
|
Input: *input,
|
|
}
|
|
ctx := context.Background()
|
|
m, err := c.GetMeasurementMeta(ctx, config)
|
|
fatalOnError(err, "client.GetMeasurementMeta failed")
|
|
return m
|
|
}
|