@grandlinex/kernel 1.3.7 → 1.3.9

package/dist/cjs/Kernel.d.ts

@@ -1,12 +1,13 @@
 import { CoreKernel, CoreLogger } from '@grandlinex/core';
 import { ICClient, IKernel } from './lib/index.js';
-import { XRequest } from './lib/express.js';
+import { BaseKernelMetric } from './classes/index.js';
 /**
  *  @class Kernel
  */
 export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     private expressPort;
     private readonly apiVersion;
+    protected metric: BaseKernelMetric<unknown> | null;
     /**
      * Default Constructor
      * @param options App Name
@@ -24,8 +25,5 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     getAppServerPort(): number;
     setAppServerPort(port: number): void;
     getApiVersion(): number;
-    responseCodeFunction(data: {
-        code: number;
-        req: XRequest;
-    }): void;
+    getMetric(): BaseKernelMetric<unknown> | null;
 }

package/dist/cjs/Kernel.js

@@ -16,6 +16,7 @@ class Kernel extends core_1.CoreKernel {
      */
     constructor(options) {
         super({ ...options });
+        this.metric = null;
         this.apiVersion = options.apiVersion ?? 1;
         this.setBaseModule(new KernelModule_js_1.default(this));
         if (options.portOverride) {
@@ -39,11 +40,8 @@ class Kernel extends core_1.CoreKernel {
     getApiVersion() {
         return this.apiVersion;
     }
-    responseCodeFunction(data) {
-        const { code } = data;
-        if (code < 200 || code >= 300) {
-            this.debug(data.req.path, data.req.ip, data.code);
-        }
+    getMetric() {
+        return this.metric;
     }
 }
 exports.default = Kernel;

package/dist/cjs/classes/BaseAction.js

@@ -15,7 +15,7 @@ class BaseAction extends core_1.CoreAction {
     static validateSchema(error, inputSchema, key, field, required = true) {
         let schema;
         if ((0, core_1.instanceOfEntity)(inputSchema)) {
-            schema = swagger_mate_1.SPathUtil.schemaFromEntity(inputSchema);
+            schema = swagger_mate_1.ESchemaEditor.schemaFromEntity(inputSchema);
         }
         else {
             schema = inputSchema;
@@ -118,6 +118,21 @@ class BaseAction extends core_1.CoreAction {
         });
     }
     async secureHandler(req, res, next) {
+        const metric = this.getKernel().getMetric();
+        if (metric) {
+            const end = metric.start({
+                req,
+                action: this,
+            });
+            if (end) {
+                res.on('finish', () => metric.end({
+                    started: end,
+                    req,
+                    res,
+                    action: this,
+                }));
+            }
+        }
         const xPath = {};
         Object.entries(req.params).forEach(([k, v]) => {
             if (typeof v === 'string') {
@@ -132,12 +147,6 @@ class BaseAction extends core_1.CoreAction {
         });
         const extension = this.initExtension(res);
         const auth = extension.timing.start('auth');
-        res.on('finish', () => {
-            this.getKernel().responseCodeFunction({
-                code: res.statusCode,
-                req,
-            });
-        });
         const cc = this.getKernel().getCryptoClient();
         if (!cc) {
             res.status(504).send('internal server error');

package/dist/cjs/classes/BaseKernelMetric.d.ts

@@ -0,0 +1,14 @@
+import { XRequest, XResponse } from '../lib/express.js';
+import BaseAction from './BaseAction.js';
+export type MetricEventStart = {
+    req: XRequest;
+    action: BaseAction;
+};
+export type MetricEventEnd<T> = MetricEventStart & {
+    started: T;
+    res: XResponse;
+};
+export declare abstract class BaseKernelMetric<T> {
+    abstract start(event: MetricEventStart): T | null;
+    abstract end(event: MetricEventEnd<T>): void;
+}

package/dist/cjs/classes/BaseKernelMetric.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseKernelMetric = void 0;
+class BaseKernelMetric {
+}
+exports.BaseKernelMetric = BaseKernelMetric;

package/dist/cjs/classes/index.d.ts

@@ -5,6 +5,7 @@ import BaseKernelModule from './BaseKernelModule.js';
 import BaseApiAction from './BaseApiAction.js';
 import RouteApiAction from './RouteApiAction.js';
 import BaseAuthProvider from './BaseAuthProvider.js';
+export * from './BaseKernelMetric.js';
 export * from './BaseAction.js';
 export * from './BaseUserAgent.js';
 export * from './BaseAuthProvider.js';

package/dist/cjs/classes/index.js

@@ -60,6 +60,7 @@ const RouteApiAction_js_1 = __importDefault(require("./RouteApiAction.js"));
 exports.RouteApiAction = RouteApiAction_js_1.default;
 const BaseAuthProvider_js_1 = __importDefault(require("./BaseAuthProvider.js"));
 exports.BaseAuthProvider = BaseAuthProvider_js_1.default;
+__exportStar(require("./BaseKernelMetric.js"), exports);
 __exportStar(require("./BaseAction.js"), exports);
 __exportStar(require("./BaseUserAgent.js"), exports);
 __exportStar(require("./BaseAuthProvider.js"), exports);

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

@@ -3,6 +3,7 @@ import express from 'express';
 import * as jwt from 'jsonwebtoken';
 import { IAuthProvider, JwtExtend, JwtToken } from '../classes/index.js';
 import { XActionEvent, XRequest } from './express.js';
+import { BaseKernelMetric } from '../classes/BaseKernelMetric.js';
 /**
  * Represents a request for validating a JWT token with optional constraints.
  *
@@ -83,10 +84,7 @@ export interface IKernel<T extends JwtExtend = JwtExtend> extends ICoreKernel<IC
     getAppServerPort(): number;
     getApiVersion(): number;
     setAppServerPort(port: number): void;
-    responseCodeFunction(data: {
-        code: number;
-        req: XRequest;
-    }): void;
+    getMetric(): BaseKernelMetric<any> | null;
 }
 export type IBaseKernelModule<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> = ICoreKernelModule<K, T, P, C, E>;
 export type IBasePresenter = ICorePresenter<express.Express>;

package/dist/mjs/Kernel.d.ts

@@ -1,12 +1,13 @@
 import { CoreKernel, CoreLogger } from '@grandlinex/core';
 import { ICClient, IKernel } from './lib/index.js';
-import { XRequest } from './lib/express.js';
+import { BaseKernelMetric } from './classes/index.js';
 /**
  *  @class Kernel
  */
 export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     private expressPort;
     private readonly apiVersion;
+    protected metric: BaseKernelMetric<unknown> | null;
     /**
      * Default Constructor
      * @param options App Name
@@ -24,8 +25,5 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     getAppServerPort(): number;
     setAppServerPort(port: number): void;
     getApiVersion(): number;
-    responseCodeFunction(data: {
-        code: number;
-        req: XRequest;
-    }): void;
+    getMetric(): BaseKernelMetric<unknown> | null;
 }

package/dist/mjs/Kernel.js

@@ -11,6 +11,7 @@ export default class Kernel extends CoreKernel {
      */
     constructor(options) {
         super({ ...options });
+        this.metric = null;
         this.apiVersion = options.apiVersion ?? 1;
         this.setBaseModule(new KernelModule(this));
         if (options.portOverride) {
@@ -34,10 +35,7 @@ export default class Kernel extends CoreKernel {
     getApiVersion() {
         return this.apiVersion;
     }
-    responseCodeFunction(data) {
-        const { code } = data;
-        if (code < 200 || code >= 300) {
-            this.debug(data.req.path, data.req.ip, data.code);
-        }
+    getMetric() {
+        return this.metric;
     }
 }

package/dist/mjs/classes/BaseAction.js

@@ -1,5 +1,5 @@
 import { CoreAction, instanceOfEntity, } from '@grandlinex/core';
-import { ActionMode, isErrorType, isSwaggerRef, SPathUtil, } from '@grandlinex/swagger-mate';
+import { ActionMode, ESchemaEditor, isErrorType, isSwaggerRef, } from '@grandlinex/swagger-mate';
 import { ExpressServerTiming } from './timing/index.js';
 import { BaseUserAgent } from './BaseUserAgent.js';
 export default class BaseAction extends CoreAction {
@@ -13,7 +13,7 @@ export default class BaseAction extends CoreAction {
     static validateSchema(error, inputSchema, key, field, required = true) {
         let schema;
         if (instanceOfEntity(inputSchema)) {
-            schema = SPathUtil.schemaFromEntity(inputSchema);
+            schema = ESchemaEditor.schemaFromEntity(inputSchema);
         }
         else {
             schema = inputSchema;
@@ -116,6 +116,21 @@ export default class BaseAction extends CoreAction {
         });
     }
     async secureHandler(req, res, next) {
+        const metric = this.getKernel().getMetric();
+        if (metric) {
+            const end = metric.start({
+                req,
+                action: this,
+            });
+            if (end) {
+                res.on('finish', () => metric.end({
+                    started: end,
+                    req,
+                    res,
+                    action: this,
+                }));
+            }
+        }
         const xPath = {};
         Object.entries(req.params).forEach(([k, v]) => {
             if (typeof v === 'string') {
@@ -130,12 +145,6 @@ export default class BaseAction extends CoreAction {
         });
         const extension = this.initExtension(res);
         const auth = extension.timing.start('auth');
-        res.on('finish', () => {
-            this.getKernel().responseCodeFunction({
-                code: res.statusCode,
-                req,
-            });
-        });
         const cc = this.getKernel().getCryptoClient();
         if (!cc) {
             res.status(504).send('internal server error');

package/dist/mjs/classes/BaseKernelMetric.d.ts

@@ -0,0 +1,14 @@
+import { XRequest, XResponse } from '../lib/express.js';
+import BaseAction from './BaseAction.js';
+export type MetricEventStart = {
+    req: XRequest;
+    action: BaseAction;
+};
+export type MetricEventEnd<T> = MetricEventStart & {
+    started: T;
+    res: XResponse;
+};
+export declare abstract class BaseKernelMetric<T> {
+    abstract start(event: MetricEventStart): T | null;
+    abstract end(event: MetricEventEnd<T>): void;
+}

package/dist/mjs/classes/BaseKernelMetric.js

@@ -0,0 +1,2 @@
+export class BaseKernelMetric {
+}

package/dist/mjs/classes/index.d.ts

@@ -5,6 +5,7 @@ import BaseKernelModule from './BaseKernelModule.js';
 import BaseApiAction from './BaseApiAction.js';
 import RouteApiAction from './RouteApiAction.js';
 import BaseAuthProvider from './BaseAuthProvider.js';
+export * from './BaseKernelMetric.js';
 export * from './BaseAction.js';
 export * from './BaseUserAgent.js';
 export * from './BaseAuthProvider.js';

package/dist/mjs/classes/index.js

@@ -5,6 +5,7 @@ import BaseKernelModule from './BaseKernelModule.js';
 import BaseApiAction from './BaseApiAction.js';
 import RouteApiAction from './RouteApiAction.js';
 import BaseAuthProvider from './BaseAuthProvider.js';
+export * from './BaseKernelMetric.js';
 export * from './BaseAction.js';
 export * from './BaseUserAgent.js';
 export * from './BaseAuthProvider.js';

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

@@ -3,6 +3,7 @@ import express from 'express';
 import * as jwt from 'jsonwebtoken';
 import { IAuthProvider, JwtExtend, JwtToken } from '../classes/index.js';
 import { XActionEvent, XRequest } from './express.js';
+import { BaseKernelMetric } from '../classes/BaseKernelMetric.js';
 /**
  * Represents a request for validating a JWT token with optional constraints.
  *
@@ -83,10 +84,7 @@ export interface IKernel<T extends JwtExtend = JwtExtend> extends ICoreKernel<IC
     getAppServerPort(): number;
     getApiVersion(): number;
     setAppServerPort(port: number): void;
-    responseCodeFunction(data: {
-        code: number;
-        req: XRequest;
-    }): void;
+    getMetric(): BaseKernelMetric<any> | null;
 }
 export type IBaseKernelModule<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> = ICoreKernelModule<K, T, P, C, E>;
 export type IBasePresenter = ICorePresenter<express.Express>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/kernel",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "description": "GrandLineX is an out-of-the-box server framework on top of ExpressJs.",
   "type": "module",
   "exports": {
@@ -47,7 +47,7 @@
   "license": "BSD-3-Clause",
   "dependencies": {
     "@grandlinex/core": "1.3.1",
-    "@grandlinex/swagger-mate": "1.3.8",
+    "@grandlinex/swagger-mate": "1.3.9",
     "@types/jsonwebtoken": "9.0.10",
     "@types/ms": "2.1.0",
     "body-parser": "2.2.1",