n-api: Update property attrs enum to match JS spec #12240

jasongin · 2017-04-05T18:18:42Z

The napi_property_attributes enum used names and values from
v8::PropertyAttribute, but those negative flag names were outdated
along with the default behavior of a property being writable,
enumerable, and configurable unless otherwise specified. To match the
ES5 standard property descriptor those attributes should be positive
flags and should default to false unless otherwise specified.

Fixes: nodejs/abi-stable-node#221

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

N-API

jasongin · 2017-04-05T18:19:19Z

@mhdawson @TimothyGu please review

mhdawson

LGTM

TimothyGu · 2017-04-06T01:04:27Z

test/addons-napi/test_constructor/test_constructor.c

-      { "readonlyValue", 0, 0, 0, number, napi_read_only, 0},
-      { "hiddenValue", 0, 0, 0, number, napi_read_only | napi_dont_enum, 0},
+      { "echo", Echo, 0, 0, 0, napi_enumerable, 0 },
+      { "accessorValue", 0, GetValue, SetValue, 0, napi_enumerable, 0},


The accessorValue is not actually referenced in the JS layer. You should also find a way to make certain the getters/setters are actually called when getting/setting the property.

Also, tests that cover the normalization logic fully should be added.

TimothyGu · 2017-04-06T01:04:30Z

test/addons-napi/test_properties/test_properties.c

-      { "readonlyValue", 0, 0, 0, number, napi_read_only, 0 },
-      { "hiddenValue", 0, 0, 0, number, napi_read_only | napi_dont_enum, 0 },
+      { "echo", Echo, 0, 0, 0, napi_enumerable, 0 },
+      { "accessorValue", 0, GetValue, SetValue, 0, napi_enumerable, 0},


TimothyGu · 2017-04-06T01:06:52Z

src/node_api.cc

+      // but V8 requires the ReadOnly attribute to match existence of a setter.
+      attributes = static_cast<v8::PropertyAttribute>(p->setter != nullptr
+        ? attributes & ~v8::PropertyAttribute::ReadOnly
+        : attributes | v8::PropertyAttribute::ReadOnly);


Your call, but I think it might be better if this is factored out?

Yeah I sort of wanted to do that, but it didn't seem right to put it in v8impl::V8PropertyAttributesFromAttributes() because the logic depends on the kind of property descriptor. I'll consider further what to do with this.

TimothyGu · 2017-04-06T01:09:47Z

src/node_api.cc


