refactor(benchmark): reduce code redundancy for statistics calculations

Author: jeffbcross

benchmark/web/bp.js

@@ -15,7 +15,9 @@ var bp = window.bp = {
   Report: {
     timesPerAction: {}
   },
-  Measure: {}
+  Measure: {
+    characteristics: ['gcTime','testTime','garbageCount','retainedCount']
+  }
 };
 
 bp.Measure.numMilliseconds = function() {
@@ -151,8 +153,8 @@ bp.Runner.runTimedTest = function (bs) {
     testTime: endTime,
     gcTime: endGCTime,
     beforeHeap: beforeHeap,
-    garbage: garbage,
-    retainedMemory: retainedMemory
+    garbageCount: garbage,
+    retainedCount: retainedMemory
   };
 };
 
@@ -168,12 +170,16 @@ bp.Report.getTimesPerAction = function(name) {
   var tpa = bp.Report.timesPerAction[name];
   if (!tpa) {
     tpa = bp.Report.timesPerAction[name] = {
-      testTimes: [], // circular buffer
-      gcTimes: [],
-      garbageCount: [],
-      retainedCount: [],
+      name: name,
       nextEntry: 0
-    }
+    };
+    _.each(bp.Measure.characteristics, function(c) {
+      tpa[c] = {
+        recent: undefined,
+        history: [],
+        avg: {}
+      };
+    });
   }
   return tpa;
 };
@@ -188,8 +194,9 @@ bp.Report.rightSizeTimes = function(times) {
 };
 
 bp.Report.updateTimes = function(tpa, index, reference, recentTime) {
-  tpa[reference][index] = recentTime;
-  tpa[reference] = bp.Report.rightSizeTimes(tpa[reference]);
+  tpa[reference].recent = recentTime;
+  tpa[reference].history[index] = recentTime;
+  tpa[reference].history = bp.Report.rightSizeTimes(tpa[reference].history);
 };
 
 bp.Report.calcStats = function() {
@@ -198,33 +205,21 @@ bp.Report.calcStats = function() {
     var recentResult = bp.Runner.runState.recentResult[bs.name],
         tpa = bp.Report.getTimesPerAction(bs.name);
 
-    bp.Report.updateTimes(tpa, tpa.nextEntry, 'gcTimes', recentResult.gcTime);
-    bp.Report.updateTimes(tpa, tpa.nextEntry, 'garbageCount', recentResult.garbage / 1e3);
-    bp.Report.updateTimes(tpa, tpa.nextEntry, 'retainedCount', recentResult.retainedMemory / 1e3);
-    bp.Report.updateTimes(tpa, tpa.nextEntry, 'testTimes', recentResult.testTime);
+    _.each(bp.Measure.characteristics, function(c) {
+      bp.Report.updateTimes(tpa, tpa.nextEntry, c, recentResult[c]);
+      var mean = bp.Statistics.getMean(tpa[c].history);
+      var stdDev = bp.Statistics.calculateStandardDeviation(tpa[c].history, mean);
+      tpa[c].avg = {
+        mean: mean,
+        stdDev: stdDev,
+        coefficientOfVariation: bp.Statistics.calculateCoefficientOfVariation(stdDev, mean)
+      };
+    });
 
     tpa.nextEntry++;
     tpa.nextEntry %= bp.Runner.runState.numSamples;
 
-    var meanTestTime = bp.Statistics.getMean(tpa.testTimes);
-    var testTimesStdDev = bp.Statistics.calculateStandardDeviation(tpa.testTimes, meanTestTime);
-    var avgGCTime = bp.Statistics.getMean(tpa.gcTimes);
-    var avg = {
-      gcTime: avgGCTime,
-      testTime: meanTestTime,
-      combinedTime: meanTestTime + avgGCTime,
-      garbage: bp.Statistics.getMean(tpa.garbageCount),
-      retained: bp.Statistics.getMean(tpa.retainedCount),
-      testTimesStdDev: testTimesStdDev,
-      coefficientOfVariation: bp.Statistics.calculateCoefficientOfVariation(testTimesStdDev, meanTestTime)
-    };
-
-    var reportModel = _.clone(tpa);
-    reportModel.name = bs.name;
-    reportModel.avg = avg;
-    reportModel.testTimes = tpa.testTimes;
-
-    report += bp.Report.generatePartial(reportModel);
+    report += bp.Report.generatePartial(tpa);
   });
   return report;
 };

