job.go 3.15 KB
Newer Older
1
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
2 3 4 5
// See License.txt for license information.

package model

6 7 8
import (
	"encoding/json"
	"io"
9
	"net/http"
10
	"time"
11 12 13
)

const (
14
	JOB_TYPE_DATA_RETENTION                 = "data_retention"
15
	JOB_TYPE_MESSAGE_EXPORT                 = "message_export"
16 17
	JOB_TYPE_ELASTICSEARCH_POST_INDEXING    = "elasticsearch_post_indexing"
	JOB_TYPE_ELASTICSEARCH_POST_AGGREGATION = "elasticsearch_post_aggregation"
18
	JOB_TYPE_LDAP_SYNC                      = "ldap_sync"
19
	JOB_TYPE_MIGRATIONS                     = "migrations"
20 21 22 23 24 25 26 27 28 29

	JOB_STATUS_PENDING          = "pending"
	JOB_STATUS_IN_PROGRESS      = "in_progress"
	JOB_STATUS_SUCCESS          = "success"
	JOB_STATUS_ERROR            = "error"
	JOB_STATUS_CANCEL_REQUESTED = "cancel_requested"
	JOB_STATUS_CANCELED         = "canceled"
)

type Job struct {
30 31 32 33 34 35 36 37 38
	Id             string            `json:"id"`
	Type           string            `json:"type"`
	Priority       int64             `json:"priority"`
	CreateAt       int64             `json:"create_at"`
	StartAt        int64             `json:"start_at"`
	LastActivityAt int64             `json:"last_activity_at"`
	Status         string            `json:"status"`
	Progress       int64             `json:"progress"`
	Data           map[string]string `json:"data"`
39 40
}

41 42 43 44 45 46 47 48 49 50 51
func (j *Job) IsValid() *AppError {
	if len(j.Id) != 26 {
		return NewAppError("Job.IsValid", "model.job.is_valid.id.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	if j.CreateAt == 0 {
		return NewAppError("Job.IsValid", "model.job.is_valid.create_at.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	switch j.Type {
	case JOB_TYPE_DATA_RETENTION:
52
	case JOB_TYPE_ELASTICSEARCH_POST_INDEXING:
53
	case JOB_TYPE_ELASTICSEARCH_POST_AGGREGATION:
54
	case JOB_TYPE_LDAP_SYNC:
55
	case JOB_TYPE_MESSAGE_EXPORT:
56
	case JOB_TYPE_MIGRATIONS:
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
	default:
		return NewAppError("Job.IsValid", "model.job.is_valid.type.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	switch j.Status {
	case JOB_STATUS_PENDING:
	case JOB_STATUS_IN_PROGRESS:
	case JOB_STATUS_SUCCESS:
	case JOB_STATUS_ERROR:
	case JOB_STATUS_CANCEL_REQUESTED:
	case JOB_STATUS_CANCELED:
	default:
		return NewAppError("Job.IsValid", "model.job.is_valid.status.app_error", nil, "id="+j.Id, http.StatusBadRequest)
	}

	return nil
}

75
func (js *Job) ToJson() string {
Chris's avatar
Chris committed
76 77
	b, _ := json.Marshal(js)
	return string(b)
78 79 80
}

func JobFromJson(data io.Reader) *Job {
81 82 83
	var job Job
	if err := json.NewDecoder(data).Decode(&job); err == nil {
		return &job
84 85 86 87 88 89
	} else {
		return nil
	}
}

func JobsToJson(jobs []*Job) string {
Chris's avatar
Chris committed
90 91
	b, _ := json.Marshal(jobs)
	return string(b)
92 93 94 95 96 97 98 99 100 101 102 103
}

func JobsFromJson(data io.Reader) []*Job {
	var jobs []*Job
	if err := json.NewDecoder(data).Decode(&jobs); err == nil {
		return jobs
	} else {
		return nil
	}
}

func (js *Job) DataToJson() string {
Chris's avatar
Chris committed
104 105
	b, _ := json.Marshal(js.Data)
	return string(b)
106 107 108 109 110 111 112 113 114
}

type Worker interface {
	Run()
	Stop()
	JobChannel() chan<- Job
}

type Scheduler interface {
115 116 117 118 119
	Name() string
	JobType() string
	Enabled(cfg *Config) bool
	NextScheduleTime(cfg *Config, now time.Time, pendingJobs bool, lastSuccessfulJob *Job) *time.Time
	ScheduleJob(cfg *Config, pendingJobs bool, lastSuccessfulJob *Job) (*Job, *AppError)
120
}