cleanup: remove unnecessary legacy interfaces (#656)

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?).
2022-01-07 18:33:37 +01:00
parent 1c057d322d
commit 566c6b246a
76 changed files with 328 additions and 736 deletions
@@ -1,14 +1,5 @@
 package netxlite

-import (
-	"context"
-	"crypto/tls"
-	"net"
-
-	"github.com/lucas-clemente/quic-go"
-	"github.com/ooni/probe-cli/v3/internal/model"
-)
-
 // These vars export internal names to legacy ooni/probe-cli code.
 //
 // Deprecated: do not use these names in new code.
@@ -44,143 +35,3 @@ type (
 	TLSDialerLegacy           = tlsDialer
 	AddressResolver           = resolverShortCircuitIPAddr
 )
-
-// ResolverLegacy performs domain name resolutions.
-//
-// Deprecated: new code should use Resolver.
-//
-// Existing code in ooni/probe-cli is still using this definition.
-type ResolverLegacy interface {
-	// LookupHost behaves like net.Resolver.LookupHost.
-	LookupHost(ctx context.Context, hostname string) (addrs []string, err error)
-}
-
-// NewResolverLegacyAdapter adapts a ResolverLegacy to
-// become compatible with the Resolver definition.
-func NewResolverLegacyAdapter(reso ResolverLegacy) model.Resolver {
-	return &ResolverLegacyAdapter{reso}
-}
-
-// ResolverLegacyAdapter makes a ResolverLegacy behave like a Resolver.
-type ResolverLegacyAdapter struct {
-	ResolverLegacy
-}
-
-var _ model.Resolver = &ResolverLegacyAdapter{}
-
-type resolverLegacyNetworker interface {
-	Network() string
-}
-
-// Network implements Resolver.Network.
-func (r *ResolverLegacyAdapter) Network() string {
-	if rn, ok := r.ResolverLegacy.(resolverLegacyNetworker); ok {
-		return rn.Network()
-	}
-	return "adapter"
-}
-
-type resolverLegacyAddresser interface {
-	Address() string
-}
-
-// Address implements Resolver.Address.
-func (r *ResolverLegacyAdapter) Address() string {
-	if ra, ok := r.ResolverLegacy.(resolverLegacyAddresser); ok {
-		return ra.Address()
-	}
-	return ""
-}
-
-type resolverLegacyIdleConnectionsCloser interface {
-	CloseIdleConnections()
-}
-
-// CloseIdleConnections implements Resolver.CloseIdleConnections.
-func (r *ResolverLegacyAdapter) CloseIdleConnections() {
-	if ra, ok := r.ResolverLegacy.(resolverLegacyIdleConnectionsCloser); ok {
-		ra.CloseIdleConnections()
-	}
-}
-
-// LookupHTTPS always returns ErrDNSNoTransport.
-func (r *ResolverLegacyAdapter) LookupHTTPS(
-	ctx context.Context, domain string) (*model.HTTPSSvc, error) {
-	return nil, ErrNoDNSTransport
-}
-
-// DialerLegacy establishes network connections.
-//
-// Deprecated: please use Dialer instead.
-//
-// Existing code in probe-cli can use it until we
-// have finished refactoring it.
-type DialerLegacy interface {
-	// DialContext behaves like net.Dialer.DialContext.
-	DialContext(ctx context.Context, network, address string) (net.Conn, error)
-}
-
-// NewDialerLegacyAdapter adapts a DialerrLegacy to
-// become compatible with the Dialer definition.
-//
-// Deprecated: do not use this function in new code.
-func NewDialerLegacyAdapter(d DialerLegacy) model.Dialer {
-	return &DialerLegacyAdapter{d}
-}
-
-// DialerLegacyAdapter makes a DialerLegacy behave like
-// it was a Dialer type. If DialerLegacy is actually also
-// a Dialer, this adapter will just forward missing calls,
-// otherwise it will implement a sensible default action.
-type DialerLegacyAdapter struct {
-	DialerLegacy
-}
-
-var _ model.Dialer = &DialerLegacyAdapter{}
-
-type dialerLegacyIdleConnectionsCloser interface {
-	CloseIdleConnections()
-}
-
-// CloseIdleConnections implements Dialer.CloseIdleConnections.
-func (d *DialerLegacyAdapter) CloseIdleConnections() {
-	if ra, ok := d.DialerLegacy.(dialerLegacyIdleConnectionsCloser); ok {
-		ra.CloseIdleConnections()
-	}
-}
-
-// QUICContextDialer is a dialer for QUIC using Context.
-//
-// Deprecated: new code should use QUICDialer.
-//
-// Use NewQUICDialerFromContextDialerAdapter if you need to
-// adapt to QUICDialer.
-type QUICContextDialer interface {
-	// DialContext establishes a new QUIC session using the given
-	// network and address. The tlsConfig and the quicConfig arguments
-	// MUST NOT be nil. Returns either the session or an error.
-	DialContext(ctx context.Context, network, address string,
-		tlsConfig *tls.Config, quicConfig *quic.Config) (quic.EarlySession, error)
-}
-
-// NewQUICDialerFromContextDialerAdapter creates a new
-// QUICDialer from a QUICContextDialer.
-func NewQUICDialerFromContextDialerAdapter(d QUICContextDialer) model.QUICDialer {
-	return &QUICContextDialerAdapter{d}
-}
-
-// QUICContextDialerAdapter adapts a QUICContextDialer to be a QUICDialer.
-type QUICContextDialerAdapter struct {
-	QUICContextDialer
-}
-
-type quicContextDialerConnectionsCloser interface {
-	CloseIdleConnections()
-}
-
-// CloseIdleConnections implements QUICDialer.CloseIdleConnections.
-func (d *QUICContextDialerAdapter) CloseIdleConnections() {
-	if o, ok := d.QUICContextDialer.(quicContextDialerConnectionsCloser); ok {
-		o.CloseIdleConnections()
-	}
-}
@@ -1,100 +0,0 @@
-package netxlite
-
-import (
-	"context"
-	"errors"
-	"net"
-	"testing"
-
-	"github.com/ooni/probe-cli/v3/internal/model/mocks"
-	nlmocks "github.com/ooni/probe-cli/v3/internal/netxlite/mocks"
-)
-
-func TestResolverLegacyAdapter(t *testing.T) {
-	t.Run("with compatible type", func(t *testing.T) {
-		var called bool
-		r := NewResolverLegacyAdapter(&mocks.Resolver{
-			MockNetwork: func() string {
-				return "network"
-			},
-			MockAddress: func() string {
-				return "address"
-			},
-			MockCloseIdleConnections: func() {
-				called = true
-			},
-		})
-		if r.Network() != "network" {
-			t.Fatal("invalid Network")
-		}
-		if r.Address() != "address" {
-			t.Fatal("invalid Address")
-		}
-		r.CloseIdleConnections()
-		if !called {
-			t.Fatal("not called")
-		}
-	})
-
-	t.Run("with incompatible type", func(t *testing.T) {
-		r := NewResolverLegacyAdapter(&net.Resolver{})
-		if r.Network() != "adapter" {
-			t.Fatal("invalid Network")
-		}
-		if r.Address() != "" {
-			t.Fatal("invalid Address")
-		}
-		r.CloseIdleConnections() // does not crash
-	})
-
-	t.Run("for LookupHTTPS", func(t *testing.T) {
-		r := NewResolverLegacyAdapter(&net.Resolver{})
-		https, err := r.LookupHTTPS(context.Background(), "x.org")
-		if !errors.Is(err, ErrNoDNSTransport) {
-			t.Fatal("not the error we expected")
-		}
-		if https != nil {
-			t.Fatal("expected nil result")
-		}
-	})
-}
-
-func TestDialerLegacyAdapter(t *testing.T) {
-	t.Run("with compatible type", func(t *testing.T) {
-		var called bool
-		r := NewDialerLegacyAdapter(&mocks.Dialer{
-			MockCloseIdleConnections: func() {
-				called = true
-			},
-		})
-		r.CloseIdleConnections()
-		if !called {
-			t.Fatal("not called")
-		}
-	})
-
-	t.Run("with incompatible type", func(t *testing.T) {
-		r := NewDialerLegacyAdapter(&net.Dialer{})
-		r.CloseIdleConnections() // does not crash
-	})
-}
-
-func TestQUICContextDialerAdapter(t *testing.T) {
-	t.Run("with compatible type", func(t *testing.T) {
-		var called bool
-		d := NewQUICDialerFromContextDialerAdapter(&mocks.QUICDialer{
-			MockCloseIdleConnections: func() {
-				called = true
-			},
-		})
-		d.CloseIdleConnections()
-		if !called {
-			t.Fatal("not called")
-		}
-	})
-
-	t.Run("with incompatible type", func(t *testing.T) {
-		d := NewQUICDialerFromContextDialerAdapter(&nlmocks.QUICContextDialer{})
-		d.CloseIdleConnections() // does not crash
-	})
-}