@adaptivestone/framework 4.6.0 → 4.7.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 4.7.0
+
+[UPDATE] update logger init (refactor)
+[UPDATE] updated deps
+
 ### 4.6.0
 
 [NEW] migrated from JEST to vitest

package/cluster.js

@@ -21,6 +21,5 @@ if (cluster.isMaster) {
     cluster.fork();
   });
 } else {
-  // eslint-disable-next-line global-require
-  require('./index');
+  import('./server.js');
 }

package/commands/GetOpenApiJson.js

@@ -13,8 +13,7 @@ class GetOpenApiJson extends AbstractCommand {
     }
 
     try {
-      // eslint-disable-next-line import/no-dynamic-require, global-require
-      jsonFile = require(jsonFile);
+      jsonFile = JSON.parse(await fs.readFile(jsonFile, 'utf8'));
     } catch (e) {
       this.logger.error(
         'No npm package detected. Please start this command via NPM as it depends on package.json',

package/commands/migration/Migrate.js

@@ -31,8 +31,8 @@ class Migrate extends AbstractCommand {
 
     for (const migration of migrations) {
       this.logger.info(`=== Start migration ${migration.file} ===`);
-      // eslint-disable-next-line import/no-dynamic-require, global-require
-      const MigrationCommand = require(migration.path);
+      // eslint-disable-next-line no-await-in-loop
+      const MigrationCommand = await import(migration.path);
       const migrationCommand = new MigrationCommand(this.app);
       // eslint-disable-next-line no-await-in-loop
       await migrationCommand.up();

package/controllers/index.js

@@ -33,7 +33,6 @@ class ControllerManager extends Base {
       // TODO wait until https://github.com/nodejs/node/issues/35889
       controllers.push(
         import(controller.path).then(({ default: ControllerModule }) => {
-          // eslint-disable-next-line import/no-dynamic-require, global-require
           // const ControllerModule = require(controller.path);
           const contollerName = ControllerModule.name.toLowerCase();
           let prefix = path.dirname(controller.file);

package/modules/AbstractController.js

@@ -271,7 +271,7 @@ class AbstractController extends Base {
      */
     if (!this.app.httpServer) {
       this.app.documentation.push(
-        DocumentationGenerator.convertDataToDocumentationElement(
+        new DocumentationGenerator(this.app).convertDataToDocumentationElement(
           this.getConstructorName(),
           routesInfo,
           middlewaresInfo,

package/modules/Base.js

@@ -29,71 +29,10 @@ class Base {
 
   /**
    * Get winston loger for given label
-   * @param {sting} label name of logger
+   * @param {string} label name of logger
    */
   getLogger(label) {
-    // eslint-disable-next-line global-require
-    const winston = require('winston'); // speed up optimisation
-    const alignColorsAndTime = winston.format.combine(
-      winston.format.colorize({
-        all: true,
-      }),
-      winston.format.label({
-        label: ` \x1B[32m[${label}]\x1B[39m`,
-      }),
-      winston.format.timestamp(),
-      winston.format.printf(
-        (info) =>
-          `(${process.pid}) ${info.label}  ${info.timestamp}  ${info.level} : ${info.message}`,
-      ),
-    );
-
-    const logConfig = this.app.getConfig('log').transports;
-
-    function IsConstructor(f) {
-      try {
-        Reflect.construct(String, [], f);
-      } catch (e) {
-        return false;
-      }
-      return true;
-    }
-    const transports = [];
-    for (const log of logConfig) {
-      if (log.enable) {
-        if (log.transport === 'console') {
-          transports.push(
-            new winston.transports.Console({
-              level: log.transportOptions.level,
-              format: winston.format.combine(
-                winston.format.colorize(),
-                alignColorsAndTime,
-              ),
-            }),
-          );
-        } else {
-          // eslint-disable-next-line global-require, import/no-dynamic-require
-          let Tr = require(log.transport);
-          if (!IsConstructor(Tr) && Tr.default) {
-            Tr = Tr.default;
-          } else {
-            // eslint-disable-next-line no-console
-            console.error(
-              `${log.transport} not a constructor. Please check it`,
-            );
-            // eslint-disable-next-line no-continue
-            continue;
-          }
-
-          transports.push(new Tr(log.transportOptions));
-        }
-      }
-    }
-
-    return winston.createLogger({
-      level: 'silly',
-      transports,
-    });
+    return this.app.logger.child({ label });
   }
 
   async getFilesPathWithInheritance(internalFolder, externalFolder) {

package/modules/BaseCli.js

@@ -50,7 +50,6 @@ class Cli extends Base {
     // TODO wait until https://github.com/nodejs/node/issues/35889
     const { default: Command } = await import(this.commands[command]);
 
-    // eslint-disable-next-line import/no-dynamic-require, global-require
     // const Command = require(this.commands[command]);
 
     const c = new Command(this.app, this.commands, args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "engines": {

package/server.d.ts

@@ -7,6 +7,7 @@ import { Model as MongooseModel, Schema } from 'mongoose';
 
 import BaseCli from './modules/BaseCli';
 import Cache from './services/cache/Cache';
+import winston from 'winston';
 
 type ServerConfig = {
   folders: ExpandDeep<TFolderConfig>;
@@ -22,6 +23,7 @@ declare class Server {
     foldersConfig: Server['config']['folders'];
     events: EventEmitter;
     get cache(): Server['cacheService'];
+    get logger(): winston.Logger;
     httpServer: null;
     controllerManager: null;
   };
@@ -39,7 +41,7 @@ declare class Server {
   constructor(config: ExpandDeep<ServerConfig>);
 
   /**
-   * Start server (http + websocket + init all http and websocet ralated functions)
+   * Start server (http  + init all http ralated functions)
    */
   startServer(callbackBefore404?: Promise<null>): Promise<null>;
 
@@ -54,6 +56,11 @@ declare class Server {
    */
   getConfig(configName: string): {};
 
+  /**
+   * Return or create new logger instance. This is a main logger instance
+   */
+  getLogger(): winston.Logger;
+
   /**
    * Primary designed for tests when we need to update some configs before start testing
    * Should be called before any initialization was done

package/server.js

@@ -3,11 +3,14 @@ const EventEmitter = require('node:events');
 
 require('dotenv').config();
 const merge = require('deepmerge');
+const winston = require('winston');
 
 /**
  * Main framework class.
  */
 class Server {
+  #realLogger = null;
+
   /**
    *  Construct new server
    * @param {Object} config main config object
@@ -33,6 +36,9 @@ class Server {
       get cache() {
         return that.getCache();
       },
+      get logger() {
+        return that.getLogger();
+      },
       httpServer: null,
       controllerManager: null,
     };
@@ -46,21 +52,17 @@ class Server {
   }
 
   /**
-   * Start server (http + websocket + init all http and websocet ralated functions)
+   * Start server (http  + init all http ralated functions)
    * @param <Promise>callbackBefore404 code that should be executed before adding page 404
    * @returns {Promise}
    */
   async startServer(callbackBefore404 = async () => Promise.resolve()) {
-    // eslint-disable-next-line global-require
     // const HttpServer = require('./services/http/HttpServer');
-    // eslint-disable-next-line global-require
     // const ControllerManager = require('./controllers/index');
     // TODO wait until https://github.com/nodejs/node/issues/35889
     const [{ default: HttpServer }, { default: ControllerManager }] =
       await Promise.all([
-        // eslint-disable-next-line import/extensions
         import('./services/http/HttpServer.js'), // Speed optimisation
-        // eslint-disable-next-line import/extensions
         import('./controllers/index.js'), // Speed optimisation
       ]);
 
@@ -126,6 +128,80 @@ class Server {
     return this.cache.configs.get(configName);
   }
 
+  /**
+   * Return or create new logger instance. This is a main logger instance
+   */
+  getLogger() {
+    if (!this.#realLogger) {
+      this.#realLogger = this.#createLogger();
+    }
+    return this.#realLogger;
+  }
+
+  #createLogger() {
+    const alignColorsAndTime = winston.format.combine(
+      winston.format.colorize({
+        all: true,
+      }),
+      winston.format.timestamp(),
+      winston.format.printf(
+        (info) =>
+          `(${process.pid}) \x1B[32m[${info.label ?? 'SERVER'}]\x1B[39m ${
+            info.timestamp
+          }  ${info.level} : ${info.message} ${info?.stack ?? ''} ${
+            info.durationMs ? `Duration: ${info.durationMs}ms` : ''
+          }`,
+      ),
+    );
+    const logConfig = this.app.getConfig('log').transports;
+    function IsConstructor(f) {
+      try {
+        Reflect.construct(String, [], f);
+      } catch (e) {
+        return false;
+      }
+      return true;
+    }
+
+    const logger = winston.createLogger({
+      format: winston.format.errors({ stack: true }),
+      level: 'silly',
+    });
+
+    for (const log of logConfig) {
+      if (log.enable) {
+        if (log.transport === 'console') {
+          logger.add(
+            new winston.transports.Console({
+              level: log.transportOptions.level,
+              format: winston.format.combine(
+                winston.format.colorize(),
+                alignColorsAndTime,
+              ),
+            }),
+          );
+        } else {
+          import(log.transport).then((Tr) => {
+            let Transport = Tr.default;
+            if (!IsConstructor(Transport) && Transport.default) {
+              Transport = Transport.default;
+            } else {
+              console.error(
+                `${log.transport} not a constructor. Please check it`,
+              );
+              return;
+            }
+            logger.profile(`Adding new logger ${log.transport}`);
+            logger.add(new Transport(log.transportOptions));
+            logger.profile(`Adding new logger ${log.transport}`);
+          });
+        }
+      }
+    }
+
+    return logger;
+  }
+
   /**
    * Primary designed for tests when we need to update some configs before start testing
    * Should be called before any initialization was done
@@ -178,11 +254,9 @@ class Server {
    */
   async runCliCommand(commandName, args) {
     if (!this.cli) {
-      // eslint-disable-next-line import/extensions
       // TODO wait until https://github.com/nodejs/node/issues/35889
-      // const { default: BaseCli } = await import('./modules/BaseCli.js'); // Speed optimisation
-      // eslint-disable-next-line global-require
-      const BaseCli = require('./modules/BaseCli');
+      const { default: BaseCli } = await import('./modules/BaseCli.js'); // Speed optimisation
+      // const BaseCli = require('./modules/BaseCli');
       this.cli = new BaseCli(this);
     }
     return this.cli.run(commandName, args);

package/services/documentation/DocumentationGenerator.js

@@ -2,7 +2,8 @@ const Base = require('../../modules/Base');
 const ValidateService = require('../validate/ValidateService');
 
 class DocumentationGenerator extends Base {
-  static processingFields(fieldsByRoute) {
+  // eslint-disable-next-line class-methods-use-this
+  processingFields(fieldsByRoute) {
     const fields = [];
     if (!fieldsByRoute) {
       return fields;
@@ -36,7 +37,8 @@ class DocumentationGenerator extends Base {
     return fields;
   }
 
-  static selectUniqueFields(fields) {
+  // eslint-disable-next-line class-methods-use-this
+  selectUniqueFields(fields) {
     return Array.from(
       new Map(fields.map((item) => [item.name, item])).values(),
     ).reduce((uniqueArray, item) => {
@@ -52,7 +54,7 @@ class DocumentationGenerator extends Base {
     }, []);
   }
 
-  static groupFieldsFromSchemas(schemas) {
+  groupFieldsFromSchemas(schemas) {
     const result = [];
     schemas.forEach((schema) => {
       const convertedSchema = new ValidateService(this.app, schema).validator;
@@ -71,7 +73,7 @@ class DocumentationGenerator extends Base {
     return result;
   }
 
-  static convertDataToDocumentationElement(
+  convertDataToDocumentationElement(
     controllerName,
     routesInfo,
     middlewaresInfo,
@@ -80,23 +82,19 @@ class DocumentationGenerator extends Base {
     return {
       contollerName: controllerName,
       routesInfo: routesInfo.map((route) => {
-        const middlewareQueryParams = ValidateService.getMiddlewareParams(
-          middlewaresInfo,
-          routeMiddlewaresReg,
-          {
-            method: route.method.toLowerCase(),
-            path: route.fullPath,
-          },
-        ).query;
+        const middlewareQueryParams = new ValidateService(
+          this.app,
+        ).getMiddlewareParams(middlewaresInfo, routeMiddlewaresReg, {
+          method: route.method.toLowerCase(),
+          path: route.fullPath,
+        }).query;
 
-        const middlewareRequestParams = ValidateService.getMiddlewareParams(
-          middlewaresInfo,
-          routeMiddlewaresReg,
-          {
-            method: route.method.toLowerCase(),
-            path: route.fullPath,
-          },
-        ).request;
+        const middlewareRequestParams = new ValidateService(
+          this.app,
+        ).getMiddlewareParams(middlewaresInfo, routeMiddlewaresReg, {
+          method: route.method.toLowerCase(),
+          path: route.fullPath,
+        }).request;
 
         const queryParams = this.groupFieldsFromSchemas(middlewareQueryParams);
 

package/services/validate/ValidateService.js

@@ -41,7 +41,7 @@ class ValidateService extends Base {
   /**
    * Filter middlewares by route path and select all parameters
    */
-  static filterRelatedParametersByRoute(middlewares, method, path) {
+  filterRelatedParametersByRoute(middlewares, method, path) {
     const middlewaresParams = middlewares
       .filter(
         (middleware) =>
@@ -63,11 +63,7 @@ class ValidateService extends Base {
   /**
    * Group all middleware(routes + controller) parameters
    */
-  static getMiddlewareParams(
-    controllerMiddlewares,
-    AllrouteMiddlewares,
-    options,
-  ) {
+  getMiddlewareParams(controllerMiddlewares, AllrouteMiddlewares, options) {
     const { method, path } = options;
     const routeMiddlewaresParams = this.filterRelatedParametersByRoute(
       AllrouteMiddlewares,
@@ -134,7 +130,7 @@ class ValidateService extends Base {
       this.validator,
       selectedReqData,
     );
-    const additionalMiddlewareSchemas = this.constructor.getMiddlewareParams(
+    const additionalMiddlewareSchemas = this.getMiddlewareParams(
       middlewaresInfo,
       routeMiddlewaresReg,
       routeOptions,

package/coverage/base.css

@@ -1,224 +0,0 @@
-body, html {
-  margin:0; padding: 0;
-  height: 100%;
-}
-body {
-    font-family: Helvetica Neue, Helvetica, Arial;
-    font-size: 14px;
-    color:#333;
-}
-.small { font-size: 12px; }
-*, *:after, *:before {
-  -webkit-box-sizing:border-box;
-     -moz-box-sizing:border-box;
-          box-sizing:border-box;
-  }
-h1 { font-size: 20px; margin: 0;}
-h2 { font-size: 14px; }
-pre {
-    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
-    margin: 0;
-    padding: 0;
-    -moz-tab-size: 2;
-    -o-tab-size:  2;
-    tab-size: 2;
-}
-a { color:#0074D9; text-decoration:none; }
-a:hover { text-decoration:underline; }
-.strong { font-weight: bold; }
-.space-top1 { padding: 10px 0 0 0; }
-.pad2y { padding: 20px 0; }
-.pad1y { padding: 10px 0; }
-.pad2x { padding: 0 20px; }
-.pad2 { padding: 20px; }
-.pad1 { padding: 10px; }
-.space-left2 { padding-left:55px; }
-.space-right2 { padding-right:20px; }
-.center { text-align:center; }
-.clearfix { display:block; }
-.clearfix:after {
-  content:'';
-  display:block;
-  height:0;
-  clear:both;
-  visibility:hidden;
-  }
-.fl { float: left; }
-@media only screen and (max-width:640px) {
-  .col3 { width:100%; max-width:100%; }
-  .hide-mobile { display:none!important; }
-}
-
-.quiet {
-  color: #7f7f7f;
-  color: rgba(0,0,0,0.5);
-}
-.quiet a { opacity: 0.7; }
-
-.fraction {
-  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
-  font-size: 10px;
-  color: #555;
-  background: #E8E8E8;
-  padding: 4px 5px;
-  border-radius: 3px;
-  vertical-align: middle;
-}
-
-div.path a:link, div.path a:visited { color: #333; }
-table.coverage {
-  border-collapse: collapse;
-  margin: 10px 0 0 0;
-  padding: 0;
-}
-
-table.coverage td {
-  margin: 0;
-  padding: 0;
-  vertical-align: top;
-}
-table.coverage td.line-count {
-    text-align: right;
-    padding: 0 5px 0 20px;
-}
-table.coverage td.line-coverage {
-    text-align: right;
-    padding-right: 10px;
-    min-width:20px;
-}
-
-table.coverage td span.cline-any {
-    display: inline-block;
-    padding: 0 5px;
-    width: 100%;
-}
-.missing-if-branch {
-    display: inline-block;
-    margin-right: 5px;
-    border-radius: 3px;
-    position: relative;
-    padding: 0 4px;
-    background: #333;
-    color: yellow;
-}
-
-.skip-if-branch {
-    display: none;
-    margin-right: 10px;
-    position: relative;
-    padding: 0 4px;
-    background: #ccc;
-    color: white;
-}
-.missing-if-branch .typ, .skip-if-branch .typ {
-    color: inherit !important;
-}
-.coverage-summary {
-  border-collapse: collapse;
-  width: 100%;
-}
-.coverage-summary tr { border-bottom: 1px solid #bbb; }
-.keyline-all { border: 1px solid #ddd; }
-.coverage-summary td, .coverage-summary th { padding: 10px; }
-.coverage-summary tbody { border: 1px solid #bbb; }
-.coverage-summary td { border-right: 1px solid #bbb; }
-.coverage-summary td:last-child { border-right: none; }
-.coverage-summary th {
-  text-align: left;
-  font-weight: normal;
-  white-space: nowrap;
-}
-.coverage-summary th.file { border-right: none !important; }
-.coverage-summary th.pct { }
-.coverage-summary th.pic,
-.coverage-summary th.abs,
-.coverage-summary td.pct,
-.coverage-summary td.abs { text-align: right; }
-.coverage-summary td.file { white-space: nowrap;  }
-.coverage-summary td.pic { min-width: 120px !important;  }
-.coverage-summary tfoot td { }
-
-.coverage-summary .sorter {
-    height: 10px;
-    width: 7px;
-    display: inline-block;
-    margin-left: 0.5em;
-    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
-}
-.coverage-summary .sorted .sorter {
-    background-position: 0 -20px;
-}
-.coverage-summary .sorted-desc .sorter {
-    background-position: 0 -10px;
-}
-.status-line {  height: 10px; }
-/* yellow */
-.cbranch-no { background: yellow !important; color: #111; }
-/* dark red */
-.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
-.low .chart { border:1px solid #C21F39 }
-.highlighted,
-.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
-  background: #C21F39 !important;
-}
-/* medium red */
-.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
-/* light red */
-.low, .cline-no { background:#FCE1E5 }
-/* light green */
-.high, .cline-yes { background:rgb(230,245,208) }
-/* medium green */
-.cstat-yes { background:rgb(161,215,106) }
-/* dark green */
-.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
-.high .chart { border:1px solid rgb(77,146,33) }
-/* dark yellow (gold) */
-.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
-.medium .chart { border:1px solid #f9cd0b; }
-/* light yellow */
-.medium { background: #fff4c2; }
-
-.cstat-skip { background: #ddd; color: #111; }
-.fstat-skip { background: #ddd; color: #111 !important; }
-.cbranch-skip { background: #ddd !important; color: #111; }
-
-span.cline-neutral { background: #eaeaea; }
-
-.coverage-summary td.empty {
-    opacity: .5;
-    padding-top: 4px;
-    padding-bottom: 4px;
-    line-height: 1;
-    color: #888;
-}
-
-.cover-fill, .cover-empty {
-  display:inline-block;
-  height: 12px;
-}
-.chart {
-  line-height: 0;
-}
-.cover-empty {
-    background: white;
-}
-.cover-full {
-    border-right: none !important;
-}
-pre.prettyprint {
-    border: none !important;
-    padding: 0 !important;
-    margin: 0 !important;
-}
-.com { color: #999 !important; }
-.ignore-none { color: #999; font-weight: normal; }
-
-.wrapper {
-  min-height: 100%;
-  height: auto !important;
-  height: 100%;
-  margin: 0 auto -48px;
-}
-.footer, .push {
-  height: 48px;
-}