pipeline

package
v1.10.17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 18, 2021 License: MIT Imports: 56 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	InputTaskKey = "input"
)

Variables

View Source 
var (
	ErrWrongInputCardinality = errors.New("wrong number of task inputs")
	ErrBadInput              = errors.New("bad input for task")
	ErrInputTaskErrored      = errors.New("input task errored")
	ErrParameterEmpty        = errors.New("parameter is empty")
	ErrTooManyErrors         = errors.New("too many errors")
	ErrTimeout               = errors.New("timeout")
	ErrTaskRunFailed         = errors.New("task run failed")
	ErrCancelled             = errors.New("task run cancelled (fail early)")
)
View Source 
var (
	// PromPipelineTaskExecutionTime reports how long each pipeline task took to execute
	// TODO: Make private again after
	// https://app.clubhouse.io/chainlinklabs/story/6065/hook-keeper-up-to-use-tasks-in-the-pipeline
	PromPipelineTaskExecutionTime = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pipeline_task_execution_time",
		Help: "How long each pipeline task took to execute",
	},
		[]string{"job_id", "job_name", "task_id", "task_type"},
	)
	PromPipelineRunErrors = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "pipeline_run_errors",
		Help: "Number of errors for each pipeline spec",
	},
		[]string{"job_id", "job_name"},
	)
	PromPipelineRunTotalTimeToCompletion = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pipeline_run_total_time_to_completion",
		Help: "How long each pipeline run took to finish (from the moment it was created)",
	},
		[]string{"job_id", "job_name"},
	)
	PromPipelineTasksTotalFinished = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "pipeline_tasks_total_finished",
		Help: "The total number of pipeline tasks which have finished",
	},
		[]string{"job_id", "job_name", "task_id", "task_type", "status"},
	)
)
View Source 
var (
	ErrKeypathNotFound = errors.New("keypath not found")
	ErrKeypathTooDeep  = errors.New("keypath too deep (maximum 2 keys)")
	ErrVarsRoot        = errors.New("cannot get/set the root of a pipeline.Vars")
)
View Source 
var (
	ErrNoSuchBridge = errors.New("no such bridge exists")
)
View Source 
var ErrOverflow = errors.New("overflow")

Functions

func CheckInputs 

func CheckInputs(inputs []Result, minLen, maxLen, maxErrors int) ([]interface{}, error)

func NewORM 

func NewORM(db *gorm.DB) *orm

func NewRunner 

func NewRunner(orm ORM, config Config, chainSet evm.ChainSet, ethks ETHKeyStore, vrfks VRFKeyStore) *runner

func ParseETHABIArgsString added in v1.10.17 

func ParseETHABIArgsString(theABI []byte, isLog bool) (args abi.Arguments, indexedArgs abi.Arguments, _ error)

func ResolveParam 

func ResolveParam(out PipelineParamUnmarshaler, getters []GetterFunc) error

Types

type AddressParam 

type AddressParam common.Address

func (*AddressParam) UnmarshalPipelineParam 

func (a *AddressParam) UnmarshalPipelineParam(val interface{}) error

type AddressSliceParam 

type AddressSliceParam []common.Address

func (*AddressSliceParam) UnmarshalPipelineParam 

func (s *AddressSliceParam) UnmarshalPipelineParam(val interface{}) error

type AnyTask 

type AnyTask struct {
	BaseTask `mapstructure:",squash"`
}

AnyTask picks a value at random from the set of non-errored inputs. If there are zero non-errored inputs then it returns an error.

func (*AnyTask) Run 

func (t *AnyTask) Run(_ context.Context, _ Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*AnyTask) Type 

func (t *AnyTask) Type() TaskType

type BaseTask 

type BaseTask struct {
	Index     int32         `mapstructure:"index" json:"-" `
	Timeout   time.Duration `mapstructure:"timeout"`
	FailEarly bool          `mapstructure:"failEarly"`

	Retries    null.Uint32   `mapstructure:"retries"`
	MinBackoff time.Duration `mapstructure:"minBackoff"`
	MaxBackoff time.Duration `mapstructure:"maxBackoff"`
	// contains filtered or unexported fields
}

func NewBaseTask 

func NewBaseTask(id int, dotID string, inputs, outputs []Task, index int32) BaseTask

func (*BaseTask) Base 

func (t *BaseTask) Base() *BaseTask

func (BaseTask) DotID 

func (t BaseTask) DotID() string

func (BaseTask) ID 

func (t BaseTask) ID() int

func (BaseTask) Inputs 

func (t BaseTask) Inputs() []Task

func (BaseTask) OutputIndex 

func (t BaseTask) OutputIndex() int32

func (BaseTask) Outputs 

func (t BaseTask) Outputs() []Task

func (BaseTask) TaskMaxBackoff added in v1.10.17 

func (t BaseTask) TaskMaxBackoff() time.Duration

func (BaseTask) TaskMinBackoff added in v1.10.17 

