node-api: verify cleanup hooks order

Cleanup hooks are called before the environment shutdown finalizer
invocations.
PR-URL: #46692
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>

Author: legendecas

test/node-api/test_async_cleanup_hook/binding.c

@@ -4,6 +4,7 @@
 #include<stdlib.h>
 #include"../../js-native-api/common.h"
 
+staticintcleanup_hook_count=0;
 staticvoidMustNotCall(napi_async_cleanup_hook_handlehook, void*arg) {
 assert(0);
 }
@@ -21,17 +22,20 @@ static struct AsyncData* CreateAsyncData() {
 }
 
 staticvoidAfterCleanupHookTwo(uv_handle_t*handle) {
+cleanup_hook_count++;
 structAsyncData*data= (structAsyncData*) handle->data;
 napi_statusstatus=napi_remove_async_cleanup_hook(data->handle);
 assert(status==napi_ok);
 free(data);
 }
 
 staticvoidAfterCleanupHookOne(uv_async_t*async) {
+cleanup_hook_count++;
 uv_close((uv_handle_t*) async, AfterCleanupHookTwo);
 }
 
 staticvoidAsyncCleanupHook(napi_async_cleanup_hook_handlehandle, void*arg) {
+cleanup_hook_count++;
 structAsyncData*data= (structAsyncData*) arg;
 uv_loop_t*loop;
 napi_statusstatus=napi_get_uv_event_loop(data->env, &loop);
@@ -44,7 +48,31 @@ static void AsyncCleanupHook(napi_async_cleanup_hook_handle handle, void* arg) {
 uv_async_send(&data->async);
 }
 
+staticvoidObjectFinalizer(napi_envenv, void*data, void*hint) {
+// AsyncCleanupHook and its subsequent callbacks are called twice.
+assert(cleanup_hook_count==6);
+
+napi_ref*ref=data;
+NODE_API_CALL_RETURN_VOID(env, napi_delete_reference(env, *ref));
+free(ref);
+}
+
+staticvoidCreateObjectWrap(napi_envenv) {
+napi_valuejs_obj;
+napi_ref*ref=malloc(sizeof(*ref));
+NODE_API_CALL_RETURN_VOID(env, napi_create_object(env, &js_obj));
+NODE_API_CALL_RETURN_VOID(
+env, napi_wrap(env, js_obj, ref, ObjectFinalizer, NULL, ref));
+// create a strong reference so that the finalizer is called at shutdown.
+NODE_API_CALL_RETURN_VOID(env, napi_reference_ref(env, *ref, NULL));
+}
+
 staticnapi_valueInit(napi_envenv, napi_valueexports) {
+// Reinitialize the static variable to be compatible with musl libc.
+cleanup_hook_count=0;
+// Create object wrap before cleanup hooks.
+CreateObjectWrap(env);
+
  {
 structAsyncData*data=CreateAsyncData();
 data->env=env;
@@ -64,6 +92,9 @@ static napi_value Init(napi_env env, napi_value exports) {
 napi_remove_async_cleanup_hook(must_not_call_handle);
  }
 
+// Create object wrap after cleanup hooks.
+CreateObjectWrap(env);
+
 returnNULL;
 }
 

test/node-api/test_cleanup_hook/binding.c

@@ -1,19 +1,48 @@
+#include<assert.h>
+#include<stdlib.h>
+#include"../../js-native-api/common.h"
 #include"node_api.h"
 #include"uv.h"
-#include"../../js-native-api/common.h"
 
+staticintcleanup_hook_count=0;
 staticvoidcleanup(void*arg) {
+cleanup_hook_count++;
 printf("cleanup(%d)\n", *(int*)(arg));
 }
 
 staticintsecret=42;
 staticintwrong_secret=17;
 
+staticvoidObjectFinalizer(napi_envenv, void*data, void*hint) {
+// cleanup is called once.
+assert(cleanup_hook_count==1);
+
+napi_ref*ref=data;
+NODE_API_CALL_RETURN_VOID(env, napi_delete_reference(env, *ref));
+free(ref);
+}
+
+staticvoidCreateObjectWrap(napi_envenv) {
+napi_valuejs_obj;
+napi_ref*ref=malloc(sizeof(*ref));
+NODE_API_CALL_RETURN_VOID(env, napi_create_object(env, &js_obj));
+NODE_API_CALL_RETURN_VOID(
+env, napi_wrap(env, js_obj, ref, ObjectFinalizer, NULL, ref));
+// create a strong reference so that the finalizer is called at shutdown.
+NODE_API_CALL_RETURN_VOID(env, napi_reference_ref(env, *ref, NULL));
+}
+
 staticnapi_valueInit(napi_envenv, napi_valueexports) {
+// Create object wrap before cleanup hooks.
+CreateObjectWrap(env);
+
 napi_add_env_cleanup_hook(env, cleanup, &wrong_secret);
 napi_add_env_cleanup_hook(env, cleanup, &secret);
 napi_remove_env_cleanup_hook(env, cleanup, &wrong_secret);
 
+// Create object wrap after cleanup hooks.
+CreateObjectWrap(env);
+
 returnNULL;
 }
 

test/node-api/test_cleanup_hook/test.js

@@ -6,7 +6,8 @@ const child_process = require('child_process');
 if(process.argv[2]==='child'){
 require(`./build/${common.buildType}/binding`);
 }else{
-const{ stdout }=
+const{ stdout, status, signal}=
 child_process.spawnSync(process.execPath,[__filename,'child']);
+assert.strictEqual(status,0,`process exited with status(${status}) and signal(${signal})`);
 assert.strictEqual(stdout.toString().trim(),'cleanup(42)');
 }