pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-28 08:37:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make it easier to just rebuild the WASM files (#3510)

Browse Source 
* Adds `WASM_TARGET_DIRECTORY` env variable to `wasm-builder`

* Create the `wasm-builder-runner`'s in a common workspace

* Make `wasm-builder` trigger less rebuilds

* Version up

* Adds script for building only the WASM files

* Apply suggestions from code review

Co-Authored-By: André Silva <andre.beat@gmail.com>
Co-Authored-By: DemiMarie-parity <48690212+DemiMarie-parity@users.noreply.github.com>
This commit is contained in:
Bastian Köcher
2019-08-29 09:06:51 +02:00
committed by GitHub
parent c26b7163a3
commit 4ff97bd856
12 changed files with 182 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/core/utils/wasm-builder/src/lib.rs
+34 -8
View File
@@ -66,6 +66,8 @@
//! needs to change. As WASM builder instructs `cargo` to watch for file changes
//! this environment variable should only be required in certain circumstances.
//! - `WASM_BUILD_RUSTFLAGS` - Extend `RUSTFLAGS` given to `cargo build` while building the WASM binary.
//! - `WASM_TARGET_DIRECTORY` - Will copy any build WASM binary to the given directory. The path needs
//! to be absolute.
//!
//! Each project can be skipped individually by using the environment variable `SKIP_PROJECT_NAME_WASM_BUILD`.
//! Where `PROJECT_NAME` needs to be replaced by the name of the cargo project, e.g. `node-runtime` will
@@ -96,6 +98,11 @@ const WASM_BUILD_TYPE_ENV: &str = "WASM_BUILD_TYPE";
/// Environment variable to extend the `RUSTFLAGS` variable given to the WASM build.
const WASM_BUILD_RUSTFLAGS_ENV: &str = "WASM_BUILD_RUSTFLAGS";
/// Environment variable to set the target directory to copy the final WASM binary.
///
/// The directory needs to be an absolute path.
const WASM_TARGET_DIRECTORY: &str = "WASM_TARGET_DIRECTORY";
/// Build the currently built project as WASM binary.
///
/// The current project is determined by using the `CARGO_MANIFEST_DIR` environment variable.
@@ -104,6 +111,22 @@ const WASM_BUILD_RUSTFLAGS_ENV: &str = "WASM_BUILD_RUSTFLAGS";
/// constant `WASM_BINARY`, which contains the built WASM binary.
/// `cargo_manifest` - The path to the `Cargo.toml` of the project that should be built.
pub fn build_project(file_name: &str, cargo_manifest: &str) {
build_project_with_default_rustflags(file_name, cargo_manifest, "");
}
/// Build the currently built project as WASM binary.
///
/// The current project is determined by using the `CARGO_MANIFEST_DIR` environment variable.
///
/// `file_name` - The name + path of the file being generated. The file contains the
/// constant `WASM_BINARY`, which contains the built WASM binary.
/// `cargo_manifest` - The path to the `Cargo.toml` of the project that should be built.
/// `default_rustflags` - Default `RUSTFLAGS` that will always be set for the build.
pub fn build_project_with_default_rustflags(
file_name: &str,
cargo_manifest: &str,
default_rustflags: &str,
) {
if check_skip_build() {
return;
}
@@ -123,10 +146,13 @@ pub fn build_project(file_name: &str, cargo_manifest: &str) {
process::exit(1);
}
let (wasm_binary, bloaty) = wasm_project::create_and_compile(&cargo_manifest);
let (wasm_binary, bloaty) = wasm_project::create_and_compile(
&cargo_manifest,
default_rustflags,
);
create_out_file(
file_name,
write_file_if_changed(
file_name.into(),
format!(
r#"
pub const WASM_BINARY: &[u8] = include_bytes!("{wasm_binary}");
@@ -143,11 +169,11 @@ fn check_skip_build() -> bool {
env::var(SKIP_BUILD_ENV).is_ok()
}
fn create_out_file(file_name: &str, content: String) {
fs::write(
file_name,
content
).expect("Creating and writing can not fail; qed");
/// Write to the given `file` if the `content` is different.
fn write_file_if_changed(file: PathBuf, content: String) {
if fs::read_to_string(&file).ok().as_ref() != Some(&content) {
fs::write(&file, content).expect(&format!("Writing `{}` can not fail!", file.display()));
}
}
/// Get a cargo command that compiles with nightly
substrate/core/utils/wasm-builder/src/wasm_project.rs
+48 -10
View File
@@ -14,6 +14,8 @@
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
use crate::write_file_if_changed;
use std::{fs, path::{Path, PathBuf}, borrow::ToOwned, process::{Command, self}, env};
use toml::value::Table;
@@ -75,7 +77,10 @@ impl Drop for WorkspaceLock {
///
/// # Returns
/// The path to the compact WASM binary and the bloaty WASM binary.
pub fn create_and_compile(cargo_manifest: &Path) -> (WasmBinary, WasmBinaryBloaty) {
pub fn create_and_compile(
cargo_manifest: &Path,
default_rustflags: &str,
) -> (WasmBinary, WasmBinaryBloaty) {
let wasm_workspace_root = get_wasm_workspace_root();
let wasm_workspace = wasm_workspace_root.join("wbuild");
@@ -85,8 +90,14 @@ pub fn create_and_compile(cargo_manifest: &Path) -> (WasmBinary, WasmBinaryBloat
let project = create_project(cargo_manifest, &wasm_workspace);
create_wasm_workspace_project(&wasm_workspace);
build_project(&project);
let (wasm_binary, bloaty) = compact_wasm_file(&project, cargo_manifest, &wasm_workspace);
build_project(&project, default_rustflags);
let (wasm_binary, bloaty) = compact_wasm_file(
&project,
cargo_manifest,
&wasm_workspace,
);
copy_wasm_to_target_directory(cargo_manifest, &wasm_binary);
generate_rerun_if_changed_instructions(cargo_manifest, &project, &wasm_workspace);
@@ -122,6 +133,7 @@ fn find_cargo_lock(cargo_manifest: &Path) -> Option<PathBuf> {
cargo_manifest.display(),
build_helper::out_dir().display()
);
None
}
@@ -203,7 +215,7 @@ fn create_project(cargo_manifest: &Path, wasm_workspace: &Path) -> PathBuf {
fs::create_dir_all(project_folder.join("src")).expect("Wasm project dir create can not fail; qed");
fs::write(
write_file_if_changed(
project_folder.join("Cargo.toml"),
format!(
r#"
@@ -223,12 +235,12 @@ fn create_project(cargo_manifest: &Path, wasm_workspace: &Path) -> PathBuf {
crate_path = crate_path.display(),
wasm_binary = wasm_binary,
)
).expect("Project `Cargo.toml` writing can not fail; qed");
);
fs::write(
write_file_if_changed(
project_folder.join("src/lib.rs"),
"#![no_std] pub use wasm_project::*;",
).expect("Project `lib.rs` writing can not fail; qed");
"#![no_std] pub use wasm_project::*;".into(),
);
if let Some(crate_lock_file) = find_cargo_lock(cargo_manifest) {
// Use the `Cargo.lock` of the main project.
@@ -257,12 +269,13 @@ fn is_release_build() -> bool {
}
/// Build the project to create the WASM binary.
fn build_project(project: &Path) {
fn build_project(project: &Path, default_rustflags: &str) {
let manifest_path = project.join("Cargo.toml");
let mut build_cmd = crate::get_nightly_cargo().command();
let rustflags = format!(
"-C link-arg=--export-table {}",
"-C link-arg=--export-table {} {}",
default_rustflags,
env::var(crate::WASM_BUILD_RUSTFLAGS_ENV).unwrap_or_default(),
);
@@ -349,4 +362,29 @@ fn generate_rerun_if_changed_instructions(
println!("cargo:rerun-if-env-changed={}", crate::SKIP_BUILD_ENV);
println!("cargo:rerun-if-env-changed={}", crate::WASM_BUILD_TYPE_ENV);
println!("cargo:rerun-if-env-changed={}", crate::WASM_BUILD_RUSTFLAGS_ENV);
println!("cargo:rerun-if-env-changed={}", crate::WASM_TARGET_DIRECTORY);
}
/// Copy the WASM binary to the target directory set in `WASM_TARGET_DIRECTORY` environment variable.
/// If the variable is not set, this is a no-op.
fn copy_wasm_to_target_directory(cargo_manifest: &Path, wasm_binary: &WasmBinary) {
let target_dir = match env::var(crate::WASM_TARGET_DIRECTORY) {
Ok(path) => PathBuf::from(path),
Err(_) => return,
};
if !target_dir.is_absolute() {
panic!(
"Environment variable `{}` with `{}` is not an absolute path!",
crate::WASM_TARGET_DIRECTORY,
target_dir.display(),
);
}
fs::create_dir_all(&target_dir).expect("Creates `WASM_TARGET_DIRECTORY`.");
fs::copy(
wasm_binary.wasm_binary_path(),
target_dir.join(format!("{}.wasm", get_wasm_binary_name(cargo_manifest))),
).expect("Copies WASM binary to `WASM_TARGET_DIRECTORY`.");
}