feat: Add package version to Nargo.toml metadata (#3427)

Co-authored-by: Tom French <[email protected]>
Co-authored-by: Tom French <[email protected]>

test_programs/execution_success/1_mul/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
 name = "1_mul"
+version = "0.1.0"
 type = "bin"
 authors = [""]
 

tooling/nargo/src/package.rs

@@ -43,6 +43,7 @@ impl Dependency {
 
 #[derive(Clone)]
 pub struct Package {
+    pub version: Option<String>,
     // A semver string which specifies the compiler version required to compile this package
     pub compiler_required_version: Option<String>,
     pub root_dir: PathBuf,

tooling/nargo_toml/src/errors.rs

@@ -71,6 +71,7 @@ pub enum ManifestError {
     SemverError(SemverError),
 }
 
+#[allow(clippy::enum_variant_names)]
 #[derive(Error, Debug, PartialEq, Eq, Clone)]
 pub enum SemverError {
     #[error("Incompatible compiler version in package {package_name}. Required compiler version is {required_compiler_version} but the compiler version is {compiler_version_found}.\n Update the compiler_version field in Nargo.toml to >={required_compiler_version} or compile this project with version {required_compiler_version}")]
@@ -81,4 +82,6 @@ pub enum SemverError {
     },
     #[error("Could not parse the required compiler version for package {package_name} in Nargo.toml. Error: {error}")]
     CouldNotParseRequiredVersion { package_name: String, error: String },
+    #[error("Could not parse the package version for package {package_name} in Nargo.toml. Error: {error}")]
+    CouldNotParsePackageVersion { package_name: String, error: String },
 }

tooling/nargo_toml/src/lib.rs

@@ -8,6 +8,7 @@ use std::{
     path::{Component, Path, PathBuf},
 };
 
+use errors::SemverError;
 use fm::{NormalizePath, FILE_EXTENSION};
 use nargo::{
     package::{Dependency, Package, PackageType},
@@ -99,7 +100,7 @@ struct PackageConfig {
 
 impl PackageConfig {
     fn resolve_to_package(&self, root_dir: &Path) -> Result<Package, ManifestError> {
-        let name = if let Some(name) = &self.package.name {
+        let name: CrateName = if let Some(name) = &self.package.name {
             name.parse().map_err(|_| ManifestError::InvalidPackageName {
                 toml: root_dir.join("Nargo.toml"),
                 name: name.into(),
@@ -163,7 +164,18 @@ impl PackageConfig {
             }
         };
 
+        // If there is a package version, ensure that it is semver compatible
+        if let Some(version) = &self.package.version {
+            semver::parse_semver_compatible_version(version).map_err(|err| {
+                ManifestError::SemverError(SemverError::CouldNotParsePackageVersion {
+                    package_name: name.to_string(),
+                    error: err.to_string(),
+                })
+            })?;
+        }
+
         Ok(Package {
+            version: self.package.version.clone(),
             compiler_required_version: self.package.compiler_version.clone(),
             root_dir: root_dir.to_path_buf(),
             entry_path,
@@ -225,6 +237,7 @@ struct WorkspaceConfig {
 #[derive(Default, Debug, Deserialize, Clone)]
 struct PackageMetadata {
     name: Option<String>,
+    version: Option<String>,
     #[serde(alias = "type")]
     package_type: Option<String>,
     entry: Option<PathBuf>,

tooling/nargo_toml/src/semver.rs

@@ -3,14 +3,19 @@ use nargo::{
     package::{Dependency, Package},
     workspace::Workspace,
 };
-use semver::{Version, VersionReq};
+use semver::{Error, Version, VersionReq};
+
+// Parse a semver compatible version string
+pub(crate) fn parse_semver_compatible_version(version: &str) -> Result<Version, Error> {
+    Version::parse(version)
+}
 
 // Check that all of the packages in the workspace are compatible with the current compiler version
 pub(crate) fn semver_check_workspace(
     workspace: Workspace,
     current_compiler_version: String,
 ) -> Result<(), ManifestError> {
-    let version = Version::parse(&current_compiler_version)
+    let version = parse_semver_compatible_version(&current_compiler_version)
         .expect("The compiler version is not a valid semver version");
     for package in &workspace.members {
         semver_check_package(package, &version).map_err(ManifestError::SemverError)?;
@@ -83,6 +88,7 @@ mod tests {
             entry_path: PathBuf::new(),
             name: CrateName::from_str("test").unwrap(),
             dependencies: BTreeMap::new(),
+            version: Some("1.0".to_string()),
         };
         if let Err(err) = semver_check_package(&package, &compiler_version) {
             panic!("semver check should have passed. compiler version is 0.1.0 and required version from the package is 0.1.0\n error: {err:?}")
@@ -113,6 +119,7 @@ mod tests {
             entry_path: PathBuf::new(),
             name: CrateName::from_str("test").unwrap(),
             dependencies: BTreeMap::new(),
+            version: Some("1.0".to_string()),
         };
 
         let valid_dependency = Package {
@@ -122,6 +129,7 @@ mod tests {
             entry_path: PathBuf::new(),
             name: CrateName::from_str("good_dependency").unwrap(),
             dependencies: BTreeMap::new(),
+            version: Some("1.0".to_string()),
         };
         let invalid_dependency = Package {
             compiler_required_version: Some("0.2.0".to_string()),
@@ -130,6 +138,7 @@ mod tests {
             entry_path: PathBuf::new(),
             name: CrateName::from_str("bad_dependency").unwrap(),
             dependencies: BTreeMap::new(),
+            version: Some("1.0".to_string()),
         };
 
         package.dependencies.insert(
@@ -169,6 +178,7 @@ mod tests {
             entry_path: PathBuf::new(),
             name: CrateName::from_str("test").unwrap(),
             dependencies: BTreeMap::new(),
+            version: Some("1.0".to_string()),
         };
 
         if let Err(err) = semver_check_package(&package, &compiler_version) {
@@ -187,6 +197,7 @@ mod tests {
             entry_path: PathBuf::new(),
             name: CrateName::from_str("test").unwrap(),
             dependencies: BTreeMap::new(),
+            version: Some("1.0".to_string()),
         };
 
         if let Err(err) = semver_check_package(&package, &compiler_version) {