n-api: implement napi_run_script #15216

gabrielschulhof · 2017-09-06T10:53:34Z

Checklist

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

Affected core subsystem(s)

n-api

TimothyGu · 2017-09-06T11:21:12Z

doc/api/n-api.md

+```
+
+- `[in] env`: The environment that the API is invoked under.
+- `[in] script`: The string containing the script to execute.


Make it clear that this is in UTF-8? Or just take a string napi_value instead?

Maybe it'd be easier to take a napi_value instead.

addaleax · 2017-09-06T11:17:53Z

doc/api/n-api.md

+```
+
+- `[in] env`: The environment that the API is invoked under.
+- `[in] script`: The string containing the script to execute.


… encoded as UTF-8 and null-terminated?

addaleax · 2017-09-06T11:21:27Z

test/addons-napi/test_general/test_general.c

+  NAPI_CALL(env, napi_get_cb_info(env, info, &argc, &arg, NULL, NULL));
+
+  NAPI_CALL(env, napi_get_value_string_utf8(env, arg, NULL, 0, &string_size));
+  string = (char *)malloc(string_size);


don’t we technically need to free() this?

TimothyGu · 2017-09-06T11:22:43Z

test/addons-napi/test_general/test_general.c

@@ -215,12 +216,35 @@ napi_value testAdjustExternalMemory(napi_env env, napi_callback_info info) {
  return result;
 }

