@coding-blocks/jsonapi-server
Version:
A config driven NodeJS framework implementing json:api
690 lines (689 loc) • 26 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for lib/router.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../prettify.css" />
<link rel="stylesheet" href="../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../index.html">All files</a> / <a href="index.html">lib</a> router.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">20.91% </span>
<span class="quiet">Statements</span>
<span class='fraction'>23/110</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Branches</span>
<span class='fraction'>0/52</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Functions</span>
<span class='fraction'>0/20</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">21.9% </span>
<span class="quiet">Lines</span>
<span class='fraction'>23/105</span>
</div>
</div>
</div>
<div class='status-line low'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209</td><td class="line-coverage quiet"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">'use strict'
const router = module.exports = { }
const _ = {
assign: require('lodash.assign'),
omit: require('lodash.omit')
}
const express = require('express')
let app
let server
const bodyParser = require('body-parser')
const cookieParser = require('cookie-parser')
const jsonApi = require('./jsonApi.js')
const debug = require('./debugging.js')
const responseHelper = require('./responseHelper.js')
const url = require('url')
const metrics = require('./metrics.js')
const graphQl = require('./graphQl/index.js')
router.applyMiddleware = <span class="fstat-no" title="function not covered" >()</span> => {
<span class="cstat-no" title="statement not covered" > app = app || jsonApi._apiConfig.router || express()</span>
<span class="cstat-no" title="statement not covered" > app.use(<span class="fstat-no" title="function not covered" >(r</span>eq, res, next) => {</span>
<span class="cstat-no" title="statement not covered" > res.set({</span>
'Content-Type': 'application/vnd.api+json',
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'GET, POST, PATCH, DELETE, OPTIONS',
'Access-Control-Allow-Headers': req.headers['access-control-request-headers'] || '',
'Cache-Control': 'private, must-revalidate, max-age=0',
'Expires': 'Thu, 01 Jan 1970 00:00:00'
})
<span class="cstat-no" title="statement not covered" > if (req.method === 'OPTIONS') {</span>
<span class="cstat-no" title="statement not covered" > return res.status(204).end()</span>
}
<span class="cstat-no" title="statement not covered" > return next()</span>
})
<span class="cstat-no" title="statement not covered" > app.use(<span class="fstat-no" title="function not covered" >(r</span>eq, res, next) => {</span>
<span class="cstat-no" title="statement not covered" > if (!req.headers['content-type'] && !req.headers.accept) <span class="cstat-no" title="statement not covered" >return next()</span></span>
<span class="cstat-no" title="statement not covered" > if (req.headers['content-type']) {</span>
// 415 Unsupported Media Type
<span class="cstat-no" title="statement not covered" > if (req.headers['content-type'].match(/^application\/vnd\.api\+json;.+$/)) {</span>
<span class="cstat-no" title="statement not covered" > return res.status(415).end(`HTTP 415 Unsupported Media Type - [${req.headers['content-type']}]`)</span>
}
// Convert "application/vnd.api+json" content type to "application/json".
// This enables the express body parser to correctly parse the JSON payload.
<span class="cstat-no" title="statement not covered" > if (req.headers['content-type'].match(/^application\/vnd\.api\+json$/)) {</span>
<span class="cstat-no" title="statement not covered" > req.headers['content-type'] = 'application/json'</span>
}
}
<span class="cstat-no" title="statement not covered" > if (req.headers.accept) {</span>
// 406 Not Acceptable
let matchingTypes = <span class="cstat-no" title="statement not covered" >req.headers.accept.split(/, ?/)</span>
<span class="cstat-no" title="statement not covered" > matchingTypes = matchingTypes.filter(<span class="fstat-no" title="function not covered" >me</span>diaType => // Accept application/*, */vnd.api+json, */* and the correct JSON:API type.</span>
<span class="cstat-no" title="statement not covered" > mediaType.match(/^(\*|application)\/(\*|json|vnd\.api\+json)$/) || mediaType.match(/\*\/\*/))</span>
<span class="cstat-no" title="statement not covered" > if (matchingTypes.length === 0) {</span>
<span class="cstat-no" title="statement not covered" > return res.status(406).end()</span>
}
}
<span class="cstat-no" title="statement not covered" > return next()</span>
})
<span class="cstat-no" title="statement not covered" > app.use(bodyParser.json())</span>
<span class="cstat-no" title="statement not covered" > app.use(bodyParser.urlencoded({ extended: true }))</span>
<span class="cstat-no" title="statement not covered" > app.use(cookieParser())</span>
<span class="cstat-no" title="statement not covered" > if (!jsonApi._apiConfig.router) {</span>
<span class="cstat-no" title="statement not covered" > app.disable('x-powered-by')</span>
<span class="cstat-no" title="statement not covered" > app.disable('etag')</span>
}
<span class="cstat-no" title="statement not covered" > graphQl.with(app)</span>
let requestId = <span class="cstat-no" title="statement not covered" >0</span>
<span class="cstat-no" title="statement not covered" > app.route('*').all(<span class="fstat-no" title="function not covered" >(r</span>eq, res, next) => {</span>
<span class="cstat-no" title="statement not covered" > debug.requestCounter(requestId++, req.method, req.url)</span>
<span class="cstat-no" title="statement not covered" > if (requestId > 1000) <span class="cstat-no" title="statement not covered" >requestId = 0</span></span>
<span class="cstat-no" title="statement not covered" > next()</span>
})
}
router.listen = <span class="fstat-no" title="function not covered" >po</span>rt => {
<span class="cstat-no" title="statement not covered" > if (!server) {</span>
<span class="cstat-no" title="statement not covered" > if (jsonApi._apiConfig.protocol === 'https') {</span>
<span class="cstat-no" title="statement not covered" > server = require('https').createServer(jsonApi._apiConfig.tls || {}, app)</span>
} else {
<span class="cstat-no" title="statement not covered" > server = require('http').createServer(app)</span>
}
<span class="cstat-no" title="statement not covered" > server.listen(port)</span>
}
}
router.close = <span class="fstat-no" title="function not covered" >()</span> => {
<span class="cstat-no" title="statement not covered" > if (server) {</span>
<span class="cstat-no" title="statement not covered" > server.close()</span>
<span class="cstat-no" title="statement not covered" > server = null</span>
}
}
router._routes = { }
router.bindRoute = <span class="fstat-no" title="function not covered" >(c</span>onfig, callback) => {
const path = <span class="cstat-no" title="statement not covered" >jsonApi._apiConfig.base + config.path</span>
const verb = <span class="cstat-no" title="statement not covered" >config.verb.toLowerCase()</span>
const routeHandler = <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >(r</span>eq, res, extras) => {</span>
let request = <span class="cstat-no" title="statement not covered" >router._getParams(req)</span>
<span class="cstat-no" title="statement not covered" > request = _.assign(request, extras)</span>
const resourceConfig = <span class="cstat-no" title="statement not covered" >jsonApi._resources[request.params.type]</span>
<span class="cstat-no" title="statement not covered" > request.resourceConfig = resourceConfig</span>
<span class="cstat-no" title="statement not covered" > res._request = request</span>
<span class="cstat-no" title="statement not covered" > res._startDate = new Date()</span>
<span class="cstat-no" title="statement not covered" > router.authenticate(request, res, <span class="fstat-no" title="function not covered" >()</span> => <span class="cstat-no" title="statement not covered" >callback(request, resourceConfig, res))</span></span>
}
<span class="cstat-no" title="statement not covered" > router._routes[verb] = router._routes[verb] || { }</span>
<span class="cstat-no" title="statement not covered" > router._routes[verb][config.path] = routeHandler</span>
<span class="cstat-no" title="statement not covered" > app[verb](path, routeHandler)</span>
}
router.authenticate = <span class="fstat-no" title="function not covered" >(r</span>equest, res, callback) => {
<span class="cstat-no" title="statement not covered" > if (!router._authFunction) <span class="cstat-no" title="statement not covered" >return callback()</span></span>
<span class="cstat-no" title="statement not covered" > router._authFunction(request, <span class="fstat-no" title="function not covered" >er</span>r => {</span>
<span class="cstat-no" title="statement not covered" > if (!err) <span class="cstat-no" title="statement not covered" >return callback()</span></span>
const errorWrapper = <span class="cstat-no" title="statement not covered" >{</span>
status: '401',
code: 'UNAUTHORIZED',
title: 'Authentication Failed',
detail: err || 'You are not authorised to access this resource.'
}
const payload = <span class="cstat-no" title="statement not covered" >responseHelper.generateError(request, errorWrapper)</span>
<span class="cstat-no" title="statement not covered" > res.status(401).end(Buffer.from(JSON.stringify(payload)))</span>
})
}
router.authenticateWith = <span class="fstat-no" title="function not covered" >au</span>thFunction => {
<span class="cstat-no" title="statement not covered" > router._authFunction = authFunction</span>
}
router.bind404 = <span class="fstat-no" title="function not covered" >ca</span>llback => {
<span class="cstat-no" title="statement not covered" > app.use(<span class="fstat-no" title="function not covered" >(r</span>eq, res) => {</span>
const request = <span class="cstat-no" title="statement not covered" >router._getParams(req)</span>
<span class="cstat-no" title="statement not covered" > return callback(request, res)</span>
})
}
router.bindErrorHandler = <span class="fstat-no" title="function not covered" >ca</span>llback => {
<span class="cstat-no" title="statement not covered" > app.use(<span class="fstat-no" title="function not covered" >(e</span>rror, req, res, next) => {</span>
const request = <span class="cstat-no" title="statement not covered" >router._getParams(req)</span>
<span class="cstat-no" title="statement not covered" > return callback(request, res, error, next)</span>
})
}
router._getParams = <span class="fstat-no" title="function not covered" >re</span>q => {
let urlParts = <span class="cstat-no" title="statement not covered" >req.url.split(jsonApi._apiConfig.base)</span>
<span class="cstat-no" title="statement not covered" > urlParts.shift()</span>
<span class="cstat-no" title="statement not covered" > urlParts = urlParts.join(jsonApi._apiConfig.base).split('?')</span>
const headersToRemove = <span class="cstat-no" title="statement not covered" >[</span>
'host', 'connection', 'accept-encoding', 'accept-language', 'content-length'
]
let combined
let reqUrl = <span class="cstat-no" title="statement not covered" >req.url</span>
<span class="cstat-no" title="statement not covered" > if (jsonApi._apiConfig.urlPrefixAlias) {</span>
<span class="cstat-no" title="statement not covered" > combined = jsonApi._apiConfig.urlPrefixAlias.replace(/\/$/, '')</span>
<span class="cstat-no" title="statement not covered" > reqUrl = reqUrl.replace(jsonApi._apiConfig.base, '/')</span>
} else {
<span class="cstat-no" title="statement not covered" > combined = url.format({</span>
protocol: jsonApi._apiConfig.protocol,
hostname: jsonApi._apiConfig.hostname,
port: jsonApi._apiConfig.port
})
}
<span class="cstat-no" title="statement not covered" > combined += reqUrl</span>
<span class="cstat-no" title="statement not covered" > return {</span>
params: _.assign(req.params, req.body, req.query),
headers: req.headers,
safeHeaders: _.omit(req.headers, headersToRemove),
cookies: req.cookies,
originalUrl: req.originalUrl,
route: {
verb: req.method,
host: req.headers.host,
base: jsonApi._apiConfig.base,
path: urlParts.shift() || '',
query: urlParts.shift() || '',
combined
}
}
}
router.sendResponse = <span class="fstat-no" title="function not covered" >(r</span>es, payload, httpCode) => {
const timeDiff = <span class="cstat-no" title="statement not covered" >(new Date()) - res._startDate</span>
<span class="cstat-no" title="statement not covered" > metrics.processResponse(res._request, httpCode, payload, timeDiff)</span>
<span class="cstat-no" title="statement not covered" > res.status(httpCode).end(Buffer.from(JSON.stringify(payload)))</span>
}
router.getExpressServer = <span class="fstat-no" title="function not covered" >()</span> => {
<span class="cstat-no" title="statement not covered" > app = app || jsonApi._apiConfig.router || express()</span>
<span class="cstat-no" title="statement not covered" > return app</span>
}
</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sat Jan 27 2018 19:59:16 GMT+0530 (IST)
</div>
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../sorter.js"></script>
</body>
</html>