worker

Documentation

Index

• func At(t ...time.Time) scheduled
• func Cron(c string) cron
• func Crons(c ...string) cronArr
• func Event(e string) event
• func Events(events ...string) eventsArr
• func NoTrigger() noTrigger
• type Action
• type HatchetContext
• type JobRunLookupData
• type MiddlewareFunc
• type RegisterActionOpt
  • func WithActionName(name string) RegisterActionOpt
• type Service
  • func (s *Service) Call(verb string) *WorkflowStep
  • func (s *Service) On(t triggerConverter, workflow workflowConverter) error
  • func (s *Service) RegisterAction(fn any, opts ...RegisterActionOpt) error
  • func (s *Service) Use(mws ...MiddlewareFunc)
• type StepData
• type StepRunData
• type TriggeredBy
• type Worker
  • func NewWorker(fs ...WorkerOpt) (*Worker, error)
  • func (w *Worker) Call(action string) *WorkflowStep
  • func (w *Worker) NewService(name string) *Service
  • func (w *Worker) On(t triggerConverter, workflow workflowConverter) error
  • func (w *Worker) RegisterAction(actionId string, method any) error
  • func (w *Worker) Start(ctx context.Context) error
  • func (w *Worker) Use(mws ...MiddlewareFunc)
• type WorkerOpt
  • func WithClient(client client.Client) WorkerOpt
  • func WithErrorAlerter(alerter errors.Alerter) WorkerOpt
  • func WithIntegration(integration integrations.Integration) WorkerOpt
  • func WithName(name string) WorkerOpt
• type WorkerOpts
• type Workflow
• type WorkflowJob
  • func (j *WorkflowJob) ToActionMap(svcName string) map[string]any
  • func (j *WorkflowJob) ToWorkflow(svcName string) types.Workflow
  • func (j *WorkflowJob) ToWorkflowJob(svcName string) (*types.WorkflowJob, error)
• type WorkflowStep
  • func Fn(f any) *WorkflowStep
  • func (w *WorkflowStep) AddParents(parents ...string) *WorkflowStep
  • func (w *WorkflowStep) GetActionId(svcName string, index int) string
  • func (w *WorkflowStep) GetStepId(index int) string
  • func (w *WorkflowStep) SetName(name string) *WorkflowStep
  • func (w *WorkflowStep) SetTimeout(timeout string) *WorkflowStep
  • func (w *WorkflowStep) ToActionMap(svcName string) map[string]any
  • func (w *WorkflowStep) ToWorkflow(svcName string) types.Workflow
  • func (w *WorkflowStep) ToWorkflowStep(svcName string, index int) (*step, error)

Functions

func At

func At(t ...time.Time) scheduled

func Cron

func Cron(c string) cron

func Crons

func Crons(c ...string) cronArr

func Event

func Event(e string) event

func Events

func Events(events ...string) eventsArr

func NoTrigger

func NoTrigger() noTrigger

Types

type Action

type Action interface {
	// Name returns the name of the action
	Name() string

	// Run runs the action
	Run(args ...any) []any

	MethodFn() any

	// Service returns the service that the action belongs to
	Service() string
}

Action is an individual action that can be run by the worker.

type HatchetContext

type HatchetContext interface {
	context.Context

	SetContext(ctx context.Context)

	GetContext() context.Context

	StepOutput(step string, target interface{}) error

	TriggeredByEvent() bool

	WorkflowInput(target interface{}) error
}

type JobRunLookupData

type JobRunLookupData struct {
	Input       map[string]interface{} `json:"input"`
	TriggeredBy TriggeredBy            `json:"triggered_by"`
	Steps       map[string]StepData    `json:"steps,omitempty"`
}

type MiddlewareFunc

type MiddlewareFunc func(ctx HatchetContext, next func(HatchetContext) error) error

type RegisterActionOpt

type RegisterActionOpt func(*registerActionOpts)

func WithActionName

func WithActionName(name string) RegisterActionOpt

type Service

type Service struct {
	Name string
	// contains filtered or unexported fields
}

func (*Service) Call

func (s *Service) Call(verb string) *WorkflowStep

func (*Service) On

func (s *Service) On(t triggerConverter, workflow workflowConverter) error

func (*Service) RegisterAction

func (s *Service) RegisterAction(fn any, opts ...RegisterActionOpt) error

func (*Service) Use

func (s *Service) Use(mws ...MiddlewareFunc)

type StepData

type StepData map[string]interface{}

type StepRunData

type StepRunData struct {
	Input       map[string]interface{} `json:"input"`
	TriggeredBy TriggeredBy            `json:"triggered_by"`
	Parents     map[string]StepData    `json:"parents"`
}

type TriggeredBy

type TriggeredBy string

TODO: move this into proto definitions

const (
	TriggeredByEvent    TriggeredBy = "event"
	TriggeredByCron     TriggeredBy = "cron"
	TriggeredBySchedule TriggeredBy = "schedule"
)

type Worker

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

func NewWorker

func NewWorker(fs ...WorkerOpt) (*Worker, error)

NewWorker creates a new worker instance

func (*Worker) Call

func (w *Worker) Call(action string) *WorkflowStep

func (*Worker) NewService

func (w *Worker) NewService(name string) *Service

func (*Worker) On

func (w *Worker) On(t triggerConverter, workflow workflowConverter) error

func (*Worker) RegisterAction

func (w *Worker) RegisterAction(actionId string, method any) error

RegisterAction can be used to register a single action which can be reused across multiple workflows.

An action should be of the format <service>:<verb>, for example slack:create-channel.

The method must match the following signatures: - func(ctx context.Context) error - func(ctx context.Context, input *Input) error - func(ctx context.Context, input *Input) (*Output, error) - func(ctx context.Context) (*Output, error)

func (*Worker) Start

func (w *Worker) Start(ctx context.Context) error

Start starts the worker in blocking fashion

func (*Worker) Use

func (w *Worker) Use(mws ...MiddlewareFunc)

type WorkerOpt

type WorkerOpt func(*WorkerOpts)

func WithClient

func WithClient(client client.Client) WorkerOpt

func WithErrorAlerter

func WithErrorAlerter(alerter errors.Alerter) WorkerOpt

func WithIntegration

func WithIntegration(integration integrations.Integration) WorkerOpt

func WithName

func WithName(name string) WorkerOpt

type WorkerOpts

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

type Workflow

type Workflow struct {
	Jobs []WorkflowJob
}

type WorkflowJob

type WorkflowJob struct {
	// The name of the job
	Name string

	Description string

	Timeout string

	// The steps that are run in the job
	Steps []*WorkflowStep
}

func (*WorkflowJob) ToActionMap

func (j *WorkflowJob) ToActionMap(svcName string) map[string]any

func (*WorkflowJob) ToWorkflow

func (j *WorkflowJob) ToWorkflow(svcName string) types.Workflow

func (*WorkflowJob) ToWorkflowJob

func (j *WorkflowJob) ToWorkflowJob(svcName string) (*types.WorkflowJob, error)

type WorkflowStep

type WorkflowStep struct {
	// The step timeout
	Timeout string

	// The executed function
	Function any

	// The step id/name. If not set, one will be generated from the function name
	Name string

	// The ids of the parents
	Parents []string
}

func Fn

func Fn(f any) *WorkflowStep

func (*WorkflowStep) AddParents

func (w *WorkflowStep) AddParents(parents ...string) *WorkflowStep

func (*WorkflowStep) GetActionId

func (w *WorkflowStep) GetActionId(svcName string, index int) string

func (*WorkflowStep) GetStepId

func (w *WorkflowStep) GetStepId(index int) string

func (*WorkflowStep) SetName

func (w *WorkflowStep) SetName(name string) *WorkflowStep

func (*WorkflowStep) SetTimeout

func (w *WorkflowStep) SetTimeout(timeout string) *WorkflowStep

func (*WorkflowStep) ToActionMap

func (w *WorkflowStep) ToActionMap(svcName string) map[string]any

func (*WorkflowStep) ToWorkflow

func (w *WorkflowStep) ToWorkflow(svcName string) types.Workflow

func (*WorkflowStep) ToWorkflowStep

func (w *WorkflowStep) ToWorkflowStep(svcName string, index int) (*step, error)