UNPKG

apollo-tracer

Version:

Trace collection library for Node.js GraphQL servers

660 lines (659 loc) 18.5 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for Tracer.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> Tracer.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Statements</span> <span class='fraction'>72/72</span> </div> <div class='fl pad1y space-right2'> <span class="strong">88.46% </span> <span class="quiet">Branches</span> <span class='fraction'>23/26</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Functions</span> <span class='fraction'>11/11</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Lines</span> <span class='fraction'>71/71</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</td><td class="line-coverage quiet"><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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">42x</span> <span class="cline-any cline-yes">7x</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">6x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">6x</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">5x</span> <span class="cline-any cline-yes">5x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">5x</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">5x</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-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">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">33x</span> <span class="cline-any cline-yes">33x</span> <span class="cline-any cline-yes">33x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">33x</span> <span class="cline-any cline-yes">33x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</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">16x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-yes">5x</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">16x</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-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">9x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</span> <span class="cline-any cline-yes">16x</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-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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">15x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">13x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-yes">2x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">11x</span> <span class="cline-any cline-yes">10x</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-neutral">&nbsp;</span> <span class="cline-any cline-yes">8x</span> <span class="cline-any cline-yes">8x</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">10x</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-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-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-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">2x</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-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">6x</span> <span class="cline-any cline-yes">6x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">6x</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></td><td class="text"><pre class="prettyprint lang-js">import now from 'performance-now'; import uuid from 'node-uuid'; import request from 'request'; import { forEachField } from 'graphql-tools'; &nbsp; const TRACER_INGRESS_URL = 'https://nim-test-ingress.appspot.com'; &nbsp; class Tracer { // TODO make sure Tracer can NEVER crash the server. // maybe wrap everything in try/catch, but need to test that. &nbsp; constructor({ TRACER_APP_KEY, sendReports = true, reportFilterFn, proxy }) { if (!TRACER_APP_KEY || TRACER_APP_KEY.length &lt; 36) { throw new Error('Tracer requires a well-formatted TRACER_APP_KEY'); } // TODO check that sendReports is a boolean // TODO check that report filter fn is a function (if defined) this.TRACER_APP_KEY = TRACER_APP_KEY; this.startTime = (new Date()).getTime(); this.startHrTime = now(); this.sendReports = sendReports; this.reportFilterFn = reportFilterFn; this.proxy = proxy; } &nbsp; sendReport(report) { let filteredEvents = report.events; if (this.reportFilterFn) { filteredEvents = report.events.filter(this.reportFilterFn); } const options = { url: TRACER_INGRESS_URL, proxy: this.proxy, method: 'PUT', headers: { 'user-agent': `apollo tracer v${report.tracerApiVersion}`, }, json: { ...report, events: filteredEvents, }, }; request(options, (err) =&gt; { <span class="missing-if-branch" title="else path not taken" >E</span>if (err) { console.error('Error trying to report to tracer backend:', err.message); return; } // console.log('status', response.statusCode); }); } &nbsp; newLoggerInstance() { const queryId = uuid.v4(); const events = []; let idCounter = 0; const startTime = (new Date()).getTime(); const startHrTime = now(); &nbsp; const log = (type, data = <span class="branch-0 cbranch-no" title="branch not covered" >null) =&gt; {</span> const id = idCounter++; const timestamp = now(); // const timestamp = (new Date()).getTime(); // console.log(timestamp, type, id, data); events.push({ id, timestamp, type, data }); return id; }; &nbsp; const report = () =&gt; { return { TRACER_APP_KEY: this.TRACER_APP_KEY, tracerApiVersion: '0.1.0', queryId, startTime, startHrTime, events, }; }; &nbsp; const submit = () =&gt; { if (this.sendReports) { this.sendReport(report()); } }; &nbsp; return { log, report, submit, }; } &nbsp; /* log(type, data = null) { // TODO ensure props is a valid props thingy // TODO ensure info is a valid info thingy // TODO ensure type is a valid type thingy const id = this.idCounter++; const timestamp = now(); // const timestamp = (new Date()).getTime(); console.log(timestamp, type, id, data); this.events.push({ id, timestamp, type, data }); return id; } &nbsp; report() { return { queryId: this.queryId, startTime: this.startTime, startHrTime: this.startHrTime, events: this.events, }; } */ } &nbsp; function decorateWithTracer(fn, info) { return (p, a, ctx, i) =&gt; { const startEventId = ctx.tracer.log('resolver.start', info); let result; try { result = fn(p, a, ctx, i); } catch (e) { // console.log('yeah, it errored directly'); ctx.tracer.log('resolver.end', { ...info, resolverError: { message: e.message, stack: e.stack, }, startEventId, }); throw e; } &nbsp; try { if (result === null) { ctx.tracer.log('resolver.end', { ...info, returnedNull: true, startEventId }); return result; } if (typeof result === 'undefined') { ctx.tracer.log('resolver.end', { ...info, returnedUndefined: true, startEventId }); return result; } if (typeof result.then === 'function') { result.then((res) =&gt; { ctx.tracer.log('resolver.end', { ...info, startEventId }); return res; }) .catch((err) =&gt; { // console.log('whoa, it threw an error!'); ctx.tracer.log('resolver.end', { ...info, startEventId }); throw err; }); } else { // console.log('did not return a promise. logging now'); ctx.tracer.log('resolver.end', { ...info, startEventId }); } return result; } catch (e) { // XXX this should basically never happen // if it does happen, we want to be able to collect these events. ctx.tracer.log('tracer.error', { ...info, result, tracerError: { message: e.message, stack: e.stack, }, startEventId, }); ctx.tracer.log('resolver.end', { ...info, startEventId }); return result; } }; } &nbsp; // This function modifies the schema in place to add tracing around all resolve functions function addTracingToResolvers(schema) { // XXX this is a hacky way of making sure that the schema only gets decorated // with tracer once. if (schema._apolloTracerApplied) { // console.log('Tracing already added to resolve functions. Not adding again.'); return; } // eslint-disable-next-line no-param-reassign schema._apolloTracerApplied = true; &nbsp; forEachField(schema, (field, typeName, fieldName) =&gt; { const functionName = `${typeName}.${fieldName}`; <span class="missing-if-branch" title="else path not taken" >E</span>if (field.resolve) { // eslint-disable-next-line no-param-reassign field.resolve = decorateWithTracer( field.resolve, { type: 'resolve', functionName }, ); } }); } &nbsp; export { Tracer, decorateWithTracer, addTracingToResolvers }; &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 Tue Jun 14 2016 20:58:13 GMT-0700 (PDT) </div> </div> <script src="prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="sorter.js"></script> </body> </html>