Make wasm-builder less spammy (#3020)

* Don't clutter the output that much

* Support building from `crates` or from `path`

* Upgrade the versions

* Update `Cargo.lock`

Author: bkchr

Cargo.lock

@@ -12,7 +12,7 @@ sandbox = { package = "sr-sandbox", path = "../../sr-sandbox", default-features
 substrate-primitives = { path = "../../primitives", default-features = false }
 
 [build-dependencies]
-wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.0" }
+wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.1", path = "../../utils/wasm-builder-runner" }
 
 [features]
 default = [ "std" ]

core/executor/runtime-test/Cargo.toml

@@ -17,5 +17,11 @@
 use wasm_builder_runner::{build_current_project, WasmBuilderSource};
 
 fn main() {
-	build_current_project("wasm_binary.rs", WasmBuilderSource::Crates("1.0.1"));
+	build_current_project(
+		"wasm_binary.rs",
+		WasmBuilderSource::CratesOrPath {
+			path: "../../utils/wasm-builder",
+			version: "1.0.2",
+		},
+	);
 }

core/executor/runtime-test/build.rs

@@ -31,7 +31,7 @@ substrate-executor = { path = "../executor" }
 substrate-test-runtime-client = { path = "./client" }
 
 [build-dependencies]
-wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.0" }
+wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.1", path = "../utils/wasm-builder-runner" }
 
 [features]
 default = [

core/test-runtime/Cargo.toml

@@ -17,5 +17,11 @@
 use wasm_builder_runner::{build_current_project, WasmBuilderSource};
 
 fn main() {
-	build_current_project("wasm_binary.rs", WasmBuilderSource::Crates("1.0.1"));
+	build_current_project(
+		"wasm_binary.rs",
+		WasmBuilderSource::CratesOrPath {
+			path: "../utils/wasm-builder",
+			version: "1.0.2",
+		},
+	);
 }

core/test-runtime/build.rs

@@ -1,6 +1,6 @@
 [package]
 name = "substrate-wasm-builder-runner"
-version = "1.0.0"
+version = "1.0.1"
 authors = ["Parity Technologies <admin@parity.io>"]
 description = "Runner for substrate-wasm-builder"
 edition = "2018"

core/utils/wasm-builder-runner/Cargo.toml

@@ -25,7 +25,7 @@
 //!
 //! For more information see <https://crates.io/substrate-wasm-builder>
 
-use std::{env, process::Command, fs, path::{PathBuf, Path}};
+use std::{env, process::{Command, self}, fs, path::{PathBuf, Path}};
 
 /// Environment variable that tells us to skip building the WASM binary.
 const SKIP_BUILD_ENV: &str = "SKIP_WASM_BUILD";
@@ -56,8 +56,13 @@ pub enum WasmBuilderSource {
 		repo: &'static str,
 		rev: &'static str,
 	},
-	/// Use the given version released on crates.io
+	/// Use the given version released on crates.io.
 	Crates(&'static str),
+	/// Use the given version released on crates.io or from the given path.
+	CratesOrPath {
+		version: &'static str,
+		path: &'static str,
+	}
 }
 
 impl WasmBuilderSource {
@@ -75,6 +80,15 @@ impl WasmBuilderSource {
 			WasmBuilderSource::Crates(version) => {
 				format!("version = \"{}\"", version)
 			}
+			WasmBuilderSource::CratesOrPath { version, path } => {
+				replace_back_slashes(
+					format!(
+						"path = \"{}\", version = \"{}\"",
+						manifest_dir.join(path).display(),
+						version
+					)
+				)
+			}
 		}
 	}
 }
@@ -87,9 +101,9 @@ impl WasmBuilderSource {
 ///               constant `WASM_BINARY` which contains the build wasm binary.
 /// `wasm_builder_path` - Path to the wasm-builder project, relative to `CARGO_MANIFEST_DIR`.
 pub fn build_current_project(file_name: &str, wasm_builder_source: WasmBuilderSource) {
-	generate_rerun_if_changed_instructions();
-
 	if check_skip_build() {
+		// If we skip the build, we still want to make sure to be called when an env variable changes
+		generate_rerun_if_changed_instructions();
 		return;
 	}
 
@@ -110,6 +124,10 @@ pub fn build_current_project(file_name: &str, wasm_builder_source: WasmBuilderSo
 		create_project(&project_folder, &file_path, &manifest_dir, wasm_builder_source, &cargo_toml_path);
 		run_project(&project_folder);
 	}
+
+	// As last step we need to generate our `rerun-if-changed` stuff. If a build fails, we don't
+	// want to spam the output!
+	generate_rerun_if_changed_instructions();
 }
 
 fn create_project(
@@ -164,7 +182,8 @@ fn run_project(project_folder: &Path) {
 	}
 
 	if !cmd.status().map(|s| s.success()).unwrap_or(false) {
-		panic!("Running WASM build runner failed!");
+		// Don't spam the output with backtraces when a build failed!
+		process::exit(1);
 	}
 }
 

core/utils/wasm-builder-runner/src/lib.rs

@@ -1,6 +1,6 @@
 [package]
 name = "substrate-wasm-builder"
-version = "1.0.1"
+version = "1.0.2"
 authors = ["Parity Technologies <admin@parity.io>"]
 description = "Utility for building WASM binaries"
 edition = "2018"

core/utils/wasm-builder/Cargo.toml

@@ -78,7 +78,7 @@
 //! - wasm-gc
 //!
 
-use std::{env, fs, path::PathBuf, process::Command};
+use std::{env, fs, path::PathBuf, process::{Command, Stdio}};
 
 mod prerequisites;
 mod wasm_project;
@@ -156,8 +156,12 @@ fn create_out_file(file_name: &str, content: String) {
 
 /// Get a cargo command that compiles with nightly
 fn get_nightly_cargo() -> Command {
-	if Command::new("rustup").args(&["run", "nightly", "cargo"])
-		.status().map(|s| s.success()).unwrap_or(false)
+	if Command::new("rustup")
+		.args(&["run", "nightly", "cargo"])
+		.stdout(Stdio::null())
+		.stderr(Stdio::null())
+		.status()
+		.map(|s| s.success()).unwrap_or(false)
 	{
 		let mut cmd = Command::new("rustup");
 		cmd.args(&["run", "nightly", "cargo"]);

core/utils/wasm-builder/src/lib.rs

@@ -27,7 +27,12 @@ pub fn check() -> Option<&'static str> {
 		return Some("Rust nightly not installed, please install it!")
 	}
 
-	if Command::new("wasm-gc").stdout(Stdio::null()).status().map(|s| !s.success()).unwrap_or(true) {
+	if Command::new("wasm-gc")
+		.stdout(Stdio::null())
+		.stderr(Stdio::null())
+		.status()
+		.map(|s| !s.success()).unwrap_or(true)
+	{
 		return Some("wasm-gc not installed, please install it!")
 	}
 
@@ -83,6 +88,8 @@ fn check_wasm_toolchain_installed() -> bool {
 	let manifest_path = manifest_path.display().to_string();
 	crate::get_nightly_cargo()
 		.args(&["build", "--target=wasm32-unknown-unknown", "--manifest-path", &manifest_path])
+		.stdout(Stdio::null())
+		.stderr(Stdio::null())
 		.status()
 		.map(|s| s.success())
 		.unwrap_or(false)

core/utils/wasm-builder/src/prerequisites.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
-use std::{fs, path::{Path, PathBuf}, borrow::ToOwned, process::Command, env};
+use std::{fs, path::{Path, PathBuf}, borrow::ToOwned, process::{Command, self}, env};
 
 use toml::value::Table;
 
@@ -266,7 +266,8 @@ fn build_project(project: &Path) {
 
 	match build_cmd.status().map(|s| s.success()) {
 		Ok(true) => {},
-		_ => panic!("Failed to compile WASM binary"),
+		// Use `process.exit(1)` to have a clean error output.
+		_ => process::exit(1),
 	}
 }
 

core/utils/wasm-builder/src/wasm_project.rs

@@ -26,7 +26,7 @@ consensus-aura = { package = "substrate-consensus-aura-primitives", path = "../.
 offchain-primitives = { package = "substrate-offchain-primitives", path = "../../core/offchain/primitives", default-features = false }
 
 [build-dependencies]
-wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.0" }
+wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.1" }
 
 [features]
 default = ["std"]

node-template/runtime/Cargo.toml

@@ -17,5 +17,5 @@
 use wasm_builder_runner::{build_current_project, WasmBuilderSource};
 
 fn main() {
-	build_current_project("wasm_binary.rs", WasmBuilderSource::Crates("1.0.1"));
+	build_current_project("wasm_binary.rs", WasmBuilderSource::Crates("1.0.2"));
 }

node-template/runtime/build.rs

@@ -39,7 +39,7 @@ serde = { version = "1.0", optional = true }
 substrate-keyring = { path = "../../core/keyring", optional = true }
 
 [build-dependencies]
-wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.0" }
+wasm-builder-runner = { package = "substrate-wasm-builder-runner", version = "1.0.1", path = "../../core/utils/wasm-builder-runner" }
 
 [features]
 default = ["std"]

node/runtime/Cargo.toml

@@ -19,6 +19,9 @@ use wasm_builder_runner::{build_current_project, WasmBuilderSource};
 fn main() {
 	build_current_project(
 		"wasm_binary.rs",
-		WasmBuilderSource::Crates("1.0.1"),
+		WasmBuilderSource::CratesOrPath {
+			path: "../../core/utils/wasm-builder",
+			version: "1.0.2",
+		},
 	);
 }