Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

Commit afe5581

Browse files
jeffbcrossjeffbcross
committed
feat(benchmark): add ability to profile memory usage per iteration
1 parent bdda8d9 commit afe5581

File tree

4 files changed

+192
-45
lines changed

4 files changed

+192
-45
lines changed

‎benchmark/launch_chrome.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ platform=`uname`
44
if [[ "$platform" == 'Linux' ]]; then
55
`google-chrome --js-flags="--expose-gc"`
66
elif [[ "$platform" == 'Darwin' ]]; then
7-
`/Applications/Google\ Chrome\ Canary.app/Contents/MacOS/Google\ Chrome\ Canary --js-flags="--expose-gc"`
7+
`/Applications/Google\ Chrome\ Canary.app/Contents/MacOS/Google\ Chrome\ Canary --enable-memory-info --enable-precise-memory-info --enable-memory-benchmarking --js-flags="--expose-gc"`
88
fi

‎benchmark/web/bp.js‎

Lines changed: 98 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ bp.runState = {
44
numSamples: 20,
55
recentTimePerStep: {},
66
recentGCTimePerStep: {},
7+
recentGarbagePerStep: {},
8+
recentRetainedMemoryPerStep: {},
79
timesPerAction: {}
810
};
911

@@ -78,21 +80,40 @@ bp.onSampleRangeChanged = function (evt) {
7880
};
7981

8082
bp.runTimedTest = function (bs) {
83+
var startTime,
84+
endTime,
85+
startGCTime,
86+
endGCTime,
87+
retainedDelta,
88+
garbage,
89+
beforeHeap,
90+
afterHeap,
91+
finalHeap;
8192
if (typeof window.gc === 'function') {
8293
window.gc();
8394
}
84-
var startTime = bp.numMilliseconds();
95+
96+
beforeHeap = performance.memory.usedJSHeapSize;
97+
startTime = bp.numMilliseconds();
8598
bs.fn();
86-
var endTime = bp.numMilliseconds() - startTime;
99+
endTime = bp.numMilliseconds() - startTime;
100+
afterHeap = performance.memory.usedJSHeapSize;
87101

88-
var startGCTime = bp.numMilliseconds();
102+
startGCTime = bp.numMilliseconds();
89103
if (typeof window.gc === 'function') {
90104
window.gc();
91105
}
92-
var endGCTime = bp.numMilliseconds() - startGCTime;
106+
endGCTime = bp.numMilliseconds() - startGCTime;
107+
108+
finalHeap = performance.memory.usedJSHeapSize;
109+
garbage = Math.abs(finalHeap - afterHeap);
110+
retainedDelta = finalHeap - beforeHeap;
93111
return {
94112
time: endTime,
95-
gcTime: endGCTime
113+
gcTime: endGCTime,
114+
beforeHeap: beforeHeap,
115+
garbage: garbage,
116+
retainedDelta: retainedDelta
96117
};
97118
};
98119

@@ -102,6 +123,8 @@ bp.runAllTests = function (done) {
102123
var testResults = bp.runTimedTest(bs);
103124
bp.runState.recentTimePerStep[bs.name] = testResults.time;
104125
bp.runState.recentGCTimePerStep[bs.name] = testResults.gcTime;
126+
bp.runState.recentGarbagePerStep[bs.name] = testResults.garbage;
127+
bp.runState.recentRetainedMemoryPerStep[bs.name] = testResults.retainedDelta;
105128
});
106129
bp.report = bp.calcStats();
107130
bp.writeReport(bp.report);
@@ -116,31 +139,41 @@ bp.runAllTests = function (done) {
116139
}
117140
}
118141

