whisker-build 0.2.1

//! Whisker module-system — discovery + manifest parsing.
//!
//! When `whisker run` builds an app crate for
//! iOS or Android, every cargo dependency may optionally contribute
//! native code (Swift / Obj-C++ on iOS, Kotlin / JNI on Android) to
//! the final host binary. A crate opts in by declaring a
//! `[package.metadata.whisker]` table in its `Cargo.toml`. The
//! Whisker CLI walks the consuming app's dep graph via `cargo
//! metadata`, picks out every dependency carrying that table, and
//! feeds the per-platform source paths through to the
//! platform-specific build step.
//!
//! This module is platform-neutral — it just produces the
//! `ResolvedModule` list. `whisker-build::ios` and
//! `whisker-build::android` consume the list and decide what to do
//! with each module (the SwiftPM aggregator on iOS, the gradle
//! settings include on Android).
//!
//! ## Schema
//!
//! ```toml
//! # packages/whisker-video/Cargo.toml
//! [package.metadata.whisker]
//! # The bare table is the marker — its presence identifies this
//! # crate as a Whisker module. Platform code + build manifests live
//! # at the package root in `android/` and `ios/` (Expo-style):
//! #   android/build.gradle.kts   — AGP library
//! #   ios/Package.swift          — SwiftPM library
//! # whisker-build discovers those per-platform manifests directly,
//! # so no source-file list is needed for DSL modules.
//! ```
//!
//! Older revisions also accepted `[package.metadata.whisker.ios]
//! native_sources = [...]` to declare raw Obj-C++ files compiled
//! into the host dylib's bridge — that path was rewired through
//! `WHISKER_IOS_MODULE_NATIVE_SOURCES` + the Lynx-header stage in
//! `whisker-driver-sys/build.rs`, and required Whisker to download
//! the Lynx iOS tarball just to satisfy PrimJS `#include`s. No
//! module in this monorepo (or in any external module surveyed)
//! ever declared `native_sources`, so the field is no longer
//! recognised — re-introducing iOS Obj-C++ sources can be done
//! cleanly through SwiftPM target dependencies in `ios/Package.swift`
//! without re-creating the bespoke env-var plumbing.
//!
//! All paths are resolved relative to the directory containing the
//! manifest (the crate's `Cargo.toml`). The resolver returns
//! absolute paths so the downstream cc::Build / gradle invocations
//! don't have to know about the module's source layout.
//!
//! Future extensions (e.g. exported headers, link flags, cargo
//! feature gates) land additively under the same table.

use std::path::{Path, PathBuf};

use anyhow::{anyhow, Context, Result};
use cargo_metadata::MetadataCommand;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};

/// Top-level shape of the `[package.metadata.whisker]` table.
///
/// Every section is optional so a module can declare just the
/// platform(s) it supports — the bare table (no sub-sections) is a
/// valid marker for a pure-DSL module that ships only Swift /
/// Kotlin via its `ios/` / `android/` dirs. Unknown sections /
/// fields are rejected to catch typos early (we don't want a
/// typoed `iOS` section to silently produce a no-op build).
#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ManifestRaw {
    #[serde(default)]
    pub ios: Option<IosSectionRaw>,
    #[serde(default)]
    pub android: Option<AndroidSectionRaw>,
    /// `[package.metadata.whisker.plugins.<name>]` entries —
    /// consumed by `whisker_cng::discovery`, not by the module
    /// system. Captured here as raw JSON so its presence doesn't
    /// trip the `deny_unknown_fields` check on this struct.
    /// Validation of the plugin entry's shape lives in
    /// `whisker_cng::discovery::PluginEntryRaw`.
    #[serde(default)]
    pub plugins: Option<serde_json::Value>,
}

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct IosSectionRaw {
    /// Paths to Swift source files that get staged into the
    /// consuming app's gen tree under
    /// `gen/ios/Sources/WhiskerModules/<crate-name>/` and compiled
    /// into the host app target alongside its own Swift sources.
    /// Mirror of `[android].kotlin_sources` for symmetry.
    ///
    /// Largely vestigial in the Expo-style layout: DSL module
    /// authors declare their Swift in `ios/Package.swift`, which
    /// whisker-build discovers directly. Retained for the rare
    /// module that wants raw Swift sources staged outside a SwiftPM
    /// package; existence-checked but otherwise inert.
    #[serde(default)]
    pub swift_sources: Vec<String>,
}

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct AndroidSectionRaw {
    /// Paths to Kotlin / Java source files (`*.kt`, `*.java`) that
    /// should be compiled into the host app's APK alongside the
    /// runtime's own Kotlin sources. Paths are relative to the
    /// manifest's directory.
    ///
    /// Most modules use these to declare a `LynxUI` subclass that
    /// the [`behaviors`] list below points the Lynx engine at.
    #[serde(default)]
    pub kotlin_sources: Vec<String>,
    /// Paths to JNI C / C++ source files (`*.c`, `*.cc`, `*.cpp`)
    /// — for modules that need to drop into native code on Android
    /// (cross-language calls, raw NDK APIs, etc.). Less common than
    /// kotlin_sources; most native_element modules can stay in
    /// Kotlin.
    #[serde(default)]
    pub jni_sources: Vec<String>,
}

