Merge pull request #6 from nickel-lang/index-package-subpaths

Bump nickel and support subpaths in index packages

Author: jneem

Cargo.lock

@@ -8,9 +8,10 @@ clap = { version = "4.5.40", features = ["derive"] }
 gitpatch = "0.7.1"
 gix = { version = "0.70.0", features = ["blocking-http-transport-reqwest-rust-tls"]}
 miette = { version = "7.6.0", features = ["fancy"] }
-nickel-lang-core = "0.13.0"
-nickel-lang-git = "0.1.0"
-nickel-lang-package = "0.2.0"
+# TODO: once there's a nickel release that has support for index package subpaths, switch to that
+nickel-lang-core = { git = "https://github.com/tweag/nickel" }
+nickel-lang-git= { git = "https://github.com/tweag/nickel" }
+nickel-lang-package = { git = "https://github.com/tweag/nickel" }
 octocrab = "0.44.1"
 serde = "1.0.219"
 serde_json = "1.0.140"

Cargo.toml

@@ -29,7 +29,6 @@
       {
         devShells.default = mkShell {
           nativeBuildInputs = [
-            gosmee
             rust-toolchain
           ];
         };

flake.nix

@@ -105,15 +105,18 @@ impl PackageReport {
         index: &PackageIndex<Shared>,
         pkg: Package,
     ) -> miette::Result<Self> {
-        let PreciseId::Github { org, name, .. } = &pkg.id;
+        let PreciseId::Github {
+            org, name, path, ..
+        } = &pkg.id;
         let permission =
             Permission::check(client, user.to_owned(), org.clone(), name.clone()).await?;
 
         let temp_dir = tempdir().into_diagnostic()?;
         let status = if let Err(e) = package::fetch(&pkg, temp_dir.path()) {
             PackageStatus::FetchFailed(e.to_string())
         } else {
-            match package::check_manifest(&pkg, temp_dir.path(), index) {
+            let path = temp_dir.path().join(path);
+            match package::check_manifest(&pkg, &path, index) {
                 Ok(c) => PackageStatus::Manifest(Box::new(c)),
                 Err(e) => PackageStatus::EvalFailed(e.to_string()),
             }
@@ -135,12 +138,14 @@ impl PackageReport {
     }
 
     fn format(&self, f: &mut std::fmt::Formatter, indent: &str) -> std::fmt::Result {
-        let PreciseId::Github { org, name, .. } = &self.pkg.id;
+        let PreciseId::Github {
+            org, name, path, ..
+        } = &self.pkg.id;
         let perm = &self.permission;
         let indent_spaces = " ".repeat(indent.len());
         writeln!(
             f,
-            "{}package {org}/{name}, version {}",
+            "{}package {org}/{name}/{path}, version {}",
             indent, self.pkg.version
         )?;
         if perm.is_allowed {

src/main.rs

@@ -2,11 +2,11 @@ use std::path::Path;
 
 use gitpatch::Patch;
 use miette::{IntoDiagnostic as _, bail};
-use nickel_lang_core::error::report::report_as_str;
+use nickel_lang_core::error::report::{ColorOpt, report_as_str};
 use nickel_lang_git::{Spec, Target};
 use nickel_lang_package::{
     IndexDependency, ManifestFile,
-    index::{Package, PackageIndex, PreciseId, Shared, serialize::PackageFormat},
+    index::{Id, Package, PackageIndex, PreciseId, Shared, serialize::PackageFormat},
     manifest::MANIFEST_NAME,
     version::SemVer,
 };
@@ -27,6 +27,8 @@ pub enum Error {
     Deserialize(#[from] serde_json::Error),
     #[error("org/name mismatch: path was \"{path}\", package was \"{package}\"")]
     OrgNameMismatch { path: String, package: String },
+    #[error("path too deep: expected three components, got \"{path}\"")]
+    PathToDeep { path: String },
 }
 
 impl<'a> From<gitpatch::ParseError<'a>> for Error {
@@ -53,21 +55,24 @@ pub fn changed_packages(diff: &str) -> Result<Vec<Package>, Error> {
         let Some(path_name) = parts.next() else {
             return Err(Error::MissingRepo(path.into_owned()));
         };
+        if parts.next().is_some() {
+            return Err(Error::PathToDeep {
+                path: path.into_owned(),
+            });
+        }
 
         for line in patch.hunks.iter().flat_map(|h| h.lines.iter()) {
             match line {
                 gitpatch::Line::Add(line) => {
                     let package: PackageFormat = serde_json::from_str(line)?;
                     let package = Package::from(package);
-                    match &package.id {
-                        PreciseId::Github { org, name, .. } => {
-                            if org != path_org || name != path_name {
-                                return Err(Error::OrgNameMismatch {
-                                    path: format!("{path_org}/{path_name}"),
-                                    package: format!("{org}/{name}"),
-                                });
-                            }
-                        }
+                    let id = Id::from(package.id.clone());
+                    let package_path = format!("github/{path_org}/{path_name}");
+                    if id.path().to_str() != Some(package_path.as_ref()) {
+                        return Err(Error::OrgNameMismatch {
+                            path: package_path,
+                            package: id.path().display().to_string(),
+                        });
                     }
                     ret.push(package);
                 }
@@ -86,7 +91,12 @@ pub fn changed_packages(diff: &str) -> Result<Vec<Package>, Error> {
 /// This uses `nickel_lang_git`, with essentially the same code as nickel's package manager.
 /// In particular, this should catch any portability issues like illegal windows filenames.
 pub fn fetch(pkg: &Package, path: &Path) -> miette::Result<()> {
-    let PreciseId::Github { org, name, commit } = &pkg.id;
+    let PreciseId::Github {
+        org,
+        name,
+        commit,
+        path: _,
+    } = &pkg.id;
     let url = format!("https://github.com/{org}/{name}.git");
     let spec = Spec {
         url: url.try_into().into_diagnostic()?,
@@ -182,7 +192,9 @@ impl<T> IntoDiagnostic<T> for Result<T, nickel_lang_package::error::Error> {
             Err(nickel_lang_package::error::Error::ManifestEval {
                 mut files, error, ..
             }) => {
-                bail!(report_as_str(&mut files, error, Default::default()))
+                // ANSI codes don't seem to get rendered in github comments, so
+                // turn off color.
+                bail!(report_as_str(&mut files, *error, ColorOpt::Never))
             }
             Err(e) => bail!(e.to_string()),
         }
@@ -199,6 +211,7 @@ pub fn check_manifest(
     path.push(MANIFEST_NAME);
 
     // TODO: report manifest eval errors better
+    // FIXME: use the subdir here if necessary
     let manifest = ManifestFile::from_path(&path).into_diag()?;
 
     let mut dependencies = Vec::new();
@@ -220,6 +233,9 @@ pub fn check_manifest(
 
 #[cfg(test)]
 mod tests {
+    use std::path::PathBuf;
+
+    use gix::ObjectId;
     use nickel_lang_package::version::SemVer;
 
     use super::*;
@@ -232,6 +248,16 @@ index df1cd2a..2229806 100644
 @@ -1 +1,2 @@
  {"id":{"github":{"org":"nickel-lang","name":"nickel-schemastore","commit":"3ac728792d4a71f53897b185445b77029c3ce245"}},"version":{"major":0,"minor":1,"patch":0,"pre":""},"minimal_nickel_version":{"major":1,"minor":11,"patch":0,"pre":""},"dependencies":{},"authors":["Théophane Hufschmitt","Yann Hamdaoui <[email protected]>"],"description":"A nickel package containing contracts autogenerated from the Schemastore JSON Schema repository via json-schema-to-nickel.","keywords":["schemastore","schemas","json-schema","contracts"],"license":"MIT","v":0}
 +{"id":{"github":{"org":"nickel-lang","name":"nickel-schemastore","commit":"5b5edcba47eb5f957a34a6224b3d9b976a4fc911"}},"version":{"major":0,"minor":2,"patch":0,"pre":""},"minimal_nickel_version":{"major":1,"minor":11,"patch":0,"pre":""},"dependencies":{},"authors":["Théophane Hufschmitt","Yann Hamdaoui <[email protected]>"],"description":"Nickel contracts autogenerated from the Schemastore JSON Schema repository via json-schema-to-nickel","keywords":["schemastore","schemas","json-schema","contracts"],"license":"MIT","v":0}
+"#;
+
+    const SAMPLE_DIFF_WITH_SUBDIR: &str = r#"
+diff --git a/github/nickel-lang/json-schema-to-nickel%@lib b/github/nickel-lang/json-schema-to-nickel%@lib
+new file mode 100644
+index 0000000..17e1150
+--- /dev/null
++++ b/github/nickel-lang/json-schema-to-nickel%@lib
+@@ -0,0 +1 @@
++{"id":{"github":{"org":"nickel-lang","name":"json-schema-to-nickel","path":"lib","commit":"7d7c007c1de43aa448df633ddbcb33b54385d8a0"}},"version":{"major":0,"minor":1,"patch":0,"pre":""},"minimal_nickel_version":{"major":1,"minor":12,"patch":0,"pre":""},"dependencies":{},"authors":["The json-schema-to-nickel authors"],"description":"A library of predicates for JSON schema","keywords":[],"license":"","v":0}
 "#;
 
     #[test]
@@ -240,4 +266,19 @@ index df1cd2a..2229806 100644
         assert_eq!(packages.len(), 1);
         assert_eq!(packages[0].version, SemVer::new(0, 2, 0));
     }
+
+    #[test]
+    fn test_changed_packages_with_subdir() {
+        let packages = changed_packages(SAMPLE_DIFF_WITH_SUBDIR).unwrap();
+        assert_eq!(packages.len(), 1);
+        assert_eq!(
+            packages[0].id,
+            PreciseId::Github {
+                org: "nickel-lang".to_owned(),
+                name: "json-schema-to-nickel".to_owned(),
+                path: PathBuf::from("lib").try_into().unwrap(),
+                commit: ObjectId::from_hex(b"7d7c007c1de43aa448df633ddbcb33b54385d8a0").unwrap(),
+            }
+        );
+    }
 }