node/test/parallel/test-performance-eventlooputil.js
Trevor Norris 589b2a1244 perf_hooks: add idleTime and event loop util
Use uv_metrics_idle_time() to return a high resolution millisecond timer
of the amount of time the event loop has been idle since it was
initialized.

Include performance.eventLoopUtilization() API to handle the math of
calculating the idle and active times. This has been added to prevent
accidental miscalculations of the event loop utilization. Such as not
taking into consideration offsetting nodeTiming.loopStart or timing
differences when being called from a Worker thread.

PR-URL: https://github.com/nodejs/node/pull/34938
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Adrian Estrada <edsadr@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2020-08-29 07:02:31 -07:00

100 lines
3.2 KiB
JavaScript

'use strict';
require('../common');
const TIMEOUT = 50;
const assert = require('assert');
const { performance } = require('perf_hooks');
const { Worker, parentPort } = require('worker_threads');
const { nodeTiming, eventLoopUtilization } = performance;
const elu = eventLoopUtilization();
// Take into account whether this test was started as a Worker.
if (nodeTiming.loopStart === -1) {
assert.strictEqual(nodeTiming.idleTime, 0);
assert.deepStrictEqual(elu, { idle: 0, active: 0, utilization: 0 });
assert.deepStrictEqual(eventLoopUtilization(elu),
{ idle: 0, active: 0, utilization: 0 });
assert.deepStrictEqual(eventLoopUtilization(elu, eventLoopUtilization()),
{ idle: 0, active: 0, utilization: 0 });
}
// Place in setTimeout() to make sure there is some idle time, but not going to
// assert this since it could make the test flaky.
setTimeout(() => {
const t = Date.now();
const elu1 = eventLoopUtilization();
while (Date.now() - t < 50) { }
const elu2 = eventLoopUtilization();
const elu3 = eventLoopUtilization(elu1);
const elu4 = eventLoopUtilization(elu2, elu1);
assert.strictEqual(elu3.idle, 0);
assert.strictEqual(elu4.idle, 0);
assert.strictEqual(elu3.utilization, 1);
assert.strictEqual(elu4.utilization, 1);
assert.strictEqual(elu2.active - elu1.active, elu4.active);
assert.ok(elu2.active > elu3.active);
assert.ok(elu2.active > elu4.active);
assert.ok(elu3.active > elu4.active);
setTimeout(runIdleTimeTest, TIMEOUT);
}, 5);
function runIdleTimeTest() {
const idleTime = nodeTiming.idleTime;
const elu1 = eventLoopUtilization();
const sum = elu1.idle + elu1.active;
assert.ok(sum >= elu1.idle && sum >= elu1.active,
`idle: ${elu1.idle} active: ${elu1.active} sum: ${sum}`);
assert.strictEqual(elu1.idle, idleTime);
assert.strictEqual(elu1.utilization, elu1.active / sum);
setTimeout(runCalcTest, TIMEOUT, elu1);
}
function runCalcTest(elu1) {
const now = performance.now();
const elu2 = eventLoopUtilization();
const elu3 = eventLoopUtilization(elu2, elu1);
const active_delta = elu2.active - elu1.active;
const idle_delta = elu2.idle - elu1.idle;
assert.ok(elu2.idle >= 0);
assert.ok(elu2.active >= 0);
assert.ok(elu3.idle >= 0);
assert.ok(elu3.active >= 0);
assert.ok(elu2.idle + elu2.active > elu1.idle + elu2.active);
assert.ok(elu2.idle + elu2.active >= now - nodeTiming.loopStart);
assert.strictEqual(elu3.active, elu2.active - elu1.active);
assert.strictEqual(elu3.idle, elu2.idle - elu1.idle);
assert.strictEqual(elu3.utilization,
active_delta / (idle_delta + active_delta));
setImmediate(runWorkerTest);
}
function runWorkerTest() {
// Use argv to detect whether we're running as a Worker called by this test
// vs. this test also being called as a Worker.
if (process.argv[2] === 'iamalive') {
parentPort.postMessage(JSON.stringify(eventLoopUtilization()));
return;
}
const elu1 = eventLoopUtilization();
const worker = new Worker(__filename, { argv: [ 'iamalive' ] });
worker.on('message', (msg) => {
const elu2 = eventLoopUtilization(elu1);
const data = JSON.parse(msg);
assert.ok(elu2.active + elu2.idle > data.active + data.idle);
});
}