Merge pull request #85 from pharindoko/feat-add-jsonfile-path-setting

pharindoko · web-flow · commit d616a6ec2165 · 2019-08-25T17:43:13.000+02:00
feat(settings): added possiblity to set path of json file which will …
diff --git a/README.md b/README.md
@@ -170,6 +170,7 @@ curl -H "x-api-key: {API-KEY}" -H "Content-Type: application/json" https://xxxxx
 | readOnly  |  Make API readonly - all API - write operations are forbidden (http 403)) | string |false |
 | enableSwagger  | Enable swagger and swagger UI support  | string | true |
 | enableApiKeyAuth  | Make your routes private by using an additional ApiKey | boolean | false |
+| jsonFile  | path of json file that will be used  | string | db.json |
 
 ## Used Packages
 
diff --git a/config/appconfig.json b/config/appconfig.json
@@ -1,6 +1,7 @@
 {
     "readOnly": false,
     "enableSwagger": true,
-    "enableApiKeyAuth": false
+    "enableApiKeyAuth": false,
+    "jsonFile": "db.json"
   }
   
diff --git a/src/core.js b/src/core.js
@@ -6,50 +6,47 @@ const jsonServer = require('json-server');
 const { logger } = require('./logger');
 const swagger = require('./swagger/swagger');
 
-
-const defaultDB = JSON.parse(fs.readFileSync('./db.json', 'UTF-8'));
 const appConfig = JSON.parse(fs.readFileSync('./config/appconfig.json', 'UTF-8'));
-
 const server = express();
-
 let storage = null;
-
-
+let defaultDB = null;
 function setupServer(middlewares, router) {
   if (appConfig.enableSwagger) {
     middlewares.splice(middlewares.findIndex((x) => x.name === 'serveStatic'), 1);
   }
   server.use(middlewares);
   server.use('/api', router);
-  if (appConfig.enableSwagger) {
-    swagger.generateSwagger(server, defaultDB, appConfig);
-  }
 }
 
