@vida-global/core 1.3.2 → 1.3.3

package/.github/workflows/npm-publish.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '24'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Update npm

package/.github/workflows/npm-test.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '24'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies

package/lib/server/server.js

@@ -106,40 +106,17 @@ class VidaServer {
 
     get loggingMiddleware() {
         return httpLogger({
-            logger: this.middlewareLogger,
-            customLogLevel: (res, err) => {
-                if (res.statusCode >= 500) return 'error';
-                if (res.statusCode >= 400) return 'warn';
-                return 'info';
-            },
-            serializers: {
-                // Format the request log as a string
-                req: (req) => `Request: ${req.method} ${req.url}`,
-                // Format the response log as a string
-                res: (res) => `statusCode=${res.statusCode}, responseTime=${res.get('X-Response-Time')}`,
-            },
-            wrapSerializers: false,
+            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,
         })
     }
 
 
-    get middlewareLogger() {
-      return pino({
-            level: process.env.HTTP_LOG_LEVEL || 'info',
-            transport: {
-                level: process.env.HTTP_LOG_LEVEL || 'info',
-                target: 'pino-pretty',
-                options: {
-                    colorize: true,
-                    ignore: 'pid,hostname',
-                    translateTime: 'SYS:standard',
-                    messageFormat: '{msg}',
-                }
-            },
-        });
-    }
-
-
     get staticFilesDirectory() {
         return `${process.cwd()}/static`;
     }
@@ -158,6 +135,53 @@ 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
     ***********************************************************************************************/
@@ -226,8 +250,9 @@ class VidaServer {
 
     requestHandler(action, controllerCls) {
         return async function(request, response) {
-            if (process.env.NODE_ENV != 'test') this.logger.info(`${controllerCls.name}#${action}`);
             const controllerInstance = this.buildController(controllerCls, request, response);
+            request.controller       = controllerInstance;
+            request.action           = action;
             await controllerInstance.performRequest(action);
         }.bind(this);
     }

package/lib/server/serverController.js

@@ -133,9 +133,14 @@ class VidaServerController {
             await this.renderErrors(err.message, err.fields);
 
         } else {
-            this.statusCode = 500;
-            await this.render({error: err.message});
-            if (process.env.NODE_ENV == 'development') console.log(err);
+            this._response.error = err;
+            let message;
+            if (typeof err == 'string') {
+                message = err;
+            } else {
+                message = err.message;
+            }
+            await this.renderServerErrorResponse(message);
         }
     }
 
@@ -148,7 +153,11 @@ class VidaServerController {
             this._response.send(body);
         } else {
             body = await this.processJSONBody(body, options);
-            body = this.formatJSONBody(body, options);
+
+            const  errors = body.errors || null;
+            delete body.errors;
+
+            body = this.formatJSONBody(body, errors, options);
             this._response.json(body);
         }
         this.#rendered = true;
@@ -177,27 +186,40 @@ class VidaServerController {
     }
 
 
+    async renderUnauthorizedResponse(message=null) {
+        return await this.#renderError(401, message);
+    }
+
+
+    async renderForbiddenResponse(message=null) {
+        return await this.#renderError(403, message);
+    }
+
+
     async renderNotFoundResponse(message=null) {
-        this.statusCode = 404;
-        await this.render({ message });
+        return await this.#renderError(404, message);
     }
 
 
-    async renderUnauthorizedResponse(message=null) {
-        this.statusCode = 401;
-        await this.render({ message });
+    async renderServerErrorResponse(message=null) {
+        return await this.#renderError(500, message);
     }
 
 
-    async renderForbiddenResponse(message=null) {
-        this.statusCode = 403;
-        await this.render({ message });
+    async #renderError(statusCode, message) {
+        this.statusCode = statusCode;
+        const body = {errors: {message: message || null}};
+        return await this.render(body);
     }
 
 
-    formatJSONBody(body, options) {
+    formatJSONBody(body, errors, options) {
         if (options.standardize === false) return body;
-        return {data: body, status: this.statusText};
+
+        const response = {data: body, status: this.statusText};
+        if (errors) response.errors = errors;
+
+        return response;
     }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vida-global/core",
-    "version": "1.3.2",
+    "version": "1.3.3",
     "description": "Core libraries for supporting Vida development",
     "author": "",
     "license": "ISC",
@@ -33,7 +33,7 @@
         "@vida-global/release": "^1.0.0"
     },
     "devDependencies": {
-        "jest": "^30.0.0",
+        "jest": "^29.0.0",
         "jest-express": "^1.12.0",
         "jest-extended": "^7.0.0",
         "@vida-global/test-helpers": "^1.0.1"

package/test/server/server.test.js

@@ -8,7 +8,7 @@ const { VidaServer }    = require('../../lib/server');
 
 
 jest.mock('express', () => {
-    const express      = require('jest-express');
+    const   express    = require('jest-express');
     const { Response } = require('jest-express/lib/response');
 
     // missing functions in mock express

package/test/server/serverController.test.js

@@ -8,7 +8,7 @@ const   TestHelpers            = require('@vida-global/test-helpers');
 const { VidaServerController } = require('../../lib/server');
 
 describe('VidaServerController', () => {
-    describe('VidaServerController.actionNames', () => {
+    describe('.actionNames', () => {
         it ('returns actions based on method names', () => {
             const names      = FooController.actionNames;
             const expected   = ['postIndex',
@@ -23,7 +23,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.autoLoadHelpers', () => {
+    describe('.autoLoadHelpers', () => {
         class AutoLoadTestController extends VidaServerController {
             static get autoLoadHelperPath() {
                 return `${process.cwd()}/test/server/helpers/autoload/${this.name}.js`;
@@ -60,7 +60,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController._constructAction', () => {
+    describe('._constructAction', () => {
         class UsersController extends VidaServerController {
             static get routes() {
                 return {getBazBan: '/baz/:id/ban'};
@@ -123,7 +123,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validateParameters', () => {
+    describe('.validateParameters', () => {
         const paramName1      = TestHelpers.Faker.Text.randomString();
         const paramName2      = TestHelpers.Faker.Text.randomString();
         const value1          = TestHelpers.Faker.Text.randomString();
@@ -217,7 +217,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validatePresence', () => {
+    describe('.validatePresence', () => {
         const controller = new FooController({}, {});
         it ('returns undefined when there is a value', () => {
             const result = controller.validatePresence(TestHelpers.Faker.Text.randomString());
@@ -231,7 +231,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validateIsInteger', () => {
+    describe('.validateIsInteger', () => {
         const controller = new FooController({}, {});
         it ('returns undefined when there is an integer', () => {
             const val    = Math.ceil(Math.random() * 100);
@@ -316,7 +316,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validateIsString', () => {
+    describe('.validateIsString', () => {
         const controller = new FooController({}, {});
         it ('returns undefined when there is an string', () => {
             const result = controller.validateIsString('')
@@ -396,7 +396,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validateIsDateTime', () => {
+    describe('.validateIsDateTime', () => {
         const controller = new FooController({}, {});
         it ('returns undefined when passed a string of format YYYY-MM-DD', () => {
             const result = controller.validateIsDateTime('2025-12-17');
@@ -435,7 +435,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validateIsEnum', () => {
+    describe('.validateIsEnum', () => {
         const controller = new FooController({}, {});
         const enums      = [Math.random(), Math.random(), Math.random()];
         const error      = TestHelpers.Faker.Text.randomString();
@@ -452,7 +452,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController.validateFunction', () => {
+    describe('.validateFunction', () => {
         const controller   = new FooController({}, {});
         const correctValue = Math.random();
         const error        = TestHelpers.Faker.Text.randomString();
@@ -470,7 +470,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('VidaServerController#performRequest', () => {
+    describe('#performRequest', () => {
         const errorHandlers = [
             ['renderUnauthorizedResponse', 'AuthorizationError'],
             ['renderForbiddenResponse',    'ForbiddenError'],
@@ -505,7 +505,7 @@ describe('VidaServerController', () => {
             await controller.performRequest('testAction');
 
             expect(controller.statusCode).toEqual(500);
-            expect(controller.render).toHaveBeenCalledWith({error: message});
+            expect(controller.render).toHaveBeenCalledWith({errors: { message }});
         });
     });
 
@@ -520,7 +520,7 @@ describe('VidaServerController', () => {
         });
 
         
-        describe('VidaServerController#renderErrors', () => {
+        describe('#renderErrors', () => {
             it ('returns a 400 response', async () => {
                 await controller.renderErrors();
                 expect(response.statusCode).toBe(400);
@@ -577,7 +577,7 @@ describe('VidaServerController', () => {
         });
 
         
-        describe('VidaServerController#renderUnauthorizedResponse', () => {
+        describe('#renderUnauthorizedResponse', () => {
             it ('returns a 401 response', async () => {
                 await controller.renderUnauthorizedResponse();
                 expect(response.statusCode).toBe(401);
@@ -586,19 +586,19 @@ describe('VidaServerController', () => {
             it ('includes a blank message by default', async () => {
                 await controller.renderUnauthorizedResponse();
                 expect(controller.render).toHaveBeenCalledTimes(1);
-                expect(controller.render).toHaveBeenCalledWith({message: null});
+                expect(controller.render).toHaveBeenCalledWith({errors: {message: null}});
             })
 
             it ('includes a provided message', async () => {
                 const msg = TestHelpers.Faker.Text.randomString();
                 await controller.renderUnauthorizedResponse(msg);
                 expect(controller.render).toHaveBeenCalledTimes(1);
-                expect(controller.render).toHaveBeenCalledWith({message: msg});
+                expect(controller.render).toHaveBeenCalledWith({errors: {message: msg}});
             });
         });
 
         
-        describe('VidaServerController#renderForbiddenResponse', () => {
+        describe('#renderForbiddenResponse', () => {
             it ('returns a 403 response', async () => {
                 await controller.renderForbiddenResponse();
                 expect(response.statusCode).toBe(403);
@@ -607,19 +607,19 @@ describe('VidaServerController', () => {
             it ('includes a blank message by default', async () => {
                 await controller.renderForbiddenResponse();
                 expect(controller.render).toHaveBeenCalledTimes(1);
-                expect(controller.render).toHaveBeenCalledWith({message: null});
+                expect(controller.render).toHaveBeenCalledWith({errors: {message: null}});
             })
 
             it ('includes a provided message', async () => {
                 const msg = TestHelpers.Faker.Text.randomString();
                 await controller.renderForbiddenResponse(msg);
                 expect(controller.render).toHaveBeenCalledTimes(1);
-                expect(controller.render).toHaveBeenCalledWith({message: msg});
+                expect(controller.render).toHaveBeenCalledWith({errors: {message: msg}});
             });
         });
 
 
-        describe('VidaServerController#renderNotFoundResponse', () => {
+        describe('#renderNotFoundResponse', () => {
             it ('returns a 404 response', async () => {
                 await controller.renderNotFoundResponse();
                 expect(response.statusCode).toBe(404);
@@ -628,14 +628,14 @@ describe('VidaServerController', () => {
             it ('includes a blank message by default', async () => {
                 await controller.renderNotFoundResponse();
                 expect(controller.render).toHaveBeenCalledTimes(1);
-                expect(controller.render).toHaveBeenCalledWith({message: null});
+                expect(controller.render).toHaveBeenCalledWith({errors: {message: null}});
             })
 
             it ('includes a provided message', async () => {
                 const msg = TestHelpers.Faker.Text.randomString();
                 await controller.renderNotFoundResponse(msg);
                 expect(controller.render).toHaveBeenCalledTimes(1);
-                expect(controller.render).toHaveBeenCalledWith({message: msg});
+                expect(controller.render).toHaveBeenCalledWith({errors: {message: msg}});
             });
         });
     });
@@ -653,7 +653,7 @@ describe('VidaServerController', () => {
             controller                      = new FooController(request, response);
         });
 
-        describe('VidaServerController#requestHeaders', () => {
+        describe('#requestHeaders', () => {
             it ('returns a copy of the request headers', () => {
                 expect(controller.requestHeaders).not.toBe(request.headers);
                 expect(JSON.stringify(controller.requestHeaders)).toEqual(JSON.stringify(request.headers));
@@ -661,28 +661,28 @@ describe('VidaServerController', () => {
         });
 
 
-        describe('VidaServerController#responseHeaders', () => {
+        describe('#responseHeaders', () => {
             it ('returns the request headers', () => {
                 expect(controller.responseHeaders).toBe(response.headers);
             });
         });
 
 
-        describe('VidaServerController#contentType', () => {
+        describe('#contentType', () => {
             it ('returns the content-type request header', () => {
                 expect(controller.contentType).toEqual(request.headers['content-type']);
             });
         });
 
 
-        describe('VidaServerController#logger', () => {
+        describe('#logger', () => {
             it ('uses the standard logger', () => {
                 expect(controller.logger).toBe(logger);
             });
         });
 
 
-        describe('VidaServerController#rendered', () => {
+        describe('#rendered', () => {
             it ('returns false if nothing has rendered', () => {
                 expect(controller.rendered).toBeFalsy();
             });
@@ -701,7 +701,7 @@ describe('VidaServerController', () => {
         });
 
 
-        describe('VidaServerController#statusCode', () => {
+        describe('#statusCode', () => {
             it ('returns the response status code', () => {
                 expect(controller.statusCode).toEqual(response.statusCode);
             });
@@ -715,7 +715,7 @@ describe('VidaServerController', () => {
     });
 
 
-    describe('ServerController#setupCallbacks', () => {
+    describe('#setupCallbacks', () => {
         it ('is only called once', () => {
             class CallbacksTestController extends VidaServerController {}
             CallbacksTestController.prototype.setupCallbacks = jest.fn();