Job Editing

Description

One of the most powerful and flexible methods within rethinkdb-job-queue is the Job.update method. It allows you, without restriction, to change any value of a job and save those changes back to the queue database.

This document will give you some examples of how you may use the Job.update method to perform advanced changes to jobs in the queue.

• Job Reanimation
• Job Data Changes
• Removing Job Data
• Disable Job

Job Reanimation

This example will show how to reanimate or re-run a job that has finished. A job is considered finished if it has either a completed, cancelled, or terminated status. See the Job Status document for more detail.

To start with, here is a JSON object representing a cancelled job.

{
  q: [Object],
  data: 'foo',
  dateCreated: 2016-09-19T03:07:44.394Z,
  dateEnable: 2016-09-19T03:12:44.451Z,
  dateFinished: 2016-09-19T03:07:44.469Z,
  dateStarted: 2016-09-19T03:07:44.451Z,
  id: '5127d082-fe7e-4e88-b1de-7093029695c3',
  log:
   [ { date: 2016-09-19T03:07:44.421Z,
       message: 'Job added to the queue',
       queueId: 'WebDev::rjqJobQueueTestJobs:1942:ebc89e54-f7d3-40a1-952a-3bb152d154ce',
       retryCount: 0,
       status: 'waiting',
       type: 'information' },
     { date: 2016-09-19T03:07:44.451Z,
       message: 'Job retrieved and active',
       queueId: 'WebDev::rjqJobQueueTestJobs:1942:ebc89e54-f7d3-40a1-952a-3bb152d154ce',
       retryCount: 0,
       status: 'active',
       type: 'information' },
     { date: 2016-09-19T03:07:44.470Z,
       message: 'The quick brown fox jumped over the lazy dog',
       queueId: 'WebDev::rjqJobQueueTestJobs:1942:ebc89e54-f7d3-40a1-952a-3bb152d154ce',
       retryCount: 0,
       status: 'cancelled',
       type: 'information' } ],
  priority: 'normal',
  progress: 0,
  queueId: 'WebDev::rjqJobQueueTestJobs:1942:ebc89e54-f7d3-40a1-952a-3bb152d154ce',
  retryCount: 0,
  retryDelay: 600000,
  retryMax: 3,
  status: 'cancelled',
  timeout: 300000
}

To re-run this job you will need to change three properties as follows.

• Status: Change the status from cancelled to waiting.
• retryCount: Set the retryCount to zero if it is not alreay zero.
• dateEnable: Set the dateEnable to now or a future date.

Here is the code to make these changes.

Assumptions:

• The job is already in the database with the properties above.
• We have the job id.

All we need to do it get the job and update its properties.

const Queue = require('rethinkdb-job-queue')
const q = new Queue()

q.getJob('5127d082-fe7e-4e88-b1de-7093029695c3').then((savedJobs) => {
  savedJobs[0].status = 'waiting'
  savedJobs[0].retryCount = 0
  savedJobs[0].dateEnable = new Date()
  return savedJobs[0].update('Job reanimated')
}).catch((err) => {
  console.error(err)
})

Job Data Changes

If for some reason you need to change the data associated with a job you can do so with the following code. For this example we need to change the job.data property from foo to bar.

Assumptions:

• The job is in the queue.
• The job has not been processed.
• The job.data property is set to foo.

const Queue = require('rethinkdb-job-queue')
const q = new Queue()

q.getJob('5127d082-fe7e-4e88-b1de-7093029695c3').then((savedJobs) => {
  savedJobs[0].data = 'bar'
  return savedJobs[0].update('Job data updated')
}).catch((err) => {
  console.error(err)
})

Removing Job Data

If for some reason you had extra data saved with a job and you need it removed for some security reason. You could do so easily enough as this example shows.

Assumptions:

• The job is in the queue.
• The job.secret property is set.

const Queue = require('rethinkdb-job-queue')
const q = new Queue()

q.getJob('5127d082-fe7e-4e88-b1de-7093029695c3').then((savedJobs) => {
  delete savedJobs[0].secret
  return savedJobs[0].update('Job secret removed')
}).catch((err) => {
  console.error(err)
})