func (t BaseTask) TaskMinBackoff() time.Duration

func (BaseTask) TaskRetries added in v1.10.17 

func (t BaseTask) TaskRetries() uint32

func (BaseTask) TaskTimeout 

func (t BaseTask) TaskTimeout() (time.Duration, bool)

type BoolParam 

type BoolParam bool

func (*BoolParam) UnmarshalPipelineParam 

func (b *BoolParam) UnmarshalPipelineParam(val interface{}) error

type BridgeTask 

type BridgeTask struct {
	BaseTask `mapstructure:",squash"`

	Name              string `json:"name"`
	RequestData       string `json:"requestData"`
	IncludeInputAtKey string `json:"includeInputAtKey"`
	Async             string `json:"async"`
	// contains filtered or unexported fields
}

Return types: 

string

func (*BridgeTask) Run 

func (t *BridgeTask) Run(ctx context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*BridgeTask) Type 

func (t *BridgeTask) Type() TaskType

type BytesParam 

type BytesParam []byte

func (*BytesParam) UnmarshalPipelineParam 

func (b *BytesParam) UnmarshalPipelineParam(val interface{}) error

type CBORParseTask 

type CBORParseTask struct {
	BaseTask `mapstructure:",squash"`
	Data     string `json:"data"`
	Mode     string `json:"mode"`
}

Return types: 

map[string]interface{} with potential value types:
    float64
    string
    bool
    map[string]interface{}
    []interface{}
    nil

func (*CBORParseTask) Run 

func (t *CBORParseTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*CBORParseTask) Type 

func (t *CBORParseTask) Type() TaskType

type Config 

type Config interface {
	BridgeResponseURL() *url.URL
	DatabaseMaximumTxDuration() time.Duration
	DatabaseURL() url.URL
	DefaultHTTPLimit() int64
	DefaultHTTPTimeout() models.Duration
	DefaultMaxHTTPAttempts() uint
	DefaultHTTPAllowUnrestrictedNetworkAccess() bool
	TriggerFallbackDBPollInterval() time.Duration
	JobPipelineMaxRunDuration() time.Duration
	JobPipelineReaperInterval() time.Duration
	JobPipelineReaperThreshold() time.Duration
}

type DecimalParam 

type DecimalParam decimal.Decimal

func (DecimalParam) Decimal 

func (d DecimalParam) Decimal() decimal.Decimal

func (*DecimalParam) UnmarshalPipelineParam 

func (d *DecimalParam) UnmarshalPipelineParam(val interface{}) error

type DecimalSliceParam 

type DecimalSliceParam []decimal.Decimal

func (*DecimalSliceParam) UnmarshalPipelineParam 

func (s *DecimalSliceParam) UnmarshalPipelineParam(val interface{}) error

type DivideTask 

type DivideTask struct {
	BaseTask  `mapstructure:",squash"`
	Input     string `json:"input"`
	Divisor   string `json:"divisor"`
	Precision string `json:"precision"`
}

Return types: 

*decimal.Decimal

func (*DivideTask) Run 

func (t *DivideTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*DivideTask) Type 

func (t *DivideTask) Type() TaskType

type ETHABIDecodeLogTask 

type ETHABIDecodeLogTask struct {
	BaseTask `mapstructure:",squash"`
	ABI      string `json:"abi"`
	Data     string `json:"data"`
	Topics   string `json:"topics"`
}

Return types: 

map[string]interface{} with any geth/abigen value type

func (*ETHABIDecodeLogTask) Run 

func (t *ETHABIDecodeLogTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*ETHABIDecodeLogTask) Type 

func (t *ETHABIDecodeLogTask) Type() TaskType

type ETHABIDecodeTask 

type ETHABIDecodeTask struct {
	BaseTask `mapstructure:",squash"`
	ABI      string `json:"abi"`
	Data     string `json:"data"`
}

Return types: 

map[string]interface{} with any geth/abigen value type

func (*ETHABIDecodeTask) Run 

func (t *ETHABIDecodeTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*ETHABIDecodeTask) Type 

func (t *ETHABIDecodeTask) Type() TaskType

type ETHABIEncodeTask 

type ETHABIEncodeTask struct {
	BaseTask `mapstructure:",squash"`
	ABI      string `json:"abi"`
	Data     string `json:"data"`
}

Return types: 

[]byte

func (*ETHABIEncodeTask) Run 

func (t *ETHABIEncodeTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*ETHABIEncodeTask) Type 

func (t *ETHABIEncodeTask) Type() TaskType

type ETHABIEncodeTask2 added in v1.10.17 

type ETHABIEncodeTask2 struct {
	BaseTask `mapstructure:",squash"`
	ABI      string `json:"abi"`
	Data     string `json:"data"`
}

Return types: 

[]byte

func (*ETHABIEncodeTask2) Run added in v1.10.17 