-    if (p->method) {
+    if (p->method != nullptr) {


Slightly off-topic and basic, but are the C NULL and the C++ nullptr interoperable?

Slightly off-topic and basic, but are the C NULL and the C++ nullptr interoperable?

Yup. :) The different names are just historical oddities because C++ NULL is not defined the same way as C NULL, so C++11 introduced nullptr as a direct equivalent to C NULL.

The napi_property_attributes enum used names and values from v8::PropertyAttribute, but those negative flag names were outdated along with the default behavior of a property being writable, enumerable, and configurable unless otherwise specified. To match the ES5 standard property descriptor those attributes should be positive flags and should default to false unless otherwise specified. Fixes: nodejs/abi-stable-node#221

jasongin · 2017-04-06T20:06:49Z

@TimothyGu I pushed a commit to address your feedback, and also rebased.

TimothyGu

LGTM except for the nit

TimothyGu · 2017-04-06T21:26:54Z

src/node_api.cc

@@ -1,4 +1,4 @@
-/******************************************************************************
+/******************************************************************************


Do you have an idea what this is?

It's a UTF-8 BOM. VS 2017 likes to insert those for some reason. Fixed.

TimothyGu · 2017-04-06T21:33:39Z

src/node_api.cc

+    attribute_flags |= (descriptor->setter == nullptr ?
+      v8::PropertyAttribute::ReadOnly : v8::PropertyAttribute::None);
+  }
+  else if ((descriptor->attributes & napi_writable) == 0) {


nit: coalesce the right brace with else

TimothyGu · 2017-04-06T22:55:43Z

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

mhdawson · 2017-04-07T13:35:41Z

CI green, landing.

mhdawson · 2017-04-07T13:44:58Z

Landed as 8460284

The napi_property_attributes enum used names and values from v8::PropertyAttribute, but those negative flag names were outdated along with the default behavior of a property being writable, enumerable, and configurable unless otherwise specified. To match the ES5 standard property descriptor those attributes should be positive flags and should default to false unless otherwise specified. PR-URL: #12240 Fixes: nodejs/abi-stable-node#221 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Timothy Gu <[email protected]>

refack · 2017-04-07T23:53:06Z

Guys I suspect you have a failing test on windows
CI: https://ci.nodejs.org/job/node-test-commit/8961/
Lets see.

refack · 2017-04-08T00:01:01Z

this is the diff between the PR and 8460284

test/addons/make-callback-recurse/test.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/addons/make-callback-recurse/test.js b/test/addons/make-callback-recurse/test.js
index 46b1327d7..895769bc3 100644
--- a/test/addons/make-callback-recurse/test.js
+++ b/test/addons/make-callback-recurse/test.js
@@ -15,7 +15,7 @@ assert.throws(function() {
   makeCallback({}, function() {
     throw new Error('hi from domain error');
   });
-});
+}, /^Error: hi from domain error$/);
 
 
 // Check the execution order of the nextTickQueue and MicrotaskQueue in

And it's close to what failed on me on the CI

The napi_property_attributes enum used names and values from v8::PropertyAttribute, but those negative flag names were outdated along with the default behavior of a property being writable, enumerable, and configurable unless otherwise specified. To match the ES5 standard property descriptor those attributes should be positive flags and should default to false unless otherwise specified. PR-URL: nodejs#12240 Fixes: nodejs/abi-stable-node#221 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Timothy Gu <[email protected]>

The napi_property_attributes enum used names and values from v8::PropertyAttribute, but those negative flag names were outdated along with the default behavior of a property being writable, enumerable, and configurable unless otherwise specified. To match the ES5 standard property descriptor those attributes should be positive flags and should default to false unless otherwise specified. Backport-PR-URL: #19447 PR-URL: #12240 Fixes: nodejs/abi-stable-node#221 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Timothy Gu <[email protected]>

nodejs-github-bot added the c++ Issues and PRs that require attention from people who are familiar with C++. label Apr 5, 2017

mhdawson approved these changes Apr 5, 2017

View reviewed changes

mscdex added the node-api Issues and PRs related to the Node-API. label Apr 5, 2017

TimothyGu reviewed Apr 6, 2017

View reviewed changes

jasongin added 2 commits April 6, 2017 12:43

Refactor attribute normalization, add tests

05586f4

jasongin force-pushed the napi_property_attributes branch from d878c51 to 05586f4 Compare April 6, 2017 20:05

jasongin mentioned this pull request Apr 6, 2017

napi: change napi_callback to return napi_value #12248

Closed

3 tasks

TimothyGu approved these changes Apr 6, 2017

View reviewed changes

Small updates for review feedback

d915a24

mhdawson closed this Apr 7, 2017

refack mentioned this pull request Apr 8, 2017

n-api: investigate breakage #12279

Closed

3 tasks

italoacasas added dont-land-on-v4.x labels Apr 10, 2017

addaleax added the dont-land-on-v6.x label Apr 13, 2017

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

MylesBorins mentioned this pull request Apr 16, 2018

v6.14.2 proposal #19996

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

n-api: Update property attrs enum to match JS spec #12240

n-api: Update property attrs enum to match JS spec #12240

jasongin commented Apr 5, 2017

jasongin commented Apr 5, 2017

mhdawson left a comment

TimothyGu Apr 6, 2017

TimothyGu Apr 6, 2017

TimothyGu Apr 6, 2017

jasongin Apr 6, 2017

TimothyGu Apr 6, 2017

addaleax Apr 6, 2017

jasongin commented Apr 6, 2017

TimothyGu left a comment

TimothyGu Apr 6, 2017

jasongin Apr 6, 2017

TimothyGu Apr 6, 2017

jasongin Apr 6, 2017

TimothyGu commented Apr 6, 2017

mhdawson commented Apr 7, 2017

mhdawson commented Apr 7, 2017

refack commented Apr 7, 2017

refack commented Apr 8, 2017

		@@ -1,4 +1,4 @@
		/******************************************************************************
		/******************************************************************************

n-api: Update property attrs enum to match JS spec #12240

n-api: Update property attrs enum to match JS spec #12240

Conversation

jasongin commented Apr 5, 2017

Checklist

Affected core subsystem(s)

jasongin commented Apr 5, 2017

mhdawson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasongin commented Apr 6, 2017

TimothyGu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimothyGu commented Apr 6, 2017

mhdawson commented Apr 7, 2017

mhdawson commented Apr 7, 2017

refack commented Apr 7, 2017

refack commented Apr 8, 2017