feat: add performance payload

Author: MatthewPattell

__tests__/services/abstract-microservice-test.ts

@@ -2,6 +2,7 @@
 import dns from 'dns';
 import axios from 'axios';
 import { expect } from 'chai';
+import _ from 'lodash';
 import sinon from 'sinon';
 import BaseException from '@core/base-exception';
 import MicroserviceRequest from '@core/microservice-request';
@@ -275,6 +276,8 @@ describe('services/abstract-microservice', () => {
     const stubbed = await createAxiosMock(req.toJSON());
     const secondCall = stubbed.getCall(1).firstArg;
 
+    _.unset(secondCall.data.getResult(), 'payload');
+
     expect(secondCall.data.getResult()).to.deep.equal({ ...result, middleware: 'after' });
     expect(handler.firstCall.firstArg).to.deep.equal({ ...req.getParams(), middleware: 'before' });
   });
@@ -361,6 +364,8 @@ describe('services/abstract-microservice', () => {
 
     stubbed.restore();
 
+    _.unset(data, 'params.payload.performance');
+
     expect(result).to.instanceof(MicroserviceResponse);
     expect(result.getResult()).to.deep.equal(response);
     // Set correctly microservice url

__tests__/services/gateway-test.ts

@@ -303,6 +303,8 @@ 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/abstract-microservice.ts

@@ -1,5 +1,6 @@
 import type { Agent } from 'http';
 import http from 'http';
+import { performance } from 'perf_hooks';
 import axios from 'axios';
 import _ from 'lodash';
 import { v4 as uuidv4 } from 'uuid';
@@ -207,6 +208,22 @@ abstract class AbstractMicroservice {
     return this;
   }
 
+  /**
+   * Inject performance record to request or response
+   * @protected
+   */
+  protected injectPerformance(data: Record<string, any>, key: string, type: 'req' | 'res'): void {
+    const stack = data?.payload?.performance ?? [];
+
+    stack.push({
+      key,
+      type,
+      point: performance.now(),
+    });
+
+    _.set(data, 'payload.performance', stack);
+  }
+
   /**
    * Add process exit handler
    * E.g. for close DB connection etc.
@@ -345,6 +362,8 @@ abstract class AbstractMicroservice {
 
       const task = new MicroserviceRequest(req.data);
 
+      this.injectPerformance(task.getParams()!, `${name}-start`, 'req');
+
       return { task, req };
     } catch (e) {
       // Could not connect to ijson or channel
@@ -369,6 +388,7 @@ abstract class AbstractMicroservice {
     task: ITask['task'],
     req: ITask['req'],
   ): Promise<MicroserviceResponse> {
+    const { name } = this.options;
     const response = new MicroserviceResponse({ id: task.getId() });
     const taskSender =
       task instanceof MicroserviceRequest ? task.getParams()?.payload?.sender : null;
@@ -437,6 +457,8 @@ abstract class AbstractMicroservice {
       response.getId(),
     );
 
+    this.injectPerformance(response.getResult()!, `${name}-end`, 'res');
+
     return response;
   }
 
@@ -631,6 +653,7 @@ abstract class AbstractMicroservice {
     _.set(requestParams, 'payload.sender', sender);
     _.set(requestParams, 'payload.senderStack', [...(data.payload?.senderStack ?? []), sender]);
     _.set(requestParams, 'payload.isInternal', isInternal);
+    this.injectPerformance(requestParams, `${microservice}-start`, 'req');
 
     const request = new MicroserviceRequest({
       ...(shouldGenerateId || reqId ? { id: reqId ?? uuidv4() } : {}),
@@ -670,6 +693,8 @@ abstract class AbstractMicroservice {
         throw new BaseException(result.error);
       }
 
+      this.injectPerformance(result.result, `${microservice}-end`, 'res');
+
       response.setResult(result.result);
 
       return response;

src/services/gateway.ts

@@ -295,6 +295,7 @@ class Gateway extends AbstractMicroservice {
     _.set(body, 'params.payload.senderStack', ['client']);
     _.set(body, 'params.payload.isInternal', false);
     _.set(body, 'params.payload.headers', headers);
+    this.injectPerformance(body.params!, 'gateway-start', 'req');
 
     const request = new MicroserviceRequest(body);
     const [microservice] = request.getMethod().split('.');
@@ -350,6 +351,8 @@ class Gateway extends AbstractMicroservice {
         `${request.getId()!}-gateway`,
       );
 
+      this.injectPerformance(result!, 'gateway-end', 'req');
+
       response.setResult(result);
 
       return response;