func (t *ETHABIEncodeTask2) Run(_ context.Context, vars Vars, inputs []Result) (Result, RunInfo)

func (*ETHABIEncodeTask2) Type added in v1.10.17 

func (t *ETHABIEncodeTask2) Type() TaskType

type ETHCallTask 

type ETHCallTask struct {
	BaseTask            `mapstructure:",squash"`
	Contract            string `json:"contract"`
	Data                string `json:"data"`
	Gas                 string `json:"gas"`
	GasPrice            string `json:"gasPrice"`
	GasTipCap           string `json:"gasTipCap"`
	GasFeeCap           string `json:"gasFeeCap"`
	ExtractRevertReason bool   `json:"extractRevertReason"`
	EVMChainID          string `json:"evmChainID" mapstructure:"evmChainID"`
	// contains filtered or unexported fields
}

Return types: 

[]byte

func (*ETHCallTask) Run 

func (t *ETHCallTask) Run(ctx context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*ETHCallTask) Type 

func (t *ETHCallTask) Type() TaskType

type ETHKeyStore 

type ETHKeyStore interface {
	GetRoundRobinAddress(addrs ...common.Address) (common.Address, error)
}

type ETHTxTask 

type ETHTxTask struct {
	BaseTask         `mapstructure:",squash"`
	From             string `json:"from"`
	To               string `json:"to"`
	Data             string `json:"data"`
	GasLimit         string `json:"gasLimit"`
	TxMeta           string `json:"txMeta"`
	MinConfirmations string `json:"minConfirmations"`
	EVMChainID       string `json:"evmChainID" mapstructure:"evmChainID"`
	Simulate         string `json:"simulate" mapstructure:"simulate"`
	// contains filtered or unexported fields
}

Return types: 

nil

func (*ETHTxTask) Run 

func (t *ETHTxTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*ETHTxTask) Type 

func (t *ETHTxTask) Type() TaskType

type ErrRunPanicked 

type ErrRunPanicked struct {
	// contains filtered or unexported fields
}

When a task panics, we catch the panic and wrap it in an error for reporting to the scheduler.

func (ErrRunPanicked) Error 

func (err ErrRunPanicked) Error() string

type EstimateGasLimitTask added in v1.10.17 

type EstimateGasLimitTask struct {
	BaseTask   `mapstructure:",squash"`
	Input      string `json:"input"`
	From       string `json:"from"`
	To         string `json:"to"`
	Multiplier string `json:"multiplier"`
	Data       string `json:"data"`
	EVMChainID string `json:"evmChainID" mapstructure:"evmChainID"`
	// contains filtered or unexported fields
}

Return types: 

uint64

func (*EstimateGasLimitTask) Run added in v1.10.17 

func (t *EstimateGasLimitTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*EstimateGasLimitTask) Type added in v1.10.17 

func (t *EstimateGasLimitTask) Type() TaskType

type FailTask added in v1.10.17 

type FailTask struct {
	BaseTask `mapstructure:",squash"`
	Msg      string
}

FailTask is like the Panic task but without all the drama and stack unwinding of a panic

func (*FailTask) Run added in v1.10.17 

func (t *FailTask) Run(_ context.Context, vars Vars, _ []Result) (Result, RunInfo)

func (*FailTask) Type added in v1.10.17 

func (t *FailTask) Type() TaskType

type FinalResult 

type FinalResult struct {
	Values      []interface{}
	AllErrors   []error
	FatalErrors []error
}

FinalResult is the result of a Run

func (FinalResult) HasErrors 

func (result FinalResult) HasErrors() bool

HasErrors returns true if the final result has any errors

func (FinalResult) HasFatalErrors added in v1.10.17 

func (result FinalResult) HasFatalErrors() bool

HasFatalErrors returns true if the final result has any errors

func (FinalResult) SingularResult 

func (result FinalResult) SingularResult() (Result, error)

SingularResult returns a single result if the FinalResult only has one set of outputs/errors

type GasEstimator added in v1.10.17 

type GasEstimator interface {
	EstimateGas(ctx context.Context, call ethereum.CallMsg) (uint64, error)
}

type GetterFunc 

type GetterFunc func() (interface{}, error)

func From 

func From(getters ...interface{}) []GetterFunc

func Input 

func Input(inputs []Result, index int) GetterFunc

func Inputs 

func Inputs(inputs []Result) GetterFunc

func JSONWithVarExprs 

func JSONWithVarExprs(s string, vars Vars, allowErrors bool) GetterFunc

func NonemptyString 

func NonemptyString(s string) GetterFunc

func VarExpr 

func VarExpr(s string, vars Vars) GetterFunc

type Graph 

type Graph struct {
	*simple.DirectedGraph
}

tree fulfills the graph.DirectedGraph interface, which makes it possible for us to `dot.Unmarshal(...)` a DOT string directly into it.

func NewGraph 

func NewGraph() *Graph

func (*Graph) NewNode 

func (g *Graph) NewNode() graph.Node