/// A single discovered module after its metadata has been resolved
/// against the cargo dep tree. `package` carries the cargo crate
/// name (handy for diagnostics) and `manifest_dir` is the absolute
/// path of the directory the crate's `Cargo.toml` lives in.
#[derive(Debug, Clone)]
pub struct ResolvedModule {
    pub package: String,
    pub manifest_dir: PathBuf,
    /// Absolute, existence-checked paths to `.swift` sources.
    /// Empty when the module declares no Swift contributions.
    pub ios_swift_sources: Vec<PathBuf>,
    /// Absolute, existence-checked paths to Kotlin / Java sources
    /// for the Android build. Empty when the module declares no
    /// Android Kotlin contributions.
    pub android_kotlin_sources: Vec<PathBuf>,
    /// Absolute, existence-checked paths to JNI C / C++ sources
    /// for the Android build. Empty by default — most native_element
    /// modules use Kotlin, not JNI.
    pub android_jni_sources: Vec<PathBuf>,
}

/// Walk the cargo dep graph of `app_package` (resolved at
/// `manifest_path`) and return every dependency that declares a
/// `[package.metadata.whisker]` table in its `Cargo.toml`.
///
/// Ordering: `cargo metadata`'s topological order, deduplicated by
/// package id (a diamond dep landed twice gets resolved once).
/// Downstream consumers can rely on a stable order across calls
/// for the same workspace state.
///
/// Errors:
/// - `cargo metadata` failure (workspace broken, manifest_path
///   invalid, etc.) propagates with the `cargo_metadata` error.
/// - Metadata parse failure (`[package.metadata.whisker]` exists
///   but has unknown sections / fields) propagates with the
///   offending crate name attached.
/// - Native-source path referenced in the table but not present
///   on disk errors with the missing absolute path attached. We
///   prefer eager failure over silently skipping — a missing source
///   almost certainly means the module's metadata is out of sync
///   with its `src/native/` layout.
pub fn discover(manifest_path: &Path, app_package: &str) -> Result<Vec<ResolvedModule>> {
    let metadata = MetadataCommand::new()
        .manifest_path(manifest_path)
        .exec()
        .with_context(|| {
            format!(
                "cargo metadata failed for {} (package: {app_package})",
                manifest_path.display(),
            )
        })?;

    // Find the resolved dep tree rooted at `app_package`. We walk
    // the resolution graph (which encodes activated features /
    // platform deps) rather than `metadata.packages` directly, so
    // we only see deps that would actually be linked into the app.
    let resolve = metadata
        .resolve
        .as_ref()
        .ok_or_else(|| anyhow!("cargo metadata returned no resolve graph"))?;
    let root_id = resolve
        .root
        .as_ref()
        .filter(|id| {
            metadata
                .packages
                .iter()
                .any(|p| &p.id == *id && p.name == app_package)
        })
        .cloned()
        .or_else(|| {
            metadata
                .packages
                .iter()
                .find(|p| p.name == app_package)
                .map(|p| p.id.clone())
        })
        .ok_or_else(|| anyhow!("cargo package `{app_package}` not found in the workspace"))?;

    // BFS the resolution graph. The `nodes` list keys by package
    // id; `deps` carries forward edges.
    let mut visit: Vec<&cargo_metadata::PackageId> = vec![&root_id];
    let mut seen: std::collections::HashSet<&cargo_metadata::PackageId> = Default::default();
    let mut module_pkg_ids: Vec<cargo_metadata::PackageId> = Vec::new();

    while let Some(pkg_id) = visit.pop() {
        if !seen.insert(pkg_id) {
            continue;
        }
        if let Some(node) = resolve.nodes.iter().find(|n| &n.id == pkg_id) {
            for dep in &node.deps {
                visit.push(&dep.pkg);
            }
        }
        // Don't include the root app itself — by convention an app
        // declares native sources directly, not through a
        // `[package.metadata.whisker]` table.
        if pkg_id != &root_id {
            module_pkg_ids.push(pkg_id.clone());
        }
    }

    let mut resolved: Vec<ResolvedModule> = Vec::new();
    for id in module_pkg_ids {
        let pkg = metadata
            .packages
            .iter()
            .find(|p| p.id == id)
            .expect("dep id came from `resolve.nodes`; must exist in metadata.packages");
        // Manifest dir = directory containing this dep's Cargo.toml.
        let manifest_dir = pkg
            .manifest_path
            .parent()
            .map(|p| PathBuf::from(p.as_str()))
            .ok_or_else(|| {
                anyhow!(
                    "dep `{}` manifest_path has no parent: {}",
                    pkg.name,
                    pkg.manifest_path,
                )
            })?;
        // The opt-in marker: a `[package.metadata.whisker]` table.
        // cargo_metadata surfaces `[package.metadata]` as a JSON
        // value; absence is `Value::Null`, so a non-module dep has
        // no `whisker` key and is skipped.
        let Some(whisker_meta) = pkg.metadata.get("whisker") else {
            continue;
        };
        let manifest: ManifestRaw =
            serde_json::from_value(whisker_meta.clone()).with_context(|| {
                format!("parse [package.metadata.whisker] in {}", pkg.manifest_path,)
            })?;
        let mut ios_swift: Vec<PathBuf> = Vec::new();
        if let Some(ios) = manifest.ios {
            for raw_path in ios.swift_sources {
                let resolved_path = manifest_dir.join(&raw_path);
                let canonical = resolved_path.canonicalize().with_context(|| {
                    format!(
                        "module `{}` declares metadata.whisker.ios.swift_sources = \
                         [..., {raw_path:?}] but {} does not exist",
                        pkg.name,
                        resolved_path.display(),
                    )
                })?;
                ios_swift.push(canonical);
            }
        }
        let mut android_kotlin: Vec<PathBuf> = Vec::new();
        let mut android_jni: Vec<PathBuf> = Vec::new();
        if let Some(android) = manifest.android {
            for raw_path in android.kotlin_sources {
                let resolved_path = manifest_dir.join(&raw_path);
                let canonical = resolved_path.canonicalize().with_context(|| {
                    format!(
                        "module `{}` declares metadata.whisker.android.kotlin_sources = \
                         [..., {raw_path:?}] but {} does not exist",
                        pkg.name,
                        resolved_path.display(),
                    )
                })?;
                android_kotlin.push(canonical);
            }
            for raw_path in android.jni_sources {
                let resolved_path = manifest_dir.join(&raw_path);
                let canonical = resolved_path.canonicalize().with_context(|| {
                    format!(
                        "module `{}` declares metadata.whisker.android.jni_sources = \
                         [..., {raw_path:?}] but {} does not exist",
                        pkg.name,
                        resolved_path.display(),
                    )
                })?;
                android_jni.push(canonical);
            }
        }
        resolved.push(ResolvedModule {
            package: pkg.name.clone(),
            manifest_dir,
            ios_swift_sources: ios_swift,
            android_kotlin_sources: android_kotlin,
            android_jni_sources: android_jni,
        });
    }

    // Stable ordering by package name so two consecutive runs produce
    // deterministic gen-tree output (and gradle / cargo don't re-run
    // downstream tasks for spurious permutation reasons).
    resolved.sort_by(|a, b| a.package.cmp(&b.package));
    Ok(resolved)
}

