feat(express): add name field with default name on error

Ticket: DX-1197

Author: starfy84

modules/express/src/clientRoutes.ts

@@ -45,7 +45,7 @@ import { handlePingEnclavedExpress } from './enclavedExpressRoutes';
 import { RequestTracer } from 'bitgo/dist/src/v2/internal/util';
 
 import { Config } from './config';
-import { ApiResponseError } from './errors';
+import { ApiResponseError, BitGoExpressError } from './errors';
 import { promises as fs } from 'fs';
 import { retryPromise } from './retryPromise';
 import {
@@ -1310,16 +1310,17 @@ function handleRequestHandlerError(res: express.Response, error: unknown) {
   if (error instanceof Error) {
     err = error;
   } else if (typeof error === 'string') {
-    err = new Error('(string_error) ' + error);
+    err = new BitGoExpressError('(string_error) ' + error);
   } else {
-    err = new Error('(object_error) ' + JSON.stringify(error));
+    err = new BitGoExpressError('(object_error) ' + JSON.stringify(error));
   }
 
   const message = err.message || 'local error';
   // use attached result, or make one
   let result = err.result || { error: message };
   result = _.extend({}, result, {
     message: err.message,
+    name: err.name || 'BitGoExpressError',
     bitgoJsVersion: version,
     bitgoExpressVersion: pjson.version,
   });

modules/express/src/errors.ts

@@ -52,3 +52,10 @@ export class LightningSignerConfigError extends BitGoJsError {
     super(message || 'Lightning signer configuration is invalid');
   }
 }
+
+export class BitGoExpressError extends BitGoJsError {
+  public constructor(message?: string) {
+    super(message);
+    Object.setPrototypeOf(this, BitGoExpressError.prototype);
+  }
+}

modules/express/test/unit/clientRoutes/index.ts

@@ -134,5 +134,20 @@ describe('common methods', () => {
       res.status.calledWith(500).should.be.true();
       res.send.calledWithMatch((result: any) => result.message === 'Test error').should.be.true();
     });
+
+    it('should have name field on error request', async () => {
+      const handler = sandbox.stub().throws({ message: 'Test error' });
+      const req: any = {};
+      const res: any = {
+        status: sandbox.stub().returnsThis(),
+        send: sandbox.stub().returnsThis(),
+      };
+      const next = sandbox.stub();
+
+      await promiseWrapper(handler)(req, res, next);
+
+      res.status.calledWith(500).should.be.true();
+      res.send.calledWithMatch((result: any) => result.name === 'BitGoExpressError').should.be.true();
+    });
   });
 });