func (*Graph) UnmarshalText 

func (g *Graph) UnmarshalText(bs []byte) (err error)

type GraphNode 

type GraphNode struct {
	graph.Node
	// contains filtered or unexported fields
}

func NewGraphNode 

func NewGraphNode(n graph.Node, dotID string, attrs map[string]string) *GraphNode

func (*GraphNode) Attributes 

func (n *GraphNode) Attributes() []encoding.Attribute

func (*GraphNode) DOTID 

func (n *GraphNode) DOTID() string

func (*GraphNode) SetAttribute 

func (n *GraphNode) SetAttribute(attr encoding.Attribute) error

func (*GraphNode) SetDOTID 

func (n *GraphNode) SetDOTID(id string)

func (*GraphNode) String 

func (n *GraphNode) String() string

type HTTPTask 

type HTTPTask struct {
	BaseTask                       `mapstructure:",squash"`
	Method                         string
	URL                            string
	RequestData                    string `json:"requestData"`
	AllowUnrestrictedNetworkAccess string
	// contains filtered or unexported fields
}

Return types: 

string

func (*HTTPTask) Run 

func (t *HTTPTask) Run(ctx context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*HTTPTask) Type 

func (t *HTTPTask) Type() TaskType

type HashSliceParam 

type HashSliceParam []common.Hash

func (*HashSliceParam) UnmarshalPipelineParam 

func (s *HashSliceParam) UnmarshalPipelineParam(val interface{}) error

type JSONParseTask 

type JSONParseTask struct {
	BaseTask `mapstructure:",squash"`
	Path     string `json:"path"`
	Data     string `json:"data"`
	// Lax when disabled will return an error if the path does not exist
	// Lax when enabled will return nil with no error if the path does not exist
	Lax string
}

Return types: 

float64
string
bool
map[string]interface{}
[]interface{}
nil

func (*JSONParseTask) Run 

func (t *JSONParseTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*JSONParseTask) Type 

func (t *JSONParseTask) Type() TaskType

type JSONPathParam 

type JSONPathParam []string

func (*JSONPathParam) UnmarshalPipelineParam 

func (p *JSONPathParam) UnmarshalPipelineParam(val interface{}) error

type JSONSerializable 

type JSONSerializable struct {
	Val   interface{}
	Valid bool
}

func JSONSerializableFrom added in v1.10.17 

func JSONSerializableFrom(val interface{}) JSONSerializable

JSONSerializableFrom creates a new JSONSerializable that will always be valid.

func NewJSONSerializable added in v1.10.17 

func NewJSONSerializable(val interface{}, valid bool) JSONSerializable

NewJSONSerializable returns an instance of JSONSerializable with the passed parameters.

func (*JSONSerializable) Empty 

func (js *JSONSerializable) Empty() bool

func (JSONSerializable) MarshalJSON 

func (js JSONSerializable) MarshalJSON() ([]byte, error)

MarshalJSON implements custom marshaling logic

func (*JSONSerializable) Scan 

func (js *JSONSerializable) Scan(value interface{}) error

func (*JSONSerializable) UnmarshalJSON 

func (js *JSONSerializable) UnmarshalJSON(bs []byte) error

UnmarshalJSON implements custom unmarshaling logic

func (JSONSerializable) Value 

func (js JSONSerializable) Value() (driver.Value, error)

type Keypath 

type Keypath [2][]byte

func (Keypath) NumParts 

func (keypath Keypath) NumParts() int

func (Keypath) String 

func (keypath Keypath) String() string

type MapParam 

type MapParam map[string]interface{}

MapParam accepts maps or JSON-encoded strings

func (MapParam) Map added in v1.10.17 

func (m MapParam) Map() map[string]interface{}

func (*MapParam) UnmarshalPipelineParam 

func (m *MapParam) UnmarshalPipelineParam(val interface{}) error

type MaybeBigIntParam added in v1.10.17 

type MaybeBigIntParam struct {
	// contains filtered or unexported fields
}

func (MaybeBigIntParam) BigInt added in v1.10.17 

func (p MaybeBigIntParam) BigInt() *big.Int

func (*MaybeBigIntParam) UnmarshalPipelineParam added in v1.10.17 

func (p *MaybeBigIntParam) UnmarshalPipelineParam(val interface{}) error

type MaybeInt32Param 

type MaybeInt32Param struct {
	// contains filtered or unexported fields
}

func (MaybeInt32Param) Int32 

func (p MaybeInt32Param) Int32() (int32, bool)

func (*MaybeInt32Param) UnmarshalPipelineParam 

func (p *MaybeInt32Param) UnmarshalPipelineParam(val interface{}) error

type MaybeUint64Param 

type MaybeUint64Param struct {
	// contains filtered or unexported fields
}

func (MaybeUint64Param) Uint64 

func (p MaybeUint64Param) Uint64() (uint64, bool)

func (*MaybeUint64Param) UnmarshalPipelineParam 

