Merge N-API JSRT implementation from abi-stable-node #238

jasongin · 2017-05-08T19:42:36Z

When Node-ChakraCore merged the latest changes from upstream node last week, it got the V8 N-API implementation. This change replaces that with a JSRT implementation, so that N-API calls do not go through the shim. The public API surface in node_api.h is unchanged.

This code is a result of a collaborative effort from the N-API working group in the api-prototype-chakracore-8.x branch of the abi-stable-node fork. It includes contributions from the following people in alphabetical order:

Arunesh Chandra (@aruneshchandra)
Gabriel Schulhof (@gabrielschulhof)
Hitesh Kanwathirtha (@digitalinfinity)
Ian Halliday (@ianwjhalliday)
Jason Ginchereau (@jasongin)
Michael Dawson (@mhdawson)
Sampson Gao (@sampsongao)
Taylor Woll (@boingoing)

In addition to all the work done in the abi-stable-node fork, the following changes were done for this PR:

Copy node_api_jsrt.cc from abi-stable-node fork
Update node_api_jsrt.cc for renamed JSRT string APIs: JsCopyStringUtf8 -> JsCopyString, etc
Update node.gyp to build node_api_jsrt.cc instead of node_api.cc
Copy JSRT weak-reference APIs from abi-stable-node fork
Temporarily disable 2 N-API test cases with known failures (Latin1 encoding for JSRT N-API abi-stable-node#235, Symbol.hasInstance support in JSRT abi-stable-node#236)
Fix lint errors in node_api_jsrt.cc (in the second commit)

The N-API V8 implementation (node_api.cc) is not deleted here, but merely excluded from the build, so that there are no conflicts in future merges from upstream node.

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

boingoing · 2017-05-08T20:19:50Z

LGTM 👍

kunalspathak · 2017-05-08T20:37:04Z

Copy JSRT weak-reference APIs from abi-stable-node fork

Are these changes in Microsoft/chakracore's 2.0 branch? If yes, can you just sync Microsoft/Chakracore branch 2.0 instead?

kunalspathak · 2017-05-08T20:37:51Z

test/addons-napi/test_instanceof/test.js

@@ -74,7 +74,8 @@ if (typeof Symbol !== 'undefined' && 'hasInstance' in Symbol &&
  compareToNative(x, MySubClass);
  compareToNative(y, MySubClass);
  compareToNative(x, MyClass);
-  compareToNative(y, MyClass);
+  // TODO: https://github.com/nodejs/abi-stable-node/issues/236


TODO [](start = 5, length = 4)

nit: Should we open/port these issues to nodejs/node?

Probably not, because these issues are specific to N-API on Node-ChakraCore. The tests pass with N-API on Node-V8.

Maybe they could be moved to nodejs/node-chakracore/issues. I think sometime soon we will stop using the abi-stable-node fork, now that all the code has been merged from it. But then we'll review all the remaining open issues there.

Does it make sense to add the ChakraCore check rather than commenting these out?

@kfarnung I'm not sure about that. These are issues that we want to fix in Node-ChakraCore, not engine-specific behavior that we want to allow indefinitely.

jasongin · 2017-05-08T21:23:20Z

Copy JSRT weak-reference APIs from abi-stable-node fork

Are these changes in Microsoft/chakracore's 2.0 branch?

These JSRT APIs were added specifically to support N-API. Would it be better to add them to ChakraCore first, or do changes sometimes flow back from Node-ChakraCore?

kfarnung · 2017-05-08T21:39:08Z

@jasongin I've been making my ChakraCore changes in release/2.0 and then flowing them into node-chakracore. I don't believe we have a two-way sync, we just clone ChakraCore into node-chakracore.

jasongin · 2017-05-09T19:39:35Z

I created a PR for the weak-reference APIs at chakra-core/ChakraCore#2948

I guess this PR should wait for that change to merge into ChakraCore and Node-ChakraCore.

kunalspathak · 2017-05-09T19:40:48Z

I guess this PR should wait for that change to merge into ChakraCore and Node-ChakraCore.

That's correct.

kfarnung · 2017-05-09T20:49:45Z

node.gyp

-        'src/node_api.h',
-        'src/node_api_types.h',
+#        'src/node_api.cc',
+        'src/node_api_jsrt.cc',


Can we just add a "conditions" block which checked the engine type and then removes node_api.cc and adds in node_api_jsrt.cc?

OK, I'll do that.

kfarnung · 2017-05-09T20:51:29Z

src/node_api_jsrt.cc

+  JsValueRef target;
+  CHECK_JSRT(JsGetWeakReferenceValue(weakRef, &target));
+
+  if (target == nullptr) {


Should we be comparing against JS_INVALID_REFERENCE?

Yes. (Though actually they are the same thing.)

Merge pull request #2948 from jasongin:weakref - Add a new typedef: `JsWeakRef` - Add two new APIs: `JsCreateWeakReference()`, `JsGetWeakReferenceValue()` - Add a native test for the new APIs The weak reference APIs are required for N-API in Node-ChakraCore. See nodejs/node-chakracore#238

kfarnung · 2017-05-13T06:41:42Z

test/addons-napi/test_string/test.js

@@ -46,7 +46,8 @@ const str4 = '¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿';
 assert.strictEqual(test_string.TestLatin1(str4), str4);
 assert.strictEqual(test_string.TestUtf8(str4), str4);
 assert.strictEqual(test_string.TestUtf16(str4), str4);
-assert.strictEqual(test_string.TestLatin1Insufficient(str4), str4.slice(0, 3));
+// TODO: https://github.com/nodejs/abi-stable-node/issues/235
+// assert.strictEqual(test_string.TestLatin1Insufficient(str4), str4.slice(0, 3));


/home/kfarnung/GitHub/node-chakracore/test/addons-napi/test_string/test.js
50:1 error Line 50 exceeds the maximum line length of 80 max-len
61:1 error Line 61 exceeds the maximum line length of 80 max-len

kfarnung · 2017-05-13T06:44:39Z

Made some modifications to your original review and pushed to my fork:

https://github.com/kfarnung/node-chakracore/tree/napi

Enabled conditional sources for V8 and ChakraCore
Removed conflicting ChakraCore changes

jasongin · 2017-05-15T17:25:28Z

Thanks @kfarnung! I rebased on top of the latest xplat (which now includes the JSRT weak-reference APIs), incorporated your changes in node.gyp, and addressed other review feedback above.

kfarnung · 2017-05-15T17:32:41Z

CI: https://ci.nodejs.org/job/chakracore-test-pull-request/31/ - One failure
Rerun: https://ci.nodejs.org/job/chakracore-test-pull-request/32/ - PASSED

kfarnung

LGTM

- Copy `node_api_jsrt.cc` from abi-stable-node fork - Update `node_api_jsrt.cc` for renamed JSRT string APIs: `JsCopyStringUtf8` -> `JsCopyString`, etc - Update `node.gyp` to build `node_api_jsrt.cc` instead of `node_api.cc` - Temporarily disable 2 N-API test cases with known failures PR-URL: nodejs#238 Reviewed-By: Taylor Woll <taylor.woll@microsoft.com> Reviewed-By: Kyle Farnung <kfarnung@microsoft.com>

PR-URL: nodejs#238 Reviewed-By: Taylor Woll <taylor.woll@microsoft.com> Reviewed-By: Kyle Farnung <kfarnung@microsoft.com>

jasongin requested a review from kunalspathak May 8, 2017 19:42

kunalspathak reviewed May 8, 2017

View reviewed changes

jasongin mentioned this pull request May 9, 2017

Add JSRT weak reference APIs chakra-core/ChakraCore#2948

Merged

kfarnung reviewed May 9, 2017

View reviewed changes

kfarnung reviewed May 13, 2017

View reviewed changes

jasongin force-pushed the napi branch from 917cc80 to 4835661 Compare May 15, 2017 17:24

kfarnung approved these changes May 15, 2017

View reviewed changes

jasongin and others added 4 commits May 15, 2017 11:26

n-api: Fix cc lint errors in node_api_jsrt.cc

f8cbdde

PR-URL: nodejs#238 Reviewed-By: Taylor Woll <taylor.woll@microsoft.com> Reviewed-By: Kyle Farnung <kfarnung@microsoft.com>

n-api: Make sources conditional on V8 / ChakraCore

cc20967

PR-URL: nodejs#238 Reviewed-By: Taylor Woll <taylor.woll@microsoft.com> Reviewed-By: Kyle Farnung <kfarnung@microsoft.com>

n-api: Minor updates for review feedback

28cdc33

PR-URL: nodejs#238 Reviewed-By: Taylor Woll <taylor.woll@microsoft.com> Reviewed-By: Kyle Farnung <kfarnung@microsoft.com>

kfarnung force-pushed the napi branch from 4835661 to 28cdc33 Compare May 15, 2017 20:30

kfarnung merged commit 28cdc33 into nodejs:xplat May 15, 2017

jasongin deleted the napi branch May 16, 2017 00:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge N-API JSRT implementation from abi-stable-node #238

Merge N-API JSRT implementation from abi-stable-node #238

jasongin commented May 8, 2017

boingoing commented May 8, 2017

kunalspathak commented May 8, 2017

kunalspathak May 8, 2017

jasongin May 8, 2017

jasongin May 8, 2017

kfarnung May 9, 2017

jasongin May 15, 2017

jasongin commented May 8, 2017

kfarnung commented May 8, 2017

jasongin commented May 9, 2017

kunalspathak commented May 9, 2017

kfarnung May 9, 2017

jasongin May 9, 2017

kfarnung May 9, 2017

jasongin May 9, 2017

jasongin May 15, 2017

kfarnung May 13, 2017

jasongin May 15, 2017

kfarnung commented May 13, 2017

jasongin commented May 15, 2017 •

edited

Loading

kfarnung commented May 15, 2017 •

edited

Loading

kfarnung left a comment

Merge N-API JSRT implementation from abi-stable-node #238

Merge N-API JSRT implementation from abi-stable-node #238

Conversation

jasongin commented May 8, 2017

Checklist

Affected core subsystem(s)

boingoing commented May 8, 2017

kunalspathak commented May 8, 2017

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 May 8, 2017

kfarnung commented May 8, 2017

jasongin commented May 9, 2017

kunalspathak commented May 9, 2017

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

kfarnung commented May 13, 2017

jasongin commented May 15, 2017 • edited Loading

kfarnung commented May 15, 2017 • edited Loading

kfarnung left a comment

Choose a reason for hiding this comment

jasongin commented May 15, 2017 •

edited

Loading

kfarnung commented May 15, 2017 •

edited

Loading