job

type Config struct {
	// InstanceID specifis the ID of the instance.
	InstanceID string `envconfig:"INSTANCE_ID"`

	// MaxRunning is maximum number of jobs that can be running at once.
	BackgroundJobsMaxRunning int `envconfig:"JOBS_MAX_RUNNING" default:"10"`

	// RetentionTime is the duration after which non-recurring,
	// finished and failed jobs will be purged from the DB.
	BackgroundJobsRetentionTime time.Duration `envconfig:"JOBS_RETENTION_TIME" default:"120h"` // 5 days

}

type Definition struct {
	UID        string
	Type       string
	MaxRetries int
	Timeout    time.Duration
	Data       string
}

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

type Handler interface {
	Handle(ctx context.Context, input string, fn ProgressReporter) (result string, err error)
}

type Job struct {
	UID                 string   `db:"job_uid"                   gorm:"column:job_uid;primaryKey"`
	Created             int64    `db:"job_created"               gorm:"column:job_created"`
	Updated             int64    `db:"job_updated"               gorm:"column:job_updated"`
	Type                string   `db:"job_type"                  gorm:"column:job_type"`
	Priority            Priority `db:"job_priority"              gorm:"column:job_priority"`
	Data                string   `db:"job_data"                  gorm:"column:job_data"`
	Result              string   `db:"job_result"                gorm:"column:job_result"`
	MaxDurationSeconds  int      `db:"job_max_duration_seconds"  gorm:"column:job_max_duration_seconds"`
	MaxRetries          int      `db:"job_max_retries"           gorm:"column:job_max_retries"`
	State               State    `db:"job_state"                 gorm:"column:job_state"`
	Scheduled           int64    `db:"job_scheduled"             gorm:"column:job_scheduled"`
	TotalExecutions     int      `db:"job_total_executions"      gorm:"column:job_total_executions"`
	RunBy               string   `db:"job_run_by"                gorm:"column:job_run_by"`
	RunDeadline         int64    `db:"job_run_deadline"          gorm:"column:job_run_deadline"`
	RunProgress         int      `db:"job_run_progress"          gorm:"column:job_run_progress"`
	LastExecuted        int64    `db:"job_last_executed"         gorm:"column:job_last_executed"`
	IsRecurring         bool     `db:"job_is_recurring"          gorm:"column:job_is_recurring"`
	RecurringCron       string   `db:"job_recurring_cron"        gorm:"column:job_recurring_cron"`
	ConsecutiveFailures int      `db:"job_consecutive_failures"  gorm:"column:job_consecutive_failures"`
	LastFailureError    string   `db:"job_last_failure_error"    gorm:"column:job_last_failure_error"`
	GroupID             string   `db:"job_group_id"              gorm:"column:job_group_id"`
}

type Priority int

type Progress struct {
	State    State  `json:"state"`
	Progress int    `json:"progress"`
	Result   string `json:"result,omitempty"`
	Failure  string `json:"failure,omitempty"`
}

type ProgressReporter func(progress int, result string) error

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

type State string

type StateChange struct {
	UID      string `json:"uid"`
	Type     string `json:"type"`
	State    State  `json:"state"`
	Progress int    `json:"progress"`
	Result   string `json:"result"`
	Failure  string `json:"failure"`
}

type Store interface {
	// Find fetches a job by its unique identifier.
	Find(ctx context.Context, uid string) (*Job, error)

	// ListByGroupID fetches all jobs for a group id
	ListByGroupID(ctx context.Context, groupID string) ([]*Job, error)

	// DeleteByGroupID deletes all jobs for a group id
	DeleteByGroupID(ctx context.Context, groupID string) (int64, error)

	// Create is used to create a new job.
	Create(ctx context.Context, job *Job) error

	// Upsert will insert the job in the database if the job didn't already exist,
	// or it will update the existing one but only if its definition has changed.
	Upsert(ctx context.Context, job *Job) error

	// UpdateDefinition is used to update a job definition.
	UpdateDefinition(ctx context.Context, job *Job) error

	// UpdateExecution is used to update a job before and after execution.
	UpdateExecution(ctx context.Context, job *Job) error

	// UpdateProgress is used to update a job progress data.
	UpdateProgress(ctx context.Context, job *Job) error

	// CountRunning returns number of jobs that are currently being run.
	CountRunning(ctx context.Context) (int, error)

	// ListReady returns a list of jobs that are ready for execution.
	ListReady(ctx context.Context, now time.Time, limit int) ([]*Job, error)

	// ListDeadlineExceeded returns a list of jobs that have exceeded their execution deadline.
	ListDeadlineExceeded(ctx context.Context, now time.Time) ([]*Job, error)

	// NextScheduledTime returns a scheduled time of the next ready job.
	NextScheduledTime(ctx context.Context, now time.Time) (time.Time, error)

	// DeleteOld removes non-recurring jobs that have finished execution or have failed.
	DeleteOld(ctx context.Context, olderThan time.Time) (int64, error)

	// DeleteByUID deletes a job by its unique identifier.
	DeleteByUID(ctx context.Context, jobUID string) error
}