sails_cli/

idlgen.rs

use anyhow::{Context, bail};
use cargo_metadata::{DependencyKind, Package, PackageId, camino::*, semver::VersionReq};
use convert_case::{Case, Casing};
use std::{
    collections::{HashMap, HashSet},
    env, fs,
    path::{Path, PathBuf},
    process::{Command, ExitStatus},
};

const META_PATH: &[&str] = &["sails_idl_meta", "ProgramMeta"];
const ICON_BUILD: &str = "🔨";
const ICON_DONE: &str = "✅";
const ICON_ERROR: &str = "❌";

pub struct CrateIdlGenerator {
    manifest_path: Utf8PathBuf,
    target_dir: Option<Utf8PathBuf>,
    deps_level: usize,
    program_name: Option<String>,
}

impl CrateIdlGenerator {
    pub fn new(
        manifest_path: Option<PathBuf>,
        target_dir: Option<PathBuf>,
        deps_level: Option<usize>,
        program_name: Option<String>,
    ) -> Self {
        Self {
            manifest_path: Utf8PathBuf::from_path_buf(
                manifest_path.unwrap_or_else(|| env::current_dir().unwrap().join("Cargo.toml")),
            )
            .unwrap(),
            target_dir: target_dir
                .and_then(|p| p.canonicalize().ok())
                .map(Utf8PathBuf::from_path_buf)
                .and_then(|t| t.ok()),
            deps_level: deps_level.unwrap_or(1),
            program_name,
        }
    }

    pub fn generate(self) -> anyhow::Result<()> {
        println!("...reading metadata: {}", &self.manifest_path);
        // get metadata with deps
        let metadata = cargo_metadata::MetadataCommand::new()
            .manifest_path(&self.manifest_path)
            .exec()?;

        // find `sails-rs` packages (any version )
        let sails_packages = metadata
            .packages
            .iter()
            .filter(|&p| p.name == "sails-rs")
            .collect::<Vec<_>>();
        if sails_packages.is_empty() {
            bail!("`sails-rs` package not found");
        }

        let target_dir = self
            .target_dir
            .as_ref()
            .unwrap_or(&metadata.target_directory);

        let package_list = get_package_list(&metadata, self.deps_level)?;
        println!(
            "...looking for Program implementation in {} package(s)",
            package_list.len()
        );
        for program_package in package_list {
            let idl_gen = PackageIdlGenerator::new(
                program_package,
                &sails_packages,
                target_dir,
                &metadata.workspace_root,
                self.program_name.clone(),
            );
            match get_program_struct_path_from_doc(program_package, target_dir) {
                Ok(program_struct_path) => {
                    println!("...found Program implementation: {program_struct_path}");
                    let file_path = idl_gen.try_generate_for_package(&program_struct_path)?;
                    println!("{ICON_DONE} Generated IDL: {file_path}");

                    return Ok(());
                }
                Err(err) => {
                    println!("{ICON_ERROR} no Program implementation found: {err}");
                }
            }
        }
        Err(anyhow::anyhow!("no Program implementation found"))
    }
}

struct PackageIdlGenerator<'a> {
    program_package: &'a Package,
    sails_packages: &'a Vec<&'a Package>,
    target_dir: &'a Utf8Path,
    workspace_root: &'a Utf8Path,
    program_name: Option<String>,
}

impl<'a> PackageIdlGenerator<'a> {
    fn new(
        program_package: &'a Package,
        sails_packages: &'a Vec<&'a Package>,
        target_dir: &'a Utf8Path,
        workspace_root: &'a Utf8Path,
        program_name: Option<String>,
    ) -> Self {
        Self {
            program_package,
            sails_packages,
            target_dir,
            workspace_root,
            program_name,
        }
    }

