Skip to content

perf: napi define_properties #11280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

perf: napi define_properties #11280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3607db8
perf: napi define_properties
SyMind Aug 5, 2025
9fe6292
Merge remote-tracking branch 'origin' into perf-napi_define_properties
SyMind Aug 6, 2025
6d27579
perf: inline
SyMind Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions crates/rspack_binding_api/src/module.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ use rspack_core::{
FactoryMeta, LibIdentOptions, Module as _, ModuleIdentifier, RuntimeModuleStage, SourceType,
};
use rspack_napi::{
OneShotInstanceRef, WeakRef, napi::bindgen_prelude::*, string::JsStringExt,
threadsafe_function::ThreadsafeFunction,
OneShotInstanceRef, Property, WeakRef, define_properties, napi::bindgen_prelude::*,
string::JsStringExt, threadsafe_function::ThreadsafeFunction,
};
use rspack_plugin_runtime::RuntimeModuleFromJs;
use rspack_util::source_map::SourceMapKind;
Expand Down Expand Up @@ -227,44 +227,44 @@ impl Module {
properties.clear();
properties.push(
Property::new()
.with_utf8_name("type")?
.with_utf8_name(c"type")?
.with_value(&env.create_string(module.module_type().as_str())?),
);
properties.push(
Property::new()
.with_utf8_name("context")?
.with_utf8_name(c"context")?
.with_getter(context_getter),
);
properties.push(
Property::new()
.with_utf8_name("layer")?
.with_utf8_name(c"layer")?
.with_getter(layer_getter),
);
properties.push(
Property::new()
.with_utf8_name("useSourceMap")?
.with_utf8_name(c"useSourceMap")?
.with_getter(use_source_map_getter),
);
properties.push(
Property::new()
.with_utf8_name("useSimpleSourceMap")?
.with_utf8_name(c"useSimpleSourceMap")?
.with_getter(use_simple_source_map_getter),
);
properties.push(
Property::new()
.with_utf8_name("factoryMeta")?
.with_utf8_name(c"factoryMeta")?
.with_getter(factory_meta_getter)
.with_setter(factory_meta_setter),
);
properties.push(
Property::new()
.with_utf8_name("buildInfo")?
.with_utf8_name(c"buildInfo")?
.with_getter(build_info_getter)
.with_setter(build_info_setter),
);
properties.push(
Property::new()
.with_utf8_name("buildMeta")?
.with_utf8_name(c"buildMeta")?
.with_value(&Object::new(env)?),
);
MODULE_IDENTIFIER_SYMBOL.with(|once_cell| {
Expand All @@ -280,7 +280,7 @@ impl Module {
Ok::<(), napi::Error>(())
})?;

object.define_properties(&properties)
define_properties(env, &mut object, &properties)
})?;

