ISSUE-7 - fix middleware for inclusive paths

.mocharc.yaml

@@ -0,0 +1,4 @@
+recursive: true
+require:
+  - chai/register-expect
+  - ./test/globals.js

.npmignore

@@ -1,13 +1,15 @@
 .idea/
-*.iml
+.nyc_output/
 coverage/
-test/
+docs/
 examples/
-.nyc_output/
+test/
 .editorconfig
 .eslintignore
 .eslintrc.yaml
-.npmignore
 .nvmrc
 .nycrc
-README.hbs
+.mocharc.yaml
+.npmignore
+.travis.yml
+*.iml

docs/CONTRIBUTING.md

@@ -16,11 +16,5 @@ If you have node installed, `$ npm install` and you are ready to go.
 
 Before submitting pull request, you can `$ npm run preversion`. It will:
 
- * audit package.json dependencies (we use [nsp](https://nodesecurity.io/)),
  * lint the code (we use [eslint](https://eslint.org/) and [@smartrecruiters/eslint-config](https://www.npmjs.com/package/@smartrecruiters/eslint-config) and [eslint-plugin-security](https://github.com/nodesecurity/eslint-plugin-security)),
  * test the code and check coverage (we use [mocha](https://mochajs.org/), [chai](http://www.chaijs.com/api/bdd/), [sinon](http://sinonjs.org/) and [istanbul](https://istanbul.js.org/)),
- * regenerate README.md (we use [jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown)).
-
-## Fixing README.md
-
-Project's readme is generated using [docs/docs.hbs](docs/docs.hbs), so please modify this file.

lib/middleware-once-per-req.js

@@ -0,0 +1,14 @@
+const uuid = require('uuid')
+
+module.exports = () => {
+    const middlewareId = uuid()
+
+    return middleware => (req, res, next) => {
+        req._openApiFirst = req._openApiFirst || {usedMiddlewares: []}
+        if (req._openApiFirst.usedMiddlewares.includes(middlewareId)) {
+            return next()
+        }
+        req._openApiFirst.usedMiddlewares.push(middlewareId)
+        middleware(req, res, next)
+    }
+}

openapi/app.js

@@ -1,9 +1,9 @@
 const {forOwn, cloneDeep, unionBy} = require('lodash')
 
 const pathUtils = require('./path')
-const httpMethods = require('./http-methods')
 const {uniquenessCriterion} = require('./parameters')
 
+const middlewareOncePerReq = require('../lib/middleware-once-per-req')
 const refResolver = require('../lib/utils/ref-resolver')
 
 module.exports = function (app, spec) {
@@ -12,12 +12,14 @@ module.exports = function (app, spec) {
 
     return {
         use: openApiMiddleware => {
+            const oncePerReq = middlewareOncePerReq()
+
             forOwn(spec.paths, (pathItem, path) => {
 
                 const defaultParams = pathItem.parameters && pathItem.parameters.map(resolveRef)
 
                 forOwn(pathItem, (value, key) => {
-                    if (!httpMethods.is(key)) {
+                    if (!value.operationId) {
                         return
                     }
 
@@ -31,7 +33,7 @@ module.exports = function (app, spec) {
 
                     const middleware = openApiMiddleware(operation, {spec})
                     if (middleware) {
-                        app[key](pathUtils.toRoutePath(path), middleware)
+                        app[key](pathUtils.toRoutePath(path), oncePerReq(middleware))
                     }
                 })
             })

package.json

@@ -12,16 +12,16 @@
     "node": ">=6.0.0"
   },
   "dependencies": {
-    "lodash": "4.17.11",
-    "type-is": "1.6.18"
+    "lodash": "4.17.14",
+    "type-is": "1.6.18",
+    "uuid": "3.3.2"
   },
   "devDependencies": {
     "@smartrecruiters/eslint-config": "4.3.0",
     "chai": "4.2.0",
     "eslint": "5.16.0",
     "eslint-plugin-security": "1.4.0",
     "express": "4.17.1",
-    "jsdoc-to-markdown": "5.0.0",
     "mocha": "6.1.4",
     "nyc": "14.1.1",
     "sinon": "7.3.2"
@@ -30,7 +30,6 @@
     "lint": "eslint .",
     "test": "mocha",
     "test:coverage": "nyc mocha",
-    "readme": "jsdoc2md --template docs/docs.hbs middlewares/**/*.js openapi/*.js > README.md",
-    "preversion": "npm run lint && npm run test:coverage && npm run readme"
+    "preversion": "npm run lint && npm run test:coverage"
   }
 }

test/app.spec.js

@@ -9,14 +9,19 @@ describe('api', () => {
                     {in: 'query', name: 'p'}
                 ],
                 get: {
+                    operationId: 'a',
                     requestBody: {},
                     parameters: [{in: 'query', name: 'p'}]
                 }
             },
             '/b': {
                 parameters: [],
-                get: {},
-                post: {}
+                get: {
+                    operationId: 'b1'
+                },
+                post: {
+                    operationId: 'b2'
+                }
             },
             requestBody: {}
         },
@@ -25,16 +30,17 @@ describe('api', () => {
     it('should add middleware to app', () => {
         // given
         const app = {get: sinon.spy(), post: sinon.spy()}
-        const middlewareA = () => 'A'
-        const middlewareB = () => undefined
+        const middlewareA = sinon.fake.returns('A')
+        const middlewareB = sinon.fake()
 
         // when
         openApi(app, spec).use(middlewareA)
         openApi(app, spec).use(middlewareB)
 
         // then
-        sinon.assert.calledWith(app.get, '/a', middlewareA())
-        sinon.assert.calledWith(app.get, '/b', middlewareA())
-        sinon.assert.calledWith(app.post, '/b', middlewareA())
+        sinon.assert.calledThrice(middlewareA)
+        sinon.assert.calledWithMatch(app.get, '/a', sinon.match.func)
+        sinon.assert.calledWithMatch(app.get, '/b', sinon.match.func)
+        sinon.assert.calledWithMatch(app.post, '/b', sinon.match.func)
     })
 })

test/globals.js

@@ -1,6 +1,3 @@
-const chai = require('chai')
 const sinon = require('sinon')
 
-global.chai = chai
-global.expect = chai.expect
 global.sinon = sinon

test/lib/middleware-once-per-path.spec.js

@@ -0,0 +1,21 @@
+const MiddlewareOncePerReq = require('../../lib/middleware-once-per-req')
+
+describe('openapi middleware', () => {
+
+    it('should be run once for the same request', () => {
+        // given
+        const middleware = sinon.spy()
+        const next = sinon.spy()
+        const req = {}
+
+        // when
+        const wrappedMiddleware = MiddlewareOncePerReq()(middleware)
+        wrappedMiddleware(req, undefined, next)
+        wrappedMiddleware(req, undefined, next)
+
+        // then
+        sinon.assert.callOrder(middleware, next)
+        sinon.assert.calledOnce(middleware)
+        sinon.assert.calledOnce(next)
+    })
+})