n-api: implement wrapping using private properties #18311

gabrielschulhof · 2018-01-23T04:27:40Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

n-api

addaleax · 2018-01-28T00:52:15Z

src/node_api.cc

+      v8::String::NewFromOneByte(isolate,
+          reinterpret_cast<const uint8_t*>(key),
+          v8::NewStringType::kInternalized).ToLocalChecked());
+}


env.h has some convenience wrappers for accessing private methods (look for PER_ISOLATE_PRIVATE_SYMBOL_PROPERTIES), can we use those?

addaleax · 2018-01-28T00:53:14Z

src/node_api.cc

@@ -815,24 +791,38 @@ static
 napi_status Unwrap(napi_env env,
                   napi_value js_object,
                   void** result,
-                   v8::Local<v8::Object>* wrapper,
-                   v8::Local<v8::Object>* parent = nullptr) {
+                   bool removeWrap) {


We generally use snake_case for local variables and parameters

gabrielschulhof · 2018-01-30T01:07:48Z

@addaleax I have addressed your review comments.

BridgeAR · 2018-02-01T14:21:05Z

CI https://ci.nodejs.org/job/node-test-pull-request/12887/

mhdawson

LGTM

bnoordhuis · 2018-02-02T16:47:02Z

src/node_api.cc

@@ -46,6 +47,9 @@ struct napi_env__ {
  uv_loop_t* loop = nullptr;
 };

+#define NAPI_PRIVATE_KEY(isolate, prefix) \
+  (node::Environment::GetCurrent((isolate))->napi_ ## prefix())


s/prefix/suffix/?

bnoordhuis · 2018-02-02T16:47:25Z

src/node_api.cc

-          reinterpret_cast<const uint8_t*>("N-API Environment"),
-          v8::NewStringType::kInternalized).ToLocalChecked());
-  auto value = global->GetPrivate(context, key).ToLocalChecked();
+  auto value = global->GetPrivate(context, NAPI_PRIVATE_KEY(isolate, env))


Since you have a reference to the v8::Context, it would be more efficient to call Environment::GetCurrent(context) once and then call env->napi_env() directly.

Applies to a few more spots. I won't point them out individually.

bnoordhuis · 2018-02-02T16:50:34Z

src/node_api.cc

@@ -815,24 +782,37 @@ static
 napi_status Unwrap(napi_env env,
                   napi_value js_object,
                   void** result,
-                   v8::Local<v8::Object>* wrapper,
-                   v8::Local<v8::Object>* parent = nullptr) {
+                   bool remove_wrap) {


Consider using an enum instead of a bool. More self-descriptive at the call site.

bnoordhuis · 2018-02-02T16:51:08Z

src/node_api.cc

+  } else {
+    // Create a self-deleting reference.
+    reference = v8impl::Reference::New(env, obj, 0, true, finalize_cb,
+        native_object, finalize_cb == nullptr ? nullptr: finalize_hint);


Space before :.

bnoordhuis · 2018-02-02T16:51:54Z

src/node_api.cc

-    wrapper->SetInternalField(2, v8::External::New(isolate, reference));
-  }
+  CHECK(obj->SetPrivate(context, NAPI_PRIVATE_KEY(isolate, wrapper),
+      v8::External::New(isolate, reference)).FromJust());


Can you line up the arguments?

Fixes: nodejs#14367

gabrielschulhof · 2018-02-02T22:03:30Z

New CI: https://ci.nodejs.org/job/node-test-pull-request/12914/

gabrielschulhof · 2018-02-03T01:18:20Z

I re-ran the node-test-commit-arm portion, and it passed: https://ci.nodejs.org/job/node-test-commit-arm/13589/

gabrielschulhof · 2018-02-03T01:22:04Z

Landed in 1286923.

PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

MylesBorins · 2018-03-20T16:33:26Z

Should this be backported to v8.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

gabrielschulhof · 2018-03-20T19:46:42Z

@MylesBorins this is part of #19265.

PR-URL: nodejs#18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: nodejs#14367

Backport-PR-URL: #19447 PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

Backport-PR-URL: #19265 PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

PR-URL: nodejs#18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: nodejs#14367

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Jan 23, 2018

gabrielschulhof added the node-api Issues and PRs related to the Node-API. label Jan 23, 2018