Ok(instance)
Expand Down
4 changes: 2 additions & 2 deletions crates/rspack_binding_api/src/modules/external_module.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ impl ExternalModule {
properties.clear();

properties.push(
napi::Property::new()
.with_utf8_name("userRequest")?
rspack_napi::Property::new()
.with_utf8_name(c"userRequest")?
.with_value(&user_request),
);
Self::new_inherited(self, env, &mut properties)
Expand Down
38 changes: 19 additions & 19 deletions crates/rspack_binding_api/src/modules/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ macro_rules! impl_module_methods {
fn new_inherited<'a>(
self,
env: &'a napi::Env,
properties: &mut Vec<napi::Property>,
properties: &mut Vec<rspack_napi::Property>,
) -> napi::Result<napi::bindgen_prelude::ClassInstance<'a, Self>> {
use napi::bindgen_prelude::{JavaScriptClassExt, JsObjectValue, JsValue};

Expand Down Expand Up @@ -186,59 +186,59 @@ macro_rules! impl_module_methods {
}

properties.push(
napi::Property::new()
.with_utf8_name("type")?
rspack_napi::Property::new()
.with_utf8_name(c"type")?
.with_value(&env.create_string(module.module_type().as_str())?),
);
properties.push(
napi::Property::new()
.with_utf8_name("context")?
rspack_napi::Property::new()
.with_utf8_name(c"context")?
.with_getter(context_getter)
);
properties.push(
napi::Property::new()
.with_utf8_name("layer")?
rspack_napi::Property::new()
.with_utf8_name(c"layer")?
.with_getter(layer_getter)
);
properties.push(
napi::Property::new()
.with_utf8_name("useSourceMap")?
rspack_napi::Property::new()
.with_utf8_name(c"useSourceMap")?
.with_getter(use_source_map_getter)
);
properties.push(
napi::Property::new()
.with_utf8_name("useSimpleSourceMap")?
rspack_napi::Property::new()
.with_utf8_name(c"useSimpleSourceMap")?
.with_getter(use_simple_source_map_getter),
);
properties.push(
napi::Property::new()
.with_utf8_name("factoryMeta")?
rspack_napi::Property::new()
.with_utf8_name(c"factoryMeta")?
.with_getter(factory_meta_getter)
.with_setter(factory_meta_setter),
);
properties.push(
napi::Property::new()
.with_utf8_name("buildInfo")?
rspack_napi::Property::new()
.with_utf8_name(c"buildInfo")?
.with_getter(build_info_getter)
.with_setter(build_info_setter)
);
properties.push(
napi::Property::new()
.with_utf8_name("buildMeta")?
rspack_napi::Property::new()
.with_utf8_name(c"buildMeta")?
.with_value(&napi::bindgen_prelude::Object::new(env)?)
);
$crate::module::MODULE_IDENTIFIER_SYMBOL.with(|once_cell| {
let identifier = env.create_string(module.identifier().as_str())?;
let symbol = once_cell.get().unwrap();
properties.push(
napi::bindgen_prelude::Property::new()
rspack_napi::Property::new()
.with_name(env, symbol)?
.with_value(&identifier)
.with_property_attributes(napi::bindgen_prelude::PropertyAttributes::Configurable),
);
Ok::<(), napi::Error>(())
})?;
object.define_properties(properties)?;
rspack_napi::define_properties(env, &mut object, properties)?;

Ok(instance)
}
Expand Down
108 changes: 54 additions & 54 deletions crates/rspack_binding_api/src/modules/normal_module.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,46 @@ use crate::{
resource_data::ReadonlyResourceDataWrapper,
};

#[js_function]
pub fn match_resource_getter(ctx: CallContext<'_>) -> napi::Result<Either<&String, ()>> {
let this = ctx.this_unchecked::<JsObject>();
let env = ctx.env.raw();
let wrapped_value = unsafe { NormalModule::from_napi_mut_ref(env, this.raw())? };

let (_, module) = wrapped_value.as_ref()?;
Ok(match module.match_resource() {
Some(match_resource) => Either::A(&match_resource.resource),
None => Either::B(()),
})
}

#[js_function(1)]
pub fn match_resource_setter(ctx: CallContext) -> napi::Result<()> {
let this = ctx.this_unchecked::<JsObject>();
let env = ctx.env.raw();
let wrapped_value = unsafe { NormalModule::from_napi_mut_ref(env, this.raw())? };

let val = ctx.get::<Either<String, ()>>(0)?;
match val {
Either::A(val) => {
let module = wrapped_value.as_mut()?;
let ResourceParsedData {
path,
query,
fragment,
} = parse_resource(&val).expect("Should parse resource");
*module.match_resource_mut() = Some(
ResourceData::new(val)
.path(path)
.query_optional(query)
.fragment_optional(fragment),
);
}
Either::B(_) => {}
}
Ok(())
}

#[napi]
#[repr(C)]
pub struct NormalModule {
Expand Down Expand Up @@ -50,83 +90,43 @@ impl NormalModule {
)?
});

#[js_function]
pub fn match_resource_getter(ctx: CallContext<'_>) -> napi::Result<Either<&String, ()>> {
let this = ctx.this_unchecked::<JsObject>();
let env = ctx.env.raw();
let wrapped_value = unsafe { NormalModule::from_napi_mut_ref(env, this.raw())? };

let (_, module) = wrapped_value.as_ref()?;
Ok(match module.match_resource() {
Some(match_resource) => Either::A(&match_resource.resource),
None => Either::B(()),
})
}