119-
bp.generateReportPartial = function(name, avg, fmtTimes, gcTimes) {
120-
return bp.interpolateHtml(
121-
'<tr class="sampleContainer">' +
122-
'<td>%0</td>' +
123-
'<td class="average">test:%1ms<br>gc:%2ms<br>combined: %3ms</td>' +
124-
'<td><div class="sampleContainer"><div class="testTimeCol">%4</div><div class="testTimeCol">%5</div></div></td>' +
125-
'</tr>',
126-
[
127-
name,
128-
('' + avg.time).substr(0,6),
129-
('' + avg.gcTime).substr(0,6),
130-
('' + (avg.time + avg.gcTime)).substr(0,6),
131-
fmtTimes.join('<br>'),
132-
gcTimes.join('<br>')
133-
]);
134-
};
135-
136-
bp.getAverage = function (times, gcTimes, runState) {
142+
bp.generateReportModel = function (rawModel) {
143+
return {
144+
name: rawModel.name,
145+
avg: {
146+
time: ('' + rawModel.avg.time).substr(0,6),
147+
gcTime: ('' + rawModel.avg.gcTime).substr(0,6),
148+
garbage: ('' + rawModel.avg.garbage).substr(0,6),
149+
retained: ('' + rawModel.avg.retained).substr(0,6),
150+
combinedTime: ('' + (rawModel.avg.time + rawModel.avg.gcTime)).substr(0,6)
151+
},
152+
times: rawModel.times.join('<br>'),
153+
gcTimes: rawModel.gcTimes.join('<br>'),
154+
garbageTimes: rawModel.garbageTimes.join('<br>'),
155+
retainedTimes: rawModel.retainedTimes.join('<br>')
156+
};
157+
};
158+
159+
bp.generateReportPartial = function(model) {
160+
return bp.infoTemplate(model);
161+
};
162+
163+
bp.getAverage = function (times, gcTimes, garbageTimes, retainedTimes) {
137164
var timesAvg = 0;
138165
var gcAvg = 0;
166+
var garbageAvg = 0;
167+
var retainedAvg = 0;
139168
times.forEach(function(x) { timesAvg += x; });
140169
gcTimes.forEach(function(x) { gcAvg += x; });
170+
garbageTimes.forEach(function(x) { garbageAvg += x; });
171+
retainedTimes.forEach(function(x) { retainedAvg += x; });
141172
return {
142173
gcTime: gcAvg / gcTimes.length,
143-
time: timesAvg / times.length
174+
time: timesAvg / times.length,
175+
garbage: garbageAvg / garbageTimes.length,
176+
retained: retainedAvg / retainedTimes.length
144177
};
145178
};
146179

@@ -154,8 +187,12 @@ bp.getTimesPerAction = function(name) {
154187
tpa = bp.runState.timesPerAction[name] = {
155188
times: [], // circular buffer
156189
fmtTimes: [],
157-
fmtGCTimes: [],
158190
gcTimes: [],
191+
fmtGCTimes: [],
192+
garbageTimes: [],
193+
fmtGarbageTimes: [],
194+
retainedTimes: [],
195+
fmtRetainedTimes: [],
159196
nextEntry: 0
160197
}
161198
}
@@ -177,24 +214,51 @@ bp.calcStats = function() {
177214
var stepName = bs.name,
178215
timeForStep = bp.runState.recentTimePerStep[stepName],
179216
gcTimeForStep = bp.runState.recentGCTimePerStep[stepName],
217+
garbageTimeForStep = bp.runState.recentGarbagePerStep[stepName],
218+
retainedTimeForStep = bp.runState.recentRetainedMemoryPerStep[stepName],
180219
tpa = bp.getTimesPerAction(stepName),
220+
reportModel,
181221
avg;
182222

183-
tpa.fmtTimes[tpa.nextEntry] = timeForStep.toString().substr(0, 6);
184-
tpa.fmtTimes = bp.rightSizeTimes(tpa.fmtTimes);
185223

224+
tpa.gcTimes[tpa.nextEntry] = gcTimeForStep;
225+
tpa.gcTimes = bp.rightSizeTimes(tpa.gcTimes);
186226
tpa.fmtGCTimes[tpa.nextEntry] = gcTimeForStep.toString().substr(0, 6);
187227
tpa.fmtGCTimes = bp.rightSizeTimes(tpa.fmtGCTimes);
188228

189-
tpa.gcTimes[tpa.nextEntry] = gcTimeForStep;
190-
tpa.gcTimes = bp.rightSizeTimes(tpa.gcTimes);
191229

192-
tpa.times[tpa.nextEntry++] = timeForStep;
230+
231+
tpa.garbageTimes[tpa.nextEntry] = garbageTimeForStep / 1e3;
232+
tpa.garbageTimes = bp.rightSizeTimes(tpa.garbageTimes);
233+
tpa.fmtGarbageTimes[tpa.nextEntry] = (garbageTimeForStep / 1e3).toFixed(3).toString();
234+
tpa.fmtGarbageTimes = bp.rightSizeTimes(tpa.fmtGarbageTimes);
235+
236+
tpa.retainedTimes[tpa.nextEntry] = retainedTimeForStep / 1e3;
237+
tpa.retainedTimes = bp.rightSizeTimes(tpa.retainedTimes);
238+
tpa.fmtRetainedTimes[tpa.nextEntry] = (retainedTimeForStep / 1e3).toFixed(3).toString();
239+
tpa.fmtRetainedTimes = bp.rightSizeTimes(tpa.fmtRetainedTimes);
240+
241+
tpa.times[tpa.nextEntry] = timeForStep;
193242
tpa.times = bp.rightSizeTimes(tpa.times);
243+
tpa.fmtTimes[tpa.nextEntry] = timeForStep.toString().substr(0, 6);
244+
tpa.fmtTimes = bp.rightSizeTimes(tpa.fmtTimes);
194245

246+
tpa.nextEntry++;
195247
tpa.nextEntry %= bp.runState.numSamples;
196-
avg = bp.getAverage(tpa.times, tpa.gcTimes);
197-
report += bp.generateReportPartial(stepName, avg, tpa.fmtTimes, tpa.fmtGCTimes);
248+
avg = bp.getAverage(
249+
tpa.times,
250+
tpa.gcTimes,
251+
tpa.garbageTimes,
252+
tpa.retainedTimes);
253+
reportModel = bp.generateReportModel({
254+
name: stepName,
255+
avg: avg,
256+
times: tpa.fmtTimes,
257+
gcTimes: tpa.fmtGCTimes,
258+
garbageTimes: tpa.fmtGarbageTimes,
259+
retainedTimes: tpa.fmtRetainedTimes
260+
});
261+
report += bp.generateReportPartial(reportModel);
198262
});
199263
return report;
200264
};
@@ -229,6 +293,8 @@ bp.addLinks = function() {
229293

230294
bp.addInfo = function() {
231295
bp.infoDiv = bp.container().querySelector('tbody.info');
296+
bp.infoTemplate = _.template(bp.container().querySelector('#infoTemplate').innerHTML);
297+
console.log(bp.infoTemplate)
232298
};
233299

234300
bp.onDOMContentLoaded = function() {

‎benchmark/web/bp.spec.js‎

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ describe('bp', function() {
2828
numSamples: 20,
2929
recentTimePerStep: {},
3030
recentGCTimePerStep: {},
31+
recentGarbagePerStep: {},
32+
recentRetainedMemoryPerStep: {},
3133
timesPerAction: {}
3234
};
3335
});
@@ -293,6 +295,7 @@ describe('bp', function() {
293295
beforeEach(function() {
294296
bp.steps = [mockStep];
295297
bp.infoDiv = document.createElement('div');
298+
bp.infoTemplate = jasmine.createSpy('infoTemplate');
296299
});
297300

298301
it('should call resetIterations before calling done', function() {
@@ -359,9 +362,11 @@ describe('bp', function() {
359362

360363
describe('.getAverage()', function() {
361364
it('should return the average of a set of numbers', function() {
362-
expect(bp.getAverage([100,0,50,75,25], [2,4,2,4,3])).toEqual({
365+
expect(bp.getAverage([100,0,50,75,25], [2,4,2,4,3], [1,2],[3,4])).toEqual({
363366
gcTime: 3,
364-
time: 50
367+
time: 50,
368+
garbage: 1.5,
369+
retained: 3.5
365370
});
366371
});
367372
});
@@ -379,11 +384,21 @@ describe('bp', function() {
379384
recentGCTimePerStep: {
380385
fakeStep: 2
381386
},
387+
recentGarbagePerStep: {
388+
fakeStep: 200
389+
},
390+
recentRetainedMemoryPerStep: {
391+
fakeStep: 100
392+
},
382393
timesPerAction: {
383394
fakeStep: {
384395
times: [3,7],
385396
fmtTimes: ['3', '7'],
386397
fmtGCTimes: ['1','3'],
398+
garbageTimes: [50,50],
399+
fmtGarbageTimes: ['50','50'],
400+
retainedTimes: [25,25],
401+
fmtRetainedTimes: ['25','25'],
387402
gcTimes: [1,3],
388403
nextEntry: 2
389404
},
@@ -392,21 +407,17 @@ describe('bp', function() {
392407
});
393408

394409

395-
it('should call generateReportPartial() with the correct info', function() {
410+
xit('should call generateReportPartial() with the correct info', function() {
396411
var spy = spyOn(bp, 'generateReportPartial');
397412
bp.calcStats();
398-
expect(spy).toHaveBeenCalledWith('fakeStep', {time: 5, gcTime: 2}, ['3','7','5'], ['1','3','2'])
399-
expect(spy.calls[0].args[0]).toBe('fakeStep');
400-
expect(spy.calls[0].args[1].gcTime).toBe(2);
401-
expect(spy.calls[0].args[1].time).toBe(5);
402-
expect(spy.calls[0].args[2]).toEqual(['3','7', '5']);
413+
expect(spy).toHaveBeenCalledWith('fakeStep', {time: 5, gcTime: 2}, ['3','7','5'], ['1','3','2'], [50,50,200], [25,25,100])
403414
});
404415

405416

406417
it('should call getAverage() with the correct info', function() {
407418
var spy = spyOn(bp, 'getAverage').andCallThrough();
408419
bp.calcStats();
409-
expect(spy).toHaveBeenCalledWith([ 3, 7, 5 ], [ 1, 3, 2 ]);
420+
expect(spy).toHaveBeenCalledWith([ 3, 7, 5 ], [ 1, 3, 2 ], [50,50,0.2], [25,25,0.1]);
410421
});
411422

412423

@@ -425,8 +436,40 @@ describe('bp', function() {
425436
});
426437

427438

439+
describe('.generateReportModel()', function() {
440+
it('should return properly formatted data', function() {
441+
expect(bp.generateReportModel({
442+
name: 'Some Step',
443+
avg: {
444+
time: 1.234567,
445+
gcTime: 2.345678,
446+
garbage: 6.5,
447+
retained: 7.5
448+
},
449+
times: ['1','2'],
450+
gcTimes: ['4','5'],
451+
garbageTimes: ['6','7'],
452+
retainedTimes: ['7','8']
453+
})).toEqual({
454+
name : 'Some Step',
455+
avg : {
456+
time : '1.2345',
457+
gcTime : '2.3456',
458+
garbage : '6.5',
459+
retained : '7.5',
460+
combinedTime : '3.5802'
461+
},
462+
times : '1<br>2',
463+
gcTimes : '4<br>5',
464+
garbageTimes : '6<br>7',
465+
retainedTimes : '7<br>8'
466+
});
467+
});
468+
});
469+
470+
428471
describe('.generateReportPartial()', function() {
429-
it('should return an html string with provided values', function() {
472+
xit('should return an html string with provided values', function() {
430473
bp.runState.numSamples = 9;
431474
expect(bp.generateReportPartial('foo', {time: 10, gcTime: 5}, ['9', '11'], ['4','6'])).
432475
toBe('<tr class="sampleContainer"><td>foo</td><td class="average">test:10ms<br>gc:5ms<br>combined: 15ms</td><td><div class="sampleContainer"><div class="testTimeCol">9<br>11</div><div class="testTimeCol">4<br>6</div></div></td></tr>')
@@ -438,7 +481,7 @@ describe('bp', function() {
438481
it('should write the report to the infoDiv', function() {
439482
bp.infoDiv = document.createElement('div');
440483
bp.writeReport('report!');
441-
expect(bp.infoDiv.innerHTML).toBe('report!');
484+
expect(bp.infoDiv.innerHTML).toBe('report!')
442485
});
443486
});
444487

0 commit comments

Comments
 (0)