feat: add express compression

Author: MatthewPattell

package-lock.json

@@ -14,10 +14,10 @@
 		"worker",
 		"typescript"
 	],
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
 		"type": "git",
 		"url": "https://github.com/Lomray-Software/microservice-nodejs-lib.git"
 	},
@@ -38,18 +38,20 @@
 		"prepare": "husky install"
 	},
 	"dependencies": {
-		"axios": "^0.24.0",
-		"express": "^4.17.2",
+		"axios": "^0.27.2",
+		"compression": "^1.7.4",
+		"express": "^4.18.1",
 		"lodash": "^4.17.21",
-		"uuid": "^8.3.2"
+		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
-		"@commitlint/cli": "^13.2.1",
-		"@commitlint/config-conventional": "^13.2.0",
+		"@commitlint/cli": "^17.1.2",
+		"@commitlint/config-conventional": "^17.1.0",
 		"@istanbuljs/nyc-config-typescript": "^1.0.2",
-		"@lomray/eslint-config": "^1.1.2",
-		"@lomray/prettier-config": "^1.1.0",
+		"@lomray/eslint-config": "^1.2.1",
+		"@lomray/prettier-config": "^1.2.0",
 		"@types/chai": "^4.3.0",
+		"@types/compression": "^1.7.2",
 		"@types/express": "^4.17.13",
 		"@types/lodash": "^4.14.178",
 		"@types/mocha": "^9.0.0",
@@ -58,23 +60,23 @@
 		"@types/sinon-chai": "^3.2.8",
 		"@types/uuid": "^8.3.4",
 		"@zerollup/ts-transform-paths": "^1.7.18",
-		"rollup-plugin-ts": "^2.0.5",
-		"chai": "^4.3.4",
+		"chai": "^4.3.6",
 		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-prettier": "^4.0.0",
-		"husky": "^7.0.4",
-		"lint-staged": "^11.2.6",
-		"mocha": "^9.1.3",
+		"husky": "^8.0.1",
+		"lint-staged": "^13.0.3",
+		"mocha": "^9.2.2",
 		"nyc": "^15.1.0",
-		"prettier": "^2.5.1",
-		"rollup": "^2.63.0",
-		"semantic-release": "^18.0.1",
-		"sinon": "^11.1.2",
+		"prettier": "^2.7.1",
+		"rollup": "^2.79.1",
+		"rollup-plugin-ts": "^2.0.7",
+		"semantic-release": "^19.0.5",
+		"sinon": "^14.0.0",
 		"sinon-chai": "^3.7.0",
-		"ts-node": "^10.4.0",
-		"tsconfig-paths": "^3.12.0",
+		"ts-node": "10.9.1",
+		"tsconfig-paths": "^3.14.1",
 		"ttypescript": "^1.5.13",
-		"typescript": "4.4.4"
+		"typescript": "4.7.4"
 	}
 }

package.json

@@ -5,7 +5,8 @@ import {
   LOG_INFO_COLOR,
   LOG_INTERNAL_COLOR,
 } from '@constants/index';
-import { LogType, ConsoleInfoType } from '@interfaces/drivers/console-log';
+import type { ConsoleInfoType } from '@interfaces/drivers/console-log';
+import { LogType } from '@interfaces/drivers/console-log';
 
 const reqIds = new Map();
 

src/drivers/console-log.ts

@@ -1,5 +1,5 @@
 import type { CookieOptions } from 'express-serve-static-core';
-import BaseException from '@core/base-exception';
+import type BaseException from '@core/base-exception';
 
 enum CookiesAction {
   add = 'add',

src/interfaces/core/i-microservice-response.ts

@@ -1,15 +1,15 @@
 import type { AxiosRequestConfig, AxiosResponse } from 'axios';
 import type { Request } from 'express';
-import MicroserviceRequest from '@core/microservice-request';
-import MicroserviceResponse from '@core/microservice-response';
+import type MicroserviceRequest from '@core/microservice-request';
+import type MicroserviceResponse from '@core/microservice-response';
 import type { IEventRequest } from '@interfaces/core/i-event-request';
 import type { IMicroserviceRequest } from '@interfaces/core/i-microservice-request';
 import type {
   IMicroserviceResponseResult,
   IMicroserviceResponse,
 } from '@interfaces/core/i-microservice-response';
 import type { LogDriverType } from '@interfaces/drivers/console-log';
-import AbstractMicroservice from '@services/abstract-microservice';
+import type AbstractMicroservice from '@services/abstract-microservice';
 
 interface IAbstractMicroserviceOptions {
   name: string;

src/interfaces/services/i-abstract-microservice.ts

@@ -1,4 +1,5 @@
 import type { OptionsJson } from 'body-parser';
+import type { CompressionOptions } from 'compression';
 import type { Express, Request } from 'express';
 import type { IMicroserviceRequest } from '@interfaces/core/i-microservice-request';
 import type {
@@ -14,6 +15,7 @@ interface IGatewayOptions extends IAbstractMicroserviceOptions {
   hasAutoRegistration: boolean;
   batchLimit: number;
   jsonParams: OptionsJson;
+  compressionOptions?: CompressionOptions | false;
 }
 
 interface IGatewayParams extends IAbstractMicroserviceParams {

src/interfaces/services/i-gateway.ts

@@ -14,7 +14,8 @@ import WaitSec from '@helpers/wait-sec';
 import type IBaseException from '@interfaces/core/i-base-exception';
 import type { IEventRequest } from '@interfaces/core/i-event-request';
 import type { IMicroserviceRequest } from '@interfaces/core/i-microservice-request';
-import { LogDriverType, LogType } from '@interfaces/drivers/console-log';
+import type { LogDriverType } from '@interfaces/drivers/console-log';
+import { LogType } from '@interfaces/drivers/console-log';
 import type {
   IAbstractMicroserviceOptions,
   IAbstractMicroserviceParams,

src/services/abstract-microservice.ts

@@ -1,14 +1,15 @@
+import compression from 'compression';
 import type { Express, Request, Response } from 'express';
 import express from 'express';
-import { NextFunction } from 'express-serve-static-core';
+import type { NextFunction } from 'express-serve-static-core';
 import _ from 'lodash';
 import { EXCEPTION_CODE } from '@constants/index';
 import BaseException from '@core/base-exception';
 import MicroserviceRequest from '@core/microservice-request';
 import MicroserviceResponse from '@core/microservice-response';
 import { LogType } from '@interfaces/drivers/console-log';
 import { MiddlewareType } from '@interfaces/services/i-abstract-microservice';
-import {
+import type {
   GatewayEndpointHandler,
   IExpressRequest,
   IGatewayOptions,
@@ -69,10 +70,16 @@ class Gateway extends AbstractMicroservice {
     this.init(options, params);
 
     const { beforeRoute, afterRoute } = params;
-    const { listener, jsonParams } = this.options;
+    const { listener, jsonParams, compressionOptions } = this.options;
     const [, ...route] = listener.split('/');
 
     this.express.disable('x-powered-by');
+
+    // Enable response compression
+    if (compressionOptions !== false) {
+      this.express.use(compression(compressionOptions));
+    }
+
     // Parse JSON body request
     this.express.use(express.json(jsonParams));
     beforeRoute?.(this.express);