gabrielschulhof requested review from bnoordhuis, addaleax and TimothyGu January 24, 2018 16:36

maclover7 force-pushed the master branch from bb5575a to 993b716 Compare January 26, 2018 22:02

cjihrig force-pushed the master branch from 993b716 to 082f952 Compare January 26, 2018 22:36

addaleax approved these changes Jan 28, 2018

View reviewed changes

gabrielschulhof force-pushed the use-private-for-wrap branch 3 times, most recently from 2465f08 to b6d330e Compare January 30, 2018 01:06

mhdawson approved these changes Feb 1, 2018

View reviewed changes

bnoordhuis reviewed Feb 2, 2018

View reviewed changes

n-api: implement wrapping using private properties

92488fe

Fixes: nodejs#14367

gabrielschulhof force-pushed the use-private-for-wrap branch from b6d330e to 92488fe Compare February 2, 2018 21:54

gabrielschulhof closed this Feb 3, 2018

gabrielschulhof pushed a commit that referenced this pull request Feb 3, 2018

n-api: implement wrapping using private properties

1286923

PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

gabrielschulhof deleted the use-private-for-wrap branch February 3, 2018 01:27

MylesBorins pushed a commit that referenced this pull request Feb 20, 2018

n-api: implement wrapping using private properties

1385daf

PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

MylesBorins pushed a commit that referenced this pull request Feb 21, 2018

n-api: implement wrapping using private properties

9466558

PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

MylesBorins pushed a commit that referenced this pull request Feb 21, 2018

n-api: implement wrapping using private properties

ae8f5db

PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

MylesBorins mentioned this pull request Feb 21, 2018

v9.6.0 proposal #18902

Merged

MylesBorins added dont-land-on-v6.x labels Mar 20, 2018

MylesBorins pushed a commit that referenced this pull request Apr 16, 2018

n-api: implement wrapping using private properties

b565ba2

Backport-PR-URL: #19447 PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

MylesBorins mentioned this pull request Apr 16, 2018

v6.14.2 proposal #19996

Merged

MylesBorins pushed a commit that referenced this pull request May 1, 2018

n-api: implement wrapping using private properties

d89f593

Backport-PR-URL: #19265 PR-URL: #18311 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: #14367

MylesBorins mentioned this pull request May 2, 2018

v8.11.2 proposal #20478

Merged

BethGriggs added backported-to-v8.x and removed backport-requested-v8.x labels Jul 10, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

n-api: implement wrapping using private properties #18311

n-api: implement wrapping using private properties #18311

gabrielschulhof commented Jan 23, 2018

addaleax Jan 28, 2018

addaleax Jan 28, 2018

gabrielschulhof commented Jan 30, 2018

BridgeAR commented Feb 1, 2018

mhdawson left a comment

bnoordhuis Feb 2, 2018

bnoordhuis Feb 2, 2018

bnoordhuis Feb 2, 2018

bnoordhuis Feb 2, 2018

bnoordhuis Feb 2, 2018

gabrielschulhof commented Feb 2, 2018

gabrielschulhof commented Feb 3, 2018

gabrielschulhof commented Feb 3, 2018

MylesBorins commented Mar 20, 2018

gabrielschulhof commented Mar 20, 2018

n-api: implement wrapping using private properties #18311

n-api: implement wrapping using private properties #18311

Conversation

gabrielschulhof commented Jan 23, 2018

Checklist

Affected core subsystem(s)

addaleax Jan 28, 2018

Choose a reason for hiding this comment

addaleax Jan 28, 2018

Choose a reason for hiding this comment

gabrielschulhof commented Jan 30, 2018

BridgeAR commented Feb 1, 2018

mhdawson left a comment

Choose a reason for hiding this comment

bnoordhuis Feb 2, 2018

Choose a reason for hiding this comment

bnoordhuis Feb 2, 2018

Choose a reason for hiding this comment

bnoordhuis Feb 2, 2018

Choose a reason for hiding this comment

bnoordhuis Feb 2, 2018

Choose a reason for hiding this comment

bnoordhuis Feb 2, 2018

Choose a reason for hiding this comment

gabrielschulhof commented Feb 2, 2018

gabrielschulhof commented Feb 3, 2018

gabrielschulhof commented Feb 3, 2018

MylesBorins commented Mar 20, 2018

gabrielschulhof commented Mar 20, 2018