build: expose napi_build_version variable to native addons #27835

NickNaso · 2019-05-23T10:04:27Z

Expose napi_build_version to allow node-gyp to make it
available for addons.
Fixes: nodejs/node-gyp#1745
Refs: nodejs/abi-stable-node#371

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

lpinca

SGTM

lpinca · 2019-05-23T10:55:15Z

@NickNaso can you please remove "build:" and capitalize "ensure" in commit message body?

Expose `napi_build_version` to allow `node-gyp` to make it available for
addons.

Expose `napi_build_version` to allow `node-gyp` to make it available for addons. Fixes: nodejs/node-gyp#1745 Refs: nodejs/abi-stable-node#371

mhdawson · 2019-05-23T18:44:02Z

@NickNaso is there any way to have this be generated from where the value is defined? Just worried about keeping the 2 in sync. I wonder if something the in the makefiles/build steps could update it? MIght be a bad idea if we don't modify the build files already but thought I'd ask to see if anybody else has any suggestions/comments as well.

NickNaso · 2019-05-23T19:04:35Z

@mhdawson I will investigate later or tomorrow what you suggested because it's a more robust solution. If anyone want help all feedback are welcome.

bnoordhuis · 2019-05-23T19:54:05Z

configure.py could write it to config.gypi, that's also picked up by node-gyp. Another benefit: it'll show up in process.config as process.config.variables.napi_build_version; useful for post-install scripts.

There's precedence, see tools/getmoduleversion.py and its corresponding import and usage in configure.py. That's what generates process.config.variables.node_module_version.

mhdawson · 2019-05-24T20:54:31Z

@bnoordhuis thanks for the great pointers.

addaleax · 2019-06-02T17:00:16Z

A test with assert.strictEqual(process.config.variables.napi_build_version, process.versions.napi); should work if @bnoordhuis’ suggestion is implemented, as far as keeping the versions up to date is concerned, right?

NickNaso · 2019-06-03T16:44:48Z

Thanks all for suggestions I will update the PR very soon.

legendecas

There is a definition of NAPI_VERSION in node_version.h. Should it be derived from the one in js_native_api.h too?

NickNaso · 2019-06-04T08:44:49Z

@legendecas
I didn't know that node_verssion.h contains the definition of NAPI_VERSION and I think that it's more appropriate use this file to retrieve the version of N-API. I will provide to update the PR.

nodejs-github-bot · 2019-06-04T09:18:05Z

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

…ion.h

legendecas

Wondering the difference of NAPI_VERSION between node_version.h and js_native_api.h. Should they both be updated on version bumping?

NickNaso · 2019-06-04T16:23:35Z

@legendecas I think that we need to update both version in node_version.h and in js_native_api.h, but your concern is about the fact the we need to change the version in two places. Now I'm thinking that if we use js_native_api.h to retrive the N-API version could be more appropriate because I added a test so if the test fail this means there is a bad N-API version set in js_native_api.h or node_version.h. What do you think?

NickNaso · 2019-06-07T10:53:40Z

Hi everyone,
like I explained in the previous comment now we have two places (node_version.h and js_native_api.h) where we need to update the N-API version and this could not be ideal. In these days I tried to find a solution that now I want propose:

Create a new file called js_native_api_version.h and define NAPI_BASE_VERSION
Import js_native_api_version.h in node_version.h and js_native_api.h and then use the NAPI_BASE_VERSION

I executed the tests and it seems to work, but I don't know if it could be the right solution.
Someone have an opinion or feedback about that?

@nodejs/n-api

mhdawson · 2019-06-07T15:02:44Z

The two definitions of N-API version are actually a bit different.

The one in node_version.h is the version which the Node binary being built supports.

The one in js_native_api_version.h controls which version will be used by default when compiling a native addon. For example, if all LTS versions support N-API 4, but the latest support N-API 5 we still may want to have the default be N-API 4 be the default so that the addon can compile across all of the LTS versions. If the addon developer specifically wants to use functions in N-API 5 they can do that by setting NAPI_VERSION to 5 knowing that they have specifically depended on that version.

Might have been better if we had named them differently as I can't remember if there was any reason they needed to be the same.

My thought is that having them be separate is useful but that we should have more comments to explain what I've just said in the code.

jschlight · 2019-06-10T04:21:19Z