    fn try_generate_for_package(&self, program_struct_path: &str) -> anyhow::Result<Utf8PathBuf> {
        // find `sails-rs` dependency kind `Normal`
        let sails_dep = self
            .program_package
            .dependencies
            .iter()
            .find(|p| p.name == "sails-rs" && p.kind == DependencyKind::Normal)
            .context("failed to find `sails-rs` dependency")?;
        // collect features, e.g. ["ethexe"]
        let sails_features = &sails_dep.features;
        println!(
            "...found `sails-rs` dep with features: {:?}",
            sails_features
        );
        // find `sails-rs` package matches dep version
        let sails_package = self
            .sails_packages
            .iter()
            .find(|p| sails_dep.req == VersionReq::STAR || sails_dep.req.matches(&p.version))
            .context(format!(
                "failed to find `sails-rs` package with matching version {}",
                &sails_dep.req
            ))?;

        let crate_name = &get_idl_gen_crate_name(self.program_package);
        let crate_dir = &self.target_dir.join(crate_name);
        let src_dir = crate_dir.join("src");
        fs::create_dir_all(&src_dir)?;

        let gen_manifest_path = crate_dir.join("Cargo.toml");
        write_file(
            &gen_manifest_path,
            gen_cargo_toml(self.program_package, sails_package, sails_features),
        )?;

        let out_file = self
            .target_dir
            .join(format!("{}.idl", &self.program_package.name));
        let program_name = self
            .program_name
            .clone()
            .unwrap_or_else(|| self.program_package.name.to_case(Case::Pascal));
        let main_rs_path = src_dir.join("main.rs");
        write_file(
            main_rs_path,
            gen_main_rs(program_struct_path, &program_name, &out_file),
        )?;

        let from_lock = &self.workspace_root.join("Cargo.lock");
        let to_lock = &crate_dir.join("Cargo.lock");
        drop(fs::copy(from_lock, to_lock));

        println!("{ICON_BUILD} cargo run --bin {crate_name}");
        let res = cargo_run_bin(&gen_manifest_path, crate_name, self.target_dir);

        fs::remove_dir_all(crate_dir)?;

        match res {
            Ok(exit_status) if exit_status.success() => Ok(out_file),
            Ok(exit_status) => Err(anyhow::anyhow!("Exit status: {}", exit_status)),
            Err(err) => Err(err),
        }
    }
}

/// Get list of packages from the root package and its dependencies
fn get_package_list(
    metadata: &cargo_metadata::Metadata,
    deps_level: usize,
) -> Result<Vec<&Package>, anyhow::Error> {
    let resolve = metadata
        .resolve
        .as_ref()
        .context("failed to get resolve from metadata")?;
    let root_package_id = resolve
        .root
        .as_ref()
        .context("failed to find root package")?;
    let node_map = resolve
        .nodes
        .iter()
        .map(|n| (&n.id, n))
        .collect::<HashMap<_, _>>();
    let package_map = metadata
        .packages
        .iter()
        .map(|p| (&p.id, p))
        .collect::<HashMap<_, _>>();

    let mut deps_set: HashSet<&PackageId> = HashSet::new();
    deps_set.insert(root_package_id);

    let mut deps = vec![root_package_id];
    for _ in 0..deps_level {
        deps = deps
            .iter()
            .filter_map(|id| node_map.get(id))
            .flat_map(|&n| &n.dependencies)
            .filter(|&id| metadata.workspace_members.contains(id))
            .collect();
        if deps.is_empty() {
            break;
        }
        deps_set.extend(deps.iter());
    }
    let package_list: Vec<&Package> = deps_set
        .iter()
        .filter_map(|id| package_map.get(id))
        .copied()
        .collect();
    Ok(package_list)
}

fn get_program_struct_path_from_doc(
    program_package: &Package,
    target_dir: &Utf8Path,
) -> anyhow::Result<String> {
    let program_package_file_name = program_package.name.to_lowercase().replace('-', "_");
    println!(
        "...running doc generation for `{}`",
        program_package.manifest_path
    );
    // run `cargo doc`
    _ = cargo_doc(&program_package.manifest_path, target_dir)?;
    // read doc
    let docs_path = target_dir
        .join("doc")
        .join(format!("{}.json", &program_package_file_name));
    println!("...reading doc: {docs_path}");
    let json_string = std::fs::read_to_string(docs_path)?;
    let doc_crate: rustdoc_types::Crate = serde_json::from_str(&json_string)?;

    // find `sails_rs::meta::ProgramMeta` path id
    let program_meta_id = doc_crate
        .paths
        .iter()
        .find_map(|(id, summary)| (summary.path == META_PATH).then_some(id))
        .context("failed to find `sails_rs::meta::ProgramMeta` definition in dependencies")?;
    // find struct implementing `sails_rs::meta::ProgramMeta`
    let program_struct_path = doc_crate
        .index
        .values()
        .find_map(|idx| try_get_trait_implementation_path(idx, program_meta_id))
        .context("failed to find `sails_rs::meta::ProgramMeta` implementation")?;
    let program_struct = doc_crate
        .paths
        .get(&program_struct_path.id)
        .context("failed to get Program struct by id")?;
    let program_struct_path = program_struct.path.join("::");
    Ok(program_struct_path)
}

fn try_get_trait_implementation_path(
    idx: &rustdoc_types::Item,
    program_meta_id: &rustdoc_types::Id,
) -> Option<rustdoc_types::Path> {
    if let rustdoc_types::ItemEnum::Impl(item) = &idx.inner
        && let Some(tp) = &item.trait_
        && &tp.id == program_meta_id
        && let rustdoc_types::Type::ResolvedPath(path) = &item.for_
    {
        return Some(path.clone());
    }
    None
}

