Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

performance: fix timerify bug #40625

Closed
wants to merge 4 commits into from
Closed

performance: fix timerify bug #40625

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36c886f
performance: fix timerify bug
iam-frankqiu Oct 27, 2021
304d5df
perf_hooks: add a test and drop isConstructor
iam-frankqiu Oct 27, 2021
47edde3
perf_hooks: alter the test and format timerify
iam-frankqiu Oct 28, 2021
591f94b
doc: add a comment to the fn
iam-frankqiu Oct 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 32 additions & 43 deletions lib/internal/perf/timerify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,45 +12,30 @@ const {
const { InternalPerformanceEntry } = require('internal/perf/performance_entry');
const { now } = require('internal/perf/utils');

const {
validateFunction,
validateObject,
} = require('internal/validators');
const { validateFunction, validateObject } = require('internal/validators');
iam-frankqiu marked this conversation as resolved.
Show resolved Hide resolved

const {
isHistogram
} = require('internal/histogram');
const { isHistogram } = require('internal/histogram');

const {
isConstructor,
} = internalBinding('util');

const {
codes: {
ERR_INVALID_ARG_TYPE,
},
codes: { ERR_INVALID_ARG_TYPE },
} = require('internal/errors');

const {
enqueue,
} = require('internal/perf/observe');
const { enqueue } = require('internal/perf/observe');

const kTimerified = Symbol('kTimerified');

function processComplete(name, start, args, histogram) {
const duration = now() - start;
if (histogram !== undefined)
histogram.record(MathCeil(duration * 1e6));
const entry =
new InternalPerformanceEntry(
name,
'function',
start,
duration,
args);

for (let n = 0; n < args.length; n++)
entry[n] = args[n];
if (histogram !== undefined) histogram.record(MathCeil(duration * 1e6));
const entry = new InternalPerformanceEntry(
name,
'function',
start,
duration,
args
);

for (let n = 0; n < args.length; n++) entry[n] = args[n];

enqueue(entry);
}
Expand All @@ -59,27 +44,29 @@ function timerify(fn, options = {}) {
validateFunction(fn, 'fn');

validateObject(options, 'options');
const {
histogram
} = options;
const { histogram } = options;

if (histogram !== undefined &&
(!isHistogram(histogram) || typeof histogram.record !== 'function')) {
if (
histogram !== undefined &&
(!isHistogram(histogram) || typeof histogram.record !== 'function')
) {
throw new ERR_INVALID_ARG_TYPE(
'options.histogram',
'RecordableHistogram',
histogram);
histogram
);
}

if (fn[kTimerified]) return fn[kTimerified];

const constructor = isConstructor(fn);
// If the parameter is a function and it will be called directly
// or used as `new` operator.
const isCalledAsConstructor = (fn) => /^\s*class/.test(fn.toString());

function timerified(...args) {
const start = now();
const result = constructor ?
ReflectConstruct(fn, args, fn) :
ReflectApply(fn, this, args);
const result = isCalledAsConstructor(fn) ?
ReflectConstruct(fn, args, fn) : ReflectApply(fn, this, args);
Comment on lines +78 to +79
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const result = isCalledAsConstructor(fn) ?
ReflectConstruct(fn, args, fn) : ReflectApply(fn, this, args);
const result = new.target !== undefined ?
ReflectConstruct(fn, args, fn) :
ReflectApply(fn, this, args);

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You marked this conversation as resolved but didn't take my suggestion. Is it because you disagree with it, or because you forgot to push?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aduh95 wouldn't new.target not be undefined only if timerified() is called with new instead of fn()?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but that's the point. We want the timerified function to behave the same as the original function in both cases.

Copy link
Contributor

@RaisinTen RaisinTen Oct 31, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, we are returning timerified from timerify. Yea, this makes sense 👍

if (!constructor && typeof result?.finally === 'function') {
iam-frankqiu marked this conversation as resolved.
Show resolved Hide resolved
return result.finally(
FunctionPrototypeBind(
Expand All @@ -88,7 +75,9 @@ function timerify(fn, options = {}) {
fn.name,
start,
args,
histogram));
histogram
)
);
}
processComplete(fn.name, start, args, histogram);
return result;
Expand All @@ -108,16 +97,16 @@ function timerify(fn, options = {}) {
name: {
configurable: false,
enumerable: true,
value: `timerified ${fn.name}`
}
value: `timerified ${fn.name}`,
},
});

ObjectDefineProperties(fn, {
[kTimerified]: {
configurable: false,
enumerable: false,
value: timerified,
}
},
});

return timerified;
Expand Down
7 changes: 0 additions & 7 deletions src/node_util.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,6 @@ static void GuessHandleType(const FunctionCallbackInfo<Value>& args) {
args.GetReturnValue().Set(OneByteString(env->isolate(), type));
}

static void IsConstructor(const FunctionCallbackInfo<Value>& args) {
CHECK(args[0]->IsFunction());
args.GetReturnValue().Set(args[0].As<v8::Function>()->IsConstructor());
}

static void ToUSVString(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
CHECK_GE(args.Length(), 2);
Expand Down Expand Up @@ -344,7 +339,6 @@ void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
registry->Register(WeakReference::IncRef);
registry->Register(WeakReference::DecRef);
registry->Register(GuessHandleType);
registry->Register(IsConstructor);
registry->Register(ToUSVString);
}

Expand Down Expand Up @@ -384,7 +378,6 @@ void Initialize(Local<Object> target,
env->SetMethodNoSideEffect(target, "getConstructorName", GetConstructorName);
env->SetMethodNoSideEffect(target, "getExternalValue", GetExternalValue);
env->SetMethod(target, "sleep", Sleep);
env->SetMethodNoSideEffect(target, "isConstructor", IsConstructor);

env->SetMethod(target, "arrayBufferViewHasBuffer", ArrayBufferViewHasBuffer);
Local<Object> constants = Object::New(env->isolate());
Expand Down
24 changes: 24 additions & 0 deletions test/parallel/test-performance-function.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,30 @@ const {
setTimeout: sleep
} = require('timers/promises');

{
const perf = performance.timerify(function foo() {
let sum = 0;
for (let i = 0; i < 101; i++) {
sum += i;
}
return sum;
});
const result = perf();
assert.strictEqual(result, 5050);
}

{
class Foo {
constructor() {
/* eslint-disable no-constructor-return */
return Promise.resolve('foo');
}
}
const perf = performance.timerify(Foo);
const result = perf();
result.then((val) => assert.strictEqual(val, 'foo'));
iam-frankqiu marked this conversation as resolved.
Show resolved Hide resolved
}

{
// Intentional non-op. Do not wrap in common.mustCall();
const n = performance.timerify(function noop() {});
Expand Down