ooni-probe-cli/internal/engine/netx
Simone Basso 8a0beee808
refactor: start pivoting netx (#396)
What do I mean by pivoting? Netx is currently organized by row:

```
               | dialer | quicdialer | resolver | ...
 saving        |        |            |          | ...
 errorwrapping |        |            |          | ...
 logging       |        |            |          | ...
 mocking/sys   |        |            |          | ...
```

Every row needs to implement saving, errorwrapping, logging, mocking (or
adapting to the system or to some underlying library).

This causes cross package dependencies and, in turn, complexity. For
example, we need the `trace` package for supporting saving.

And `dialer`, `quickdialer`, et al. need to depend on such a package.

The same goes for errorwrapping.

This arrangement further complicates testing. For example, I am
currently working on https://github.com/ooni/probe/issues/1505 and
I realize it need to repeat integration tests in multiple places.

Let's say instead we pivot the above matrix as follows:

```
             | saving | errorwrapping | logging | ...
 dialer      |        |               |         | ...
 quicdialer  |        |               |         | ...
 logging     |        |               |         | ...
 mocking/sys |        |               |         | ...
 ...
```

In this way, now every row contains everything related to a specific
action to perform. We can now share code without relying on extra
support packages. What's more, we can write tests and, judding from
the way in which things are made, it seems we only need integration
testing in `errorwrapping` because it's where data quality matters
whereas, in all other cases, unit testing is fine.

I am going, therefore, to proceed with these changes and "pivot"
`netx`. Hopefully, it won't be too painful.
2021-06-23 15:53:12 +02:00
..
archival cleanup: remove ConnID, DialID, TransactionID (#395) 2021-06-23 13:36:45 +02:00
dialer refactor: start pivoting netx (#396) 2021-06-23 15:53:12 +02:00
errorx cleanup: remove ConnID, DialID, TransactionID (#395) 2021-06-23 13:36:45 +02:00
httptransport refactor: move bytecounter to internal (#391) 2021-06-22 13:00:29 +02:00
mockablex refactor(netx): move dialer's mockable types in mockablex (#368) 2021-06-08 23:59:30 +02:00
quicdialer refactor: start pivoting netx (#396) 2021-06-23 15:53:12 +02:00
resolver refactor: start pivoting netx (#396) 2021-06-23 15:53:12 +02:00
tlsdialer cleanup: remove ConnID, DialID, TransactionID (#395) 2021-06-23 13:36:45 +02:00
tlsx fix(all): introduce and use iox.ReadAllContext (#379) 2021-06-15 11:57:40 +02:00
trace chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
fake_test.go fix(all): introduce and use iox.ReadAllContext (#379) 2021-06-15 11:57:40 +02:00
integration_test.go refactor: move bytecounter to internal (#391) 2021-06-22 13:00:29 +02:00
netx_internal_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
netx_test.go refactor: start pivoting netx (#396) 2021-06-23 15:53:12 +02:00
netx.go refactor: start pivoting netx (#396) 2021-06-23 15:53:12 +02:00
README.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00

Package github.com/ooni/probe-engine/netx

OONI extensions to the net and net/http packages. This code is used by ooni/probe-engine as a low level library to collect network, DNS, and HTTP events occurring during OONI measurements.

This library contains replacements for commonly used standard library interfaces that facilitate seamless network measurements. By using such replacements, as opposed to standard library interfaces, we can:

  • save the timing of HTTP events (e.g. received response headers)
  • save the timing and result of every Connect, Read, Write, Close operation
  • save the timing and result of the TLS handshake (including certificates)

By default, this library uses the system resolver. In addition, it is possible to configure alternative DNS transports and remote servers. We support DNS over UDP, DNS over TCP, DNS over TLS (DoT), and DNS over HTTPS (DoH). When using an alternative transport, we are also able to intercept and save DNS messages, as well as any other interaction with the remote server (e.g., the result of the TLS handshake for DoT and DoH).

This package is a fork of github.com/ooni/netx.