feat: make errors loggable (#235)

packages/handlersjs-http/lib/handlers/error.handler.ts

@@ -1,6 +1,6 @@
 import { Observable, of } from 'rxjs';
 import { catchError } from 'rxjs/operators';
-import { getLogger } from '@digita-ai/handlersjs-logging';
+import { getLogger, makeErrorLoggable } from '@digita-ai/handlersjs-logging';
 import { HttpHandlerResponse } from '../models/http-handler-response';
 import { HttpHandler } from '../models/http-handler';
 import { HttpHandlerContext } from '../models/http-handler-context';
@@ -75,7 +75,7 @@ export class ErrorHandler implements HttpHandler {
     return this.nestedHandler.handle(context).pipe(
       catchError((error) => {
 
-        this.logger.warn('Error occurred: ', { error });
+        this.logger.warn('Error occurred: ', { error: makeErrorLoggable(error) });
 
         const status = error?.statusCode ?? error.status;
         const message = error?.message ?? error.body;

packages/handlersjs-http/lib/servers/node/node-http-request-response.handler.ts

@@ -1,7 +1,7 @@
 import { Observable, of, Subject, throwError } from 'rxjs';
 import { map, switchMap, toArray, catchError } from 'rxjs/operators';
 import { v4 } from 'uuid';
-import { getLogger } from '@digita-ai/handlersjs-logging';
+import { getLogger, makeErrorLoggable } from '@digita-ai/handlersjs-logging';
 import { BadRequestHttpError } from '../../errors/bad-request-http-error';
 import { HttpHandler } from '../../models/http-handler';
 import { HttpHandlerContext } from '../../models/http-handler-context';
@@ -204,7 +204,7 @@ export class NodeHttpRequestResponseHandler implements NodeHttpStreamsHandler {
         const status = error?.statusCode ?? error.status;
         const message = error?.message ?? error.body;
 
-        this.logger.warn(`${error.name}:`, { error });
+        this.logger.warn(`Unhandled error is handled by Handlersjs :`, { error: makeErrorLoggable(error) });
 
         return of({ headers: {}, ... error, body: message ?? 'Internal Server Error', status: statusCodes[status] ? status : 500 });
 

packages/handlersjs-logging/lib/index.ts

@@ -3,4 +3,5 @@ export * from './models/logger-options';
 export * from './loggers/logger';
 export * from './loggers/console-logger';
 export * from './loggers/pino-logger';
+export * from './util/make-error-loggable';
 export * from './main';

packages/handlersjs-logging/lib/util/make-error-loggable.spec.ts

@@ -0,0 +1,36 @@
+import { makeErrorLoggable } from './make-error-loggable';
+
+describe('makeErrorLoggable', () => {
+
+  it('should return a set values when passed something that is not an Error', async () => {
+
+    expect(makeErrorLoggable('foo')).toEqual({ 'error': 'not-an-error' });
+
+  });
+
+  it('should return a parsed object when passed an Error', async () => {
+
+    const error = new Error('foo');
+
+    expect(makeErrorLoggable(error)).toEqual({
+      message: 'foo',
+      name: 'Error',
+      stack: expect.any(Array),
+    });
+
+  });
+
+  it('should return an empty stack when passed an Error without a stack', async () => {
+
+    const error = new Error('foo');
+    delete error.stack;
+
+    expect(makeErrorLoggable(error)).toEqual({
+      message: 'foo',
+      name: 'Error',
+      stack: [],
+    });
+
+  });
+
+});

packages/handlersjs-logging/lib/util/make-error-loggable.ts

@@ -0,0 +1,15 @@
+export const makeErrorLoggable = (error: unknown): Record<string, unknown> => {
+
+  if (error instanceof Error) {
+
+    return {
+      message: error.message,
+      name: error.name,
+      stack: error.stack ? error.stack.split(/\n/) : [],
+    };
+
+  }
+
+  return { 'error': 'not-an-error' };
+
+};