perf_hooks,http2: add performance.clear()

Add missing clear() method to `perf_hooks.performance` to remove the entries from the master timeline to prevent that from being a memory leak. Backport-PR-URL: #20456 PR-URL: #18046 Reviewed-By: Matteo Collina <[email protected]>
nodejs · May 2, 2018 · 6bdfb1f · 6bdfb1f
1 parent 88babd5
commit 6bdfb1f
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md
@@ -29,6 +29,14 @@ added: v8.5.0
 The `Performance` provides access to performance metric data. A single
 instance of this class is provided via the `performance` property.
 
+### performance.clearEntries(name)
+<!-- YAML
+added: REPLACEME
+-->
+
+Remove all performance entry objects with `entryType` equal to `name` from the
+Performance Timeline.
+
 ### performance.clearFunctions([name])
 <!-- YAML
 added: v8.5.0

diff --git a/lib/perf_hooks.js b/lib/perf_hooks.js
@@ -471,6 +471,10 @@ class Performance extends PerformanceObserverEntryList {
     this[kClearEntry]('function', name);
   }
 
+  clearEntries(name) {
+    this[kClearEntry](name);
+  }
+
   timerify(fn) {
     if (typeof fn !== 'function') {
       const errors = lazyErrors();

diff --git a/test/parallel/test-http2-perf_hooks.js b/test/parallel/test-http2-perf_hooks.js
@@ -6,7 +6,7 @@ if (!common.hasCrypto)
 const assert = require('assert');
 const h2 = require('http2');
 
-const { PerformanceObserver } = require('perf_hooks');
+const { PerformanceObserver, performance } = require('perf_hooks');
 
 const obs = new PerformanceObserver(common.mustCall((items) => {
   const entry = items.getEntries()[0];
@@ -46,6 +46,7 @@ const obs = new PerformanceObserver(common.mustCall((items) => {
     default:
       assert.fail('invalid entry name');
   }
+  performance.clearEntries('http2');
 }, 4));
 obs.observe({ entryTypes: ['http2'] });
 
@@ -100,3 +101,10 @@ server.on('listening', common.mustCall(() => {
   }));
 
 }));
+
+process.on('exit', () => {
+  const entries = performance.getEntries();
+  // There shouldn't be any http2 entries left over.
+  assert.strictEqual(entries.length, 1);
+  assert.strictEqual(entries[0], performance.nodeTiming);
+});