islands_build/

patch.rs

//! The V8 module-namespace patch — a first-class, tested, public part of the
//! build contract.
//!
//! Each page's wasm-bindgen-emitted JS imports `* as import1` from the shared
//! `islands-core` URL and passes that namespace directly to
//! `WebAssembly.instantiate` as the importObject value. V8 rejects
//! module-namespace objects there with `Import #N "<url>": module is not an
//! object or function`. We patch the emitted JS so the namespace is spread into a
//! plain prototype-less object — same shape, V8 accepts it. **Skipping this is
//! fatal: the page WASM does not load.**
//!
//! Under a content-hashing build, the hashing pass rewrites basenames inside every
//! JS file (e.g. `islands_core.js` → `islands_core.a1b2c3d4.js`); the patch token
//! [`PATCH_TOKEN`] MUST survive that rewrite, and the importObject *key* for the
//! runtime is surgically restored to its unhashed form (see
//! [`rewrite_basenames_in_js`]) so it matches the WASM's compiled import-module
//! name.

use std::fs;
use std::path::Path;

use anyhow::{Context, Result};

/// The runtime's fixed, never-hashed import URL — baked into every page WASM's
/// import section by wasm-bindgen's `raw_module = "..."`.
pub const RUNTIME_IMPORT_URL: &str = "/static/islands-core/islands_core.js";

/// Literal substring present in every patched page JS. Build verification and the
/// content-hash pass both assert this token is present (and survives hashing).
pub const PATCH_TOKEN: &str = "Object.assign(Object.create(null), import1)";

/// The literal pre-patch line wasm-bindgen emits for the page→core import value.
const NEEDLE: &str = "\"/static/islands-core/islands_core.js\": import1,";

/// The post-patch replacement line.
const PATCHED: &str =
    "\"/static/islands-core/islands_core.js\": Object.assign(Object.create(null), import1),";

/// Apply the V8 namespace patch to a page's emitted JS file, in place.
///
/// Returns `Ok(true)` if patched, `Ok(false)` if the needle was absent (already
/// patched, or wasm-bindgen's output shape changed). Callers that just emitted a
/// fresh bundle should follow up with [`assert_patched`] to turn the second case
/// into a loud failure rather than a silently non-loading bundle.
pub fn patch_page_js(js_path: &Path) -> Result<bool> {
    let content =
        fs::read_to_string(js_path).with_context(|| format!("reading {}", js_path.display()))?;
    if !content.contains(NEEDLE) {
        return Ok(false);
    }
    let new_content = content.replacen(NEEDLE, PATCHED, 1);
    fs::write(js_path, new_content)
        .with_context(|| format!("writing patched {}", js_path.display()))?;
    Ok(true)
}

/// In-memory analogue of [`patch_page_js`] for unit tests.
pub fn patch_page_source(source: &str) -> String {
    if !source.contains(NEEDLE) {
        return source.to_owned();
    }
    source.replacen(NEEDLE, PATCHED, 1)
}

/// Loud guard against wasm-bindgen output-shape drift: assert a freshly emitted
/// page JS actually carries the patch. If neither the patched token nor the raw
/// needle is present, wasm-bindgen changed its emitted shape and [`NEEDLE`] must
/// be updated — fail with a clear message instead of shipping a bundle V8 will
/// reject at runtime.
pub fn assert_patched(js_path: &Path) -> Result<()> {
    let content =
        fs::read_to_string(js_path).with_context(|| format!("reading {}", js_path.display()))?;
    if content.contains(PATCH_TOKEN) {
        return Ok(());
    }
    anyhow::bail!(
        "V8 namespace patch missing from {} — wasm-bindgen's emitted import shape changed. \
         Neither the patch token (`{PATCH_TOKEN}`) nor the expected needle (`{NEEDLE}`) is \
         present. Update islands_build::patch::NEEDLE to match the new wasm-bindgen output.",
        js_path.display()
    )
}

/// In-memory analogue of a content-hashing build's basename rewrite: replace every
/// `original → hashed` basename, then surgically restore the importObject KEY for
/// the runtime to its unhashed form (so the WASM's two-level import still
/// resolves). Mirrors [`crate::hashing`]'s rewrite step.
pub fn rewrite_basenames_in_js(source: &str, rename_map: &[(String, String)]) -> String {
    let mut content = source.to_owned();
    for (original, hashed) in rename_map {
        if content.contains(original.as_str()) {
            content = content.replace(original.as_str(), hashed.as_str());
        }
    }
    for (original, hashed) in rename_map {
        if !original.contains("islands_core.js") {
            continue;
        }
        let rewritten_key_line = format!(
            r#""/static/islands-core/{hashed}": Object.assign(Object.create(null), import1)"#
        );
        let original_key_line = format!(
            r#""/static/islands-core/{original}": Object.assign(Object.create(null), import1)"#
        );
        content = content.replace(&rewritten_key_line, &original_key_line);
    }
    content
}

