@apolitical/server 2.5.1 → 2.5.2-rc.1

package/CHANGELOG.md

@@ -5,6 +5,10 @@ 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "2.5.1",
+  "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",

package/src/config.js

@@ -53,6 +53,16 @@ module.exports = {
       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/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');
   };
 };