@vida-global/core 1.4.5 → 2.0.0

package/lib/redis/redisClient.js

@@ -3,40 +3,48 @@ const { logger } = require('../logger');
 const   redis    = require('redis');
 
 
-let redisSingleton;
+const CERT_LOCATION = process.env.REDIS_CERT_LOCATION || `${process.cwd()}/redis_ca.pem`;
+const clients       = {};
+logger.addScope('redis');
 
 
-async function initRedisClientSingleton() {
-    if (redisSingleton) return;
+function redisClientFactory({ host, port, password, subscriber=false } = {}) {
+    host      = host || process.env.REDIS_HOST;
+    port      = parseInt(port || process.env.REDIS_PORT);
+    password  = password || process.env.REDIS_PASSWORD
+    const key = `${host}:${port}:${Boolean(subscriber)}`;
 
-    const certLocation = process.env.REDIS_CERT_LOCATION || `${process.cwd()}/redis_ca.pem`;
-    const cert         = fs.readFileSync(certLocation)
+    if (clients[key]) return clients[key];
 
-    redisSingleton = redis.createClient({
-        socket: {
-            host: process.env.REDIS_HOST,
-            port: parseInt(process.env.REDIS_PORT),
-            tls:  true,
-            ca:   [cert]
-        },
-        password: process.env.REDIS_PASSWORD
-    });
+    const client = createClient(host, port, password);
+    clients[key] = client;
+
+    configureClient(client)
+    return client;
+}
 
-    redisSingleton.on('ready', (err) => {
-        logger.info('Redis Client Connected');
+
+function createClient(host, port, password) {
+    const ca     = fs.readFileSync(CERT_LOCATION)
+    const socket = { host, port, ca, tls:  true, };
+    return redis.createClient({ socket, password });
+}
+
+
+function configureClient(client) {
+    client.on('ready', (err) => {
+        logger.redis.info('Connected');
     });
-    redisSingleton .on('error', (err) => {
+    client.on('error', (err) => {
         const errno = err.errno ? ` (${err.errno})` : '';
-        logger.error(`Redis: ${err.message}${errno}`);
+        logger.redis.error(`${err.message}${errno}`);
     });
 
-    await redisSingleton.connect();
-}
-
 
-async function redisClientFactory() {
-    await initRedisClientSingleton();
-    return redisSingleton;
+    const connect = client.connect.bind(client);
+    client.connect = async function() {
+        if (!this.isReady) await connect();
+    }
 }
 
 

package/lib/server/controllerImporter.js

@@ -1,61 +1,23 @@
-const   fs                     = require('fs');
+const { AbstractAutoImporter } = require('../utils/abstractAutoImporter');
 const { VidaServerController } = require('./serverController');
 
 
-class ControllerImporter {
-    #controllerDirectories;
-    #controllerClasses;
-
-
-    constructor(controllerDirectories) {
-        if (!Array.isArray(controllerDirectories)) {
-            controllerDirectories = [controllerDirectories];
-        }
-        this.#controllerDirectories = controllerDirectories;
-    }
-
-
+class ControllerImporter extends AbstractAutoImporter {
     get controllerClasses() {
-        if (!this.#controllerClasses) {
-            this.#importControllerClasses();
-        }
-        return this.#controllerClasses;
+        return this.imports;
     }
 
 
-    #importControllerClasses() {
-        this.#controllerClasses = [];
-        this.#controllerDirectories.forEach(dir => {
-            this.#importDirectory(dir, dir);
-        });
+    shouldImport(obj) {
+        return obj.prototype instanceof VidaServerController;
     }
 
 
-    #importDirectory(dir, topLevelDirectory) {
-        fs.readdirSync(dir).forEach((f => {
-            const filePath = `${dir}/${f}`;
-            if (fs.lstatSync(filePath).isDirectory()) {
-                this.#importDirectory(filePath, topLevelDirectory);
-            } else if (f.endsWith('.js')) {
-                this.#importFromFile(filePath, dir, topLevelDirectory);
-            }
-        }).bind(this));
+    processImport(obj, directoryPrefix) {
+        obj.directoryPrefix = directoryPrefix;
+        obj.autoLoadHelpers();
+        obj.autoLoadDocumentation();
     }
-
-
-    #importFromFile(filePath, dir, topLevelDirectory) {
-        const exports = Object.values(require(filePath));
-        exports.forEach(_export => {
-            if (_export.prototype instanceof VidaServerController) {
-                const directoryPrefix   = dir.replace(topLevelDirectory, '');
-                _export.directoryPrefix = directoryPrefix;
-                _export.autoLoadHelpers();
-                _export.autoLoadDocumentation();
-                this.#controllerClasses.push(_export);
-            }
-        });
-    }
-
 }
 
 

package/lib/server/server.js

@@ -1,13 +1,17 @@
+const   APM                    = require('../apm');
 const { ControllerImporter }   = require('./controllerImporter');
 const   express                = require('express');
-const   httpLogger             = require('pino-http')
 const { logger }               = require('../logger');
+const   loggingMiddleware      = require('../logger/serverMiddleware');
 const   mustacheExpress        = require('mustache-express');
-const { pino }                 = require('pino');
 const   responseTime           = require('response-time');
 const   IoServer               = require("socket.io")
 const { Server }               = require('http');
 const { SystemController }     = require('./systemController');
+const   requestID              = require( 'express-request-id');
+
+
+logger.addScope('server');
 
 
 class VidaServer {
@@ -31,7 +35,7 @@ class VidaServer {
         await this.registerControllers();
 
         this.#httpServer.listen(this.#port, this.#host, () => {
-            this.logger.info(`Server is running on port ${this.#port}`);
+            this.logger.info(`${this.constructor.name} running on port ${this.#port}`);
             if (callback) callback();
         });
     }
@@ -39,7 +43,7 @@ class VidaServer {
 
     get host()   { return this.#host; }
     get port()   { return this.#port; }
-    get logger() { return logger; }
+    get logger() { return logger.server; }
 
 
     /***********************************************************************************************
@@ -72,11 +76,12 @@ class VidaServer {
     setupMiddleware() {
         this.use(this.jsonParsingMiddleware);
         this.use(this.octetStreamParsingMiddleware);
-        this.use(responseTime())
+        this.use(responseTime({suffix: true}))
         this.use(express.static('public'))
         this.use(this.loggingMiddleware);
         this.use('/static', express.static(this.staticFilesDirectory));
         this.use(this.connectionAbortedMiddleware);
+        this.use(requestID());
 
         this.#expressServer.engine('html', mustacheExpress());
     }
@@ -105,15 +110,7 @@ class VidaServer {
 
 
     get loggingMiddleware() {
-        return httpLogger({
-            logger:               this.middlewareLogger,
-            customLogLevel:       this.requestLogLevel.bind(this),
-            customSuccessMessage: this.requestLogMessage.bind(this),
-            customErrorMessage:   this.requestLogMessage.bind(this),
-            customErrorObject:    this.requestLogDetails.bind(this),
-            customSuccessObject:  this.requestLogDetails.bind(this),
-            wrapSerializers:      false,
-        })
+        return loggingMiddleware.middleware(this.logger);
     }
 
 
@@ -123,7 +120,7 @@ class VidaServer {
 
 
     get connectionAbortedMiddleware() {
-        return async function (err, req, res, next) {
+        return async function connectionAborted(err, req, res, next) {
             if (err && err.code === 'ECONNABORTED') {
                 return res.status(400).end(); // Don't process this error any further to avoid its logging
             }
@@ -135,53 +132,6 @@ class VidaServer {
     use() { this.#expressServer.use(...arguments); }
 
 
-    /***********************************************************************************************
-    * LOGGING
-    ***********************************************************************************************/
-    requestLogDetails(req, res, err) {
-        const details = {
-            req: `${req.method} ${req.url}`,
-            res: `statusCode=${res.statusCode}, responseTime=${res.get('X-Response-Time')}`,
-        };
-
-        if (res.statusCode >= 500 && res.error) {
-            details.error = this.requestLogErrorDetails(req, res, res.error);
-        }
-
-        return details;
-    }
-
-
-    requestLogErrorDetails(req, res, err) {
-        if (typeof err == 'string') return {message: err};
-        return {
-            type: err.constructor.name,
-            message: err.message,
-            stack: err.stack
-        }
-    }
-
-    
-    requestLogMessage(req, res) {
-        const prefix = '[VidaServer]';
-        if (req.controller) {
-            return `${prefix} ${req.controller.constructor.name}#${req.action}`;
-        }
-
-        return `${prefix} ${res.status >= 500 ? 'request errored' : 'request completed'}`;
-    }
-
-
-    requestLogLevel(req, res) {
-        return 'debug';
-    }
-
-
-    get middlewareLogger() {
-        return logger;
-    }
-
-
     /***********************************************************************************************
     * SETTINGS
     ***********************************************************************************************/
@@ -234,7 +184,7 @@ class VidaServer {
         const method         = action.method.toLowerCase();
         const requestHandler = this.requestHandler(action.action, controllerCls)
         if (process.env.NODE_ENV != 'test') {
-            logger.info(`ROUTE: ${method.toUpperCase().padEnd(6)} ${action.path}`);
+            this.logger.verbose(`ROUTE: ${method.toUpperCase().padEnd(6)} ${action.path}`);
         }
         this['_'+method](action.path, requestHandler);
     }
@@ -249,24 +199,29 @@ class VidaServer {
 
 
     requestHandler(action, controllerCls) {
-        return async function(request, response) {
-            const controllerInstance = this.buildController(controllerCls, request, response);
-            request.controller       = controllerInstance;
-            request.action           = action;
-            await controllerInstance.performRequest(action);
-        }.bind(this);
+      // Implemented with this object access for APM segment tracking
+      const server  = this;
+      const handler = {
+          async requestHandler(request, response) {
+              const controllerInstance = server.buildController(controllerCls, request, response);
+              request.controller       = controllerInstance;
+              request.action           = action;
+              await controllerInstance.performRequest(action);
+          }
+      }.requestHandler;
+      return handler;
     }
 
 
     buildController(controllerCls, request, response) {
-        return new controllerCls(request, response);
+        return new controllerCls(request, response, this.logger);
     }
 
 
     get controllerClasses() {
         if (!this.#controllerClasses) {
             const controllerImporter = new ControllerImporter(this.controllerDirectories);
-            this.#controllerClasses  = controllerImporter.controllerClasses;
+            this.#controllerClasses  = controllerImporter.controllerClasses.filter(cls => !cls.name.startsWith('Abstract'));
         }
 
         return this.#controllerClasses;
@@ -290,6 +245,14 @@ class VidaServer {
     }
 
 
+    /***********************************************************************************************
+    * APM
+    ***********************************************************************************************/
+    startApmSegment(name, record, handler) {
+        APM.startSegment(name, record, handler);
+    }
+
+
     /***********************************************************************************************
     * DEPRECATED PASS THROUGH METHODS
     ***********************************************************************************************/