@apolitical/server 1.5.2-beta.7 → 2.0.0-beta.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).
 
+## [1.5.2] - 2021-10-18
+### Changed
+- Allow cors options to be passed in as params on start
+
 ## [1.5.1] - 2021-09-15
 ### Added
 - Extend error class to handle too many request error

package/README.md

@@ -6,7 +6,7 @@ Node.js module to encapsulate Apolitical's express server setup
 
 Requires the following to run:
 
-- [node.js][node] 12.20.1+
+- [node.js][node] 16.13.2+
 - [yarn][yarn]
 
 [node]: https://nodejs.org/en/download/

package/package.json

@@ -1,19 +1,13 @@
 {
   "name": "@apolitical/server",
-  "version": "1.5.2-beta.7",
+  "version": "2.0.0-beta.1",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
-  "contributors": [
-    "Anouska Hopkins <anouska.hopkins@apolitical.co>",
-    "Antonio Cordasco <antonio.cordasco@apolitical.co>",
-    "Dorothy Yau <dorothy.yau@apolitical.co>",
-    "Laura Hanna-White <laura.hanna-white@apolitical.co>",
-    "Fatimat Gbajabiamila <fatimat.gbajabiamila@apolitical.co>",
-    "Renzo Rozza <renzo.rozza@apolitical.co>",
-    "Rihards Jukna <rihards.jukna@apolitical.co>"
-  ],
   "license": "MIT",
-  "main": "index.js",
+  "main": "src/index.js",
+  "files": [
+    "src"
+  ],
   "scripts": {
     "test": "jest --bail --runInBand",
     "unit-test": "jest test/unit/**/* --bail --runInBand",
@@ -30,38 +24,39 @@
     "Node Modules"
   ],
   "dependencies": {
-    "@apolitical/logger": "1.0.2",
+    "@apolitical/logger": "2.0.0-beta.6",
     "@cloudnative/health-connect": "2.1.0",
-    "awilix": "5.0.1",
-    "body-parser": "1.19.0",
+    "awilix": "6.0.0",
+    "body-parser": "1.19.1",
     "compression": "1.7.4",
-    "cookie-parser": "1.4.5",
+    "cookie-parser": "1.4.6",
     "cors": "2.8.5",
-    "dotenv": "10.0.0",
-    "express": "4.17.1",
+    "dotenv": "14.2.0",
+    "express": "4.17.2",
     "express-jwt": "6.1.0",
-    "http-status-codes": "2.1.4",
-    "http-terminator": "3.0.0",
-    "jsrsasign": "10.4.0",
-    "jwks-rsa": "2.0.4",
+    "http-status-codes": "2.2.0",
+    "http-terminator": "3.0.4",
+    "jsrsasign": "10.5.1",
+    "jwks-rsa": "2.0.5",
     "jwt-decode": "3.1.2",
     "morgan": "1.10.0",
-    "passport": "0.4.1",
+    "passport": "0.5.2",
     "passport-jwt": "4.0.0",
-    "swagger-ui-express": "4.1.6"
+    "swagger-ui-express": "4.3.0"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "0.0.1",
+    "@apolitical/eslint-config": "1.0.0-beta.0",
     "@apolitical/testing": "0.0.4",
-    "audit-ci": "4.1.0",
-    "husky": "7.0.2",
-    "jest": "27.1.0",
-    "lint-staged": "11.1.2",
+    "audit-ci": "5.1.2",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
+    "lint-staged": "12.2.0",
     "mock-jwks": "1.0.1",
-    "nock": "13.1.3"
+    "nock": "13.2.2"
   },
   "engines": {
-    "node": ">=12.20.1"
+    "node": ">=16.13.2"
   },
   "eslintConfig": {
     "extends": "@apolitical/eslint-config/base.config"
@@ -86,7 +81,12 @@
     "testEnvironment": "node",
     "testTimeout": 60000,
     "maxConcurrency": 1,
-    "maxWorkers": 1
+    "maxWorkers": 1,
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
+    "testResultsProcessor": "jest-junit"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix --ignore-path .gitignore",

package/src/config.js

@@ -2,15 +2,18 @@
 
 const { NODE_ENV, LOG_LEVEL } = process.env;
 
-const serviceName = 'apolitical-server';
+const NAME = 'apolitical-server';
+const VERSION = 'v2.0.0';
+const ADMIN_ROLE = 'administrator';
 
 module.exports = {
   NODE_ENV,
   LOG_LEVEL,
   LOGGER_OPTIONS: {
     logLevel: LOG_LEVEL,
-    metadata: {
-      serviceName,
+    labels: {
+      name: NAME,
+      version: VERSION,
     },
   },
   ENDPOINTS: {
@@ -20,15 +23,16 @@ module.exports = {
     },
     DOCUMENTATION: '/docs/',
   },
+  MIDDLEWARES: {
+    PERMISSIONS: {
+      ADMIN_ROLE,
+      MYSELF_SLUG: 'me',
+    },
+  },
   SERVER: {
     CORS_OPTIONS: {
-      ORIGIN_TRUE: {
-        origin: true,
-        credentials: true,
-      },
-      ORIGIN_FALSE: {
-        origin: false,
-      },
+      origin: true,
+      credentials: true,
     },
     BODY_PARSER_OPTIONS: {
       extended: false,
@@ -60,10 +64,10 @@ module.exports = {
       ALGORITHM: 'HS256',
       HEADER: { alg: 'HS256', typ: 'JWT' },
       DEFAULT_PAYLOAD: {
-        role: 'administrator',
+        role: ADMIN_ROLE,
         admin: true,
-        slug: serviceName,
-        iss: serviceName,
+        slug: NAME,
+        iss: NAME,
         sub: 'login',
       },
     },

package/src/container.js

@@ -23,7 +23,7 @@ const apoliticalLogger = require('@apolitical/logger');
 // Configuration
 const config = require('./config');
 // Logger
-const logger = apoliticalLogger(config.LOGGER_OPTIONS);
+const logger = apoliticalLogger.createLogger(config.LOGGER_OPTIONS);
 // Errors
 const serverError = require('./errors/server.error');
 // Helpers
@@ -42,6 +42,7 @@ const authMiddleware = require('./middlewares/auth.middleware');
 const jwtApoliticalMiddleware = require('./middlewares/jwt/apolitical.middleware');
 const jwtAuth0Middleware = require('./middlewares/jwt/auth0.middleware');
 const errorMiddleware = require('./middlewares/error.middleware');
+const permissionsMiddleware = require('./middlewares/permissions.middleware');
 // Services
 const jwtService = require('./services/jwt.service');
 const serverService = require('./services/server.service');
@@ -90,6 +91,7 @@ container.register({
   jwtApoliticalMiddleware: asFunction(jwtApoliticalMiddleware).singleton(),
   jwtAuth0Middleware: asFunction(jwtAuth0Middleware).singleton(),
   errorMiddleware: asFunction(errorMiddleware).singleton(),
+  permissionsMiddleware: asFunction(permissionsMiddleware).singleton(),
   // Services
   jwtService: asFunction(jwtService).singleton(),
   serverService: asFunction(serverService).singleton(),

package/src/helpers/logger.helper.js

@@ -1,16 +1,12 @@
 'use strict';
 
 module.exports = ({ apoliticalLogger, config: { LOG_LEVEL } }) => ({
-  build({ filename, method, serviceName }) {
+  build({ filename, method, labels }) {
     const options = { logLevel: LOG_LEVEL };
-    if (serviceName) {
-      Object.assign(options, {
-        metadata: {
-          serviceName,
-        },
-      });
+    if (labels) {
+      Object.assign(options, { labels });
     }
-    const logger = apoliticalLogger(options);
+    const logger = apoliticalLogger.createLogger(options);
     return logger.where(filename, method);
   },
 });

package/src/index.js

@@ -0,0 +1,5 @@
+'use strict';
+
+const { resolve } = require('./container');
+
+module.exports = resolve('serverService');

package/src/loaders/documentation.loader.js

@@ -1,18 +1,23 @@
 'use strict';
 
-module.exports = ({ httpStatusCodes: { MOVED_PERMANENTLY }, config, logger, swaggerUi: { serve, setup } }) => {
-  const { NODE_ENV } = config;
+module.exports = ({
+  httpStatusCodes: { MOVED_PERMANENTLY },
+  config,
+  logger,
+  swaggerUi: { serve, setup },
+  permissionsMiddleware,
+}) => {
   const { DOCUMENTATION } = config.ENDPOINTS;
 
   return function load(app, { swaggerDocument }) {
     const childLogger = logger.where(__filename, 'load');
     childLogger.debug('Started');
     // Load document endpoint
-    if (NODE_ENV !== 'production' && swaggerDocument) {
+    if (swaggerDocument) {
       // Redirection to documentation
       app.use(`${DOCUMENTATION}index.html`, (req, res) => res.redirect(MOVED_PERMANENTLY, DOCUMENTATION));
       // Documentation express setup
-      app.use(DOCUMENTATION, serve, setup(swaggerDocument));
+      app.use(DOCUMENTATION, permissionsMiddleware(), serve, setup(swaggerDocument));
     }
     childLogger.debug('Finished');
   };

package/src/loaders/logger.loader.js

@@ -1,6 +1,6 @@
 'use strict';
 
-module.exports = ({ morgan, config, logger, loggerHelper }) => {
+module.exports = ({ apoliticalLogger, morgan, config, logger, loggerHelper }) => {
   const {
     LOGGED_OUT_SLUG,
     TOKENS: { USER_SLUG },
@@ -21,22 +21,29 @@ module.exports = ({ morgan, config, logger, loggerHelper }) => {
     ].join(' ');
   }
 
-  return function load(app, { serviceName }) {
+  return async function load(app, { labels }) {
     const childLogger = logger.where(__filename, 'load');
     childLogger.debug('Started');
-    // Add user slug token
+    // Setup Morgan with custom format and Apolitical Logger stream
     morgan.token(USER_SLUG, getUserSlug);
-    // Setup Morgan with custom format and Apolitical Logger (with service metadata) stream
-    app.use(
-      morgan(
-        buildCustomFormat,
-        loggerHelper.build({
-          filename: __filename,
-          method: 'morganHandler',
-          serviceName,
-        }),
-      ),
+    const morganMiddleware = morgan(
+      buildCustomFormat,
+      loggerHelper.build({
+        filename: __filename,
+        method: 'loggerMiddlewareMorgan',
+        labels,
+      }),
     );
+    app.use(morganMiddleware);
+    // Setup Google Cloud with Apolitical Logger
+    const googleMiddleware = await apoliticalLogger.loggerMiddleware(
+      loggerHelper.build({
+        filename: __filename,
+        method: 'loggerMiddlewareWinston',
+        labels,
+      }),
+    );
+    app.use(googleMiddleware);
     childLogger.debug('Finished');
   };
 };

package/src/loaders/middlewares.loader.js

@@ -1,21 +1,16 @@
 'use strict';
 
 module.exports = ({ bodyParser: { json, urlencoded }, compression, cors, cookieParser, config, logger }) => {
-  const {
-    BODY_PARSER_OPTIONS,
-    CORS_OPTIONS: { ORIGIN_TRUE, ORIGIN_FALSE },
-  } = config.SERVER;
+  const { BODY_PARSER_OPTIONS, CORS_OPTIONS } = config.SERVER;
 
-  return function load(app, { disableCors }) {
+  return function load(app, { corsOptions }) {
     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(corsOptions));
+    app.use(cors(Object.assign({}, CORS_OPTIONS, corsOptions)));
     app.use(compression());
     childLogger.debug('Finished');
   };

package/src/middlewares/auth.middleware.js

@@ -1,10 +1,10 @@
 'use strict';
 
-module.exports =
-  ({ jwtApoliticalMiddleware, logger, serverError: { Forbidden }, config }) =>
-  ({ allowLoggedOut = false } = {}) => {
-    const { COOKIE_KEY } = config.JWT.APOLITICAL;
-
+module.exports = ({ jwtApoliticalMiddleware, logger, serverError: { Forbidden }, config }) => {
+  const { COOKIE_KEY } = config.JWT.APOLITICAL;
+  // Define external options
+  return ({ allowLoggedOut = false } = {}) => {
+    // Return middleware handler
     return async function handler(req, res, next) {
       const childLogger = logger.where(__filename, 'handler');
       childLogger.debug('Started');
@@ -12,7 +12,7 @@ module.exports =
       const user = await jwtApoliticalMiddleware(req, res);
       // If logged out users are not allowed and there is no user object throws forbidden error
       if (!allowLoggedOut && !user) {
-        return next(new Forbidden('No Apolitical authorization token', ['cookie-jwt', 'logged-out']));
+        return next(new Forbidden('Cannot authenticate action', ['cookie-jwt', 'logged-out']));
       }
       // Assigns user to the request object
       Object.assign(req, { user });
@@ -22,3 +22,4 @@ module.exports =
       return next();
     };
   };
+};

package/src/middlewares/error.middleware.js

@@ -10,12 +10,12 @@ module.exports =
     loggerHelper,
     serverError: { GeneralError },
   }) =>
-  ({ serviceName, redirectURL }) => {
+  ({ labels, redirectURL }) => {
     // Apolitical Logger (with service metadata)
     const errorLogger = loggerHelper.build({
       filename: __filename,
-      method: 'errorHandler',
-      serviceName,
+      method: 'errorMiddleware',
+      labels,
     });
 
     // eslint-disable-next-line no-unused-vars

package/src/middlewares/permissions.middleware.js

@@ -0,0 +1,39 @@
+'use strict';
+
+module.exports = ({ logger, serverError: { Forbidden }, config }) => {
+  const { ADMIN_ROLE, MYSELF_SLUG } = config.MIDDLEWARES.PERMISSIONS;
+  // Define external options
+  return ({ myselfSource = null, myselfTarget = null, allowNonAdmin = false } = {}) => {
+    // Return middleware handler
+    return async function handler(req, res, next) {
+      const childLogger = logger.where(__filename, 'handler');
+      childLogger.debug('Started');
+      let isNotMyselfSlug = false;
+      let isNotAdmin = false;
+      // Check myself param
+      if (myselfSource) {
+        isNotMyselfSlug = req.params[myselfSource] !== MYSELF_SLUG;
+      }
+      // Check user role (from JWT)
+      if (!allowNonAdmin) {
+        isNotAdmin = req.user && req.user.role !== ADMIN_ROLE;
+      }
+      // Check permissions and prevent unauthorised requests
+      let unauthorised = false;
+      if (isNotMyselfSlug && myselfSource && isNotAdmin && !allowNonAdmin) {
+        unauthorised = true;
+      } else if (isNotAdmin && !allowNonAdmin) {
+        unauthorised = true;
+      }
+      if (unauthorised) {
+        return next(new Forbidden('Cannot authorise action', ['cookie-jwt', 'non-admin']));
+      }
+      // Update myself slug with real slug (from JWT)
+      if (myselfSource && myselfTarget && req.params[myselfSource] === MYSELF_SLUG) {
+        Object.assign(req.params, { [myselfSource]: req.user[myselfTarget] });
+      }
+      childLogger.debug('Finished');
+      return next();
+    };
+  };
+};

package/src/services/server.service.js

@@ -44,13 +44,13 @@ module.exports = ({
       // Load useful middlewares
       middlewaresLoader(app, opts);
       // Load logger
-      loggerLoader(app, opts);
-      // Load documentation
-      documentationLoader(app, opts);
+      await loggerLoader(app, opts);
       // Load custom resources
       if (opts.appLoader) {
         await opts.appLoader(app);
       }
+      // Load documentation
+      documentationLoader(app, opts);
       // Load static resources
       if (opts.staticFiles) {
         staticLoader(app, opts);

package/.gitlab-ci.yml

@@ -1,22 +0,0 @@
-# External jobs
-include:
-  - project: 'apolitical/templates/gitlab-pipelines'
-    ref: master
-    file: 'Node-Testing.gitlab-ci.yml'
-
-stages:
-  - cache
-  - test
-  - publish
-
-publish-module:
-  stage: publish
-  image: node:12.20.1-alpine3.11
-  extends: 
-    - .yarn-install
-  only:
-    - tags
-    - /^v\d+\.\d+\.\d+$/  
-  script:
-    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
-    - yarn publish --access=public

package/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-format
-
-yarn test

package/doc/swagger.json

@@ -1,52 +0,0 @@
-{
-  "openapi": "3.0.1",
-  "info": {
-    "title": "Apolitical Server",
-    "description": "Node.js module to encapsulate Apolitical's express server setup",
-    "version": "1.0.0"
-  },
-  "servers": [
-    {
-      "url": "http://localhost:3000"
-    }
-  ],
-  "paths": {
-    "/example": {
-      "get": {
-        "description": "Example Endpoint",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "Example Response",
-            "content": {
-              "application/json; charset=utf-8": {
-                "schema": {
-                  "$ref": "#/components/schemas/Response"
-                },
-                "examples": {
-                  "message": {
-                    "summary": "Default Response",
-                    "value": { "message": "hello" }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "Response": {
-        "type": "object",
-        "required": ["message"],
-        "properties": {
-          "message": {
-            "type": "string"
-          }
-        }
-      }
-    }
-  }
-}

package/index.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const container = require('./src/container');
-
-module.exports = container.resolve('serverService');

package/test/integration/__snapshots__/jwt.apolitical.spec.js.snap

@@ -1,14 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`JWT Apolitical Endpoints GET /jwt should return 200 with token 1`] = `
-Object {
-  "admin": true,
-  "email": "apolitical.testing@email.com",
-  "exp": Any<Number>,
-  "iss": "apolitical-testing",
-  "name": "Apolitical Testing",
-  "role": "public-servant",
-  "slug": "apolitical-testing",
-  "sub": "login",
-}
-`;

package/test/integration/container.js

@@ -1,40 +0,0 @@
-'use strict';
-
-// External Modules
-require('dotenv').config({ path: `${__dirname}/../test.env` });
-const { createContainer, asValue } = require('awilix');
-const { default: jwksClient } = require('mock-jwks');
-// Internal Modules
-const apoliticalTesting = require('@apolitical/testing');
-// API Container
-const apiContainer = require('../../src/container');
-// API Documentation
-const swaggerDocument = require('../../doc/swagger.json');
-// Mocks
-const jwksConfig = require('./mocks/configs/jwks.config');
-const mockEndpoints = require('./mocks/endpoints');
-// Testing environment variables
-const config = apiContainer.resolve('config');
-Object.assign(config.SERVER, {
-  PORT: process.env.PORT,
-  SESSION_SECRET: process.env.SESSION_SECRET,
-});
-// Test Container
-const testContainer = createContainer();
-testContainer.register(apiContainer.registrations);
-testContainer.register({
-  // Internal Modules
-  apoliticalTesting: asValue(apoliticalTesting),
-  // Configuration
-  config: asValue(config),
-  // Documentation
-  swaggerDocument: asValue(swaggerDocument),
-  // Mocks
-  mockEndpoints: asValue(mockEndpoints),
-  mockJwks: asValue({
-    jwksClient,
-    jwksConfig,
-  }),
-});
-
-module.exports = testContainer;

package/test/integration/errors.spec.js

@@ -1,102 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Internal Modules
-const { request } = resolve('apoliticalTesting');
-// Configuration
-const {
-  SERVER: { PORT, SESSION_SECRET },
-} = resolve('config');
-// Services
-const { start, stop, errors } = resolve('serverService');
-// Mocks
-const { errorsEndpoint } = resolve('mockEndpoints');
-const { metadata, url, controller } = errorsEndpoint(errors);
-
-describe('Error Handling', () => {
-  let agents = null;
-
-  beforeAll(async () => {
-    const app = await start({
-      port: PORT,
-      appLoader: (app) => {
-        app.get(url, controller);
-      },
-      handleErrors: true,
-      serviceName: 'test-service',
-    });
-
-    agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-  });
-
-  afterAll(async () => {
-    await stop();
-  });
-
-  describe('GET /error', () => {
-    test('should return 400', async () => {
-      const res = await agents.loggedOut.get(url.replace(':code', 400));
-      expect(res.statusCode).toEqual(400);
-      expect(res.body).toEqual(metadata);
-    });
-
-    test('should return 403', async () => {
-      const res = await agents.loggedOut.get(url.replace(':code', 403));
-      expect(res.statusCode).toEqual(403);
-      expect(res.body).toEqual(metadata);
-    });
-
-    test('should return 404', async () => {
-      const res = await agents.loggedOut.get(url.replace(':code', 404));
-      expect(res.statusCode).toEqual(404);
-      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);
-      expect(res.body).toEqual({ message: metadata.message, errors: [] });
-    });
-
-    test('should return 500 (unexpected error)', async () => {
-      const res = await agents.loggedOut.get(url.replace(':code', 501));
-      expect(res.statusCode).toEqual(500);
-      expect(res.body).toEqual({ message: 'Unexpected error: Some Unexpected Error', errors: ['unknown-error'] });
-    });
-  });
-});
-
-describe('Error Redirect', () => {
-  let agents = null;
-  const redirectURL = `http://localhost:${PORT}/not-found`;
-
-  beforeAll(async () => {
-    const app = await start({
-      port: PORT,
-      appLoader: (app) => {
-        app.get(url, controller);
-      },
-      handleErrors: true,
-      redirectURL,
-      serviceName: 'test-service',
-    });
-
-    agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-  });
-
-  afterAll(async () => {
-    await stop();
-  });
-
-  test('should return 307', async () => {
-    const res = await agents.loggedOut.get(url.replace(':code', 500));
-    expect(res.statusCode).toEqual(307);
-    expect(res.headers.location).toEqual(`${redirectURL}?errorMessage=${encodeURI(metadata.message)}`);
-  });
-});

package/test/integration/example.spec.js

@@ -1,43 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Internal Modules
-const { request } = resolve('apoliticalTesting');
-// Configuration
-const {
-  SERVER: { PORT, SESSION_SECRET },
-} = resolve('config');
-// Services
-const { start, stop } = resolve('serverService');
-// Mocks
-const { exampleEndpoint } = resolve('mockEndpoints');
-const { url, controller } = exampleEndpoint();
-
-describe('Example Endpoint', () => {
-  let agents = null;
-
-  beforeAll(async () => {
-    const app = await start({
-      port: PORT,
-      appLoader: (app) => {
-        app.get(url, controller);
-      },
-      handleErrors: false,
-      serviceName: 'test-service',
-    });
-
-    agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-  });
-
-  afterAll(async () => {
-    await stop();
-  });
-
-  describe('GET /dummy', () => {
-    test('should return 200', async () => {
-      const res = await agents.loggedOut.get(url);
-      expect(res.statusCode).toEqual(200);
-      expect(res.body).toEqual({ message: 'some-message' });
-    });
-  });
-});

package/test/integration/jwt.apolitical.spec.js

@@ -1,74 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Internal Modules
-const { request } = resolve('apoliticalTesting');
-// Configuration
-const {
-  ENDPOINTS: { DOCUMENTATION },
-  SERVER: { PORT, SESSION_SECRET },
-} = resolve('config');
-// Documentation
-const swaggerDocument = resolve('swaggerDocument');
-// Services
-const {
-  start,
-  stop,
-  jwt,
-  middlewares: { auth },
-} = resolve('serverService');
-// Mocks
-const { jwtApoliticalEndpoint } = resolve('mockEndpoints');
-const { url, controller } = jwtApoliticalEndpoint();
-
-describe('JWT Apolitical Endpoints', () => {
-  let agents = null;
-
-  beforeAll(async () => {
-    const app = await start({
-      port: PORT,
-      appLoader: (app) => {
-        jwt.apolitical.setup(SESSION_SECRET);
-        app.use(auth());
-        app.get(url, controller);
-      },
-      swaggerDocument,
-      handleErrors: true,
-      serviceName: 'test-service',
-    });
-
-    agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-  });
-
-  afterAll(async () => {
-    await stop();
-  });
-
-  describe('GET /jwt', () => {
-    test('should return 200 with token', async () => {
-      const res = await agents.loggedIn.get(url);
-      expect(res.statusCode).toEqual(200);
-      expect(res.body.user).toMatchSnapshot({ exp: expect.any(Number) });
-    });
-
-    test('should return 403 without token', async () => {
-      const res = await agents.loggedOut.get(url);
-      expect(res.statusCode).toEqual(403);
-      expect(res.body.message).toEqual('No Apolitical authorization token');
-    });
-  });
-
-  describe('GET /docs', () => {
-    test('should return 200 with token', async () => {
-      const res = await agents.loggedIn.get(DOCUMENTATION);
-      expect(res.statusCode).toEqual(200);
-      expect(res.headers['content-type']).toEqual('text/html; charset=utf-8');
-    });
-
-    test('should return 301 with token (index file)', async () => {
-      const res = await agents.loggedIn.get(`${DOCUMENTATION}index.html`);
-      expect(res.statusCode).toEqual(301);
-      expect(res.headers.location).toEqual(DOCUMENTATION);
-    });
-  });
-});

package/test/integration/jwt.auth0.spec.js

@@ -1,57 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Internal Modules
-const { request } = resolve('apoliticalTesting');
-// Configuration
-const {
-  SERVER: { PORT, SESSION_SECRET },
-} = resolve('config');
-// Services
-const { start, stop, jwt } = resolve('serverService');
-// Mocks
-const { jwksClient, jwksConfig } = resolve('mockJwks');
-const { jwtAuth0Endpoint } = resolve('mockEndpoints');
-const { url, controller, auth } = jwtAuth0Endpoint(jwt, jwksConfig);
-
-describe('JWT Auth0 Endpoints', () => {
-  let agents = null;
-
-  const jwksMock = jwksClient(jwksConfig.ISSUER);
-
-  beforeAll(async () => {
-    jwksMock.start();
-
-    const app = await start({
-      port: PORT,
-      appLoader: (app) => {
-        app.get(url, auth, controller);
-      },
-      handleErrors: true,
-      serviceName: 'test-service',
-    });
-
-    agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-  });
-
-  afterAll(async () => {
-    jwksMock.stop();
-    await stop();
-  });
-
-  describe('GET /jwt', () => {
-    test('should return 200 with token', async () => {
-      const token = jwksMock.token(jwksConfig.PAYLOAD);
-      agents.loggedInMyself.set('Authorization', `Bearer ${token}`);
-      const res = await agents.loggedInMyself.get(url);
-      expect(res.statusCode).toEqual(200);
-      expect(res.body).toEqual({ ok: true });
-    });
-
-    test('should return 403 without token', async () => {
-      const res = await agents.loggedOut.get(url);
-      expect(res.statusCode).toEqual(403);
-      expect(res.body.message).toEqual('Unauthorized error: No authorization token was found');
-    });
-  });
-});

package/test/integration/mocks/configs/jwks.config.js

@@ -1,17 +0,0 @@
-'use strict';
-
-const DOMAIN = 'some-domain.eu.auth0.com';
-const AUDIENCE = `https://some.url.co/api/auth-api/`;
-const ISSUER = `https://${DOMAIN}/`;
-
-module.exports = {
-  DOMAIN,
-  AUDIENCE,
-  ISSUER,
-  PAYLOAD: {
-    iss: ISSUER,
-    sub: 'some-sub@clients',
-    aud: AUDIENCE,
-    gty: 'client-credentials',
-  },
-};

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

@@ -1,40 +0,0 @@
-'use strict';
-
-const errorArray = ['some-error'];
-const errorMessage = 'Some Error Message';
-
-module.exports = (errors) => ({
-  metadata: {
-    errors: errorArray,
-    message: errorMessage,
-  },
-  url: '/error/:code',
-  controller: (req, res, next) => {
-    switch (parseInt(req.params.code)) {
-      case 400: {
-        next(new errors.BadRequest(errorMessage, errorArray));
-        break;
-      }
-      case 403: {
-        next(new errors.Forbidden(errorMessage, errorArray));
-        break;
-      }
-      case 404: {
-        next(new errors.NotFound(errorMessage, errorArray));
-        break;
-      }
-      case 429: {
-        next(new errors.TooManyRequests(errorMessage, errorArray));
-        break;
-      }
-      case 500: {
-        next(new errors.InternalError(errorMessage));
-        break;
-      }
-      default: {
-        next(new Error('Some Unexpected Error'));
-        break;
-      }
-    }
-  },
-});

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

@@ -1,8 +0,0 @@
-'use strict';
-
-module.exports = () => ({
-  url: '/example',
-  controller: (req, res) => {
-    res.status(200).json({ message: 'some-message' });
-  },
-});

package/test/integration/mocks/endpoints/index.html

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <meta name="theme-color" content="#000000" />
-    <meta property="og:title" content="__OG_TITLE__" />
-    <title>Static Server | Apolitical</title>
-  </head>
-  <body>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
-    <div id="root"></div>
-  </body>
-</html>

package/test/integration/mocks/endpoints/index.js

@@ -1,15 +0,0 @@
-'use strict';
-
-const exampleEndpoint = require('./example.endpoint');
-const errorsEndpoint = require('./errors.endpoint');
-const jwtApoliticalEndpoint = require('./jwt/apolitical.endpoint');
-const jwtAuth0Endpoint = require('./jwt/auth0.endpoint');
-const staticEndpoint = require('./static.endpoint');
-
-module.exports = {
-  exampleEndpoint,
-  errorsEndpoint,
-  jwtApoliticalEndpoint,
-  jwtAuth0Endpoint,
-  staticEndpoint,
-};

package/test/integration/mocks/endpoints/jwt/apolitical.endpoint.js

@@ -1,9 +0,0 @@
-'use strict';
-
-module.exports = () => ({
-  url: '/jwt',
-  controller: (req, res) => {
-    const { user } = req;
-    res.status(200).json({ user });
-  },
-});

package/test/integration/mocks/endpoints/jwt/auth0.endpoint.js

@@ -1,13 +0,0 @@
-'use strict';
-
-module.exports = (jwt, { DOMAIN, AUDIENCE, ISSUER }) => ({
-  url: '/jwt',
-  controller: (req, res) => {
-    res.status(200).json({ ok: true });
-  },
-  auth: jwt.auth0.parse({
-    domain: DOMAIN,
-    audience: AUDIENCE,
-    issuer: ISSUER,
-  }),
-});

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

@@ -1,15 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-
-module.exports = () => ({
-  baseUrl: '/',
-  folderPath: path.join(__dirname),
-  indexFilePath: path.join(__dirname, 'index.html'),
-  controller: (req, res) => {
-    const indexFile = fs.readFileSync(path.join(__dirname, 'index.html'), 'utf8');
-    const indexModified = indexFile.replace('__OG_TITLE__', 'some-title');
-    res.send(indexModified);
-  },
-});

package/test/integration/probes.spec.js

@@ -1,42 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Internal Modules
-const { request } = resolve('apoliticalTesting');
-const {
-  ENDPOINTS: {
-    PROBES: { LIVENESS, READINESS },
-  },
-  SERVER: { PORT, SESSION_SECRET },
-} = resolve('config');
-// Services
-const { start, stop } = resolve('serverService');
-
-describe('Probes Endpoints', () => {
-  let agents = null;
-
-  beforeAll(async () => {
-    const app = await start({ port: PORT, serviceName: 'test-service' });
-    agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-  });
-
-  afterAll(async () => {
-    await stop();
-  });
-
-  describe('GET /liveness', () => {
-    test('should return 200', async () => {
-      const res = await agents.loggedOut.get(LIVENESS);
-      expect(res.statusCode).toEqual(200);
-      expect(res.body).toEqual({});
-    });
-  });
-
-  describe('GET /readiness', () => {
-    test('should return 200', async () => {
-      const res = await agents.loggedOut.get(READINESS);
-      expect(res.statusCode).toEqual(200);
-      expect(res.body).toEqual({});
-    });
-  });
-});

package/test/integration/static.spec.js

@@ -1,94 +0,0 @@
-'use strict';
-
-const { resolve } = require('./container');
-// Internal Modules
-const { request } = resolve('apoliticalTesting');
-// Configuration
-const {
-  SERVER: { PORT, SESSION_SECRET },
-} = resolve('config');
-// Services
-const { start, stop } = resolve('serverService');
-// Mocks
-const { staticEndpoint } = resolve('mockEndpoints');
-const { baseUrl, folderPath, indexFilePath, controller } = staticEndpoint();
-
-describe('Static Server', () => {
-  let agents = null;
-
-  describe('Default static loader', () => {
-    beforeAll(async () => {
-      const app = await start({
-        port: PORT,
-        staticFiles: {
-          baseUrl,
-          folderPath,
-          indexFilePath,
-        },
-        handleErrors: true,
-        serviceName: 'test-service',
-      });
-
-      agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-    });
-
-    afterAll(async () => {
-      await stop();
-    });
-
-    describe('GET /index.html', () => {
-      test('should return 200 with token', async () => {
-        const res = await agents.loggedIn.get('/');
-        expect(res.statusCode).toEqual(200);
-        expect(res.headers['content-type']).toEqual('text/html; charset=UTF-8');
-        expect(res.text.includes('__OG_TITLE__')).toBeTruthy();
-      });
-
-      test('should return 200 without token', async () => {
-        const res = await agents.loggedOut.get('/');
-        expect(res.statusCode).toEqual(200);
-        expect(res.headers['content-type']).toEqual('text/html; charset=UTF-8');
-        expect(res.text.includes('__OG_TITLE__')).toBeTruthy();
-      });
-    });
-  });
-
-  describe('Custom static loader', () => {
-    beforeAll(async () => {
-      const app = await start({
-        port: PORT,
-        staticFiles: {
-          baseUrl,
-          folderPath,
-        },
-        appLoader: (app) => {
-          app.get(`${baseUrl}*`, controller);
-        },
-        handleErrors: true,
-        serviceName: 'test-service',
-      });
-
-      agents = request({ sessionSecret: SESSION_SECRET }).generateAgents(app);
-    });
-
-    afterAll(async () => {
-      await stop();
-    });
-
-    describe('GET /index.html', () => {
-      test('should return 200 with token', async () => {
-        const res = await agents.loggedIn.get('/');
-        expect(res.statusCode).toEqual(200);
-        expect(res.headers['content-type']).toEqual('text/html; charset=utf-8');
-        expect(res.text.includes('some-title')).toBeTruthy();
-      });
-
-      test('should return 200 without token', async () => {
-        const res = await agents.loggedOut.get('/');
-        expect(res.statusCode).toEqual(200);
-        expect(res.headers['content-type']).toEqual('text/html; charset=utf-8');
-        expect(res.text.includes('some-title')).toBeTruthy();
-      });
-    });
-  });
-});

package/test/test.env

@@ -1,4 +0,0 @@
-LOG_LEVEL=error
-NODE_ENV=testing
-PORT=3000
-SESSION_SECRET=hello