Repository navigation
Serious issue with NAPI_VERSION being set to 3 on 8.x branch while features are missing #330
Description
I am writing an N-API integration that uses an node::AtExit callback hook, and I intend to use N-API for that.
The documentation of napi_add_env_cleanup_hook https://nodejs.org/api/n-api.html#n_api_napi_add_env_cleanup_hook states this was added in N-API version 3.
However, Node.js 8.11 is missing this function even though it advertises support for N-API version 3.
I do not understand why Node 8 should have N-API version 3, but most of all I'm incredibly surprised by the mismatch between N-API versions and actually exported N-API functions.
I know versions 1-2 were sort of messy, but I definitely expected all N-API version 3 functions to be present if NAPI_VERSION is set to 3.
What is the purpose of NAPI_VERSION if it cannot be used to detect new additions?
Can someone please advise what the best way forward is for module authors like me.
Activity
gabrielschulhof commentedon Aug 21, 2018
@rolftimmermans I started a backport PR.
kfarnung commentedon Aug 22, 2018
@rolftimmermans Thanks for the report. Unfortunately NAPI_VERSION 3 was created without a formal process for accepting new APIs and promoting them. That process has been documented now so this should not be an issue going forward.
Thanks @gabrielschulhof for opening the backport PR!
mhdawson commentedon Aug 22, 2018
Just to add to the comments from @kfarnung, what I understand happened was that a new API was added to master and then backported to 10.X without bumping the NAPI_VERSION which should have been the case. This meant that it would be SemVer major to remove it from 10.X.
The new guidance and use of an experimental phase should prevent this from occurring again.
@gabrielschulhof it will need a backport to both 8.x and 6.x to completely close the gap.
gabrielschulhof commentedon Aug 22, 2018
mhdawson commentedon Nov 15, 2021
Looks like backport PR landed and we have improved the handling of how new functions are added since Node-API went stable. Closing, please let us know if you think that was not the right thing to do.