websteps

type Analysis struct {
	// DNS contains the DNS results analysis.
	DNS []*AnalysisDNS `json:"dns"`

	// Endpoint contains the endpoint results analysis.
	Endpoint []*AnalysisEndpoint `json:"endpoint"`

	// TH contains the TH results analysis.
	TH []*AnalysisEndpoint `json:"th"`
}

type AnalysisDNS struct {
	// ID is the unique ID of this analysis.
	ID int64 `json:"id"`

	// URLMeasurementID is the related URL measurement ID.
	URLMeasurementID int64 `json:"-"`

	// Ref references the measurements we used. The first ref is the
	// measurement we're describing and the other refs instead are
	// the measurement(s) we use as the "control".
	Refs []int64 `json:"refs"`

	// Flags contains the analysis flags.
	Flags int64 `json:"flags"`
}

type AnalysisDescription struct {
	// Flag is the flag value.
	Flag int64

	// Hashtag is the related hashtag.
	Hashtag string

	// Severity is the related emoji.
	Severity int64
}

type AnalysisEndpoint struct {
	// ID is the unique ID of this analysis.
	ID int64 `json:"id"`

	// URLMeasurementID is the related URL measurement ID.
	URLMeasurementID int64 `json:"-"`

	// Ref is the ID of the lookup.
	Refs []int64 `json:"refs"`

	// Flags contains the analysis flags.
	Flags int64 `json:"flags"`
}

type ArchivalSingleStepMeasurement struct {
	// Initial measurement by the probe
	ID          int64                                   `json:"id"`
	EndpointIDs []int64                                 `json:"endpoint_ids"`
	URL         string                                  `json:"url"`
	Cookies     []string                                `json:"cookies"`
	DNS         []measurex.ArchivalDNSLookupMeasurement `json:"dns"`
	Endpoint    []measurex.ArchivalEndpointMeasurement  `json:"endpoint"`

	// Data gathered by the TH or follow-up experiments
	TH              *ArchivalTHResponse                    `json:"th"`
	DNSPing         *dnsping.ArchivalResult                `json:"dnsping"`
	ProbeAdditional []measurex.ArchivalEndpointMeasurement `json:"probe_additional"`

	// Overall analysis of this step
	Analysis *Analysis `json:"analysis"`
	Flags    int64     `json:"flags"`
}

type ArchivalTHResponse struct {
	DNS      []measurex.ArchivalDNSLookupMeasurement `json:"dns"`
	Endpoint []measurex.ArchivalEndpointMeasurement  `json:"endpoint"`
}

type ArchivalTestKeys struct {
	URL   string                           `json:"url"`
	Steps []*ArchivalSingleStepMeasurement `json:"steps"`
	Flags int64                            `json:"flags"`
}

type Client struct {
	// Input is the MANDATORY channel for receiving Input.
	Input chan string

	// MeasurerFactory is the OPTIONAL factory for creating
	// new measurer instances. If you set this field, you MUST
	// set it before starting any background worker.
	MeasurerFactory MeasurerFactory

	// NewDNSPingEngine is the MANDATORY factory for creating
	// new instances of the dnsping engine. You should set this
	// field before starting any background worker. You may
	// want to use this field for caching dnsping results.
	NewDNSPingEngine func(
		idgen dnsping.IDGenerator, queryTimeout time.Duration) dnsping.AbstractEngine

	// Output is the MANDATORY channel for emitting measurements.
	Output chan *TestKeysOrError

	// Resolvers contains the MANDATORY Resolvers to use.
	Resolvers []*measurex.DNSResolverInfo

	// THMeasurementObserver is an OPTIONAL hook allowing
	// the user to view/store the response from the TH.
	//
	// You MUST NOT modify the measurement. Doing that is
	// most likely going to result in a data race.
	THMeasurementObserver func(m *THResponse)
	// contains filtered or unexported fields
}

type Explainable interface {
	// Describe returns a description of the explainable.
	Describe() string
}

type MeasurerFactory func(options *measurex.Options) (measurex.AbstractMeasurer, error)

type SingleStepMeasurement struct {
	// ProbeInitial contains the initial probe measurement.
	ProbeInitial *measurex.URLMeasurement

	// TH contains the response from the test helper.
	TH *THResponse `json:",omitempty"`

	// DNSPing contains the optional result of
	// the dnsping follow-up experiment.
	DNSPing *dnsping.Result `json:",omitempty"`

	// ProbeAdditional contains additional measurements performed
	// by the probe using extra info from the TH.
	ProbeAdditional []*measurex.EndpointMeasurement `json:",omitempty"`

	// Analysis contains the results analysis.
	Analysis *Analysis

	// Flags contains aggregate flags for this single step.
	Flags int64
}

type THClient interface {
	// THRequestAsync performs an async TH request posting the result on the out channel.
	THRequestAsync(ctx context.Context, thReq *THRequest, out chan<- *THResponseOrError)

	// THRequest performs a sync TH request.
	THRequest(ctx context.Context, req *THRequest) (*THResponse, error)
}

type THHandler struct {
	// Options contains the TH handler options.
	Options *THHandlerOptions

	// IDGenerator generates the next ID.
	IDGenerator *measurex.IDGenerator
}

type THHandlerOptions struct {
	// MeasurerFactory is the OPTIONAL factory used
	// to construct a measurer. By changing this
	// factory, you can force the THHandler to use
	// a different measurer (e.g., a caching measurer).
	MeasurerFactory MeasurerFactory

	// Resolvers contains the resolvers to use.
	Resolvers []*measurex.DNSResolverInfo

	// Saver saves measurements.
	Saver THHandlerSaver
}

type THHandlerSaver interface {
	// Save saves this measurement somewhere.
	Save(um *measurex.URLMeasurement)
}

type THRequest struct {
	// URL is the current URL.
	URL string

	// Options contains the options. Nil means using defaults.
	Options *measurex.Options `json:",omitempty"`

	// Cookies is the list of cookies to use.
	Cookies []string

	// Plan is the endpoint measurement plan.
	Plan []THRequestEndpointPlan `json:",omitempty"`
}

type THRequestEndpointPlan struct {
	// Network is the endpoint network.
	Network string

	// Address it the endpoint addr.
	Address string

	// URL is the endpoint URL.
	URL string
}

type THRequestHandler struct {
	// Options contains the options.
	Options *THHandlerOptions

	// ID is the unique ID of this request.
	ID int64
}

type THResponse struct {
	// StillRunning is a boolean flag that tells the client that
	// the test helper is still alive and running.
	StillRunning bool `json:",omitempty"`

	// URLMeasurementID is the URL measurement ID. We do not
	// serialize this field to JSON since that would be redundant.
	URLMeasurementID int64 `json:"-"`

	// DNS contains DNS measurements.
	DNS []*measurex.DNSLookupMeasurement

	// Endpoint contains the endpoints.
	Endpoint []*measurex.EndpointMeasurement
}

type THResponseOrError struct {
	// Resp is the response
	Resp *THResponse

	// Err is the error
	Err error
}

type TestKeys struct {
	// URL is the URL this measurement refers to.
	URL string

	// Steps contains all the steps.
	Steps []*SingleStepMeasurement

	// Flags contains the analysis flags.
	Flags int64
}

type TestKeysOrError struct {
	// Err is the error that occurred.
	Err error

	// TestKeys are the test keys.
	TestKeys *TestKeys
}