Merge pull request #414 from devspace-K/error-handling-centralization

mehmetsefabalik · web-flow · commit 87d6c98b1fcf · 2024-03-22T08:24:26.000+03:00
Implement centralized error handling middleware
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+# [3.65.1] - 20-03-2024
+### Changed
+- Route handlers have been modified to utilize centralized error middleware by forwarding exceptions using a next() call when 'useExpressErrorForwarding' flag is set. With this change, custom error middleware can be used to handle exceptions in a centralized manner.
+
 # [3.65.0] - 19-02-2024
 ### Changed
 - A fragment's name included in a page's URL will not cause the URL to be modified (just like js client logic).
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@puzzle-js/core",
-  "version": "3.65.0",
+  "version": "3.65.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "logo": "https://image.ibb.co/jM29on/puzzlelogo.png",
diff --git a/src/api.ts b/src/api.ts
@@ -19,11 +19,16 @@ export class Api {
         this.prepareHandlers();
     }
 
-    private controllerWrapper(handler) {
-        return async (req, res) => {
+    private controllerWrapper(handler, useExpressErrorForwarding = false) {
+        return async (req, res, next) => {
             try {
-                await handler(req, res);
+                await handler(req, res, next);
             } catch (e) {
+                if (useExpressErrorForwarding) {
+                    next(e);
+                    return;
+                }
+
                 console.error("PUZZLE_BFF_HANDLER_UNHANDLED_ERROR");
                 console.log(e);
                 return res.status(500).send();
@@ -49,7 +54,7 @@ export class Api {
             const apiHandler = this.config.versions[version];
 
             apiHandler.endpoints.forEach(endpoint => {
-                server.handler.addRoute(`/${API_ROUTE_PREFIX}/${this.config.name}/${version}${endpoint.path}`, endpoint.method, this.controllerWrapper(this.handler[version][endpoint.controller]), endpoint.middlewares);
+                server.handler.addRoute(`/${API_ROUTE_PREFIX}/${this.config.name}/${version}${endpoint.path}`, endpoint.method, this.controllerWrapper(this.handler[version][endpoint.controller], endpoint.useExpressErrorForwarding), endpoint.middlewares);
             });
         });
     }
diff --git a/src/configurator.ts b/src/configurator.ts
@@ -24,7 +24,8 @@ const apiEndpointsStructure = struct({
     method: struct.enum(Object.values(HTTP_METHODS)),
     controller: 'string',
     routeCache: 'number?',
-    cacheControl: 'string?'
+    cacheControl: 'string?',
+    useExpressErrorForwarding: 'boolean?'
 });
 
 const customHeaderStructure = struct({
diff --git a/src/types.ts b/src/types.ts
@@ -141,6 +141,7 @@ export interface IApiHandler {
     cacheControl?: string;
     routeCache?: number;
     controller: string;
+    useExpressErrorForwarding?: boolean;
 }
 
 export interface IApiVersion {
diff --git a/tests/api.spec.ts b/tests/api.spec.ts
@@ -2,6 +2,7 @@ import { Api } from "../src/api";
 import { expect } from "chai";
 import { HTTP_METHODS } from "../src/enums";
 import { Server } from "../src/network";
+import sinon from "sinon";
 import supertest from "supertest";
 import faker from "faker";
 
@@ -202,5 +203,91 @@ describe('Api',  () => {
       .end(() => {
       });
   });
+
+  it('should forward to next middleware when "useExpressErrorForwarding" is set', (done) => {
+    const consoleErrorSpy = sinon.spy(console, 'error');
+    const server = new Server();
+
+    const api = new Api({
+      liveVersion: '1.0.0',
+      name: 'browsing',
+      testCookie: 'browsing-version',
+      versions: {
+        '1.0.0': {
+          handler: {
+            test: (req: any, res: any) => {
+              throw new Error("error");
+            },
+          },
+          endpoints: [
+            {
+              method: HTTP_METHODS.GET,
+              path: '/history',
+              controller: 'test',
+              middlewares: [],
+              useExpressErrorForwarding: true,
+            },
+          ],
+        },
+      },
+    });
+
+    api.registerEndpoints(server);
+
+    supertest(server.handler.getApp())
+      .get('/api/browsing/history')
+      .expect(500)
+      .end((err, res) => {
+        expect(consoleErrorSpy.called).to.be.false;
+
+        consoleErrorSpy.restore();
+        done();
+      });
+  });
+
+  it('should not forward to next middleware when "useExpressErrorForwarding" is not set', (done) => {
+    const consoleErrorSpy = sinon.spy(console, 'error');
+    const consoleLogSpy = sinon.spy(console, 'log');
+    const server = new Server();
+
+    const api = new Api({
+      liveVersion: '1.0.0',
+      name: 'browsing',
+      testCookie: 'browsing-version',
+      versions: {
+        '1.0.0': {
+          handler: {
+            test: (req: any, res: any) => {
+              throw new Error("error");
+            },
+          },
+          endpoints: [
+            {
+              method: HTTP_METHODS.GET,
+              path: '/history',
+              controller: 'test',
+              middlewares: [],
+              useExpressErrorForwarding: false,
+            },
+          ],
+        },
+      },
+    });
+
+    api.registerEndpoints(server);
+
+    supertest(server.handler.getApp())
+      .get('/api/browsing/history')
+      .expect(500)
+      .end((err, res) => {
+        expect(consoleErrorSpy.called).to.be.true;
+        expect(consoleErrorSpy.firstCall.args[0]).to.include("PUZZLE_BFF_HANDLER_UNHANDLED_ERROR");
+        expect(consoleLogSpy.firstCall.args[0]).to.be.instanceOf(Error);
+
+        consoleErrorSpy.restore();
+        consoleLogSpy.restore();
+        done();
+      });
+  });
 });
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@puzzle-js/core",`
`3`		`- "version": "3.65.0",`
	`3`	`+ "version": "3.65.1",`
`4`	`4`	`"main": "./dist/index.js",`
`5`	`5`	`"types": "./dist/index.d.ts",`
`6`	`6`	`"logo": "https://image.ibb.co/jM29on/puzzlelogo.png",`
Original file line number	Diff line number	Diff line change
`@@ -141,6 +141,7 @@ export interface IApiHandler {`
`141`	`141`	`cacheControl?: string;`
`142`	`142`	`routeCache?: number;`
`143`	`143`	`controller: string;`
	`144`	`+ useExpressErrorForwarding?: boolean;`
`144`	`145`	`}`
`145`	`146`
`146`	`147`	`export interface IApiVersion {`