@apolitical/server 2.5.0-rc.2 → 2.5.2-rc.1

package/CHANGELOG.md

@@ -5,9 +5,18 @@ 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.5.2] - 2022-06-08
+### Added
+- Probes prefix to support custom path
+
+## [2.5.1] - 2022-06-01
+### Added
+- Cache to `readinessCheck` and `livenessCheck` checks to avoid overload
+
 ## [2.5.0] - 2022-05-06
 ### Added
-- Custom `livenessCheck` to define liveness externally
+- Custom `readinessCheck` and `livenessCheck` to define probes externally
+- New probe `/health` endpoint to combine readiness and liveness
 
 ## [2.4.2] - 2022-03-03
 ### Bumped

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "2.5.0-rc.2",
+  "version": "2.5.2-rc.1",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
@@ -31,28 +31,29 @@
     "compression": "1.7.4",
     "cookie-parser": "1.4.6",
     "cors": "2.8.5",
-    "dotenv": "16.0.0",
+    "dotenv": "16.0.1",
     "express": "4.18.1",
-    "express-jwt": "7.7.0",
+    "express-jwt": "7.7.5",
     "http-status-codes": "2.2.0",
     "http-terminator": "3.2.0",
-    "jsrsasign": "10.5.20",
-    "jwks-rsa": "2.1.1",
+    "jsrsasign": "10.5.23",
+    "jwks-rsa": "2.1.3",
     "jwt-decode": "3.1.2",
+    "lru-cache": "7.10.1",
     "morgan": "1.10.0",
-    "passport": "0.5.2",
+    "passport": "0.6.0",
     "passport-jwt": "4.0.0",
     "prerender-node": "3.5.0",
-    "swagger-ui-express": "4.3.0"
+    "swagger-ui-express": "4.4.0"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "2.0.0",
+    "@apolitical/eslint-config": "2.0.1",
     "@apolitical/testing": "1.0.2",
-    "audit-ci": "6.2.0",
-    "husky": "8.0.0",
+    "audit-ci": "6.3.0",
+    "husky": "8.0.1",
     "jest": "28.1.0",
     "jest-junit": "13.2.0",
-    "lint-staged": "12.4.1",
+    "lint-staged": "13.0.0",
     "mock-jwks": "1.0.3",
     "nock": "13.2.4"
   },

package/src/config.js

@@ -49,6 +49,20 @@ module.exports = {
         USER_SLUG: 'user-slug',
       },
     },
+    CACHE_OPTIONS: {
+      max: 2, // Only liveness and readiness
+      ttl: 60 * 1000, // One minute
+    },
+    PROBES_OPTIONS: {
+      API: {
+        ALLOWED_PREFIXES: ['api'],
+        PREFIX_PATH: '/api',
+      },
+      UI: {
+        ALLOWED_PREFIXES: ['ui', 'pages'],
+        PREFIX_PATH: '/ui',
+      },
+    },
   },
   JWT: {
     APOLITICAL: {

package/src/container.js

@@ -14,6 +14,7 @@ const httpTerminator = require('http-terminator');
 const jwksRsa = require('jwks-rsa');
 const jsrsasign = require('jsrsasign');
 const jwtDecode = require('jwt-decode');
+const lru = require('lru-cache');
 const morgan = require('morgan');
 const passport = require('passport');
 const passportJwt = require('passport-jwt');
@@ -67,6 +68,7 @@ container.register({
   jwksRsa: asValue(jwksRsa),
   jsrsasign: asValue(jsrsasign),
   jwtDecode: asValue(jwtDecode),
+  lru: asValue(lru),
   morgan: asValue(morgan),
   passport: asValue(passport),
   passportJwt: asValue(passportJwt),

package/src/loaders/probes.loader.js

@@ -2,21 +2,41 @@
 
 module.exports = ({ config, logger, healthService }) => {
   const { HEALTH, LIVENESS, READINESS } = config.ENDPOINTS.PROBES;
+  const { API, UI } = config.SERVER.PROBES_OPTIONS;
 
-  return function load(app, { readinessCheck, livenessCheck }) {
+  function buildPrefix({ prefix }) {
+    let result = '';
+    if (prefix) {
+      if (API.ALLOWED_PREFIXES.some((allowedPrefix) => prefix.includes(allowedPrefix))) {
+        result = `${API.PREFIX_PATH}/${prefix}`;
+      } else if (UI.ALLOWED_PREFIXES.some((allowedPrefix) => prefix.includes(allowedPrefix))) {
+        result = `${UI.PREFIX_PATH}/${prefix}`;
+      } else {
+        result = prefix;
+      }
+    }
+    return result;
+  }
+
+  return function load(app, { probes }) {
     const childLogger = logger.where(__filename, 'load');
     childLogger.debug('Started');
-    // Overwrite checks when defined
-    if (readinessCheck) {
-      healthService.registerReadiness(readinessCheck);
-    }
-    if (livenessCheck) {
-      healthService.registerLiveness(livenessCheck);
+    if (probes) {
+      const { readinessCheck, livenessCheck } = probes;
+      // Overwrite checks when defined
+      if (readinessCheck) {
+        healthService.registerReadiness(readinessCheck);
+      }
+      if (livenessCheck) {
+        healthService.registerLiveness(livenessCheck);
+      }
+      // Build base URL
+      const probesPath = buildPrefix(probes);
+      // Load probes endpoints
+      app.get(`${probesPath}${HEALTH}`, healthService.healthEndpoint());
+      app.get(`${probesPath}${READINESS}`, healthService.readinessEndpoint());
+      app.get(`${probesPath}${LIVENESS}`, healthService.livenessEndpoint());
     }
-    // Load probes endpoints
-    app.get(HEALTH, healthService.healthEndpoint());
-    app.get(READINESS, healthService.readinessEndpoint());
-    app.get(LIVENESS, healthService.livenessEndpoint());
     childLogger.debug('Finished');
   };
 };

package/src/services/health.service.js

@@ -1,8 +1,22 @@
 'use strict';
 
-module.exports = ({ health }) => {
+module.exports = ({ health, lru, config }) => {
+  const { CACHE_OPTIONS } = config.SERVER;
   // Setup health checker
   const healthCheck = new health.HealthChecker();
+  // Setup cache
+  const cache = new lru(CACHE_OPTIONS);
+
+  function buildCheckWithCache(key, check) {
+    cache.clear();
+    return async function () {
+      const checked = cache.get(key);
+      if (!checked) {
+        await check();
+        cache.set(key, true);
+      }
+    };
+  }
 
   // function registerStartup(startup) {
   //   healthCheck.registerStartupCheck(new health.StartupCheck("Startup Check", startup));
@@ -13,7 +27,8 @@ module.exports = ({ health }) => {
   }
 
   function registerReadiness(readiness) {
-    healthCheck.registerReadinessCheck(new health.ReadinessCheck('Readiness Check', readiness));
+    const readinessWithCache = buildCheckWithCache('readiness', readiness);
+    healthCheck.registerReadinessCheck(new health.ReadinessCheck('Readiness Check', readinessWithCache));
   }
 
   function readinessEndpoint() {
@@ -21,7 +36,8 @@ module.exports = ({ health }) => {
   }
 
   function registerLiveness(liveness) {
-    healthCheck.registerLivenessCheck(new health.LivenessCheck('Liveness Check', liveness));
+    const livenessWithCache = buildCheckWithCache('liveness', liveness);
+    healthCheck.registerLivenessCheck(new health.LivenessCheck('Liveness Check', livenessWithCache));
   }
 
   function livenessEndpoint() {