fix(all): introduce and use iox.ReadAllContext (#379)

* fix(all): introduce and use iox.ReadAllContext

This improvement over the ioutil.ReadAll utility returns early
if the context expires. This enables us to unblock stuck code in
case there's censorship confounding the TCP stack.

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

Compared to the functionality postulated in the above mentioned
issue, I choose to be more generic and separate limiting the
maximum body size (not implemented here) from using the context
to return early when reading a body (or any other reader).

After implementing iox.ReadAllContext, I made sure we always
use it everywhere in the tree instead of ioutil.ReadAll.

This includes many parts of the codebase where in theory we don't
need iox.ReadAllContext. Though, changing all the places makes
checking whether we're not using ioutil.ReadAll where we should
not be using it easy: `git grep` should return no lines.

* Update internal/iox/iox_test.go

* fix(ndt7): treat context errors as non-errors

The rationale is explained by the comment documenting reduceErr.

* Update internal/engine/experiment/ndt7/download.go
This commit is contained in:
Simone Basso
2021-06-15 11:57:40 +02:00
committed by GitHub
parent 576e035b20
commit 0fdc9cafb5
76 changed files with 440 additions and 223 deletions
@@ -1,6 +1,7 @@
package httptransport_test
import (
"context"
"errors"
"io"
"io/ioutil"
@@ -10,6 +11,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/bytecounter"
"github.com/ooni/probe-cli/v3/internal/engine/netx/httptransport"
"github.com/ooni/probe-cli/v3/internal/iox"
)
func TestByteCounterFailure(t *testing.T) {
@@ -68,7 +70,7 @@ func TestByteCounterSuccess(t *testing.T) {
if err != nil {
t.Fatal(err)
}
data, err := ioutil.ReadAll(resp.Body)
data, err := iox.ReadAllContext(context.Background(), resp.Body)
if err != nil {
t.Fatal(err)
}
@@ -104,7 +106,7 @@ func TestByteCounterSuccessWithEOF(t *testing.T) {
if err != nil {
t.Fatal(err)
}
data, err := ioutil.ReadAll(resp.Body)
data, err := iox.ReadAllContext(context.Background(), resp.Body)
if err != nil {
t.Fatal(err)
}
@@ -2,10 +2,11 @@ package httptransport
import (
"context"
"io/ioutil"
"net"
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
)
type FakeDialer struct {
@@ -30,7 +31,7 @@ func (txp FakeTransport) RoundTrip(req *http.Request) (*http.Response, error) {
return txp.Func(req)
}
if req.Body != nil {
ioutil.ReadAll(req.Body)
iox.ReadAllContext(req.Context(), req.Body)
req.Body.Close()
}
if txp.Err != nil {
@@ -1,6 +1,7 @@
package httptransport_test
import (
"context"
"errors"
"io"
"io/ioutil"
@@ -11,6 +12,7 @@ import (
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/internal/engine/netx/httptransport"
"github.com/ooni/probe-cli/v3/internal/iox"
)
func TestLoggingFailure(t *testing.T) {
@@ -72,6 +74,6 @@ func TestLoggingSuccess(t *testing.T) {
if err != nil {
t.Fatal(err)
}
ioutil.ReadAll(resp.Body)
iox.ReadAllContext(context.Background(), resp.Body)
resp.Body.Close()
}
+6 -5
View File
@@ -2,14 +2,15 @@ package httptransport
import (
"bytes"
"context"
"errors"
"io"
"io/ioutil"
"net/http"
"net/http/httptrace"
"time"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/iox"
)
// SaverPerformanceHTTPTransport is a RoundTripper that saves
@@ -109,7 +110,7 @@ func (txp SaverBodyHTTPTransport) RoundTrip(req *http.Request) (*http.Response,
snapsize = txp.SnapshotSize
}
if req.Body != nil {
data, err := saverSnapRead(req.Body, snapsize)
data, err := saverSnapRead(req.Context(), req.Body, snapsize)
if err != nil {
return nil, err
}
@@ -125,7 +126,7 @@ func (txp SaverBodyHTTPTransport) RoundTrip(req *http.Request) (*http.Response,
if err != nil {
return nil, err
}
data, err := saverSnapRead(resp.Body, snapsize)
data, err := saverSnapRead(req.Context(), resp.Body, snapsize)
err = ignoreExpectedEOF(err, resp)
if err != nil {
resp.Body.Close()
@@ -157,8 +158,8 @@ func ignoreExpectedEOF(err error, resp *http.Response) error {
return err
}
func saverSnapRead(r io.ReadCloser, snapsize int) ([]byte, error) {
return ioutil.ReadAll(io.LimitReader(r, int64(snapsize)))
func saverSnapRead(ctx context.Context, r io.ReadCloser, snapsize int) ([]byte, error) {
return iox.ReadAllContext(ctx, io.LimitReader(r, int64(snapsize)))
}
func saverCompose(data []byte, r io.ReadCloser) io.ReadCloser {
@@ -1,6 +1,7 @@
package httptransport_test
import (
"context"
"errors"
"io/ioutil"
"net/http"
@@ -10,6 +11,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/httptransport"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/iox"
)
func TestSaverPerformanceNoMultipleEvents(t *testing.T) {
@@ -245,7 +247,7 @@ func TestSaverBodySuccess(t *testing.T) {
txp := httptransport.SaverBodyHTTPTransport{
RoundTripper: httptransport.FakeTransport{
Func: func(req *http.Request) (*http.Response, error) {
data, err := ioutil.ReadAll(req.Body)
data, err := iox.ReadAllContext(context.Background(), req.Body)
if err != nil {
t.Fatal(err)
}
@@ -274,7 +276,7 @@ func TestSaverBodySuccess(t *testing.T) {
t.Fatal("unexpected status code")
}
defer resp.Body.Close()
data, err := ioutil.ReadAll(resp.Body)
data, err := iox.ReadAllContext(context.Background(), resp.Body)
if err != nil {
t.Fatal(err)
}