@apolitical/server 1.5.0 → 1.5.2-beta.7

package/.gitlab-ci.yml

@@ -13,7 +13,7 @@ publish-module:
   stage: publish
   image: node:12.20.1-alpine3.11
   extends: 
-    - .use-cache
+    - .yarn-install
   only:
     - tags
     - /^v\d+\.\d+\.\d+$/  

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).
 
+## [1.5.1] - 2021-09-15
+### Added
+- Extend error class to handle too many request error
+
 ## [1.5.0] - 2021-09-06
 ### Added
 - Documentation

package/README.md

@@ -120,7 +120,7 @@ function appLoader(app) {
 start({ appLoader, port: 3000, handleErrors: true });
 ```
 
-The `errors` object includes a predefined set of errors: `BadRequest`, `Forbidden`, `NotFound`, and `InternalError`. Each error is an extension of the generic JavaScript `Error` object. These errors are designed to store the response status code, error message, and error key words (an array of strings).
+The `errors` object includes a predefined set of errors: `BadRequest`, `Forbidden`, `NotFound`, `TooManyRequests` and `InternalError`. Each error is an extension of the generic JavaScript `Error` object. These errors are designed to store the response status code, error message, and error key words (an array of strings).
 
 The `start` server function can take the `handleErrors` parameter. When enabling the `handleErrors` parameter, you can forward an error with the use of the `next` function on your controller and the server will take care of producing the error response. In the example above, all of the incoming requests to the `/error` endpoint are going to produce a 400 (bad request) error with the following JSON object on the body:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "1.5.0",
+  "version": "1.5.2-beta.7",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "contributors": [

package/src/config.js

@@ -22,8 +22,13 @@ module.exports = {
   },
   SERVER: {
     CORS_OPTIONS: {
-      origin: true,
-      credentials: true,
+      ORIGIN_TRUE: {
+        origin: true,
+        credentials: true,
+      },
+      ORIGIN_FALSE: {
+        origin: false,
+      },
     },
     BODY_PARSER_OPTIONS: {
       extended: false,

package/src/errors/server.error.js

@@ -1,7 +1,7 @@
 'use strict';
 
 module.exports = ({ httpStatusCodes }) => {
-  const { BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, NOT_FOUND } = httpStatusCodes;
+  const { BAD_REQUEST, FORBIDDEN, INTERNAL_SERVER_ERROR, NOT_FOUND, TOO_MANY_REQUESTS } = httpStatusCodes;
 
   class GeneralError extends Error {
     constructor(message, code, errors = []) {
@@ -35,11 +35,18 @@ module.exports = ({ httpStatusCodes }) => {
     }
   }
 
+  class TooManyRequests extends GeneralError {
+    constructor(message, errors) {
+      super(message, TOO_MANY_REQUESTS, errors);
+    }
+  }
+
   return {
     BadRequest,
     GeneralError,
     InternalError,
     Forbidden,
     NotFound,
+    TooManyRequests,
   };
 };

package/src/loaders/middlewares.loader.js

@@ -1,16 +1,21 @@
 'use strict';
 
 module.exports = ({ bodyParser: { json, urlencoded }, compression, cors, cookieParser, config, logger }) => {
-  const { BODY_PARSER_OPTIONS, CORS_OPTIONS } = config.SERVER;
+  const {
+    BODY_PARSER_OPTIONS,
+    CORS_OPTIONS: { ORIGIN_TRUE, ORIGIN_FALSE },
+  } = config.SERVER;
 
-  return function load(app) {
+  return function load(app, { disableCors }) {
     const childLogger = logger.where(__filename, 'load');
     childLogger.debug('Started');
+    // Compute cors config
+    const corsOptions = disableCors ? ORIGIN_FALSE : ORIGIN_TRUE;
     // Load useful middlewares
     app.use(cookieParser());
     app.use(json());
     app.use(urlencoded(BODY_PARSER_OPTIONS));
-    app.use(cors(CORS_OPTIONS));
+    app.use(cors(corsOptions));
     app.use(compression());
     childLogger.debug('Finished');
   };

package/src/services/server.service.js

@@ -42,7 +42,7 @@ module.exports = ({
       // Load probes
       probesLoader(app);
       // Load useful middlewares
-      middlewaresLoader(app);
+      middlewaresLoader(app, opts);
       // Load logger
       loggerLoader(app, opts);
       // Load documentation

package/test/integration/errors.spec.js

@@ -52,6 +52,12 @@ describe('Error Handling', () => {
       expect(res.body).toEqual(metadata);
     });
 
+    test('should return 429', async () => {
+      const res = await agents.loggedOut.get(url.replace(':code', 429));
+      expect(res.statusCode).toEqual(429);
+      expect(res.body).toEqual(metadata);
+    });
+
     test('should return 500', async () => {
       const res = await agents.loggedOut.get(url.replace(':code', 500));
       expect(res.statusCode).toEqual(500);

package/test/integration/mocks/endpoints/errors.endpoint.js

@@ -23,6 +23,10 @@ module.exports = (errors) => ({
         next(new errors.NotFound(errorMessage, errorArray));
         break;
       }
+      case 429: {
+        next(new errors.TooManyRequests(errorMessage, errorArray));
+        break;
+      }
       case 500: {
         next(new errors.InternalError(errorMessage));
         break;