Skip to content

doc: clarify napi_get_value_string_* for bufsize 0#58158

Merged
nodejs-github-bot merged 2 commits intonodejs:mainfrom
tniessen:doc-napigetvaluestring-bufsize-zero
May 12, 2025
Merged

doc: clarify napi_get_value_string_* for bufsize 0#58158
nodejs-github-bot merged 2 commits intonodejs:mainfrom
tniessen:doc-napigetvaluestring-bufsize-zero

Conversation

@tniessen
Copy link
Member

@tniessen tniessen commented May 4, 2025

This edge case is ambiguous and it is unclear from the existing documentation what happens in this case.

@tniessen tniessen added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels May 4, 2025
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented May 4, 2025

Review requested:

  • @nodejs/node-api

@vmoroz
Copy link
Member

vmoroz commented May 4, 2025

I would rather change it to say that if bufsize is zero and the buf pointer is not null, then the string is not returned and not measured.
To me the phrase "null-terminated if possible" sounds a bit ambiguous.
We do always null-terminate string when we return it. We obviously cannot null terminate it when we do not return it.
We do not return the string when either buf is null or the bufsize is zero.
The buffer size must be big enough to fit the string and its null terminator.

vmoroz
vmoroz reviewed May 11, 2025
View reviewed changes
vmoroz
vmoroz reviewed May 11, 2025
View reviewed changes
vmoroz
vmoroz reviewed May 11, 2025
View reviewed changes
@vmoroz
Copy link
Member

vmoroz commented May 11, 2025

@tniessen , we discussed this PR in out last Node-API meeting on 5/9/2025.
The team advised me to provide the text change suggestions instead of the general comment.

@tniessen @vmoroz
Apply suggestions from code review
32bc0ad 
Co-authored-by: Vladimir Morozov <vmorozov@microsoft.com>
@tniessen tniessen added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label May 12, 2025
mhdawson
mhdawson approved these changes May 12, 2025
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@legendecas legendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label May 12, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 12, 2025
@nodejs-github-bot nodejs-github-bot merged commit acb3d92 into nodejs:main May 12, 2025
22 checks passed
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented May 12, 2025

Landed in acb3d92

@github-project-automation github-project-automation bot moved this from Need Triage to Done in Node-API Team Project May 12, 2025
targos pushed a commit that referenced this pull request May 16, 2025
@tniessen @targos
doc: clarify napi_get_value_string_* for bufsize 0
290a5ab 
PR-URL: #58158
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@github-actions github-actions bot mentioned this pull request May 20, 2025
Merged
aduh95 pushed a commit that referenced this pull request Jun 10, 2025
@tniessen @aduh95
doc: clarify napi_get_value_string_* for bufsize 0
7d00fc2 
PR-URL: #58158
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@github-actions github-actions bot mentioned this pull request Jun 10, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vmoroz vmoroz vmoroz left review comments

@jasnell jasnell jasnell approved these changes

@cjihrig cjihrig cjihrig approved these changes

@legendecas legendecas legendecas approved these changes

@mhdawson mhdawson mhdawson approved these changes

+1 more reviewer

@aymen94 aymen94 aymen94 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Projects

Node-API Team Project
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@tniessen @nodejs-github-bot @vmoroz @jasnell @cjihrig @legendecas @mhdawson @aymen94