Skip to content

node-api: make napi_delete_reference use node_api_basic_env #59684

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

Merged
nodejs-github-bot merged 6 commits into from
Sep 12, 2025
Merged

node-api: make napi_delete_reference use node_api_basic_env #59684

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
82177ad
node-api: make napi_delete_reference use node_api_basic_env
JeetuSuthar Aug 30, 2025
001894c
fix: address review comments, remove duplicate comments, wrap long li…
JeetuSuthar Aug 31, 2025
26c06d6
fix: remove duplicate function definition and fix formatting
JeetuSuthar Sep 1, 2025
6a54a14
Format-cpp and lint fix
JeetuSuthar Sep 1, 2025
dde1ea8
removed static_cast
JeetuSuthar Sep 2, 2025
f58f962
remove unnecessary static_cast and formatting
JeetuSuthar Sep 3, 2025
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
2 changes: 1 addition & 1 deletion src/js_native_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ napi_create_reference(napi_env env,

// Deletes a reference. The referenced value is released, and may
// be GC'd unless there are other references to it.
NAPI_EXTERN napi_status NAPI_CDECL napi_delete_reference(napi_env env,
NAPI_EXTERN napi_status NAPI_CDECL napi_delete_reference(node_api_basic_env env,
napi_ref ref);

// Increments the reference count, optionally returning the resulting count.
Expand Down
3 changes: 2 additions & 1 deletion src/js_native_api_v8.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2773,7 +2773,8 @@ napi_status NAPI_CDECL napi_create_reference(napi_env env,
// there are other references to it.
// For a napi_reference returned from `napi_wrap`, this must be called in the
// finalizer.
napi_status NAPI_CDECL napi_delete_reference(napi_env env, napi_ref ref) {
napi_status NAPI_CDECL napi_delete_reference(node_api_basic_env env,
napi_ref ref) {
// Omit NAPI_PREAMBLE and GET_RETURN_STATUS because V8 calls here cannot throw
// JS exceptions.
CHECK_ENV(env);
Expand Down
3 changes: 2 additions & 1 deletion test/cctest/test_linked_binding.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,8 @@ napi_value InitializeLocalNapiRefBinding(napi_env env, napi_value exports) {
napi_ref ref{};
if (node_api_version == NAPI_VERSION_EXPERIMENTAL) {
CHECK_EQ(napi_create_reference(env, key, 1, &ref), napi_ok);
CHECK_EQ(napi_delete_reference(env, ref), napi_ok);
CHECK_EQ(napi_delete_reference(static_cast<node_api_basic_env>(env), ref),
Copy link
Member

@legendecas legendecas Sep 2, 2025

Choose a reason for hiding this comment

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

I don't think this static_cast is necessary.

Copy link
Contributor Author

@JeetuSuthar JeetuSuthar Sep 2, 2025

Choose a reason for hiding this comment

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

Ok let me remove that

Copy link
Contributor Author

@JeetuSuthar JeetuSuthar Sep 2, 2025

Choose a reason for hiding this comment

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

@legendecas I removed the static cast

napi_ok);
} else {
CHECK_EQ(napi_create_reference(env, key, 1, &ref), napi_invalid_arg);
}
Expand Down
6 changes: 4 additions & 2 deletions test/js-native-api/6_object_wrap/myobject.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ MyObject::MyObject(double value)
: value_(value), env_(nullptr), wrapper_(nullptr) {}

MyObject::~MyObject() {
napi_delete_reference(env_, wrapper_);
napi_delete_reference(static_cast<node_api_basic_env>(env_), wrapper_);
Copy link
Member

@legendecas legendecas Sep 3, 2025

Choose a reason for hiding this comment

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

Would you mind removing this change? As mentioned earlier, this is not necessary.

Copy link
Contributor Author

@JeetuSuthar JeetuSuthar Sep 3, 2025

Choose a reason for hiding this comment

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

Yes done

}

void MyObject::Destructor(node_api_basic_env env,
Expand Down Expand Up @@ -215,7 +215,9 @@ napi_value ObjectWrapDanglingReferenceTest(napi_env env,

if (out == nullptr) {
// If the napi_ref has been invalidated, delete it.
NODE_API_CALL(env, napi_delete_reference(env, dangling_ref));
NODE_API_CALL(env,
napi_delete_reference(static_cast<node_api_basic_env>(env),
dangling_ref));
NODE_API_CALL(env, napi_get_boolean(env, true, &ret));
} else {
// The dangling napi_ref is still valid.
Expand Down
4 changes: 2 additions & 2 deletions test/js-native-api/6_object_wrap/nested_wrap.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ static int finalization_count = 0;
NestedWrap::NestedWrap() {}

NestedWrap::~NestedWrap() {
napi_delete_reference(env_, wrapper_);
napi_delete_reference(static_cast<node_api_basic_env>(env_), wrapper_);

// Delete the nested reference as well.
napi_delete_reference(env_, nested_);
napi_delete_reference(static_cast<node_api_basic_env>(env_), nested_);
}

void NestedWrap::Destructor(node_api_basic_env env,
Expand Down
4 changes: 3 additions & 1 deletion test/js-native-api/7_factory_wrap/myobject.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ static int finalize_count = 0;

MyObject::MyObject() : env_(nullptr), wrapper_(nullptr) {}

MyObject::~MyObject() { napi_delete_reference(env_, wrapper_); }
MyObject::~MyObject() {
Copy link
Member

@legendecas legendecas Sep 3, 2025

Choose a reason for hiding this comment

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

Would you mind removing this unnecessary formatting?

Copy link
Contributor Author

@JeetuSuthar JeetuSuthar Sep 3, 2025

Choose a reason for hiding this comment

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

@legendecas Done

napi_delete_reference(static_cast<node_api_basic_env>(env_), wrapper_);
}

void MyObject::Destructor(napi_env env,
void* nativeObject,
Expand Down
2 changes: 1 addition & 1 deletion test/js-native-api/8_passing_wrapped/myobject.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MyObject::MyObject() : env_(nullptr), wrapper_(nullptr) {}

MyObject::~MyObject() {
finalize_count++;
napi_delete_reference(env_, wrapper_);
napi_delete_reference(static_cast<node_api_basic_env>(env_), wrapper_);
}

void MyObject::Destructor(
Expand Down
4 changes: 3 additions & 1 deletion test/node-api/test_uv_loop/test_uv_loop.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ napi_value SetImmediateBinding(napi_env env, napi_callback_info info) {
NODE_API_CALL(env, napi_open_handle_scope(env, &scope));
NODE_API_CALL(env, napi_get_undefined(env, &undefined));
NODE_API_CALL(env, napi_get_reference_value(env, cbref, &callback));
NODE_API_CALL(env, napi_delete_reference(env, cbref));
NODE_API_CALL(
env,
napi_delete_reference(static_cast<node_api_basic_env>(env), cbref));
NODE_API_CALL(env,
napi_call_function(env, undefined, callback, 0, nullptr, nullptr));
NODE_API_CALL(env, napi_close_handle_scope(env, scope));
Expand Down
Loading