refactor: make emitter type-safe and rename request finished event

Rename http:request_finished event to http:request_completed

Author: thetutlage

src/server/main.ts

@@ -10,17 +10,18 @@
 import onFinished from 'on-finished'
 import Middleware from '@poppinss/middleware'
 import type { Logger } from '@adonisjs/logger'
-import type { Emitter } from '@adonisjs/events'
 import type { Encryption } from '@adonisjs/encryption'
 import type { Server as HttpsServer } from 'node:https'
 import type { Application } from '@adonisjs/application'
+import type { EmitterLike } from '@adonisjs/events/types'
 import { ContainerResolver, moduleCaller, moduleImporter } from '@adonisjs/fold'
 import type { ServerResponse, IncomingMessage, Server as HttpServer } from 'node:http'
 
 import type { LazyImport } from '../types/base.js'
 import type { MiddlewareAsClass, ParsedGlobalMiddleware } from '../types/middleware.js'
 import type {
   ServerConfig,
+  HttpServerEvents,
   ServerErrorHandler,
   ErrorHandlerAsAClass,
   TestingMiddlewarePipeline,
@@ -73,7 +74,7 @@ export class Server {
   /**
    * Emitter is required to notify when a request finishes
    */
-  #emitter: Emitter<any>
+  #emitter: EmitterLike<HttpServerEvents>
 
   /**
    * The application instance to be shared with the router
@@ -138,7 +139,7 @@ export class Server {
   constructor(
     app: Application<any>,
     encryption: Encryption,
-    emitter: Emitter<any>,
+    emitter: EmitterLike<HttpServerEvents>,
     logger: Logger,
     config: ServerConfig
   ) {
@@ -330,7 +331,7 @@ export class Server {
     /**
      * Setup for the "http:request_finished" event
      */
-    const hasRequestListener = this.#emitter.hasListeners('http:request_finished')
+    const hasRequestListener = this.#emitter.hasListeners('http:request_completed')
     const startTime = hasRequestListener ? process.hrtime() : null
 
     /**
@@ -348,7 +349,7 @@ export class Server {
      */
     if (startTime) {
       onFinished(res, () => {
-        this.#emitter.emit('http:request_finished', {
+        this.#emitter.emit('http:request_completed', {
           ctx: ctx,
           duration: process.hrtime(startTime),
         })

src/types/server.ts

@@ -52,13 +52,20 @@ export type StatusPageRange = `${number}..${number}` | `${number}` | number
 export type StatusPageRenderer = (error: HttpError, ctx: HttpContext) => any | Promise<any>
 
 /**
- * Data type for the "http:request_finished" event
+ * Data type for the "http:request_completed" event
  */
 export type HttpRequestFinishedPayload = {
   ctx: HttpContext
   duration: [number, number]
 }
 
+/**
+ * Events emitted by the HttpServer
+ */
+export type HttpServerEvents = {
+  'http:request_completed': HttpRequestFinishedPayload
+}
+
 /**
  * Error handler to handle HTTP errors
  */

tests/server.spec.ts

@@ -20,7 +20,7 @@ import { Router } from '../src/router/main.js'
 import { HttpContext } from '../src/http_context/main.js'
 import { ServerFactory } from '../factories/server_factory.js'
 import { defineNamedMiddleware } from '../src/define_middleware.js'
-import { HttpRequestFinishedPayload } from '../src/types/server.js'
+import { HttpRequestFinishedPayload, HttpServerEvents } from '../src/types/server.js'
 
 const BASE_URL = new URL('./app/', import.meta.url)
 
@@ -46,7 +46,7 @@ test.group('Server', () => {
 
   test('emit request finished route handler', async ({ assert }, done) => {
     const app = new AppFactory().create(BASE_URL, () => {})
-    const emitter = new Emitter(app)
+    const emitter = new Emitter<HttpServerEvents>(app)
     const server = new ServerFactory().merge({ app, emitter }).create()
     const httpServer = createServer(server.handle.bind(server))
 
@@ -56,7 +56,7 @@ test.group('Server', () => {
     server.getRouter().get('/', async ({ response }) => response.send('handled'))
     await server.boot()
 
-    emitter.on('http:request_finished', (event: HttpRequestFinishedPayload) => {
+    emitter.on('http:request_completed', (event: HttpRequestFinishedPayload) => {
       assert.instanceOf(event.ctx, HttpContext)
       assert.isArray(event.duration)
       done()