@apolitical/server 2.2.0 → 2.3.1

package/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.3.1] - 2022-02-15
+### Changed
+- Body parser types
+
+## [2.3.0] - 2022-02-14
+### Added
+- fallbackController
+
 ## [2.2.0] - 2022-02-07
 ### Changed
 - Pipeline uses `Node-Publish` template

package/package.json

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

@@ -35,7 +35,12 @@ module.exports = {
       credentials: true,
     },
     BODY_PARSER_OPTIONS: {
-      extended: false,
+      JSON_OPTIONS: {
+        type: ['application/json', 'application/csp-report', 'application/reports+json'],
+      },
+      URL_ENCODED_OPTIONS: {
+        extended: false,
+      },
     },
     MORGAN_OPTIONS: {
       LOGGED_OUT_SLUG: 'logged-out',

package/src/container.js

@@ -36,7 +36,7 @@ const documentationLoader = require('./loaders/documentation.loader');
 const loggerLoader = require('./loaders/logger.loader');
 const middlewaresLoader = require('./loaders/middlewares.loader');
 const probesLoader = require('./loaders/probes.loader');
-const staticLoader = require('./loaders/static.loader');
+const fallbackLoader = require('./loaders/fallback.loader');
 // Middleware
 const authenticationMiddleware = require('./middlewares/authentication.middleware');
 const authorisationMiddleware = require('./middlewares/authorisation.middleware');
@@ -85,7 +85,7 @@ container.register({
   loggerLoader: asFunction(loggerLoader).singleton(),
   middlewaresLoader: asFunction(middlewaresLoader).singleton(),
   probesLoader: asFunction(probesLoader).singleton(),
-  staticLoader: asFunction(staticLoader).singleton(),
+  fallbackLoader: asFunction(fallbackLoader).singleton(),
   // Middlewares
   authenticationMiddleware: asFunction(authenticationMiddleware).singleton(),
   authorisationMiddleware: asFunction(authorisationMiddleware).singleton(),

package/src/loaders/fallback.loader.js

@@ -0,0 +1,21 @@
+'use strict';
+
+module.exports = ({ logger }) => {
+  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
+      if (fallbackController) {
+        app.get(`${baseUrl}*`, fallbackController);
+      } else if (indexFilePath) {
+        app.get(`${baseUrl}*`, function (req, res) {
+          res.sendFile(indexFilePath);
+        });
+      }
+    }
+    childLogger.debug('Finished');
+  };
+};

package/src/loaders/middlewares.loader.js

@@ -1,20 +1,36 @@
 'use strict';
 
-module.exports = ({ bodyParser: { json, urlencoded }, compression, cors, cookieParser, prerender, config, logger }) => {
-  const { BODY_PARSER_OPTIONS, CORS_OPTIONS } = config.SERVER;
+module.exports = ({
+  bodyParser: { json, urlencoded },
+  express,
+  compression,
+  cors,
+  cookieParser,
+  prerender,
+  config,
+  logger,
+}) => {
+  const {
+    BODY_PARSER_OPTIONS: { JSON_OPTIONS, URL_ENCODED_OPTIONS },
+    CORS_OPTIONS,
+  } = config.SERVER;
 
-  return function load(app, { corsOptions, prerenderToken }) {
+  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());
-    app.use(urlencoded(BODY_PARSER_OPTIONS));
+    app.use(json(JSON_OPTIONS));
+    app.use(urlencoded(URL_ENCODED_OPTIONS));
     app.use(cors(Object.assign({}, CORS_OPTIONS, corsOptions)));
     app.use(compression());
     if (prerenderToken) {
       app.use(prerender.set('prerenderToken', prerenderToken));
     }
+    if (staticFiles) {
+      const { baseUrl, folderPath } = staticFiles;
+      app.use(baseUrl, express.static(folderPath));
+    }
     childLogger.debug('Finished');
   };
 };

package/src/middlewares/error.middleware.js

@@ -9,7 +9,7 @@ module.exports =
     logger,
     serverError: { GeneralError },
   }) =>
-  ({ labels, redirectURL }) => {
+  ({ labels, redirectURL, fallbackController }) => {
     // Apolitical Logger (with service metadata)
     const errorLogger = logger.where(__filename, 'errorMiddleware', labels);
 
@@ -43,10 +43,16 @@ module.exports =
       } else {
         errorLogger.warn(message, { errors });
       }
+
       if (redirectURL) {
-        res.redirect(TEMPORARY_REDIRECT, `${redirectURL}?errorMessage=${encodeURI(message)}`);
-      } else {
-        res.status(code).json({ message, errors });
+        return res.redirect(TEMPORARY_REDIRECT, `${redirectURL}?errorMessage=${encodeURI(message)}`);
+      }
+      if (fallbackController) {
+        // more known error messages can be added here
+        if (message === 'Unexpected error: Cannot read items') {
+          return fallbackController(req, res);
+        }
       }
+      return res.status(code).json({ message, errors });
     };
   };

package/src/services/server.service.js

@@ -11,11 +11,11 @@ module.exports = ({
   errorMiddleware,
   middlewaresLoader,
   probesLoader,
-  staticLoader,
+  fallbackLoader,
   jwtService,
   serverError,
 }) => {
-  let terminator = null;
+  let terminator = null; // I need your clothes, your boots and your motorcycle.
 
   function run(app, port) {
     const childLogger = logger.where(__filename, 'run');
@@ -52,10 +52,8 @@ module.exports = ({
       }
       // Load documentation
       documentationLoader(app, opts);
-      // Load static resources
-      if (opts.staticFiles) {
-        staticLoader(app, opts);
-      }
+      // Load fallback routing
+      fallbackLoader(app, opts);
       // Use error handler
       if (opts.handleErrors) {
         app.use(errorMiddleware(opts));

package/src/loaders/static.loader.js

@@ -1,17 +0,0 @@
-'use strict';
-
-module.exports = ({ express, logger }) => {
-  return function load(app, { staticFiles: { baseUrl, folderPath, indexFilePath } }) {
-    const childLogger = logger.where(__filename, 'load');
-    childLogger.debug('Started');
-    // Use Express built-in middleware
-    app.use(baseUrl, express.static(folderPath));
-    // Load static endpoint
-    if (indexFilePath) {
-      app.get(`${baseUrl}*`, function (req, res) {
-        res.sendFile(indexFilePath);
-      });
-    }
-    childLogger.debug('Finished');
-  };
-};