lykmapipo / kue-unique

Unique job utility for kue

kue-unique

Unique job utility for kue. If job already exists it will return it, otherwise it will create a new job and return it.

Requirements

• NodeJS v14.5+
• Npm v6.14+

Installation

$ npm install --save kue kue-unique

Usage

import kue from 'kue-unique';
const queue = kue.createQueue();

// create and save unique job
const job = queue.create('email', {
    title: 'welcome email for tj'
  , to: '[email protected]'
  , template: 'welcome-email'
})
.unique(<job_unique_identifier>)
.save((error, job) => {
   if( !error ) {
        console.log( job.id );
    }
});

// removing existing unique job
job.remove( (error, job) => {
   if( !error ) {
        console.log( job.id );
    }
})

Testing

• Clone this repository

• Install all development dependencies

npm install

• Run example

npm run examples

• Then run test

npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

License

The MIT License (MIT)

Copyright (c) lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

kue-unique's Issues

Save and remove callbacks must be used?

What does this mean?

Note!:To ensure unique jobs, save callback and remove callback must be passed when working with unique job(s)

Does is mean this will not work?

queue.create('jobName').unique('1234').save()

I have to add save and remove callbacks to every job that is created? Event if they don't do anything?

performance issue

When adding tons of jobs, iterating over all jobs ids creates a high cpu usage and delay process to add job

    //deserialize string to number
    //once fetched from redis
    _.forEach(data, function (value, key) {
      if (!isNaN(value)) {
        data[key] = parseInt(value);
      }
    });

A good way is to not iterate over this since it is not being used when adding a job. Also it should use redis sets for each queue type and not one set to all queue types

Make use of redis set to store unique job data

Remove from Kue-UI

If I try to remove a unique job from the Kue-UI and I try to re-create the unique job I receive this error:

Error controller Error: job "89" doesnt exist
at Command.callback (/Users/michele/Sites/pubcheck-kue/node_modules/kue/lib/queue/job.js:178:17)
at normal_reply (/Users/michele/Sites/pubcheck-kue/node_modules/redis/index.js:714:21)
at RedisClient.return_reply (/Users/michele/Sites/pubcheck-kue/node_modules/redis/index.js:816:9)
at JavascriptRedisParser.returnReply (/Users/michele/Sites/pubcheck-kue/node_modules/redis/index.js:188:18)
at JavascriptRedisParser.execute (/Users/michele/Sites/pubcheck-kue/node_modules/redis-parser/lib/parser.js:574:12)
at Socket. (/Users/michele/Sites/pubcheck-kue/node_modules/redis/index.js:267:27)
at emitOne (events.js:96:13)
at Socket.emit (events.js:188:7)
at readableAddChunk (_stream_readable.js:176:18)
at Socket.Readable.push (_stream_readable.js:134:10)
at TCP.onread (net.js:548:20)