/// Apply the snippet-namespace patch to the runtime's own JS, in place.
///
/// The `nav` feature's `inline_js` glue makes wasm-bindgen emit
/// `import * as importN from "./snippets/.../inlineK.js"` inside `islands_core.js`
/// and pass that raw module namespace to `WebAssembly.instantiate` — the same V8
/// rejection [`patch_page_js`] dodges. This wraps each such importObject *value*;
/// the *key* (snippet specifier) is left untouched so it keeps matching the WASM's
/// baked import-module name (snippets are excluded from the content-hashing pass
/// for the same reason). Returns `Ok(true)` if anything was wrapped.
pub fn patch_runtime_snippets(js_path: &Path) -> Result<bool> {
    let content =
        fs::read_to_string(js_path).with_context(|| format!("reading {}", js_path.display()))?;
    let patched = wrap_snippet_namespace_imports(&content);
    if patched == content {
        return Ok(false);
    }
    fs::write(js_path, &patched)
        .with_context(|| format!("writing patched {}", js_path.display()))?;
    Ok(true)
}

/// In-memory analogue of [`patch_runtime_snippets`]: wrap every snippet
/// importObject value line. Idempotent; returns the source unchanged when there
/// are no snippet imports (no `inline_js`, or already patched).
pub fn wrap_snippet_namespace_imports(source: &str) -> String {
    let mut changed = false;
    let mut lines: Vec<String> = Vec::with_capacity(source.lines().count());
    for line in source.lines() {
        match wrap_snippet_import_value(line) {
            Some(wrapped) => {
                lines.push(wrapped);
                changed = true;
            }
            None => lines.push(line.to_owned()),
        }
    }
    if !changed {
        return source.to_owned();
    }
    let mut output = lines.join("\n");
    if source.ends_with('\n') {
        output.push('\n');
    }
    output
}

/// If `line` is a snippet importObject *value* entry of the shape
/// `    "<…/snippets/…>.js": importN,`, return it with the bare `importN`
/// namespace wrapped in `Object.assign(Object.create(null), importN)`. `None` for
/// any other line — including the `import * as …` statement (no `": "` value
/// separator), a single-quoted named import, or an already-wrapped value.
fn wrap_snippet_import_value(line: &str) -> Option<String> {
    if !line.contains("/snippets/") {
        return None;
    }
    let separator = "\": ";
    let separator_index = line.find(separator)?;
    let key_through_separator = &line[..separator_index + separator.len()];
    let value_part = line[separator_index + separator.len()..].trim_end();
    let identifier = value_part.strip_suffix(',')?;
    // Must be a bare `import<digits>` namespace identifier — not an already
    // wrapped `Object.assign(...)` value.
    let digits = identifier.strip_prefix("import")?;
    if digits.is_empty() || !digits.bytes().all(|byte| byte.is_ascii_digit()) {
        return None;
    }
    Some(format!(
        "{key_through_separator}Object.assign(Object.create(null), {identifier}),"
    ))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn patches_the_page_core_import_value() {
        let source = format!("    {NEEDLE}\n");
        let patched = patch_page_source(&source);
        assert!(patched.contains(PATCH_TOKEN), "got: {patched}");
    }

    #[test]
    fn page_patch_is_idempotent_in_memory() {
        let once = patch_page_source(&format!("    {NEEDLE}\n"));
        let twice = patch_page_source(&once);
        assert_eq!(once, twice);
    }

    #[test]
    fn wraps_snippet_importobject_namespace_value() {
        let source = "    \"./snippets/islands-runtime-abc/inline0.js\": import1,\n";
        let output = wrap_snippet_namespace_imports(source);
        assert!(
            output.contains(
                "\"./snippets/islands-runtime-abc/inline0.js\": Object.assign(Object.create(null), import1),"
            ),
            "snippet importObject value must be namespace-wrapped; got: {output}"
        );
    }

    #[test]
    fn leaves_import_statement_and_non_snippet_lines_untouched() {
        let source = concat!(
            "import * as import1 from \"./snippets/islands-runtime-abc/inline0.js\";\n",
            "    \"__wbindgen_placeholder__\": import1,\n",
        );
        assert_eq!(wrap_snippet_namespace_imports(source), source);
    }

    #[test]
    fn snippet_wrap_is_idempotent() {
        let source = "    \"./snippets/x/inline0.js\": import2,\n";
        let once = wrap_snippet_namespace_imports(source);
        let twice = wrap_snippet_namespace_imports(&once);
        assert_eq!(once, twice, "re-running the wrap must be a no-op");
    }

    #[test]
    fn page_patch_token_survives_basename_rewrite() {
        // The patch token must survive the content-hash rewrite, and the
        // importObject key for the runtime must be restored to its unhashed form.
        let patched = patch_page_source(&format!("    {NEEDLE}\n"));
        let rename_map = vec![(
            "islands_core.js".to_owned(),
            "islands_core.deadbeef.js".to_owned(),
        )];
        let after = rewrite_basenames_in_js(&patched, &rename_map);
        assert!(after.contains(PATCH_TOKEN), "patch token lost: {after}");
        assert!(
            after.contains("/static/islands-core/islands_core.js\":"),
            "runtime importObject key must be restored unhashed: {after}"
        );
    }

    #[test]
    fn snippet_key_stays_unhashed_through_rewrite() {
        let wrapped = wrap_snippet_namespace_imports("    \"./snippets/r/inline0.js\": import1,\n");
        let rename_map = vec![(
            "islands_core.js".to_owned(),
            "islands_core.deadbeef.js".to_owned(),
        )];
        let after = rewrite_basenames_in_js(&wrapped, &rename_map);
        assert!(
            after.contains(
                "\"./snippets/r/inline0.js\": Object.assign(Object.create(null), import1),"
            ),
            "snippet key must stay unhashed and the wrap must survive; got: {after}"
        );
    }
}