-function startLocal() {
+async function initializeLayers() {
+  const adapter = await low(storage);
+  const router = jsonServer.router(adapter);
+  const middlewares = jsonServer.defaults({ readOnly: appConfig.readOnly });
+  return { middlewares, router };
+}
+
+function startLocal(db) {
   logger.info('start locals environment');
-  const router = jsonServer.router('db.json');
+  const router = jsonServer.router(db);
   const middlewares = jsonServer.defaults({ readOnly: appConfig.readOnly });
-  setupServer(middlewares, router);
+  setupServer(middlewares, router, db);
 }
 
-function startInCloud() {
+function startInCloud(db) {
   logger.info(`S3File: ${process.env.S3File}`);
   logger.info(`S3Bucket: ${process.env.S3Bucket}`);
   logger.info(`readOnly: ${appConfig.readOnly}`);
   logger.info(`basePath: ${process.env.basePath}`);
   storage = new AwsAdapter(process.env.S3File, {
-    defaultValue: defaultDB,
+    defaultValue: db,
     aws: { bucketName: process.env.S3Bucket },
   });
 }
 
 const request = async () => {
   try {
-    const adapter = await low(storage);
-    const router = jsonServer.router(adapter);
-    const middlewares = jsonServer.defaults({ readOnly: appConfig.readOnly });
-    setupServer(middlewares, router);
+    const { middlewares, router } = await initializeLayers();
+    setupServer(middlewares, router, defaultDB);
   } catch (e) {
     if (e.code === 'ExpiredToken') {
       logger.error(`Please add valid credentials for AWS. Error: ${e.message}`);
@@ -59,20 +56,36 @@ const request = async () => {
   }
 };
 
-function init() {
+const init = async () => {
   logger.info(`NODE_ENV: ${process.env.NODE_ENV}`);
+
   if (process.env.NODE_ENV === 'local' || process.env.NODE_ENV === 'debug') {
-    startLocal(3000);
+    defaultDB = JSON.parse(fs.readFileSync(appConfig.jsonFile, 'UTF-8'));
+    startLocal(defaultDB);
   } else if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'offline') {
     logger.info('start development mode');
     logger.info('load variables from .env file');
     // eslint-disable-next-line global-require
     require('dotenv').config();
-    startInCloud();
+    defaultDB = JSON.parse(fs.readFileSync(process.env.S3File, 'UTF-8'));
+    startInCloud(defaultDB);
+    const { middlewares, router } = await initializeLayers();
+    setupServer(middlewares, router);
   } else {
-    startInCloud();
+    defaultDB = JSON.parse(fs.readFileSync(process.env.S3File, 'UTF-8'));
+    startInCloud(defaultDB);
+    const { middlewares, router } = await initializeLayers();
+    setupServer(middlewares, router);
   }
-}
-init();
+  if (appConfig.enableSwagger) {
+    swagger.generateSwagger(server, defaultDB, appConfig, true);
+  }
+};
 
-module.exports = { server, request };
+server.use('/reload', async () => {
+  await init();
+});
+
+module.exports = {
+  server, request, init,
+};
diff --git a/src/handler.js b/src/handler.js
@@ -1,30 +1,30 @@
 require('@babel/polyfill');
 const serverless = require('serverless-http');
 const { logger } = require('./logger');
-const app = require('./utils');
+const core = require('./core');
 
 function start(server, port) {
   // start the web server
   server.listen(port);
   logger.info(`JSON Server is running under port ${port}. Use http://localhost:${port} to access it`);
 }
 
-const handler = serverless(app.server);
+const handler = serverless(core.server);
 module.exports.handler = async (event, context) => {
-  await app.request();
+  await core.request();
   const result = await handler(event, context);
   return result;
 };
-
-if (require.main === module) {
-  if (process.env.NODE_ENV === 'local' || process.env.NODE_ENV === 'debug') {
-    start(app.server, 3000);
-  } else if (process.env.NODE_ENV === 'development') {
-    (async () => {
-      await app.request();
-      start(app.server, 3000);
-    })();
-  } else {
-    app.request();
+(async () => {
+  await core.init();
+  if (require.main === module) {
+    if (process.env.NODE_ENV === 'local' || process.env.NODE_ENV === 'debug') {
+      start(core.server, 3000);
+    } else if (process.env.NODE_ENV === 'development') {
+      await core.request();
+      start(core.server, 3000);
+    } else {
+      await core.request();
+    }
   }
-}
+})();
diff --git a/src/output.js b/src/output.js
@@ -0,0 +1,5 @@
+function output(data) {
+  console.log('Received Stack Output', data);
+}
+
+module.exports = { output };
diff --git a/src/swagger/swagger.js b/src/swagger/swagger.js
@@ -4,25 +4,27 @@ const swaggerSpec = require('./swaggerspec');
 const swaggerDefGen = require('./swagdefgen');
 const { logger } = require('../logger');
 
-module.exports.generateSwagger = (server, json, config) => {
-  logger.info('init Swagger');
-  const swaggerSchemaDefinitions = swaggerDefGen.generateDefinitions(json);
-  const spec = swaggerSpec.getSpec(server, {}, config.readOnly);
-  const auth = {
-    securityDefinitions: {
-      apiKeyHeader: {
-        type: 'apiKey',
-        in: 'header',
-        name: 'x-api-key',
-        description: 'All requests must include the `x-api-key` header containing your account ID.',
+let spec = null;
+module.exports.generateSwagger = (server, json, config, force) => {
+  if (!spec || force) {
+    logger.info('init Swagger');
+    const swaggerSchemaDefinitions = swaggerDefGen.generateDefinitions(json);
+    spec = swaggerSpec.getSpec(server, {}, config.readOnly);
+    const auth = {
+      securityDefinitions: {
+        apiKeyHeader: {
+          type: 'apiKey',
+          in: 'header',
+          name: 'x-api-key',
+          description: 'All requests must include the `x-api-key` header containing your account ID.',
+        },
       },
-    },
-  };
-  if (config.enableApiKeyAuth) {
-    swaggerSpec.addAuthentication(spec, auth);
+    };
+    if (config.enableApiKeyAuth) {
+      swaggerSpec.addAuthentication(spec, auth);
+    }
+    swaggerSpec.addSchemaDefitions(spec, swaggerSchemaDefinitions);
   }
-  swaggerSpec.addSchemaDefitions(spec, swaggerSchemaDefinitions);
-
   server.use('/api-spec', (req, res) => {
     res.setHeader('Content-Type', 'application/json');
     res.send(spec, null, 2);
diff --git a/tests/test.js b/tests/test.js
@@ -1,5 +1,9 @@
 const request = require('supertest');
-const app = require('../dist/utils.js');
+const app = require('../dist/core');
+
+(async () => {
+  await app.init();
+})();
 
 describe('Test the root path', () => {
   test('It should response the GET method', async () => {
diff --git a/webpack.config.js b/webpack.config.js
@@ -5,18 +5,21 @@ const NodeEnvPlugin = require('node-env-webpack-plugin');
 const NodemonPlugin = require('nodemon-webpack-plugin');
 const TerserPlugin = require('terser-webpack-plugin');
 const { join } = require('path');
+const fs = require('fs');
+
+const appConfig = JSON.parse(fs.readFileSync('./config/appconfig.json', 'UTF-8'));
 
 module.exports = {
   mode: 'development',
   plugins: [
     new CopyPlugin([
-      { from: './db.json', to: './db.json' },
+      { from: appConfig.jsonFile, to: './db.json' },
       { from: './config/appconfig.json', to: './config/appconfig.json' },
     ]),
     new NodeEnvPlugin({
       'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
     }),
-    process.env.NODE_ENV === 'debug' ? new NodemonPlugin({ nodeArgs: ['--inspect-brk'] }) : new NodemonPlugin(),
+    process.env.NODE_ENV === 'debug' || process.env.NODE_ENV === 'development' ? new NodemonPlugin({ nodeArgs: ['--inspect-brk'] }) : new NodemonPlugin(),
   ],
   entry: { 'src/handler': './src/handler.js' },
   optimization: {
diff --git a/webpack.config.prod.js b/webpack.config.prod.js
@@ -2,6 +2,9 @@ const nodeExternals = require('webpack-node-externals');
 const CopyPlugin = require('copy-webpack-plugin');
 const TerserPlugin = require('terser-webpack-plugin');
 const webpack = require('webpack');
+const fs = require('fs');
+
+const appConfig = JSON.parse(fs.readFileSync('./config/appconfig.json', 'UTF-8'));
 
 module.exports = {
   mode: 'production',
@@ -11,7 +14,7 @@ module.exports = {
       DEBUG: false,
     }),
     new CopyPlugin([
-      { from: './db.json', to: './db.json' },
+      { from: appConfig.jsonFile, to: './db.json' },
       { from: './config/appconfig.json', to: './config/appconfig.json' },
     ]),
   ],

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"readOnly": false,`
`3`	`3`	`"enableSwagger": true,`
`4`		`- "enableApiKeyAuth": false`
	`4`	`+ "enableApiKeyAuth": false,`
	`5`	`+ "jsonFile": "db.json"`
`5`	`6`	`}`
`6`	`7`