func (p *MaybeUint64Param) UnmarshalPipelineParam(val interface{}) error

type MeanTask 

type MeanTask struct {
	BaseTask      `mapstructure:",squash"`
	Values        string `json:"values"`
	AllowedFaults string `json:"allowedFaults"`
	Precision     string `json:"precision"`
}

Return types: 

*decimal.Decimal

func (*MeanTask) Run 

func (t *MeanTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*MeanTask) Type 

func (t *MeanTask) Type() TaskType

type MedianTask 

type MedianTask struct {
	BaseTask      `mapstructure:",squash"`
	Values        string `json:"values"`
	AllowedFaults string `json:"allowedFaults"`
}

Return types: 

*decimal.Decimal

func (*MedianTask) Run 

func (t *MedianTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*MedianTask) Type 

func (t *MedianTask) Type() TaskType

type MemoTask added in v1.10.17 

type MemoTask struct {
	BaseTask `mapstructure:",squash"`
	Value    string `json:"value"`
}

func (*MemoTask) Run added in v1.10.17 

func (t *MemoTask) Run(_ context.Context, vars Vars, inputs []Result) (Result, RunInfo)

func (*MemoTask) Type added in v1.10.17 

func (t *MemoTask) Type() TaskType

type MergeTask added in v1.10.17 

type MergeTask struct {
	BaseTask `mapstructure:",squash"`
	Left     string `json:"left"`
	Right    string `json:"right"`
}

Return types: 

map[string]interface{}

func (*MergeTask) Run added in v1.10.17 

func (t *MergeTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*MergeTask) Type added in v1.10.17 

func (t *MergeTask) Type() TaskType

type Method added in v1.10.17 

type Method struct {
	Name   string
	Inputs abi.Arguments
}

go-ethereum's abi.Method doesn't implement json.Marshal for Type, but otherwise would have worked fine, in any case we only care about these...

type ModeTask 

type ModeTask struct {
	BaseTask      `mapstructure:",squash"`
	Values        string `json:"values"`
	AllowedFaults string `json:"allowedFaults"`
}

Return types: 

map[string]interface{}{
    "results": []interface{} containing any other type other pipeline tasks can return
    "occurrences": (int64)
}

func (*ModeTask) Run 

func (t *ModeTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*ModeTask) Type 

func (t *ModeTask) Type() TaskType

type MultiplyTask 

type MultiplyTask struct {
	BaseTask `mapstructure:",squash"`
	Input    string `json:"input"`
	Times    string `json:"times"`
}

Return types: 

*decimal.Decimal

func (*MultiplyTask) Run 

func (t *MultiplyTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*MultiplyTask) Type 

func (t *MultiplyTask) Type() TaskType

type ORM 

type ORM interface {
	CreateSpec(ctx context.Context, tx *gorm.DB, pipeline Pipeline, maxTaskTimeout models.Interval) (int32, error)
	CreateRun(db postgres.Queryer, run *Run) (err error)
	DeleteRun(id int64) error
	StoreRun(db postgres.Queryer, run *Run) (restart bool, err error)
	UpdateTaskRunResult(taskID uuid.UUID, result Result) (run Run, start bool, err error)
	InsertFinishedRun(db postgres.Queryer, run Run, saveSuccessfulTaskRuns bool) (runID int64, err error)
	DeleteRunsOlderThan(context.Context, time.Duration) error
	FindRun(id int64) (Run, error)
	GetAllRuns() ([]Run, error)
	GetUnfinishedRuns(context.Context, time.Time, func(run Run) error) error
	DB() *gorm.DB
}

type ObjectParam added in v1.10.17 

type ObjectParam struct {
	Type         ObjectType
	BoolValue    BoolParam
	DecimalValue DecimalParam
	StringValue  StringParam
	SliceValue   SliceParam
	MapValue     MapParam
}

ObjectParam represents a kind of any type that could be used by the memo task

func MustNewObjectParam added in v1.10.17 

func MustNewObjectParam(val interface{}) *ObjectParam

func (ObjectParam) Marshal added in v1.10.17 

func (o ObjectParam) Marshal() (string, error)

func (ObjectParam) MarshalJSON added in v1.10.17 

func (o ObjectParam) MarshalJSON() ([]byte, error)

func (ObjectParam) String added in v1.10.17 

func (o ObjectParam) String() string

func (*ObjectParam) UnmarshalPipelineParam added in v1.10.17 

func (o *ObjectParam) UnmarshalPipelineParam(val interface{}) error

type ObjectType added in v1.10.17 

type ObjectType int
const (
	NilType ObjectType = iota
	BoolType
	DecimalType
	StringType
	SliceType
	MapType
)

type PanicTask 

type PanicTask struct {
	BaseTask `mapstructure:",squash"`
	Msg      string
}

func (*PanicTask) Run 

func (t *PanicTask) Run(_ context.Context, vars Vars, _ []Result) (result Result, runInfo RunInfo)