If I understand correctly, the NAPI_VERSION value is meant to be optionally overridden using build tools.

For example, node-pre-gyp (N-API Doc) and prebuild (N-API Doc) are designed to fire off multiple builds, one for each N-API version supported by the native module. The NAPI_VERSION value is used to communicate to the C/C++code which N-API version the code is being built against.

~~I'm not clear what effect, if any, NAPI_VERSION should have on napi_build_version if the value of NAPI_VERSION set externally by a build tool.~~

Edit: Reviewing the documentation linked above, it looks like for node-pre-gyp and prebuild the NAPI_VERSION is derived directly from napi_build_version. So with these two tools we're good.

src/js_native_api.h

gabrielschulhof · 2019-06-13T17:46:40Z

@mhdawson NAPI_VERSION as defined in js_native_api.h is defined softly. Thus, if you wish to build against whichever version your copy of Node.js supports, you can

#include "node_version.h"
#include "js_native_api.h"

gabrielschulhof · 2019-06-13T17:47:15Z

@mhdawson that's probably why they have the same name.

mhdawson

LGTM

nodejs-github-bot · 2019-06-17T17:43:00Z

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

mhdawson · 2019-06-17T17:43:11Z

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

mhdawson · 2019-06-17T21:53:20Z

Rebuild - https://ci.nodejs.org/job/node-test-commit/29527/

bnoordhuis

LGTM % style nit. Thanks for doing this!

edit: the CI failures are all infrastructural, by the way.

configure.py

NickNaso · 2019-07-01T08:18:41Z

Hi everybody is there a chance to merge this PR?

nodejs-github-bot · 2019-07-01T17:53:14Z

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

gabrielschulhof · 2019-07-02T05:08:21Z

Landed in 9868126.

Expose `napi_build_version` to allow `node-gyp` to make it available for building native addons. Fixes: nodejs/node-gyp#1745 Refs: nodejs/abi-stable-node#371 PR-URL: nodejs#27835 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

Expose `napi_build_version` to allow `node-gyp` to make it available for building native addons. Fixes: nodejs/node-gyp#1745 Refs: nodejs/abi-stable-node#371 PR-URL: #27835 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

Expose `napi_build_version` to allow `node-gyp` to make it available for building native addons. Fixes: nodejs/node-gyp#1745 Refs: nodejs/abi-stable-node#371 PR-URL: nodejs#27835 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

Expose `napi_build_version` to allow `node-gyp` to make it available for building native addons. Fixes: nodejs/node-gyp#1745 Refs: nodejs/abi-stable-node#371 PR-URL: #27835 Backport-PR-URL: #35266 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

Notable changes: - deps: - upgrade npm to 6.14.8 (Ruy Adorno) #34834 - n-api: - create N-API version 7 (Gabriel Schulhof) #35199 - expose napi_build_version variable (NickNaso) #27835 - tools: - add debug entitlements for macOS 10.15+ (Gabriele Greco) #34378 PR-URL: #35544

NickNaso mentioned this pull request May 23, 2019

Napi version in node-gyp nodejs/abi-stable-node#371

Closed

lpinca approved these changes May 23, 2019

View reviewed changes

build: expose napi_build_version variable to native addons

e4a965a

Expose `napi_build_version` to allow `node-gyp` to make it available for addons. Fixes: nodejs/node-gyp#1745 Refs: nodejs/abi-stable-node#371

addaleax added addons Issues and PRs related to native addons. build Issues and PRs related to build files or the CI. node-api Issues and PRs related to the Node-API. labels Jun 2, 2019

Retrieve napi_build_version in a dynamic way.

5e4f0bb

legendecas reviewed Jun 4, 2019

View reviewed changes

addaleax approved these changes Jun 4, 2019

View reviewed changes

Fixed lint problem on test and retrtieve N-API version from node_vers…

8758973

…ion.h

legendecas approved these changes Jun 4, 2019

View reviewed changes

richardlau approved these changes Jun 4, 2019

View reviewed changes

Added some comments about NAPI_VERSION

cc8031b

gabrielschulhof approved these changes Jun 13, 2019

View reviewed changes

src/js_native_api.h Outdated Show resolved Hide resolved

Fixed typo

a46ad00

mhdawson approved these changes Jun 17, 2019

View reviewed changes

