feat: tlsping and tcpping using step-by-step (#815)
## 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/2158 - [x] if you changed anything related how experiments work and you need to reflect these changes in the ooni/spec repository, please link to the related ooni/spec pull request: https://github.com/ooni/spec/pull/250 ## Description This diff refactors the codebase to reimplement tlsping and tcpping to use the step-by-step measurements style. See docs/design/dd-003-step-by-step.md for more information on the step-by-step measurement style.
This commit is contained in:
parent
5371c7f486
commit
5ebdeb56ca
48 changed files with 2825 additions and 299 deletions
143
internal/measurexlite/trace.go
Normal file
143
internal/measurexlite/trace.go
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
package measurexlite
|
||||
|
||||
//
|
||||
// Definition of Trace
|
||||
//
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
"github.com/ooni/probe-cli/v3/internal/model"
|
||||
"github.com/ooni/probe-cli/v3/internal/netxlite"
|
||||
)
|
||||
|
||||
// Trace implements model.Trace.
|
||||
//
|
||||
// The zero-value of this struct is invalid. To construct you should either
|
||||
// fill all the fields marked as MANDATORY or use NewTrace.
|
||||
//
|
||||
// Buffered channels
|
||||
//
|
||||
// NewTrace uses reasonable buffer sizes for the channels used for collecting
|
||||
// events. You should drain the channels used by this implementation after
|
||||
// each operation you perform (i.e., we expect you to peform step-by-step
|
||||
// measurements). If you want larger (or smaller) buffers, then you should
|
||||
// construct this data type manually with the desired buffer sizes.
|
||||
//
|
||||
// We have convenience methods for extracting events from the buffered
|
||||
// channels. Otherwise, you could read the channels directly. (In which
|
||||
// case, remember to issue nonblocking channel reads because channels are
|
||||
// never closed and they're just written when new events occur.)
|
||||
type Trace struct {
|
||||
// Index is the MANDATORY unique index of this trace within the
|
||||
// current measurement. If you don't care about uniquely identifying
|
||||
// treaces, you can use zero to indicate the "default" trace.
|
||||
Index int64
|
||||
|
||||
// NetworkEvent is MANDATORY and buffers network events. If you create
|
||||
// this channel manually, ensure it has some buffer.
|
||||
NetworkEvent chan *model.ArchivalNetworkEvent
|
||||
|
||||
// NewDialerWithoutResolverFn is OPTIONAL and can be used to override
|
||||
// calls to the netxlite.NewDialerWithoutResolver factory.
|
||||
NewDialerWithoutResolverFn func(dl model.DebugLogger) model.Dialer
|
||||
|
||||
// NewTLSHandshakerStdlibFn is OPTIONAL and can be used to overide
|
||||
// calls to the netxlite.NewTLSHandshakerStdlib factory.
|
||||
NewTLSHandshakerStdlibFn func(dl model.DebugLogger) model.TLSHandshaker
|
||||
|
||||
// TCPConnect is MANDATORY and buffers TCP connect observations. If you create
|
||||
// this channel manually, ensure it has some buffer.
|
||||
TCPConnect chan *model.ArchivalTCPConnectResult
|
||||
|
||||
// TLSHandshake is MANDATORY and buffers TLS handshake observations. If you create
|
||||
// this channel manually, ensure it has some buffer.
|
||||
TLSHandshake chan *model.ArchivalTLSOrQUICHandshakeResult
|
||||
|
||||
// TimeNowFn is OPTIONAL and can be used to override calls to time.Now
|
||||
// to produce deterministic timing when testing.
|
||||
TimeNowFn func() time.Time
|
||||
|
||||
// ZeroTime is the MANDATORY time when we started the current measurement.
|
||||
ZeroTime time.Time
|
||||
}
|
||||
|
||||
const (
|
||||
// NetworkEventBufferSize is the buffer size for constructing
|
||||
// the Trace's NetworkEvent buffered channel.
|
||||
NetworkEventBufferSize = 64
|
||||
|
||||
// TCPConnectBufferSize is the buffer size for constructing
|
||||
// the Trace's TCPConnect buffered channel.
|
||||
TCPConnectBufferSize = 8
|
||||
|
||||
// TLSHandshakeBufferSize is the buffer for construcing
|
||||
// the Trace's TLSHandshake buffered channel.
|
||||
TLSHandshakeBufferSize = 8
|
||||
)
|
||||
|
||||
// NewTrace creates a new instance of Trace using default settings.
|
||||
//
|
||||
// We create buffered channels using as buffer sizes the constants that
|
||||
// are also defined by this package.
|
||||
//
|
||||
// Arguments:
|
||||
//
|
||||
// - index is the unique index of this trace within the current measurement (use
|
||||
// zero if you don't care about giving this trace a unique ID);
|
||||
//
|
||||
// - zeroTime is the time when we started the current measurement.
|
||||
func NewTrace(index int64, zeroTime time.Time) *Trace {
|
||||
return &Trace{
|
||||
Index: index,
|
||||
NetworkEvent: make(
|
||||
chan *model.ArchivalNetworkEvent,
|
||||
NetworkEventBufferSize,
|
||||
),
|
||||
NewDialerWithoutResolverFn: nil, // use default
|
||||
NewTLSHandshakerStdlibFn: nil, // use default
|
||||
TCPConnect: make(
|
||||
chan *model.ArchivalTCPConnectResult,
|
||||
TCPConnectBufferSize,
|
||||
),
|
||||
TLSHandshake: make(
|
||||
chan *model.ArchivalTLSOrQUICHandshakeResult,
|
||||
TLSHandshakeBufferSize,
|
||||
),
|
||||
TimeNowFn: nil, // use default
|
||||
ZeroTime: zeroTime,
|
||||
}
|
||||
}
|
||||
|
||||
// newDialerWithoutResolver indirectly calls netxlite.NewDialerWithoutResolver
|
||||
// thus allows us to mock this func for testing.
|
||||
func (tx *Trace) newDialerWithoutResolver(dl model.DebugLogger) model.Dialer {
|
||||
if tx.NewDialerWithoutResolverFn != nil {
|
||||
return tx.NewDialerWithoutResolverFn(dl)
|
||||
}
|
||||
return netxlite.NewDialerWithoutResolver(dl)
|
||||
}
|
||||
|
||||
// newTLSHandshakerStdlib indirectly calls netxlite.NewTLSHandshakerStdlib
|
||||
// thus allowing us to mock this func for testing.
|
||||
func (tx *Trace) newTLSHandshakerStdlib(dl model.DebugLogger) model.TLSHandshaker {
|
||||
if tx.NewTLSHandshakerStdlibFn != nil {
|
||||
return tx.NewTLSHandshakerStdlibFn(dl)
|
||||
}
|
||||
return netxlite.NewTLSHandshakerStdlib(dl)
|
||||
}
|
||||
|
||||
// TimeNow implements model.Trace.TimeNow.
|
||||
func (tx *Trace) TimeNow() time.Time {
|
||||
if tx.TimeNowFn != nil {
|
||||
return tx.TimeNowFn()
|
||||
}
|
||||
return time.Now()
|
||||
}
|
||||
|
||||
// TimeSince is equivalent to Trace.TimeNow().Sub(t0).
|
||||
func (tx *Trace) TimeSince(t0 time.Time) time.Duration {
|
||||
return tx.TimeNow().Sub(t0)
|
||||
}
|
||||
|
||||
var _ model.Trace = &Trace{}
|
||||
Loading…
Reference in a new issue