proto

type CreateRequest 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 FinishRequest struct {
	State      byte      // the final state of the chain
	FinishedAt time.Time // when the Job Runner finished the request
}

type Job struct {
	Id            string                 `json:"id"`              // unique id
	Name          string                 `json:"name"`            // name of the job
	Type          string                 `json:"type"`            // user-specific job type
	Bytes         []byte                 `json:"bytes,omitempty"` // return value of Job.Serialize method
	State         byte                   `json:"state"`           // STATE_* const
	Args          map[string]interface{} `json:"args,omitempty"`  // the jobArgs a job was created with
	Data          map[string]interface{} `json:"data,omitempty"`  // 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
	SequenceId    string                 `json:"sequenceStartId"` // ID for first job in sequence
	SequenceRetry uint                   `json:"sequenceRetry"`   // retry sequence N times if first run fails. Only set for first job in sequence.
}

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 that is monotonically increasing
	SequenceTry uint   `json:"sequenceTry"` // try number N of 1 + Job's sequence retry
	SequenceId  string `json:"sequenceId"`  // ID of first job in sequence

	Name       string `json:"name"`
	Type       string `json:"type"`
	StartedAt  int64  `json:"startedAt"`  // when job started (UnixNano)
	FinishedAt int64  `json:"finishedAt"` // when job finished, regardless of state (UnixNano)

	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 JobLogById []JobLog

type JobStatus struct {
	RequestId string                 `json:"requestId"`
	JobId     string                 `json:"jobId"`
	Type      string                 `json:"type"`
	Name      string                 `json:"name"`
	Args      map[string]interface{} `json:"jobArgs"`
	StartedAt int64                  `json:"startedAt"` // when job started (UnixNano)
	State     byte                   `json:"state"`     // usually proto.STATE_RUNNING
	Status    string                 `json:"status"`    // @todo: job.Status()
	N         uint                   `json:"n"`         // Nth job ran in chain
}

type JobStatusByStartTime []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
	Args  []RequestArg `json:"args,omitempty"` // final request args (request_archives.args)

	CreatedAt  time.Time  `json:"createdAt"`  // when the request was created
	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"`   // job chain (request_archives.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

	JobRunnerURL string `json:"jrURL,omitempty"` // URL of the job runner running the request
}

type RequestArg struct {
	Pos     int // position in request spec relative to required:, optional:, or static: stanza
	Name    string
	Desc    string
	Type    string      // required, optional, static
	Given   bool        // true if Required or Optional and value given
	Default interface{} // default value if Optional or Static
	Value   interface{} // final value
}

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
}

type SuspendedJobChain struct {
	// Request corresponding to this SJC - unique identifier
	RequestId string    `json:"requestId"`
	JobChain  *JobChain `json:"jobChain"`

	// The total number of times a job has ever been tried, keyed on job.Id
	// This is the sum of the number of times the job was tried each time
	// that its sequence was tried.
	TotalJobTries map[string]uint `json:"totalJobTries"`

	// The number of times a job was tried the latest time it was run
	// (during the latest try of the sequence it's in), keyed on job.Id.
	LatestRunJobTries map[string]uint `json:"latestRunJobTries"`

	// The number of times a sequence has been tried, keyed on the
	// id of the first job in the sequence.
	SequenceTries map[string]uint `json:"sequenceTries"`
}