fn get_idl_gen_crate_name(program_package: &Package) -> String {
    format!("{}-idl-gen", program_package.name)
}

fn write_file<P: AsRef<Path>, C: AsRef<[u8]>>(path: P, contents: C) -> anyhow::Result<()> {
    let path = path.as_ref();
    fs::write(path, contents.as_ref())
        .with_context(|| format!("failed to write `{}`", path.display()))
}

fn cargo_doc(
    manifest_path: &cargo_metadata::camino::Utf8Path,
    target_dir: &cargo_metadata::camino::Utf8Path,
) -> anyhow::Result<ExitStatus> {
    let cargo_path = std::env::var("CARGO").unwrap_or("cargo".into());

    let mut cmd = Command::new(cargo_path);
    cmd.env("RUSTC_BOOTSTRAP", "1")
        .env(
            "RUSTDOCFLAGS",
            "-Z unstable-options --output-format=json --cap-lints=allow",
        )
        .env("__GEAR_WASM_BUILDER_NO_BUILD", "1")
        .stdout(std::process::Stdio::null()) // Don't pollute output
        .arg("doc")
        .arg("--manifest-path")
        .arg(manifest_path.as_str())
        .arg("--target-dir")
        .arg(target_dir.as_str())
        .arg("--no-deps")
        .arg("--quiet");

    cmd.status()
        .context("failed to execute `cargo doc` command")
}

fn cargo_run_bin(
    manifest_path: &cargo_metadata::camino::Utf8Path,
    bin_name: &str,
    target_dir: &cargo_metadata::camino::Utf8Path,
) -> anyhow::Result<ExitStatus> {
    let cargo_path = std::env::var("CARGO").unwrap_or("cargo".into());

    let mut cmd = Command::new(cargo_path);
    cmd.env("CARGO_TARGET_DIR", target_dir)
        .env("__GEAR_WASM_BUILDER_NO_BUILD", "1")
        .stdout(std::process::Stdio::null()) // Don't pollute output
        .arg("run")
        .arg("--manifest-path")
        .arg(manifest_path.as_str())
        .arg("--bin")
        .arg(bin_name);
    cmd.status().context("failed to execute `cargo` command")
}

fn gen_cargo_toml(
    program_package: &Package,
    sails_package: &Package,
    sails_features: &[String],
) -> String {
    let mut manifest = toml_edit::DocumentMut::new();
    manifest["package"] = toml_edit::Item::Table(toml_edit::Table::new());
    manifest["package"]["name"] = toml_edit::value(get_idl_gen_crate_name(program_package));
    manifest["package"]["version"] = toml_edit::value("0.1.0");
    manifest["package"]["edition"] = toml_edit::value(program_package.edition.as_str());

    let mut dep_table = toml_edit::Table::default();
    let mut package_table = toml_edit::InlineTable::new();
    let manifest_dir = program_package.manifest_path.parent().unwrap();
    package_table.insert("path", manifest_dir.as_str().into());
    dep_table[&program_package.name] = toml_edit::value(package_table);

    let sails_dep = sails_dep_v2(sails_package, sails_features);
    dep_table[&sails_package.name] = toml_edit::value(sails_dep);

    manifest["dependencies"] = toml_edit::Item::Table(dep_table);

    let mut bin = toml_edit::Table::new();
    bin["name"] = toml_edit::value(get_idl_gen_crate_name(program_package));
    bin["path"] = toml_edit::value("src/main.rs");
    manifest["bin"]
        .or_insert(toml_edit::Item::ArrayOfTables(
            toml_edit::ArrayOfTables::new(),
        ))
        .as_array_of_tables_mut()
        .expect("bin is an array of tables")
        .push(bin);

    manifest["workspace"] = toml_edit::Item::Table(toml_edit::Table::new());

    manifest.to_string()
}

fn sails_dep_v2(sails_package: &Package, sails_features: &[String]) -> toml_edit::InlineTable {
    let mut features = toml_edit::Array::default();
    features.push("idl-gen");
    features.push("std");
    features.extend(sails_features);
    let mut sails_table = toml_edit::InlineTable::new();
    let manifest_dir = sails_package.manifest_path.parent().unwrap();
    sails_table.insert("package", sails_package.name.as_str().into());
    sails_table.insert("path", manifest_dir.as_str().into());
    sails_table.insert("features", features.into());
    sails_table
}

fn gen_main_rs(
    program_struct_path: &str,
    program_name: &str,
    out_file: &cargo_metadata::camino::Utf8Path,
) -> String {
    format!(
        "
fn main() {{
    sails_rs::generate_idl_to_file::<{}>(
        Some(r\"{}\"),
        std::path::PathBuf::from(r\"{}\")
    )
    .unwrap();
}}",
        program_struct_path,
        program_name,
        out_file.as_str(),
    )
}