proto

type CreateRequestParams struct {
	Type string                 // the type of request being made
	Args map[string]interface{} // the arguments for the request
	User string                 // the user making the request
}

type FinishRequestParams struct {
	State byte // the final state of the chain
}

type Job struct {
	Id        string                 `json:"id"`        // unique id
	Type      string                 `json:"type"`      // user-specific job type
	Bytes     []byte                 `json:"bytes"`     // return value of Job.Serialize method
	State     byte                   `json:"state"`     // STATE_* const
	Args      map[string]interface{} `json:"args"`      // the jobArgs a job was created with
	Data      map[string]interface{} `json:"data"`      // job-specific data during Job.Run
	Retry     uint                   `json:"retry"`     // retry N times if first run fails
	RetryWait uint                   `json:"retryWait"` // wait time (milliseconds) between retries
}

type JobChain struct {
	RequestId     string              `json:"requestId"`     // unique identifier for the chain
	Jobs          map[string]Job      `json:"jobs"`          // Job.Id => job
	AdjacencyList map[string][]string `json:"adjacencyList"` // Job.Id => next []Job.Id
	State         byte                `json:"state"`         // STATE_* const
}

type JobChainStatus struct {
	RequestId   string      `json:"requestId"`
	JobStatuses JobStatuses `json:"jobStatuses"`
}

type JobLog struct {
	// These three fields uniquely identify an entry in the job log.
	RequestId string `json:"requestId"`
	JobId     string `json:"jobId"`
	Try       uint   `json:"try"` // try number N of 1 + Job.Retry

	Type       string `json:"type"`       // the type of the job
	StartedAt  int64  `json:"startedAt"`  // when the job runner started the job
	FinishedAt int64  `json:"finishedAt"` // when the job returned, regardless of state

	State  byte   `json:"state"`  // STATE_* const
	Exit   int64  `json:"exit"`   // unix exit code
	Error  string `json:"error"`  // error message
	Stdout string `json:"stdout"` // stdout output
	Stderr string `json:"stderr"` // stderr output
}

type JobStatus struct {
	RequestId string  `json:"requestId"`
	JobId     string  `json:"jobId"`
	State     byte    `json:"state"`
	Status    string  `json:"status"`  // @todo: job.Status()
	Runtime   float64 `json:"runtime"` // seconds
	N         uint    `json:"n"`       // Nth job ran in chain
}

type JobStatusByRuntime []JobStatus

type JobStatuses []JobStatus

type Jobs []Job

type Request struct {
	Id    string `json:"id"`    // unique identifier for the request
	Type  string `json:"type"`  // the type of request
	State byte   `json:"state"` // STATE_* const
	User  string `json:"user"`  // the user who made the request

	CreatedAt time.Time `json:"createdAt"` // when the request was created
	// These are pointers so that they can have nil values.
	StartedAt  *time.Time `json:"startedAt"`  // when the request was sent to the job runner
	FinishedAt *time.Time `json:"finishedAt"` // when the job runner finished the request. doesn't indicate success/failure

	JobChain     *JobChain `json:",omitempty"`   // the job chain
	TotalJobs    int       `json:"totalJobs"`    // the number of jobs in the request's job chain
	FinishedJobs int       `json:"finishedJobs"` // the number of finished jobs in the request
}

type RequestArg struct {
	Name     string
	Desc     string
	Required bool
	Default  string
}

type RequestSpec struct {
	Name string
	Args []RequestArg
}

type RequestStatus struct {
	Request        `json:"request"`
	JobChainStatus JobChainStatus `json:"jobChainStatus"`
}

type RunningStatus struct {
	Jobs     []JobStatus        `json:"jobs,omitempty"`
	Requests map[string]Request `json:"requests,omitempty"` // keyed on RequestId
}