@lucaapp/service-utils 1.16.0 → 1.18.0

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './lib/kafka';
 export * from './lib/serviceIdentity';
 export * from './lib/urlEncoded';
 export * from './lib/metrics';
+export * from './lib/middleware';
 export * from './lib/requestTracer';
 export * from './lib/wsEvent';
 export * from './lib/lifecycle';

package/dist/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./lib/kafka"), exports);
 __exportStar(require("./lib/serviceIdentity"), exports);
 __exportStar(require("./lib/urlEncoded"), exports);
 __exportStar(require("./lib/metrics"), exports);
+__exportStar(require("./lib/middleware"), exports);
 __exportStar(require("./lib/requestTracer"), exports);
 __exportStar(require("./lib/wsEvent"), exports);
 __exportStar(require("./lib/lifecycle"), exports);

package/dist/lib/middleware/index.d.ts

@@ -0,0 +1 @@
+export * from './requestMetrics';

package/dist/lib/middleware/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requestMetrics"), exports);

package/dist/lib/middleware/requestMetrics.d.ts

@@ -0,0 +1,3 @@
+import { RequestHandler } from 'express';
+declare const responseTimeMiddleware: RequestHandler;
+export default responseTimeMiddleware;

package/dist/lib/middleware/requestMetrics.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const response_time_1 = __importDefault(require("response-time"));
+const normalizePath_1 = __importDefault(require("utils/normalizePath"));
+const metrics_1 = require("lib/metrics");
+const labelNames = ['method', 'statusCode', 'path', 'host'];
+const requestDuration = new metrics_1.metricsClient.Histogram({
+    name: 'http_request_duration_seconds',
+    help: 'A histogram of the HTTP request durations in seconds.',
+    buckets: [0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10],
+    labelNames,
+});
+const responseSize = new metrics_1.metricsClient.Histogram({
+    name: 'http_response_size_bytes',
+    help: 'A histogram of the HTTP response size in bytes.',
+    buckets: [100, 1000, 10000, 100000, 1000000, 10000000, 100000000, 1000000000],
+    labelNames,
+});
+const responseTimeMiddleware = (0, response_time_1.default)((request, response, time) => {
+    const { method, route, baseUrl, originalUrl, headers: { host }, } = request;
+    const { statusCode, _contentLength } = response;
+    if (!route)
+        return;
+    const path = `${baseUrl || (0, normalizePath_1.default)(originalUrl, route.path)}${baseUrl ? route.path : ''}`.toLowerCase();
+    const labels = {
+        method,
+        path,
+        statusCode,
+        host,
+    };
+    requestDuration.observe(labels, time / 1000);
+    responseSize.observe(labels, _contentLength || 0);
+});
+exports.default = responseTimeMiddleware;

package/dist/lib/urlEncoded/index.d.ts

@@ -1 +1 @@
-export declare const createSafeUrlPath: (rawPath: string | string[]) => string;
+export declare const createSafeUrlPath: (rawPath: string[]) => string;

package/dist/utils/normalizePath.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (path: string, routePath: string) => string;
+export default _default;

package/dist/utils/normalizePath.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const url_value_parser_1 = __importDefault(require("url-value-parser"));
+exports.default = (path, routePath) => {
+    const parser = new url_value_parser_1.default({
+        extraMasks: ['payment_[0-9]+'],
+    });
+    const masks = routePath.split('/').filter(part => part.startsWith(':'));
+    let formattedPath = path;
+    const [actualPath, queryString] = path.split('?');
+    if (queryString || queryString === '') {
+        formattedPath = actualPath;
+    }
+    formattedPath = decodeURIComponent(formattedPath);
+    const { chunks, valueIndexes } = parser.parsePathValues(formattedPath);
+    if (valueIndexes.length === 0 && masks.length > 0) {
+        return `${formattedPath}${routePath}`.replace('//', '/');
+    }
+    if (masks.length === 0) {
+        return formattedPath;
+    }
+    return [
+        '',
+        ...chunks.map((chunk, index) => valueIndexes.includes(index) ? masks.shift() : chunk),
+    ].join('/');
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucaapp/service-utils",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -37,6 +37,7 @@
   "dependencies": {
     "@hapi/boom": "^10.0.0",
     "@types/express": "4.17.13",
+    "@types/response-time": "^2.3.5",
     "axios": "^0.27.2",
     "cls-rtracer": "^2.6.2",
     "jose": "4.9.2",
@@ -45,6 +46,8 @@
     "moment": "^2.29.4",
     "pino-http": "8.2.1",
     "prom-client": "14.1.0",
+    "response-time": "^2.3.2",
+    "url-value-parser": "^2.2.0",
     "uuid": "^9.0.0"
   }
 }