initial commit

Author: ksmacleod99

.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,39 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+
+# dependencies
+/node_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db

README.md

@@ -0,0 +1,68 @@
+# Redis manager
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.1.4.
+
+### Dependencies
+
+- Node 8.11.x , npm 5.6.x
+- redis 4.x
+
+### Redis
+
+- follow here https://redis.io/download download and compile redis server  or follow this commands
+
+  ```
+  $ wget http://download.redis.io/releases/redis-4.0.11.tar.gz
+  $ tar xzf redis-4.0.11.tar.gz
+  $ cd redis-4.0.11
+  $ make
+  ```
+
+- start up redis server `cd src` `./redis-server`
+- 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 browers 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 |
+
+
+
+###  Additional document
+
+- Frontend 
+
+  - Angular 6
+  - Angular Material https://material.angular.io/
+  - Material Icons https://material.io/tools/icons/?style=baseline
+
+- Backend
+
+  - express
+  - ioredis https://github.com/luin/ioredis
+
+- Commands
+
+  - what commands are included ? 
+
+    INFO,GET,SET,RPUSH,SADD,ZADD,HMSET,LRANGE,ZRANGE,SMEMBERS,HGETALL,LLEN, SCARD, ZCARD,HLEN
+
+  - what commands should be added next?
+
+    - SREM remove one element from set
+    - ZREM remove one element from ordered set
+    - HSET, HMSET, HDEL, update/delete single/values from hash map
+    - Other commands may need accroding to functions.
+
+  - which commands are dependent on one another?
+
+    a web app function  dependent a lot of command, so, in fact, there is no command dependent on one another command.

angular.json

@@ -0,0 +1,104 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "redis-manager": {
+      "root": "",
+      "sourceRoot": "src",
+      "projectType": "application",
+      "prefix": "app",
+      "schematics": {
+        "@schematics/angular:component": {
+          "styleext": "scss"
+        }
+      },
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "dist",
+            "index": "src/index.html",
+            "main": "src/main.ts",
+            "polyfills": "src/polyfills.ts",
+            "tsConfig": "src/tsconfig.app.json",
+            "assets": [
+              "src/favicon.ico",
+              "src/assets"
+            ],
+            "styles": [
+              "src/styles.scss"
+            ],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.prod.ts"
+                }
+              ],
+              "optimization": true,
+              "outputHashing": "all",
+              "sourceMap": false,
+              "extractCss": true,
+              "namedChunks": false,
+              "aot": true,
+              "extractLicenses": true,
+              "vendorChunk": false,
+              "buildOptimizer": true
+            }
+          }
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "browserTarget": "redis-manager:build"
+          },
+          "configurations": {
+            "production": {
+              "browserTarget": "redis-manager:build:production"
+            }
+          }
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "redis-manager:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "src/test.ts",
+            "polyfills": "src/polyfills.ts",
+            "tsConfig": "src/tsconfig.spec.json",
+            "karmaConfig": "src/karma.conf.js",
+            "styles": [
+              "src/styles.scss"
+            ],
+            "scripts": [],
+            "assets": [
+              "src/favicon.ico",
+              "src/assets"
+            ]
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "src/tsconfig.app.json",
+              "src/tsconfig.spec.json"
+            ],
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "defaultProject": "redis-manager"
+}

app.js

@@ -0,0 +1,86 @@
+/**
+ * Copyright (C) 2017 TopCoder Inc., All Rights Reserved.
+ */
+/**
+ * The application entry point
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+
+
+
+
+const express = require('express');
+const cross = require('cors');
+const bodyParser = require('body-parser');
+const _ = require('lodash');
+const config = require('config');
+const http = require('http');
+const path = require('path');
+const logger = require('./lib/common/logger');
+const errorMiddleware = require('./lib/common/error.middleware');
+const routes = require('./lib/route');
+
+const app = express();
+const httpServer = http.Server(app);
+
+
+app.set('port', config.PORT);
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({extended: true}));
+app.use(cross());
+const apiRouter = express.Router({});
+
+// load all routes
+_.each(routes, (verbs, url) => {
+  _.each(verbs, (def, verb) => {
+    let actions = [];
+
+    const {method} = def;
+    if (!method) {
+      throw new Error(`${verb.toUpperCase()} ${url} method is undefined`);
+    }
+    if (def.middleware && def.middleware.length > 0) {
+      actions = actions.concat(def.middleware);
+    }
+
+    actions.push(async (req, res, next) => {
+      try {
+        await method(req, res, next);
+      } catch (e) {
+        next(e);
+      }
+    });
+
+    const middlewares = [];
+    for (let i = 0; i < actions.length - 1; i += 1) {
+      if (actions[i].name.length !== 0) {
+        middlewares.push(actions[i].name);
+      }
+    }
+
+    logger.info(`Endpoint discovered : [${middlewares.join(',')}] ${verb.toLocaleUpperCase()} /${config.API_VERSION}${url}`);
+    apiRouter[verb](`/${config.API_VERSION}${url}`, actions);
+  });
+});
+app.use('/backend/', apiRouter);
+app.use(errorMiddleware());
+
+// Serve static assets
+app.use(express.static(path.resolve(__dirname, 'dist')));
+// Always return the main index.html
+app.get('/', (req, res) => {
+  res.sendFile(path.resolve(__dirname, 'dist', 'index.html'));
+});
+
+
+(async () => {
+  if (!module.parent) { // this code will never run in unit test mode
+    httpServer.listen(app.get('port'), () => {
+      logger.info(`Express server listening on port ${app.get('port')}`);
+    });
+  } else {
+    module.exports = app;
+  }
+})();

config/default.js

@@ -0,0 +1,15 @@
+/**
+ * Copyright (C) 2017 TopCoder Inc., All Rights Reserved.
+ */
+/**
+ * the default config
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+
+module.exports = {
+  LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
+  PORT: process.env.PORT || 3003,
+  API_VERSION: 'api/1.0',
+};

config/production.js

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) 2017 Topcoder Inc, All rights reserved.
+ */
+
+
+/**
+ * The production configuration file.
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+
+module.exports = {
+  LOG_LEVEL: process.env.LOG_LEVEL || 'info',
+};

lib/common/error.middleware.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright (C) 2018 TopCoder Inc., All Rights Reserved.
+ */
+/* eslint-disable no-unused-vars */
+
+/**
+ * Common error handling middleware
+ *
+ * @author      TCSCODER
+ * @version     1.0
+ */
+const logger = require('./logger');
+
+const DEFAULT_MESSAGE = 'Something is broken at API server-side.';
+
+/**
+ * The error middleware function
+ *
+ * @param  {Object}     err       the error that is thrown in the application
+ * @param  {Object}     req       the express request instance
+ * @param  {Object}     res       the express response instance
+ * @param  {Function}   next      the next middleware in the chain
+ */
+function middleware(err, req, res, next) {
+  logger.logFullError(err);
+
+  if (err.isJoi) {
+    res.status(400).json({message: err.details[0].message});
+  } else if (err.errors) {
+    res.status(400).json({message: err.errors});
+  } else {
+    const status = err.status || 500;
+    const message = err.message || DEFAULT_MESSAGE;
+    res.status(status).json({message});
+  }
+}
+
+module.exports = () => middleware;