ff1c170562
This is required to implement websteps, which is currently tracked by https://github.com/ooni/probe/issues/1733. We introduce the concept of async runner. An async runner will post measurements on a channel until it is done. When it is done, it will close the channel to notify the reader about that. This change causes sync experiments now to strictly return either a non-nil measurement or a non-nil error. While this is a pretty much obvious situation in golang, we had some parts of the codebase that were not robust to this assumption and attempted to submit a measurement after the measure call returned an error. Luckily, we had enough tests to catch this change in our assumption and this is why there are extra docs and tests changes. |
||
|---|---|---|
| .. | ||
| internal/tasks | ||
| .gitignore | ||
| experiment_test.go | ||
| experiment.go | ||
| README.md | ||
| session_integration_test.go | ||
| session_test.go | ||
| session.go | ||
| sessioncontext_test.go | ||
| sessioncontext.go | ||
| sessionlogger_test.go | ||
| sessionlogger.go | ||
| task_integration_test.go | ||
| task_internal_test.go | ||
| task.go | ||
| uuid_test.go | ||
| uuid.go | ||
| webconnectivity_integration_test.go | ||
| webconnectivity_test.go | ||
| webconnectivity.go | ||
Package github.com/ooni/probe-cli/pkg/oonimkall
Package oonimkall implements APIs used by OONI mobile apps. We expose these APIs to mobile apps using gomobile.
We expose two APIs: the task API, which is derived from the
API originally exposed by Measurement Kit, and the session API,
which is a Go API that mobile apps can use via gomobile.
This package is named oonimkall because it contains a partial reimplementation of the mkall API implemented by Measurement Kit in, e.g., mkall-ios.
The basic tenet of the task API is that you define an experiment task you wanna run using a JSON, then you start a task for it, and you receive events as serialized JSONs. In addition to this functionality, we also include extra APIs used by OONI mobile.
The basic tenet of the session API is that you create an instance
of Session and use it to perform the operations you need.