use std::path::{Path, PathBuf};
use std::{fs, io};
use anyhow::Context;
use cargo_metadata::Message;
use duct::cmd;
fn cargo_cmd(subcommand: &str, build_debug: bool, args: &[&str]) -> duct::Expression {
duct::cmd(
"cargo",
[
subcommand,
"--config=net.git-fetch-with-cli=true",
"--target=wasm32-unknown-unknown",
]
.into_iter()
.chain((!build_debug).then_some("--release"))
.chain(args.iter().copied()),
)
}
pub(crate) fn build_rust(project_path: &Path, skip_clippy: bool, build_debug: bool) -> anyhow::Result<PathBuf> {
if let Err(err) = cmd!("rustup", "target", "add", "wasm32-unknown-unknown").run() {
println!(
"Warning: Failed to install wasm32-unknown-unknown target: {}. Is `rustup` installed?",
err
);
}
if !skip_clippy {
let clippy_conf_dir = tempfile::tempdir()?;
fs::write(clippy_conf_dir.path().join("clippy.toml"), CLIPPY_TOML)?;
eprintln!("checking crate with spacetimedb's clippy configuration");
let out = cargo_cmd(
"clippy",
build_debug,
&["--", "--no-deps", "-Aclippy::all", "-Dclippy::disallowed-macros"],
)
.dir(project_path)
.env("CLIPPY_DISABLE_DOCS_LINKS", "1")
.env("CLIPPY_CONF_DIR", clippy_conf_dir.path())
.unchecked()
.run()?;
anyhow::ensure!(out.status.success(), "clippy found a lint error");
}
let reader = cargo_cmd("build", build_debug, &["--message-format=json-render-diagnostics"])
.dir(project_path)
.reader()?;
let mut artifact = None;
for message in Message::parse_stream(io::BufReader::new(reader)) {
match message {
Ok(Message::CompilerArtifact(art)) => artifact = Some(art),
Err(error) => return Err(anyhow::anyhow!(error)),
_ => {}
}
}
let artifact = artifact.context("no artifact found?")?;
let artifact = artifact.filenames.into_iter().next().context("no wasm?")?;
check_for_issues(artifact.as_ref())?;
Ok(artifact.into())
}
const CLIPPY_TOML: &str = r#"
disallowed-macros = [
{ path = "std::print", reason = "print!() has no effect inside a spacetimedb module; use log::info!() instead" },
{ path = "std::println", reason = "println!() has no effect inside a spacetimedb module; use log::info!() instead" },
{ path = "std::eprint", reason = "eprint!() has no effect inside a spacetimedb module; use log::warn!() instead" },
{ path = "std::eprintln", reason = "eprintln!() has no effect inside a spacetimedb module; use log::warn!() instead" },
{ path = "std::dbg", reason = "std::dbg!() has no effect inside a spacetimedb module; import spacetime's dbg!() macro instead" },
]
"#;
fn check_for_issues(artifact: &Path) -> anyhow::Result<()> {
let Ok(file) = fs::File::open(artifact) else {
return Ok(());
};
let Ok(module) = wasmbin::Module::decode_from(&mut io::BufReader::new(file)) else {
return Ok(());
};
if has_wasm_bindgen(&module) {
anyhow::bail!(
"wasm-bindgen detected.\n\
\n\
It seems like either you or a crate in your dependency tree is depending on\n\
wasm-bindgen. wasm-bindgen is only for webassembly modules that target the web\n\
platform, and will not work in the context of SpacetimeDB.\n\
\n\
To find the offending dependency, run `cargo tree -i wasm-bindgen`. Try checking\n\
its cargo features for 'js' or 'web' or 'wasm-bindgen' to see if there's a way\n\
to disable it."
)
}
if has_getrandom(&module) {
anyhow::bail!(
"getrandom usage detected.\n\
\n\
It seems like either you or a crate in your dependency tree is depending on\n\
the `getrandom` crate for random number generation. getrandom is the default\n\
randomness source for the `rand` crate, and is used when you call\n\
`rand::random()` or `rand::thread_rng()`. If this is you, you should instead\n\
use `spacetimedb::random()` or `spacetimedb::rng()`. If this is a crate in your\n\
tree, you should try to see if the crate provides a way to pass in a custom\n\
`Rng` type, and pass it the rng returned from `spacetimedb::rng()`."
)
}
Ok(())
}
const WBINDGEN_PREFIX: &str = "__wbindgen";
fn has_wasm_bindgen(module: &wasmbin::Module) -> bool {
let check_import = |import: &wasmbin::sections::Import| {
import.path.module.starts_with(WBINDGEN_PREFIX) || import.path.name.starts_with(WBINDGEN_PREFIX)
};
let check_export = |export: &wasmbin::sections::Export| export.name.starts_with(WBINDGEN_PREFIX);
module
.find_std_section::<wasmbin::sections::payload::Import>()
.and_then(|imports| imports.try_contents().ok())
.is_some_and(|imports| imports.iter().any(check_import))
|| module
.find_std_section::<wasmbin::sections::payload::Export>()
.and_then(|exports| exports.try_contents().ok())
.is_some_and(|exports| exports.iter().any(check_export))
}
fn has_getrandom(module: &wasmbin::Module) -> bool {
module
.find_std_section::<wasmbin::sections::payload::Import>()
.and_then(|imports| imports.try_contents().ok())
.is_some_and(|imports| imports.iter().any(|import| import.path.name == "__getrandom_custom"))
}