33de701263
* refactor(atomicx): move outside the engine package
After merging probe-engine into probe-cli, my impression is that we have
too much unnecessary nesting of packages in this repository.
The idea of this commit and of a bunch of following commits will instead
be to reduce the nesting and simplify the structure.
While there, improve the documentation.
* fix: always use the atomicx package
For consistency, never use sync/atomic and always use ./internal/atomicx
so we can just grep and make sure we're not risking to crash if we make
a subtle mistake on a 32 bit platform.
While there, mention in the contributing guidelines that we want to
always prefer the ./internal/atomicx package over sync/atomic.
* fix(atomicx): remove unnecessary constructor
We don't need a constructor here. The default constructed `&Int64{}`
instance is already usable and the constructor does not add anything to
what we are doing, rather it just creates extra confusion.
* cleanup(atomicx): we are not using Float64
Because atomicx.Float64 is unused, we can safely zap it.
* cleanup(atomicx): simplify impl and improve tests
We can simplify the implementation by using defer and by letting
the Load() method call Add(0).
We can improve tests by making many goroutines updated the
atomic int64 value concurrently.
* refactor(fsx): can live in the ./internal pkg
Let us reduce the amount of nesting. While there, ensure that the
package only exports the bare minimum, and improve the documentation
of the tests, to ease reading the code.
* refactor: move runtimex to ./internal
* refactor: move shellx into the ./internal package
While there, remove unnecessary dependency between packages.
While there, specify in the contributing guidelines that
one should use x/sys/execabs instead of os/exec.
* refactor: move ooapi into the ./internal pkg
* refactor(humanize): move to ./internal and better docs
* refactor: move platform to ./internal
* refactor(randx): move to ./internal
* refactor(multierror): move into the ./internal pkg
* refactor(kvstore): all kvstores in ./internal
Rather than having part of the kvstore inside ./internal/engine/kvstore
and part in ./internal/engine/kvstore.go, let us put every piece of code
that is kvstore related into the ./internal/kvstore package.
* fix(kvstore): always return ErrNoSuchKey on Get() error
It should help to use the kvstore everywhere removing all the
copies that are lingering around the tree.
* sessionresolver: make KVStore mandatory
Simplifies implementation. While there, use the ./internal/kvstore
package rather than having our private implementation.
* fix(ooapi): use the ./internal/kvstore package
* fix(platform): better documentation
92 lines
2.9 KiB
Go
92 lines
2.9 KiB
Go
package oonimkall
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/runtimex"
|
|
)
|
|
|
|
// WebConnectivityConfig contains settings for WebConnectivity.
|
|
type WebConnectivityConfig struct {
|
|
// Callbacks contains the experiment callbacks. This field is
|
|
// optional. Leave it empty and we'll use a default set of
|
|
// callbacks that use the session logger.
|
|
Callbacks ExperimentCallbacks
|
|
|
|
// Input contains the URL to measure. This field must be set
|
|
// by the user, otherwise the experiment fails.
|
|
Input string
|
|
}
|
|
|
|
// WebConnectivityResults contains the results of WebConnectivity.
|
|
type WebConnectivityResults struct {
|
|
// KibiBytesReceived contains the KiB received.
|
|
KibiBytesReceived float64
|
|
|
|
// KibiBytesSent contains the KiB sent.
|
|
KibiBytesSent float64
|
|
|
|
// Measurement contains the resulting measurement.
|
|
Measurement string
|
|
}
|
|
|
|
// webConnectivityRunner is the type that runs
|
|
// the WebConnectivity experiment.
|
|
type webConnectivityRunner struct {
|
|
sess experimentSession
|
|
}
|
|
|
|
// run runs the WebConnectivity experiment to completion. Both arguments
|
|
// must be correctly initialized. The return value is either a valid
|
|
// results with a nil error, or nil results with an error.
|
|
func (r *webConnectivityRunner) run(ctx context.Context, config *WebConnectivityConfig) (*WebConnectivityResults, error) {
|
|
select {
|
|
case <-ctx.Done():
|
|
return nil, ctx.Err() // helps with testing
|
|
default:
|
|
// fallthrough
|
|
}
|
|
// TODO(bassosimone): I suspect most of the code for running
|
|
// experiments is going to be quite redundant. Autogen?
|
|
defer r.sess.unlock()
|
|
r.sess.lock()
|
|
if err := r.sess.maybeLookupBackends(ctx); err != nil {
|
|
return nil, err
|
|
}
|
|
if err := r.sess.maybeLookupLocation(ctx); err != nil {
|
|
return nil, err
|
|
}
|
|
builder, err := r.sess.newExperimentBuilder("web_connectivity")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if config.Callbacks != nil {
|
|
builder.setCallbacks(config.Callbacks)
|
|
}
|
|
exp := builder.newExperiment()
|
|
measurement, err := exp.MeasureWithContext(ctx, config.Input)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
data, err := json.Marshal(measurement)
|
|
runtimex.PanicOnError(err, "json.Marshal should not fail here")
|
|
return &WebConnectivityResults{
|
|
KibiBytesReceived: exp.KibiBytesReceived(),
|
|
KibiBytesSent: exp.KibiBytesSent(),
|
|
Measurement: string(data),
|
|
}, nil
|
|
}
|
|
|
|
// WebConnectivity runs the WebConnectivity experiment. Both ctx and config
|
|
// MUST NOT be nil. Returns either an error or the experiment results.
|
|
//
|
|
// This function locks the session until it's done. That is, no other operation
|
|
// can be performed as long as this function is pending.
|
|
//
|
|
// This API is currently experimental. We do not promise that we will bump
|
|
// the major version number when changing it.
|
|
func (sess *Session) WebConnectivity(ctx *Context, config *WebConnectivityConfig) (*WebConnectivityResults, error) {
|
|
return (&webConnectivityRunner{sess: sess}).run(ctx.ctx, config)
|
|
}
|