feat: add validator middleware

closes #4

Author: antongolub

README.md

@@ -19,6 +19,7 @@ npm i @qiwi/mware
 * [mware-logger](./packages/mware-logger/README.md)
 * [mware-crumbs](./packages/mware-crumbs/README.md)
 * [mware-cors](./packages/mware-cors/README.md)
+* [mware-validator](./packages/mware-validator/README.md)
 
 ### Usage
 ```javascript

packages/mware-validator/.babelrc

@@ -0,0 +1,35 @@
+{
+  "comments": false,
+  "ignore": [
+    "interface.js"
+  ],
+  "presets": [
+    "@babel/preset-flow"
+  ],
+  "env": {
+    "production": {
+      "presets": [
+        "@babel/preset-flow",
+        ["@babel/preset-env", {
+          "modules": false
+        }]
+      ],
+      "plugins": [
+        "@babel/plugin-transform-modules-commonjs",
+        "@babel/plugin-proposal-class-properties",
+        "@babel/plugin-proposal-object-rest-spread"
+      ]
+    },
+    "test": {
+      "presets": [
+        "@babel/preset-flow",
+        "@babel/preset-env"
+      ],
+      "plugins": [
+        "@babel/plugin-transform-modules-commonjs",
+        "@babel/plugin-proposal-class-properties",
+        "@babel/plugin-proposal-object-rest-spread"
+      ]
+    }
+  }
+}

packages/mware-validator/README.md

@@ -0,0 +1,41 @@
+# @qiwi/mware-validator
+JSON-schema based validator middleware
+
+### Install
+```bash
+yarn add @qiwi/mware-validator
+npm i @qiwi/mware-validator
+```
+
+### Usage
+
+```javascript
+import validator from '@qiwi/mware-validator'
+import express from 'express'
+
+const app = express()
+const schema = {
+  type: 'object',
+  properties: {
+    params: {
+      id: {
+        type: 'string',
+        pattern: '[abc]^\d{2}',
+        required: true
+      }
+    },
+    query: {
+      data: {
+        type: 'object',
+        required: true
+      }
+    }
+  }
+}
+app.get('/foo/:id', validator({schema}), (req, res) => {
+  ...
+  res.send({...})
+})
+
+app.listen(...)
+```

packages/mware-validator/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@qiwi/mware-validator",
+  "version": "1.3.0",
+  "private": false,
+  "description": "JSON-schema based validator middleware",
+  "main": "dist/es5/index.js",
+  "files": [
+    "README.md",
+    "CHANGELOG.md",
+    "dist/"
+  ],
+  "scripts": {
+    "build_es6": "flow-remove-types src/ --out-dir dist/es6/",
+    "build_es5": "BABEL_ENV=production babel src --out-dir dist/es5/",
+    "build": "rm -rf dist && npm run build_es6 && npm run build_es5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/qiwi/mware.git"
+  },
+  "keywords": [
+    "common middlewares"
+  ],
+  "author": "Anton Golub <a.golub@qiwi.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/qiwi/mware/issues"
+  },
+  "homepage": "https://github.com/qiwi/mware#readme",
+  "dependencies": {
+    "ajv": "^6.5.5",
+    "http-status-codes": "^1.3.0"
+  },
+  "devDependencies": {
+    "lodash": "^4.17.11",
+    "reqresnext": "^1.5.1"
+  }
+}

packages/mware-validator/src/index.js

@@ -0,0 +1,45 @@
+// @flow
+
+import type {
+  IMiddlewareFactory,
+  IRegularMiddleware,
+  IRequest,
+  IResponse,
+  INext, IAny
+} from '../../mware-core/src/interface'
+import Ajv from 'ajv'
+import { BAD_REQUEST, getStatusText } from 'http-status-codes'
+
+const ajv = new Ajv()
+
+export type IOpts = {
+  schema: {
+    [key: string]: IAny
+  },
+  scheme?: {
+    [key: string]: IAny
+  }
+}
+
+export const DEFAULT_SCHEMA: IOpts = {
+  schema: {}
+}
+
+export default ((opts?: IOpts) => {
+  const {schema, scheme} = opts || DEFAULT_SCHEMA
+
+  return ((req: IRequest, res: IResponse, next: INext) => {
+    if (!ajv.validate(schema || scheme, req)) {
+      res
+        .status(BAD_REQUEST)
+        .send({
+          message: getStatusText(BAD_REQUEST),
+          details: ajv.errorsText()
+        })
+
+      return
+    }
+
+    next()
+  }: IRegularMiddleware)
+}: IMiddlewareFactory)

packages/mware-validator/test/index.js

@@ -0,0 +1,83 @@
+import factory from '../src'
+import reqresnext from 'reqresnext'
+import {BAD_REQUEST} from 'http-status-codes'
+
+describe('mware-validator', () => {
+  beforeEach(() => {
+    jest.resetAllMocks()
+  })
+
+  it('factory returns a middleware', () => {
+    expect(factory()).toEqual(expect.any(Function))
+  })
+})
+
+describe('validates request fields by scheme', () => {
+  const scheme = {
+    type: 'object',
+    required: ['headers', 'params', 'query', 'body'],
+    properties: {
+      headers: {
+        type: 'object',
+        required: ['foo'],
+        properties: {
+          foo: {
+            type: 'string'
+          }
+        }
+      },
+      params: {
+        type: 'object',
+        required: ['baz'],
+        properties: {
+          baz: {
+            type: 'string'
+          }
+        }
+      },
+      query: {
+        type: 'object',
+        required: ['quxx'],
+        properties: {
+          quxx: {
+            type: 'string'
+          }
+        }
+      },
+      body: {
+        type: 'string'
+      }
+    }
+  }
+
+  const mware = factory({scheme})
+
+  it('proceeds to `next` if valid', () => {
+    const { req, res, next } = reqresnext({
+      headers: {
+        foo: 'bar'
+      },
+      params: {
+        baz: 'qux'
+      },
+      query: {
+        quxx: 'buzz'
+      },
+      body: 'FooBarBaz'
+    }, null, jest.fn())
+
+    mware(req, res, next)
+
+    expect(next).toHaveBeenCalled()
+  })
+
+  it('returns 404 otherwise', () => {
+    const { req, res, next } = reqresnext(null, null, jest.fn())
+
+    mware(req, res, next)
+
+    expect(res.body).toBe("{\"message\":\"Bad Request\",\"details\":\"data.headers should have required property 'foo'\"}")
+    expect(res.statusCode).toBe(BAD_REQUEST)
+    expect(next).not.toHaveBeenCalled()
+  })
+})

packages/mware/README.md

@@ -12,6 +12,7 @@ npm i @qiwi/mware
 * [mware-logger](../mware-logger/README.md)
 * [mware-crumbs](../mware-crumbs/README.md)
 * [mware-cors](../mware-cors/README.md)
+* [mware-validator](../mware-validator/README.md)
 
 ### Usage
 

packages/mware/src/index.js

@@ -2,13 +2,15 @@ import mdc from '@qiwi/mware-mdc'
 import logger from '@qiwi/mware-logger'
 import crumbs from '@qiwi/mware-crumbs'
 import cors from '@qiwi/mware-cors'
+import validator from '@qiwi/mware-validator'
 import { util } from '@qiwi/mware-core'
 
 export {
   mdc,
   logger,
   cors,
   crumbs,
+  validator,
   util
 }
 
@@ -17,5 +19,6 @@ export default {
   logger,
   cors,
   crumbs,
+  validator,
   util
 }

packages/mware/test/index.js

@@ -1,11 +1,12 @@
-import {mdc, logger, util, cors, crumbs} from '../src'
+import {mdc, logger, util, cors, crumbs, validator} from '../src'
 
 describe('mware', () => {
   it('exposes middlewares collection', () => {
     expect(mdc).toEqual(expect.any(Function))
     expect(logger).toEqual(expect.any(Function))
     expect(cors).toEqual(expect.any(Function))
     expect(crumbs).toEqual(expect.any(Function))
+    expect(validator).toEqual(expect.any(Function))
     expect(util).not.toBeUndefined()
   })
 })

yarn.lock

@@ -2648,7 +2648,7 @@ debug@^4.0.0, debug@^4.0.1:
   dependencies:
     ms "^2.1.1"
 
-debuglog@*, debuglog@^1.0.1:
+debuglog@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debuglog/-/debuglog-1.0.1.tgz#aa24ffb9ac3df9a2351837cfb2d279360cd78492"
 
@@ -4324,7 +4324,7 @@ import-local@^1.0.0:
     pkg-dir "^2.0.0"
     resolve-cwd "^2.0.0"
 
-imurmurhash@*, imurmurhash@^0.1.4:
+imurmurhash@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea"
 
@@ -5526,39 +5526,17 @@ lockfile@^1.0.4:
   dependencies:
     signal-exit "^3.0.2"
 
-lodash._baseindexof@*:
-  version "3.1.0"
-  resolved "https://registry.yarnpkg.com/lodash._baseindexof/-/lodash._baseindexof-3.1.0.tgz#fe52b53a1c6761e42618d654e4a25789ed61822c"
-
 lodash._baseuniq@~4.6.0:
   version "4.6.0"
   resolved "https://registry.yarnpkg.com/lodash._baseuniq/-/lodash._baseuniq-4.6.0.tgz#0ebb44e456814af7905c6212fa2c9b2d51b841e8"
   dependencies:
     lodash._createset "~4.0.0"
     lodash._root "~3.0.0"
 
-lodash._bindcallback@*:
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/lodash._bindcallback/-/lodash._bindcallback-3.0.1.tgz#e531c27644cf8b57a99e17ed95b35c748789392e"
-
-lodash._cacheindexof@*:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/lodash._cacheindexof/-/lodash._cacheindexof-3.0.2.tgz#3dc69ac82498d2ee5e3ce56091bafd2adc7bde92"
-
-lodash._createcache@*:
-  version "3.1.2"
-  resolved "https://registry.yarnpkg.com/lodash._createcache/-/lodash._createcache-3.1.2.tgz#56d6a064017625e79ebca6b8018e17440bdcf093"
-  dependencies:
-    lodash._getnative "^3.0.0"
-
 lodash._createset@~4.0.0:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/lodash._createset/-/lodash._createset-4.0.3.tgz#0f4659fbb09d75194fa9e2b88a6644d363c9fe26"
 
-lodash._getnative@*, lodash._getnative@^3.0.0:
-  version "3.9.1"
-  resolved "https://registry.yarnpkg.com/lodash._getnative/-/lodash._getnative-3.9.1.tgz#570bc7dede46d61cdcde687d65d3eecbaa3aaff5"
-
 lodash._reinterpolate@~3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/lodash._reinterpolate/-/lodash._reinterpolate-3.0.0.tgz#0ccf2d89166af03b3663c796538b75ac6e114d9d"
@@ -5595,10 +5573,6 @@ lodash.isstring@^4.0.1:
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/lodash.isstring/-/lodash.isstring-4.0.1.tgz#d527dfb5456eca7cc9bb95d5daeaf88ba54a5451"
 
-lodash.restparam@*:
-  version "3.6.1"
-  resolved "https://registry.yarnpkg.com/lodash.restparam/-/lodash.restparam-3.6.1.tgz#936a4e309ef330a7645ed4145986c85ae5b20805"
-
 lodash.sortby@^4.7.0:
   version "4.7.0"
   resolved "https://registry.yarnpkg.com/lodash.sortby/-/lodash.sortby-4.7.0.tgz#edd14c824e2cc9c1e0b0a1b42bb5210516a42438"
@@ -7323,7 +7297,7 @@ readable-stream@~2.1.5:
     string_decoder "~0.10.x"
     util-deprecate "~1.0.1"
 
-readdir-scoped-modules@*, readdir-scoped-modules@^1.0.0:
+readdir-scoped-modules@^1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/readdir-scoped-modules/-/readdir-scoped-modules-1.0.2.tgz#9fafa37d286be5d92cbaebdee030dc9b5f406747"
   dependencies: