c4eb682606
This diff forward ports 90bf0629b957c912a5a6f3bb6c98ad3abb5a2ff6 to `master`. If we close the channel to signal the end of a task we may panic when some background goroutine tries to post on the channel. This bug is rare but may happen. See for example https://github.com/ooni/probe/issues/1438. How can we improve? First, let us add a timeout when sending to the channel. Given that the channel is buffered and we have a generous timeout (1/4 of a second), it's unlikely we will really block. But, in the event in which a late message appears, we'll eventually _unblock_ when sending with a timeout. So, now we don't have to worry anymore about leaking forever a goroutine. Then, let us change the protocol with which we signal that a task is done. We used to close the channel. Now, instead we just synchronously post a nil on the channel when done. In turn, we interpret this nil to mean that the task is done when we receive messages. The _main_ different with respect to before is that now we are asking the consumer of our API to drain the channel. Because before we had a blocking channel, it seems to me we were already requiring the consumer of the API to do that. Which means, I think in practical terms it did not change much. Finally, acknowledge that we don't need a specific state variable to tell us we're done and simplify a little bit the API by just making isRunning private and using the "we're done" signal to determine whether we've stopped running the task. All these changes should be enough to close https://github.com/ooni/probe/issues/1438. |
||
|---|---|---|
| .. | ||
| .gitignore | ||
| chanlogger.go | ||
| event.go | ||
| eventemitter_test.go | ||
| eventemitter.go | ||
| experiment_test.go | ||
| experiment.go | ||
| README.md | ||
| runner_integration_test.go | ||
| runner_internal_test.go | ||
| runner.go | ||
| session_integration_test.go | ||
| session_test.go | ||
| session.go | ||
| sessioncontext_test.go | ||
| sessioncontext.go | ||
| sessionlogger_test.go | ||
| sessionlogger.go | ||
| settings.go | ||
| task_integration_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.