c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
internal/engine/netx/fake_test.go
+3 -2
View File
@@ -2,10 +2,11 @@ package netx
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 {
internal/engine/netx/httptransport/bytecounter_test.go
+4 -2
View File
@@ -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)
}
internal/engine/netx/httptransport/fake_test.go
+3 -2
View File
@@ -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 {
internal/engine/netx/httptransport/logging_test.go
+3 -1
View File
@@ -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()
}
internal/engine/netx/httptransport/saver.go
+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 {
internal/engine/netx/httptransport/saver_test.go
+4 -2
View File
@@ -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)
}
internal/engine/netx/integration_test.go
+2 -2
View File
@@ -3,7 +3,6 @@ package netx_test
import (
"context"
"errors"
"io/ioutil"
"net/http"
"testing"
@@ -12,6 +11,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx/bytecounter"
"github.com/ooni/probe-cli/v3/internal/engine/netx/errorx"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/iox"
)
func TestSuccess(t *testing.T) {
@@ -38,7 +38,7 @@ func TestSuccess(t *testing.T) {
if err != nil {
t.Fatal(err)
}
if _, err = ioutil.ReadAll(resp.Body); err != nil {
if _, err = iox.ReadAllContext(context.Background(), resp.Body); err != nil {
t.Fatal(err)
}
if err = resp.Body.Close(); err != nil {
internal/engine/netx/resolver/dnsoverhttps.go
+2 -2
View File
@@ -4,11 +4,11 @@ import (
"bytes"
"context"
"errors"
"io/ioutil"
"net/http"
"time"
"github.com/ooni/probe-cli/v3/internal/engine/httpheader"
"github.com/ooni/probe-cli/v3/internal/iox"
)
// DNSOverHTTPS is a DNS over HTTPS RoundTripper. Requests are submitted over
@@ -56,7 +56,7 @@ func (t DNSOverHTTPS) RoundTrip(ctx context.Context, query []byte) ([]byte, erro
if resp.Header.Get("content-type") != "application/dns-message" {
return nil, errors.New("doh: invalid content-type")
}
return ioutil.ReadAll(resp.Body)
return iox.ReadAllContext(ctx, resp.Body)
}
// RequiresPadding returns true for DoH according to RFC8467
internal/engine/netx/tlsx/certifi.go
+1 -1
View File
@@ -1,5 +1,5 @@
// Code generated by go generate; DO NOT EDIT.
// 2021-06-08 14:36:18.474117 +0200 CEST m=+0.459588210
// 2021-06-15 10:55:55.638897 +0200 CEST m=+4.257631084
// https://curl.haxx.se/ca/cacert.pem
package tlsx
internal/engine/netx/tlsx/generate.go
+4 -2
View File
@@ -12,14 +12,16 @@
package main
import (
"context"
"crypto/x509"
"io/ioutil"
"log"
"net/http"
"os"
"strings"
"text/template"
"time"
"github.com/ooni/probe-cli/v3/internal/iox"
)
var tmpl = template.Must(template.New("").Parse(`// Code generated by go generate; DO NOT EDIT.
@@ -50,7 +52,7 @@ func main() {
}
defer resp.Body.Close()
bundle, err := ioutil.ReadAll(resp.Body)
bundle, err := iox.ReadAllContext(context.Background(), resp.Body)
if err != nil {
log.Fatal(err)
}