nodejs / node

Node.js JavaScript runtime ✨🐢🚀✨
https://nodejs.org
Other
105.68k stars 28.67k forks source link

[node-api]: New variant `napi_set_named_property` that treats '\0' as values. #52979

Open hyf0 opened 2 months ago

hyf0 commented 2 months ago

What is the problem this feature will solve?

I'm developing rolldown, rust version of rollup. Rollup use \0 as the virtual module name convention.

If your plugin uses 'virtual modules' (e.g. for helper functions), prefix the module ID with \0. This prevents other plugins from trying to process it. link

Rolldown follows this convention and got problems while using napi_set_named_property. napi_set_named_property considers \0 as the terminator rather than values. This makes passing "\0mvirtual-module" to Node using napi_set_named_property become "".

Related issues:

What is the feature you are proposing to solve the problem?

So I propose a new variant napi_set_named_property, maybe call `napi_set_named_property_len, which will receive string and the length. This way, it could treat '\0' as values.

For alignment, If this request is accepted, I guess napi_get_named_property need a new variant too.

What alternatives have you considered?

I'm using workaround said in https://github.com/rolldown/rolldown/issues/1115#issuecomment-2109688578. Create JsString first, then using napi_set_property. But this cause extra napi calls and it's really not good for a bundler that address speed.

legendecas commented 2 months ago

If the property keys are definite, creating property keys with node_api_create_property_key_utf16 beforehand and reuse the created keys in napi_set_property could helps.

hyf0 commented 2 months ago

If the property keys are definite, creating property keys with node_api_create_property_key_utf16 beforehand and reuse the created keys in napi_set_property could helps.

Thanks for the solution. I'm using the workaround like it, but still there is an extra napi call of node_api_create_property_key_utf16.

mertcanaltin commented 2 months ago

I tried to make a quick improvement for this place @hyf0 @legendecas