ooni / probe-cli / 6271734012

72%

push

github

refactor(enginenetx): rename HTTPTransport to Network (#1293)

The HTTPTransport model only offers a CloseIdleConnections callback,
which semantics is obviously that of closing idle connections
(unsurprisingly).

However, the struct I am slowly building inside the enginenetx package
soon will need to write back statistics to disk using a key-value store.

I don't think we should overload the CloseIdleConnections semantics to
do this job, since the resulting code would be quite surprising.

Therefore, I have decided to rename HTTPTransport to Network and make it
represent all the network abstractions required by the OONI engine.

In time, I will move extra functionality in there. For now, let us be
happy that we can easily define a Close method (currently empty) for
this type having the usual io.Closer semantics, i.e., that any resource
opened by the type itself is released when calling this method.

This diff does the following:

- it renames the files, the type, and the tests;

- it introduces a Close method that closes the Network's underlying
transport's idle connections;

- it adapts users of this code to use the new semantics;

- it introduces an model.KeyValueStore argument for the Network
constructor which we're going to use soon to persist statistics;

- updates `CONTRIBUTING.md` to say how we do internal testing when the
main tests body is external.

Part of https://github.com/ooni/probe/issues/2531

38 of 39 new or added lines in 3 files covered. (97.44%)

23481 of 28808 relevant lines covered (81.51%)

25.64 hits per line