benchmark/web/bp.spec.js

@@ -214,7 +214,7 @@ describe('bp', function() {
         }, 'done to be called', 200);
 
         runs(function() {
-          expect(bp.Report.timesPerAction.fakeStep.testTimes.length).toBe(8);
+          expect(bp.Report.timesPerAction.fakeStep.testTime.history.length).toBe(8);
         });
       });
     });
@@ -378,29 +378,31 @@ describe('bp', function() {
         };
         bp.Report.timesPerAction = {
           fakeStep: {
-            testTimes: [3,7],
-            garbageCount: [50,50],
-            retainedCount: [25,25],
-            gcTimes: [1,3],
+            testTime: {
+              history: [3,7]
+            },
+            garbageCount: {
+              history: [50,50]
+            },
+            retainedCount: {
+              history: [25,25]
+            },
+            gcTime: {
+              recent: 3,
+              history: [1,3]
+            },
             nextEntry: 2
           },
         };
       });
 
 
-      xit('should call generateReportPartial() with the correct info', function() {
-        var spy = spyOn(bp, 'generateReportPartial');
-        bp.Report.calcStats();
-        expect(spy).toHaveBeenCalledWith('fakeStep', {time: 5, gcTime: 2}, ['3','7','5'], ['1','3','2'], [50,50,200], [25,25,100])
-      });
-
-
       it('should set the most recent time for each step to the next entry', function() {
         bp.Report.calcStats();
-        expect(bp.Report.timesPerAction.fakeStep.testTimes[2]).toBe(5);
+        expect(bp.Report.timesPerAction.fakeStep.testTime.history[2]).toBe(5);
         bp.Runner.runState.recentResult.fakeStep.testTime = 25;
         bp.Report.calcStats();
-        expect(bp.Report.timesPerAction.fakeStep.testTimes[3]).toBe(25);
+        expect(bp.Report.timesPerAction.fakeStep.testTime.history[3]).toBe(25);
       });
 
 

benchmark/web/tree.html

@@ -68,42 +68,42 @@
             <tr class="sampleContainer">
               <td><%= name %></td>
               <td class="average">
-                test:<%= avg.testTime.toFixed(2) %>ms
+                test:<%= testTime.avg.mean.toFixed(2) %>ms
                 <br>
-                deviation: <%= avg.testTimesStdDev.toFixed(2) %>
+                deviation: <%= testTime.avg.stdDev.toFixed(2) %>
                 <br>
-                coefficient of variation: <%= Math.round(avg.coefficientOfVariation * 100) %>%
+                coefficient of variation: <%= Math.round(testTime.avg.coefficientOfVariation * 100) %>%
                 <br>
-                gc:<%= avg.gcTime.toFixed(2) %>ms
+                gc:<%= gcTime.avg.mean.toFixed(2) %>ms
                 <br>
-                combined: <%= avg.combinedTime.toFixed(2) %>ms
+                combined: <%= (testTime.avg.mean + gcTime.avg.mean).toFixed(2) %>ms
                 <br>
-                garbage: <%= (avg.garbage / 1e3).toFixed(2) %>KB
+                garbage: <%= (garbageCount.avg.mean / 1e3).toFixed(2) %>KB
                 <br>
-                retained: <%= (avg.retained / 1e3).toFixed(2) %>KB
+                retained: <%= (retainedCount.avg.mean / 1e3).toFixed(2) %>KB
               </td>
               <td>
                 <div class="sampleContainer">
                   <div class="testTimeCol">
-                    <% _.each(testTimes, function(time) { %>
+                    <% _.each(testTime.history, function(time) { %>
                       <%= time.toFixed(2) %>
                       <br>
                     <% }); %>
                   </div>
                   <div class="testTimeCol">
-                    <% _.each(gcTimes, function(time) { %>
+                    <% _.each(gcTime.history, function(time) { %>
                       <%= time.toFixed(2) %>
                       <br>
                     <% }); %>
                   </div>
                   <div class="testTimeCol">
-                  <% _.each(garbageCount, function(count) { %>
+                  <% _.each(garbageCount.history, function(count) { %>
                       <%= (count / 1e3).toFixed(2) %>
                       <br>
                     <% }); %>
                   </div>
                   <div class="testTimeCol">
-                    <% _.each(retainedCount, function(count) { %>
+                    <% _.each(retainedCount.history, function(count) { %>
                       <%= (count / 1e3).toFixed(2) %>
                       <br>
                     <% }); %>