-
Notifications
You must be signed in to change notification settings - Fork 422
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(lockfiles): Use
Cargo.lock to identify wasm-bindgen versions
This lets us leverage `cargo` for semver finding and then ensure that we get the exact same version of the CLI that cargo selected. It also lets us support fuzzy dependencies like "0.2" instead of exact dependencies like "0.2.21" again.
- Loading branch information
Showing
12 changed files
with
334 additions
and
186 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| //! Reading Cargo.lock lock file. | ||
| use std::fs::File; | ||
| use std::io::Read; | ||
| use std::path::{Path, PathBuf}; | ||
|
|
||
| use cargo_metadata; | ||
| use console::style; | ||
| use error::Error; | ||
| use toml; | ||
|
|
||
| /// This struct represents the contents of `Cargo.lock`. | ||
| #[derive(Clone, Debug, Deserialize)] | ||
| struct Lockfile { | ||
| package: Vec<Package>, | ||
| } | ||
|
|
||
| /// This struct represents a single package entry in `Cargo.lock` | ||
| #[derive(Clone, Debug, Deserialize)] | ||
| struct Package { | ||
| name: String, | ||
| version: String, | ||
| } | ||
|
|
||
| impl Lockfile { | ||
| fn get_package_version(&self, package: &str) -> Option<String> { | ||
| self.package | ||
| .iter() | ||
| .find(|p| p.name == package) | ||
| .map(|p| p.version.clone()) | ||
| } | ||
| } | ||
|
|
||
| /// Get the version of `wasm-bindgen` dependency used in the `Cargo.lock`. | ||
| pub fn get_wasm_bindgen_version(path: &Path) -> Result<String, Error> { | ||
| let lockfile = read_cargo_lock(&path)?; | ||
| lockfile.get_package_version("wasm-bindgen").ok_or_else(|| { | ||
| let message = format!( | ||
| "Ensure that you have \"{}\" as a dependency in your Cargo.toml file:\n\ | ||
| [dependencies]\n\ | ||
| wasm-bindgen = \"0.2\"", | ||
| style("wasm-bindgen").bold().dim(), | ||
| ); | ||
| Error::CrateConfig { message } | ||
| }) | ||
| } | ||
|
|
||
| /// Get the version of `wasm-bindgen` dependency used in the `Cargo.lock`. | ||
| pub fn get_wasm_bindgen_test_version(path: &Path) -> Result<String, Error> { | ||
| let lockfile = read_cargo_lock(&path)?; | ||
| lockfile | ||
| .get_package_version("wasm-bindgen-test") | ||
| .ok_or_else(|| { | ||
| let message = format!( | ||
| "Ensure that you have \"{}\" as a dependency in your Cargo.toml file:\n\ | ||
| [dev-dependencies]\n\ | ||
| wasm-bindgen-test = \"0.2\"", | ||
| style("wasm-bindgen").bold().dim(), | ||
| ); | ||
| Error::CrateConfig { message } | ||
| }) | ||
| } | ||
|
|
||
| /// Read the `Cargo.lock` file for the crate at the given path. | ||
| fn read_cargo_lock(crate_path: &Path) -> Result<Lockfile, Error> { | ||
| let lock_path = get_lockfile_path(crate_path)?; | ||
| let mut lockfile = String::new(); | ||
| File::open(lock_path)?.read_to_string(&mut lockfile)?; | ||
| toml::from_str(&lockfile).map_err(Error::from) | ||
| } | ||
|
|
||
| /// Given the path to the crate that we are buliding, return a `PathBuf` | ||
| /// containing the location of the lock file, by finding the workspace root. | ||
| fn get_lockfile_path(crate_path: &Path) -> Result<PathBuf, Error> { | ||
| // Identify the crate's root directory, or return an error. | ||
| let manifest = crate_path.join("Cargo.toml"); | ||
| let crate_root = cargo_metadata::metadata(Some(&manifest)) | ||
| .map_err(|_| Error::CrateConfig { | ||
| message: String::from("Error while processing crate metadata"), | ||
| })?.workspace_root; | ||
| // Check that a lock file can be found in the directory. Return an error | ||
| // if it cannot, otherwise return the path buffer. | ||
| let lockfile_path = Path::new(&crate_root).join("Cargo.lock"); | ||
| if !lockfile_path.is_file() { | ||
| Err(Error::CrateConfig { | ||
| message: format!("Could not find lockfile at {:?}", lockfile_path), | ||
| }) | ||
| } else { | ||
| Ok(lockfile_path) | ||
| } | ||
| } |
Oops, something went wrong.