/// Flatten every discovered module's Android Kotlin sources into a
/// colon-separated string. The Android orchestration uses these
/// paths to extend gradle's main source set (see
/// `whisker-build::android`).
pub fn android_kotlin_sources_env_value(modules: &[ResolvedModule]) -> String {
    let mut paths: Vec<String> = Vec::new();
    for m in modules {
        for p in &m.android_kotlin_sources {
            paths.push(p.to_string_lossy().into_owned());
        }
    }
    paths.join(":")
}

/// Same shape, JNI sources. Currently only consumed by the Android
/// orchestration when a module needs C/C++ code on Android (rare;
/// most modules stick to Kotlin).
pub fn android_jni_sources_env_value(modules: &[ResolvedModule]) -> String {
    let mut paths: Vec<String> = Vec::new();
    for m in modules {
        for p in &m.android_jni_sources {
            paths.push(p.to_string_lossy().into_owned());
        }
    }
    paths.join(":")
}

// ----- JSON report for build-system plugins ---------------------------------
//
// The Settings Plugin / SwiftPM Build Tool Plugin can't link against
// this crate (they live in Kotlin / Swift), so they consume module
// discovery through stdout JSON from the `whisker modules`
// subcommand. The shape below is the wire schema — keep it stable
// across releases (additive changes only; rename → version bump).

