Capture server errors in NestJS (#53)

* Add test

* Add NestJS exceptions filter

Author: itssimon

src/nestjs/index.ts

@@ -1,2 +1,24 @@
+import { ArgumentsHost, Catch, INestApplication } from "@nestjs/common";
+import { BaseExceptionFilter } from "@nestjs/core";
+import { Response } from "express";
+
+import type { ApitallyConfig } from "../common/types.js";
+import { useApitally as useApitallyExpress } from "../express/index.js";
 export type { ApitallyConsumer } from "../common/types.js";
-export { useApitally } from "../express/index.js";
+
+export const useApitally = (app: INestApplication, config: ApitallyConfig) => {
+  const httpAdapter = app.getHttpAdapter();
+  const expressInstance = httpAdapter.getInstance();
+  useApitallyExpress(expressInstance, config);
+  app.useGlobalFilters(new AllExceptionsFilter(httpAdapter));
+};
+
+@Catch()
+class AllExceptionsFilter extends BaseExceptionFilter {
+  catch(exception: unknown, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const res = ctx.getResponse<Response>();
+    res.locals.serverError = exception;
+    super.catch(exception, host);
+  }
+}

tests/express/app.test.ts

@@ -46,7 +46,6 @@ testCases.forEach(({ name, getApp }) => {
       await appTest.get("/error").expect(500);
 
       const requests = client.requestCounter.getAndResetRequests();
-      const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
       expect(requests.length).toBe(4);
       expect(
         requests.some(
@@ -76,6 +75,8 @@ testCases.forEach(({ name, getApp }) => {
       expect(
         requests.some((r) => r.status_code === 500 && r.request_count === 1),
       ).toBe(true);
+
+      const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
       expect(serverErrors.length).toBe(1);
       expect(
         serverErrors.some(

tests/fastify/app.test.ts

@@ -30,7 +30,6 @@ describe("Plugin for Fastify", () => {
     await appTest.get("/error").expect(500);
 
     const requests = client.requestCounter.getAndResetRequests();
-    const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
     expect(requests.length).toBe(4);
     expect(
       requests.some(
@@ -60,6 +59,8 @@ describe("Plugin for Fastify", () => {
     expect(
       requests.some((r) => r.status_code === 500 && r.request_count === 1),
     ).toBe(true);
+
+    const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
     expect(serverErrors.length).toBe(1);
     expect(
       serverErrors.some(

tests/hono/app.test.ts

@@ -52,7 +52,6 @@ describe("Middleware for Hono", () => {
     expect(res.status).toBe(500);
 
     const requests = client.requestCounter.getAndResetRequests();
-    const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
     expect(requests.length).toBe(5);
     expect(
       requests.some(
@@ -89,6 +88,8 @@ describe("Middleware for Hono", () => {
     expect(
       requests.some((r) => r.status_code === 500 && r.request_count === 1),
     ).toBe(true);
+
+    const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
     expect(serverErrors.length).toBe(1);
     expect(
       serverErrors.some(

tests/koa/app.test.ts

@@ -48,7 +48,6 @@ testCases.forEach(({ name, router, getApp }) => {
       consoleSpy.mockRestore();
 
       const requests = client.requestCounter.getAndResetRequests();
-      const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
       expect(requests.length).toBe(3);
       expect(
         requests.some(
@@ -73,6 +72,8 @@ testCases.forEach(({ name, router, getApp }) => {
         ),
       ).toBe(true);
       expect(requests.some((r) => r.status_code === 500)).toBe(true);
+
+      const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
       expect(serverErrors.length).toBe(1);
       expect(
         serverErrors.some(

tests/nestjs/app.controller.ts

@@ -40,6 +40,6 @@ export class AppController {
 
   @Get("/error")
   getError() {
-    throw new Error("Error");
+    throw new Error("test");
   }
 }

tests/nestjs/app.test.ts

@@ -50,6 +50,18 @@ describe("Middleware for NestJS", () => {
     expect(
       requests.some((r) => r.status_code === 500 && r.request_count === 1),
     ).toBe(true);
+
+    const serverErrors = client.serverErrorCounter.getAndResetServerErrors();
+    expect(serverErrors.length).toBe(1);
+    expect(
+      serverErrors.some(
+        (e) =>
+          e.type === "Error" &&
+          e.msg === "test" &&
+          e.traceback &&
+          e.error_count === 1,
+      ),
+    ).toBe(true);
   });
 
   it("Validation error logger", async () => {

tests/nestjs/app.ts

@@ -10,9 +10,8 @@ export async function getApp() {
     providers: [],
   }).compile();
   const app = moduleFixture.createNestApplication();
-  const expressInstance = app.getHttpAdapter().getInstance();
 
-  useApitally(expressInstance, {
+  useApitally(app, {
     clientId: CLIENT_ID,
     env: ENV,
     appVersion: "1.2.3",