UNPKG

@coding-blocks/jsonapi-server

Version:

A config driven NodeJS framework implementing json:api

477 lines (476 loc) 19.3 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/filter.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> filter.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">13.79% </span> <span class="quiet">Statements</span> <span class='fraction'>12/87</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Branches</span> <span class='fraction'>0/54</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Functions</span> <span class='fraction'>0/11</span> </div> <div class='fl pad1y space-right2'> <span class="strong">17.65% </span> <span class="quiet">Lines</span> <span class='fraction'>12/68</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</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</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">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">'use strict' const filter = module.exports = { } &nbsp; const FILTER_OPERATORS = ['&lt;', '&gt;', '~', ':'] const STRING_ONLY_OPERATORS = ['~', ':'] const FILTER_SEPERATOR = ',' &nbsp; filter._resourceDoesNotHaveProperty = <span class="fstat-no" title="function not covered" >(r</span>esourceConfig, key) =&gt; { <span class="cstat-no" title="statement not covered" > if (resourceConfig.attributes[key]) <span class="cstat-no" title="statement not covered" >return null</span></span> <span class="cstat-no" title="statement not covered" > return {</span> status: '403', code: 'EFORBIDDEN', title: 'Invalid filter', detail: `${resourceConfig.resource} do not have attribute or relationship '${key}'` } } &nbsp; filter._relationshipIsForeign = <span class="fstat-no" title="function not covered" >(r</span>esourceConfig, key) =&gt; { const relationSettings = <span class="cstat-no" title="statement not covered" >resourceConfig.attributes[key]._settings</span> <span class="cstat-no" title="statement not covered" > if (!relationSettings || !relationSettings.__as) <span class="cstat-no" title="statement not covered" >return null</span></span> <span class="cstat-no" title="statement not covered" > return {</span> status: '403', code: 'EFORBIDDEN', title: 'Invalid filter', detail: `Filter relationship '${key}' is a foreign reference and does not exist on ${resourceConfig.resource}` } } &nbsp; filter._splitElement = <span class="fstat-no" title="function not covered" >el</span>ement =&gt; { <span class="cstat-no" title="statement not covered" > if (!element) <span class="cstat-no" title="statement not covered" >return null</span></span> <span class="cstat-no" title="statement not covered" > if (FILTER_OPERATORS.indexOf(element[0]) !== -1) {</span> <span class="cstat-no" title="statement not covered" > return { operator: element[0], value: element.substring(1) }</span> } <span class="cstat-no" title="statement not covered" > return { operator: null, value: element }</span> } &nbsp; filter._stringOnlyOperator = <span class="fstat-no" title="function not covered" >(o</span>perator, attributeConfig) =&gt; { <span class="cstat-no" title="statement not covered" > if (!operator || !attributeConfig) <span class="cstat-no" title="statement not covered" >return null</span></span> <span class="cstat-no" title="statement not covered" > if (STRING_ONLY_OPERATORS.indexOf(operator) !== -1 &amp;&amp; attributeConfig._type !== 'string') {</span> <span class="cstat-no" title="statement not covered" > return `operator ${operator} can only be applied to string attributes`</span> } <span class="cstat-no" title="statement not covered" > return null</span> } &nbsp; filter._parseScalarFilterElement = <span class="fstat-no" title="function not covered" >(a</span>ttributeConfig, scalarElement) =&gt; { <span class="cstat-no" title="statement not covered" > if (!scalarElement) <span class="cstat-no" title="statement not covered" >return { error: 'invalid or empty filter element' }</span></span> &nbsp; const splitElement = <span class="cstat-no" title="statement not covered" >filter._splitElement(scalarElement)</span> <span class="cstat-no" title="statement not covered" > if (!splitElement) <span class="cstat-no" title="statement not covered" >return { error: 'empty filter' }</span></span> &nbsp; const error = <span class="cstat-no" title="statement not covered" >filter._stringOnlyOperator(splitElement.operator, attributeConfig)</span> <span class="cstat-no" title="statement not covered" > if (error) <span class="cstat-no" title="statement not covered" >return { error }</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > if (attributeConfig._settings) { // relationship attribute: no further validation</span> <span class="cstat-no" title="statement not covered" > return { result: splitElement }</span> } &nbsp; const validateResult = <span class="cstat-no" title="statement not covered" >attributeConfig.validate(splitElement.value)</span> <span class="cstat-no" title="statement not covered" > if (validateResult.error) {</span> <span class="cstat-no" title="statement not covered" > return { error: validateResult.error.message }</span> } &nbsp; const validatedElement = <span class="cstat-no" title="statement not covered" >{ operator: splitElement.operator, value: validateResult.value }</span> <span class="cstat-no" title="statement not covered" > return { result: validatedElement }</span> } &nbsp; filter._parseFilterElementHelper = <span class="fstat-no" title="function not covered" >(a</span>ttributeConfig, filterElement) =&gt; { <span class="cstat-no" title="statement not covered" > if (!filterElement) <span class="cstat-no" title="statement not covered" >return { error: 'invalid or empty filter element' }</span></span> &nbsp; const parsedElements = <span class="cstat-no" title="statement not covered" >[].concat(filterElement).map(<span class="fstat-no" title="function not covered" >sc</span>alarElement =&gt; <span class="cstat-no" title="statement not covered" >filter._parseScalarFilterElement(attributeConfig, scalarElement))</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > if (parsedElements.length === 1) <span class="cstat-no" title="statement not covered" >return parsedElements[0]</span></span> &nbsp; const errors = <span class="cstat-no" title="statement not covered" >parsedElements.reduce(<span class="fstat-no" title="function not covered" >(c</span>ombined, element) =&gt; {</span> <span class="cstat-no" title="statement not covered" > if (!combined) {</span> <span class="cstat-no" title="statement not covered" > if (!element.error) <span class="cstat-no" title="statement not covered" >return combined</span></span> <span class="cstat-no" title="statement not covered" > return [ element.error ]</span> } <span class="cstat-no" title="statement not covered" > return combined.concat(element.error)</span> }, null) &nbsp; <span class="cstat-no" title="statement not covered" > if (errors) <span class="cstat-no" title="statement not covered" >return { error: errors }</span></span> &nbsp; const results = <span class="cstat-no" title="statement not covered" >parsedElements.map(<span class="fstat-no" title="function not covered" >el</span>ement =&gt; <span class="cstat-no" title="statement not covered" >element.result)</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > return { result: results }</span> } &nbsp; filter._parseFilterElement = <span class="fstat-no" title="function not covered" >(a</span>ttributeName, attributeConfig, filterElement) =&gt; { const helperResult = <span class="cstat-no" title="statement not covered" >filter._parseFilterElementHelper(attributeConfig, filterElement)</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (helperResult.error) {</span> <span class="cstat-no" title="statement not covered" > return {</span> error: { status: '403', code: 'EFORBIDDEN', title: 'Invalid filter', detail: `Filter value for key '${attributeName}' is invalid: ${helperResult.error}` } } } <span class="cstat-no" title="statement not covered" > return { result: helperResult.result }</span> } &nbsp; filter.parseAndValidate = <span class="fstat-no" title="function not covered" >re</span>quest =&gt; { <span class="cstat-no" title="statement not covered" > if (!request.params.filter) <span class="cstat-no" title="statement not covered" >return null</span></span> &nbsp; const resourceConfig = <span class="cstat-no" title="statement not covered" >request.resourceConfig</span> &nbsp; const processedFilter = <span class="cstat-no" title="statement not covered" >{ }</span> let error let filterElement let parsedFilterElement &nbsp; <span class="cstat-no" title="statement not covered" > for (const key in request.params.filter) {</span> <span class="cstat-no" title="statement not covered" > filterElement = request.params.filter[key]</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (typeof filterElement === 'string') <span class="cstat-no" title="statement not covered" >request.params.filter[key] = filterElement = filterElement.split(FILTER_SEPERATOR)</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > if (!Array.isArray(filterElement) &amp;&amp; filterElement instanceof Object) <span class="cstat-no" title="statement not covered" >continue </span></span>// skip deep filters &nbsp; <span class="cstat-no" title="statement not covered" > error = filter._resourceDoesNotHaveProperty(resourceConfig, key)</span> <span class="cstat-no" title="statement not covered" > if (error) <span class="cstat-no" title="statement not covered" >return error</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > error = filter._relationshipIsForeign(resourceConfig, key)</span> <span class="cstat-no" title="statement not covered" > if (error) <span class="cstat-no" title="statement not covered" >return error</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > parsedFilterElement = filter._parseFilterElement(key, resourceConfig.attributes[key], filterElement)</span> <span class="cstat-no" title="statement not covered" > if (parsedFilterElement.error) <span class="cstat-no" title="statement not covered" >return parsedFilterElement.error</span></span> &nbsp; <span class="cstat-no" title="statement not covered" > processedFilter[key] = [].concat(parsedFilterElement.result)</span> } &nbsp; <span class="cstat-no" title="statement not covered" > request.processedFilter = processedFilter</span> &nbsp; <span class="cstat-no" title="statement not covered" > return null</span> } &nbsp;</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>