From 8000cca7f4393ea6d06a77006a5de626411c44fc Mon Sep 17 00:00:00 2001 From: Uxio Fuentefria Date: Tue, 12 Sep 2023 13:48:44 +0200 Subject: [PATCH] Test SSE propertly --- package-lock.json | 17 ++++++++ package.json | 2 + src/routes/events/events.controller.spec.ts | 4 +- src/routes/events/events.service.spec.ts | 9 +++- src/routes/events/events.service.ts | 2 +- test/app.e2e-spec.ts | 46 +++++++++++++++++---- 6 files changed, 67 insertions(+), 13 deletions(-) diff --git a/package-lock.json b/package-lock.json index d31ef30..04a4fc9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -39,6 +39,7 @@ "@nestjs/schematics": "^9.0.0", "@nestjs/testing": "^9.0.0", "@types/amqplib": "^0.10.1", + "@types/eventsource": "^1.1.11", "@types/express": "^4.17.13", "@types/jest": "^29.5.3", "@types/node": "18.15.11", @@ -48,6 +49,7 @@ "eslint": "^8.45.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-prettier": "^4.0.0", + "eventsource": "^2.0.2", "husky": "^8.0.3", "jest": "^29.6.1", "prettier": "^2.3.2", @@ -4718,6 +4720,12 @@ "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.1.tgz", "integrity": "sha512-LG4opVs2ANWZ1TJoKc937iMmNstM/d0ae1vNbnBvBhqCSezgVUOzcLCqbI5elV8Vy6WKwKjaqR+zO9VKirBBCA==" }, + "node_modules/@types/eventsource": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/@types/eventsource/-/eventsource-1.1.11.tgz", + "integrity": "sha512-L7wLDZlWm5mROzv87W0ofIYeQP5K2UhoFnnUyEWLKM6UBb0ZNRgAqp98qE5DkgfBXdWfc2kYmw9KZm4NLjRbsw==", + "dev": true + }, "node_modules/@types/express": { "version": "4.17.17", "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.17.tgz", @@ -7576,6 +7584,15 @@ "node": ">=0.8.x" } }, + "node_modules/eventsource": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/eventsource/-/eventsource-2.0.2.tgz", + "integrity": "sha512-IzUmBGPR3+oUG9dUeXynyNmf91/3zUSJg1lCktzKw47OXuhco54U3r9B7O4XX+Rb1Itm9OZ2b0RkTs10bICOxA==", + "dev": true, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/execa": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", diff --git a/package.json b/package.json index 84146af..6b8d633 100644 --- a/package.json +++ b/package.json @@ -52,6 +52,7 @@ "@nestjs/schematics": "^9.0.0", "@nestjs/testing": "^9.0.0", "@types/amqplib": "^0.10.1", + "@types/eventsource": "^1.1.11", "@types/express": "^4.17.13", "@types/jest": "^29.5.3", "@types/node": "18.15.11", @@ -61,6 +62,7 @@ "eslint": "^8.45.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-prettier": "^4.0.0", + "eventsource": "^2.0.2", "husky": "^8.0.3", "jest": "^29.6.1", "prettier": "^2.3.2", diff --git a/src/routes/events/events.controller.spec.ts b/src/routes/events/events.controller.spec.ts index 3ea7f63..5bb629c 100644 --- a/src/routes/events/events.controller.spec.ts +++ b/src/routes/events/events.controller.spec.ts @@ -12,7 +12,7 @@ describe('EventsController', () => { let service: EventsService; beforeEach(async () => { - const module = await Test.createTestingModule({ + const module: TestingModule = await Test.createTestingModule({ controllers: [EventsController], providers: [EventsService, QueueProvider, WebhookService], }) @@ -63,7 +63,7 @@ describe('EventsController', () => { // Not relevant event must be ignored by Safe filter const event = await firstValue; expect(event.data).toEqual(txServiceEvents[1]); - expect(event.type).toEqual(txServiceEvents[1].type); + expect(event.type).toEqual('message'); }); }); }); diff --git a/src/routes/events/events.service.spec.ts b/src/routes/events/events.service.spec.ts index bfd1b20..db7626b 100644 --- a/src/routes/events/events.service.spec.ts +++ b/src/routes/events/events.service.spec.ts @@ -17,7 +17,7 @@ describe('EventsService', () => { beforeEach(async () => { const webhookServiceMock = { - postEveryWebhook: async (_: object) => ({ + postEveryWebhook: async () => ({ data: {}, status: 200, statusText: 'OK', @@ -47,6 +47,10 @@ describe('EventsService', () => { describe('processEvent', () => { it('should post webhooks', async () => { const postEveryWebhook = jest.spyOn(webhookService, 'postEveryWebhook'); + const pushEventToEventsObservable = jest.spyOn( + eventsService, + 'pushEventToEventsObservable', + ); const msg = { chainId: '1', type: 'SAFE_CREATED' as TxServiceEventType, @@ -56,12 +60,15 @@ describe('EventsService', () => { await eventsService.processEvent(JSON.stringify(msg)); expect(postEveryWebhook).toBeCalledTimes(1); expect(postEveryWebhook).toBeCalledWith(msg); + expect(pushEventToEventsObservable).toBeCalledTimes(1); + expect(pushEventToEventsObservable).toBeCalledWith(msg); }); }); describe('processMessageEvents', () => { it('should post webhooks', async () => { const postEveryWebhook = jest.spyOn(webhookService, 'postEveryWebhook'); + const messageCreated = { chainId: '1', type: 'MESSAGE_CREATED' as TxServiceEventType, diff --git a/src/routes/events/events.service.ts b/src/routes/events/events.service.ts index d5f5fe9..5933885 100644 --- a/src/routes/events/events.service.ts +++ b/src/routes/events/events.service.ts @@ -46,7 +46,7 @@ export class EventsService implements OnApplicationBootstrap { txServiceEvent: TxServiceEvent, ): MessageEvent { const messageEvent: MessageEvent = new MessageEvent( - txServiceEvent.type, + 'message', { data: txServiceEvent, }, diff --git a/test/app.e2e-spec.ts b/test/app.e2e-spec.ts index 42c22c6..a667264 100644 --- a/test/app.e2e-spec.ts +++ b/test/app.e2e-spec.ts @@ -4,6 +4,9 @@ import * as request from 'supertest'; import { AppModule } from './../src/app.module'; import { QueueProvider } from '../src/datasources/queue/queue.provider'; import { EventsService } from '../src/routes/events/events.service'; +import { Server } from 'tls'; +import { TxServiceEventType } from '../src/routes/events/event.dto'; +import EventSource = require('eventsource'); /* eslint-disable */ const { version } = require('../package.json'); @@ -39,17 +42,42 @@ describe('AppController (e2e)', () => { }); describe('/events/sse/:safe (GET)', () => { - it('should subscribe to server side events', () => { + it('should subscribe and receive Server Side Events', () => { const validSafeAddress = '0x8618ce407F169ABB1388348A19632AaFA857CCB9'; - const url = `/events/sse/${validSafeAddress}`; - const expected = {}; + const msg = { + chainId: '1', + type: 'SAFE_CREATED' as TxServiceEventType, + hero: 'Tatsumaki', + address: validSafeAddress, + }; + + const path = `/events/sse/${validSafeAddress}`; + + // Supertest cannot be used, as it does not support EventSource + const server = app.getHttpServer(); + server.listen(); + const port = server.address().port; + const protocol = server instanceof Server ? 'https' : 'http'; + const url = protocol + '://127.1.0.1:' + port + path; + + const eventSource = new EventSource(url); + // Use an empty promise so test has to wait for it + const messageReceived = new Promise((resolve) => { + eventSource.onmessage = (event) => { + expect(event.type).toBe('message'); + const parsedData = JSON.parse(event.data); + expect(parsedData).toStrictEqual(msg); + server.close(); + resolve(null); + }; + }); + + // Wait a little to send the message + setTimeout(() => { + eventsService.pushEventToEventsObservable(msg); + }, 1000); - const result = request(app.getHttpServer()) - .get(url) - .expect(200) - .expect(expected); - eventsService.completeEventsObservable(); - return result; + return messageReceived; }); it('should return a 400 if safe address is not EIP55 valid', () => { const notValidAddress = '0x8618CE407F169ABB1388348A19632AaFA857CCB9';