UNPKG

susyweb

Version:

Sophon JavaScript API, middleware to talk to a sophon node over RPC

792 lines (791 loc) 23.9 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for packages/susyweb-core-requestManager/src/index.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">packages/susyweb-core-requestManager/src/</a> index.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">84.21% </span> <span class="quiet">Statements</span> <span class='fraction'>64/76</span> </div> <div class='fl pad1y space-right2'> <span class="strong">74.19% </span> <span class="quiet">Branches</span> <span class='fraction'>46/62</span> </div> <div class='fl pad1y space-right2'> <span class="strong">84.62% </span> <span class="quiet">Functions</span> <span class='fraction'>11/13</span> </div> <div class='fl pad1y space-right2'> <span class="strong">85.33% </span> <span class="quiet">Lines</span> <span class='fraction'>64/75</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 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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243</td><td class="line-coverage quiet"><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-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-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></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-yes"></span> <span class="cline-any cline-yes">1967×</span> <span class="cline-any cline-yes">1967×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1967×</span> <span class="cline-any cline-yes">1967×</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"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></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-yes"></span> <span class="cline-any cline-yes">504×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">504×</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">504×</span> <span class="cline-any cline-yes">504×</span> <span class="cline-any cline-yes">504×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">504×</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">501×</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">501×</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">494×</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-yes"></span> <span class="cline-any cline-yes"></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"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></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"></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"></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-yes"></span> <span class="cline-any cline-yes">35×</span> <span class="cline-any cline-yes">35×</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-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes">32×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">32×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">32×</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">32×</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-yes"></span> <span class="cline-any cline-yes">3605×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3605×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">86×</span> <span class="cline-any cline-yes">26×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">60×</span> <span class="cline-any cline-yes">26×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">34×</span> <span class="cline-any cline-yes">26×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></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">3597×</span> <span class="cline-any cline-yes">36×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3597×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3597×</span> <span class="cline-any cline-yes">1626×</span> <span class="cline-any cline-yes">771×</span> <span class="cline-any cline-yes">725×</span> <span class="cline-any cline-yes">163×</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">46×</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-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"></span> <span class="cline-any cline-yes">36×</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">36×</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-yes">36×</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"></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></td><td class="text"><pre class="prettyprint lang-js">/* This file is part of susyweb.js. &nbsp; susyweb.js is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. &nbsp; susyweb.js is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MSRCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. &nbsp; You should have received a copy of the GNU Lesser General Public License along with susyweb.js. If not, see &lt;http://www.gnu.org/licenses/&gt;. */ /** * @file index.js * @author Fabian Vogelsteller &lt;fabian@ethereum.org&gt; * @date 2017 */ &nbsp; "use strict"; &nbsp; &nbsp; var _ = require('underscore'); var errors = require('susyweb-core-helpers').errors; var Jsonrpc = require('./jsonrpc.js'); var BatchManager = require('./batch.js'); var givenProvider = require('./givenProvider.js'); &nbsp; &nbsp; &nbsp; /** * It's responsible for passing messages to providers * It's also responsible for polling the sophon node for incoming messages * Default poll timeout is 1 second * Singleton */ var RequestManager = function RequestManager(provider) { this.provider = null; this.providers = RequestManager.providers; &nbsp; this.setProvider(provider); this.subscriptions = {}; }; &nbsp; &nbsp; &nbsp; RequestManager.givenProvider = givenProvider; &nbsp; RequestManager.providers = { WebsocketProvider: require('susyweb-providers-ws'), HttpProvider: require('susyweb-providers-http'), IpcProvider: require('susyweb-providers-ipc') }; &nbsp; &nbsp; /** * Should be used to asynchronously send request * * @method sendAsync * @param {Object} data * @param {Function} callback */ RequestManager.prototype.send = function (data, callback) { callback = callback || function(){}; &nbsp; <span class="missing-if-branch" title="if path not taken" >I</span>if (!this.provider) { <span class="cstat-no" title="statement not covered" > return callback(errors.InvalidProvider());</span> } &nbsp; var payload = Jsonrpc.toPayload(data.method, data.params); this.provider.send(payload, function (err, result) { <span class="missing-if-branch" title="if path not taken" >I</span>if(result.id &amp;&amp; payload.id !== result.id) <span class="cstat-no" title="statement not covered" >return callback(new Error('Wrong response id "'+ result.id +'" (expected: "'+ payload.id +'") in '+ JSON.stringify(payload)));</span> &nbsp; if (err) { return callback(err); } &nbsp; <span class="missing-if-branch" title="if path not taken" >I</span>if (result &amp;&amp; result.error) { <span class="cstat-no" title="statement not covered" > return callback(errors.ErrorResponse(result));</span> } &nbsp; if (!Jsonrpc.isValidResponse(result)) { return callback(errors.InvalidResponse(result)); } &nbsp; callback(null, result.result); }); }; &nbsp; /** * Should be called to asynchronously send batch request * * @method sendBatch * @param {Array} batch data * @param {Function} callback */ RequestManager.prototype.sendBatch = function (data, callback) { <span class="missing-if-branch" title="if path not taken" >I</span>if (!this.provider) { <span class="cstat-no" title="statement not covered" > return callback(errors.InvalidProvider());</span> } &nbsp; var payload = Jsonrpc.toBatchPayload(data); this.provider.send(payload, function (err, results) { <span class="missing-if-branch" title="if path not taken" >I</span>if (err) { <span class="cstat-no" title="statement not covered" > return callback(err);</span> } &nbsp; <span class="missing-if-branch" title="if path not taken" >I</span>if (!_.isArray(results)) { <span class="cstat-no" title="statement not covered" > return callback(errors.InvalidResponse(results));</span> } &nbsp; callback(null, results); }); }; &nbsp; &nbsp; /** * Waits for notifications * * @method addSubscription * @param {String} id the subscription id * @param {String} name the subscription name * @param {String} type the subscription namespace (sof, personal, etc) * @param {Function} callback the callback to call for incoming notifications */ RequestManager.prototype.addSubscription = function (id, name, type, callback) { <span class="missing-if-branch" title="else path not taken" >E</span>if(this.provider.on) { this.subscriptions[id] = { callback: callback, type: type, name: name }; &nbsp; } else { <span class="cstat-no" title="statement not covered" > throw new Error('The provider doesn\'t support subscriptions: '+ this.provider.constructor.name);</span> } }; &nbsp; /** * Waits for notifications * * @method removeSubscription * @param {String} id the subscription id * @param {Function} callback fired once the subscription is removed */ RequestManager.prototype.removeSubscription = function (id, callback) { var _this = this; &nbsp; <span class="missing-if-branch" title="else path not taken" >E</span>if(this.subscriptions[id]) { &nbsp; this.send({ method: this.subscriptions[id].type + '_unsubscribe', params: [id] }, callback); &nbsp; // remove subscription delete _this.subscriptions[id]; } }; &nbsp; /** * Should be used to set provider of request manager * * @method setProvider * @param {Object} */ RequestManager.prototype.setProvider = function (p, net) { var _this = this; &nbsp; // autodetect provider if(p &amp;&amp; typeof p === 'string' &amp;&amp; this.providers) { &nbsp; // HTTP if(/^http:\/\//i.test(p)) { p = new this.providers.HttpProvider(p); &nbsp; // WS } else if(/^ws:\/\//i.test(p)) { p = new this.providers.WebsocketProvider(p); &nbsp; // IPC } else if(p &amp;&amp; typeof net === 'object' &amp;&amp; typeof net.connect === 'function') { p = new this.providers.IpcProvider(p, net); &nbsp; } else <span class="missing-if-branch" title="else path not taken" >E</span>if(p) { throw new Error('Can\'t autodetect provider for "'+ p +'"'); } } &nbsp; // reset the old one before changing if(this.provider) this.clearSubscriptions(); &nbsp; &nbsp; this.provider = p; &nbsp; // listen to incoming notifications if(this.provider &amp;&amp; this.provider.on) { this.provider.on('data', function requestManagerNotification(err, result){ if(!err) { if(_this.subscriptions[result.params.subscription] &amp;&amp; _this.subscriptions[result.params.subscription].callback) _this.subscriptions[result.params.subscription].callback(null, result.params.result); } else { &nbsp; Object.keys(_this.subscriptions).forEach(<span class="fstat-no" title="function not covered" >function(id){</span> <span class="cstat-no" title="statement not covered" > if(_this.subscriptions[id].callback)</span> <span class="cstat-no" title="statement not covered" > _this.subscriptions[id].callback(err);</span> }); } }); } }; &nbsp; /** * Should be called to reset the subscriptions * * @method reset */ RequestManager.prototype.clearSubscriptions = function (keepIsSyncing) { var _this = this; &nbsp; &nbsp; // uninstall all subscriptions Object.keys(this.subscriptions).forEach(<span class="fstat-no" title="function not covered" >function(id){</span> <span class="cstat-no" title="statement not covered" > if(!keepIsSyncing || _this.subscriptions[id].name !== 'syncing')</span> <span class="cstat-no" title="statement not covered" > _this.removeSubscription(id);</span> }); &nbsp; &nbsp; // reset notification callbacks etc. <span class="missing-if-branch" title="if path not taken" >I</span>if(this.provider.reset) <span class="cstat-no" title="statement not covered" > this.provider.reset();</span> }; &nbsp; module.exports = { Manager: RequestManager, BatchManager: BatchManager }; &nbsp; &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="http://istanbul-js.org/" target="_blank">istanbul</a> at Sat Jul 22 2017 12:47:05 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>