Cleanup script for Kue job queueing system in Node.js. Deletes failed, active and completed jobs after specified time. Can run on command line directly with "node kue_cleanup". Requires Kue installed :-)

kue_cleanup.js

var kue = require('kue'),
  jobs = kue.createQueue(),
  util = require('util'),
  noop = function() {};

jobs.CLEANUP_MAX_FAILED_TIME = 30 * 24 * 60 * 60 * 1000;  // 30 days
jobs.CLEANUP_MAX_ACTIVE_TIME = 1 * 24 * 60 * 60 * 1000;  // 1 day
jobs.CLEANUP_MAX_COMPLETE_TIME = 5 * 24 * 60 * 60 * 1000; // 5 days
jobs.CLEANUP_INTERVAL = 5 * 60 * 1000; // 5 minutes


// this is a simple log action
function QueueActionLog(message) {
  this.message = message || 'QueueActionLog :: got an action for job id(%s)';

  this.apply = function(job) {
    console.log(util.format(this.message, job.id));
    return true;
  };
}

// remove item action
function QueueActionRemove(age) {
  this.age = age;

  this.apply = function(job) {
    job.remove(noop);
    return true;
  };
}

// filter by age
function QueueFilterAge(age) {
  this.now = new Date();
  this.age = age;

  this.test = function(job) {
    var created = new Date(parseInt(job.created_at));
    var age = parseInt(this.now - created);

    return age > this.age;

  };
}

// the queue iterator
var queueIterator = function(ids, queueFilterChain, queueActionChain) {
  ids.forEach(function(id, index) {
    // get the kue job
    kue.Job.get(id, function(err, job) {
    	if (err || !job) return;
      var filterIterator = function(filter) { return filter.test(job) };
      var actionIterator = function(filter) { return filter.apply(job) };

      // apply filter chain
      if(queueFilterChain.every(filterIterator)) {

        // apply action chain
        queueActionChain.every(actionIterator);
      }
    });
  });
};

function performCleanup() {
  var ki = new kue;

  ki.failed(function(err, ids) {
    if (!ids) return;
    queueIterator(
      ids,
      [new QueueFilterAge(jobs.CLEANUP_MAX_FAILED_TIME)],
      [new QueueActionLog('Going to remove job id(%s) for being failed too long'),
        new QueueActionRemove()]
    );
  });

  ki.active(function(err, ids) {
    if (!ids) return;
    queueIterator(
      ids,
      [new QueueFilterAge(jobs.CLEANUP_MAX_ACTIVE_TIME)],
      [new QueueActionLog('Going to remove job id(%s) for being active too long'),
        new QueueActionRemove()]
    );
  });

  ki.complete(function(err, ids) {
    if (!ids) return;
    queueIterator(
      ids,
      [new QueueFilterAge(jobs.CLEANUP_MAX_COMPLETE_TIME)],
      [new QueueActionLog('Going to remove job id(%s) for being complete too long'),
        new QueueActionRemove()]
    );
  });
}

setInterval(performCleanup, jobs.CLEANUP_INTERVAL);

it does nothing, logs nothing. Any idea ?

Any instructions of how one would have to incorporate it to get it to work?

I had to make this change to get it to work:

// filter by age
function QueueFilterAge(age) {
    this.now = new Date().getTime();
    this.age = age;

    this.test = function(job) {
        var created = parseInt(job.created_at);
        var age = this.now - created;
        return age > this.age;
    };
 }

very nice script. congrats! =)

Great script. Thank you!

i take this inside my node server, i use 'node nameoffile' and 'node namefile.js', but it's not log anything, the cursos is lighting

it does nothing, logs nothing. Any idea ?
i take this inside my node server, i use 'node nameoffile' and 'node namefile.js', but it's not log anything, the cursos is lighting .
do you help me ?
@ktkaushik

@raphaelluiz128 not sure man. Kue is no longer maintained. I am currently using Agenda. There's also Bull which is nice.

Check feature comparison here.

@raphaelluiz128 @ktkaushik
It works, i run a test. if you cannot see the logs maybe because you need set other expiration times that the example already has. Also of curse you must have some stale jobs in your app if not you only see nothing.