mongodb-queue-up #

 

This is a fork of mongodb-queue@4 that adds support for MongoDB Driver v4, v5, v6, and v7.

A really light-weight way to create queues with a nice API if you're already
using MongoDB.

Now compatible with the MongoDB v4, v5, v6, and v7 drivers.

For MongoDB v3 driver use mongodb-queue@4.

For MongoDB v2 driver use mongodb-queue@3.

NOTE: This package is considered feature complete and STABLE hence there is not a whole lot of development on
it though it is being used extensively. Use it with all your might and let us know of any problems - it should be
bullet-proof.

Synopsis ##

Create a connection to your MongoDB database, and use it to create a queue object:

``js
var mongodb = require('mongodb')
var mongoDbQueue = require('mongodb-queue-up')

const url = 'mongodb://localhost:27017/'
const client = new mongodb.MongoClient(url)

client.connect(err => {
const db = client.db('test')
const queue = mongoDbQueue(db, 'my-queue')

// ...

})
`

Add a message to a queue:

`js
queue.add('Hello, World!', (err, id) => {
// Message with payload 'Hello, World!' added.
// 'id' is returned, useful for logging.
})
`

Get a message from the queue:

`js
queue.get((err, msg) => {
console.log('msg.id=' + msg.id)
console.log('msg.ack=' + msg.ack)
console.log('msg.payload=' + msg.payload) // 'Hello, World!'
console.log('msg.tries=' + msg.tries)
})
`

Ping a message to keep it's visibility open for long-running tasks

`js
queue.ping(msg.ack, (err, id) => {
// Visibility window now increased for this message id.
// 'id' is returned, useful for logging.
})
`

Ack a message (and remove it from the queue):

`js
queue.ack(msg.ack, (err, id) => {
// This msg removed from queue for this ack.
// The 'id' of the message is returned, useful for logging.
})
`

By default, all old messages - even processed ones - are left in MongoDB. This is so that
you can go and analyse them if you want. However, you can call the following function
to remove processed messages:

`js
queue.clean((err) => {
// All processed (ie. acked) messages have been deleted
})
`

And if you haven't already, you should call this to make sure indexes have
been added in MongoDB. Of course, if you've called this once (in some kind
one-off script) you don't need to call it in your program. Of course, check
the changelock to see if you need to update them with new releases:

`js
queue.createIndexes((err, indexName) => {
// The indexes needed have been added to MongoDB.
})
`

Creating a Queue ##

To create a queue, call the exported function with the MongoClient, the name
and a set of opts. The MongoDB collection used is the same name as the name
passed in:

`
var mongoDbQueue = require('mongodb-queue-up')

