✨✅add koa middleware and test case

Author: jun.zhua

.gitignore

@@ -44,4 +44,6 @@ bower_components/
 .tern-project
 cscope.*
 
+# nyc coverage
+.nyc_output/
 

README.md

@@ -1,19 +1,24 @@
 # HTTP Request Context
 
+[![npm package](https://nodei.co/npm/http-request-context.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/request/)
+
+[![npm package](https://img.shields.io/npm/v/http-request-context.svg?style=flat-square)](https://www.npmjs.org/package/http-request-context)
+[![NPM downloads](https://img.shields.io/npm/dm/http-request-context.svg?style=flat-square)](https://npmjs.org/package/http-request-context)
+[![Dependency Status](https://david-dm.org/zhujun24/http-request-context.svg?style=flat-square)](https://david-dm.org/zhujun24/http-request-context)
+
 Get and set request-scoped context anywhere.
 
 ## How to Use
 
 Install: `npm install http-request-context --save`
 
-### Init in middleware
+### Express
+
+#### Init
 
 ```js
-const express = require('express')
 const httpRequestContext = require('http-request-context')
 
-const app = express()
-
 app.use(httpRequestContext.middleware)
 ```
 
@@ -39,6 +44,41 @@ const httpRequestContext = require('http-request-context')
 httpRequestContext.get('foo') // 'bar'
 ```
 
+### Koa
+
+#### Init
+
+```js
+const httpRequestContext = require('http-request-context')
+
+app.use(httpRequestContext.koaMiddleware)
+```
+
+### Set Context
+
+```js
+const httpRequestContext = require('http-request-context')
+
+// set context by key-value
+app.use(async (ctx, next) => {
+  await new Promise(resolve => {
+    setTimeout(() => {
+      httpRequestContext.set('user', 'user')
+      resolve()
+    }, 300)
+  })
+  await next()
+})
+```
+
+### Get Context
+
+```js
+const httpRequestContext = require('http-request-context')
+
+httpRequestContext.get('foo') // 'bar'
+```
+
 ## Tips
 
 ### MySQL
@@ -60,3 +100,8 @@ util.promisify(mysqlConnection.query).bind(mysqlConnection)('SELECT * FROM table
   })
   .catch(error => {})
 ```
+
+## TODO
+
+- [ ] Get undefined in koa close callback
+- [ ] Get undefined in borderline case

example/express.js

@@ -1,40 +1,41 @@
 const util = require('util')
-const request = require('request')
 const express = require('express')
 const asyncHooks = require('async_hooks')
 const httpRequestContext = require('../')
 
-var app = express();
+var app = express()
 
-app.use(httpRequestContext.middleware);
+app.use(httpRequestContext.middleware)
 
 app.use((req, res, next) => {
-  const start = Date.now()
   res.on('close', () => {
     console.log('close', httpRequestContext.get('user'))
   })
   res.once('finish', () => {
-    console.log('finish', asyncHooks.executionAsyncId(), httpRequestContext.get('user'), req.query)
+    console.log('finish', asyncHooks.executionAsyncId(), httpRequestContext.get('user'))
   })
   next()
 })
 
 app.use((req, res, next) => {
-  httpRequestContext.set('user', 'user')
-  next();
-});
+  setTimeout(() => {
+    httpRequestContext.set('user', 'user')
+    next()
+  }, 300)
+})
 
 app.use((req, res, next) => {
   util.promisify(process.nextTick)().then(() => {
     httpRequestContext.set('age', '99')
-    next();
+    next()
   })
-});
+})
 
 app.all('*', (req, res) => {
-  request('https://www.baidu.com/', () => {
-    res.send(httpRequestContext.get('user'))
+  res.send({
+    user: httpRequestContext.get('user'),
+    age: httpRequestContext.get('age')
   })
 })
 
-app.listen(3001);
+app.listen(3001)

example/koa.js

@@ -0,0 +1,44 @@
+const util = require('util')
+const Koa = require('koa')
+const asyncHooks = require('async_hooks')
+const httpRequestContext = require('../')
+
+const app = new Koa()
+
+app.use(httpRequestContext.koaMiddleware)
+
+app.use(async (ctx, next) => {
+  ctx.req.on('close', () => {
+    console.log('close', httpRequestContext.get('user'))
+  })
+  ctx.res.on('finish', () => {
+    console.log('finish', asyncHooks.executionAsyncId(), httpRequestContext.get('user'))
+  })
+  await next()
+})
+
+app.use(async (ctx, next) => {
+  await new Promise(resolve => {
+    setTimeout(() => {
+      httpRequestContext.set('user', 'user')
+      resolve()
+    }, 300)
+  })
+  await next()
+})
+
+app.use(async (ctx, next) => {
+  await util.promisify(process.nextTick)().then(() => {
+    httpRequestContext.set('age', '99')
+  })
+  await next()
+})
+
+app.use(ctx => {
+  ctx.body = {
+    user: httpRequestContext.get('user'),
+    age: httpRequestContext.get('age')
+  }
+})
+
+app.listen(3002)

index.js

@@ -2,8 +2,8 @@ const asyncHooks = require('async_hooks')
 
 const contexts = {}
 const rootAsyncIdQueueMap = {}
-const INTERVAL = 1000
-const ID_TIMEOUT = 60000
+const INTERVAL = 10000
+const ID_TIMEOUT = 150000
 
 // delete asyncId map 60s ago every second
 const interval = () => {
@@ -30,15 +30,6 @@ const findRootId = (id) => {
   }
 }
 
-const removeAsyncId = id => {
-  Object.keys(contexts).forEach(cacheId => {
-    if (contexts[cacheId].id === id) {
-      delete contexts[cacheId]
-      removeAsyncId(cacheId)
-    }
-  })
-}
-
 asyncHooks.createHook({
   init (asyncId, type, triggerAsyncId) {
     contexts[asyncId] = {
@@ -77,6 +68,12 @@ module.exports = {
     rootAsyncIdQueueMap[executionAsyncId] = []
     next()
   },
+  koaMiddleware: async (ctx, next) => {
+    const executionAsyncId = asyncHooks.executionAsyncId()
+    contexts[executionAsyncId].data = {}
+    rootAsyncIdQueueMap[executionAsyncId] = []
+    await next()
+  },
   set: (key, value) => {
     const rootId = findRootId(asyncHooks.executionAsyncId())
     if (rootId) {

namespace.js

@@ -1,15 +1,23 @@
 {
   "name": "http-request-context",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Store context in http middleware lifecycle.",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "fix": "standard \"**/**.js\" --fix",
+    "lint": "standard \"**/**.js\"",
+    "test": "mocha --exit",
+    "coverage": "nyc --reporter=text --reporter=lcov npm test"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zhujun24/http-request-context.git"
   },
+  "pre-commit": [
+    "lint",
+    "test",
+    "coverage"
+  ],
   "keywords": [
     "http",
     "request",
@@ -22,7 +30,15 @@
   },
   "homepage": "https://github.com/zhujun24/http-request-context#readme",
   "devDependencies": {
+    "assert": "^2.0.0",
+    "chai": "^4.2.0",
+    "chai-http": "^4.3.0",
     "express": "^4.17.1",
-    "request": "^2.88.0"
+    "koa": "^2.8.1",
+    "mocha": "^6.2.0",
+    "nyc": "^14.1.1",
+    "pre-commit": "^1.2.2",
+    "request": "^2.88.0",
+    "standard": "^14.1.0"
   }
 }