feat: add gaxios error handler (VF-000) (#88)

* feat: add gaxios error handler (VF-000)

* fix: add error logs

* chore: pin gaxios version

* refactor: expose type guards

Author: trs

package.json

@@ -16,6 +16,7 @@
     "@voiceflow/verror": "^1.1.0",
     "chai": "^4.3.4",
     "dotenv": "^10.0.0",
+    "gaxios": "4.3.2",
     "http-errors": "^2.0.0",
     "http-status": "^1.4.2",
     "jszip": "3.7.1",

src/guards/error.ts

@@ -0,0 +1,12 @@
+import VError from '@voiceflow/verror';
+import { GaxiosError } from 'gaxios';
+import { isHttpError } from 'http-errors';
+import { types } from 'util';
+
+export const isJavascriptError = types.isNativeError;
+
+export const isGaxiosError = (err: unknown): err is GaxiosError => err instanceof GaxiosError;
+
+export const isVError = (err: unknown): err is VError => err != null && err instanceof VError;
+
+export { isHttpError };

src/guards/index.ts

@@ -0,0 +1 @@
+export * from './error';

src/index.ts

@@ -2,6 +2,7 @@ export * from './clients';
 export * as Common from './common';
 export * from './env';
 export { default as FixtureGenerator } from './fixtureGenerator';
+export * as Guards from './guards';
 export * from './middlewares';
 export { default as ResponseBuilder } from './responseBuilder';
 export * from './types';

src/middlewares/exception/formatters/gaxiosError.ts

@@ -0,0 +1,15 @@
+import { GaxiosError } from 'gaxios';
+
+import type { ExceptionFormatter } from '../types';
+
+export const formatGaxiosError: ExceptionFormatter<GaxiosError> = (err) => {
+  return {
+    statusCode: err.response?.status,
+    name: 'GaxiosError',
+    message: err.message,
+    details: {
+      code: err.code,
+      statusText: err.response?.statusText,
+    },
+  };
+};

src/middlewares/exception/formatters/httpError.ts

@@ -1,9 +1,7 @@
-import { HttpError, isHttpError } from 'http-errors';
+import { HttpError } from 'http-errors';
 
 import type { ExceptionFormatter } from '../types';
 
-export { isHttpError };
-
 export const formatHttpError: ExceptionFormatter<HttpError> = (err) => {
   return {
     statusCode: err.statusCode,

src/middlewares/exception/formatters/index.ts

@@ -1,9 +1,11 @@
 import VError from '@voiceflow/verror';
 
+import * as Guards from '../../../guards';
 import type { ExceptionFormat } from '../types';
-import { formatHttpError, isHttpError } from './httpError';
-import { formatJavascriptError, isJavascriptError } from './jsError';
-import { formatVError, isVError } from './vError';
+import { formatGaxiosError } from './gaxiosError';
+import { formatHttpError } from './httpError';
+import { formatJavascriptError } from './jsError';
+import { formatVError } from './vError';
 
 export const formatError = (err: unknown): ExceptionFormat => {
   let exception: ExceptionFormat = {
@@ -12,9 +14,10 @@ export const formatError = (err: unknown): ExceptionFormat => {
     message: 'Unknown error',
   };
 
-  if (isVError(err)) exception = mergeExceptionResult(exception, formatVError(err));
-  else if (isHttpError(err)) exception = mergeExceptionResult(exception, formatHttpError(err));
-  else if (isJavascriptError(err)) exception = mergeExceptionResult(exception, formatJavascriptError(err));
+  if (Guards.isVError(err)) exception = mergeExceptionResult(exception, formatVError(err));
+  else if (Guards.isHttpError(err)) exception = mergeExceptionResult(exception, formatHttpError(err));
+  else if (Guards.isGaxiosError(err)) exception = mergeExceptionResult(exception, formatGaxiosError(err));
+  else if (Guards.isJavascriptError(err)) exception = mergeExceptionResult(exception, formatJavascriptError(err));
 
   return exception;
 };

src/middlewares/exception/formatters/jsError.ts

@@ -1,9 +1,5 @@
-import { types } from 'util';
-
 import type { ExceptionFormatter } from '../types';
 
-export const isJavascriptError = types.isNativeError;
-
 export const formatJavascriptError: ExceptionFormatter<Error> = (err) => {
   return {
     name: err.name,

src/middlewares/exception/formatters/vError.ts

@@ -2,8 +2,6 @@ import VError from '@voiceflow/verror';
 
 import type { ExceptionFormatter } from '../types';
 
-export const isVError = (err: unknown): err is VError => err != null && err instanceof VError;
-
 export const formatVError: ExceptionFormatter<VError> = (err) => {
   return {
     statusCode: err.code,

src/middlewares/exception/index.ts

@@ -1,5 +1,6 @@
 import type { NextFunction, Request, Response } from 'express';
 
+import log from '../../logger';
 import { AbstractMiddleware } from '../../types';
 import { formatError } from './formatters';
 
@@ -9,11 +10,17 @@ export class ExceptionMiddleware extends AbstractMiddleware<never, never> {
   }
 
   public handleError(err: unknown, req: Request, res: Response, _next: NextFunction): void {
+    log.error(`Exception formatter (pre) ${JSON.stringify(err)}`);
+
     const { statusCode, ...body } = formatError(err);
 
-    res.status(statusCode).send({
+    const error = {
       ...body,
       requestID: req.id.toString(),
-    });
+    };
+
+    log.error(`Exception formatter (post) ${JSON.stringify(error)}`);
+
+    res.status(statusCode).send(error);
   }
 }