func (*PanicTask) Type 

func (t *PanicTask) Type() TaskType

type Pipeline 

type Pipeline struct {
	Tasks []Task

	Source string
	// contains filtered or unexported fields
}

func Parse 

func Parse(text string) (*Pipeline, error)

func (*Pipeline) ByDotID 

func (p *Pipeline) ByDotID(id string) Task

func (*Pipeline) MinTimeout 

func (p *Pipeline) MinTimeout() (time.Duration, bool, error)

func (*Pipeline) RequiresPreInsert added in v1.10.17 

func (p *Pipeline) RequiresPreInsert() bool

func (*Pipeline) UnmarshalText 

func (p *Pipeline) UnmarshalText(bs []byte) (err error)

type PipelineParamUnmarshaler 

type PipelineParamUnmarshaler interface {
	UnmarshalPipelineParam(val interface{}) error
}

type PossibleErrorResponses 

type PossibleErrorResponses struct {
	Error        string `json:"error"`
	ErrorMessage string `json:"errorMessage"`
}

type Result 

type Result struct {
	Value interface{}
	Error error
}

Result is the result of a TaskRun

func (Result) ErrorDB 

func (result Result) ErrorDB() null.String

ErrorDB dumps a single result error for a pipeline_task_run

func (Result) OutputDB 

func (result Result) OutputDB() JSONSerializable

OutputDB dumps a single result output for a pipeline_run or pipeline_task_run

type ResumeRequest added in v1.10.17 

type ResumeRequest struct {
	Error null.String     `json:"error"`
	Value json.RawMessage `json:"value"`
}

func (ResumeRequest) ToResult added in v1.10.17 

func (rr ResumeRequest) ToResult() (Result, error)

type Run 

type Run struct {
	ID             int64            `json:"-" gorm:"primary_key"`
	PipelineSpecID int32            `json:"-"`
	PipelineSpec   Spec             `json:"pipelineSpec"`
	Meta           JSONSerializable `json:"meta" gorm:"type:jsonb"`
	// The errors are only ever strings
	// DB example: [null, null, "my error"]
	AllErrors   RunErrors        `json:"all_errors" gorm:"type:jsonb"`
	FatalErrors RunErrors        `json:"fatal_errors" gorm:"type:jsonb"`
	Inputs      JSONSerializable `json:"inputs" gorm:"type:jsonb"`
	// Its expected that Output.Val is of type []interface{}.
	// DB example: [1234, {"a": 10}, null]
	Outputs          JSONSerializable `json:"outputs" gorm:"type:jsonb"`
	CreatedAt        time.Time        `json:"createdAt"`
	FinishedAt       null.Time        `json:"finishedAt"`
	PipelineTaskRuns []TaskRun        `json:"taskRuns" gorm:"foreignkey:PipelineRunID;->"`
	State            RunStatus        `json:"state"`

	Pending   bool `gorm:"-"`
	FailEarly bool `gorm:"-"`
}

func NewRun 

func NewRun(spec Spec, vars Vars) Run

func (*Run) ByDotID 

func (r *Run) ByDotID(id string) *TaskRun

func (Run) GetID 

func (r Run) GetID() string

func (Run) HasErrors 

func (r Run) HasErrors() bool

func (Run) HasFatalErrors added in v1.10.17 

func (r Run) HasFatalErrors() bool

func (*Run) SetID 

func (r *Run) SetID(value string) error

func (*Run) Status 

func (r *Run) Status() RunStatus

Status determines the status of the run.

func (Run) TableName 

func (Run) TableName() string

type RunErrors 

type RunErrors []null.String

func (RunErrors) HasError 

func (re RunErrors) HasError() bool

func (*RunErrors) Scan 

func (re *RunErrors) Scan(value interface{}) error

func (RunErrors) Value 

func (re RunErrors) Value() (driver.Value, error)

type RunInfo added in v1.10.17 

type RunInfo struct {
	IsRetryable bool
	IsPending   bool
}

RunInfo contains additional information about the finished TaskRun

type RunStatus 

type RunStatus string

RunStatus represents the status of a run 

const (
	// RunStatusUnknown is the when the run status cannot be determined.
	RunStatusUnknown RunStatus = "unknown"
	// RunStatusRunning is used for when a run is actively being executed.
	RunStatusRunning RunStatus = "running"
	// RunStatusSuspended is used when a run is paused and awaiting further results.
	RunStatusSuspended RunStatus = "suspended"
	// RunStatusErrored is used for when a run has errored and will not complete.
	RunStatusErrored RunStatus = "errored"
	// RunStatusCompleted is used for when a run has successfully completed execution.
	RunStatusCompleted RunStatus = "completed"
)

func (RunStatus) Completed 

func (s RunStatus) Completed() bool

Completed returns true if the status is RunStatusCompleted.

func (RunStatus) Errored 

func (s RunStatus) Errored() bool