/// Per-Whisker-module JSON record returned by
/// [`build_modules_report`]. Per-platform fields are `Option` so
/// modules that ship only one platform serialise cleanly (consumers
/// can filter `has_android` / `has_ios` rather than parsing
/// "android": {} stubs).
#[derive(Debug, Clone, Serialize)]
pub struct ModulesReportModule {
    /// Cargo crate name (e.g., `"whisker-router"`).
    pub crate_name: String,
    /// Absolute path to the directory containing the module's
    /// `Cargo.toml`.
    pub manifest_dir: PathBuf,
    /// Android-side surface. `None` when the module has no `android/`
    /// directory at the package root.
    pub android: Option<AndroidModuleReport>,
    /// iOS-side surface. `None` when the module declares neither
    /// `ios_swift_sources` nor an `ios/Package.swift`.
    pub ios: Option<IosModuleReport>,
}

#[derive(Debug, Clone, Serialize)]
pub struct AndroidModuleReport {
    /// Absolute path the Gradle Settings Plugin uses for
    /// `settings.project(":<crate>").projectDir = file(this)`.
    /// This is the package root (manifest_dir) — the Expo-style
    /// layout keeps `build.gradle.kts` at the root and points its
    /// Kotlin source set at the `android/` subdirectory.
    pub subproject_dir: PathBuf,
    /// `<PascalCase(crate_name)>Behaviors` — the KSP-emitted object
    /// name. Lives in package `rs.whisker.runtime.generated`, same as
    /// the aggregator, so the aggregator references it without an
    /// import.
    pub behaviors_class: String,
}

#[derive(Debug, Clone, Serialize)]
pub struct IosModuleReport {
    /// SwiftPM module / framework name. `Some` whenever the module
    /// ships an `ios/Package.swift`; `None` for legacy-shape modules
    /// whose Swift sources are declared via
    /// `[package.metadata.whisker.ios] swift_sources` instead.
    pub swift_module: Option<String>,
    /// `.swift` source paths declared via the legacy
    /// `[package.metadata.whisker.ios] swift_sources = [...]`. Empty
    /// for the common Expo-style case (Swift lives in
    /// `ios/Package.swift`).
    pub swift_sources: Vec<PathBuf>,
}

/// Top-level JSON payload — what `whisker modules` writes to
/// stdout.
#[derive(Debug, Clone, Serialize)]
pub struct ModulesReport {
    /// Hex SHA-256 of the workspace's `Cargo.lock`. Consumers (the
    /// Gradle Settings Plugin) key their disk cache on this — Sync
    /// reuses the cached JSON when the lock file hasn't changed.
    pub cargo_lock_sha256: String,
    /// The user app crate the discovery resolved against. Echoed
    /// back so consumers can sanity-check their `whisker { userPackage = ... }`
    /// declaration matches.
    pub user_package: String,
    /// Stable-ordered (alphabetical by `crate_name`) list of modules.
    pub modules: Vec<ModulesReportModule>,
}

