Skip to content

Commit

Permalink
Add convenience methods to ModuleLoader (#3007)
Browse files Browse the repository at this point in the history
* Add convenience methods to `ModuleLoader`

* Document special behaviour of `SimpleModuleLoader`
  • Loading branch information
jedel1043 authored and Razican committed Jun 26, 2023
1 parent 6a5c069 commit dddecb8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
26 changes: 26 additions & 0 deletions boa_engine/src/module/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,26 @@ pub trait ModuleLoader {
context: &mut Context<'_>,
);

/// Registers a new module into the module loader.
///
/// This is a convenience method for module loaders caching already parsed modules, since it
/// allows registering a new module through the `&dyn ModuleLoader` provided by
/// [`Context::module_loader`].
///
/// Does nothing by default.
fn register_module(&self, _specifier: JsString, _module: Module) {}

/// Gets the module associated with the provided specifier.
///
/// This is a convenience method for module loaders caching already parsed modules, since it
/// allows getting a cached module through the `&dyn ModuleLoader` provided by
/// [`Context::module_loader`].
///
/// Returns `None` by default.
fn get_module(&self, _specifier: JsString) -> Option<Module> {
None
}

/// Host hooks [`HostGetImportMetaProperties ( moduleRecord )`][meta] and
/// [`HostFinalizeImportMeta ( importMeta, moduleRecord )`][final].
///
Expand Down Expand Up @@ -153,6 +173,12 @@ impl ModuleLoader for IdleModuleLoader {
}

/// A simple module loader that loads modules relative to a root path.
///
/// # Note
///
/// This loader only works by using the type methods [`SimpleModuleLoader::insert`] and
/// [`SimpleModuleLoader::get`]. The utility methods on [`ModuleLoader`] don't work at the moment,
/// but we'll unify both APIs in the future.
#[derive(Debug)]
pub struct SimpleModuleLoader {
root: PathBuf,
Expand Down
5 changes: 3 additions & 2 deletions boa_examples/src/bin/modules.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ fn main() -> Result<(), Box<dyn Error>> {
module.clone(),
);

// The lifecycle of the module is tracked using promises, which can be a bit cumbersome
// for simple uses but that use case is better suited by the `Module::load_link_evaluate` method.
// The lifecycle of the module is tracked using promises which can be a bit cumbersome to use.
// If you just want to directly execute a module, you can use the `Module::load_link_evaluate`
// method to skip all the boilerplate.
// This does the full version for demonstration purposes.
//
// parse -> load -> link -> evaluate
Expand Down

0 comments on commit dddecb8

Please sign in to comment.