job_dispatcher

type Client struct {
	Endpoint       string     // endpoint of the job dispatcher
	UUID           uuid.UUID  // uuid of the client
	WorkerInstance string     // worker instance
	CurrentJob     *Job       // current job
	Bulk           bool       // use bulk endpoint
	Logger         *log.Entry // logger
}

type Job struct {
	UUID uuid.UUID `gorm:"type:varchar(36); primaryKey" json:"uuid"`
	// Metadata
	CreatedAt time.Time  `json:"createdAt"`
	UpdatedAt time.Time  `json:"updatedAt"`
	DeletedAt *time.Time `gorm:"index" json:"deletedAt"`
	// UUIDs
	MandateUID uuid.UUID `gorm:"index" gorm:"type:varchar(36);" json:"mandateUID"`
	ClientUID  uuid.UUID `gorm:"index" gorm:"type:varchar(36);" json:"clientUID"`
	OwnerUID   uuid.UUID `gorm:"index" gorm:"type:varchar(36);" json:"ownerUID"`
	// Attributes
	StartedAt         *time.Time             `gorm:"index" json:"startedAt"`                                              // the timestamp when the worker started on this job
	CompletedAt       *time.Time             `gorm:"index" json:"completedAt"`                                            // the timestamp when the worker finished the job
	LastHeartBeat     *time.Time             `gorm:"index" json:"lastHeartBeat"`                                          // the last time the worker was working on this job
	Name              string                 `json:"name" gorm:"type:varchar(100);"`                                      // a short and optional name
	Priority          uint                   `gorm:"index" json:"priority" gorm:"default:1;"`                             // the priority of the job (1 lowest priority, ... 10 high priority)
	Attempts          uint                   `gorm:"index" json:"attempts" gorm:"default:0;"`                             // the attempts that have been tried in the past
	CurrentWorkerUID  *uuid.UUID             `gorm:"index" json:"currentWorkerUID" gorm:"type:varchar(36); default:null"` // the uuid of the the worker bot that is currently working in this job
	WorkerInstance    string                 `gorm:"index" json:"workerInstance" gorm:"index:worker_instance;"`           // the type of worker that should work on this job
	Parameters        map[string]string      `json:"parameters" gorm:"-"`                                                 // the search parameters the worker should use (e.g. company names ... )
	ParametersJSON    datatypes.JSON         `json:"-" gorm:"type:jsonb;"`                                                // json
	Tasks             []JobTask              `json:"tasks" gorm:"-"`                                                      // the way the worker should interact (e.g. click on that, extract this, store it in this bucket, ...)
	TasksJSON         datatypes.JSON         `json:"-" gorm:"type:jsonb;"`                                                // json
	CurrentStatus     map[string]interface{} `json:"currentStatus" gorm:"-"`                                              // the current status of the job
	CurrentStatusJSON datatypes.JSON         `json:"-" gorm:"type:jsonb;"`                                                // json
}

type JobService interface {
	New(*Job) error
	BulkNew([]*Job) error
	GetJobByUUID(uuid uuid.UUID) (*Job, error)
	Start(*Job) error
	HeartBeat(*Job, map[string]interface{}) error
	Release(*Job) error
	Complete(*Job) error
	GetLatestJob(workerInstances []string, workerUUID uuid.UUID) (*Job, error)
	GetCurrentJobOfWorker(workerInstances []string, workerUUID uuid.UUID) (*Job, bool, error)
	Clean() error
	GetStats() ([]Stats, error)
}

type JobTask struct {
	Version string      `json:"version"`
	Name    string      `json:"name"`
	Type    string      `json:"type"`
	Execute interface{} `json:"execute"`
}

type NewJobDTO struct {
	Name           string            `json:"name"`
	WorkerInstance string            `json:"workerInstance"`
	Priority       uint              `json:"priority"`
	Params         map[string]string `json:"params"`
	Tasks          []JobTask         `json:"tasks"`
}

type ResponseDTO struct {
	Status string `json:"status"`
	Job    *Job   `json:"job"`
}

type ResponseMultipleDTO struct {
	Status string `json:"status"`
	Jobs   []*Job `json:"jobs"`
}

type Stats struct {
	WorkerInstance string
	Total          int
	Todo           int
	Done           int
	Active         int
}