fix: cleanup response payload, fix tests

Author: MatthewPattell

.npmignore

@@ -5,6 +5,7 @@ coverage
 .github
 .husky
 .idea
+.run
 .nyc_output
 .gitattributes
 .editorconfig

__tests__/services/gateway-test.ts

@@ -78,21 +78,20 @@ describe('services/gateway', () => {
   it('should correct start microservice without info route', async () => {
     const sandbox = sinon.createSandbox();
 
-    sandbox.stub(ms.getExpress(), 'listen').returns({ close: sinon.stub() } as unknown as Server);
+    const localMs = Gateway.create({ infoRoute: null });
+    const getStub = sinon.stub();
+
+    sandbox
+      .stub(localMs.getExpress(), 'listen')
+      .returns({ close: sinon.stub(), get: getStub } as unknown as Server);
     sandbox.stub(axios, 'request').rejects(new Error('ECONNREFUSED'));
     sandbox.stub(Gateway, 'instance' as any).value(undefined);
 
-    const localMs = Gateway.create({ infoRoute: null });
-
     await localMs.start();
 
-    const infoRoute = _.findLast(localMs.getExpress()._router.stack, {
-      route: { path: '/', methods: { get: true } },
-    });
-
     sandbox.restore();
 
-    expect(infoRoute).to.undefined;
+    expect(getStub).to.not.called;
   });
 
   it('should correct register microservice handler', () => {
@@ -303,8 +302,6 @@ describe('services/gateway', () => {
     const response = res.json.firstCall.firstArg;
     const { data, headers } = stubbed.firstCall.firstArg;
 
-    _.unset(response.result, 'payload');
-
     expect(response.getResult()).to.deep.equal({ endpointTriggerMiddleware, middleware: 'after' });
     expect(data.method).to.equal(endpointTriggerMiddleware);
     expect(data.params.middleware).to.equal('before');

src/services/gateway.ts

@@ -237,11 +237,11 @@ class Gateway extends AbstractMicroservice {
       this.logDriver(() => `End batch request: ${body.length} (${id}).`, LogType.RES_EXTERNAL, id);
     }
 
-    // cookie manipulations
     (Array.isArray(response) ? response : [response]).forEach((msRes) => {
       const reqPayload = msRes?.getResult()?.payload;
       const cookies = reqPayload?.cookies;
 
+      // cookie manipulations
       if (Array.isArray(cookies)) {
         _.unset(reqPayload, 'cookies');
 
@@ -254,10 +254,16 @@ class Gateway extends AbstractMicroservice {
               res.clearCookie(cookie.name);
           }
         });
+      }
+
+      // remove performance payload
+      if (reqPayload?.performance) {
+        _.unset(msRes?.getResult(), 'payload.performance');
+      }
 
-        if (reqPayload && Object.keys(reqPayload).length === 0) {
-          _.unset(msRes?.getResult(), 'payload');
-        }
+      // remove payload key if it empties
+      if (reqPayload && Object.keys(reqPayload).length === 0) {
+        _.unset(msRes?.getResult(), 'payload');
       }
     });