quiddity-agent

---

$3

- Quiddity is a simple server that connects to MongoDB and exposes few APIs like __push__, __fetch__ & __delete__.
- A seperate light-weight agent consumes these APIs and allows the user to push/pull messages from the queue.
- The user can also have multiple agents working on the queue.

---

$3

Install from NPM
``
npm install quiddity-agent
`

---

$3

Intitalise the agent simply by creating a new instance -
`js
const Queue = require("quiddity-agent")
`

Create a new queue by passing the queueName -
`js
const queue = new Queue("testQueue")
`

Push new messages into queue -
`js
queue.push({ foo: "bar", ...})
// Above returns a promise
`

Pull new messages from queue -
`js
queue.pull((message, done) => {
// Do heavy work with "message"
// Call done() to acknowledge job completion
done()
})
`

Error handling -
`js
queue.pull((message, done) => {

// In case of an error, you can notify using
done(new Error("Something went wrong..."))

// OR you can also throw a new Error without calling done()
throw new Error("Something went wrong...")
})
`

---
#### Extra functions -

User can also pass a "where" clause which can filter queue messages based on query.
All the MongoDB "find" query parameters are valid for this operation.

Check the documentation to understand how you can use this feature. - MongoDB find()

`js
// You can pass them as optional params during initialization
const queue = new Queue("testQueue", {
foo: { $gt: 10 }
})

// OR you can set them as follows //
queue.where = {
foo: { $gt: 10 }
}

queue.pull((message, done) => {
// All messages which satisfied the above criteria will return here //
console.log(message)

...
})
`

To delete all messages from the queue -
`js
queue.purge()
// Returns the number of messages deleted
`

You can analyse the messages that end up in dead letter queue -
`js
queue.fetchDeadQueue()
// Returns those messages which were not successfully processed
// after maximum number of receives by consumers
`

---
#### Note -
You can also pass the following enviornment variables to configure the agent.
| Enviornment Name | Default Value | Datatype |
|:----------------:|:---------------------------:|:------------------:|
| QUIDDITY_URL | "http://localhost:3000" | String |
| POLLING_INTERVAL | 120000 (2 mins) | Number (in millis) |

- QUIDDITY_URL
- This is the base url of the quiddity server.
- To check out how to setup the server, to go this repo GitHub

- POLLING_INTERVAL`
- If the queue is empty and there are no messages left, the agent will poll for new messages at a fixed interval.
- Developers can modify this __polling time__ to suit their requirements.

---
#### Collaborators
* Kevin Jain - GitHub
* Moksh Jain - GitHub