@apolitical/server 2.8.2 → 2.9.0-rc.1

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.9.0] - 2023-01-10
+### Changed
+- Bump dependencies to keep the project up-to-date
+### Removed
+- Unnecessary use of `.debug` logs
+
 ## [2.8.2] - 2022-11-17
 ### Removed
 - ETag header on static files to avoid cache mismatching

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "2.8.2",
+  "version": "2.9.0-rc.1",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
@@ -24,39 +24,37 @@
     "Node Modules"
   ],
   "dependencies": {
-    "@apolitical/logger": "2.0.1",
+    "@apolitical/logger": "2.1.0",
     "@cloudnative/health-connect": "2.1.0",
-    "awilix": "7.0.3",
-    "body-parser": "1.20.0",
+    "awilix": "8.0.0",
+    "body-parser": "1.20.1",
     "compression": "1.7.4",
     "cookie-parser": "1.4.6",
     "cors": "2.8.5",
-    "dotenv": "16.0.1",
-    "express": "4.18.1",
-    "express-jwt": "7.7.5",
+    "dotenv": "16.0.3",
+    "express": "4.18.2",
+    "express-jwt": "8.3.0",
     "http-status-codes": "2.2.0",
     "http-terminator": "3.2.0",
-    "jsrsasign": "10.5.23",
-    "jwks-rsa": "2.1.3",
+    "jsrsasign": "10.6.1",
+    "jwks-rsa": "3.0.0",
     "jwt-decode": "3.1.2",
-    "lru-cache": "7.10.1",
+    "lru-cache": "7.14.1",
     "morgan": "1.10.0",
     "passport": "0.6.0",
-    "passport-jwt": "4.0.0",
+    "passport-jwt": "4.0.1",
     "prerender-node": "3.5.0",
     "qs": "6.11.0",
-    "swagger-ui-express": "4.4.0"
+    "swagger-ui-express": "4.6.0"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "2.0.1",
-    "@apolitical/testing": "1.0.2",
-    "audit-ci": "6.3.0",
-    "husky": "8.0.1",
-    "jest": "28.1.0",
-    "jest-junit": "13.2.0",
-    "lint-staged": "13.0.0",
-    "mock-jwks": "1.0.3",
-    "nock": "13.2.4"
+    "@apolitical/eslint-config": "2.1.0",
+    "@apolitical/testing": "2.1.0-rc.1",
+    "audit-ci": "6.6.0",
+    "husky": "8.0.3",
+    "lint-staged": "13.1.0",
+    "mock-jwks": "1.0.9",
+    "nock": "13.2.9"
   },
   "engines": {
     "node": ">=16.13.0"

package/src/helpers/jwt/passport.helper.js

@@ -1,35 +1,25 @@
 'use strict';
 
-module.exports = ({ passport, passportJwt, logger, config }) => {
+module.exports = ({ passport, passportJwt, config }) => {
   const { COOKIE_KEY } = config.JWT.APOLITICAL;
 
   const jwtOptions = {
     jwtFromRequest(req) {
-      const childLogger = logger.where(__filename, 'jwtFromRequest');
-      childLogger.debug('Started');
       let result = null;
       if (req && req.cookies && req.cookies[COOKIE_KEY]) {
         result = req.cookies[COOKIE_KEY];
-      } else {
-        childLogger.debug('Cannot find Apolitical token (cookie)');
       }
-      childLogger.debug('Finished');
       return result;
     },
   };
 
   function jwtCallback(jwtPayload, done) {
-    const childLogger = logger.where(__filename, 'jwtCallback');
-    childLogger.debug('Started');
     if (jwtPayload.sub !== 'login') {
-      childLogger.debug(`Invalid JWT: incorrect sub ${jwtPayload}`);
       return done(null, false, { message: jwtPayload });
     }
     if (!jwtPayload.slug) {
-      childLogger.debug(`Invalid JWT: missing slug ${jwtPayload}`);
       return done(null, false, { message: jwtPayload });
     }
-    childLogger.debug(`User ${jwtPayload.slug} has a valid JWT`);
     return done(null, jwtPayload);
   }
 

package/src/helpers/logger.helper.js

@@ -22,12 +22,9 @@ module.exports = ({ morgan, config, logger }) => {
   }
 
   function buildMiddleware(labels) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
     // Setup Morgan with custom format and Apolitical Logger stream
     morgan.token(USER_SLUG, getUserSlug);
     const morganMiddleware = morgan(buildCustomFormat, logger.where(__filename, 'morganMiddleware', labels));
-    childLogger.debug('Finished');
     return morganMiddleware;
   }
 

package/src/loaders/documentation.loader.js

@@ -3,15 +3,12 @@
 module.exports = ({
   httpStatusCodes: { MOVED_PERMANENTLY },
   config,
-  logger,
   swaggerUi: { serve, setup },
   authorisationMiddleware,
 }) => {
   const { DOCUMENTATION } = config.ENDPOINTS;
 
   return function load(app, { swaggerDocument }) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
     // Load document endpoint
     if (swaggerDocument) {
       // Redirection to documentation
@@ -19,6 +16,5 @@ module.exports = ({
       // Documentation express setup
       app.use(DOCUMENTATION, authorisationMiddleware(), serve, setup(swaggerDocument));
     }
-    childLogger.debug('Finished');
   };
 };

package/src/loaders/express.loader.js

@@ -1,7 +1,6 @@
 'use strict';
 
 module.exports = ({
-  logger,
   documentationLoader,
   loggerLoader,
   errorMiddleware,
@@ -11,8 +10,6 @@ module.exports = ({
 }) => {
   // Main (express) loader
   return async function load(app, opts) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
     // Enable strict routing (treat "/foo" and "/foo/" as different)
     if (opts.strictRouting) {
       app.enable('strict routing');
@@ -35,6 +32,5 @@ module.exports = ({
     if (opts.handleErrors) {
       app.use(errorMiddleware(opts));
     }
-    childLogger.debug('Finished');
   };
 };

package/src/loaders/fallback.loader.js

@@ -1,10 +1,7 @@
 'use strict';
 
-module.exports = ({ logger }) => {
+module.exports = () => {
   return function load(app, { fallbackController, staticFiles }) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
-
     if (staticFiles) {
       const { baseUrl, indexFilePath } = staticFiles;
       // Load fallback or static content
@@ -16,6 +13,5 @@ module.exports = ({ logger }) => {
         });
       }
     }
-    childLogger.debug('Finished');
   };
 };

package/src/loaders/logger.loader.js

@@ -2,8 +2,6 @@
 
 module.exports = ({ apoliticalLogger, config, logger, loggerHelper }) => {
   return async function load(app, { labels }) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
     if (config.NODE_ENV === 'production') {
       // Setup Google Cloud with Apolitical Logger
       const winstonMiddleware = await apoliticalLogger.loggerMiddleware(
@@ -15,6 +13,5 @@ module.exports = ({ apoliticalLogger, config, logger, loggerHelper }) => {
       const morganMiddleware = loggerHelper.buildMiddleware(labels);
       app.use(morganMiddleware);
     }
-    childLogger.debug('Finished');
   };
 };

package/src/loaders/middlewares.loader.js

@@ -8,7 +8,6 @@ module.exports = ({
   cookieParser,
   prerender,
   config,
-  logger,
 }) => {
   const {
     BODY_PARSER_OPTIONS: { JSON_OPTIONS, URL_ENCODED_OPTIONS },
@@ -17,8 +16,6 @@ module.exports = ({
   } = config.SERVER;
 
   return function load(app, { corsOptions, prerenderToken, staticFiles }) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
     // Load useful middlewares
     app.use(cookieParser());
     app.use(json(JSON_OPTIONS));
@@ -45,6 +42,5 @@ module.exports = ({
         ),
       );
     }
-    childLogger.debug('Finished');
   };
 };

package/src/loaders/probes.loader.js

@@ -1,6 +1,6 @@
 'use strict';
 
-module.exports = ({ config, logger, healthService }) => {
+module.exports = ({ config, healthService }) => {
   const { HEALTH, LIVENESS, READINESS } = config.ENDPOINTS.PROBES;
   const { API, UI } = config.SERVER.PROBES_OPTIONS;
 
@@ -19,8 +19,6 @@ module.exports = ({ config, logger, healthService }) => {
   }
 
   return function load(app, { probes }) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
     if (probes) {
       const { readinessCheck, livenessCheck } = probes;
       // Overwrite checks when defined
@@ -37,6 +35,5 @@ module.exports = ({ config, logger, healthService }) => {
       app.get(`${probesPath}${READINESS}`, healthService.readinessEndpoint());
       app.get(`${probesPath}${LIVENESS}`, healthService.livenessEndpoint());
     }
-    childLogger.debug('Finished');
   };
 };

package/src/middlewares/authentication.middleware.js

@@ -1,13 +1,11 @@
 'use strict';
 
-module.exports = ({ jwtApoliticalMiddleware, logger, serverError: { Forbidden }, config }) => {
+module.exports = ({ jwtApoliticalMiddleware, serverError: { Forbidden }, config }) => {
   const { COOKIE_KEY } = config.JWT.APOLITICAL;
   // Define external options
   return ({ allowLoggedOut = false } = {}) => {
     // Return middleware handler
     return async function handler(req, res, next) {
-      const childLogger = logger.where(__filename, 'handler');
-      childLogger.debug('Started');
       // Verifies Apolitical JWT token
       const user = await jwtApoliticalMiddleware(req, res);
       // If logged out users are not allowed and there is no user object throws forbidden error
@@ -18,7 +16,6 @@ module.exports = ({ jwtApoliticalMiddleware, logger, serverError: { Forbidden },
       Object.assign(req, { user });
       // Assigns auth token to the request object
       Object.assign(req, { authToken: req.cookies[COOKIE_KEY] });
-      childLogger.debug('Finished');
       return next();
     };
   };

package/src/middlewares/authorisation.middleware.js

@@ -1,13 +1,11 @@
 'use strict';
 
-module.exports = ({ logger, serverError: { Forbidden }, config }) => {
+module.exports = ({ serverError: { Forbidden }, config }) => {
   const { ADMIN_ROLE, MYSELF_SLUG } = config.MIDDLEWARES.PERMISSIONS;
   // Define external options
   return ({ myselfSource = null, myselfTarget = null, allowNonAdmin = false } = {}) => {
     // Return middleware handler
     return function handler(req, res, next) {
-      const childLogger = logger.where(__filename, 'handler');
-      childLogger.debug('Started');
       let isNotAdmin = false;
       let isNotMyselfSlug = false;
       // Check user role (from JWT)
@@ -34,7 +32,6 @@ module.exports = ({ logger, serverError: { Forbidden }, config }) => {
       if (myselfSource && myselfTarget && req.params[myselfSource] === MYSELF_SLUG) {
         Object.assign(req.params, { [myselfSource]: req.user[myselfTarget] });
       }
-      childLogger.debug('Finished');
       return next();
     };
   };

package/src/middlewares/error.middleware.js

@@ -13,8 +13,6 @@ module.exports =
   ({ labels, redirectURL, fallbackController }) => {
     // eslint-disable-next-line no-unused-vars
     return function handler(err, req, res, next) {
-      const childLogger = logger.where(__filename, 'handler');
-      childLogger.debug('Started');
       // Initialise variables
       let code = INTERNAL_SERVER_ERROR;
       let message = 'Unexpected error';

package/src/middlewares/jwt/apolitical.middleware.js

@@ -1,17 +1,13 @@
 'use strict';
 
-module.exports = ({ passport, config, logger }) => {
+module.exports = ({ passport, config }) => {
   const { NAME, SESSION } = config.JWT.APOLITICAL;
 
   return function handler(req, res) {
-    const childLogger = logger.where(__filename, 'handler');
-    childLogger.debug('Started');
-
     // Passport JWT authentication (Apolitical)
     return new Promise((resolve) => {
       passport.authenticate(NAME, SESSION, (err, user) => {
         if (err) {
-          childLogger.warn('Cannot parse token from cookie', err.message);
           return resolve();
         }
         return resolve(user);

package/src/services/express.service.js

@@ -5,43 +5,34 @@ module.exports = ({ express, httpTerminator, logger, expressLoader }) => {
   let terminator = null; // I need your clothes, your boots and your motorcycle
 
   function expressRunner(app, port) {
-    const childLogger = logger.where(__filename, 'expressRunner');
-    childLogger.debug('Started');
     return new Promise((resolve, reject) => {
       if (!port) {
-        childLogger.warn('Missing port option');
         return reject(new Error('Cannot start server without port option'));
       }
       const server = app.listen(port, () => {
-        childLogger.info(`Server listening on ${port}`);
+        const runnerLogger = logger.where(__filename, 'expressRunner');
+        runnerLogger.info(`Server listening on ${port}`);
         return resolve();
       });
       terminator = httpTerminator.createHttpTerminator({ server });
-      childLogger.debug('Finished');
     });
   }
 
   async function startup(opts) {
-    const childLogger = logger.where(__filename, 'startup');
-    childLogger.debug('Started');
     // Create, load and run the express app
     if (!app) {
       app = express();
       await expressLoader(app, opts);
       await expressRunner(app, opts.port);
     }
-    childLogger.debug('Finished');
     return app;
   }
 
   async function shutdown() {
-    const childLogger = logger.where(__filename, 'shutdown');
-    childLogger.debug('Started');
     // Terminate process and clean-up variables
     await terminator.terminate();
     app = null;
     terminator = null;
-    childLogger.debug('Finished');
   }
 
   return { startup, shutdown };