UNPKG

feathers-offline-realtime

Version:

Offline-first realtime replication with optimistic updates.

522 lines (521 loc) 15.3 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/commons/base-engine.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">src/commons</a> base-engine.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">98.81% </span> <span class="quiet">Statements</span> <span class='fraction'>83/84</span> </div> <div class='fl pad1y space-right2'> <span class="strong">82.22% </span> <span class="quiet">Branches</span> <span class='fraction'>37/45</span> </div> <div class='fl pad1y space-right2'> <span class="strong">85.71% </span> <span class="quiet">Functions</span> <span class='fraction'>6/7</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Lines</span> <span class='fraction'>79/79</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</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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">144x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">288x</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">72x</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">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-yes">72x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">72x</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">65x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">61x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</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">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</span> <span class="cline-any cline-yes">65x</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">77x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-yes">12x</span> <span class="cline-any cline-yes">12x</span> <span class="cline-any cline-neutral">&nbsp;</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">&nbsp;</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">&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">77x</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">257x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-yes">45x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-yes">18x</span> <span class="cline-any cline-yes">12x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">18x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">59x</span> <span class="cline-any cline-yes">12x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">47x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">47x</span> <span class="cline-any cline-yes">47x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">47x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">67x</span> <span class="cline-any cline-yes">67x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">67x</span> <span class="cline-any cline-yes">67x</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-neutral">&nbsp;</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-neutral">&nbsp;</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-neutral">&nbsp;</span> <span class="cline-any cline-yes">154x</span> <span class="cline-any cline-yes">77x</span> <span class="cline-any cline-yes">257x</span> <span class="cline-any cline-yes">45x</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">32x</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">&nbsp; import EventEmitter from 'component-emitter'; &nbsp; import makeDebug from 'debug'; const debug = makeDebug('base-engine'); &nbsp; export default class BaseEngine { constructor (service, options = <span class="branch-1 cbranch-no" title="branch not covered" >{}) {</span> debug('constructor entered'); &nbsp; this._service = service; this._publication = options.publication; this._subscriber = options.subscriber || (() =&gt; {}); this._sorter = options.sort; this._eventEmitter = new EventEmitter(); &nbsp; this._listener = eventName =&gt; remoteRecord =&gt; this._mutateStore( eventName, remoteRecord, 0 ); &nbsp; this._eventListeners = { created: this._listener('created'), updated: this._listener('updated'), patched: this._listener('patched'), removed: this._listener('removed') }; &nbsp; this.useUuid = options.uuid; this.emit = this._eventEmitter.emit; this.on = this._eventEmitter.on; this.listening = false; &nbsp; this.store = { last: { eventName: '', action: '', record: {} }, records: [] }; } &nbsp; snapshot (records) { debug('snapshot entered'); &nbsp; this.store.last = { action: 'snapshot' }; this.store.records = records; &nbsp; if (this._sorter) { records.sort(this._sorter); } &nbsp; this.emit('events', this.store.records, this.store.last); this._subscriber(this.store.records, this.store.last); } &nbsp; addListeners () { debug('addListeners entered'); const service = this._service; const eventListeners = this._eventListeners; &nbsp; service.on('created', eventListeners.created); service.on('updated', eventListeners.updated); service.on('patched', eventListeners.patched); service.on('removed', eventListeners.removed); &nbsp; this.listening = true; this.emit('events', this.store.records, { action: 'add-listeners' }); this._subscriber(this.store.records, { action: 'add-listeners' }); } &nbsp; removeListeners () { debug('removeListeners entered'); &nbsp; if (this.listening) { const service = this._service; const eventListeners = this._eventListeners; &nbsp; service.removeListener('created', eventListeners.created); service.removeListener('updated', eventListeners.updated); service.removeListener('patched', eventListeners.patched); service.removeListener('removed', eventListeners.removed); &nbsp; this.listening = false; this.emit('events', this.store.records, { action: 'remove-listeners' }); this._subscriber(this.store.records, { action: 'remove-listeners' }); } } &nbsp; _mutateStore (eventName, remoteRecord, source) { debug(`_mutateStore started: ${eventName}`); const that = this; &nbsp; c</span>onst idName = t</span>his._useUuid ? <span class="branch-0 cbranch-no" title="branch not covered" >'uuid' : ('id' in remoteRecord ? 'id' : <span class="branch-1 cbranch-no" title="branch not covered" >'_id'); const store = this.store; const records = store.records; &nbsp; const index = this._findIndex(records, record =&gt; record[idName] === remoteRecord[idName]); &nbsp; if (index &gt;= 0) { records.splice(index, 1); } &nbsp; if (eventName === 'removed') { if (index &gt;= 0) { broadcast('remove'); } else if (source === 0 &amp;&amp; (!this._publication || this._publication(remoteRecord))) { // Emit service event if it corresponds to a previous optimistic remove broadcast('remove'); } &nbsp; return; // index &gt;= 0 ? broadcast('remove') : undefined; } &nbsp; if (this._publication &amp;&amp; !this._publication(remoteRecord)) { return index &gt;= 0 ? broadcast('left-pub') : undefined; } &nbsp; records[records.length] = remoteRecord; &nbsp; <span class="missing-if-branch" title="else path not taken" >E</span>if (this._sorter) { records.sort(this._sorter); } &nbsp; return broadcast('mutated'); &nbsp; function broadcast (action) { debug(`emitted ${index} ${eventName} ${action}`); store.last = { source, action, eventName, record: remoteRecord }; &nbsp; that.emit('events', records, store.last); that._subscriber(records, store.last); } } &nbsp; changeSort (sort) { this._sorter = sort; &nbsp; <span class="missing-if-branch" title="else path not taken" >E</span>if (this._sorter) { this.store.records.sort(this._sorter); } &nbsp; this.emit('events', this.store.records, { action: 'change-sort' }); this._subscriber(this.store.records, { action: 'change-sort' }); } &nbsp; _findIndex (array, predicate = <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" ><span class="branch-1 cbranch-no" title="branch not covered" >() =&gt; true, fromIndex = </span></span>0) <span class="branch-1 cbranch-no" title="branch not covered" ><span class="branch-0 cbranch-no" title="branch not covered" >{</span></span></span> for (let i = fromIndex, len = array.length; i &lt; len; i++) { if (predicate(array[i])) { return i; } } &nbsp; return -1; } } &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 Sun Jul 09 2017 16:17:53 GMT-0400 (EDT) </div> </div> <script src="../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../sorter.js"></script> </body> </html>