/// Build a [`ModulesReport`] from a workspace + user package. Combines
/// [`discover`], `Cargo.lock` hashing, and per-platform availability
/// classification.
///
/// Detection rules — both follow the Expo-style "manifest at the
/// package root, source under a per-platform subdir":
///   * Android: `<manifest_dir>/build.gradle.kts` exists. The
///     `subproject_dir` reported is `manifest_dir` (the AGP library
///     module is rooted at the package root; its Kotlin source set
///     points at `android/` internally).
///   * iOS: `<manifest_dir>/Package.swift` exists, OR
///     `ios_swift_sources` is non-empty.
pub fn build_modules_report(workspace_root: &Path, user_package: &str) -> Result<ModulesReport> {
    let manifest_path = workspace_root.join("Cargo.toml");
    let resolved = discover(&manifest_path, user_package)
        .with_context(|| format!("discover modules for `{user_package}`"))?;

    let lock_path = workspace_root.join("Cargo.lock");
    let cargo_lock_sha256 =
        sha256_file(&lock_path).with_context(|| format!("hash {}", lock_path.display()))?;

    let modules: Vec<ModulesReportModule> = resolved
        .into_iter()
        .map(|m| {
            let android = if m.manifest_dir.join("build.gradle.kts").is_file() {
                Some(AndroidModuleReport {
                    subproject_dir: m.manifest_dir.clone(),
                    behaviors_class: crate_to_behaviors_class(&m.package),
                })
            } else {
                None
            };
            let swift_pkg = m.manifest_dir.join("Package.swift");
            let has_ios = !m.ios_swift_sources.is_empty() || swift_pkg.is_file();
            let ios = if has_ios {
                Some(IosModuleReport {
                    swift_module: if swift_pkg.is_file() {
                        Some(crate_to_swift_module(&m.package))
                    } else {
                        None
                    },
                    swift_sources: m.ios_swift_sources,
                })
            } else {
                None
            };
            ModulesReportModule {
                crate_name: m.package,
                manifest_dir: m.manifest_dir,
                android,
                ios,
            }
        })
        .collect();

    Ok(ModulesReport {
        cargo_lock_sha256,
        user_package: user_package.to_string(),
        modules,
    })
}

/// `whisker-router` → `WhiskerRouterBehaviors`. Public so the Gradle
/// Project Plugin can derive the same FQN from JSON without re-
/// implementing the rule. (The aggregator only needs the short class
/// name — the FQN is `rs.whisker.runtime.generated.<class>`.)
pub fn crate_to_behaviors_class(crate_name: &str) -> String {
    let mut out = pascal_case(crate_name);
    out.push_str("Behaviors");
    out
}

/// `whisker-router` → `WhiskerRouter`. SwiftPM module names follow
/// the package name in `ios/Package.swift`; the canonical Expo-style
/// layout uses the PascalCase form of the crate name.
pub fn crate_to_swift_module(crate_name: &str) -> String {
    pascal_case(crate_name)
}

fn pascal_case(s: &str) -> String {
    let mut out = String::with_capacity(s.len());
    let mut next_upper = true;
    for ch in s.chars() {
        if ch == '-' || ch == '_' {
            next_upper = true;
            continue;
        }
        if next_upper {
            out.extend(ch.to_uppercase());
            next_upper = false;
        } else {
            out.push(ch);
        }
    }
    out
}

fn sha256_file(path: &Path) -> Result<String> {
    let bytes = std::fs::read(path).with_context(|| format!("read {}", path.display()))?;
    let mut hasher = Sha256::new();
    hasher.update(&bytes);
    Ok(hex(&hasher.finalize()))
}

fn hex(bytes: &[u8]) -> String {
    let mut out = String::with_capacity(bytes.len() * 2);
    for b in bytes {
        out.push_str(&format!("{b:02x}"));
    }
    out
}