Errored returns true if the status is RunStatusErrored.

func (RunStatus) Finished 

func (s RunStatus) Finished() bool

Finished returns true if the status is final and can't be changed.

type Runner 

type Runner interface {
	service.Service

	// Run is a blocking call that will execute the run until no further progress can be made.
	// If `incomplete` is true, the run is only partially complete and is suspended, awaiting to be resumed when more data comes in.
	// Note that `saveSuccessfulTaskRuns` value is ignored if the run contains async tasks.
	Run(ctx context.Context, run *Run, l logger.Logger, saveSuccessfulTaskRuns bool, fn func(tx *gorm.DB) error) (incomplete bool, err error)
	ResumeRun(taskID uuid.UUID, value interface{}, err error) error

	// We expect spec.JobID and spec.JobName to be set for logging/prometheus.
	// ExecuteRun executes a new run in-memory according to a spec and returns the results.
	ExecuteRun(ctx context.Context, spec Spec, vars Vars, l logger.Logger) (run Run, trrs TaskRunResults, err error)
	// InsertFinishedRun saves the run results in the database.
	InsertFinishedRun(db postgres.Queryer, run Run, saveSuccessfulTaskRuns bool) (int64, error)

	// ExecuteAndInsertFinishedRun executes a new run in-memory according to a spec, persists and saves the results.
	// It is a combination of ExecuteRun and InsertFinishedRun.
	// Note that the spec MUST have a DOT graph for this to work.
	ExecuteAndInsertFinishedRun(ctx context.Context, spec Spec, vars Vars, l logger.Logger, saveSuccessfulTaskRuns bool) (runID int64, finalResult FinalResult, err error)

	// Test method for inserting completed non-pipeline job runs
	TestInsertFinishedRun(db *gorm.DB, jobID int32, jobName string, jobType string, specID int32) (int64, error)

	OnRunFinished(func(*Run))
}

type SliceParam 

type SliceParam []interface{}

func (SliceParam) FilterErrors 

func (s SliceParam) FilterErrors() (SliceParam, int)

func (*SliceParam) UnmarshalPipelineParam 

func (s *SliceParam) UnmarshalPipelineParam(val interface{}) error

type Spec 

type Spec struct {
	ID              int32           `gorm:"primary_key"`
	DotDagSource    string          `json:"dotDagSource"`
	CreatedAt       time.Time       `json:"-"`
	MaxTaskDuration models.Interval `json:"-"`

	JobID   int32  `gorm:"-" json:"-"`
	JobName string `gorm:"-" json:"-"`
}

func (Spec) Pipeline 

func (s Spec) Pipeline() (*Pipeline, error)

func (Spec) TableName 

func (Spec) TableName() string

type StringParam 

type StringParam string

func (*StringParam) UnmarshalPipelineParam 

func (s *StringParam) UnmarshalPipelineParam(val interface{}) error

type SumTask 

type SumTask struct {
	BaseTask      `mapstructure:",squash"`
	Values        string `json:"values"`
	AllowedFaults string `json:"allowedFaults"`
}

Return types: 

*decimal.Decimal

func (*SumTask) Run 

func (t *SumTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*SumTask) Type 

func (t *SumTask) Type() TaskType

type Task 

type Task interface {
	Type() TaskType
	ID() int
	DotID() string
	Run(ctx context.Context, vars Vars, inputs []Result) (Result, RunInfo)
	Base() *BaseTask
	Outputs() []Task
	Inputs() []Task
	OutputIndex() int32
	TaskTimeout() (time.Duration, bool)
	TaskRetries() uint32
	TaskMinBackoff() time.Duration
	TaskMaxBackoff() time.Duration
}

func UnmarshalTaskFromMap 

func UnmarshalTaskFromMap(taskType TaskType, taskMap interface{}, ID int, dotID string) (_ Task, err error)

type TaskRun 

type TaskRun struct {
	ID            uuid.UUID        `json:"id" gorm:"primary_key"`
	Type          TaskType         `json:"type"`
	PipelineRun   Run              `json:"-"`
	PipelineRunID int64            `json:"-"`
	Output        JSONSerializable `json:"output" gorm:"type:jsonb"`
	Error         null.String      `json:"error"`
	CreatedAt     time.Time        `json:"createdAt"`
	FinishedAt    null.Time        `json:"finishedAt"`
	Index         int32            `json:"index"`
	DotID         string           `json:"dotId"`
	// contains filtered or unexported fields
}

func (TaskRun) GetDotID 

func (tr TaskRun) GetDotID() string

func (TaskRun) GetID 

func (tr TaskRun) GetID() string

func (*TaskRun) IsPending 

func (tr *TaskRun) IsPending() bool

func (TaskRun) Result 

func (tr TaskRun) Result() Result

func (*TaskRun) SetID 

func (tr *TaskRun) SetID(value string) error

func (TaskRun) TableName 

