From 17ab5ae570bf88024a320071decef9059abf39d2 Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Fri, 1 Mar 2024 02:44:55 +0100 Subject: [PATCH] test: fix unreliable assumption in js-native-api/test_cannot_run_js MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Previously the test assumes that when the queued finalizer is run, it must be run at a point where env->can_call_into_js() is false (typically, during Environment shutdown), which is not certain. If GC kicks in early and the second pass finalizer is queued before the event loop runs the check callbacks, the finalizer would then be called in check callbacks (via native immediates), where the finalizer can still call into JS. Essentially, addons can't make assumptions about where the queued finalizer would be called. This patch updates the assertions in the test to account for that. PR-URL: https://github.com/nodejs/node/pull/51898 Reviewed-By: Michaël Zasso Reviewed-By: Richard Lau Reviewed-By: Marco Ippolito Reviewed-By: Chengzhong Wu --- .../test_cannot_run_js/test_cannot_run_js.c | 32 ++++++++++++++----- test/root.status | 1 - 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/test/js-native-api/test_cannot_run_js/test_cannot_run_js.c b/test/js-native-api/test_cannot_run_js/test_cannot_run_js.c index c495f8780d0141..813e59918e7b3a 100644 --- a/test/js-native-api/test_cannot_run_js/test_cannot_run_js.c +++ b/test/js-native-api/test_cannot_run_js/test_cannot_run_js.c @@ -6,17 +6,33 @@ static void Finalize(napi_env env, void* data, void* hint) { napi_value global, set_timeout; napi_ref* ref = data; + + NODE_API_NOGC_ASSERT_RETURN_VOID( + napi_delete_reference(env, *ref) == napi_ok, + "deleting reference in finalizer should succeed"); + NODE_API_NOGC_ASSERT_RETURN_VOID( + napi_get_global(env, &global) == napi_ok, + "getting global reference in finalizer should succeed"); + napi_status result = + napi_get_named_property(env, global, "setTimeout", &set_timeout); + + // The finalizer could be invoked either from check callbacks (as native + // immediates) if the event loop is still running (where napi_ok is returned) + // or during environment shutdown (where napi_cannot_run_js or + // napi_pending_exception is returned). This is not deterministic from + // the point of view of the addon. + #ifdef NAPI_EXPERIMENTAL - napi_status expected_status = napi_cannot_run_js; + NODE_API_NOGC_ASSERT_RETURN_VOID( + result == napi_cannot_run_js || result == napi_ok, + "getting named property from global in finalizer should succeed " + "or return napi_cannot_run_js"); #else - napi_status expected_status = napi_pending_exception; + NODE_API_NOGC_ASSERT_RETURN_VOID( + result == napi_pending_exception || result == napi_ok, + "getting named property from global in finalizer should succeed " + "or return napi_pending_exception"); #endif // NAPI_EXPERIMENTAL - - if (napi_delete_reference(env, *ref) != napi_ok) abort(); - if (napi_get_global(env, &global) != napi_ok) abort(); - if (napi_get_named_property(env, global, "setTimeout", &set_timeout) != - expected_status) - abort(); free(ref); } diff --git a/test/root.status b/test/root.status index 12fef69a4b3c92..22f7260246f5e0 100644 --- a/test/root.status +++ b/test/root.status @@ -1,5 +1,4 @@ [true] -js-native-api/test_cannot_run_js/test: PASS,FLAKY [$mode==debug] async-hooks/test-callback-error: SLOW