perf_hooks: add histogram option to timerify

Allows setting a `Histogram` object option on timerify to record function execution times over time. Signed-off-by: James M Snell <[email protected]> PR-URL: #37475 Reviewed-By: Matteo Collina <[email protected]>

Author: jasnell

doc/api/perf_hooks.md

@@ -210,17 +210,24 @@ added: v8.5.0
 The [`timeOrigin`][] specifies the high resolution millisecond timestamp at
 which the current `node` process began, measured in Unix time.
 
-### `performance.timerify(fn)`
+### `performance.timerify(fn[, options])`
 <!-- YAML
 added: v8.5.0
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/37475
+ description: Added the histogram option.
  - version: REPLACEME
  pr-url: https://github.com/nodejs/node/pull/37136
  description: Re-implemented to use pure-JavaScript and the ability
  to time async functions.
 -->
 
 *`fn`{Function}
+*`options`{Object}
+*`histogram`{RecordableHistogram} A histogram object created using
+`perf_hooks.createHistogram()` that will record runtime durations in
+ nanoseconds.
 
 _This property is an extension by Node.js. It is not available in Web browsers._
 

lib/internal/histogram.js

@@ -42,6 +42,10 @@ const{
  JSTransferable,
 }=require('internal/worker/js_transferable');
 
+functionisHistogram(object){
+returnobject?.[kHandle]!==undefined;
+}
+
 classHistogramextendsJSTransferable{
 constructor(internal){
 super();
@@ -193,6 +197,7 @@ module.exports ={
  RecordableHistogram,
  InternalHistogram,
  InternalRecordableHistogram,
+ isHistogram,
  kDestroy,
  kHandle,
  createHistogram,

lib/internal/perf/timerify.js

@@ -3,6 +3,7 @@
 const{
  FunctionPrototypeBind,
  ObjectDefineProperties,
+ MathCeil,
  ReflectApply,
  ReflectConstruct,
  Symbol,
@@ -13,6 +14,14 @@ const{
  now,
 }=require('internal/perf/perf');
 
+const{
+ validateObject
+}=require('internal/validators');
+
+const{
+ isHistogram
+}=require('internal/histogram');
+
 const{
  isConstructor,
 }=internalBinding('util');
@@ -29,8 +38,10 @@ const{
 
 constkTimerified=Symbol('kTimerified');
 
-functionprocessComplete(name,start,args){
+functionprocessComplete(name,start,args,histogram){
 constduration=now()-start;
+if(histogram!==undefined)
+histogram.record(MathCeil(duration*1e6));
 constentry=
 newInternalPerformanceEntry(
 name,
@@ -45,10 +56,23 @@ function processComplete(name, start, args){
 enqueue(entry);
 }
 
-functiontimerify(fn){
+functiontimerify(fn,options={}){
 if(typeoffn!=='function')
 thrownewERR_INVALID_ARG_TYPE('fn','function',fn);
 
+validateObject(options,'options');
+const{
+ histogram
+}=options;
+
+if(histogram!==undefined&&
+(!isHistogram(histogram)||typeofhistogram.record!=='function')){
+thrownewERR_INVALID_ARG_TYPE(
+'options.histogram',
+'RecordableHistogram',
+histogram);
+}
+
 if(fn[kTimerified])returnfn[kTimerified];
 
 constconstructor=isConstructor(fn);
@@ -65,9 +89,10 @@ function timerify(fn){
 result,
 fn.name,
 start,
-args));
+args,
+histogram));
 }
-processComplete(fn.name,start,args);
+processComplete(fn.name,start,args,histogram);
 returnresult;
 }
 

test/parallel/test-performance-function.js

@@ -4,10 +4,15 @@ const common = require('../common');
 constassert=require('assert');
 
 const{
+ createHistogram,
  performance,
  PerformanceObserver
 }=require('perf_hooks');
 
+const{
+setTimeout: sleep
+}=require('timers/promises');
+
 {
 // Intentional non-op. Do not wrap in common.mustCall();
 constn=performance.timerify(functionnoop(){});
@@ -81,3 +86,38 @@ const{
 assert.strictEqual(n.length,m.length);
 assert.strictEqual(n.name,'timerified m');
 }
+
+(async()=>{
+consthistogram=createHistogram();
+constm=(a,b=1)=>{};
+constn=performance.timerify(m,{ histogram });
+assert.strictEqual(histogram.max,0);
+for(leti=0;i<10;i++){
+n();
+awaitsleep(10);
+}
+assert.notStrictEqual(histogram.max,0);
+[1,'',{},[],false].forEach((histogram)=>{
+assert.throws(()=>performance.timerify(m,{ histogram }),{
+code: 'ERR_INVALID_ARG_TYPE'
+});
+});
+})().then(common.mustCall());
+
+(async()=>{
+consthistogram=createHistogram();
+constm=async(a,b=1)=>{
+awaitsleep(10);
+};
+constn=performance.timerify(m,{ histogram });
+assert.strictEqual(histogram.max,0);
+for(leti=0;i<10;i++){
+awaitn();
+}
+assert.notStrictEqual(histogram.max,0);
+[1,'',{},[],false].forEach((histogram)=>{
+assert.throws(()=>performance.timerify(m,{ histogram }),{
+code: 'ERR_INVALID_ARG_TYPE'
+});
+});
+})().then(common.mustCall());