// an instance of a queue
var queue1 = mongoDbQueue(db, 'a-queue')
// another queue which uses the same collection as above
var queue2 = mongoDbQueue(db, 'a-queue')
`

Using queue1 and queue2 here won't interfere with each other and will play along nicely, but that's not
a good idea code-wise - just use the same object. This example is for illustrative purposes only.

Note: Don't use the same queue name twice with different options, otherwise behaviour is undefined and again
it's not something you should do.

To pass in options for the queue:

`
var resizeQueue = mongoDbQueue(db, 'resize-queue', { visibility : 30, delay : 15 })
`

This example shows a queue with a message visibility of 30s and a delay to each message of 15s.

Options ##

$3

This is the name of the MongoDB Collection you wish to use to store the messages.
Each queue you create will be it's own collection.

e.g.

`
var resizeImageQueue = mongoDbQueue(db, 'resize-image-queue')
var notifyOwnerQueue = mongoDbQueue(db, 'notify-owner-queue')
`

This will create two collections in MongoDB called resize-image-queue and notify-owner-queue.

$3

Default: 30

By default, if you don't ack a message within the first 30s after receiving it,
it is placed back in the queue so it can be fetched again. This is called the
visibility window.

You may set this visibility window on a per queue basis. For example, to set the
visibility to 15 seconds:

`
var queue = mongoDbQueue(db, 'queue', { visibility : 15 })
`

All messages in this queue now have a visibility window of 15s, instead of the
default 30s.

$3

Default: 0

When a message is added to a queue, it is immediately available for retrieval.
However, there are times when you might like to delay messages coming off a queue.
ie. if you set delay to be 10, then every message will only be available for
retrieval 10s after being added.

To delay all messages by 10 seconds, try this:

`
var queue = mongoDbQueue(db, 'queue', { delay : 10 })
`

This is now the default for every message added to the queue.

$3

Default: none

Messages that have been retried over maxRetries will be pushed to this queue so you can
automatically see problem messages.

Pass in a queue (that you created) onto which these messages will be pushed:

`js
var deadQueue = mongoDbQueue(db, 'dead-queue')
var queue = mongoDbQueue(db, 'queue', { deadQueue : deadQueue })
`

If you pop a message off the queue over maxRetries times and still have not acked it,
it will be pushed onto the deadQueue for you. This happens when you .get() (not when
you miss acking a message in it's visibility window). By doing it when you call .get(),
the unprocessed message will be received, pushed to the deadQueue, acked off the normal
queue and .get() will check for new messages prior to returning you one (or none).

$3

Default: 5

This option only comes into effect if you pass in a deadQueue as shown above. What this
means is that if an item is popped off the queue maxRetries times (e.g. 5) and not acked,
it will be moved to this deadQueue the next time it is tried to pop off. You can poll your
deadQueue for dead messages much like you can poll your regular queues.

The payload of the messages in the dead queue are the entire messages returned when .get()ing
them from the original queue.

e.g.

Given this message:

`
msg = {
id: '533b1eb64ee78a57664cc76c',
ack: 'c8a3cc585cbaaacf549d746d7db72f69',
payload: 'Hello, World!',
tries: 1
}
`

If it is not acked within the maxRetries times, then when you receive this same message
from the deadQueue, it may look like this:

`
msg = {
id: '533b1ecf3ca3a76b667671ef',
ack: '73872b204e3f7be84050a1ce82c5c9c0',
payload: {
id: '533b1eb64ee78a57664cc76c',
ack: 'c8a3cc585cbaaacf549d746d7db72f69',
payload: 'Hello, World!',
tries: 5
},
tries: 1
}
`

Notice that the payload from the deadQueue is exactly the same as the original message
when it was on the original queue (except with the number of tries set to 5).

Operations ##

$3

You can add a string to the queue:

`js
queue.add('Hello, World!', (err, id) => {
// Message with payload 'Hello, World!' added.
// 'id' is returned, useful for logging.
})
`

Or add an object of your choosing:

`js
queue.add({ err: 'E_BORKED', msg: 'Broken' }, (err, id) => {
// Message with payload { err: 'E_BORKED', msg: 'Broken' } added.
// 'id' is returned, useful for logging.
})
`

Or add multiple messages:

`js
queue.add(['msg1', 'msg2', 'msg3'], (err, ids) => {
// Messages with payloads 'msg1', 'msg2' & 'msg3' added.
// All 'id's are returned as an array, useful for logging.
})
`

You can delay individual messages from being visible by passing the delay option:

`js
queue.add('Later', { delay: 120 }, (err, id) => {
// Message with payload 'Later' added.
// 'id' is returned, useful for logging.
// This message won't be available for getting for 2 mins.
})
`

$3

Retrieve a message from the queue:

`js
queue.get((err, msg) => {
// You can now process the message
// IMPORTANT: The callback will not wait for an message if the queue is empty. The message will be undefined if the queue is empty.
})
`

You can choose the visibility of an individual retrieved message by passing the visibility option:

`js
queue.get({ visibility: 10 }, (err, msg) => {
// You can now process the message for 10s before it goes back into the queue if not ack'd instead of the duration that is set on the queue in general
})
`

Message will have the following structure:

`js
{
id: '533b1eb64ee78a57664cc76c', // ID of the message
ack: 'c8a3cc585cbaaacf549d746d7db72f69', // ID for ack and ping operations
payload: 'Hello, World!', // Payload passed when the message was addded
tries: 1 // Number of times this message has been retrieved from queue without being ack'd
}
`

$3

After you have received an item from a queue and processed it, you can delete it
by calling .ack() with the unique ackId returned:

`js
queue.get((err, msg) => {
queue.ack(msg.ack, (err, id) => {
// this message has now been removed from the queue
})
})
`

$3

After you have received an item from a queue and you are taking a while
to process it, you can .ping() the message to tell the queue that you are
still alive and continuing to process the message:

`js
queue.get((err, msg) => {
queue.ping(msg.ack, (err, id) => {
// this message has had it's visibility window extended
})
})
`

You can also choose the visibility time that gets added by the ping operation by passing the visibility option:

`js
queue.get((err, msg) => {
queue.ping(msg.ack, { visibility: 10 }, (err, id) => {
// this message has had it's visibility window extended by 10s instead of the visibilty set on the queue in general
})
})
`

$3

Returns the total number of messages that has ever been in the queue, including
all current messages:

`js
queue.total((err, count) => {
console.log('This queue has seen %d messages', count)
})
`

$3

Returns the total number of messages that are waiting in the queue.

`js
queue.size((err, count) => {
console.log('This queue has %d current messages', count)
})
`

Use listWaiting to get the messages, themselves.

$3

Returns the list of messages that are waiting in the queue.

`js
queue.listWaiting((err, messages) => {
console.log('This queue has %d current messages', messages.length)
})
`

The message structure will match get.

Use size to just get the count.

$3

Returns the total number of messages that are currently in flight, i.e. that
have been retrieved, not yet acknowledged, but are being pinged:

`js
queue.inFlight((err, count) => {
console.log('A total of %d messages are currently being processed', count)
})
`

Use listInFlight to get the messages, themselves.

$3

Returns the list of messages that are currently in flight, i.e. that
have been retrieved, not yet acknowledged, but are being pinged:

`js
queue.listInFlight((err, messages) => {
console.log('A total of %d messages are currently being processed', messages.length)
})
`

The message structure will match get.

Use inFlight to just get the count.

$3

Returns the total number of messages that are currently incomplete, i.e. that
have been retrieved, not yet acknowledged, but may or may not be getting pinged:

`js
queue.incomplete((err, count) => {
console.log('A total of %d messages are currently incomplete', count)
})
`

Use listIncomplete to get the messages, themselves.

$3

Returns the list of messages that are currently incomplete, i.e. that
have been retrieved, not yet acknowledged, but may or may not be getting pinged:

`js
queue.listIncomplete((err, messages) => {
console.log('A total of %d messages are currently incomplete', messages.length)
})
`

The message structure will match get.

Use incomplete to just get the count.

$3

Returns the total number of messages that have been processed correctly in the
queue:

`js
queue.done((err, count) => {
console.log('This queue has processed %d messages', count)
})
`

$3

Deletes all processed mesages from the queue. Of course, you can leave these hanging around
if you wish, but delete them if you no longer need them. Perhaps do this using setInterval
for a regular cleaning:

`js
queue.clean((err) => {
console.log('The processed messages have been deleted from the queue')
})
`

$3

If you add up .size() + .inFlight() + .done() then you should get .total()
(excluding any messages added with a delay)
but this will only be approximate since these are different operations hitting the database
at slightly different times. Hence, a message or two might be counted twice or not at all
depending on message turnover at any one time. You should not rely on these numbers for
anything but are included as approximations at any point in time.

Use of MongoDB ##

Whilst using MongoDB recently and having a need for lightweight queues, I realised
that the atomic operations that MongoDB provides are ideal for this kind of job.

Since everything it atomic, it is impossible to lose messages in or around your
application. I guess MongoDB could lose them but it's a safer bet it won't compared
to your own application.

As an example of the atomic nature being used, messages stay in the same collection
and are never moved around or deleted, just a couple of fields are set, incremented
or deleted. We always use MongoDB's excellent collection.findAndModify() so that
each message is updated atomically inside MongoDB and we never have to fetch something,
change it and store it back.

Roadmap ##

We may add the ability for each function to return a promise in the future so it can be used as such, or with
async/await.

Releases ##

$3

* [NEW] Added support for mongodb driver v7

$3

* [NEW] Replaced deleted:{$exists:true} with deleted:{$ne:null} for better index usage

$3

* [NEW] Added listWaiting, listInFlight, incomplete, and listIncomplete methods

$3

* [NEW] Added support for mongodb driver v6

$3

* [NEW] Added support for mongodb driver v5

$3

* [DOC] Fixed travis badge

$3

* [NEW] Added support for mongodb driver v4
* [NEW] Added typescript types

$3

* [NEW] Updated entire codebase to be compatible with the mongodb driver v3

$3

* [FIX] Fix to indexes (thanks https://github.com/ifightcrime) when lots of messages

$3

* [NEW] Update MongoDB API from v1 to v2 (thanks https://github.com/hanwencheng)

$3

* [NEW] Test changes only

$3

* [NEW] Ability to specify a visibility window when getting a message (thanks https://github.com/Gertt)

$3

* [NEW] Added .clean() method to remove old (processed) messages
* [NEW] Add 'delay' option to queue.add() so individual messages can be delayed separately
* [TEST] Test individual 'delay' option for each message

$3

* [FIX] Fix .ping() so only visible/non-deleted messages can be pinged
* [FIX] Fix .ack() so only visible/non-deleted messages can be pinged
* [TEST] Add test to make sure messages can't be acked twice
* [TEST] Add test to make sure an acked message can't be pinged
* [INTERNAL] Slight function name changes, nicer date routines

$3

* [NEW] The msg.id is now returned on successful Queue.ping() and Queue.ack() calls
* [NEW] Call quueue.ensureIndexes(callback) to create them
* [CHANGE] When a message is acked, 'deleted' is now set to the current time (not true)
* [CHANGE] The queue is now created synchronously

$3

* [NEW] Now adds two indexes onto the MongoDB collection used for the message
* [CHANGE] The queue is now created by calling the async exported function
* [DOC] Update to show how the queues are now created

$3

* [NEW] Ability to ping retrieved messages a. la. 'still alive' and 'extend visibility'
* [CHANGE] Removed ability to have different queues in the same collection
* [CHANGE] All queues are now stored in their own collection
* [CHANGE] When acking a message, only need ack (no longer need id)
* [TEST] Added test for pinged messages
* [DOC] Update to specify each queue will create it's own MongoDB collection
* [DOC] Added docs for option delay
* [DOC] Added synopsis for Queue.ping()
* [DOC] Removed use of msg.id when calling Queue.ack()

$3

* [DOC] Added documentation for the delay option

$3

* [NEW] Return the message id when added to a queue
* [NEW] Ability to set a default delay on all messages in a queue
* [FIX] Make sure old messages (outside of visibility window) aren't deleted when acked
* [FIX] Internal: Fix queueName`
* [TEST] Added test for multiple messages
* [TEST] Added test for delayed messages

$3

* [FIX] Fix when getting messages off an empty queue
* [NEW] More Tests

$3

* [NEW] messages now return number of tries (times they have been fetched)

$3

* [NEW] add messages to queues
* [NEW] fetch messages from queues
* [NEW] ack messages on queues
* [NEW] set up multiple queues
* [NEW] set your own MongoDB Collection name
* [NEW] set a visibility timeout on a queue

License ##

MIT

(Ends)