init

Author: a632079

Readme.md

@@ -22,7 +22,7 @@
     },
     "redis": {
         "host": "127.0.0.1",
-        "port": 3306,
+        "port": 6379,
         "password": "",
         "database": 0
     },

config.example.json

@@ -14,14 +14,18 @@ const app = new Koa()
 const preStart = require('./src/prestart')
 preStart.load()
 
+// Load CronJob
+const cron = require('./src/cron')
+cron.load()
+
 // Register Middlewares (Plugins)
 async function registerMiddlewares () {
   try {
     const middlewares = require('./plugins')
     await middlewares.map((middleware, index, input) => {
       app.use(middleware)
     })
-    winston.debug('All Plugins Loads done.')
+    winston.verbose('All Plugins Load done.')
   } catch (e) {
     winston.error(e)
     // mail.error(e)
@@ -43,7 +47,7 @@ async function registerRoutes (routes) {
         // mail.error(err)
         process.exit(1)
       })
-    winston.debug('All Routes Loads done.')
+    winston.verbose('All Routes Load done.')
   } catch (e) {
     winston.error(e)
     // mail.error(e)

core.js

@@ -0,0 +1,8 @@
+// Register Cron Event
+module.exports = (cron) => {
+  // return true
+  return [
+    // Register cron
+    cron.countRequests
+  ]
+}

crons.js

@@ -1,7 +1,7 @@
 {
-  "name": "teng-koa",
-  "version": "0.0.1",
-  "description": "Simple & fast REST API Framework.",
+  "name": "Hitokoto-api",
+  "version": "1.0.0",
+  "description": "Fast & Powerful Hitokoto API Framework.",
   "main": "core.js",
   "engines": {
     "node": ">=8"
@@ -34,6 +34,7 @@
     "bytes": "^3.0.0",
     "chalk": "^2.3.0",
     "colors": "^1.1.2",
+    "cron": "^1.3.0",
     "humanize-number": "^0.0.2",
     "kcors": "^2.2.1",
     "koa": "^2.4.1",

img/screenshot.png

@@ -4,6 +4,7 @@ module.exports = [
   // MiddleWares
   require('./src/middlewares/requestId')(),
   require('./src/middlewares/responseHandler')(),
+  require('./src/middlewares/countRequest')(),
 
   // Basic Plugins
   require('koa-json')(),
@@ -16,7 +17,7 @@ module.exports = [
   require('kcors')({
     origin: '*',
     allowMethods: ['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH'],
-    exposeHeaders: ['X-Request-Id']
+    exposeHeaders: ['X-Request-Id', 'X-Api-Token'] // Need Api-token
   }),
   require('koa-favicon')(path.join(__dirname, './public/favicon.ico')),
   require('koa-compress')({

package.json

@@ -0,0 +1,9 @@
+# Hitokoto API
+目前该项目是针对 Hitokoto V1 的 PHP 框架的重新实现。
+同时更新了以下功能:
+* API 请求统计
+
+## 开始使用
+1. `cp config.example.json config.json` 并配置好相关信息
+2. `yarn --production`
+3. `yarn start` 

plugins.js

@@ -9,5 +9,6 @@ module.exports = (router, controller) => {
   })
 
   router.get('/test', controller.hello.index)
+  router.get('/status', controller.status.status)
   return router
 }

readme.md

@@ -1,28 +1,31 @@
 'use strict'
+// Import Packages
 const nconf = require('nconf')
 const bluebrid = require('bluebird')
 const winston = require('winston')
-const redis = require('redis')
 // Promisify Redis
-bluebrid.promisifyAll(redis.RedisClient.prototype)
-bluebrid.promisifyAll(redis.Multi.prototype)
+const redis = bluebrid.promisifyAll(require('redis'))
 
 class cache {
   static connect () {
-    if (this.redis) {
+    if (this.hasOwnProperty('redis')) {
       return true
     } else {
       // Get Config
       const config = {
         host: nconf.get('redis:host') || '127.0.0.1',
-        port: nconf.get('redis:port') || 3306,
-        password: nconf.get('redis:password') || '',
+        port: nconf.get('redis:port') || 6379,
+        password: nconf.get('redis:password') && nconf.get('redis:password') !== '' ? nconf.get('redis:password') : false,
         db: nconf.get('redis:database') || 0
       }
+      if (!config.password) {
+        delete config.password
+      }
       // Connect Redis
       this.redis = redis.createClient(config)
       this.redis.on('error', err => {
         winston.error(err)
+        process.exit(1)
       })
       return true
     }
@@ -36,7 +39,11 @@ class cache {
 
   static set (key, value, time) {
     this.connect()
-    return this.redis.setAsync('cache:' + key, value, 'EX', time)
+    if (time) {
+      return this.redis.setAsync('cache:' + key, value, 'EX', time)
+    } else {
+      return this.redis.setAsync('cache:' + key, value)
+    }
   }
 
   static get (key) {

routes.js

@@ -0,0 +1,45 @@
+'use strict'
+const path = require('path')
+const cache = require(path.join(__dirname, '../cache'))
+const winston = require('winston')
+async function getRequests () {
+  const requests = await cache.get('requests')
+  return requests
+}
+
+async function getPastMinute () {
+  const ts = parseInt(Date.now().toString().slice(0, 10)) - 60
+  const requests = await cache.get('requests:count:' + ts.toString())
+  return requests
+}
+
+async function getPastHour () {
+  const ts = parseInt(Date.now().toString().slice(0, 10)) - 60 * 60
+  const requests = await cache.get('requests:count:' + ts.toString())
+  return requests
+}
+
+async function getPastDay () {
+  const ts = parseInt(Date.now().toString().slice(0, 10)) - 60 * 60 * 24
+  const requests = await cache.get('requests:count:' + ts.toString())
+  return requests
+}
+
+module.exports = {
+  status: async (ctx, next) => {
+    const now = await getRequests()
+    const pastMinute = await getPastMinute()
+    const pastHour = await getPastHour()
+    const pastDay = await getPastDay()
+    ctx.body = {
+      requests: {
+        all: parseInt(now),
+        pastMinute: parseInt(now) - parseInt(pastMinute),
+        pastHour: parseInt(now) - parseInt(pastHour),
+        pastDay: parseInt(now) - parseInt(pastDay)
+      },
+      now: new Date(Date.now()).toString(),
+      ts: Date.now()
+    }
+  }
+}

src/cache.js

@@ -0,0 +1,60 @@
+'use strict'
+// Import Packages
+const winston = require('winston')
+const path = require('path')
+const fs = require('fs')
+const colors = require('colors/safe')
+const CronJob = require('cron').CronJob
+
+// Load Cron
+class cron {
+  static async load () {
+    try {
+      // load crons
+      let crons = await this.autoLoad()
+      const cronMap = require(path.join(__dirname, '../crons.js'))(crons)
+      if (cronMap === true) {
+        // AutoLoad All Crons
+        crons = await this.autoLoad(true)
+        await crons.map((item, index, input) => {
+          // Register CronJob
+          const job = new CronJob(item[0], item[1], item[2], item[3], item[4])
+          job.start()
+        })
+        winston.verbose('All Cron Jobs Load done.')
+      } else {
+        await cronMap.map((item, index, input) => {
+          // Register CronJob
+          const job = new CronJob(item[0], item[1], item[2], item[3], item[4])
+          job.start()
+        })
+        winston.verbose('All Cron Jobs Load done.')
+      }
+    } catch (e) {
+      winston.error(colors.red(e))
+      process.exit(1)
+    }
+  }
+
+  static async autoLoad (isArray) {
+    try {
+      // Load Crons
+      let crons = {}
+      const dir = fs.readdirSync(path.join(__dirname, '../', './src/crons'))
+      if (isArray) {
+        await dir.map((item, index, input) => {
+          crons[index] = module.parent.require(path.join(__dirname, '../', './src/crons/' + item))
+        })
+      } else {
+        await dir.map((item, index, input) => {
+          crons[item.substring(0, item.length - 3)] = module.parent.require(path.join(__dirname, '../', './src/crons/' + item))
+        })
+      }
+      return crons
+    } catch (e) {
+      winston.error(colors.red(e))
+      process.exit(1)
+    }
+  }
+}
+module.exports = cron

src/controllers/status.js

@@ -0,0 +1,37 @@
+'use strict'
+// Import Packages
+const winston = require('winston')
+const path = require('path')
+const cache = require(path.join(__dirname, '../cache'))
+
+function saveCount (ts, count) {
+  cache.set('requests:count:' + ts, count, 60 * 60 * 25)
+    .catch(err => {
+      winston.error(err)
+      saveCount(ts, count)
+    })
+}
+
+module.exports = [
+  '* * * * * *', // Cron Config
+  () => {
+    // Do something
+    cache.get('requests')
+      .then(requests => {
+        const request = requests ? parseInt(requests) : 0
+        const ts = Date.now().toString().slice(0, 10)
+        saveCount(ts, request)
+        winston.debug('Save Count to Cache. Requests: ' + request)
+      })
+      .catch(err => {
+        winston.error(err)
+      })
+  },
+  () => {
+    // This function is executed when the job stops
+    winston.error('Count Requests job is stopped. Kill process.')
+    process.exit(1)
+  },
+  true, // Start the job right now,
+  'Asia/Shanghai' // Timezone
+]

src/cron.js

@@ -0,0 +1,24 @@
+'use strict'
+
+function countRequest () {
+  const path = require('path')
+  const cache = require(path.join(__dirname, '../', 'cache'))
+  const winston = require('winston')
+  return async (ctx, next) => {
+    await next()
+    // Wait Request Done
+    await cache.get('requests')
+      .then(requests => {
+        requests = requests || '0'
+        cache.set('requests', parseInt(requests) + 1)
+          .catch(err => {
+            winston.error(err)
+          })
+      })
+      .catch(err => {
+        winston.error(err)
+      })
+  }
+}
+
+module.exports = countRequest

src/crons/countRequests.js

@@ -468,6 +468,12 @@ core-util-is@~1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"
 
+cron@^1.3.0:
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/cron/-/cron-1.3.0.tgz#7e459968eaf94e1a445be796ce402166c234659d"
+  dependencies:
+    moment-timezone "^0.5.x"
+
 cross-spawn@^4:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-4.0.2.tgz#7b9247621c23adfdd3856004a823cbe397424d41"
@@ -1607,7 +1613,7 @@ mocha@^5.0.0:
     mkdirp "0.5.1"
     supports-color "4.4.0"
 
-moment-timezone@^0.5.4:
+moment-timezone@^0.5.4, moment-timezone@^0.5.x:
   version "0.5.14"
   resolved "https://registry.yarnpkg.com/moment-timezone/-/moment-timezone-0.5.14.tgz#4eb38ff9538b80108ba467a458f3ed4268ccfcb1"
   dependencies: