job

type DeferFunc func(ctx context.Context, jobErr error) IDs

type ID string

type IDs []ID

type Job struct {
	// Func represents the job to execute
	Func func(ctx context.Context) error

	// Dir describes the directory which the job belongs to,
	// which is used for deduplication of queued jobs (along with Type)
	// and prioritization
	Dir document.DirHandle

	// Type describes type of the job (e.g. GetTerraformVersion),
	// which is used for deduplication of queued jobs along with Dir.
	Type string

	// Defer is a function to execute after Func is executed
	// and before the job is marked as done (StateDone).
	// This can be used to schedule jobs dependent on the main job.
	Defer DeferFunc
}

type JobStore interface {
	EnqueueJob(newJob Job) (ID, error)
	WaitForJobs(ctx context.Context, ids ...ID) error
}