@fickou/adonis-server-sent-events
v1.0.7
Published
An addon/plugin package to provide server sent events functionality for AdonisJS 5.0+
Downloads
5
Maintainers
afidossReadme
@fickou/adonis-server-sent-events
An addon/plugin package to provide server-sent events functionality for AdonisJS 5.0+
Getting Started
npm i --save @fickou/adonis-server-sent-events Usage
Firstly, follow the instructions in
instructions.mdfile to setup the Provider and Middleware
See the instructions.md file for the complete installation steps and follow as stated.
Registering provider
Install provider:
node ace configure @fickou/adonis-server-sent-eventsLike any other provider, you need to register the provider inside .adonisrc.json file.
{
"providers": [
...,
"@fickou/adonis-server-sent-events/providers/ServerSentEventsProvider",
]
}Registering middleware
Register the following middleware inside start/kernel.ts file.
Server.middleware.register([
'Adonis/Middleware/EventSourceWatcher',
])Or alternatively setup the middleware as a named (use any name you feel like) middleware inside
start/kernel.tsfile.
Server.middleware.registerNamed({
eventsource: 'Adonis/Middleware/EventSourceWatcher',
})HINT: It would be much easier and better to make the EventSourceWatcher middleware a global middleware
Setup serve-sent events route inside
start/routes.tsfile.
import Route from '@ioc:Adonis/Core/Route'
import {HttpContextContract} from "@ioc:Adonis/Core/HttpContext";
/**
* If the 'eventsource' named middleware is set
* then setup route like below
*/
Route.get('/stream', ({source}: HttpContextContract) => {
// send a server-sent events comment
source.send("Hello AdonisJS", '!This is a comment!');
}).middleware(['eventsource']);
/**
* If the middleware is a global middlware
* then setup route like below
*/
Route.get('/stream', ({source}: HttpContextContract) => {
// send a server-sent events comment
source.send("Hello AdonisJS", '!This is a comment!');
})
Route.post('/send/email', 'NotificationsController.sendEmail')
Example(s)
Setup a controller to dispatch server-sent events to the browser using the
source.send(data: Object, comment: String, event: String, retry: Number)method like so:
import Mail from "@ioc:Adonis/Addons/Mail";
import {HttpContextContract} from "@ioc:Adonis/Core/HttpContext";
export default class NotificationsController {
async sendEmail ({ request, auth, source }:HttpContextContract){
let input = request.only([
'ticket_user_id'
]);
let { id, email, fullname } = await auth.getUser();
let error = false
try{
await Mail.send(
'emails.template',
{ fullname }, (message) => {
message.to(email)
message.from('[email protected]')
message.subject('Ticket Creation Job Status')
})
}catch(err){
error = true
}finally{
source.send({
ticket_reciever: id,
ticket_creator: input.ticket_user_id,
ticket_mail_status: `email sent ${error ? 'un' : ''}successfuly`
}, null, 'update', 4000) // event: 'update', retry: 4000 (4 seconds)
}
}
}
/**
* source.send (METHOD)
*/
send( data: Record<string,any>, comment: string, event: string, retry: number);
Connecting from the client-side
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- Polyfill for older browsers without native support for the HTML5 EventSource API. -->
<script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=EventSource"></script>
</head>
<body>
<script id="server-side-events" type="text/javascript">
const stream = new EventSource("http://127.0.0.1:3333/stream");
stream.addEventListener('message', function(e){
console.log("Data: ", e.data);
}, false);
stream.addEventListener('open', function(e) {
// Connection was opened.
console.log('connection open: true');
}, false);
stream.addEventListener('error', function(e) {
if (e.readyState == EventSource.CLOSED) {
// Connection was closed.
console.log('connection closed: true');
}
}, false);
</script>
</body>
</html>License
MIT
Running Tests
npm i
npm run lint
npm run test
Credits
Contributing
See the CONTRIBUTING.md file for info
Support
My Facebook Facebook Page.