+napi_value testNapiRun(napi_env env, napi_callback_info info) {
+  size_t string_size;
+  char *string;


Pointer star goes with the type.

We’re inconsistent about that in this file, and I think this can pass as “idiomatic for C code”

TimothyGu · 2017-09-06T11:22:48Z

test/addons-napi/test_general/test_general.c

+  NAPI_CALL(env, napi_get_cb_info(env, info, &argc, &arg, NULL, NULL));
+
+  NAPI_CALL(env, napi_get_value_string_utf8(env, arg, NULL, 0, &string_size));
+  string = (char *)malloc(string_size);


TimothyGu · 2017-09-06T11:23:10Z

doc/api/n-api.md

+- `[in] script`: The string containing the script to execute.
+- `[out] result`: The value resulting from having executed the script.
+
+[Script Execution]: #n_api_script_execution


Alphabetical order

gabrielschulhof · 2017-09-06T12:21:43Z

Switched script parameter to napi_value, made sure that the script ->IsString(), and added a test to make sure it throws if it isn't.

TimothyGu

In the future we might want to have an equivalent for V8's Script or UnboundScript, but this LGTM and should suffice for now.

jasnell · 2017-09-06T20:55:03Z

doc/api/n-api.md

@@ -3556,6 +3557,25 @@ NAPI_EXTERN napi_status napi_is_promise(napi_env env,
 - `[out] is_promise`: Flag indicating whether `promise` is a native promise
 object - that is, a promise object created by the underlying engine.

+## Script execution
+
+N-API allows you to execute a string containing JavaScript using the underlying


Please avoid the use of you in the docs.

N-API allows the execution of a JavaScript string using the underlying JavaScript engine.

mhdawson

LGTM once comment from @jasnell is addressed

Fixes: nodejs/abi-stable-node#51 PR-URL: nodejs#15216

gabrielschulhof · 2017-09-06T22:10:04Z

@jasnell I have reworded the sentence.

jasnell

thank you!

BridgeAR · 2017-09-09T19:40:33Z

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

gabrielschulhof · 2017-09-09T22:00:23Z

SmartOS re-run: https://ci.nodejs.org/job/node-test-commit-smartos/11353/

gabrielschulhof · 2017-09-09T23:05:22Z

ARM re-run: https://ci.nodejs.org/job/node-test-commit-arm/11989/

Fixes: nodejs/abi-stable-node#51 PR-URL: nodejs#15216 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com Reviewed-By: James M Snell <jasnell.gmail.com> Reviewed-By: Michael Dawson <mhdawson@ca.ibm.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>

gabrielschulhof · 2017-09-09T23:16:40Z

Landed in 61e9ba1.

Fixes: nodejs/abi-stable-node#51 PR-URL: #15216 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com Reviewed-By: James M Snell <jasnell.gmail.com> Reviewed-By: Michael Dawson <mhdawson@ca.ibm.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>

Fixes: nodejs/abi-stable-node#51 PR-URL: nodejs#15216 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com Reviewed-By: James M Snell <jasnell.gmail.com> Reviewed-By: Michael Dawson <mhdawson@ca.ibm.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>

digitalinfinity · 2017-09-14T23:48:26Z

@gabrielschulhof sorry, missed reviewing this PR. @MSLaguana and I were looking at it for implementation in node-chakracore and we had a question- if someone was debugging their script and a script executed from this API was on the stack- what is the "filename" they expect to see? Dynamic code or something equivalent? Should there be a way of modules identifying themselves to the debugger? Or should these frames be considered "library code" and hidden from the debugger?

gabrielschulhof · 2017-09-15T09:53:46Z

@digitalinfinity maybe we should treat it like an eval. Chrome developer tools opens a new tab and calls it "VM<number>" where number is probably some internal counter or something like that. It paints the tab a different colour. In fact, I ran `node --inspect-brk test/addons-napi/test_general/testNapiRun.js` and when I stepped into `addon.testNapiRun()` it behaved exactly like `eval()`.

…

On Fri, Sep 15, 2017 at 2:49 AM, Hitesh Kanwathirtha < ***@***.***> wrote: @gabrielschulhof <https://github.com/gabrielschulhof> sorry, missed reviewing this PR. @MSLaguana <https://github.com/mslaguana> and I were looking at it for implementation in node-chakracore and we had a question- if someone was debugging their script and a script executed from this API was on the stack- what is the "filename" they expect to see? Dynamic code or something equivalent? Should there be a way of modules identifying themselves to the debugger? Or should these frames be considered "library code" and hidden from the debugger? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#15216 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA7k0etVgsKC-XXzJmDMQLQoyJOln7O1ks5sibt6gaJpZM4POMQh> .

Fixes: nodejs/abi-stable-node#51 PR-URL: nodejs#15216 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com Reviewed-By: James M Snell <jasnell.gmail.com> Reviewed-By: Michael Dawson <mhdawson@ca.ibm.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>

Fixes: nodejs/abi-stable-node#51 Backport-PR-URL: #19447 PR-URL: #15216 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com Reviewed-By: James M Snell <jasnell.gmail.com> Reviewed-By: Michael Dawson <mhdawson@ca.ibm.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com>

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216 PR-URL: #616 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Kevin Eady <kevin.c.eady@gmail.com> Reviewed-By: Kevin Eady <kevin.c.eady@gmail.com>

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216 PR-URL: #616 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Kevin Eady <kevin.c.eady@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216 PR-URL: nodejs/node-addon-api#616 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Kevin Eady <kevin.c.eady@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

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 Sep 6, 2017

gabrielschulhof added the node-api Issues and PRs related to the Node-API. label Sep 6, 2017

TimothyGu reviewed Sep 6, 2017

View reviewed changes

addaleax approved these changes Sep 6, 2017

View reviewed changes

TimothyGu reviewed Sep 6, 2017

View reviewed changes

gabrielschulhof force-pushed the napi-run-script branch from 679ade8 to 402d5be Compare September 6, 2017 12:20

gabrielschulhof force-pushed the napi-run-script branch 2 times, most recently from 07920bb to c7d03d4 Compare September 6, 2017 12:27

cjihrig approved these changes Sep 6, 2017

View reviewed changes

benjamingr approved these changes Sep 6, 2017

View reviewed changes

TimothyGu approved these changes Sep 6, 2017

View reviewed changes

jasnell requested changes Sep 6, 2017

View reviewed changes

mhdawson approved these changes Sep 6, 2017

View reviewed changes

n-api: implement napi_run_script

ca0d064

Fixes: nodejs/abi-stable-node#51 PR-URL: nodejs#15216

gabrielschulhof force-pushed the napi-run-script branch from c7d03d4 to ca0d064 Compare September 6, 2017 22:09

jasnell approved these changes Sep 6, 2017

View reviewed changes

gabrielschulhof closed this Sep 9, 2017

gabrielschulhof deleted the napi-run-script branch September 9, 2017 23:16

MylesBorins mentioned this pull request Sep 10, 2017

v8.5.0 proposal #15308

Merged

MylesBorins added the dont-land-on-v6.x label Sep 20, 2017

MylesBorins mentioned this pull request Apr 16, 2018

v6.14.2 proposal #19996

Merged

tniessen added a commit to tniessen/node-addon-api that referenced this pull request Dec 1, 2019

Add Env::RunScript

2a5cc1c

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216

tniessen added a commit to tniessen/node-addon-api that referenced this pull request Dec 1, 2019

Add Env::RunScript

f196271

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216

tniessen mentioned this pull request Dec 1, 2019

Add Env::RunScript nodejs/node-addon-api#616

Closed

tniessen added a commit to tniessen/node-addon-api that referenced this pull request Dec 1, 2019

Add Env::RunScript

92dc802

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216

tniessen added a commit to tniessen/node-addon-api that referenced this pull request Dec 2, 2019

Add Env::RunScript

25740d1

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216

tniessen added a commit to tniessen/node-addon-api that referenced this pull request Dec 2, 2019

Add Env::RunScript

c0b2070

This is a thin wrapper around napi_run_script. Refs: nodejs/node#15216

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

n-api: implement napi_run_script #15216

n-api: implement napi_run_script #15216

gabrielschulhof commented Sep 6, 2017

TimothyGu Sep 6, 2017

gabrielschulhof Sep 6, 2017

addaleax Sep 6, 2017

addaleax Sep 6, 2017

TimothyGu Sep 6, 2017

addaleax Sep 6, 2017

TimothyGu Sep 6, 2017

TimothyGu Sep 6, 2017

gabrielschulhof commented Sep 6, 2017 •

edited

TimothyGu left a comment

jasnell Sep 6, 2017

mhdawson left a comment

gabrielschulhof commented Sep 6, 2017

jasnell left a comment

BridgeAR commented Sep 9, 2017

gabrielschulhof commented Sep 9, 2017

gabrielschulhof commented Sep 9, 2017

gabrielschulhof commented Sep 9, 2017

digitalinfinity commented Sep 14, 2017

gabrielschulhof commented Sep 15, 2017 via email

n-api: implement napi_run_script #15216

n-api: implement napi_run_script #15216

Conversation

gabrielschulhof commented Sep 6, 2017

Checklist

Affected core subsystem(s)

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

Choose a reason for hiding this comment

gabrielschulhof commented Sep 6, 2017 • edited

TimothyGu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhdawson left a comment

Choose a reason for hiding this comment

gabrielschulhof commented Sep 6, 2017

jasnell left a comment

Choose a reason for hiding this comment

BridgeAR commented Sep 9, 2017

gabrielschulhof commented Sep 9, 2017

gabrielschulhof commented Sep 9, 2017

gabrielschulhof commented Sep 9, 2017

digitalinfinity commented Sep 14, 2017

gabrielschulhof commented Sep 15, 2017 via email

gabrielschulhof commented Sep 6, 2017 •

edited