#[js_function(1)]
pub fn match_resource_setter(ctx: CallContext) -> napi::Result<()> {
let this = ctx.this_unchecked::<JsObject>();
let env = ctx.env.raw();
let wrapped_value = unsafe { NormalModule::from_napi_mut_ref(env, this.raw())? };

let val = ctx.get::<Either<String, ()>>(0)?;
match val {
Either::A(val) => {
let module = wrapped_value.as_mut()?;
let ResourceParsedData {
path,
query,
fragment,
} = parse_resource(&val).expect("Should parse resource");
*module.match_resource_mut() = Some(
ResourceData::new(val)
.path(path)
.query_optional(query)
.fragment_optional(fragment),
);
}
Either::B(_) => {}
}
Ok(())
}

MODULE_PROPERTIES_BUFFER.with(|ref_cell| {
let mut properties = ref_cell.borrow_mut();
properties.clear();

properties.push(
napi::Property::new()
.with_utf8_name("resource")?
rspack_napi::Property::new()
.with_utf8_name(c"resource")?
.with_value(&resource),
);
properties.push(
napi::Property::new()
.with_utf8_name("request")?
rspack_napi::Property::new()
.with_utf8_name(c"request")?
.with_value(&request),
);
properties.push(
napi::Property::new()
.with_utf8_name("userRequest")?
rspack_napi::Property::new()
.with_utf8_name(c"userRequest")?
.with_value(&user_request),
);
properties.push(
napi::Property::new()
.with_utf8_name("rawRequest")?
rspack_napi::Property::new()
.with_utf8_name(c"rawRequest")?
.with_value(&raw_request),
);
properties.push(
napi::Property::new()
.with_utf8_name("resourceResolveData")?
rspack_napi::Property::new()
.with_utf8_name(c"resourceResolveData")?
.with_value(&resource_resolve_data),
);
properties.push(
napi::Property::new()
.with_utf8_name("loaders")?
rspack_napi::Property::new()
.with_utf8_name(c"loaders")?
.with_value(&loaders),
);
properties.push(
napi::Property::new()
.with_utf8_name("matchResource")?
rspack_napi::Property::new()
.with_utf8_name(c"matchResource")?
.with_getter(match_resource_getter)
.with_setter(match_resource_setter),
);
Expand Down
13 changes: 7 additions & 6 deletions crates/rspack_binding_api/src/resource_data.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ use std::{
};

use napi::{
Env, JsValue, Property,
Env, JsValue,
bindgen_prelude::{JavaScriptClassExt, JsObjectValue, ToNapiValue},
sys::napi_value,
};
use napi_derive::napi;
use rspack_napi::{Property, define_properties};

// Converting the descriptionFileData property to a JSObject may become a performance bottleneck.
// Additionally, descriptionFileData and descriptionFilePath are rarely used, so they are exposed via getter methods and only converted to JSObject when accessed.
Expand Down Expand Up @@ -85,31 +86,31 @@ impl ToNapiValue for ReadonlyResourceDataWrapper {
properties.clear();
properties.push(
Property::new()
.with_utf8_name("resource")?
.with_utf8_name(c"resource")?
.with_value(&env_wrapper.create_string(&resource_data.resource)?),
);
if let Some(path) = &resource_data.resource_path {
properties.push(
Property::new()
.with_utf8_name("path")?
.with_utf8_name(c"path")?
.with_value(&env_wrapper.create_string(path.as_str())?),
);
}
if let Some(query) = &resource_data.resource_query {
properties.push(
Property::new()
.with_utf8_name("query")?
.with_utf8_name(c"query")?
.with_value(&env_wrapper.create_string(query)?),
);
}
if let Some(fragment) = &resource_data.resource_fragment {
properties.push(
Property::new()
.with_utf8_name("fragment")?
.with_utf8_name(c"fragment")?
.with_value(&env_wrapper.create_string(fragment)?),
);
}
object.define_properties(&properties)
define_properties(&env_wrapper, &mut object, &properties)
})?;

Ok(object.raw())
Expand Down
2 changes: 2 additions & 0 deletions crates/rspack_napi/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

mod ext;
mod js_values;
mod object;
mod utils;

mod errors;
Expand All @@ -22,4 +23,5 @@ pub use js_values::{
weak_ref::*,
};
pub use napi;
pub use object::*;
pub use utils::*;
Loading
Loading