UNPKG

@coding-blocks/jsonapi-server

Version:

A config driven NodeJS framework implementing json:api

456 lines (455 loc) 16.7 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/jsonApi.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> jsonApi.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">39.13% </span> <span class="quiet">Statements</span> <span class='fraction'>27/69</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Branches</span> <span class='fraction'>0/28</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Functions</span> <span class='fraction'>0/10</span> </div> <div class='fl pad1y space-right2'> <span class="strong">41.54% </span> <span class="quiet">Lines</span> <span class='fraction'>27/65</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</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-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-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-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">&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-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-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-yes">1x</span> <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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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></td><td class="text"><pre class="prettyprint lang-js">'use strict' const jsonApi = module.exports = { } jsonApi._version = require(require('path').join(__dirname, '../package.json')).version jsonApi._resources = { } jsonApi._apiConfig = { } &nbsp; const _ = { assign: require('lodash.assign'), pick: require('lodash.pick') } const ourJoi = require('./ourJoi.js') const router = require('./router.js') const responseHelper = require('./responseHelper.js') const handlerEnforcer = require('./handlerEnforcer.js') const pagination = require('./pagination.js') const routes = require('./routes') const url = require('url') const metrics = require('./metrics.js') const schemaValidator = require('./schemaValidator.js') &nbsp; jsonApi.Joi = ourJoi.Joi jsonApi.metrics = metrics.emitter jsonApi.MemoryHandler = require('./MemoryHandler') jsonApi.ChainHandler = require('./ChainHandler') &nbsp; jsonApi.setConfig = <span class="fstat-no" title="function not covered" >ap</span>iConfig =&gt; { <span class="cstat-no" title="statement not covered" > jsonApi._apiConfig = apiConfig</span> <span class="cstat-no" title="statement not covered" > jsonApi._apiConfig.base = jsonApi._cleanBaseUrl(jsonApi._apiConfig.base)</span> <span class="cstat-no" title="statement not covered" > jsonApi._apiConfig.pathPrefix = apiConfig.urlPrefixAlias || jsonApi._concatenateUrlPrefix(jsonApi._apiConfig)</span> <span class="cstat-no" title="statement not covered" > responseHelper.setBaseUrl(jsonApi._apiConfig.pathPrefix)</span> <span class="cstat-no" title="statement not covered" > responseHelper.setMetadata(jsonApi._apiConfig.meta)</span> } &nbsp; jsonApi.authenticate = router.authenticateWith &nbsp; jsonApi._concatenateUrlPrefix = <span class="fstat-no" title="function not covered" >co</span>nfig =&gt; <span class="cstat-no" title="statement not covered" >url.format({</span> protocol: config.protocol, hostname: config.hostname, port: config.port, pathname: config.base }) &nbsp; jsonApi._cleanBaseUrl = <span class="fstat-no" title="function not covered" >ba</span>se =&gt; { <span class="cstat-no" title="statement not covered" > if (!base) {</span> <span class="cstat-no" title="statement not covered" > base = ''</span> } <span class="cstat-no" title="statement not covered" > if (base[0] !== '/') {</span> <span class="cstat-no" title="statement not covered" > base = `/${base}`</span> } <span class="cstat-no" title="statement not covered" > if (base[base.length - 1] !== '/') {</span> <span class="cstat-no" title="statement not covered" > base += '/'</span> } <span class="cstat-no" title="statement not covered" > return base</span> } &nbsp; jsonApi.define = <span class="fstat-no" title="function not covered" >re</span>sourceConfig =&gt; { <span class="cstat-no" title="statement not covered" > if (!resourceConfig.resource.match(/^[A-Za-z0-9_]*$/)) {</span> <span class="cstat-no" title="statement not covered" > throw new Error(`Resource '${resourceConfig.resource}' contains illegal characters!`)</span> } <span class="cstat-no" title="statement not covered" > resourceConfig.namespace = resourceConfig.namespace || 'default'</span> <span class="cstat-no" title="statement not covered" > resourceConfig.searchParams = resourceConfig.searchParams || { }</span> <span class="cstat-no" title="statement not covered" > jsonApi._resources[resourceConfig.resource] = resourceConfig</span> &nbsp; <span class="cstat-no" title="statement not covered" > handlerEnforcer.wrap(resourceConfig.handlers)</span> &nbsp; <span class="cstat-no" title="statement not covered" > resourceConfig.handlers.initialise = resourceConfig.handlers.initialise || resourceConfig.handlers.initialize</span> <span class="cstat-no" title="statement not covered" > if (resourceConfig.handlers.initialise) {</span> <span class="cstat-no" title="statement not covered" > resourceConfig.handlers.initialise(resourceConfig)</span> } &nbsp; <span class="cstat-no" title="statement not covered" > Object.keys(resourceConfig.attributes).forEach(<span class="fstat-no" title="function not covered" >at</span>tribute =&gt; {</span> <span class="cstat-no" title="statement not covered" > if (!attribute.match(/^[A-Za-z0-9_]*$/)) {</span> <span class="cstat-no" title="statement not covered" > throw new Error(`Attribute '${attribute}' on ${resourceConfig.resource} contains illegal characters!`)</span> } }) &nbsp; <span class="cstat-no" title="statement not covered" > resourceConfig.searchParams = _.assign({</span> type: ourJoi.Joi.any().required().valid(resourceConfig.resource) .description(`Always "${resourceConfig.resource}"`) .example(resourceConfig.resource), sort: ourJoi.Joi.any() .description('An attribute to sort by') .example('title'), filter: ourJoi.Joi.any() .description('An attribute+value to filter by') .example('title'), fields: ourJoi.Joi.any() .description('An attribute+value to filter by') .example('title'), include: ourJoi.Joi.any() .description('An attribute to include') .example('title') }, resourceConfig.searchParams, pagination.joiPageDefinition) &nbsp; <span class="cstat-no" title="statement not covered" > resourceConfig.attributes = _.assign({</span> id: ourJoi.Joi.string().required() .description('Unique resource identifier') .example('1234'), type: ourJoi.Joi.string().required().valid(resourceConfig.resource) .description(`Always "${resourceConfig.resource}"`) .example(resourceConfig.resource), meta: ourJoi.Joi.object().optional() }, resourceConfig.attributes) &nbsp; <span class="cstat-no" title="statement not covered" > resourceConfig.onCreate = _.pick.apply(_, [].concat(resourceConfig.attributes, Object.keys(resourceConfig.attributes).filter(<span class="fstat-no" title="function not covered" >i </span>=&gt; <span class="cstat-no" title="statement not covered" >(resourceConfig.attributes[i]._meta.indexOf('readonly') === -1) &amp;&amp; (!(resourceConfig.attributes[i]._settings || { }).__as))</span>))</span> } &nbsp; jsonApi.onUncaughtException = <span class="fstat-no" title="function not covered" >er</span>rHandler =&gt; { <span class="cstat-no" title="statement not covered" > jsonApi._errHandler = errHandler</span> } &nbsp; jsonApi.getExpressServer = <span class="fstat-no" title="function not covered" >()</span> =&gt; <span class="cstat-no" title="statement not covered" >router.getExpressServer()</span> &nbsp; jsonApi.start = <span class="fstat-no" title="function not covered" >()</span> =&gt; { <span class="cstat-no" title="statement not covered" > schemaValidator.validate(jsonApi._resources)</span> <span class="cstat-no" title="statement not covered" > router.applyMiddleware()</span> <span class="cstat-no" title="statement not covered" > routes.register()</span> <span class="cstat-no" title="statement not covered" > if (!jsonApi._apiConfig.router) {</span> <span class="cstat-no" title="statement not covered" > router.listen(jsonApi._apiConfig.port)</span> } } &nbsp; jsonApi.close = <span class="fstat-no" title="function not covered" >()</span> =&gt; { <span class="cstat-no" title="statement not covered" > router.close()</span> <span class="cstat-no" title="statement not covered" > metrics.emitter.removeAllListeners('data')</span> <span class="cstat-no" title="statement not covered" > for (const i in jsonApi._resources) {</span> const resourceConfig = <span class="cstat-no" title="statement not covered" >jsonApi._resources[i]</span> <span class="cstat-no" title="statement not covered" > if (resourceConfig.handlers.close) <span class="cstat-no" title="statement not covered" >resourceConfig.handlers.close()</span></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>