delta/node-new.git/src/node_api.cc, branch docs-fix

n-api: re-implement async env cleanup hooks

2020-08-27T15:18:37+00:00

* Avoid passing core `void*` and function pointers into add-on.
* Document `napi_async_cleanup_hook_handle` type.
* Render receipt of the handle mandatory from the point where the
  hook gets called. Removal of the handle remains mandatory.

Fixes: https://github.com/nodejs/node/issues/34715
Signed-off-by: Gabriel Schulhof 
Co-authored-by: Anna Henningsen 
PR-URL: https://github.com/nodejs/node/pull/34819
Reviewed-By: Michael Dawson 
Reviewed-By: Zeyu Yang

n-api: fix use-after-free with napi_remove_async_cleanup_hook

2020-08-07T18:25:42+00:00

Fixes: https://github.com/nodejs/node/issues/34657
Refs: https://github.com/nodejs/node/pull/34572

PR-URL: https://github.com/nodejs/node/pull/34662
Reviewed-By: Gabriel Schulhof 
Reviewed-By: James M Snell

n-api,src: provide asynchronous cleanup hooks

2020-08-06T22:02:02+00:00

Sometimes addons need to perform cleanup actions, for example
closing libuv handles or waiting for requests to finish, that
cannot be performed synchronously.

Add C++ API and N-API functions that allow providing such
asynchronous cleanup hooks.

Fixes: https://github.com/nodejs/node/issues/34567

PR-URL: https://github.com/nodejs/node/pull/34572
Reviewed-By: James M Snell 
Reviewed-By: Gabriel Schulhof

n-api: run all finalizers via SetImmediate()

2020-07-24T06:28:09+00:00

Throwing an exception from a finalizer can cause the following fatal
error:

Error: async hook stack has become corrupted (actual: 2, expected: 0)
 1: 0x970b5a node::InternalCallbackScope::~InternalCallbackScope()
    [./node]
 2: 0x99dda0 node::Environment::RunTimers(uv_timer_s*) [./node]
 3: 0x13d8b22  [./node]
 4: 0x13dbe42 uv_run [./node]
 5: 0xa57974 node::NodeMainInstance::Run() [./node]
 6: 0x9dbc17 node::Start(int, char**) [./node]
 7: 0x7f4965417f43 __libc_start_main [/lib64/libc.so.6]
 8: 0x96f4ae _start [./node]

By https://github.com/nodejs/node/issues/34341#issuecomment-658426281,
calling into JS from a finalizer and/or throwing exceptions from there
is not advised, because the stack may or may not be set up for JS
execution. The best solution is to run the user's finalizer from a
`SetImmediate()` callback.

Signed-off-by: Gabriel Schulhof 
Fixes: https://github.com/nodejs/node/issues/34341
PR-URL: https://github.com/nodejs/node/pull/34386
Reviewed-By: James M Snell 
Reviewed-By: Anna Henningsen 
Reviewed-By: Michael Dawson 
Reviewed-By: Juan José Arboleda

worker: add public method for marking objects as untransferable

2020-06-25T15:33:29+00:00

We currently mark a number of `ArrayBuffer`s as not transferable,
including the `Buffer` pool and ones with finalizers provided
by C++ addons.

There is no good reason to assume that userland code might not
encounter similar problems, for example when doing `ArrayBuffer`
pooling similar to ours. Therefore, provide an API that lets
userland code also mark objects as not transferable.

PR-URL: https://github.com/nodejs/node/pull/33979
Reviewed-By: James M Snell 
Reviewed-By: Gus Caplan

n-api: remove `napi_env::CallIntoModuleThrow`

2020-05-28T20:28:56+00:00

Give `napi_env::CallIntoModule` the thrower used by
`CallIntoModuleThrow` as its default second argument. That way we do
not need two different methods on `napi_env` for calling into the
addon.

PR-URL: https://github.com/nodejs/node/pull/33570
Signed-off-by: Gabriel Schulhof 
Reviewed-By: James M Snell 
Reviewed-By: Anna Henningsen 
Reviewed-By: Chengzhong Wu 
Reviewed-By: Michael Dawson

Revert "n-api: detect deadlocks in thread-safe function"

2020-05-23T15:45:42+00:00

This reverts commit d26ca06c16f497ffa5ac4845a27922d5058a9318 because
it breaks running the tests in debug mode, as
`v8::Isolate::GetCurrent()` is not allowed if no `Isolate` is active
on the current thread.

Refs: https://github.com/nodejs/node/pull/33276
Refs: https://github.com/nodejs/node/pull/32860

PR-URL: https://github.com/nodejs/node/pull/33453
Reviewed-By: Daniel Bevenius 
Reviewed-By: Colin Ihrig 
Reviewed-By: James M Snell 
Reviewed-By: David Carlier 
Reviewed-By: Gireesh Punathil 
Reviewed-By: Gabriel Schulhof

n-api: simplify uv_idle wrangling

2020-04-29T01:53:59+00:00

uv_idle_init(), uv_idle_start() and uv_idle_stop() always succeed.
Remove the superfluous error handling.

Refs: https://github.com/libuv/libuv/pull/2803

PR-URL: https://github.com/nodejs/node/pull/32997
Reviewed-By: Colin Ihrig 
Reviewed-By: David Carlier 
Reviewed-By: Gus Caplan 
Reviewed-By: Juan José Arboleda 
Reviewed-By: James M Snell

n-api: detect deadlocks in thread-safe function

2020-04-19T17:07:00+00:00

We introduce status `napi_would_deadlock` to be used as a return status
by `napi_call_threadsafe_function` if the call is made with
`napi_tsfn_blocking` on the main thread and the queue is full.

Fixes: https://github.com/nodejs/node/issues/32615
Signed-off-by: Gabriel Schulhof 
PR-URL: https://github.com/nodejs/node/pull/32860
Reviewed-By: Ben Noordhuis 
Reviewed-By: Michael Dawson 
Reviewed-By: Zeyu Yang

Revert "n-api: detect deadlocks in thread-safe function"

2020-04-16T19:52:12+00:00

This reverts commit aeb7084fe6446350ec032e9819746126811bf44f.

The solution creates incorrect behaviour on Windows.

Re: https://github.com/nodejs/node-addon-api/pull/697#issuecomment-612993476
Signed-off-by: Gabriel Schulhof 
PR-URL: https://github.com/nodejs/node/pull/32880
Reviewed-By: Ben Noordhuis 
Reviewed-By: Anna Henningsen 
Reviewed-By: Colin Ihrig 
Reviewed-By: Gireesh Punathil 
Reviewed-By: Chengzhong Wu 
Reviewed-By: Gerhard Stöbich