FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

node-api: handle no support for external buffers · nodejs/node@aaca54c · GitHub

/ node Public

Commit aaca54c

Browse files
mhdawson
authored and
RafaelGSS
committed
node-api: handle no support for external buffers
Refs: electron/electron#35801 Refs: nodejs/abi-stable-node#441 Electron recently dropped support for external buffers. Provide a way for addon authors to: - hide the methods to create external buffers so they can avoid using them if they want the broadest compatibility. - call the methods that create external buffers at runtime to check if external buffers are supported and either use them or not based on the return code. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #45181 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
1 parent 9aa305f commit aaca54c

8 files changed

Lines changed: 49 additions & 2 deletions

File tree

‎doc/api/n-api.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,7 @@ typedef enum {
579579
napi_arraybuffer_expected,
580580
napi_detachable_arraybuffer_expected,
581581
napi_would_deadlock, /* unused */
582+
napi_no_external_buffers_allowed
582583
} napi_status;
583584
```
584585

@@ -2403,6 +2404,19 @@ napi_create_external_arraybuffer(napi_env env,
24032404

24042405
Returns `napi_ok` if the API succeeded.
24052406

2407+
**Some runtimes other than Node.js have dropped support for external buffers**.
2408+
On runtimes other than Node.js this method may return
2409+
`napi_no_external_buffers_allowed` to indicate that external
2410+
buffers are not supported. One such runtime is Electron as
2411+
described in this issue
2412+
[electron/issues/35801](https://github.com/electron/electron/issues/35801).
2413+
2414+
In order to maintain broadest compatibility with all runtimes
2415+
you may define `NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED` in your addon before
2416+
includes for the node-api headers. Doing so will hide the 2 functions
2417+
that create external buffers. This will ensure a compilation error
2418+
occurs if you accidentally use one of these methods.
2419+
24062420
This API returns a Node-API value corresponding to a JavaScript `ArrayBuffer`.
24072421
The underlying byte buffer of the `ArrayBuffer` is externally allocated and
24082422
managed. The caller must ensure that the byte buffer remains valid until the
@@ -2447,6 +2461,19 @@ napi_status napi_create_external_buffer(napi_env env,
24472461

24482462
Returns `napi_ok` if the API succeeded.
24492463

2464+
**Some runtimes other than Node.js have dropped support for external buffers**.
2465+
On runtimes other than Node.js this method may return
2466+
`napi_no_external_buffers_allowed` to indicate that external
2467+
buffers are not supported. One such runtime is Electron as
2468+
described in this issue
2469+
[electron/issues/35801](https://github.com/electron/electron/issues/35801).
2470+
2471+
In order to maintain broadest compatibility with all runtimes
2472+
you may define `NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED` in your addon before
2473+
includes for the node-api headers. Doing so will hide the 2 functions
2474+
that create external buffers. This will ensure a compilation error
2475+
occurs if you accidentally use one of these methods.
2476+
24502477
This API allocates a `node::Buffer` object and initializes it with data
24512478
backed by the passed in buffer. While this is still a fully-supported data
24522479
structure, in most cases using a `TypedArray` will suffice.

‎src/js_native_api.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,13 +401,15 @@ NAPI_EXTERN napi_status NAPI_CDECL napi_create_arraybuffer(napi_env env,
401401
size_t byte_length,
402402
void** data,
403403
napi_value* result);
404+
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
404405
NAPI_EXTERN napi_status NAPI_CDECL
405406
napi_create_external_arraybuffer(napi_env env,
406407
void* external_data,
407408
size_t byte_length,
408409
napi_finalize finalize_cb,
409410
void* finalize_hint,
410411
napi_value* result);
412+
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
411413
NAPI_EXTERN napi_status NAPI_CDECL napi_get_arraybuffer_info(
412414
napi_env env, napi_value arraybuffer, void** data, size_t* byte_length);
413415
NAPI_EXTERN napi_status NAPI_CDECL napi_is_typedarray(napi_env env,

‎src/js_native_api_types.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ typedef enum {
9898
napi_date_expected,
9999
napi_arraybuffer_expected,
100100
napi_detachable_arraybuffer_expected,
101-
napi_would_deadlock // unused
101+
napi_would_deadlock, // unused
102+
napi_no_external_buffers_allowed
102103
} napi_status;
103104
// Note: when adding a new enum value to `napi_status`, please also update
104105
// * `const int last_status` in the definition of `napi_get_last_error_info()'

‎src/js_native_api_v8.cc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -746,6 +746,7 @@ static const char* error_messages[] = {
746746
"An arraybuffer was expected",
747747
"A detachable arraybuffer was expected",
748748
"Main thread would deadlock",
749+
"External buffers are not allowed",
749750
};
750751

751752
napi_status NAPI_CDECL napi_get_last_error_info(
@@ -757,7 +758,7 @@ napi_status NAPI_CDECL napi_get_last_error_info(
757758
// message in the `napi_status` enum each time a new error message is added.
758759
// We don't have a napi_status_last as this would result in an ABI
759760
// change each time a message was added.
760-
const int last_status = napi_would_deadlock;
761+
const int last_status = napi_no_external_buffers_allowed;
761762

762763
static_assert(NAPI_ARRAYSIZE(error_messages) == last_status + 1,
763764
"Count of error messages must match count of error values");

‎src/node_api.cc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -950,6 +950,10 @@ napi_status NAPI_CDECL napi_create_external_buffer(napi_env env,
950950
NAPI_PREAMBLE(env);
951951
CHECK_ARG(env, result);
952952

953+
#if defined(V8_ENABLE_SANDBOX)
954+
return napi_set_last_error(env, napi_no_external_buffers_allowed);
955+
#endif
956+
953957
v8::Isolate* isolate = env->isolate;
954958

955959
// The finalizer object will delete itself after invoking the callback.

‎src/node_api.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,15 @@ NAPI_EXTERN napi_status NAPI_CDECL napi_create_buffer(napi_env env,
153153
size_t length,
154154
void** data,
155155
napi_value* result);
156+
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
156157
NAPI_EXTERN napi_status NAPI_CDECL
157158
napi_create_external_buffer(napi_env env,
158159
size_t length,
159160
void* data,
160161
napi_finalize finalize_cb,
161162
void* finalize_hint,
162163
napi_value* result);
164+
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
163165
NAPI_EXTERN napi_status NAPI_CDECL napi_create_buffer_copy(napi_env env,
164166
size_t length,
165167
const void* data,

‎test/js-native-api/test_general/test_general.c‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
// we define NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED here to
2+
// validate that it can be used as a form of test itself. It is
3+
// not related to any of the other tests
4+
// defined in the file
5+
#define NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
16
#include <stdio.h>
27
#include <stdlib.h>
38
#include <stdint.h>

‎test/node-api/test_general/test_general.c‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
#define NAPI_EXPERIMENTAL
2+
// we define NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED here to validate that it can
3+
// be used as a form of test itself. It is
4+
// not related to any of the other tests
5+
// defined in the file
6+
#define NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
27
#include <node_api.h>
38
#include <stdlib.h>
49
#include "../../js-native-api/common.h"

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL