quasar_jobs/job

Durable job values and their state machine.

Types

ExecutionToken

opaque </>

Capability for one claim. The owner nonce changes even across manual retries. Generation is the attempt number; both fields must match atomically.

pub opaque type ExecutionToken

Job

opaque </>

pub opaque type Job

JobError

</>

pub type JobError {
  JobError(kind: String, message: String)
}

Constructors

```
JobError(kind: String, message: String)
```

JobId

opaque </>

pub opaque type JobId

NewJob

opaque </>

pub opaque type NewJob

Status

</>

pub type Status {
  Available
  Scheduled
  Executing
  Completed
  Retryable
  Discarded
  Cancelled
}

Constructors

```
Available
```
```
Scheduled
```
```
Executing
```
```
Completed
```
```
Retryable
```
```
Discarded
```
```
Cancelled
```

TransitionError

</>

pub type TransitionError {
  InvalidTransition(from: Status, operation: String)
  InvalidJob(String)
  StaleExecution
}

Constructors

InvalidTransition(from: Status, operation: String)

```
InvalidJob(String)
```
```
StaleExecution
```

Values

attempt

</>

pub fn attempt(job: Job) -> Int

attempted_at

</>

pub fn attempted_at(job: Job) -> option.Option(Int)

available_at

</>

pub fn available_at(job: Job) -> Int

cancel

</>

pub fn cancel(job: Job) -> Result(Job, TransitionError)

claim

</>

pub fn claim(
  job: Job,
  owner: String,
  now: Int,
  lease_expires_at: Int,
) -> Result(Job, TransitionError)

complete

</>

pub fn complete(
  job: Job,
  now: Int,
) -> Result(Job, TransitionError)

completed_at

</>

pub fn completed_at(job: Job) -> option.Option(Int)

encoded_payload

</>

pub fn encoded_payload(new_job: NewJob) -> String

error

</>

pub fn error(job: Job) -> option.Option(JobError)

error_kind

</>

pub fn error_kind(error: JobError) -> String

error_message

</>

pub fn error_message(error: JobError) -> String

execution_token

</>

pub fn execution_token(
  item: Job,
) -> Result(ExecutionToken, TransitionError)

fail

</>

pub fn fail(
  job: Job,
  error: JobError,
  available_at: Int,
) -> Result(Job, TransitionError)

id

</>

pub fn id(job: Job) -> JobId

id_to_string

</>

pub fn id_to_string(id: JobId) -> String

id_value

</>

pub fn id_value(id: JobId) -> Int

inserted_at

</>

pub fn inserted_at(job: Job) -> Int

lease_expires_at

</>

pub fn lease_expires_at(job: Job) -> option.Option(Int)

lease_owner

</>

pub fn lease_owner(job: Job) -> option.Option(String)

materialise

</>

pub fn materialise(
  new_job: NewJob,
  id: JobId,
  queue: String,
  available_at: Int,
  now: Int,
) -> Result(Job, TransitionError)

max_attempts

</>

pub fn max_attempts(job: Job) -> Int

new_id

</>

pub fn new_id(value: Int) -> JobId

new_job

</>

pub fn new_job(
  worker: String,
  payload: String,
  priority: Int,
  max_attempts: Int,
) -> NewJob

new_job_max_attempts

</>

pub fn new_job_max_attempts(new_job: NewJob) -> Int

new_job_priority

</>

pub fn new_job_priority(new_job: NewJob) -> Int

owns

</>

pub fn owns(item: Job, token: ExecutionToken) -> Bool

payload

</>

pub fn payload(job: Job) -> String

priority

</>

pub fn priority(job: Job) -> Int

queue

</>

pub fn queue(job: Job) -> String

ready

</>

pub fn ready(job: Job, queue: String, now: Int) -> Bool

recover_if_expired

</>

pub fn recover_if_expired(job: Job, now: Int) -> Job

restore

</>

pub fn restore(
  id: JobId,
  queue: String,
  worker: String,
  payload: String,
  status: Status,
  priority: Int,
  attempt: Int,
  max_attempts: Int,
  available_at: Int,
  inserted_at: Int,
  attempted_at: option.Option(Int),
  completed_at: option.Option(Int),
  lease_owner: option.Option(String),
  lease_expires_at: option.Option(Int),
  error_kind: option.Option(String),
  error_message: option.Option(String),
) -> Job

retry

</>

pub fn retry(job: Job, now: Int) -> Result(Job, TransitionError)

set_lease_expiry

</>

pub fn set_lease_expiry(job: Job, expires_at: Int) -> Job

status

</>

pub fn status(job: Job) -> Status

status_from_string

</>

pub fn status_from_string(
  status: String,
) -> Result(Status, String)

status_to_string

</>

pub fn status_to_string(status: Status) -> String

token_generation

</>

pub fn token_generation(token: ExecutionToken) -> Int

token_id

</>

pub fn token_id(token: ExecutionToken) -> JobId

token_owner

</>

pub fn token_owner(token: ExecutionToken) -> String

validate

</>

pub fn validate(new_job: NewJob) -> Result(Nil, TransitionError)

with_max_attempts

</>

pub fn with_max_attempts(
  new_job: NewJob,
  max_attempts: Int,
) -> NewJob

Changes the maximum number of execution attempts.

with_priority

</>

pub fn with_priority(new_job: NewJob, priority: Int) -> NewJob

Changes the priority used when a store claims ready jobs.

worker

</>

pub fn worker(job: Job) -> String

worker_name

</>

pub fn worker_name(new_job: NewJob) -> String