feat(errors): add error handling hooks and improve error logging

chore(package): add pump, husky, lint-staged, and prettier dependencies

Author: Jordan van Wijnen

demos/errors.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const gateway = require('./../index')
+const PORT = process.env.PORT || 8080
+
+const server = gateway({
+  routes: [{
+    prefix: '/*',
+    prefixRewrite: '',
+    target: 'http://127.0.0.1:3000',
+    hooks: {
+      onRequest: () => {
+        throw new SyntaxError('Something went wrong')
+      },
+      onError(err, req) {
+        // allows for extra error handling logic (i.e. Sentry, Newrelic etc.)
+        console.warn(req.method, req.url, err)
+      }
+    }
+  }]
+})
+
+server.start(PORT).then(server => {
+  console.log(`API Gateway listening on ${PORT} port!`)
+})

index.d.ts

@@ -59,6 +59,7 @@ declare namespace fastgateway {
     onRequest?: Function
     rewriteHeaders?: Function
     onResponse?: Function
+    onError?: (error: Error, request: Request) => void
     rewriteRequestHeaders?: Function
     request?: {
       timeout?: number

index.js

@@ -173,6 +173,11 @@ const handler = (route, proxy, proxyHandler) => async (req, res, next) => {
       proxyHandler(req, res, req.url, proxy, proxyOpts)
     }
   } catch (err) {
+    const { onError } = hooks
+    if (typeof onError === 'function') {
+      onError(err, req)
+    }
+
     return next(err)
   }
 }

package.json

@@ -31,6 +31,7 @@
     "fast-proxy-lite": "^1.1.2",
     "http-cache-middleware": "^1.4.1",
     "micromatch": "^4.0.8",
+    "pump": "^3.0.4",
     "restana": "^5.0.0",
     "stream-to-array": "^2.3.0"
   },
@@ -42,8 +43,8 @@
     "LICENSE"
   ],
   "devDependencies": {
-    "@types/node": "^22.13.11",
     "@types/express": "^5.0.0",
+    "@types/node": "^22.13.11",
     "artillery": "^2.0.21",
     "aws-sdk": "^2.1691.0",
     "chai": "^4.5.0",
@@ -56,10 +57,13 @@
     "fg-multiple-hooks": "^1.3.0",
     "helmet": "^7.2.0",
     "http-lambda-proxy": "^1.1.4",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.2",
     "load-balancers": "^1.3.52",
     "mocha": "^10.8.2",
     "nyc": "^17.1.0",
     "pem": "^1.14.8",
+    "prettier": "^3.8.3",
     "request-ip": "^3.3.0",
     "response-time": "^2.3.3",
     "supertest": "^7.0.0"