Show small per-benchmark summaries in the graph index
[gipeda.git] / site / js / gipeda.js
1 // Main document
2 var data = {};
3 // Name of the current view
4 var view = 'index';
5 // Options of the current view
6 var viewData = {};
7
8 // Nonpersistent settings
9 var settings = {
10     benchFilter: {
11         improvements: true,
12         boring: false,
13         regressions: true,
14     },
15     collapsedGroups: [true, false, false, false]
16 };
17
18 // Signals
19
20 viewChanged = new signals.Signal()
21 dataChanged = new signals.Signal()
22
23
24 // Routes
25
26 var routes = {
27     index:
28         { regex: /^$/,
29           download: ['out/latest-summaries.json'],
30           url: function () {return ""},
31         },
32     complete:
33         { regex: /^all$/,
34           download: ['out/all-summaries.json'],
35           url: function () {return "all"},
36         },
37     graphIndex:
38         { regex: /^graphs$/,
39           download: ['out/benchNames.json', 'out/graph-summaries.json'],
40           url: function () {return "graphs"},
41         },
42     revision:
43         { regex: /^revision\/([a-f0-9]+)$/,
44           viewData: function (match) { return { hash: match[1] }; },
45           download: function () {
46             return ['out/benchNames.json','out/reports/' + viewData.hash + '.json'];
47           },
48           url: function (hash) { return "revision/" + hash; },
49         },
50     compare:
51         { regex: /^compare\/([a-f0-9]+)\/([a-f0-9]+)$/,
52           viewData: function (match) { return { hash1: match[1], hash2: match[2] }; },
53           download: function () {
54             return ['out/benchNames.json',
55                     'out/reports/' + viewData.hash1 + '.json',
56                     'out/reports/' + viewData.hash2 + '.json'
57                     ];
58           },
59           url: function (hash1, hash2) { return "compare/" + hash1 + "/" + hash2; },
60         },
61     graph:
62         { regex: /^graph\/(.*)$/,
63           viewData: function (match, options) {
64             var highlights = [];
65             options.forEach(function (opt) {
66                 var m;
67                 if (m = /hl=(.*)/.exec(opt)) {
68                     highlights.push(m[1]);
69                 }
70             });
71             return {
72                 benchName: match[1],
73                 highlights: highlights,
74             };
75           },
76           download: function () {
77             return ['out/latest-summaries.json','out/graphs/' + viewData.benchName + '.json'];
78           },
79           url: function (benchName, hls) {
80             var comps = [ "graph/" + benchName ];
81             $.merge(comps, hls.map(function (hl) { return "hl=" + hl }));
82             return comps.join(';');
83           },
84         },
85 };
86
87 function parseRoute (path) {
88     var options = path.split(";");
89     var routePath = options.shift();
90
91     $.each(routes, function (v,r) {
92         var match = r.regex.exec(routePath);
93         if (match) {
94             view = v;
95             if (r.viewData) viewData = r.viewData(match, options);
96             return false;
97         } else {
98             return true;
99         }
100     });
101     viewChanged.dispatch();
102 }
103
104 viewChanged.add(function () {
105     if (routes[view].download) {
106         d = routes[view].download;
107         if ($.isFunction(d)) {d = d()}
108         d.forEach(function (url) { getJSON(url) });
109     }
110 });
111
112 function handleHashChange(newHash) {
113     parseRoute(newHash);
114 }
115
116 // Data
117
118 function commitsFrom(revs, hash, count) {
119   // Can happen during loading
120   if (!revs) {return []};
121
122   if (count == 0) return [];
123
124   var rev = revs[hash];
125   if (rev) {
126     if (rev.summary.parents.length > 0) {
127       var later = commitsFrom(revs, rev.summary.parents[0], count - 1);
128       later.unshift(rev);
129       return later;
130     } else {
131       return [ rev ];
132     }
133   } else {
134     return []
135   }
136 }
137
138
139 // Template handling
140 var templates = {};
141
142 $(function ()  {
143   var template_ids =  ["revision", "compare", "index", "complete", "graphIndex", "graph", "revTooltip"];
144   template_ids.forEach(function(id) {
145     var source = $("#" + id).html();
146     templates[id] = Handlebars.compile(source);
147   });
148
149   var partials_ids =  ["nav", "summary-icons", "summary-list", "nothing"];
150   partials_ids.forEach(function(id) {
151     var source = $("#" + id).html();
152     Handlebars.registerPartial(id, source);
153   });
154
155 });
156
157 Handlebars.registerHelper('revisionLink', function(hash) {
158   if (!hash) { return "#"; }
159   return "#" + routes.revision.url(hash);
160 });
161 Handlebars.registerHelper('compareLink', function(hash1,hash2) {
162   if (!hash1) { return "#"; }
163   if (!hash2) { return "#"; }
164   return "#" + routes.compare.url(hash1,hash2);
165 });
166 Handlebars.registerHelper('graphLink', function(benchName, hl1, hl2) {
167     hls = [];
168     if (hl1) {hls.push(hl1)};
169     if (hl2) {hls.push(hl2)};
170     return "#" + routes.graph.url(benchName,hls);
171 });
172 Handlebars.registerHelper('diffLink', function(rev1, rev2) {
173   return data.settings.cgitLink + "/commitdiff/" + rev2
174 });
175 Handlebars.registerHelper('logLink', function(rev, options) {
176   if (data.settings.logLink) {
177     var link = Handlebars.compile(data.settings.logLink)({rev: rev});
178     $.extend(this,{link:link});
179     return options.fn(this);
180   }
181 });
182 Handlebars.registerHelper('indexLink', function() {
183   return "#" + routes.index.url();
184 });
185 Handlebars.registerHelper('allLink', function() {
186   return "#" + routes.complete.url();
187 });
188 Handlebars.registerHelper('graphIndexLink', function() {
189   return "#" + routes.graphIndex.url();
190 });
191 Handlebars.registerHelper('recentCommits', function(revisions) {
192   return commitsFrom(revisions, data.latest, data.settings.limitRecent);
193 });
194 Handlebars.registerHelper('allCommits', function(revisions) {
195   return commitsFrom(revisions, data.latest, -1);
196 });
197 function shortRev(rev) {
198   if (!rev) { return ''; }
199   return rev.substr(0,7);
200 }
201 Handlebars.registerHelper('shortRev', shortRev);
202 Handlebars.registerHelper('iso8601', function(timestamp) {
203   if (!timestamp) { return '' };
204   return new Date(timestamp*1000).toISOString();
205 });
206 Handlebars.registerHelper('humanDate', function(timestamp) {
207   return new Date(timestamp*1000).toString();
208 });
209
210 // We cache everything
211 var jsonSeen = {};
212 var jsonFetching = {};
213 function getJSON(url, callback, options) {
214     var opts = {
215         block: true,
216     };
217     $.extend(opts, options);
218     if (jsonSeen[url]) {
219         console.log("Not fetching "+url+" again.");
220         if (callback) callback();
221     } else if (jsonFetching[url]) {
222         console.log("Already fetching "+url+".");
223         if (callback) jsonFetching[url].push(callback);
224     } else {
225         console.log("Fetching "+url+".");
226         jsonFetching[url] = [];
227         if (callback) jsonFetching[url].push(callback);
228         $.ajax(url, {
229             success: function (newdata) {
230                 console.log("Fetched "+url+".");
231                 jsonSeen[url] = true;
232                 $.extend(true, data, newdata);
233                 dataChanged.dispatch();
234                 $.each(jsonFetching[url], function (i,c) {c()});
235                 delete jsonFetching[url];
236             },
237             error: function (e) {
238                 console.log("Failure fetching "+url,e);
239             },
240             cache: false,
241             dataType: 'json',
242         });
243     }
244 }
245
246
247 // Views
248
249 function groupStats (benchResults) {
250   return {
251     totalCount: benchResults.length,
252     improvementCount: benchResults.filter(function (br) { return br.changeType == 'Improvement' }).length,
253     regressionCount:  benchResults.filter(function (br) { return br.changeType == 'Regression' }).length,
254   }
255 }
256
257 function benchmark_name_matches(pattern, name) {
258     if (pattern[pattern.length-1] == "*") {
259         return pattern.substr(0, pattern.length-1) == name.substr(0, pattern.length-1);
260     } else {
261         return pattern == name;
262     }
263 }
264
265 // The following logic should be kept in sync with BenchmarkSettings.hs
266 function setting_for(name) {
267     var benchSettings = {
268         smallerIsBetter: true,
269         unit: "",
270         type: "integral",
271         group: "",
272         threshold: 3,
273         important: true
274     };
275
276     data.settings.benchmarks.map(function (s) {
277         if (benchmark_name_matches(s.match, name)) {
278             $.extend(benchSettings, s);
279         }
280     })
281
282     return benchSettings;
283 }
284
285
286 // The following logic should be kept in sync with toResult in ReportTypes.hs
287 function compareResults (res1, res2) {
288     if (!res1 && !res2) { return };
289
290     name = res1? res1.name : res2.name;
291     s = setting_for(name);
292
293     res = {
294         name: name,
295         previous:    res1 ? res1.value : null,
296         value:       res2 ? res2.value : null,
297         unit:        s.unit,
298         important:   s.important,
299         changeType: "Boring",
300         change: "foobar",
301     };
302
303     if (res1 && res2){
304         if (s.type == "integral" || s.type == "float"){
305             if (res1.value == 0 && res2.value == 0) {
306                 res.change = "=";
307             } else if (res1.value == 0) {
308                 res.change = "+  ∞";
309                 res.changeType = "Improvement";
310             } else {
311                 var perc = 100.0 * (res2.value - res1.value) / res1.value;
312                 var percS = Math.round (perc * 100.0) / 100;
313                 if (Math.abs(perc) < 0.01) {
314                     res.change = "=";
315                 } else if (perc >= 0) {
316                     res.change = "+ " + percS + "%";
317                 } else {
318                     res.change = "- " + (-percS) + "%";
319                 }
320
321                 if (Math.abs(perc) >= s.threshold) {
322                     if (perc >= 0) {
323                         s.changeType = "Improvement";
324                     } else {
325                         s.changeType = "Regression";
326                     }
327                 }
328             }
329         } else if (s.type == "small integral") {
330             if (res1.value == res2.value) {
331                 res.change = "=";
332             } else if (res2.value > res1.value) {
333                 res.change = "+" + (res2.value - res1.value);
334                 res.changeType = "Improvement";
335             } else if (res1.value > res2.value) {
336                 res.change = "-" + (res1.value - res2.value);
337                 res.changeType = "Regression";
338             }
339         }
340
341         if (s.smallerIsBetter) {
342             if (res.changeType == "Improvement") {
343                 res.changeType = "Regression";
344             } else if (res.changeType == "Regression") {
345                 res.changeType = "Improvement";
346             }
347         }
348     }
349
350     return res;
351 }
352
353 // Some views require the data to be prepared in ways that are 
354 // too complicated for the template, so lets do it here.
355 dataViewPrepare = {
356   'revision': function (data, viewData) {
357     if (!data.benchGroups || !data.revisions) return {};
358     var hash = viewData.hash;
359     var rev = data.revisions[hash];
360     if (!rev) return {};
361     if (!rev.benchResults) return {};
362
363     var groups = data.benchGroups.map(function (group) {
364       var benchmarks = group.groupMembers.map(function (bn) {
365         return rev.benchResults[bn]
366       }).filter(function (br) {return br});
367       return {
368         groupName: group.groupName,
369         benchResults: benchmarks,
370         groupStats: groupStats(benchmarks),
371       };
372     });
373     return {
374       rev : rev,
375       groups : groups,
376     };
377   },
378   'compare': function (data, viewData) {
379     if (!data.benchGroups || !data.revisions) return {};
380     var hash1 = viewData.hash1;
381     var hash2 = viewData.hash2;
382     var rev1 = data.revisions[hash1];
383     var rev2 = data.revisions[hash2];
384     if (!rev1) return {};
385     if (!rev1.benchResults) return {};
386     if (!rev2) return {};
387     if (!rev2.benchResults) return {};
388
389     var groups = data.benchGroups.map(function (group) {
390       var benchmarks = group.groupMembers.map(function (bn) {
391         var r1 = rev1.benchResults[bn];
392         var r2 = rev2.benchResults[bn];
393         return compareResults(r1,r2);
394       }).filter(function (br) {return br});
395       return {
396         groupName: group.groupName,
397         benchResults: benchmarks,
398         groupStats: groupStats(benchmarks),
399       };
400     });
401     return {
402       rev1 : rev1,
403       rev2 : rev2,
404       groups : groups,
405     };
406   },
407 }
408
409 function load_template () {
410     console.log('Rebuilding page');
411     var context = {};
412     $.extend(context, data, viewData, settings);
413     if (dataViewPrepare[view]){
414       $.extend(context, dataViewPrepare[view](data, viewData));
415     }
416     $('#main').html(templates[view](context));
417
418     $(".nav-loading").toggle(jQuery.active > 0);
419
420     updateBenchFilter();
421     updateCollapsedGroups();
422     $('abbrv.timeago').timeago();
423
424     if ($('#benchChart').length) {
425         setupChart();
426     }
427 }
428 viewChanged.add(load_template);
429 dataChanged.add(load_template);
430
431 function setupChart () {
432     
433     var commits = commitsFrom(data.revisions, data.latest, data.settings.limitRecent);
434     var benchName = viewData.benchName;
435
436     $("<div id='tooltip' class='panel alert-info'></div>").css({
437                 position: "absolute",
438                 display: "none",
439                 //border: "1px solid #fdd",
440                 padding: "2px",
441                 //"background-color": "#fee",
442                 // opacity: 0.80,
443                 width: '300px',
444         }).appendTo("#main");
445
446     var plot_series = {
447           lines: { show: true, fill: true, fillColor: "rgba(255, 255, 255, 0.8)" },
448           points: { show: true, fill: false },
449           label: benchName,
450           data: commits.map(function (x,i){
451             if (!x.benchResults) return;
452             if (!x.benchResults[benchName]) return;
453             return [commits.length - i, x.benchResults[benchName].value]
454           }),
455         };
456
457     var plot_options = {
458           legend: {
459                 position: 'nw',
460           },
461           grid: {
462                 hoverable: true,
463                 clickable: true,
464           },
465           yaxis: {},
466           xaxis: {
467                 // ticks: values.map(function (x,i){return [i,x[0]]}),
468                 tickFormatter: function (i,axis) {
469                         if (i > 0 && i <= commits.length) {
470                                 var rev = commits[commits.length - i];
471                                 if (!rev) return "";
472                                 var date = new Date(rev.summary.gitDate * 1000);
473                                 return $.timeago(date);
474                         } else {
475                                 return '';
476                         }
477                 }
478           }
479         };
480
481     var type;
482     if (data.benchmarkSettings && data.benchmarkSettings[benchName]) {
483         type = data.benchmarkSettings[benchName].type;
484     }
485     if (type == "integral" || type == "small integral") {
486         plot_options.yaxis.minTickSize = 1;
487         plot_options.yaxis.tickDecimals = 0;
488     }
489
490     var plot = $.plot("#benchChart", [plot_series], plot_options);
491
492     viewData.highlights.forEach(function (hash) {
493         commits.forEach(function (rev,i) {
494             if (rev.summary.hash == hash)  {
495                 plot.highlight(0, i);
496             };
497         });
498     });
499
500
501     $("#benchChart").bind("plothover", function (event, pos, item) {
502         if (item) {
503                 var v = item.datapoint[1];
504                 var i = item.dataIndex;
505                 var rev = commits[i].summary.hash;
506                 var summary = commits[i].summary;
507
508                 var tooltipContext = $.extend({value: v}, summary);
509
510                 if ($("#tooltip").data('rev') != rev) {
511                     $("#tooltip")
512                         .html(shortRev(rev))
513                         .data('rev',rev)
514                         .html(templates.revTooltip(tooltipContext))
515                         .fadeIn(200)
516                         .css({top: item.pageY+10, left: item.pageX-100})
517                         .show();
518                     $("#benchChart").css('cursor','pointer');
519                 }
520         } else {
521                 $("#tooltip").data('rev',null).hide();
522                 $("#benchChart").css('cursor','default');
523         }
524     });
525     $("#benchChart").bind("plotclick", function (event, pos, item) {
526         if (item) {
527                 var v = item.datapoint[1];
528                 var i = item.dataIndex;
529                 var hash = commits[i].summary.hash;
530                 
531                 goTo(routes.revision.url(hash));
532         }
533     });
534 }
535
536 function updateCollapsedGroups() {
537     // Does not work yet...
538     /*
539
540     var list = settings.collapsedGroups;
541     console.log(list);
542     if ($(".panel-collapse").length) {
543         $(".panel-collapse").each(function (i){
544             if (i < list.length) {
545                 console.log(i, list[i], this);
546                 $(this).toggleClass('in', !list[i]);
547
548                 $(this).collapse();
549                 if (list[i]) {
550                     $(this).collapse('hide');
551                 } else {
552                     $(this).collapse('show');
553                 }
554             }
555         });
556     }
557     */
558 }
559
560 function updateBenchFilter() {
561     var showRegressions  = settings.benchFilter.regressions;
562     var showBoring       = settings.benchFilter.boring;
563     var showImprovements = settings.benchFilter.improvements;
564
565     $('#show-regressions').toggleClass('active', showRegressions);
566     $('#show-boring').toggleClass('active', showBoring); 
567     $('#show-improvements').toggleClass('active', showImprovements);
568
569     $('tr.row-Regression').toggle(showRegressions);
570     $('tr.row-Boring').toggle(showBoring);
571     $('tr.row-Improvement').toggle(showImprovements);
572
573     $('.bench-panel').show().each(function() {
574         if ($(this).has('tr.row-result:visible').length == 0) {
575             $(this).hide();
576         }
577     });
578
579     $('tr.summary-row').addClass('summary-row-collapsed');
580     if (showBoring) {
581         $('tr.summary-row:not(.summary-improvement):not(.summary-regression)')
582             .removeClass('summary-row-collapsed');
583     }
584     if (showRegressions) {
585         $('tr.summary-row.summary-regression')
586             .removeClass('summary-row-collapsed');
587     }
588     if (showImprovements) {
589         $('tr.summary-row.summary-improvement')
590             .removeClass('summary-row-collapsed');
591     }
592     $('tr.summary-row').first()
593             .removeClass('summary-row-collapsed');
594
595     updateNothingToSee();
596 };
597
598 function updateNothingToSee() {
599     $('.nothing-to-see')
600         .toggle(jQuery.active == 0 && $('.bench-panel:visible, tr.summary-row:not(.summary-row-collapsed)').length == 0);
601 }
602
603 $(function (){
604     $('body').on('click', '.benchSelector', function (event) {
605         $(this).toggleClass('active');
606         settings.benchFilter = {
607             regressions:  $('#show-regressions').hasClass('active'),
608             boring:       $('#show-boring').hasClass('active'), 
609             improvements: $('#show-improvements').hasClass('active'), 
610         };
611         updateBenchFilter();
612     });
613 });
614
615 // Redirection
616
617 function goTo(path) {
618     console.log("goTo " + path);
619     hasher.setHash(path);
620 }
621
622
623 // Main setup
624
625 $(function() {
626     hasher.prependHash = '';
627
628     $('#loading').hide();
629
630     $(document).ajaxStart(function () {
631         $(".nav-loading").show();
632         updateNothingToSee();
633     });
634     $(document).ajaxStop(function () {
635         $(".nav-loading").hide();
636         updateNothingToSee();
637     });
638
639     // Load settins, then figure out what view to use.
640     $.get("out/latest.txt", function (latest) {
641         data.latest = latest;
642
643         getJSON("out/settings.json", function (settings) {
644             $('title').html(data.settings.title + " – Gipeda");
645             hasher.changed.add(handleHashChange);
646             hasher.initialized.add(handleHashChange);
647             hasher.init();
648         });
649     }, 'text');
650
651
652 });