summaryrefslogtreecommitdiffstats
path: root/model
diff options
context:
space:
mode:
authorGeorge Goldberg <george@gberg.me>2017-07-20 16:25:35 +0100
committerChristopher Speller <crspeller@gmail.com>2017-07-20 08:25:35 -0700
commit6c6f2a1138447777bbf46cc2c40e1b3c47204466 (patch)
treec2630ad79a7bc12d6c0c0233098e29d6811cb99b /model
parent5ae701d133f713363e52b9cc6aa01579c81ebab4 (diff)
downloadchat-6c6f2a1138447777bbf46cc2c40e1b3c47204466.tar.gz
chat-6c6f2a1138447777bbf46cc2c40e1b3c47204466.tar.bz2
chat-6c6f2a1138447777bbf46cc2c40e1b3c47204466.zip
PLT-6595-Server: Job Management APIs. (#6931)
* PLT-6595-Server: Job Management APIs. * MANAGE_JOBS Permission * Fix test.
Diffstat (limited to 'model')
-rw-r--r--model/authorization.go7
-rw-r--r--model/client4.go36
-rw-r--r--model/job.go37
3 files changed, 74 insertions, 6 deletions
diff --git a/model/authorization.go b/model/authorization.go
index 458ed1bdb..880d25e27 100644
--- a/model/authorization.go
+++ b/model/authorization.go
@@ -58,6 +58,7 @@ var PERMISSION_MANAGE_TEAM *Permission
var PERMISSION_IMPORT_TEAM *Permission
var PERMISSION_VIEW_TEAM *Permission
var PERMISSION_LIST_USERS_WITHOUT_TEAM *Permission
+var PERMISSION_MANAGE_JOBS *Permission
// General permission that encompases all system admin functions
// in the future this could be broken up to allow access to some
@@ -292,6 +293,11 @@ func InitalizePermissions() {
"authentication.permisssions.list_users_without_team.name",
"authentication.permisssions.list_users_without_team.description",
}
+ PERMISSION_MANAGE_JOBS = &Permission{
+ "manage_jobs",
+ "authentication.permisssions.manage_jobs.name",
+ "authentication.permisssions.manage_jobs.description",
+ }
}
func InitalizeRoles() {
@@ -405,6 +411,7 @@ func InitalizeRoles() {
PERMISSION_CREATE_TEAM.Id,
PERMISSION_ADD_USER_TO_TEAM.Id,
PERMISSION_LIST_USERS_WITHOUT_TEAM.Id,
+ PERMISSION_MANAGE_JOBS.Id,
},
ROLE_TEAM_USER.Permissions...,
),
diff --git a/model/client4.go b/model/client4.go
index feff9f8de..6f5eb03c6 100644
--- a/model/client4.go
+++ b/model/client4.go
@@ -2800,7 +2800,7 @@ func (c *Client4) OpenGraph(url string) (map[string]string, *Response) {
// GetJob gets a single job.
func (c *Client4) GetJob(id string) (*Job, *Response) {
- if r, err := c.DoApiGet(c.GetJobsRoute()+fmt.Sprintf("/%v/status", id), ""); err != nil {
+ if r, err := c.DoApiGet(c.GetJobsRoute()+fmt.Sprintf("/%v", id), ""); err != nil {
return nil, BuildErrorResponse(r, err)
} else {
defer closeBody(r)
@@ -2808,12 +2808,42 @@ func (c *Client4) GetJob(id string) (*Job, *Response) {
}
}
-// GetJobsByType gets all jobs of a given type, sorted with the job that most recently started first.
+// Get all jobs, sorted with the job that was created most recently first.
+func (c *Client4) GetJobs(page int, perPage int) ([]*Job, *Response) {
+ if r, err := c.DoApiGet(c.GetJobsRoute()+fmt.Sprintf("?page=%v&per_page=%v", page, perPage), ""); err != nil {
+ return nil, BuildErrorResponse(r, err)
+ } else {
+ defer closeBody(r)
+ return JobsFromJson(r.Body), BuildResponse(r)
+ }
+}
+
+// GetJobsByType gets all jobs of a given type, sorted with the job that was created most recently first.
func (c *Client4) GetJobsByType(jobType string, page int, perPage int) ([]*Job, *Response) {
- if r, err := c.DoApiGet(c.GetJobsRoute()+fmt.Sprintf("/type/%v/statuses?page=%v&per_page=%v", jobType, page, perPage), ""); err != nil {
+ if r, err := c.DoApiGet(c.GetJobsRoute()+fmt.Sprintf("/type/%v?page=%v&per_page=%v", jobType, page, perPage), ""); err != nil {
return nil, BuildErrorResponse(r, err)
} else {
defer closeBody(r)
return JobsFromJson(r.Body), BuildResponse(r)
}
}
+
+// CreateJob creates a job based on the provided job struct.
+func (c *Client4) CreateJob(job *Job) (*Job, *Response) {
+ if r, err := c.DoApiPost(c.GetJobsRoute(), job.ToJson()); err != nil {
+ return nil, BuildErrorResponse(r, err)
+ } else {
+ defer closeBody(r)
+ return JobFromJson(r.Body), BuildResponse(r)
+ }
+}
+
+// CancelJob requests the cancellation of the job with the provided Id.
+func (c *Client4) CancelJob(jobId string) (bool, *Response) {
+ if r, err := c.DoApiPost(c.GetJobsRoute()+fmt.Sprintf("/%v/cancel", jobId), ""); err != nil {
+ return false, BuildErrorResponse(r, err)
+ } else {
+ defer closeBody(r)
+ return CheckStatusOK(r), BuildResponse(r)
+ }
+}
diff --git a/model/job.go b/model/job.go
index b0567bf1a..ebc849b30 100644
--- a/model/job.go
+++ b/model/job.go
@@ -6,6 +6,7 @@ package model
import (
"encoding/json"
"io"
+ "net/http"
)
const (
@@ -32,6 +33,36 @@ type Job struct {
Data map[string]interface{} `json:"data"`
}
+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:
+ case JOB_TYPE_SEARCH_INDEXING:
+ 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
+}
+
func (js *Job) ToJson() string {
if b, err := json.Marshal(js); err != nil {
return ""
@@ -41,9 +72,9 @@ func (js *Job) ToJson() string {
}
func JobFromJson(data io.Reader) *Job {
- var status Job
- if err := json.NewDecoder(data).Decode(&status); err == nil {
- return &status
+ var job Job
+ if err := json.NewDecoder(data).Decode(&job); err == nil {
+ return &job
} else {
return nil
}