fix: Make native modules built with Neon work in Bun #914
Conversation
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
kjvalencik
force-pushed
the
kv/bun
branch
2 times, most recently
from
553de18 to
b60393d
Compare
kjvalencik
commented
Jul 8, 2022
| actual_napi_version, | ||
| ); | ||
|
|
||
| let print_warn = |err| eprintln!("WARN: {}", err); |
There was a problem hiding this comment.
Sample output:
WARN: bun: undefined symbol: napi_get_value_external
WARN: bun: undefined symbol: napi_close_escapable_handle_scope
WARN: bun: undefined symbol: napi_open_escapable_handle_scope
WARN: bun: undefined symbol: napi_create_external
WARN: bun: undefined symbol: napi_escape_handle
WARN: bun: undefined symbol: napi_set_instance_data
WARN: bun: undefined symbol: napi_get_instance_data
kjvalencik
commented
Jul 8, 2022
| #[inline(never)] | ||
| fn panic_load<T>() -> T { | ||
| panic!("Must load N-API bindings") | ||
| panic!("Node-API symbol has not been loaded") |
There was a problem hiding this comment.
Currently this panic stack looks like:
thread '<unnamed>' panicked at 'Node-API symbol has not been loaded', crates/neon/src/sys/bindings/functions.rs:307:5
stack backtrace:
0: std::panicking::begin_panic
at /rustc/db9d1b20bba1968c1ec1fc49616d4742c1725b4b/library/std/src/panicking.rs:525:12
1: neon::sys::bindings::functions::napi6::panic_load
at /work/crates/neon/src/sys/bindings/mod.rs:121:13
2: neon::sys::bindings::functions::napi6::NAPI::get_instance_data
The panic message itself doesn't explain what symbol is missing; instead it requires the backtrace to determine. This is by design because it's never expected to happen on Node and only having a single panic method for the defaults reduces binary bloat.
Do you think it's worth the cost to binary sizes (a bunch of unique functions that should never be executed) to have more clear error messages in bun? I personally feel that the backtrace is sufficient since eventually all symbols should be implemented.
dherman
reviewed
Jul 8, 2022
dherman
approved these changes
Jul 8, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
bun is a new JavaScript runtime designed to be Node.js compatible--including Node-API. However, it currently ships with an incomplete set of Node-APIs.
The following changes symbol loading to print a warning to
stderrif a symbol is missing instead of panicking. This should be no change on Node because symbols are guaranteed to exist if the Node-API version number matches. Onbun, this converts a panic on load to a panic when attempting to use the API.With these changes, simple Neon modules work with
bun. However, because of Neon's heavily reliance onnapi_get_instance_data, many more powerful features will not work until this API is implemented in bun.