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