xref: /third_party/node/test/node-api/test_async_context/test-gcable-callback.js

'use strict';
// Flags: --gc-interval=100 --gc-global

const common = require('../../common');
const assert = require('assert');
const async_hooks = require('async_hooks');
const {
  createAsyncResource,
  destroyAsyncResource,
  makeCallback,
} = require(`./build/${common.buildType}/binding`);

// Test for https://github.com/nodejs/node/issues/27218:
// napi_async_destroy() can be called during a regular garbage collection run.

const hook_result = {
  id: null,
  init_called: false,
  destroy_called: false,
};

const test_hook = async_hooks.createHook({
  init: (id, type) => {
    if (type === 'test_async') {
      hook_result.id = id;
      hook_result.init_called = true;
    }
  },
  destroy: (id) => {
    if (id === hook_result.id) hook_result.destroy_called = true;
  },
});

test_hook.enable();
const asyncResource = createAsyncResource(
  { foo: 'bar' },
  /* destroy_on_finalizer */false,
);

// Trigger GC. This does *not* use global.gc(), because what we want to verify
// is that `napi_async_destroy()` can be called when there is no JS context
// on the stack at the time of GC.
// Currently, using --gc-interval=100 + 1M elements seems to work fine for this.
const arr = new Array(1024 * 1024);
for (let i = 0; i < arr.length; i++)
  arr[i] = {};

assert.strictEqual(hook_result.destroy_called, false);
setImmediate(() => {
  assert.strictEqual(hook_result.destroy_called, false);
  makeCallback(asyncResource, process, () => {
    const executionAsyncResource = async_hooks.executionAsyncResource();
    // Assuming the executionAsyncResource was created for the absence of the
    // initial `{ foo: 'bar' }`.
    // This is the worst path of `napi_async_context` related API of
    // recovering from the condition and not break the executionAsyncResource
    // shape, although the executionAsyncResource might not be correct.
    assert.strictEqual(typeof executionAsyncResource, 'object');
    assert.strictEqual(executionAsyncResource.foo, undefined);
    destroyAsyncResource(asyncResource);
    setImmediate(() => {
      assert.strictEqual(hook_result.destroy_called, true);
    });
  });
});