socketcluster-api
Version:
API over SocketCluster's websocket
480 lines (479 loc) • 14.5 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for 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> Router.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">83.61% </span>
<span class="quiet">Statements</span>
<span class='fraction'>51/61</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">76.47% </span>
<span class="quiet">Branches</span>
<span class='fraction'>26/34</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">94.12% </span>
<span class="quiet">Functions</span>
<span class='fraction'>16/17</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">83.61% </span>
<span class="quiet">Lines</span>
<span class='fraction'>51/61</span>
</div>
</div>
</div>
<div class='status-line high'></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</td><td class="line-coverage quiet"><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-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">33x</span>
<span class="cline-any cline-yes">33x</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">41x</span>
<span class="cline-any cline-yes">41x</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-neutral"> </span>
<span class="cline-any cline-yes">3x</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">3x</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">3x</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">3x</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">41x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">40x</span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">40x</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">39x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">39x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">39x</span>
<span class="cline-any cline-yes">39x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">39x</span>
<span class="cline-any cline-yes">39x</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">67x</span>
<span class="cline-any cline-yes">109x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">109x</span>
<span class="cline-any cline-yes">35x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">74x</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">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">74x</span>
<span class="cline-any cline-yes">20x</span>
<span class="cline-any cline-yes">20x</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">32x</span>
<span class="cline-any cline-yes">12x</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-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">32x</span>
<span class="cline-any cline-yes">32x</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">32x</span>
<span class="cline-any cline-yes">20x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">20x</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">20x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-yes">12x</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">12x</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-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-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-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">const debug = require('debug')('socketcluster-api:Router');
const { serialize, deserialize } = require('./protobufCodec');
const NotFound = Symbol('404 NOT FOUND');
class Router {
constructor(pbRoot) {
this._routes = [];
this._pbRoot = pbRoot;
}
_verifyMethod(method) {
const allowedMethods = [ 'get', 'post', 'put', 'delete' ];
if (!allowedMethods.includes(method)) {
throw new Error(`Invalid method. Allowed methods are: ${allowedMethods.join(',')}`);
}
}
get(path, handler) {
return this.use('get', path, handler);
}
post(path, handler) {
return this.use('post', path, handler);
}
put(path, handler) {
return this.use('put', path, handler);
}
delete(path, handler) {
return this.use('delete', path, handler);
}
use(method, path, handler) {
this._verifyMethod(method);
if (typeof path === 'function') {
handler = path;
path = '/';
}
if (typeof handler !== 'function' && !(handler instanceof Router)) {
throw new Error('A handler (a function or a Router) must be passed to `use`.');
}
if (path[0] !== '/') {
path = '/' + path;
}
const parts = path.split('/').slice(1); // First element is empty (as path always start with '/').
let nextHandler = handler;
if (parts.length > 1) {
// This path contains multiple folders. Build `Router`s appropriately
nextHandler = new Router(this._pbRoot).use(method, parts.slice(1).join('/'), handler);
}
this._routes.push([ method, `/${parts[0]}`, nextHandler ]);
return this;
}
traverse(callback, absolutePath = '') {
this._routes.forEach(([ method, path, handler ]) => {
const fullPath = `${absolutePath}${path}`;
if (handler instanceof Router) {
handler.traverse(callback, fullPath);
} else {
callback(method, fullPath, handler);
}
});
}
_find(searchMethod, searchRoute) {
let resolved = false;
return new Promise((resolve, reject) => {
this.traverse((method, fullPath, handler) => {
if (!resolved && searchMethod === method && fullPath === searchRoute) {
resolved = true;
resolve(handler);
}
});
if (!resolved) {
reject(NotFound);
}
});
}
<span class="fstat-no" title="function not covered" > re</span>gister(scSocket) {
<span class="cstat-no" title="statement not covered" > scSocket.on('#api', this._handleEvent.bind(this));</span>
}
_handleEvent(data, callback) {
let plain = {};
<span class="missing-if-branch" title="if path not taken" >I</span>if (data.dataType) {
<span class="cstat-no" title="statement not covered" > plain = deserialize(this._pbRoot.lookupType(data.dataType), data.buffer);</span>
}
return this._find(data.method, data.resource)
.then(handler => handler(plain))
.then(({ dataType, responseData } = {}) => {
let buffer;
<span class="missing-if-branch" title="if path not taken" >I</span>if (dataType) {
<span class="cstat-no" title="statement not covered" > buffer = serialize(this._pbRoot.lookupType(dataType), responseData);</span>
}
callback(null, { dataType, buffer, isError: false });
})
.catch(err => {
const dataType = '.socketclusterapi.ApiError';
<span class="missing-if-branch" title="else path not taken" >E</span>if (err === NotFound) {
debug("No route for %o", data.resource);
const buffer = serialize(this._pbRoot.lookupType(dataType), {
code: 404,
reason: 'Not Found',
description: `Requested resource '${data.method} ${data.resource}' has no handler defined.`
});
callback(null, { dataType, buffer, isError: true });
} else <span class="cstat-no" title="statement not covered" >if ( err.dataType && typeof err.datType === 'string' && err.data) {</span>
const [ dataType, data ] = <span class="cstat-no" title="statement not covered" >err;</span>
const buffer = <span class="cstat-no" title="statement not covered" >serialize(this._pbRoot.lookupType(dataType), data);</span>
<span class="cstat-no" title="statement not covered" > callback(null, { dataType: dataType, buffer, isError: true });</span>
} else {
<span class="cstat-no" title="statement not covered" > debug("Handler threw unexpectedly: %O", err);</span>
const buffer = <span class="cstat-no" title="statement not covered" >serialize(this._pbRoot.lookupType(dataType), {</span>
code: 500,
reason: 'Internal Server Error',
description: `The resource threw an unexpected error.`
});
<span class="cstat-no" title="statement not covered" > callback(null, { dataType, buffer, isError: true });</span>
}
});
}
}
module.exports = Router;
</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 Sun Aug 13 2017 14:47:51 GMT+0200 (CEST)
</div>
</div>
<script src="prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="sorter.js"></script>
</body>
</html>