0f22ef9e429e6bc678133c31221f35737a60b160
[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'],
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             cache: false,
238             dataType: 'json',
239         });
240     }
241 }
242
243
244 // Views
245
246 function groupStats (benchResults) {
247   return {
248     totalCount: benchResults.length,
249     improvementCount: benchResults.filter(function (br) { return br.changeType == 'Improvement' }).length,
250     regressionCount:  benchResults.filter(function (br) { return br.changeType == 'Regression' }).length,
251   }
252 }
253
254 function benchmark_name_matches(pattern, name) {
255     if (pattern[pattern.length-1] == "*") {
256         return pattern.substr(0, pattern.length-1) == name.substr(0, pattern.length-1);
257     } else {
258         return pattern == name;
259     }
260 }
261
262 // The following logic should be kept in sync with BenchmarkSettings.hs
263 function setting_for(name) {
264     var benchSettings = {
265         smallerIsBetter: true,
266         unit: "",
267         type: "integral",
268         group: "",
269         threshold: 3,
270         important: true
271     };
272
273     data.settings.benchmarks.map(function (s) {
274         if (benchmark_name_matches(s.match, name)) {
275             $.extend(benchSettings, s);
276         }
277     })
278
279     return benchSettings;
280 }
281
282
283 // The following logic should be kept in sync with toResult in ReportTypes.hs
284 function compareResults (res1, res2) {
285     if (!res1 && !res2) { return };
286
287     name = res1? res1.name : res2.name;
288     s = setting_for(name);
289
290     res = {
291         name: name,
292         previous:    res1 ? res1.value : null,
293         value:       res2 ? res2.value : null,
294         unit:        s.unit,
295         important:   s.important,
296         changeType: "Boring",
297         change: "foobar",
298     };
299
300     if (res1 && res2){
301         if (s.type == "integral" || s.type == "float"){
302             if (res1.value == 0 && res2.value == 0) {
303                 res.change = "=";
304             } else if (res1.value == 0) {
305                 res.change = "+  ∞";
306                 res.changeType = "Improvement";
307             } else {
308                 var perc = 100.0 * (res2.value - res1.value) / res1.value;
309                 var percS = Math.round (perc * 100.0) / 100;
310                 if (Math.abs(perc) < 0.01) {
311                     res.change = "=";
312                 } else if (perc >= 0) {
313                     res.change = "+ " + percS + "%";
314                 } else {
315                     res.change = "- " + (-percS) + "%";
316                 }
317
318                 if (Math.abs(perc) >= s.threshold) {
319                     if (perc >= 0) {
320                         s.changeType = "Improvement";
321                     } else {
322                         s.changeType = "Regression";
323                     }
324                 }
325             }
326         } else if (s.type == "small integral") {
327             if (res1.value == res2.value) {
328                 res.change = "=";
329             } else if (res2.value > res1.value) {
330                 res.change = "+" + (res2.value - res1.value);
331                 res.changeType = "Improvement";
332             } else if (res1.value > res2.value) {
333                 res.change = "-" + (res1.value - res2.value);
334                 res.changeType = "Regression";
335             }
336         }
337
338         if (s.smallerIsBetter) {
339             if (res.changeType == "Improvement") {
340                 res.changeType = "Regression";
341             } else if (res.changeType == "Regression") {
342                 res.changeType = "Improvement";
343             }
344         }
345     }
346
347     return res;
348 }
349
350 // Some views require the data to be prepared in ways that are 
351 // too complicated for the template, so lets do it here.
352 dataViewPrepare = {
353   'revision': function (data, viewData) {
354     if (!data.benchGroups || !data.revisions) return {};
355     var hash = viewData.hash;
356     var rev = data.revisions[hash];
357     if (!rev) return {};
358     if (!rev.benchResults) return {};
359
360     var groups = data.benchGroups.map(function (group) {
361       var benchmarks = group.groupMembers.map(function (bn) {
362         return rev.benchResults[bn]
363       }).filter(function (br) {return br});
364       return {
365         groupName: group.groupName,
366         benchResults: benchmarks,
367         groupStats: groupStats(benchmarks),
368       };
369     });
370     return {
371       rev : rev,
372       groups : groups,
373     };
374   },
375   'compare': function (data, viewData) {
376     if (!data.benchGroups || !data.revisions) return {};
377     var hash1 = viewData.hash1;
378     var hash2 = viewData.hash2;
379     var rev1 = data.revisions[hash1];
380     var rev2 = data.revisions[hash2];
381     if (!rev1) return {};
382     if (!rev1.benchResults) return {};
383     if (!rev2) return {};
384     if (!rev2.benchResults) return {};
385
386     var groups = data.benchGroups.map(function (group) {
387       var benchmarks = group.groupMembers.map(function (bn) {
388         var r1 = rev1.benchResults[bn];
389         var r2 = rev2.benchResults[bn];
390         return compareResults(r1,r2);
391       }).filter(function (br) {return br});
392       return {
393         groupName: group.groupName,
394         benchResults: benchmarks,
395         groupStats: groupStats(benchmarks),
396       };
397     });
398     return {
399       rev1 : rev1,
400       rev2 : rev2,
401       groups : groups,
402     };
403   },
404 }
405
406 function load_template () {
407     console.log('Rebuilding page');
408     var context = {};
409     $.extend(context, data, viewData, settings);
410     if (dataViewPrepare[view]){
411       $.extend(context, dataViewPrepare[view](data, viewData));
412     }
413     $('#main').html(templates[view](context));
414
415     $(".nav-loading").toggle(jQuery.active > 0);
416
417     updateBenchFilter();
418     updateCollapsedGroups();
419     $('abbrv.timeago').timeago();
420
421     if ($('#benchChart').length) {
422         setupChart();
423     }
424 }
425 viewChanged.add(load_template);
426 dataChanged.add(load_template);
427
428 function setupChart () {
429     
430     var commits = commitsFrom(data.revisions, data.latest, data.settings.limitRecent);
431     var benchName = viewData.benchName;
432
433     $("<div id='tooltip' class='panel alert-info'></div>").css({
434                 position: "absolute",
435                 display: "none",
436                 //border: "1px solid #fdd",
437                 padding: "2px",
438                 //"background-color": "#fee",
439                 // opacity: 0.80,
440                 width: '300px',
441         }).appendTo("#main");
442
443     var plot_series = {
444           lines: { show: true, fill: true, fillColor: "rgba(255, 255, 255, 0.8)" },
445           points: { show: true, fill: false },
446           label: benchName,
447           data: commits.map(function (x,i){
448             if (!x.benchResults) return;
449             if (!x.benchResults[benchName]) return;
450             return [commits.length - i, x.benchResults[benchName].value]
451           }),
452         };
453
454     var plot_options = {
455           legend: {
456                 position: 'nw',
457           },
458           grid: {
459                 hoverable: true,
460                 clickable: true,
461           },
462           yaxis: {},
463           xaxis: {
464                 // ticks: values.map(function (x,i){return [i,x[0]]}),
465                 tickFormatter: function (i,axis) {
466                         if (i > 0 && i <= commits.length) {
467                                 var rev = commits[commits.length - i];
468                                 if (!rev) return "";
469                                 var date = new Date(rev.summary.gitDate * 1000);
470                                 return $.timeago(date);
471                         } else {
472                                 return '';
473                         }
474                 }
475           }
476         };
477
478     var type;
479     if (data.benchmarkSettings && data.benchmarkSettings[benchName]) {
480         type = data.benchmarkSettings[benchName].type;
481     }
482     if (type == "integral" || type == "small integral") {
483         plot_options.yaxis.minTickSize = 1;
484         plot_options.yaxis.tickDecimals = 0;
485     }
486
487     var plot = $.plot("#benchChart", [plot_series], plot_options);
488
489     viewData.highlights.forEach(function (hash) {
490         commits.forEach(function (rev,i) {
491             if (rev.summary.hash == hash)  {
492                 plot.highlight(0, i);
493             };
494         });
495     });
496
497
498     $("#benchChart").bind("plothover", function (event, pos, item) {
499         if (item) {
500                 var v = item.datapoint[1];
501                 var i = item.dataIndex;
502                 var rev = commits[i].summary.hash;
503                 var summary = commits[i].summary;
504
505                 var tooltipContext = $.extend({value: v}, summary);
506
507                 if ($("#tooltip").data('rev') != rev) {
508                     $("#tooltip")
509                         .html(shortRev(rev))
510                         .data('rev',rev)
511                         .html(templates.revTooltip(tooltipContext))
512                         .fadeIn(200)
513                         .css({top: item.pageY+10, left: item.pageX-100})
514                         .show();
515                     $("#benchChart").css('cursor','pointer');
516                 }
517         } else {
518                 $("#tooltip").data('rev',null).hide();
519                 $("#benchChart").css('cursor','default');
520         }
521     });
522     $("#benchChart").bind("plotclick", function (event, pos, item) {
523         if (item) {
524                 var v = item.datapoint[1];
525                 var i = item.dataIndex;
526                 var hash = commits[i].summary.hash;
527                 
528                 goTo(routes.revision.url(hash));
529         }
530     });
531 }
532
533 function updateCollapsedGroups() {
534     // Does not work yet...
535     /*
536
537     var list = settings.collapsedGroups;
538     console.log(list);
539     if ($(".panel-collapse").length) {
540         $(".panel-collapse").each(function (i){
541             if (i < list.length) {
542                 console.log(i, list[i], this);
543                 $(this).toggleClass('in', !list[i]);
544
545                 $(this).collapse();
546                 if (list[i]) {
547                     $(this).collapse('hide');
548                 } else {
549                     $(this).collapse('show');
550                 }
551             }
552         });
553     }
554     */
555 }
556
557 function updateBenchFilter() {
558     var showRegressions  = settings.benchFilter.regressions;
559     var showBoring       = settings.benchFilter.boring;
560     var showImprovements = settings.benchFilter.improvements;
561
562     $('#show-regressions').toggleClass('active', showRegressions);
563     $('#show-boring').toggleClass('active', showBoring); 
564     $('#show-improvements').toggleClass('active', showImprovements);
565
566     $('tr.row-Regression').toggle(showRegressions);
567     $('tr.row-Boring').toggle(showBoring);
568     $('tr.row-Improvement').toggle(showImprovements);
569
570     $('.bench-panel').show().each(function() {
571         if ($(this).has('tr.row-result:visible').length == 0) {
572             $(this).hide();
573         }
574     });
575
576     $('tr.summary-row').addClass('summary-row-collapsed');
577     if (showBoring) {
578         $('tr.summary-row:not(.summary-improvement):not(.summary-regression)')
579             .removeClass('summary-row-collapsed');
580     }
581     if (showRegressions) {
582         $('tr.summary-row.summary-regression')
583             .removeClass('summary-row-collapsed');
584     }
585     if (showImprovements) {
586         $('tr.summary-row.summary-improvement')
587             .removeClass('summary-row-collapsed');
588     }
589     $('tr.summary-row').first()
590             .removeClass('summary-row-collapsed');
591
592     updateNothingToSee();
593 };
594
595 function updateNothingToSee() {
596     $('.nothing-to-see')
597         .toggle(jQuery.active == 0 && $('.bench-panel:visible, tr.summary-row:not(.summary-row-collapsed)').length == 0);
598 }
599
600 $(function (){
601     $('body').on('click', '.benchSelector', function (event) {
602         $(this).toggleClass('active');
603         settings.benchFilter = {
604             regressions:  $('#show-regressions').hasClass('active'),
605             boring:       $('#show-boring').hasClass('active'), 
606             improvements: $('#show-improvements').hasClass('active'), 
607         };
608         updateBenchFilter();
609     });
610 });
611
612 // Redirection
613
614 function goTo(path) {
615     console.log("goTo " + path);
616     hasher.setHash(path);
617 }
618
619
620 // Main setup
621
622 $(function() {
623     hasher.prependHash = '';
624
625     $('#loading').hide();
626
627     $(document).ajaxStart(function () {
628         $(".nav-loading").show();
629         updateNothingToSee();
630     });
631     $(document).ajaxStop(function () {
632         $(".nav-loading").hide();
633         updateNothingToSee();
634     });
635
636     // Load settins, then figure out what view to use.
637     $.get("out/latest.txt", function (latest) {
638         data.latest = latest;
639
640         getJSON("out/settings.json", function (settings) {
641             $('title').html(data.settings.title + " – Gipeda");
642             hasher.changed.add(handleHashChange);
643             hasher.initialized.add(handleHashChange);
644             hasher.init();
645         });
646     }, 'text');
647
648
649 });