vm.compileFunction should return an object

[ryzokuken]

At #23837 (comment), @jdalton proposed that instead of returning a function with certain special properties, vm.compileFunction should instead return an object with the said properties and the function stored as the value property on the object.

This approach was infact discussed during the design phase of compileFunction, and I agree that either approach has it's own merits, but I decided to go with the status quo because it was consistent with similar functions in the vm module and consistency is really important IMO.

I'm opening this issue as suggested by @jdalton to open a discussion regarding what the best way to return information from these functions will be, moving forward.

I have three options in mind:

1. Continue with the status quo (consistent).
2. Make vm.compileFunction return an Object (inconsistent).
3. Make all similar functions return Objects (consistent).

Feel free to back one of the above or suggest something else entirely. The updates (if any) will have to be semver-major, but thankfully vm is probably one of the least used modules externally (vs internally).

[ryzokuken]

/cc @nodejs/vm

[jdalton]

Background: Before the properties like cachedDataRejected were added to the script object instance. Because compileFunction returns the actual function placing extra data like cachedDataRejected ends up on the actual function. Something like a script instance would be handy for tracking this kind of data.

[Trott]

Should we try to ping a bit wider to try to get some opinions on this? (Alternatively, you can take the lack of responses as an indication that you should open a pull request to do whichever one you think makes the most sense. I don't know how much work that is, and how disappointing it would be to then have it rejected. On the other hand, responding to concrete pull requests is probably easier then forming opinions in the abstract?)

[ryzokuken]

@Trott I think I could make a PR soon-ish.

[github-actions]

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.