273b70bacc
## Checklist - [x] I have read the [contribution guidelines](https://github.com/ooni/probe-cli/blob/master/CONTRIBUTING.md) - [x] reference issue for this pull request: https://github.com/ooni/probe/issues/1885 - [x] related ooni/spec pull request: N/A Location of the issue tracker: https://github.com/ooni/probe ## Description This PR contains a set of changes to move important interfaces and data types into the `./internal/model` package. The criteria for including an interface or data type in here is roughly that the type should be important and used by several packages. We are especially interested to move more interfaces here to increase modularity. An additional side effect is that, by reading this package, one should be able to understand more quickly how different parts of the codebase interact with each other. This is what I want to move in `internal/model`: - [x] most important interfaces from `internal/netxlite` - [x] everything that was previously part of `internal/engine/model` - [x] mocks from `internal/netxlite/mocks` should also be moved in here as a subpackage
89 lines
2.8 KiB
Go
89 lines
2.8 KiB
Go
package dialer
|
|
|
|
import (
|
|
"context"
|
|
"net"
|
|
"net/url"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/engine/legacy/errorsx"
|
|
"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"
|
|
)
|
|
|
|
// Dialer establishes network connections.
|
|
type Dialer interface {
|
|
// DialContext behaves like net.Dialer.DialContext.
|
|
DialContext(ctx context.Context, network, address string) (net.Conn, error)
|
|
}
|
|
|
|
// Resolver is the interface we expect from a DNS resolver.
|
|
type Resolver interface {
|
|
// LookupHost behaves like net.Resolver.LookupHost.
|
|
LookupHost(ctx context.Context, hostname string) (addrs []string, err error)
|
|
}
|
|
|
|
// Config contains the settings for New.
|
|
type Config struct {
|
|
// ContextByteCounting optionally configures context-based
|
|
// byte counting. By default we don't do that.
|
|
//
|
|
// Use WithExperimentByteCounter and WithSessionByteCounter
|
|
// to assign byte counters to a context. The code will use
|
|
// corresponding, private functions to access the configured
|
|
// byte counters and will notify them about I/O events.
|
|
//
|
|
// Bug
|
|
//
|
|
// This implementation cannot properly account for the bytes that are sent by
|
|
// persistent connections, because they stick to the counters set when the
|
|
// connection was established. This typically means we miss the bytes sent and
|
|
// received when submitting a measurement. Such bytes are specifically not
|
|
// seen by the experiment specific byte counter.
|
|
//
|
|
// For this reason, this implementation may be heavily changed/removed.
|
|
ContextByteCounting bool
|
|
|
|
// DialSaver is the optional saver for dialing events. If not
|
|
// set, we will not save any dialing event.
|
|
DialSaver *trace.Saver
|
|
|
|
// Logger is the optional logger. If not set, there
|
|
// will be no logging from the new dialer.
|
|
Logger model.DebugLogger
|
|
|
|
// ProxyURL is the optional proxy URL.
|
|
ProxyURL *url.URL
|
|
|
|
// ReadWriteSaver is like DialSaver but for I/O events.
|
|
ReadWriteSaver *trace.Saver
|
|
}
|
|
|
|
// New creates a new Dialer from the specified config and resolver.
|
|
func New(config *Config, resolver Resolver) Dialer {
|
|
var d Dialer = netxlite.DefaultDialer
|
|
d = &errorsx.ErrorWrapperDialer{Dialer: d}
|
|
if config.Logger != nil {
|
|
d = &netxlite.DialerLogger{
|
|
Dialer: netxlite.NewDialerLegacyAdapter(d),
|
|
DebugLogger: config.Logger,
|
|
}
|
|
}
|
|
if config.DialSaver != nil {
|
|
d = &saverDialer{Dialer: d, Saver: config.DialSaver}
|
|
}
|
|
if config.ReadWriteSaver != nil {
|
|
d = &saverConnDialer{Dialer: d, Saver: config.ReadWriteSaver}
|
|
}
|
|
d = &netxlite.DialerResolver{
|
|
Resolver: netxlite.NewResolverLegacyAdapter(resolver),
|
|
Dialer: netxlite.NewDialerLegacyAdapter(d),
|
|
}
|
|
d = &proxyDialer{ProxyURL: config.ProxyURL, Dialer: d}
|
|
if config.ContextByteCounting {
|
|
d = &byteCounterDialer{Dialer: d}
|
|
}
|
|
d = &shapingDialer{Dialer: d}
|
|
return d
|
|
}
|