func (TaskRun) TableName() string

type TaskRunResult 

type TaskRunResult struct {
	ID         uuid.UUID
	Task       Task
	TaskRun    TaskRun
	Result     Result
	Attempts   uint
	CreatedAt  time.Time
	FinishedAt null.Time
	// contains filtered or unexported fields
}

TaskRunResult describes the result of a task run, suitable for database update or insert. ID might be zero if the TaskRun has not been inserted yet TaskSpecID will always be non-zero

func (*TaskRunResult) IsPending 

func (result *TaskRunResult) IsPending() bool

func (*TaskRunResult) IsTerminal 

func (result *TaskRunResult) IsTerminal() bool

type TaskRunResults 

type TaskRunResults []TaskRunResult

TaskRunResults represents a collection of results for all task runs for one pipeline run

func (TaskRunResults) FinalResult 

func (trrs TaskRunResults) FinalResult() FinalResult

FinalResult pulls the FinalResult for the pipeline_run from the task runs It needs to respect the output index of each task

type TaskType 

type TaskType string
const (
	TaskTypeHTTP             TaskType = "http"
	TaskTypeBridge           TaskType = "bridge"
	TaskTypeMean             TaskType = "mean"
	TaskTypeMedian           TaskType = "median"
	TaskTypeMode             TaskType = "mode"
	TaskTypeSum              TaskType = "sum"
	TaskTypeMultiply         TaskType = "multiply"
	TaskTypeDivide           TaskType = "divide"
	TaskTypeJSONParse        TaskType = "jsonparse"
	TaskTypeCBORParse        TaskType = "cborparse"
	TaskTypeAny              TaskType = "any"
	TaskTypeVRF              TaskType = "vrf"
	TaskTypeVRFV2            TaskType = "vrfv2"
	TaskTypeEstimateGasLimit TaskType = "estimategaslimit"
	TaskTypeETHCall          TaskType = "ethcall"
	TaskTypeETHTx            TaskType = "ethtx"
	TaskTypeETHABIEncode     TaskType = "ethabiencode"
	TaskTypeETHABIEncode2    TaskType = "ethabiencode2"
	TaskTypeETHABIDecode     TaskType = "ethabidecode"
	TaskTypeETHABIDecodeLog  TaskType = "ethabidecodelog"
	TaskTypeMerge            TaskType = "merge"

	// Testing only.
	TaskTypePanic TaskType = "panic"
	TaskTypeMemo  TaskType = "memo"
	TaskTypeFail  TaskType = "fail"
)

func (TaskType) String 

func (t TaskType) String() string

type TxManager 

type TxManager interface {
	CreateEthTransaction(db *gorm.DB, newTx bulletprooftxmanager.NewTx) (etx bulletprooftxmanager.EthTx, err error)
}

type URLParam 

type URLParam url.URL

func (*URLParam) String 

func (u *URLParam) String() string

func (*URLParam) UnmarshalPipelineParam 

func (u *URLParam) UnmarshalPipelineParam(val interface{}) error

type Uint64Param 

type Uint64Param uint64

func (*Uint64Param) UnmarshalPipelineParam 

func (u *Uint64Param) UnmarshalPipelineParam(val interface{}) error

type VRFKeyStore 

type VRFKeyStore interface {
	GenerateProof(id string, seed *big.Int) (vrfkey.Proof, error)
}

type VRFTask 

type VRFTask struct {
	BaseTask           `mapstructure:",squash"`
	PublicKey          string `json:"publicKey"`
	RequestBlockHash   string `json:"requestBlockHash"`
	RequestBlockNumber string `json:"requestBlockNumber"`
	Topics             string `json:"topics"`
	// contains filtered or unexported fields
}

func (*VRFTask) Run 

func (t *VRFTask) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*VRFTask) Type 

func (t *VRFTask) Type() TaskType

type VRFTaskV2 added in v1.10.17 

type VRFTaskV2 struct {
	BaseTask           `mapstructure:",squash"`
	PublicKey          string `json:"publicKey"`
	RequestBlockHash   string `json:"requestBlockHash"`
	RequestBlockNumber string `json:"requestBlockNumber"`
	Topics             string `json:"topics"`
	// contains filtered or unexported fields
}

func (*VRFTaskV2) Run added in v1.10.17 

func (t *VRFTaskV2) Run(_ context.Context, vars Vars, inputs []Result) (result Result, runInfo RunInfo)

func (*VRFTaskV2) Type added in v1.10.17 

func (t *VRFTaskV2) Type() TaskType

type Vars 

type Vars struct {
	// contains filtered or unexported fields
}

func NewVarsFrom 

func NewVarsFrom(m map[string]interface{}) Vars

func (Vars) Copy 

func (vars Vars) Copy() Vars

func (Vars) Get 

func (vars Vars) Get(keypathStr string) (interface{}, error)

func (Vars) Set 

func (vars Vars) Set(dotID string, value interface{})

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.