@apolitical/server 2.3.0-rc.fallback.4 → 2.3.2-rc.static.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.2] - 2022-02-21
+### Changed
+- loading static files middleware after the app has been loaded
+
+## [2.3.1] - 2022-02-15
+### Changed
+- Body parser types
+
 ## [2.3.0] - 2022-02-14
 ### Added
 - fallbackController

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "2.3.0-rc.fallback.4",
+  "version": "2.3.2-rc.static.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

@@ -35,6 +35,7 @@ const jwtPassportHelper = require('./helpers/jwt/passport.helper');
 const documentationLoader = require('./loaders/documentation.loader');
 const loggerLoader = require('./loaders/logger.loader');
 const middlewaresLoader = require('./loaders/middlewares.loader');
+const staticLoader = require('./loaders/static.loader');
 const probesLoader = require('./loaders/probes.loader');
 const fallbackLoader = require('./loaders/fallback.loader');
 // Middleware
@@ -84,6 +85,7 @@ container.register({
   documentationLoader: asFunction(documentationLoader).singleton(),
   loggerLoader: asFunction(loggerLoader).singleton(),
   middlewaresLoader: asFunction(middlewaresLoader).singleton(),
+  staticLoader: asFunction(staticLoader).singleton(),
   probesLoader: asFunction(probesLoader).singleton(),
   fallbackLoader: asFunction(fallbackLoader).singleton(),
   // Middlewares

package/src/loaders/middlewares.loader.js

@@ -1,33 +1,23 @@
 'use strict';
 
-module.exports = ({
-  bodyParser: { json, urlencoded },
-  express,
-  compression,
-  cors,
-  cookieParser,
-  prerender,
-  config,
-  logger,
-}) => {
-  const { BODY_PARSER_OPTIONS, CORS_OPTIONS } = config.SERVER;
+module.exports = ({ bodyParser: { json, urlencoded }, compression, cors, cookieParser, prerender, config, logger }) => {
+  const {
+    BODY_PARSER_OPTIONS: { JSON_OPTIONS, URL_ENCODED_OPTIONS },
+    CORS_OPTIONS,
+  } = config.SERVER;
 
-  return function load(app, { staticFiles, corsOptions, prerenderToken }) {
+  return function load(app, { corsOptions, prerenderToken }) {
     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/loaders/static.loader.js

@@ -0,0 +1,14 @@
+'use strict';
+
+module.exports = ({ express, logger }) => {
+  return function load(app, { staticFiles }) {
+    const childLogger = logger.where(__filename, 'load');
+    childLogger.debug('Started');
+
+    if (staticFiles) {
+      const { baseUrl, folderPath } = staticFiles;
+      app.use(baseUrl, express.static(folderPath));
+    }
+    childLogger.debug('Finished');
+  };
+};

package/src/middlewares/error.middleware.js

@@ -45,11 +45,14 @@ module.exports =
       }
 
       if (redirectURL) {
-        res.redirect(TEMPORARY_REDIRECT, `${redirectURL}?errorMessage=${encodeURI(message)}`);
-      } else if (fallbackController && message === 'Unexpected error: Cannot read items') {
-        fallbackController(req, res);
-      } 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

@@ -10,6 +10,7 @@ module.exports = ({
   authorisationMiddleware,
   errorMiddleware,
   middlewaresLoader,
+  staticLoader,
   probesLoader,
   fallbackLoader,
   jwtService,
@@ -50,12 +51,12 @@ module.exports = ({
       if (opts.appLoader) {
         await opts.appLoader(app);
       }
+      // Load static files middleware
+      staticLoader(app, opts);
       // Load documentation
       documentationLoader(app, opts);
-
-      // Load static resources or fallback
+      // Load fallback routing
       fallbackLoader(app, opts);
-
       // Use error handler
       if (opts.handleErrors) {
         app.use(errorMiddleware(opts));