bnoordhuis approved these changes Jun 20, 2019

View reviewed changes

configure.py Outdated Show resolved Hide resolved

Fixed style on configure_napi function.

0bf6549

gabrielschulhof closed this Jul 2, 2019

targos mentioned this pull request Jul 2, 2019

Release v12.6.0 proposal #28508

Merged

This was referenced Jul 3, 2019

2019-07-03 Version 12.6.0 (Current) @targos beevelop/docker-nodejs#288

Closed

2019-07-03 Version 12.6.0 (Current) @targos beevelop/docker-nodejs#289

Closed

2019-07-03 Version 12.6.0 (Current) @targos beevelop/docker-nodejs#290

Closed

richardlau mentioned this pull request Sep 17, 2020

gyp: Undefined variable napi_build_version in binding.gyp while trying to load binding.gyp nodejs/node-gyp#2224

Closed

gabrielschulhof mentioned this pull request Sep 19, 2020

[v10.x] build: expose napi_build_version variable #35266

Closed

4 tasks

richardlau mentioned this pull request Oct 7, 2020

v10.23.0 proposal #35544

Merged

3 tasks

joshuanathanson mentioned this pull request Apr 28, 2021

gyp: Undefined variable napi_build_version in binding.gyp while trying to load binding.gyp TryGhost/node-sqlite3#1359

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: expose napi_build_version variable to native addons #27835

build: expose napi_build_version variable to native addons #27835

NickNaso commented May 23, 2019 •

edited

Loading

lpinca left a comment

lpinca commented May 23, 2019 •

edited

Loading

mhdawson commented May 23, 2019

NickNaso commented May 23, 2019

bnoordhuis commented May 23, 2019

mhdawson commented May 24, 2019

addaleax commented Jun 2, 2019

NickNaso commented Jun 3, 2019

legendecas left a comment

NickNaso commented Jun 4, 2019

nodejs-github-bot commented Jun 4, 2019

legendecas left a comment

NickNaso commented Jun 4, 2019

NickNaso commented Jun 7, 2019 •

edited

Loading

mhdawson commented Jun 7, 2019

jschlight commented Jun 10, 2019 •

edited

Loading

gabrielschulhof commented Jun 13, 2019

gabrielschulhof commented Jun 13, 2019

mhdawson left a comment

nodejs-github-bot commented Jun 17, 2019

mhdawson commented Jun 17, 2019

mhdawson commented Jun 17, 2019

bnoordhuis left a comment •

edited

Loading

NickNaso commented Jul 1, 2019

nodejs-github-bot commented Jul 1, 2019

gabrielschulhof commented Jul 2, 2019

build: expose napi_build_version variable to native addons #27835

build: expose napi_build_version variable to native addons #27835

Conversation

NickNaso commented May 23, 2019 • edited Loading

lpinca left a comment

Choose a reason for hiding this comment

lpinca commented May 23, 2019 • edited Loading

mhdawson commented May 23, 2019

NickNaso commented May 23, 2019

bnoordhuis commented May 23, 2019

mhdawson commented May 24, 2019

addaleax commented Jun 2, 2019

NickNaso commented Jun 3, 2019

legendecas left a comment

Choose a reason for hiding this comment

NickNaso commented Jun 4, 2019

nodejs-github-bot commented Jun 4, 2019

legendecas left a comment

Choose a reason for hiding this comment

NickNaso commented Jun 4, 2019

NickNaso commented Jun 7, 2019 • edited Loading

mhdawson commented Jun 7, 2019

jschlight commented Jun 10, 2019 • edited Loading

gabrielschulhof commented Jun 13, 2019

gabrielschulhof commented Jun 13, 2019

mhdawson left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Jun 17, 2019

mhdawson commented Jun 17, 2019

mhdawson commented Jun 17, 2019

bnoordhuis left a comment • edited Loading

Choose a reason for hiding this comment

NickNaso commented Jul 1, 2019

nodejs-github-bot commented Jul 1, 2019

gabrielschulhof commented Jul 2, 2019

NickNaso commented May 23, 2019 •

edited

Loading

lpinca commented May 23, 2019 •

edited

Loading

NickNaso commented Jun 7, 2019 •

edited

Loading

jschlight commented Jun 10, 2019 •

edited

Loading

bnoordhuis left a comment •

edited

Loading