CallTracker wrapper function to have original function length

Is your feature request related to a problem?

Some frameworks and libraries (ex. Express.js middleware execution) rely on the function length and use it to decide the appropriate behaviour.

Currently, the CallTracker Node.js API does not proxy the original function length. Thus, its application may be limited in certain circumstances.

import assert from 'assert';

function originalFn(a, b, c) { /* noop */ }

const tracker = new assert.CallTracker();
const trackedFn = tracker.calls(originalFn, 1);

console.log(`originalFn length: ${originalFn.length}`); // => 3
console.log(`trackedFn length: ${trackedFn.length}`); // => 0

Such widely popular test automation frameworks as Jest have built-in functionality to match the arity of a function when it is mocked. And they also consider the original function length as a source of truth.

So here, it is proposed to change the CallTracker.calls wrapper function to match the arity of the original function.
I would be glad to work on this feature and create my first code contribution to the Node.js codebase! 😃

Describe the solution you'd like

To achieve the goal of this feature request, it is proposed to change the CallTracker.calls wrapper function, and, for instance, redefine the length property of this function with:

ReflectDefineProperty(wrapperFunction, 'length', { value: originalFn.length });

Moreover, the wrapper function may also be refactored to use rest parameters instead of the arguments object.

Describe alternatives you've considered

It is an open question whether it is required to proxy call, apply and bind methods calls to the original function, as well as to detect if the wrapper function is called as a constructor.

@primeare

@primeare Would you like to work on this?

@Mesteery

@Mesteery, yes, I do want to work on this feature implementation. Is there anything important or particular I should know prior to starting working on the implementation except accepting the Code of Conduct and reading the Contribution Guidelines?

Is there anything important or particular I should know

Hopefully documentation (such as in doc/guides) should contain all the info you need, but don't hesitate to ask questions if you get stuck. Don't forget to run make lint-js-fix before committing, and to add a test that fails with the current master and passes with the fix.

There has been no activity on this feature request for 5 months and it is unlikely to be implemented. It will be closed 6 months after the last non-automated comment.

For more information on how the project manages feature requests, please consult the feature request management document.

@aduh95

see this github-actions hint will close this in 6 months, can I work on this? @aduh95 @Mesteery

can I work on this?

Sure, go for it :)

@aduh95

can I work on this?

Sure, go for it :)

@aduh95 Thanks, I have submitted the pr #42909

assert: fix CallTracker wraps the function causes the length to be lost

Navigation Menu

Repository navigation

`CallTracker` wrapper function to have original function length #40484

Is your feature request related to a problem?

Describe the solution you'd like

Describe alternatives you've considered

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

CallTracker wrapper function to have original function length #40484

Description

Is your feature request related to a problem?

Describe the solution you'd like

Describe alternatives you've considered

Activity

Mesteery commented on Oct 16, 2021

primeare commented on Oct 16, 2021

aduh95 commented on Oct 16, 2021

github-actions commented on Apr 15, 2022

Y1D7NG commented on Apr 28, 2022

aduh95 commented on Apr 28, 2022

Y1D7NG commented on Apr 29, 2022

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

`CallTracker` wrapper function to have original function length #40484