Merge pull request #3 from topcoderinc/challenge_2

changes for challenge 4

Author: ksmacleod99

README.md

@@ -6,6 +6,7 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
 
 - Node 8.11.x , npm 5.6.x
 - redis 4.x
+- docker
 
 ### Redis
 
@@ -18,22 +19,30 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
   $ make
   ```
 
-- start up redis server `cd src` `./redis-server`
+- start up redis server `cd src` `./redis-server --bind 0.0.0.0`
 - load sample data into redis server, `cd src`,  then run this `cat <submission-folder>/simple-data-txt.txt | ./redis-cli --pipe` import simple data.
 
 ### Local run
 
 - goto submission folder, run `npm i` first
 - just run `npm run start`, and use browsers open http://127.0.0.1:3003
 
+### Docker build and run
+
+- build image, make sure your dokcer already startup
+  - run `./build-docker-image.sh` to build docker image, the image named **tc/redis-manager**
+  - after build succeed, run `docker run -p 3003:3003 -it tc/redis-manager` to run image
+  - then use browsers open http://127.0.0.1:3003
+
 ### Configs
 
-| Key                                      | default          | Description                      |
-| ---------------------------------------- | ---------------- | -------------------------------- |
-| config/default.js **PORT**               | 3003             | the web app run port             |
-| config/default.js **API_VERSION**        | api/1.0          | the backend endpoint prefix      |
-| config/default.js **LOG_LEVEL**          | Debug            | the backend log level            |
-| src/environments/environments.ts **URI** | /backend/api/1.0 | the backend uri used in frontend |
+| Key                                             | default          | Description                      |
+| ----------------------------------------------- | ---------------- | -------------------------------- |
+| config/default.js **PORT**                      | 3003             | the web app run port             |
+| config/default.js **API_VERSION**               | api/1.0          | the backend endpoint prefix      |
+| config/default.js **LOG_LEVEL**                 | Debug            | the backend log level            |
+| config/default.js **defaultExternalConfigLink** | None             | the default external config link |
+| src/environments/environments.ts **URI**        | /backend/api/1.0 | the backend uri used in frontend |
 
 
 

app.js

@@ -1,69 +1,16 @@
-const config = require('config');
-const _ = require('lodash');
+const config = require('./config/default');
 
 const HApi = require('hapi');
-const routes = require('./lib/route');
 const logger = require('./lib/common/logger');
+const redisManagerPlugin = require('./lib');
 
 // Create a server with a host and port
-const server = HApi.server({
-  port: config.PORT,
-});
-
-
-/**
- * inject cors headers
- */
-const injectHeader = (h) => {
-  h.header("Access-Control-Allow-Origin", "*");
-  h.header("Access-Control-Allow-Methods", "GET,HEAD,OPTIONS,POST,PUT");
-  h.header("Access-Control-Allow-Headers", "If-Modified-Since, Origin, X-Requested-With, Content-Type, Accept, Authorization");
-  return h;
-};
-
-/**
- * inject routes
- */
-_.each(routes, (route, path) => {
-  const newPath = '/backend/' + config.API_VERSION + path;
-  server.route({method: 'options', path: newPath, handler: (req, h) => injectHeader(h.response('ok'))});
-  _.each(route, (handler, method) => {
-
-    logger.info(`endpoint added, [${method.toUpperCase()}] ${newPath}`);
-    server.route({
-      method,
-      path: newPath,
-      handler: async (req, h) => {
-        let result = {};
-        let status = 200;
-        try {
-          result = await handler.method(req, h);
-        } catch (e) {
-          result = {code: e.status, message: e.message}
-          status = e.status || 500;
-        }
-        return injectHeader(h.response(result).code(status));
-      }
-    });
-  });
-});
-
+const server = HApi.server({port: config.PORT});
 
 // Start the server
 async function start() {
   try {
-    await server.register(require('inert'));
-
-    // add static folder
-    server.route({
-      method: 'GET',
-      path: '/{param*}',
-      handler: {
-        directory: {
-          path: 'dist',
-        }
-      }
-    });
+    await server.register(redisManagerPlugin);
     await server.start();
   }
   catch (err) {

config/default.js

@@ -8,8 +8,34 @@
  * @version     1.0
  */
 
-module.exports = {
+const path = require('path');
+const fs = require('fs');
+const _ = require('lodash');
+
+let config = {
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
   PORT: process.env.PORT || 3003,
   API_VERSION: 'api/1.0',
+  WORK_ROOT: path.join(__dirname, '..'),
+  defaultExternalConfigLink: 'https://raw.githubusercontent.com/jiangliwu/static-files/master/config.json',
+  defaultExternalConfigFileName: 'defaultExternalCache.json',
+  externalConfigFileName: 'externalCache.json',
 };
+
+
+/**
+ * merge json config to config object
+ * @param fileName the config json file
+ */
+function mergeConfig(fileName) {
+  console.log('start check ' + fileName); // eslint-disable-line  here use console.log
+  if (fs.existsSync(path.join(__dirname, fileName))) {
+    const content = fs.readFileSync(path.join(__dirname, fileName));
+    config = _.extend({}, config, JSON.parse(content.toString()));
+  }
+}
+
+mergeConfig(config.defaultExternalConfigFileName);
+mergeConfig(config.externalConfigFileName);
+
+module.exports = config;

config/defaultExternalCache.json

@@ -0,0 +1,3 @@
+{
+  "LOG_LEVEL": "info"
+}

config/externalCache.json

@@ -0,0 +1,3 @@
+{
+  "LOG_LEVEL": "info"
+}

lib/common/external-config.js

@@ -0,0 +1,65 @@
+const request = require('request');
+const logger = require('../common/logger');
+const fs = require('fs');
+const config = require('config');
+const path = require('path');
+const pm2 = require('pm2');
+
+/**
+ * download config file from link
+ * @param url the config url link
+ * @param isDefault is it the default external config
+ * @return {Promise<void>}
+ */
+async function downloadExternalConfigFile(url, isDefault) {
+  logger.info('downloadExternalConfigFile ' + url);
+  return new Promise((resolve, reject) => {
+    request(url, function (error, response, body) {
+      if (error) {
+        logger.error(error);
+        return reject(error);
+      }
+      if (response && response.statusCode === 200) {
+        const filePath = path.join(config.WORK_ROOT, 'config',
+          isDefault ? config.defaultExternalConfigFileName : config.externalConfigFileName);
+        try {
+          fs.writeFileSync(filePath, JSON.stringify(JSON.parse(body), null, 2));
+        } catch (e) {
+          fs.writeFileSync(filePath, JSON.stringify({error: JSON.stringify(e)}));
+        }
+        logger.info('downloadExternalConfigFile succeed');
+        resolve();
+      } else {
+        logger.error('empty response from url or wrong status code');
+      }
+    });
+  });
+}
+
+
+/**
+ * refresh config
+ * @param url the config file link
+ * @return {Promise<void>}
+ */
+async function refreshConfig(url) {
+  await downloadExternalConfigFile(url, false);
+  return new Promise(((resolve, reject) => {
+    pm2.connect(function (err) {
+      if (err) {
+        return reject(err);
+      }
+      resolve({message: 'OK'});
+      pm2.reload('app', function (err) {
+        pm2.disconnect();
+        if (err) {
+          reject(err);
+        }
+      })
+    });
+  }));
+}
+
+module.exports = {
+  refreshConfig, downloadExternalConfigFile
+};

lib/common/git.js

@@ -0,0 +1,64 @@
+const git = require('git-last-commit');
+const config = require('config');
+const fs = require('fs');
+const path = require('path');
+const logger = require('./logger');
+
+const FILE_NAME = 'lastCommit.json';
+
+/**
+ * get last commit information from git command
+ * @return {Promise<*>}
+ */
+async function getLastCommit() {
+  return new Promise(((resolve, reject) => {
+    git.getLastCommit(function (err, commit) {
+      if (err) {
+        return reject(err);
+      }
+      resolve({
+        commitSha: commit.hash,
+        author: commit.author,
+        committedOn: new Date(commit.committedOn * 1000),
+        subject: commit.subject,
+        message: commit.body,
+        notes: commit.notes,
+      });
+    });
+  }))
+}
+
+/**
+ * create last commit json file
+ * @return {Promise<void>}
+ */
+async function generateLastCommitJson() {
+  try {
+    const lastCommit = await getLastCommit();
+    fs.writeFileSync(path.join(config.WORK_ROOT, FILE_NAME), JSON.stringify(lastCommit, null, 2));
+  } catch (e) {
+    logger.error('generateLastCommitJson failed');
+    logger.error(e);
+  }
+}
+
+/**
+ * get last commit from file, if not exist, it will try to create one
+ * @return {Promise<*>}
+ */
+async function getLastCommitFromFile() {
+  try {
+    if (!fs.existsSync(path.join(config.WORK_ROOT, FILE_NAME))) {
+      await generateLastCommitJson();
+    }
+    const content = fs.readFileSync(path.join(config.WORK_ROOT, FILE_NAME));
+    return JSON.parse(content.toString());
+  } catch (e) {
+    logger.error(e);
+    return e;
+  }
+}
+
+module.exports = {
+  generateLastCommitJson, getLastCommitFromFile
+};

lib/index.js

@@ -0,0 +1,62 @@
+const config = require('config');
+const routes = require('./route');
+const _ = require('lodash');
+const logger = require('./common/logger');
+
+module.exports = {
+  name: 'redis-manager-hapi-service',
+  version: '1.0.0',
+  register: async function (server, options) {
+
+    logger.debug('redis-manager-hapi-service plugin start init ...');
+
+    /**
+     * inject cors headers
+     */
+    const injectHeader = (h) => {
+      h.header('Access-Control-Allow-Origin', '*');
+      h.header('Access-Control-Allow-Methods', 'GET,HEAD,OPTIONS,POST,PUT');
+      h.header('Access-Control-Allow-Headers', 'If-Modified-Since, Origin, X-Requested-With, Content-Type, Accept, Authorization');
+      return h;
+    };
+
+    /**
+     * inject routes
+     */
+    _.each(routes, (route, path) => {
+      const newPath = '/backend/' + config.API_VERSION + path;
+      server.route({method: 'options', path: newPath, handler: (req, h) => injectHeader(h.response('ok'))});
+      _.each(route, (handler, method) => {
+
+        logger.info(`endpoint added, [${method.toUpperCase()}] ${newPath}`);
+        server.route({
+          method,
+          path: newPath,
+          handler: async (req, h) => {
+            let result = {};
+            let status = 200;
+            try {
+              result = await handler.method(req, h);
+            } catch (e) {
+              result = {code: e.status, message: e.message}
+              status = e.status || 500;
+            }
+            return injectHeader(h.response(result).code(status));
+          }
+        });
+      });
+    });
+
+    await server.register(require('inert'));
+    // add static folder
+    server.route({
+      method: 'GET',
+      path: '/{param*}',
+      handler: {
+        directory: {
+          path: 'dist',
+        }
+      }
+    });
+  }
+};

lib/route.js

@@ -11,6 +11,9 @@
 
 
 const redis = require('./redis');
+const git = require('./common/git');
+const externalConfig = require('./common/external-config');
+
 const logger = require('./common/logger');
 
 logger.buildService("RedisService", redis);
@@ -30,5 +33,15 @@ module.exports = {
     post: {
       method: async req => await redis.call(req.query, req.payload),
     }
-  }
+  },
+  '/healthCheck': {
+    get: {
+      method: async () => await git.getLastCommitFromFile(),
+    }
+  },
+  '/refreshConfig': {
+    post: {
+      method: async req => await externalConfig.refreshConfig(req.payload.externalFile),
+    }
+  },
 };

lib/tools/before-build.js

@@ -0,0 +1,5 @@
+const git = require('../common/git');
+
+(async () => {
+  await git.generateLastCommitJson();
+})();

lib/tools/before-start.js

@@ -0,0 +1,5 @@
+const config = require('config');
+const externalConfig = require('../common/external-config');
+(async () => {
+  await externalConfig.downloadExternalConfigFile(config.defaultExternalConfigLink, true);
+})();