UNPKG

18.2 kBHTMLView Raw
1<!doctype html>
2<html lang="en">
3<head>
4 <title>Code coverage report for Response.ts</title>
5 <meta charset="utf-8" />
6 <link rel="stylesheet" href="prettify.css" />
7 <link rel="stylesheet" href="base.css" />
8 <meta name="viewport" content="width=device-width, initial-scale=1">
9 <style type='text/css'>
10 .coverage-summary .sorter {
11 background-image: url(sort-arrow-sprite.png);
12 }
13 </style>
14</head>
15<body>
16<div class='wrapper'>
17 <div class='pad1'>
18 <h1>
19 <a href="index.html">All files</a> Response.ts
20 </h1>
21 <div class='clearfix'>
22 <div class='fl pad1y space-right2'>
23 <span class="strong">100% </span>
24 <span class="quiet">Statements</span>
25 <span class='fraction'>38/38</span>
26 </div>
27 <div class='fl pad1y space-right2'>
28 <span class="strong">100% </span>
29 <span class="quiet">Branches</span>
30 <span class='fraction'>11/11</span>
31 </div>
32 <div class='fl pad1y space-right2'>
33 <span class="strong">100% </span>
34 <span class="quiet">Functions</span>
35 <span class='fraction'>18/18</span>
36 </div>
37 <div class='fl pad1y space-right2'>
38 <span class="strong">100% </span>
39 <span class="quiet">Lines</span>
40 <span class='fraction'>38/38</span>
41 </div>
42 </div>
43 <p class="quiet">
44 Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
45 </p>
46 </div>
47 <div class='status-line high'></div>
48<pre><table class="coverage">
49<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
50<a name='L2'></a><a href='#L2'>2</a>
51<a name='L3'></a><a href='#L3'>3</a>
52<a name='L4'></a><a href='#L4'>4</a>
53<a name='L5'></a><a href='#L5'>5</a>
54<a name='L6'></a><a href='#L6'>6</a>
55<a name='L7'></a><a href='#L7'>7</a>
56<a name='L8'></a><a href='#L8'>8</a>
57<a name='L9'></a><a href='#L9'>9</a>
58<a name='L10'></a><a href='#L10'>10</a>
59<a name='L11'></a><a href='#L11'>11</a>
60<a name='L12'></a><a href='#L12'>12</a>
61<a name='L13'></a><a href='#L13'>13</a>
62<a name='L14'></a><a href='#L14'>14</a>
63<a name='L15'></a><a href='#L15'>15</a>
64<a name='L16'></a><a href='#L16'>16</a>
65<a name='L17'></a><a href='#L17'>17</a>
66<a name='L18'></a><a href='#L18'>18</a>
67<a name='L19'></a><a href='#L19'>19</a>
68<a name='L20'></a><a href='#L20'>20</a>
69<a name='L21'></a><a href='#L21'>21</a>
70<a name='L22'></a><a href='#L22'>22</a>
71<a name='L23'></a><a href='#L23'>23</a>
72<a name='L24'></a><a href='#L24'>24</a>
73<a name='L25'></a><a href='#L25'>25</a>
74<a name='L26'></a><a href='#L26'>26</a>
75<a name='L27'></a><a href='#L27'>27</a>
76<a name='L28'></a><a href='#L28'>28</a>
77<a name='L29'></a><a href='#L29'>29</a>
78<a name='L30'></a><a href='#L30'>30</a>
79<a name='L31'></a><a href='#L31'>31</a>
80<a name='L32'></a><a href='#L32'>32</a>
81<a name='L33'></a><a href='#L33'>33</a>
82<a name='L34'></a><a href='#L34'>34</a>
83<a name='L35'></a><a href='#L35'>35</a>
84<a name='L36'></a><a href='#L36'>36</a>
85<a name='L37'></a><a href='#L37'>37</a>
86<a name='L38'></a><a href='#L38'>38</a>
87<a name='L39'></a><a href='#L39'>39</a>
88<a name='L40'></a><a href='#L40'>40</a>
89<a name='L41'></a><a href='#L41'>41</a>
90<a name='L42'></a><a href='#L42'>42</a>
91<a name='L43'></a><a href='#L43'>43</a>
92<a name='L44'></a><a href='#L44'>44</a>
93<a name='L45'></a><a href='#L45'>45</a>
94<a name='L46'></a><a href='#L46'>46</a>
95<a name='L47'></a><a href='#L47'>47</a>
96<a name='L48'></a><a href='#L48'>48</a>
97<a name='L49'></a><a href='#L49'>49</a>
98<a name='L50'></a><a href='#L50'>50</a>
99<a name='L51'></a><a href='#L51'>51</a>
100<a name='L52'></a><a href='#L52'>52</a>
101<a name='L53'></a><a href='#L53'>53</a>
102<a name='L54'></a><a href='#L54'>54</a>
103<a name='L55'></a><a href='#L55'>55</a>
104<a name='L56'></a><a href='#L56'>56</a>
105<a name='L57'></a><a href='#L57'>57</a>
106<a name='L58'></a><a href='#L58'>58</a>
107<a name='L59'></a><a href='#L59'>59</a>
108<a name='L60'></a><a href='#L60'>60</a>
109<a name='L61'></a><a href='#L61'>61</a>
110<a name='L62'></a><a href='#L62'>62</a>
111<a name='L63'></a><a href='#L63'>63</a>
112<a name='L64'></a><a href='#L64'>64</a>
113<a name='L65'></a><a href='#L65'>65</a>
114<a name='L66'></a><a href='#L66'>66</a>
115<a name='L67'></a><a href='#L67'>67</a>
116<a name='L68'></a><a href='#L68'>68</a>
117<a name='L69'></a><a href='#L69'>69</a>
118<a name='L70'></a><a href='#L70'>70</a>
119<a name='L71'></a><a href='#L71'>71</a>
120<a name='L72'></a><a href='#L72'>72</a>
121<a name='L73'></a><a href='#L73'>73</a>
122<a name='L74'></a><a href='#L74'>74</a>
123<a name='L75'></a><a href='#L75'>75</a>
124<a name='L76'></a><a href='#L76'>76</a>
125<a name='L77'></a><a href='#L77'>77</a>
126<a name='L78'></a><a href='#L78'>78</a>
127<a name='L79'></a><a href='#L79'>79</a>
128<a name='L80'></a><a href='#L80'>80</a>
129<a name='L81'></a><a href='#L81'>81</a>
130<a name='L82'></a><a href='#L82'>82</a>
131<a name='L83'></a><a href='#L83'>83</a>
132<a name='L84'></a><a href='#L84'>84</a>
133<a name='L85'></a><a href='#L85'>85</a>
134<a name='L86'></a><a href='#L86'>86</a>
135<a name='L87'></a><a href='#L87'>87</a>
136<a name='L88'></a><a href='#L88'>88</a>
137<a name='L89'></a><a href='#L89'>89</a>
138<a name='L90'></a><a href='#L90'>90</a>
139<a name='L91'></a><a href='#L91'>91</a>
140<a name='L92'></a><a href='#L92'>92</a>
141<a name='L93'></a><a href='#L93'>93</a>
142<a name='L94'></a><a href='#L94'>94</a>
143<a name='L95'></a><a href='#L95'>95</a>
144<a name='L96'></a><a href='#L96'>96</a>
145<a name='L97'></a><a href='#L97'>97</a>
146<a name='L98'></a><a href='#L98'>98</a>
147<a name='L99'></a><a href='#L99'>99</a>
148<a name='L100'></a><a href='#L100'>100</a>
149<a name='L101'></a><a href='#L101'>101</a>
150<a name='L102'></a><a href='#L102'>102</a>
151<a name='L103'></a><a href='#L103'>103</a>
152<a name='L104'></a><a href='#L104'>104</a>
153<a name='L105'></a><a href='#L105'>105</a>
154<a name='L106'></a><a href='#L106'>106</a>
155<a name='L107'></a><a href='#L107'>107</a>
156<a name='L108'></a><a href='#L108'>108</a>
157<a name='L109'></a><a href='#L109'>109</a>
158<a name='L110'></a><a href='#L110'>110</a>
159<a name='L111'></a><a href='#L111'>111</a>
160<a name='L112'></a><a href='#L112'>112</a>
161<a name='L113'></a><a href='#L113'>113</a>
162<a name='L114'></a><a href='#L114'>114</a>
163<a name='L115'></a><a href='#L115'>115</a>
164<a name='L116'></a><a href='#L116'>116</a>
165<a name='L117'></a><a href='#L117'>117</a>
166<a name='L118'></a><a href='#L118'>118</a>
167<a name='L119'></a><a href='#L119'>119</a>
168<a name='L120'></a><a href='#L120'>120</a>
169<a name='L121'></a><a href='#L121'>121</a>
170<a name='L122'></a><a href='#L122'>122</a>
171<a name='L123'></a><a href='#L123'>123</a>
172<a name='L124'></a><a href='#L124'>124</a>
173<a name='L125'></a><a href='#L125'>125</a>
174<a name='L126'></a><a href='#L126'>126</a>
175<a name='L127'></a><a href='#L127'>127</a>
176<a name='L128'></a><a href='#L128'>128</a>
177<a name='L129'></a><a href='#L129'>129</a>
178<a name='L130'></a><a href='#L130'>130</a>
179<a name='L131'></a><a href='#L131'>131</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
180<span class="cline-any cline-neutral">&nbsp;</span>
181<span class="cline-any cline-neutral">&nbsp;</span>
182<span class="cline-any cline-neutral">&nbsp;</span>
183<span class="cline-any cline-neutral">&nbsp;</span>
184<span class="cline-any cline-neutral">&nbsp;</span>
185<span class="cline-any cline-neutral">&nbsp;</span>
186<span class="cline-any cline-neutral">&nbsp;</span>
187<span class="cline-any cline-neutral">&nbsp;</span>
188<span class="cline-any cline-neutral">&nbsp;</span>
189<span class="cline-any cline-neutral">&nbsp;</span>
190<span class="cline-any cline-neutral">&nbsp;</span>
191<span class="cline-any cline-neutral">&nbsp;</span>
192<span class="cline-any cline-neutral">&nbsp;</span>
193<span class="cline-any cline-neutral">&nbsp;</span>
194<span class="cline-any cline-yes">1x</span>
195<span class="cline-any cline-yes">1x</span>
196<span class="cline-any cline-yes">1x</span>
197<span class="cline-any cline-neutral">&nbsp;</span>
198<span class="cline-any cline-yes">1x</span>
199<span class="cline-any cline-yes">1x</span>
200<span class="cline-any cline-neutral">&nbsp;</span>
201<span class="cline-any cline-neutral">&nbsp;</span>
202<span class="cline-any cline-neutral">&nbsp;</span>
203<span class="cline-any cline-neutral">&nbsp;</span>
204<span class="cline-any cline-neutral">&nbsp;</span>
205<span class="cline-any cline-neutral">&nbsp;</span>
206<span class="cline-any cline-neutral">&nbsp;</span>
207<span class="cline-any cline-yes">1x</span>
208<span class="cline-any cline-neutral">&nbsp;</span>
209<span class="cline-any cline-neutral">&nbsp;</span>
210<span class="cline-any cline-neutral">&nbsp;</span>
211<span class="cline-any cline-neutral">&nbsp;</span>
212<span class="cline-any cline-neutral">&nbsp;</span>
213<span class="cline-any cline-yes">40x</span>
214<span class="cline-any cline-yes">40x</span>
215<span class="cline-any cline-yes">40x</span>
216<span class="cline-any cline-neutral">&nbsp;</span>
217<span class="cline-any cline-neutral">&nbsp;</span>
218<span class="cline-any cline-neutral">&nbsp;</span>
219<span class="cline-any cline-yes">37x</span>
220<span class="cline-any cline-yes">37x</span>
221<span class="cline-any cline-neutral">&nbsp;</span>
222<span class="cline-any cline-neutral">&nbsp;</span>
223<span class="cline-any cline-neutral">&nbsp;</span>
224<span class="cline-any cline-yes">44x</span>
225<span class="cline-any cline-neutral">&nbsp;</span>
226<span class="cline-any cline-neutral">&nbsp;</span>
227<span class="cline-any cline-neutral">&nbsp;</span>
228<span class="cline-any cline-yes">1x</span>
229<span class="cline-any cline-neutral">&nbsp;</span>
230<span class="cline-any cline-neutral">&nbsp;</span>
231<span class="cline-any cline-neutral">&nbsp;</span>
232<span class="cline-any cline-yes">44x</span>
233<span class="cline-any cline-yes">2x</span>
234<span class="cline-any cline-neutral">&nbsp;</span>
235<span class="cline-any cline-yes">42x</span>
236<span class="cline-any cline-yes">4x</span>
237<span class="cline-any cline-neutral">&nbsp;</span>
238<span class="cline-any cline-neutral">&nbsp;</span>
239<span class="cline-any cline-yes">38x</span>
240<span class="cline-any cline-neutral">&nbsp;</span>
241<span class="cline-any cline-neutral">&nbsp;</span>
242<span class="cline-any cline-yes">44x</span>
243<span class="cline-any cline-neutral">&nbsp;</span>
244<span class="cline-any cline-neutral">&nbsp;</span>
245<span class="cline-any cline-neutral">&nbsp;</span>
246<span class="cline-any cline-yes">1x</span>
247<span class="cline-any cline-yes">1x</span>
248<span class="cline-any cline-neutral">&nbsp;</span>
249<span class="cline-any cline-neutral">&nbsp;</span>
250<span class="cline-any cline-yes">1x</span>
251<span class="cline-any cline-neutral">&nbsp;</span>
252<span class="cline-any cline-neutral">&nbsp;</span>
253<span class="cline-any cline-neutral">&nbsp;</span>
254<span class="cline-any cline-yes">15x</span>
255<span class="cline-any cline-yes">14x</span>
256<span class="cline-any cline-neutral">&nbsp;</span>
257<span class="cline-any cline-neutral">&nbsp;</span>
258<span class="cline-any cline-yes">1x</span>
259<span class="cline-any cline-neutral">&nbsp;</span>
260<span class="cline-any cline-neutral">&nbsp;</span>
261<span class="cline-any cline-yes">15x</span>
262<span class="cline-any cline-neutral">&nbsp;</span>
263<span class="cline-any cline-neutral">&nbsp;</span>
264<span class="cline-any cline-neutral">&nbsp;</span>
265<span class="cline-any cline-yes">1x</span>
266<span class="cline-any cline-neutral">&nbsp;</span>
267<span class="cline-any cline-neutral">&nbsp;</span>
268<span class="cline-any cline-neutral">&nbsp;</span>
269<span class="cline-any cline-yes">1x</span>
270<span class="cline-any cline-neutral">&nbsp;</span>
271<span class="cline-any cline-neutral">&nbsp;</span>
272<span class="cline-any cline-neutral">&nbsp;</span>
273<span class="cline-any cline-yes">2x</span>
274<span class="cline-any cline-neutral">&nbsp;</span>
275<span class="cline-any cline-neutral">&nbsp;</span>
276<span class="cline-any cline-neutral">&nbsp;</span>
277<span class="cline-any cline-yes">4x</span>
278<span class="cline-any cline-yes">2x</span>
279<span class="cline-any cline-neutral">&nbsp;</span>
280<span class="cline-any cline-neutral">&nbsp;</span>
281<span class="cline-any cline-yes">2x</span>
282<span class="cline-any cline-neutral">&nbsp;</span>
283<span class="cline-any cline-neutral">&nbsp;</span>
284<span class="cline-any cline-neutral">&nbsp;</span>
285<span class="cline-any cline-neutral">&nbsp;</span>
286<span class="cline-any cline-yes">1x</span>
287<span class="cline-any cline-neutral">&nbsp;</span>
288<span class="cline-any cline-neutral">&nbsp;</span>
289<span class="cline-any cline-neutral">&nbsp;</span>
290<span class="cline-any cline-yes">1x</span>
291<span class="cline-any cline-neutral">&nbsp;</span>
292<span class="cline-any cline-neutral">&nbsp;</span>
293<span class="cline-any cline-neutral">&nbsp;</span>
294<span class="cline-any cline-yes">1x</span>
295<span class="cline-any cline-neutral">&nbsp;</span>
296<span class="cline-any cline-neutral">&nbsp;</span>
297<span class="cline-any cline-neutral">&nbsp;</span>
298<span class="cline-any cline-yes">1x</span>
299<span class="cline-any cline-neutral">&nbsp;</span>
300<span class="cline-any cline-neutral">&nbsp;</span>
301<span class="cline-any cline-neutral">&nbsp;</span>
302<span class="cline-any cline-yes">1x</span>
303<span class="cline-any cline-neutral">&nbsp;</span>
304<span class="cline-any cline-neutral">&nbsp;</span>
305<span class="cline-any cline-neutral">&nbsp;</span>
306<span class="cline-any cline-yes">1x</span>
307<span class="cline-any cline-neutral">&nbsp;</span>
308<span class="cline-any cline-neutral">&nbsp;</span>
309<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// Copyright (C) 2017 Norman Breau
310&nbsp;
311// This program is free software: you can redistribute it and/or modify
312// it under the terms of the GNU General Public License as published by
313// the Free Software Foundation, either version 3 of the License, or
314// (at your option) any later version.
315&nbsp;
316// This program is distributed in the hope that it will be useful,
317// but WITHOUT ANY WARRANTY; without even the implied warranty of
318// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
319// GNU General Public License for more details.
320&nbsp;
321// You should have received a copy of the GNU General Public License
322// along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.
323&nbsp;
324import {StatusCode} from './StatusCode';
325import {ResponseData} from './ResponseData';
326import {StormError, IErrorResponse} from './StormError';
327import * as express from 'express';
328import {getApplicationLogger} from './instance';
329import { InternalError } from './InternalError';
330&nbsp;
331export type SendableData = ResponseData | StormError | IErrorResponse | any;
332&nbsp;
333export interface IHeaderKeyValuePair {
334 [key: string]: string;
335}
336&nbsp;
337export class Response {
338 private response: express.Response;
339 private created: Date;
340 private requestURL: string;
341&nbsp;
342 public constructor(response: express.Response, requestURL: string) {
343 this.response = response;
344 this.created = new Date();
345 this.requestURL = requestURL;
346 }
347&nbsp;
348 public setStatus(status: StatusCode): Response {
349 this.response.status(status);
350 return this;
351 }
352&nbsp;
353 public getStatus(): StatusCode {
354 return this.response.statusCode;
355 }
356&nbsp;
357 public redirect(url: string): void {
358 this.response.redirect(url);
359 }
360&nbsp;
361 public send(data?: SendableData): void {
362 if (data instanceof ResponseData) {
363 this.setStatus(data.getStatus()).send(data.getData());
364 }
365 else if (data instanceof StormError) {
366 this.setStatus(data.getHTTPCode()).send(data.getErrorResponse());
367 }
368 else {
369 this.response.send(data);
370 }
371
372 getApplicationLogger().info(`API ${this.requestURL} (${this.getStatus()}) responded in ${new Date().getTime() - this.created.getTime()}ms`);
373 }
374&nbsp;
375 public pipe(stream: NodeJS.ReadableStream): void {
376 stream.on('end', () =&gt; {
377 stream.unpipe(this.response);
378 });
379
380 stream.pipe(this.response);
381 }
382&nbsp;
383 public success(data?: any): void {
384 if (data === undefined) {
385 this.setStatus(StatusCode.OK_NO_CONTENT);
386 }
387 else {
388 this.setStatus(StatusCode.OK);
389 }
390&nbsp;
391 this.send(data);
392 }
393&nbsp;
394 public setHeader(key: string, value: string): void {
395 this.response.set(key, value);
396 }
397&nbsp;
398 public setHeaders(keyValuePair: IHeaderKeyValuePair): void {
399 this.response.set(keyValuePair);
400 }
401&nbsp;
402 public isHeadersSent(): boolean {
403 return this.response.headersSent;
404 }
405&nbsp;
406 public error(error?: any): void {
407 if (error &amp;&amp; (error instanceof ResponseData || error instanceof StormError)) {
408 this.send(error);
409 }
410 else {
411 this.send(new InternalError(error));
412 }
413 }
414&nbsp;
415 public badRequest(data?: any): void {
416 this.setStatus(StatusCode.ERR_BAD_REQUEST).send(data);
417 }
418&nbsp;
419 public unauthorized(data?: any): void {
420 this.setStatus(StatusCode.ERR_UNAUTHORIZED).send(data);
421 }
422&nbsp;
423 public forbidden(data?: any): void {
424 this.setStatus(StatusCode.ERR_FORBIDDEN).send(data);
425 }
426&nbsp;
427 public conflict(data?: any): void {
428 this.setStatus(StatusCode.ERR_CONFLICT).send(data);
429 }
430&nbsp;
431 public notFound(data?: any): void {
432 this.setStatus(StatusCode.ERR_NOT_FOUND).send(data);
433 }
434&nbsp;
435 public internalError(data?: any): void {
436 this.setStatus(StatusCode.INTERNAL_ERROR).send(data);
437 }
438}
439&nbsp;</pre></td></tr>
440</table></pre>
441<div class='push'></div><!-- for sticky footer -->
442</div><!-- /wrapper -->
443<div class='footer quiet pad2 space-top1 center small'>
444 Code coverage
445 generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sun Oct 06 2019 20:17:21 GMT-0300 (Atlantic Daylight Time)
446</div>
447</div>
448<script src="prettify.js"></script>
449<script>
450window.onload = function () {
451 if (typeof prettyPrint === 'function') {
452 prettyPrint();
453 }
454};
455</script>
456<script src="sorter.js"></script>
457<script src="block-navigation.js"></script>
458</body>
459</html>