github.com/cozy/cozy-stack@v0.0.0-20240603063001-31110fa4cae1/client/jobs.go

package client

import (
	"encoding/json"
	"fmt"
	"net/url"
	"time"

	"github.com/cozy/cozy-stack/client/request"
)

type jobOptions struct {
	MaxExecCount int            `json:"max_exec_count,omitempty"`
	Timeout      *time.Duration `json:"timeout,omitempty"`
}

// JobOptions is the options to run a job.
type JobOptions struct {
	Worker       string
	Arguments    interface{}
	MaxExecCount int
	Timeout      *time.Duration
	Logs         chan *JobLog
}

// JobLog is a log being outputted by the running job.
type JobLog struct {
	Time    time.Time              `json:"time"`
	Message string                 `json:"message"`
	Level   string                 `json:"level"`
	Data    map[string]interface{} `json:"data"`
}

// Job is a struct representing a job
type Job struct {
	ID    string `json:"id"`
	Rev   string `json:"rev"`
	Attrs struct {
		Domain    string          `json:"domain"`
		TriggerID string          `json:"trigger_id"`
		Message   json.RawMessage `json:"message"`
		Debounced bool            `json:"debounced"`
		Event     struct {
			Domain string          `json:"domain"`
			Verb   string          `json:"verb"`
			Doc    json.RawMessage `json:"doc"`
			OldDoc json.RawMessage `json:"old,omitempty"`
		} `json:"event"`
		Options   *jobOptions `json:"options"`
		QueuedAt  time.Time   `json:"queued_at"`
		StartedAt time.Time   `json:"started_at"`
		State     string      `json:"state"`
		Worker    string      `json:"worker"`
	} `json:"attributes"`
}

// Trigger is a struct representing a trigger
type Trigger struct {
	ID    string `json:"id"`
	Rev   string `json:"rev"`
	Attrs struct {
		Domain     string          `json:"domain"`
		Type       string          `json:"type"`
		WorkerType string          `json:"worker"`
		Arguments  string          `json:"arguments"`
		Debounce   string          `json:"debounce"`
		Message    json.RawMessage `json:"message"`
		Options    *struct {
			MaxExecCount int           `json:"max_exec_count"`
			Timeout      time.Duration `json:"timeout"`
		} `json:"options"`
	} `json:"attributes"`
}

// JobPush is used to push a new job into the job queue.
func (c *Client) JobPush(r *JobOptions) (*Job, error) {
	args, err := json.Marshal(r.Arguments)
	if err != nil {
		return nil, err
	}

	type jobAttrs struct {
		Arguments   json.RawMessage `json:"arguments"`
		ForwardLogs bool            `json:"forward_logs"`
		Options     *jobOptions     `json:"options"`
	}

	opt := &jobOptions{}
	if r.MaxExecCount > 0 {
		opt.MaxExecCount = r.MaxExecCount
	}
	if r.Timeout != nil {
		opt.Timeout = r.Timeout
	}

	withLogs := r.Logs != nil
	var channel *RealtimeChannel
	if withLogs {
		channel, err = c.RealtimeClient(RealtimeOptions{
			DocTypes: []string{"io.cozy.jobs", "io.cozy.jobs.logs"},
		})
		if err != nil {
			return nil, err
		}
	}

	job := struct {
		Attrs jobAttrs `json:"attributes"`
	}{
		Attrs: jobAttrs{
			Arguments:   args,
			ForwardLogs: withLogs,
			Options:     opt,
		},
	}
	body, err := writeJSONAPI(job)
	if err != nil {
		return nil, err
	}
	res, err := c.Req(&request.Options{
		Method: "POST",
		Path:   "/jobs/queue/" + url.PathEscape(r.Worker),
		Body:   body,
	})
	if err != nil {
		return nil, err
	}

	var j *Job
	if err = readJSONAPI(res.Body, &j); err != nil {
		return nil, err
	}

	defer func() {
		if withLogs {
			close(r.Logs)
		}
	}()

	if withLogs {
		for evt := range channel.Channel() {
			if evt.Event == "error" {
				return nil, fmt.Errorf("realtime: %s", evt.Payload.Title)
			}
			switch evt.Payload.Type {
			case "io.cozy.jobs":
				var doc struct {
					ID string `json:"_id"`
				}
				if err = json.Unmarshal(evt.Payload.Doc, &doc); err != nil {
					return nil, err
				}
				if doc.ID != j.ID {
					continue
				}
				if err = json.Unmarshal(evt.Payload.Doc, &j.Attrs); err != nil {
					return nil, err
				}
				if j.Attrs.State == "done" || j.Attrs.State == "errored" {
					return j, nil
				}
			case "io.cozy.jobs.logs":
				var log JobLog
				if err = json.Unmarshal(evt.Payload.Doc, &log); err != nil {
					return nil, err
				}
				r.Logs <- &log
			}
		}
	}

	return j, nil
}

// GetTrigger return the trigger with the specified ID.
func (c *Client) GetTrigger(triggerID string) (*Trigger, error) {
	res, err := c.Req(&request.Options{
		Method: "GET",
		Path:   fmt.Sprintf("/jobs/triggers/%s", url.PathEscape(triggerID)),
	})
	if err != nil {
		return nil, err
	}
	var t *Trigger
	if err := readJSONAPI(res.Body, &t); err != nil {
		return nil, err
	}
	return t, nil
}

// GetTriggers returns the list of all triggers with the specified worker type.
func (c *Client) GetTriggers(worker string) ([]*Trigger, error) {
	res, err := c.Req(&request.Options{
		Method:  "GET",
		Path:    "/jobs/triggers",
		Queries: url.Values{"Worker": {worker}},
	})
	if err != nil {
		return nil, err
	}
	var t []*Trigger
	if err := readJSONAPI(res.Body, &t); err != nil {
		return nil, err
	}
	return t, nil
}

// TriggerLaunch launches manually the trigger with the specified ID.
func (c *Client) TriggerLaunch(triggerID string) (*Job, error) {
	res, err := c.Req(&request.Options{
		Method: "POST",
		Path:   fmt.Sprintf("/jobs/triggers/%s/launch", url.PathEscape(triggerID)),
	})
	if err != nil {
		return nil, err
	}
	var j *Job
	if err := readJSONAPI(res.Body, &j); err != nil {
		return nil, err
	}
	return j, nil
}

// ListTriggers returns the list of all triggers for an instance.
func (c *Client) ListTriggers() ([]*Trigger, error) {
	res, err := c.Req(&request.Options{
		Method: "GET",
		Path:   "/jobs/triggers",
	})
	if err != nil {
		return nil, err
	}
	var list []*Trigger
	if err := readJSONAPI(res.Body, &list); err != nil {
		return nil, err
	}
	return list, nil
}