2d7fa3d070bdd81658f6a2d585907e35d3b41250
[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", "branches"];
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     if (data.settings.diffLink) {
178         return Handlebars.compile(data.settings.diffLink)({base: rev1, rev: rev2});
179     } else {
180         return 'javascript:alert("No diffLink defined in settings")';
181     }
182 });
183 Handlebars.registerHelper('revisionInfo', function(revSummary) {
184     var ctxt = {};
185     ctxt.rev = revSummary.hash;
186     if (revSummary.parents) {
187         ctxt.base=revSummary.parents[0];
188     }
189     var result = Handlebars.compile(data.settings.revisionInfo)(ctxt);
190     return new Handlebars.SafeString(result);
191 });
192 Handlebars.registerHelper('indexLink', function() {
193   return "#" + routes.index.url();
194 });
195 Handlebars.registerHelper('allLink', function() {
196   return "#" + routes.complete.url();
197 });
198 Handlebars.registerHelper('graphIndexLink', function() {
199   return "#" + routes.graphIndex.url();
200 });
201 Handlebars.registerHelper('recentCommits', function(revisions) {
202   return commitsFrom(revisions, data.latest, data.settings.limitRecent);
203 });
204 Handlebars.registerHelper('allCommits', function(revisions) {
205   return commitsFrom(revisions, data.latest, -1);
206 });
207 function shortRev(rev) {
208   if (!rev) { return ''; }
209   return rev.substr(0,7);
210 }
211 Handlebars.registerHelper('shortRev', shortRev);
212 Handlebars.registerHelper('id', function (text) {
213     if (text) {
214         lines = text.split(/\r?\n/);
215         return new Handlebars.SafeString(lines.map(Handlebars.escapeExpression).join('
'))
216     }
217 });
218 Handlebars.registerHelper('iso8601', function(timestamp) {
219   if (!timestamp) { return '' };
220   return new Date(timestamp*1000).toISOString();
221 });
222 Handlebars.registerHelper('humanDate', function(timestamp) {
223   return new Date(timestamp*1000).toString();
224 });
225 // inspired by http://stackoverflow.com/a/17935019/946226
226 Handlebars.registerHelper('each_naturally', function(context,options){
227     var output = '';
228     if (context) {
229         console.log(context);
230         var keys = jQuery.map(context, function(v,k) {return k});
231         var sorted_keys = keys.sort(naturalSort);
232         sorted_keys.map(function (k,i) {
233             output += options.fn(context[k], {data: {key: k, index: i}});
234         });
235     }
236     return output;
237 });
238 Handlebars.registerHelper('each_unnaturally', function(context,options){
239     var output = '';
240     if (context) {
241         console.log(context);
242         var keys = jQuery.map(context, function(v,k) {return k});
243         // needs https://github.com/overset/javascript-natural-sort/issues/21 fixed
244         //var sorted_keys = keys.sort(naturalSort).reverse();
245         var sorted_keys = keys.sort().reverse();
246         sorted_keys.map(function (k,i) {
247             output += options.fn(context[k], {data: {key: k, index: i}});
248         });
249     }
250     return output;
251 });
252
253 // We cache everything
254 var jsonSeen = {};
255 var jsonFetching = {};
256 function getJSON(url, callback, options) {
257     var opts = {
258         block: true,
259     };
260     $.extend(opts, options);
261     if (jsonSeen[url]) {
262         console.log("Not fetching "+url+" again.");
263         if (callback) callback();
264     } else if (jsonFetching[url]) {
265         console.log("Already fetching "+url+".");
266         if (callback) jsonFetching[url].push(callback);
267     } else {
268         console.log("Fetching "+url+".");
269         jsonFetching[url] = [];
270         if (callback) jsonFetching[url].push(callback);
271         $.ajax(url, {
272             success: function (newdata) {
273                 console.log("Fetched "+url+".");
274                 jsonSeen[url] = true;
275                 $.extend(true, data, newdata);
276                 dataChanged.dispatch();
277                 $.each(jsonFetching[url], function (i,c) {c()});
278                 delete jsonFetching[url];
279             },
280             error: function (e) {
281                 console.log("Failure fetching "+url,e);
282             },
283             cache: false,
284             dataType: 'json',
285         });
286     }
287 }
288
289
290 // Views
291
292 function groupStats (benchResults) {
293   return {
294     totalCount: benchResults.length,
295     improvementCount: benchResults.filter(function (br) { return br.changeType == 'Improvement' }).length,
296     regressionCount:  benchResults.filter(function (br) { return br.changeType == 'Regression' }).length,
297   }
298 }
299
300 function benchmark_name_matches(pattern, name) {
301     if (pattern[pattern.length-1] == "*") {
302         return pattern.substr(0, pattern.length-1) == name.substr(0, pattern.length-1);
303     } else {
304         return pattern == name;
305     }
306 }
307
308 // The following logic should be kept in sync with BenchmarkSettings.hs
309 function setting_for(name) {
310     var benchSettings = {
311         smallerIsBetter: true,
312         unit: "",
313         type: "integral",
314         group: "",
315         threshold: 3,
316         important: true
317     };
318
319     data.settings.benchmarks.map(function (s) {
320         if (benchmark_name_matches(s.match, name)) {
321             $.extend(benchSettings, s);
322         }
323     })
324
325     return benchSettings;
326 }
327
328
329 // The following logic should be kept in sync with toResult in ReportTypes.hs
330 function compareResults (res1, res2) {
331     if (!res1 && !res2) { return };
332
333     name = res1? res1.name : res2.name;
334     s = setting_for(name);
335
336     res = {
337         name: name,
338         previous:    res1 ? res1.value : null,
339         value:       res2 ? res2.value : null,
340         unit:        s.unit,
341         important:   s.important,
342         changeType: "Boring",
343         change: "foobar",
344     };
345
346     if (res1 && res2){
347         if (s.type == "integral" || s.type == "float"){
348             if (res1.value == 0 && res2.value == 0) {
349                 res.change = "=";
350             } else if (res1.value == 0) {
351                 res.change = "+  ∞";
352                 res.changeType = "Improvement";
353             } else {
354                 var perc = 100.0 * (res2.value - res1.value) / res1.value;
355                 var percS = Math.round (perc * 100.0) / 100;
356                 if (Math.abs(perc) < 0.01) {
357                     res.change = "=";
358                 } else if (perc >= 0) {
359                     res.change = "+ " + percS + "%";
360                 } else {
361                     res.change = "- " + (-percS) + "%";
362                 }
363
364                 var th_up = s.threshold;
365                 var th_down = (1-(1/(1+s.threshold/100)))*100;
366
367                 if (perc >= 0 && perc > th_up) {
368                         res.changeType = "Improvement";
369                 }
370                 if (perc < 0 && -perc > th_down) {
371                         res.changeType = "Regression";
372                 }
373             }
374         } else if (s.type == "small integral") {
375             if (res1.value == res2.value) {
376                 res.change = "=";
377             } else if (res2.value > res1.value) {
378                 res.change = "+" + (res2.value - res1.value);
379                 res.changeType = "Improvement";
380             } else if (res1.value > res2.value) {
381                 res.change = "-" + (res1.value - res2.value);
382                 res.changeType = "Regression";
383             }
384         }
385
386         if (s.smallerIsBetter) {
387             if (res.changeType == "Improvement") {
388                 res.changeType = "Regression";
389             } else if (res.changeType == "Regression") {
390                 res.changeType = "Improvement";
391             }
392         }
393     }
394
395     return res;
396 }
397
398 // Some views require the data to be prepared in ways that are 
399 // too complicated for the template, so lets do it here.
400 dataViewPrepare = {
401   'revision': function (data, viewData) {
402     if (!data.benchGroups || !data.revisions) return {};
403     var hash = viewData.hash;
404     var rev = data.revisions[hash];
405     if (!rev) return {};
406     if (!rev.benchResults) return {};
407
408     var groups = data.benchGroups.map(function (group) {
409       var benchmarks = group.groupMembers.map(function (bn) {
410         return rev.benchResults[bn]
411       }).filter(function (br) {return br});
412       return {
413         groupName: group.groupName,
414         benchResults: benchmarks,
415         groupStats: groupStats(benchmarks),
416       };
417     });
418     return {
419       rev : rev,
420       groups : groups,
421     };
422   },
423   'compare': function (data, viewData) {
424     if (!data.benchGroups || !data.revisions) return {};
425     var hash1 = viewData.hash1;
426     var hash2 = viewData.hash2;
427     var rev1 = data.revisions[hash1];
428     var rev2 = data.revisions[hash2];
429     if (!rev1) return {};
430     if (!rev1.benchResults) return {};
431     if (!rev2) return {};
432     if (!rev2.benchResults) return {};
433
434     var groups = data.benchGroups.map(function (group) {
435       var benchmarks = group.groupMembers.map(function (bn) {
436         var r1 = rev1.benchResults[bn];
437         var r2 = rev2.benchResults[bn];
438         return compareResults(r1,r2);
439       }).filter(function (br) {return br});
440       return {
441         groupName: group.groupName,
442         benchResults: benchmarks,
443         groupStats: groupStats(benchmarks),
444       };
445     });
446     return {
447       rev1 : rev1,
448       rev2 : rev2,
449       groups : groups,
450     };
451   },
452 }
453
454 function remember_from_to() {
455     settings.compare.from = $('#compare-from').data('rev');
456     settings.compare.to = $('#compare-to').data('rev');
457 }
458
459 function recall_from_to() {
460     if (settings.compare.from) {
461         $('#compare-from').data('rev', settings.compare.from);
462         $('#compare-from').text(shortRev(settings.compare.from));
463     }
464     if (settings.compare.to) {
465         $('#compare-to').data('rev', settings.compare.to);
466         $('#compare-to').text(shortRev(settings.compare.to));
467     }
468     $('#go-to-compare').attr('href',current_compare_link());
469 }
470
471 function current_compare_link () {
472     var rev1 = settings.compare.from;
473     var rev2 = settings.compare.to;
474     if (rev1 && rev2) {
475         return "#" + routes.compare.url(rev1, rev2);
476     } else {
477         return 'javascript:alert("Please drag two revisions here to compare them")';
478     }
479 }
480
481 function load_template () {
482     console.log('Rebuilding page');
483     var context = {};
484     $.extend(context, data, viewData, settings);
485     if (dataViewPrepare[view]){
486       $.extend(context, dataViewPrepare[view](data, viewData));
487     }
488     $('#main').html(templates[view](context));
489
490     $(".nav-loading").toggle(jQuery.active > 0);
491
492     updateBenchFilter();
493     updateCollapsedGroups();
494     $('abbrv.timeago').timeago();
495
496     // Code to implement the compare-revision-drag'n'drop interface
497     $('.rev-draggable').draggable({
498         revert: true,
499         revertDuration: 0,
500     });
501     $('#compare-from, #compare-to').droppable({
502         accept: ".rev-draggable",
503         activeClass: "ui-state-highlight",
504         hoverClass: "ui-state-active",
505         drop: function( event, ui ) {
506           $( this ).text(ui.draggable.text());
507           $( this ).data('rev',ui.draggable.data('rev'));
508           remember_from_to();
509           $('#go-to-compare').attr('href',current_compare_link());
510       }
511     });
512     recall_from_to();
513
514     if ($('#benchChart').length) {
515         setupChart();
516     }
517 }
518 viewChanged.add(load_template);
519 dataChanged.add(load_template);
520
521 function setupChart () {
522
523     var commits = commitsFrom(data.revisions, data.latest, data.settings.limitRecent);
524     var benchName = viewData.benchName;
525
526     $("<div id='tooltip' class='panel alert-info'></div>").css({
527                 position: "absolute",
528                 display: "none",
529                 //border: "1px solid #fdd",
530                 padding: "2px",
531                 //"background-color": "#fee",
532                 // opacity: 0.80,
533                 width: '300px',
534         }).appendTo("#main");
535
536     var plot_series = {
537           lines: { show: true, fill: true, fillColor: "rgba(255, 255, 255, 0.8)" },
538           points: { show: true, fill: false },
539           label: benchName,
540           data: commits.map(function (x,i){
541             if (!x.benchResults) return;
542             if (!x.benchResults[benchName]) return;
543             return [commits.length - i, x.benchResults[benchName].value]
544           }),
545         };
546
547     var plot_options = {
548           legend: {
549                 position: 'nw',
550           },
551           grid: {
552                 hoverable: true,
553                 clickable: true,
554           },
555           yaxis: {},
556           xaxis: {
557                 // ticks: values.map(function (x,i){return [i,x[0]]}),
558                 tickFormatter: function (i,axis) {
559                         if (i > 0 && i <= commits.length) {
560                                 var rev = commits[commits.length - i];
561                                 if (!rev) return "";
562                                 var date = new Date(rev.summary.gitDate * 1000);
563                                 return $.timeago(date);
564                         } else {
565                                 return '';
566                         }
567                 }
568           }
569         };
570
571     var numberType;
572     if (data.benchmarkSettings && data.benchmarkSettings[benchName]) {
573         numberType = data.benchmarkSettings[benchName].numberType;
574     }
575     if (numberType == "integral" || numberType == "small integral") {
576         plot_options.yaxis.minTickSize = 1;
577         plot_options.yaxis.tickDecimals = 0;
578     }
579
580     var plot = $.plot("#benchChart", [plot_series], plot_options);
581
582     viewData.highlights.forEach(function (hash) {
583         commits.forEach(function (rev,i) {
584             if (rev.summary.hash == hash)  {
585                 plot.highlight(0, i);
586             };
587         });
588     });
589
590
591     $("#benchChart").bind("plothover", function (event, pos, item) {
592         if (item) {
593                 var v = item.datapoint[1];
594                 var i = item.dataIndex;
595                 var rev = commits[i].summary.hash;
596                 var summary = commits[i].summary;
597
598                 var tooltipContext = $.extend({value: v}, summary);
599
600                 if ($("#tooltip").data('rev') != rev) {
601                     $("#tooltip")
602                         .html(shortRev(rev))
603                         .data('rev',rev)
604                         .html(templates.revTooltip(tooltipContext))
605                         .fadeIn(200)
606                         .css({top: item.pageY+10, left: item.pageX-100})
607                         .show();
608                     $("#benchChart").css('cursor','pointer');
609                 }
610         } else {
611                 $("#tooltip").data('rev',null).hide();
612                 $("#benchChart").css('cursor','default');
613         }
614     });
615     $("#benchChart").bind("plotclick", function (event, pos, item) {
616         if (item) {
617                 var v = item.datapoint[1];
618                 var i = item.dataIndex;
619                 var hash = commits[i].summary.hash;
620                 
621                 goTo(routes.revision.url(hash));
622         }
623     });
624 }
625
626 function updateCollapsedGroups() {
627     // Does not work yet...
628     /*
629
630     var list = settings.collapsedGroups;
631     console.log(list);
632     if ($(".panel-collapse").length) {
633         $(".panel-collapse").each(function (i){
634             if (i < list.length) {
635                 console.log(i, list[i], this);
636                 $(this).toggleClass('in', !list[i]);
637
638                 $(this).collapse();
639                 if (list[i]) {
640                     $(this).collapse('hide');
641                 } else {
642                     $(this).collapse('show');
643                 }
644             }
645         });
646     }
647     */
648 }
649
650 function updateBenchFilter() {
651     var showRegressions  = settings.benchFilter.regressions;
652     var showBoring       = settings.benchFilter.boring;
653     var showImprovements = settings.benchFilter.improvements;
654
655     $('#show-regressions').toggleClass('active', showRegressions);
656     $('#show-boring').toggleClass('active', showBoring); 
657     $('#show-improvements').toggleClass('active', showImprovements);
658
659     $('tr.row-Regression').toggle(showRegressions);
660     $('tr.row-Boring').toggle(showBoring);
661     $('tr.row-Improvement').toggle(showImprovements);
662
663     $('.bench-panel').show().each(function() {
664         if ($(this).has('tr.row-result:visible').length == 0) {
665             $(this).hide();
666         }
667     });
668
669     $('tr.summary-row').addClass('summary-row-collapsed');
670     if (showBoring) {
671         $('tr.summary-row:not(.summary-improvement):not(.summary-regression)')
672             .removeClass('summary-row-collapsed');
673     }
674     if (showRegressions) {
675         $('tr.summary-row.summary-regression')
676             .removeClass('summary-row-collapsed');
677     }
678     if (showImprovements) {
679         $('tr.summary-row.summary-improvement')
680             .removeClass('summary-row-collapsed');
681     }
682     // Always show first entry in the history
683     $('.summary-table tr.summary-row').first()
684             .removeClass('summary-row-collapsed');
685
686     $('.graph-list-panel').show().each(function() {
687         if ($(this).has('tr.summary-row:visible').length == 0) {
688             $(this).hide();
689         }
690     });
691
692     updateNothingToSee();
693 };
694
695 function updateNothingToSee() {
696     $('.nothing-to-see')
697         .toggle(jQuery.active == 0 && $('.bench-panel:visible, tr.summary-row:not(.summary-row-collapsed)').length == 0);
698 }
699
700 $(function (){
701     $('body').on('click', '.benchSelector', function (event) {
702         $(this).toggleClass('active');
703         settings.benchFilter = {
704             regressions:  $('#show-regressions').hasClass('active'),
705             boring:       $('#show-boring').hasClass('active'), 
706             improvements: $('#show-improvements').hasClass('active'), 
707         };
708         updateBenchFilter();
709     });
710 });
711
712 // Redirection
713
714 function goTo(path) {
715     console.log("goTo " + path);
716     hasher.setHash(path);
717 }
718
719
720 // Main setup
721
722 $(function() {
723     hasher.prependHash = '';
724
725     $('#loading').hide();
726
727     $(document).ajaxStart(function () {
728         $(".nav-loading").show();
729         updateNothingToSee();
730     });
731     $(document).ajaxStop(function () {
732         $(".nav-loading").hide();
733         updateNothingToSee();
734     });
735
736     // Load settins, then figure out what view to use.
737     $.get("out/latest.txt", function (latest) {
738         data.latest = latest;
739
740         getJSON("out/settings.json", function (settings) {
741             $('title').html(data.settings.title + " – Gipeda");
742             hasher.changed.add(handleHashChange);
743             hasher.initialized.add(handleHashChange);
744             hasher.init();
745         });
746     }, 'text');
747
748
749 });