fix: allow for use of both manual & fetchEvent based HTTP (#247)

* fix: allow for use of both manual & fetchEvent based HTTP

This commit updates the componentize-js code to support both
fetchEvent and manual based HTTP.

To make this possible we needed to re-introduce a few things:

- A feature that represents fetch-event
- Allow controlling removal of the the built-in fetch event
- Allow skipping checks for manual wasi:http/incoming-handler impls
- Add oxc-parser to detect manual impls and toggle fetch-event feature

The docs are also updated to note the changes to API/usage.

* test: add test case for fetch-event integration

* fix: tests, arg order for splice bindings

* refactor: use sets for features & detected exports

* refactor: remove comment

* chore: fix clippy

* refactor: simplify feature creation

Author: vados-cosmonic

README.md

@@ -184,16 +184,29 @@ The default set of features includes:
 * `'random'`: Support for cryptographic random, depends on `wasi:random`. **When disabled, random numbers will still be generated but will not be random and instead fully deterministic.**
 * `'clocks'`: Support for clocks and duration polls, depends on `wasi:clocks` and `wasi:io`. **When disabled, using any timer functions like setTimeout or setInterval will panic.**
 * `'http'`: Support for outbound HTTP via the `fetch` global in JS.
+* `'fetch-event'`: Support for `fetch` based incoming request handling (i.e. `addEventListener('fetch', ...)`)
 
-Setting `disableFeatures: ['random', 'stdio', 'clocks', 'http']` will disable all features creating a minimal "pure component", that does not depend on any WASI APIs at all and just the target world.
+Setting `disableFeatures: ['random', 'stdio', 'clocks', 'http', 'fetch-event']` will disable all features creating a minimal "pure component", that does not depend on any WASI APIs at all and just the target world.
 
 Note that pure components **will not report errors and will instead trap**, so that this should only be enabled after very careful testing.
 
 Note that features explicitly imported by the target world cannot be disabled - if you target a component to a world that imports `wasi:clocks`, then `disableFeatures: ['clocks']` will not be supported.
 
+Note that depending on your component implementation, some features may be automatically disabled. For example, if using
+`wasi:http/incoming-handler` manually, the `fetch-event` cannot be used.
+
 ## Using StarlingMonkey's `fetch-event`
 
-The StarlingMonkey engine provides the ability to use `fetchEvent` to handle calls to `wasi:http/[email protected]#handle`. When targeting worlds that export `wasi:http/[email protected]` the fetch event will automatically be attached. Alternatively, to override the fetch event with a custom handler, export an explicit `incomingHandler` or `'wasi:http/[email protected]'` object. Using the `fetchEvent` requires enabling the `http` feature.
+The StarlingMonkey engine provides the ability to use `fetchEvent` to handle calls to `wasi:http/[email protected]#handle`.
+
+When targeting worlds that export `wasi:http/[email protected]` the fetch event will automatically be attached. Alternatively,
+to override the fetch event with a custom handler, export an explicit `incomingHandler` or `'wasi:http/[email protected]'`
+object. Using the `fetchEvent` requires enabling the `http` feature.
+
+> [!WARNING]
+> If using `fetch-event`, ensure that you *do not* manually import (i.e. exporting `incomingHandler` from your ES module).
+>
+> Modules that export `incomingHandler` and have the `http` feature enabled are assumed to be using `wasi:http` manually.
 
 ## API
 
@@ -206,7 +219,7 @@ export function componentize(opts: {
   debugBuild?: bool,
   engine?: string,
   preview2Adapter?: string,
-  disableFeatures?: ('stdio' | 'random' | 'clocks' | 'http')[],
+  disableFeatures?: ('stdio' | 'random' | 'clocks' | 'http', 'fetch-event')[],
 }): {
   component: Uint8Array,
   imports: string[]

crates/spidermonkey-embedding-splicer/src/bin/splicer.rs

@@ -50,6 +50,10 @@ enum Commands {
         #[arg(short, long)]
         out_dir: PathBuf,
 
+        /// Features to enable (multiple allowed)
+        #[arg(short, long)]
+        features: Vec<String>,
+
         /// Path to WIT file or directory
         #[arg(long)]
         wit_path: Option<PathBuf>,
@@ -99,6 +103,7 @@ fn main() -> Result<()> {
         Commands::SpliceBindings {
             input,
             out_dir,
+            features,
             wit_path,
             world_name,
             debug,
@@ -113,8 +118,15 @@ fn main() -> Result<()> {
 
             let wit_path_str = wit_path.as_ref().map(|p| p.to_string_lossy().to_string());
 
-            let result = splice::splice_bindings(engine, world_name, wit_path_str, None, debug)
-                .map_err(|e| anyhow::anyhow!(e))?;
+            let features = features
+                .iter()
+                .map(|v| Features::from_str(v))
+                .collect::<Result<Vec<_>>>()?;
+
+            let result =
+                splice::splice_bindings(engine, features, None, wit_path_str, world_name, debug)
+                    .map_err(|e| anyhow::anyhow!(e))?;
+
             fs::write(out_dir.join("component.wasm"), result.wasm).with_context(|| {
                 format!(
                     "Failed to write output file: {}",

crates/spidermonkey-embedding-splicer/src/bindgen.rs

@@ -19,6 +19,8 @@ use wit_component::StringEncoding;
 use wit_parser::abi::WasmType;
 use wit_parser::abi::{AbiVariant, WasmSignature};
 
+use crate::wit::exports::local::spidermonkey_embedding_splicer::splicer::Features;
+
 use crate::{uwrite, uwriteln};
 
 #[derive(Debug)]
@@ -104,6 +106,9 @@ struct JsBindgen<'a> {
     resource_directions: HashMap<TypeId, AbiVariant>,
 
     imported_resources: BTreeSet<TypeId>,
+
+    /// Features that were enabled at the time of generation
+    features: &'a Vec<Features>,
 }
 
 #[derive(Debug)]
@@ -131,7 +136,11 @@ pub struct Componentization {
     pub resource_imports: Vec<(String, String, u32)>,
 }
 
-pub fn componentize_bindgen(resolve: &Resolve, wid: WorldId) -> Result<Componentization> {
+pub fn componentize_bindgen(
+    resolve: &Resolve,
+    wid: WorldId,
+    features: &Vec<Features>,
+) -> Result<Componentization> {
     let mut bindgen = JsBindgen {
         src: Source::default(),
         esm_bindgen: EsmBindgen::default(),
@@ -146,6 +155,7 @@ pub fn componentize_bindgen(resolve: &Resolve, wid: WorldId) -> Result<Component
         imports: Vec::new(),
         resource_directions: HashMap::new(),
         imported_resources: BTreeSet::new(),
+        features,
     };
 
     bindgen.sizes.fill(resolve);
@@ -390,57 +400,17 @@ impl JsBindgen<'_> {
         intrinsic.name().to_string()
     }
 
-    fn exports_bindgen(
-        &mut self,
-        // guest_exports: &Option<Vec<String>>,
-        // features: Vec<Features>,
-    ) -> Result<()> {
+    fn exports_bindgen(&mut self) -> Result<()> {
         for (key, export) in &self.resolve.worlds[self.world].exports {
             let name = self.resolve.name_world_key(key);
-            // Do not generate exports when the guest export is not implemented.
-            // We check both the full interface name - "ns:pkg@v/my-interface" and the
-            // aliased interface name "myInterface". All other names are always
-            // camel-case in the check.
-            // match key {
-            //     WorldKey::Interface(iface) => {
-            //         if !guest_exports.contains(&name) {
-            //             let iface = &self.resolve.interfaces[*iface];
-            //             if let Some(iface_name) = iface.name.as_ref() {
-            //                 let camel_case_name = iface_name.to_lower_camel_case();
-            //                 if !guest_exports.contains(&camel_case_name) {
-            //                     // For wasi:http/incoming-handler, we treat it
-            //                     // as a special case as the engine already
-            //                     // provides the export using fetchEvent and that
-            //                     // can be used when an explicit export is not
-            //                     // defined by the guest content.
-            //                     if iface_name == "incoming-handler"
-            //                         || name.starts_with("wasi:http/[email protected].")
-            //                     {
-            //                         if !features.contains(&Features::Http) {
-            //                             bail!(
-            //                                 "JS export definition for '{}' not found. Cannot use fetchEvent because the http feature is not enabled.",
-            //                                 camel_case_name
-            //                             )
-            //                         }
-            //                         continue;
-            //                     }
-            //                     bail!("Expected a JS export definition for '{}'", camel_case_name);
-            //                 }
-            //                 // TODO: move populate_export_aliases to a preprocessing
-            //                 // step that doesn't require esm_bindgen, so that we can
-            //                 // do alias deduping here as well.
-            //             } else {
-            //                 continue;
-            //             }
-            //         }
-            //     }
-            //     WorldKey::Name(export_name) => {
-            //         let camel_case_name = export_name.to_lower_camel_case();
-            //         if !guest_exports.contains(&camel_case_name) {
-            //             bail!("Expected a JS export definition for '{}'", camel_case_name);
-            //         }
-            //     }
-            // }
+
+            // Skip bindings generation for wasi:http/incoming-handler if the fetch-event
+            // feature was enabled. We expect that the built-in engine implementation will be used
+            if name.starts_with("wasi:http/[email protected].")
+                && self.features.contains(&Features::FetchEvent)
+            {
+                continue;
+            }
 
             match export {
                 WorldItem::Function(func) => {

crates/spidermonkey-embedding-splicer/src/splice.rs

@@ -18,7 +18,7 @@ use wit_parser::Resolve;
 
 use crate::bindgen::BindingItem;
 use crate::wit::exports::local::spidermonkey_embedding_splicer::splicer::{
-    CoreFn, CoreTy, SpliceResult,
+    CoreFn, CoreTy, Features, SpliceResult,
 };
 use crate::{bindgen, map_core_fn, parse_wit, splice};
 
@@ -32,9 +32,10 @@ use crate::{bindgen, map_core_fn, parse_wit, splice};
 // }
 pub fn splice_bindings(
     engine: Vec<u8>,
-    world_name: Option<String>,
-    wit_path: Option<String>,
+    features: Vec<Features>,
     wit_source: Option<String>,
+    wit_path: Option<String>,
+    world_name: Option<String>,
     debug: bool,
 ) -> Result<SpliceResult, String> {
     let (mut resolve, id) = match (wit_source, wit_path) {
@@ -60,6 +61,7 @@ pub fn splice_bindings(
         wit_component::dummy_module(&resolve, world, wit_parser::ManglingAndAbi::Standard32);
 
     // merge the engine world with the target world, retaining the engine producers
+
     let (engine_world, producers) = if let Ok((
         _,
         Bindgen {
@@ -113,7 +115,7 @@ pub fn splice_bindings(
     };
 
     let componentized =
-        bindgen::componentize_bindgen(&resolve, world).map_err(|err| err.to_string())?;
+        bindgen::componentize_bindgen(&resolve, world, &features).map_err(|err| err.to_string())?;
 
     resolve
         .merge_worlds(engine_world, world)
@@ -255,7 +257,8 @@ pub fn splice_bindings(
         ));
     }
 
-    let mut wasm = splice::splice(engine, imports, exports, debug).map_err(|e| format!("{e:?}"))?;
+    let mut wasm =
+        splice::splice(engine, imports, exports, features, debug).map_err(|e| format!("{e:?}"))?;
 
     // add the world section to the spliced wasm
     wasm.push(section.id());
@@ -337,19 +340,25 @@ pub fn splice(
     engine: Vec<u8>,
     imports: Vec<(String, String, CoreFn, Option<i32>)>,
     exports: Vec<(String, CoreFn)>,
+    features: Vec<Features>,
     debug: bool,
 ) -> Result<Vec<u8>> {
     let mut module = Module::parse(&engine, false).unwrap();
 
     // since StarlingMonkey implements CLI Run and incoming handler,
     // we override them only if the guest content exports those functions
     remove_if_exported_by_js(&mut module, &exports, "wasi:cli/[email protected].", "#run");
-    remove_if_exported_by_js(
-        &mut module,
-        &exports,
-        "wasi:http/[email protected].",
-        "#handle",
-    );
+
+    // if 'fetch-event' feature is disabled (default being default-enabled),
+    // remove the built-in incoming-handler which is built around it's use.
+    if !features.contains(&Features::FetchEvent) {
+        remove_if_exported_by_js(
+            &mut module,
+            &exports,
+            "wasi:http/[email protected].",
+            "#handle",
+        );
+    }
 
     // we reencode the WASI world component data, so strip it out from the
     // custom section

crates/spidermonkey-embedding-splicer/src/stub_wasi.rs

@@ -139,7 +139,7 @@ pub fn stub_wasi(
         stub_stdio(&mut module)?;
     }
 
-    if !features.contains(&Features::Http) {
+    if !features.contains(&Features::Http) && !features.contains(&Features::FetchEvent) {
         stub_http(&mut module)?;
     }
 

crates/spidermonkey-embedding-splicer/src/wit.rs

@@ -16,6 +16,7 @@ impl std::str::FromStr for Features {
             "clocks" => Ok(Features::Clocks),
             "random" => Ok(Features::Random),
             "http" => Ok(Features::Http),
+            "fetch-event" => Ok(Features::FetchEvent),
             _ => bail!("unrecognized feature string [{s}]"),
         }
     }

crates/spidermonkey-embedding-splicer/wit/spidermonkey-embedding-splicer.wit

@@ -13,6 +13,7 @@ interface splicer {
     clocks,
     random,
     http,
+    fetch-event,
   }
 
   record core-fn {

crates/splicer-component/src/lib.rs

@@ -1,7 +1,7 @@
 use spidermonkey_embedding_splicer::stub_wasi::stub_wasi;
 use spidermonkey_embedding_splicer::wit::{self, export};
-use spidermonkey_embedding_splicer::splice;
 use spidermonkey_embedding_splicer::wit::exports::local::spidermonkey_embedding_splicer::splicer::{Features, Guest, SpliceResult};
+use spidermonkey_embedding_splicer::splice;
 
 struct SpidermonkeyEmbeddingSplicerComponent;
 
@@ -18,13 +18,13 @@ impl Guest for SpidermonkeyEmbeddingSplicerComponent {
 
     fn splice_bindings(
         engine: Vec<u8>,
-        _features: Vec<Features>,
-        world_name: Option<String>,
-        wit_path: Option<String>,
+        features: Vec<Features>,
         wit_source: Option<String>,
+        wit_path: Option<String>,
+        world_name: Option<String>,
         debug: bool,
     ) -> Result<SpliceResult, String> {
-        splice::splice_bindings(engine, wit_source, wit_path, world_name, debug)
+        splice::splice_bindings(engine, features, wit_source, wit_path, world_name, debug)
     }
 }