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

cleanup: remove unnecessary legacy interfaces (#656)

Browse Source 
This diff addresses another point of https://github.com/ooni/probe/issues/1956:

> - [ ] observe that we're still using a bunch of private interfaces for common interfaces such as the `Dialer`, so we can get rid of these private interfaces and always use the ones in `model`, which allows us to remove a bunch of legacy wrappers

Additional cleanups may still be possible. The more I cleanup, the more I see
there's extra legacy code we can dispose of (which seems good?).
This commit is contained in:
Simone Basso
2022-01-07 18:33:37 +01:00
committed by GitHub
parent 1c057d322d
commit 566c6b246a
76 changed files with 328 additions and 736 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/engine/experiment/dnscheck/dnscheck.go
+1 -1
View File
@@ -234,7 +234,7 @@ func (m *Measurer) Run(
return nil
}
func (m *Measurer) lookupHost(ctx context.Context, hostname string, r netx.Resolver) ([]string, error) {
func (m *Measurer) lookupHost(ctx context.Context, hostname string, r model.Resolver) ([]string, error) {
ctx, cancel := context.WithTimeout(ctx, 20*time.Second)
defer cancel()
return r.LookupHost(ctx, hostname)
internal/engine/experiment/hhfm/hhfm.go
+1 -2
View File
@@ -17,7 +17,6 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/experiment/urlgetter"
"github.com/ooni/probe-cli/v3/internal/engine/httpheader"
"github.com/ooni/probe-cli/v3/internal/engine/netx/archival"
"github.com/ooni/probe-cli/v3/internal/engine/netx/dialer"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/netxlite"
"github.com/ooni/probe-cli/v3/internal/randx"
@@ -311,7 +310,7 @@ type JSONHeaders struct {
// guarantee that the connection is used for a single request and that
// such a request does not contain any body.
type Dialer struct {
Dialer dialer.Dialer // used for testing
Dialer model.SimpleDialer // used for testing
Headers map[string]string
}
internal/engine/experiment/hirl/fake_test.go
+2
View File
@@ -17,6 +17,8 @@ func (d FakeDialer) DialContext(ctx context.Context, network, address string) (n
return d.Conn, d.Err
}
func (d FakeDialer) CloseIdleConnections() {}
type FakeConn struct {
ReadError error
ReadData []byte
internal/engine/experiment/hirl/hirl.go
+1 -1
View File
@@ -251,7 +251,7 @@ func (meth squidCacheManager) Run(ctx context.Context, config MethodConfig) {
type RunMethodConfig struct {
MethodConfig
Name string
NewDialer func(config netx.Config) netx.Dialer
NewDialer func(config netx.Config) model.Dialer
RequestLine string
}
internal/engine/experiment/hirl/hirl_test.go
+4 -4
View File
@@ -388,7 +388,7 @@ func TestRunMethodDialFailure(t *testing.T) {
Out: out,
},
Name: "random_invalid_version_number",
NewDialer: func(config netx.Config) netx.Dialer {
NewDialer: func(config netx.Config) model.Dialer {
return FakeDialer{Err: expected}
},
RequestLine: "GET / HTTP/ABC",
@@ -435,7 +435,7 @@ func TestRunMethodSetDeadlineFailure(t *testing.T) {
Out: out,
},
Name: "random_invalid_version_number",
NewDialer: func(config netx.Config) netx.Dialer {
NewDialer: func(config netx.Config) model.Dialer {
return FakeDialer{Conn: &FakeConn{
SetDeadlineError: expected,
}}
@@ -484,7 +484,7 @@ func TestRunMethodWriteFailure(t *testing.T) {
Out: out,
},
Name: "random_invalid_version_number",
NewDialer: func(config netx.Config) netx.Dialer {
NewDialer: func(config netx.Config) model.Dialer {
return FakeDialer{Conn: &FakeConn{
WriteError: expected,
}}
@@ -532,7 +532,7 @@ func TestRunMethodReadEOFWithWrongData(t *testing.T) {
Out: out,
},
Name: "random_invalid_version_number",
NewDialer: func(config netx.Config) netx.Dialer {
NewDialer: func(config netx.Config) model.Dialer {
return FakeDialer{Conn: &FakeConn{
ReadData: []byte("0xdeadbeef"),
}}
internal/engine/experiment/ndt7/dial.go
+2 -3
View File
@@ -8,7 +8,6 @@ import (
"github.com/gorilla/websocket"
"github.com/ooni/probe-cli/v3/internal/engine/netx/dialer"
"github.com/ooni/probe-cli/v3/internal/engine/netx/resolver"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/netxlite"
)
@@ -34,9 +33,9 @@ func newDialManager(ndt7URL string, logger model.Logger, userAgent string) dialM
}
func (mgr dialManager) dialWithTestName(ctx context.Context, testName string) (*websocket.Conn, error) {
var reso resolver.Resolver = &netxlite.ResolverSystem{}
var reso model.Resolver = &netxlite.ResolverSystem{}
reso = &netxlite.ResolverLogger{
Resolver: netxlite.NewResolverLegacyAdapter(reso),
Resolver: reso,
Logger: mgr.logger,
}
dlr := dialer.New(&dialer.Config{
internal/engine/experiment/stunreachability/stunreachability.go
+1 -2
View File
@@ -13,7 +13,6 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/engine/netx/archival"
"github.com/ooni/probe-cli/v3/internal/engine/netx/dialer"
"github.com/ooni/probe-cli/v3/internal/engine/netx/trace"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/netxlite"
@@ -134,7 +133,7 @@ func (tk *TestKeys) run(
}
func (tk *TestKeys) do(
ctx context.Context, config Config, dialer dialer.Dialer, endpoint string) error {
ctx context.Context, config Config, dialer model.Dialer, endpoint string) error {
dialContext := dialer.DialContext
if config.dialContext != nil {
dialContext = config.dialContext
internal/engine/experiment/tlstool/internal/dialer.go
+2 -2
View File
@@ -5,14 +5,14 @@ import (
"net"
"time"
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/model"
)
// Dialer creates net.Conn instances where (1) we delay writes if
// a delay is configured and (2) we split outgoing buffers if there
// is a configured splitter function.
type Dialer struct {
netx.Dialer
model.Dialer
Delay time.Duration
Splitter func([]byte) [][]byte
}
internal/engine/experiment/tlstool/internal/fake_test.go
+2
View File
@@ -17,6 +17,8 @@ func (d FakeDialer) DialContext(ctx context.Context, network, address string) (n
return d.Conn, d.Err
}
func (d FakeDialer) CloseIdleConnections() {}
type FakeConn struct {
ReadError error
ReadData []byte
internal/engine/experiment/tlstool/internal/internal.go
+2 -2
View File
@@ -4,12 +4,12 @@ package internal
import (
"time"
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/model"
)
// DialerConfig contains the config for creating a dialer
type DialerConfig struct {
Dialer netx.Dialer
Dialer model.Dialer
Delay time.Duration
SNI string
}
internal/engine/experiment/tlstool/internal/internal_test.go
+2 -1
View File
@@ -6,6 +6,7 @@ import (
"github.com/ooni/probe-cli/v3/internal/engine/experiment/tlstool/internal"
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/model"
)
var config = internal.DialerConfig{
@@ -14,7 +15,7 @@ var config = internal.DialerConfig{
SNI: "dns.google",
}
func dial(t *testing.T, d netx.Dialer) {
func dial(t *testing.T, d model.Dialer) {
td := netx.NewTLSDialer(netx.Config{Dialer: d})
conn, err := td.DialTLSContext(context.Background(), "tcp", "dns.google:853")
if err != nil {
internal/engine/experiment/tlstool/tlstool.go
+1 -1
View File
@@ -107,7 +107,7 @@ func (m Measurer) Run(
return nil // return nil so we always submit the measurement
}
func (m Measurer) newDialer(logger model.Logger) netx.Dialer {
func (m Measurer) newDialer(logger model.Logger) model.Dialer {
// TODO(bassosimone): this is a resolver that should hopefully work
// in many places. Maybe allow to configure it?
resolver, err := netx.NewDNSClientWithOverrides(netx.Config{Logger: logger},
internal/engine/experiment/websteps/dns.go
+3 -2
View File
@@ -5,13 +5,14 @@ import (
"github.com/apex/log"
"github.com/ooni/probe-cli/v3/internal/engine/netx"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/netxlite"
"github.com/ooni/probe-cli/v3/internal/runtimex"
)
type DNSConfig struct {
Domain string
Resolver netxlite.ResolverLegacy
Resolver model.Resolver
}
// DNSDo performs the DNS check.
@@ -22,7 +23,7 @@ func DNSDo(ctx context.Context, config DNSConfig) ([]string, error) {
runtimex.PanicOnError(err, "NewDNSClient failed")
resolver = childResolver
resolver = &netxlite.ResolverIDNA{
Resolver: netxlite.NewResolverLegacyAdapter(resolver),
Resolver: resolver,
}
}
return resolver.LookupHost(ctx, config.Domain)
internal/engine/experiment/websteps/factory.go
+6 -6
View File
@@ -32,11 +32,11 @@ func NewRequest(ctx context.Context, URL *url.URL, headers http.Header) *http.Re
// NewDialerResolver contructs a new dialer for TCP connections,
// with default, errorwrapping and resolve functionalities
func NewDialerResolver(resolver netxlite.ResolverLegacy) model.Dialer {
func NewDialerResolver(resolver model.Resolver) model.Dialer {
var d model.Dialer = netxlite.DefaultDialer
d = &netxlite.ErrorWrapperDialer{Dialer: d}
d = &netxlite.DialerResolver{
Resolver: netxlite.NewResolverLegacyAdapter(resolver),
Resolver: resolver,
Dialer: d,
}
return d
@@ -44,7 +44,7 @@ func NewDialerResolver(resolver netxlite.ResolverLegacy) model.Dialer {
// NewQUICDialerResolver creates a new QUICDialerResolver
// with default, errorwrapping and resolve functionalities
func NewQUICDialerResolver(resolver netxlite.ResolverLegacy) model.QUICDialer {
func NewQUICDialerResolver(resolver model.Resolver) model.QUICDialer {
var ql model.QUICListener = &netxlite.QUICListenerStdlib{}
ql = &netxlite.ErrorWrapperQUICListener{QUICListener: ql}
var dialer model.QUICDialer = &netxlite.QUICDialerQUICGo{
@@ -52,7 +52,7 @@ func NewQUICDialerResolver(resolver netxlite.ResolverLegacy) model.QUICDialer {
}
dialer = &netxlite.ErrorWrapperQUICDialer{QUICDialer: dialer}
dialer = &netxlite.QUICDialerResolver{
Resolver: netxlite.NewResolverLegacyAdapter(resolver),
Resolver: resolver,
Dialer: dialer,
}
return dialer
@@ -79,12 +79,12 @@ func NewSingleTransport(conn net.Conn) http.RoundTripper {
}
// NewSingleTransport creates a new HTTP transport with a custom dialer and handshaker.
func NewTransportWithDialer(dialer netxlite.DialerLegacy, tlsConfig *tls.Config, handshaker model.TLSHandshaker) http.RoundTripper {
func NewTransportWithDialer(dialer model.Dialer, tlsConfig *tls.Config, handshaker model.TLSHandshaker) http.RoundTripper {
transport := newBaseTransport()
transport.DialContext = dialer.DialContext
transport.DialTLSContext = (&netxlite.TLSDialerLegacy{
Config: tlsConfig,
Dialer: netxlite.NewDialerLegacyAdapter(dialer),
Dialer: dialer,
TLSHandshaker: handshaker,
}).DialTLSContext
return transport
internal/engine/experiment/websteps/quic.go
+3 -2
View File
@@ -5,13 +5,14 @@ import (
"crypto/tls"
"github.com/lucas-clemente/quic-go"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/netxlite"
)
type QUICConfig struct {
Endpoint string
QUICDialer netxlite.QUICContextDialer
Resolver netxlite.ResolverLegacy
QUICDialer model.QUICDialer
Resolver model.Resolver
TLSConf *tls.Config
}
internal/engine/experiment/websteps/tcp.go
+3 -2
View File
@@ -4,13 +4,14 @@ import (
"context"
"net"
"github.com/ooni/probe-cli/v3/internal/model"
"github.com/ooni/probe-cli/v3/internal/netxlite"
)
type TCPConfig struct {
Dialer netxlite.DialerLegacy
Dialer model.Dialer
Endpoint string
Resolver netxlite.ResolverLegacy
Resolver model.Resolver
}
// TCPDo performs the TCP check.