Skip to content

[WIP] Rename napi - #37108

Closed
gabrielschulhof wants to merge 8 commits into
nodejs:masterfrom
gabrielschulhof:rename-napi
Closed

[WIP] Rename napi#37108
gabrielschulhof wants to merge 8 commits into
nodejs:masterfrom
gabrielschulhof:rename-napi

Conversation

@gabrielschulhof

@gabrielschulhofgabrielschulhof commented Jan 28, 2021

Copy link
Copy Markdown
Contributor

No description provided.

@nodejs-github-botnodejs-github-bot added build Issues and PRs related to build files or the CI. meta Issues and PRs related to the general management of the project. labels Jan 28, 2021
@gabrielschulhofgabrielschulhof changed the title Rename napi[WIP] Rename napiJan 28, 2021
@gabrielschulhofgabrielschulhof added the node-api Issues and PRs related to the Node-API. label Jan 28, 2021
@gabrielschulhof

gabrielschulhof commented Jan 28, 2021

Copy link
Copy Markdown
ContributorAuthor

Hmmm ... it's not running the github actions.

@richardlau

richardlau commented Jan 28, 2021

Copy link
Copy Markdown
Member

Hmmm ... it's not running the github actions.

https://www.githubstatus.com/incidents/tf9v5jjmq2lg

@jayaddison

jayaddison commented Jan 29, 2021

Copy link
Copy Markdown
Contributor

Note for any reviewers: it can be worth using a more accepting --find-renames threshold when reviewing this changeset, so that some of the files that contain a small number of lines are detected correctly as renames rather than add/remove operations.

For example: git show 5039837c74d22d1197db33f8eeaaa9f84942c4c2 --stat --find-renames=10% (there are some small whitespace changes bundled in with the renames too -- @gabrielschulhof as a small recommendation, if possible it's helpful to perform bulk file renames and bulk file edits as separate commits; I'm not always great at following this advice myself though)

@gabrielschulhof

gabrielschulhof commented Jan 29, 2021

Copy link
Copy Markdown
ContributorAuthor

@jayaddison if only github would have the option. The only option they have so far is side-by-side diff and -w.

@gabrielschulhof

gabrielschulhof commented Jan 29, 2021

Copy link
Copy Markdown
ContributorAuthor

@jayaddison good idea though. Do all the renames in the first commit, and then make changes afterwards.

@gabrielschulhof

gabrielschulhof commented Jan 29, 2021

Copy link
Copy Markdown
ContributorAuthor

Copied from the PR I closed:

@nodejs/n-api we're gonna have to come up with a name to replace the macro NAPI_MODULE() and NAPI_MODULE_INIT(), because NODE_API_MODULE() is taken by node-addon-api. So is NODE_API_ADDON() IINM, with the addition of the addon class. I have provisionally replaced NAPI_MODULE() with NODE_API_MODULE() in this PR, but we'll have to pick something else.

mhdawson
mhdawson reviewed Jan 29, 2021
View reviewed changes
Comment threadsrc/js_native_api_types.h
typedef struct napi_escapable_handle_scope__* napi_escapable_handle_scope;
typedef struct napi_callback_info__* napi_callback_info;
typedef struct napi_deferred__* napi_deferred;
#define node_api_env napi_env

@mhdawsonmhdawsonJan 29, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all of these defines need to be guarded by NODE-API version 8. Otherwise add-ons could fail to compile against versions of Node.js that support the NODE-API version they are targeting but don't have the new defines. I see adding these defines as the equivalent to adding new supported functions to NODE-API.

@gabrielschulhofgabrielschulhofJan 29, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mhdawson one concern is that NAPI_VERSION itself has to change so, going forward, people would be able to select API versions by defining NODE_API_VERSION themselves.

Trott
Trott reviewed Jan 31, 2021
View reviewed changes
Comment thread.github/CODEOWNERS
/src/module_wrap* @nodejs/modules @nodejs/vm

# N-API
# Node.js API

@TrottTrottJan 31, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Node.js API" seems like it will inevitably cause confusion. Is this the name that reached consensus in discussion? (I can't find the issue in the tracker. Maybe I'm looking in the wrong repository?)

@jschlightjschlightJan 31, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Trott I believe the name is still open for discussion at nodejs/abi-stable-node#420.

@mhdawsonmhdawsonFeb 1, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

node-api was what was being discussion to replace n-api and napi.

@gabrielschulhof
gabrielschulhof deleted the rename-napi branch February 3, 2021 07:17
@gabrielschulhof
gabrielschulhof restored the rename-napi branch February 3, 2021 07:19
@gabrielschulhof

gabrielschulhof commented Feb 3, 2021

Copy link
Copy Markdown
ContributorAuthor

This PR is too big. I'll break it into several, starting with #37217.

@gabrielschulhof
gabrielschulhof deleted the rename-napi branch March 6, 2021 05:39
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TrottTrottTrott left review comments
+2 more reviewers
@mhdawsonmhdawsonmhdawson left review comments
@jschlightjschlightjschlight left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

buildIssues and PRs related to build files or the CI.metaIssues and PRs related to the general management of the project.node-apiIssues and PRs related to the Node-API.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@gabrielschulhof@richardlau@jayaddison@Trott@mhdawson@jschlight@nodejs-github-bot