Resource is optional in napi_async_init
#33153
Labels
async_hooks
Issues and PRs related to the async hooks subsystem.
node-api
Issues and PRs related to the Node-API.
Comments
4 tasks
legendecas
added
node-api
mhdawson
added a commit
to mhdawson/io.js
that referenced
this issue
Apr 30, 2020
Fixes: nodejs#33153 Change documentation to make async_resource required as opposed to optional in napi-async_init. Changes over time mean this parameter is required for proper operation of async hooks (which are still experimental). This changes the documentation to document what callers should do. We are doing this only in the doc in order to avoid a breaking change in N-API. We could create a new version of the method for which the parametrer is enforced as mandatory but we should only do that once async hooks is no longer experimental. In that case we could deprecate (but not remove this version of the method). Signed-off-by: Michael Dawson <[email protected]>
3 tasks
|
@legendecas, @Flarna this is what I'd suggest we do: I don't think we should change the implementation as it would be breaking which we can't do for N-API but updating the doc does make sense. |
|
I've left as draft until I get feedback from @legendecas and @Flarna that this makes sense to them as well. |
codebytere
pushed a commit
that referenced
this issue
May 7, 2020
Fixes: #33153 Change documentation to make async_resource required as opposed to optional in napi-async_init. Changes over time mean this parameter is required for proper operation of async hooks (which are still experimental). This changes the documentation to document what callers should do. We are doing this only in the doc in order to avoid a breaking change in N-API. We could create a new version of the method for which the parametrer is enforced as mandatory but we should only do that once async hooks is no longer experimental. In that case we could deprecate (but not remove this version of the method). Signed-off-by: Michael Dawson <[email protected]> PR-URL: #33181 Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
codebytere
pushed a commit
that referenced
this issue
Jun 7, 2020
Fixes: #33153 Change documentation to make async_resource required as opposed to optional in napi-async_init. Changes over time mean this parameter is required for proper operation of async hooks (which are still experimental). This changes the documentation to document what callers should do. We are doing this only in the doc in order to avoid a breaking change in N-API. We could create a new version of the method for which the parametrer is enforced as mandatory but we should only do that once async hooks is no longer experimental. In that case we could deprecate (but not remove this version of the method). Signed-off-by: Michael Dawson <[email protected]> PR-URL: #33181 Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Maybe we should also think about adapting
napi_async_initas it states that the resource is optional. As Node is meanwhile built to require an async resource it seems to be strange that we create an object on the fly if user doesn't provide one.Removing the null check in
napi_async_initwould be no issue from ABI point of view but breaking from behavior. Not sure if this should be included in this PR.Originally posted by @Flarna in #32930
The text was updated successfully, but these errors were encountered: