An addon/plugin package to provide driver-based job queueing services in AdonisJS 4.0+
adonis install adonisjs-queue
Add a job file to the jobs folder using the command. The command below creates the file
app/Jobs/SendEmail.js. The queue flag in the command is for setting the queue priority channel. The queue flag has only 2 possible values: high and low
$ adonis make:job SendEmail
$ adonis make:job SendEmail --queue=low
OR
$ node ace make:job SendEmail
const Job = use('Job')
const Mail = use('Mail')
class SendEmail extends Job {
get queue(){
return 'low'
}
constructor(emailAddress, emailFrom, emailSubject, emailBody) {
super(arguments)
this.timeOut = 50; // seconds
this.retryCount = 3;
this.retryUntil = 200; // seconds
}
async handle(link, done) {
//....
console.log(`Job [${this.constructor.name}] - handler called: status=running; id=${this.id} `)
link.reportProgress(18)
let _data = link.data // arguments passed into the constructor
let error = null
let result = null
try{
result = await Mail.send(_data.emailBody, {gender:'F', fullname:"Aisha Salihu"}, (message) => {
message.to(_data.emailAddress)
message.from(_data.emailFrom)
message.subject(_data.emailSubject)
})
}catch(err){
error = err
}finally{
//...
link.reportProgress(98)
if(error){
throw error
}
}
return result
}
failed(link, error) {
console.log(`Job [${this.constructor.name}] - status:failed; id=${this.id} `, error)
this.detach() // remove the job from the queue (when the job fails after 3 retries)
}
retrying(link, error){
console.log(`Job [${this.constructor.name}] - status:retrying; id=${this.id} `, error)
}
succeeded(link){
console.log(`Job [${this.constructor.name}] - status:succeeded; id=${this.id} `)
}
}
module.exports = SendEmailOpen the
start/events.jsfile of an AdonisJS Framework installation and add the following code to it (This package encourages the use of the standard event bus for AdonisJS)
'use strict'
const Event = use('Event')
const Queue = use('Queue')
const SendEmail = use('App/Jobs/SendEmail')
Event.on('user_registered', async ( _email ) => {
// dispatch to the "high" priority queue
await Queue.select('high').andDispatch(new SendEmail(
_email,
'[email protected]',
'YOU ARE WELCOME',
'emails.template' // AdonisJS view template file: "resources/views/emails/template.edge"
));
})Then, go to the
start/routes.jsfile of an AdonisJS Framework installation and add the following code to it
Route.post('user/register/:type', ({ request, params: { type }, respopnse }) => {
const body = request.post()
Event.fire('user_registered', '[email protected]') // Invoke the 'SendEmail' Job (to send an email) via the Event Bus
if (request.format() === 'json') {
return response.status(200).json({
status:'success'
})
}else{
return response.send('success')
}
})You can also access the queue instance via the AdonisJS Http Context in a controller/middleware
'use strict'
const SendEmail = use('App/Jobs/SendEmail')
class WorksController {
async sendEmail({ request, queue, session }){
let tenant_id = session.get('tenant_id')
let { email } = request.only([
'email'
])
await queue.dispatch(new SendEmail( // dispatch to the "low" priority queue
email,
'[email protected]',
'YOU ARE WELCOME',
'emails.template' // AdonisJS view template file in "resources/views"
))
}
}
module.exports = WorksControllerMIT
npm i
npm run lint
npm run test
See the CONTRIBUTING.md file for info