ooni-probe-cli/internal/netxlite
Simone Basso b5da8be183
fix(netxlite): robust {ReadAll,Copy}Context with wrapped io.EOF (#661)
* chore(netxlite): add currently failing test case

This diff introduces a test cases that will fail because of the reason
explained in https://github.com/ooni/probe/issues/1965.

* chore(netxlite/iox_test.go): add failing unit tests

These tests directly show how the Go implementation of ReadAll
and Copy has the issue of checking for io.EOF equality.

* fix(netxlite): make {ReadAll,Copy}Context robust to wrapped io.EOF

The fix is simple: we just need to check for `errors.Is(err, io.EOF)`
after either io.ReadAll or io.Copy has returned. When this condition is
true, we need to convert the error back to `nil` as it ought to be.

While there, observe that the unit tests I committed in the previous
commit are wrongly asserting that the error must be wrapped. This
assertion is not correct, because in both cases we have just ensured
that the returned error is `nil` (i.e., success).

See https://github.com/ooni/probe/issues/1965.

* cleanup: remove previous workaround for wrapped io.EOF

These workarounds were partial, meaning that they would cover some
cases in which the issue occurred but not all of them.

Handling the problem in `netxlite.{ReadAll,Copy}Context` is the
right thing to do _as long as_ we always use these functions instead
of `io.{ReadAll,Copy}`.

This is why it's now important to ensure we clearly mention that
inside of the `CONTRIBUTING.md` guide and to also ensure that we're
not using these functions in the code base.

* fix(urlgetter): repair tests who assumed to see EOF error

Now that we have established that we should normalize EOF when
reading bodies like the stdlib does and now that it's clear why
our behavior diverged from the stdlib, we also need to repair
all the tests that assumed this incorrect behavior.

* fix(all): don't use io{,util}.{Copy,ReadAll}

* feat: add checks to ensure we don't use io.{Copy,ReadAll}

* doc(netxlite): document we know how to deal w/ wrapped io.EOF

* fix(nocopyreadall.bash): add exception for i/n/iox.go
2022-01-12 14:26:10 +01:00
..
filtering fix(netxlite): robust {ReadAll,Copy}Context with wrapped io.EOF (#661) 2022-01-12 14:26:10 +01:00
internal [forwardport] fix(ios): make sure we can build an iOS release (#598) (#599) 2021-11-15 14:24:20 +01:00
mocks refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
quictesting [forwardport] fix: avoid http3 for dns.google and www.google.com (#593) (#594) 2021-11-12 14:43:28 +01:00
bogon_test.go cleanup: move bogon checking code in netxlite (#562) 2021-11-02 12:20:04 +01:00
bogon.go cleanup: move bogon checking code in netxlite (#562) 2021-11-02 12:20:04 +01:00
certifi_test.go netxlite: improve docs, tests, and code quality (#493) 2021-09-08 21:19:51 +02:00
certifi.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
classify_test.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
classify.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
dialer_test.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
dialer.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
dnsdecoder_test.go refactor: merge dnsx and errorsx into netxlite (#517) 2021-09-28 12:42:01 +02:00
dnsdecoder.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsencoder_test.go refactor: merge dnsx and errorsx into netxlite (#517) 2021-09-28 12:42:01 +02:00
dnsencoder.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsoverhttps_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsoverhttps.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsovertcp_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsovertcp.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsoverudp_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnsoverudp.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
dnstransport.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
doc.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
errno_darwin_test.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_darwin.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_freebsd_test.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_freebsd.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_linux_test.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_linux.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_windows_test.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno_windows.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errno.go [forwardport] release 3.11: update all the dependencies (#636) (#637) 2021-12-06 17:46:13 +01:00
errwrapper_test.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
errwrapper.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
http_test.go fix: ensure experiments return nil when we want to submit (#654) 2022-01-07 13:17:20 +01:00
http.go fix: ensure experiments return nil when we want to submit (#654) 2022-01-07 13:17:20 +01:00
http3_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
http3.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
integration_test.go fix(netxlite): robust {ReadAll,Copy}Context with wrapped io.EOF (#661) 2022-01-12 14:26:10 +01:00
iox_test.go fix(netxlite): robust {ReadAll,Copy}Context with wrapped io.EOF (#661) 2022-01-12 14:26:10 +01:00
iox.go fix(netxlite): robust {ReadAll,Copy}Context with wrapped io.EOF (#661) 2022-01-12 14:26:10 +01:00
legacy.go cleanup: remove unnecessary legacy interfaces (#656) 2022-01-07 18:33:37 +01:00
operations.go doc(netxlite): revamp the documentation (#523) 2021-09-29 20:21:25 +02:00
quic_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
quic.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
quirks_test.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
quirks.go refactor: merge dnsx and errorsx into netxlite (#517) 2021-09-28 12:42:01 +02:00
resolver_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
resolver.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
serialresolver_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
serialresolver.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
tls_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
tls.go cleanup: merge legacy errorsx in netxlite and hide classifiers (#655) 2022-01-07 17:31:21 +01:00
tproxy.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
utls_test.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00
utls.go refactor: interfaces and data types into the model package (#642) 2022-01-03 13:53:23 +01:00