fix(napi): receive raw pointer out parameters#57
Open
GrapeBaBa wants to merge 6 commits into
Open
Conversation
Comment on lines
+293
to
+295
| it("rejects unsupported TypedArray element types", () => { | ||
| const Float16ArrayCtor = Reflect.get(globalThis, "Float16Array"); | ||
| if (typeof Float16ArrayCtor !== "function") return; |
Contributor
There was a problem hiding this comment.
If that condition does not match, it will show the tests pass not skipped. We can use something like this to properly show the test skipped.
it.skipIf(typeof Float16Array !== "function")
| /// https://nodejs.org/api/n-api.html#napi_get_typedarray_info | ||
| pub fn getTypedarrayInfo(self: Value) NapiError!TypedarrayInfo { | ||
| var info: TypedarrayInfo = undefined; | ||
| pub fn getTypedarrayInfo(self: Value) TypedarrayInfoError!TypedarrayInfo { |
Contributor
There was a problem hiding this comment.
Just a note for reference. The error set change on a pub function, will be breaking for usage when user completely exhausting error union.
Contributor
Author
There was a problem hiding this comment.
Yes, this is what I thought a while and finally add a new error
nazarhussain
previously approved these changes
Jul 22, 2026
nazarhussain
previously approved these changes
Jul 23, 2026
## Motivation Node-API permits ArrayBuffer, Buffer, TypedArray, and DataView data out parameters to be `NULL` or an arbitrary pointer when the reported length is zero. This commonly occurs for empty and detached values. The previous binding received those results into non-null `[*]u8` storage, so a valid Node-API result could create a zero-length Zig slice whose pointer violates the slice type invariant. Normalizing this case at the binding boundary keeps the public slice API safe, while the TypedArray zero-length branch avoids applying element-alignment casts to an empty byte-slice sentinel. ## Summary - represent Node-API `void*` data out parameters as nullable Zig pointers - normalize successful zero-length results to safe empty slices without changing public return types - skip TypedArray alignment casts when the element length is zero - cover shared null-plus-zero normalization in Zig and exercise empty and detached values through the example API
nazarhussain
approved these changes
Jul 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Node-API returns several values through pointer-sized C out parameters. The previous bindings passed addresses of higher-level Zig struct or wrapper storage to some of these APIs, so Node-API wrote raw pointer or handle bits into the wrong fields instead of a correctly typed raw slot. This could corrupt returned Node version data and TypedArray or DataView backing ArrayBuffer wrappers. Receiving the exact C values first, then copying or wrapping them only after a successful call, preserves both the C ABI and the Zig wrapper invariants. Unsupported TypedArray tags must likewise become a normal conversion error rather than an enum-conversion trap.
Summary
napi_valuevaluesValuewrappers only after successful Node-API callsUnsupportedTypedarrayTypeinstead of trapping during enum conversion