code_ownership 2.0.0.pre.1 → 2.0.0.pre.3

data/ext/cargo-vendor/codeowners-0.2.17/src/project.rs

@@ -0,0 +1,229 @@
+use core::fmt;
+use std::{
+    collections::HashMap,
+    fmt::Display,
+    fs::File,
+    path::{Path, PathBuf},
+};
+
+use error_stack::{Context, Result, ResultExt};
+
+pub struct Project {
+    pub base_path: PathBuf,
+    pub files: Vec<ProjectFile>,
+    pub packages: Vec<Package>,
+    pub vendored_gems: Vec<VendoredGem>,
+    pub teams: Vec<Team>,
+    pub codeowners_file_path: PathBuf,
+    pub directory_codeowner_files: Vec<DirectoryCodeownersFile>,
+    pub teams_by_name: HashMap<String, Team>,
+}
+
+#[derive(Clone, Debug)]
+pub struct VendoredGem {
+    pub path: PathBuf,
+    pub name: String,
+}
+
+#[derive(Debug, Clone)]
+pub struct ProjectFile {
+    pub owner: Option<String>,
+    pub path: PathBuf,
+}
+
+#[derive(Clone, Debug, Default)]
+pub struct Team {
+    pub path: PathBuf,
+    pub name: String,
+    pub github_team: String,
+    pub owned_globs: Vec<String>,
+    pub subtracted_globs: Vec<String>,
+    pub owned_gems: Vec<String>,
+    pub avoid_ownership: bool,
+}
+
+impl Team {
+    pub fn from_team_file_path(absolute_path: PathBuf) -> Result<Self, Error> {
+        let file = File::open(&absolute_path).change_context(Error::Io)?;
+        let deserializer: deserializers::Team = serde_yaml::from_reader(file).change_context(Error::SerdeYaml)?;
+        Ok(Self {
+            path: absolute_path.to_owned(),
+            name: deserializer.name,
+            github_team: deserializer.github.team,
+            owned_globs: deserializer.owned_globs,
+            subtracted_globs: deserializer.subtracted_globs,
+            owned_gems: deserializer.ruby.map(|ruby| ruby.owned_gems).unwrap_or_default(),
+            avoid_ownership: deserializer.github.do_not_add_to_codeowners_file,
+        })
+    }
+}
+
+#[derive(Clone, Debug)]
+pub struct Package {
+    pub path: PathBuf,
+    pub package_type: PackageType,
+    pub owner: String,
+}
+
+impl Package {
+    pub fn package_root(&self) -> Option<&Path> {
+        self.path.parent()
+    }
+}
+
+#[derive(Clone, Debug)]
+pub struct DirectoryCodeownersFile {
+    pub path: PathBuf,
+    pub owner: String,
+}
+
+impl DirectoryCodeownersFile {
+    pub fn directory_root(&self) -> Option<&Path> {
+        self.path.parent()
+    }
+}
+
+#[derive(PartialEq, Eq, Debug, Clone)]
+pub enum PackageType {
+    Ruby,
+    Javascript,
+}
+
+impl Display for PackageType {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "{:?}", self)
+    }
+}
+
+pub mod deserializers {
+    use serde::Deserialize;
+
+    #[derive(Deserialize)]
+    pub struct Metadata {
+        pub owner: Option<String>,
+    }
+
+    #[derive(Deserialize)]
+    pub struct JavascriptPackage {
+        pub metadata: Option<Metadata>,
+    }
+
+    #[derive(Deserialize)]
+    pub struct RubyPackage {
+        pub owner: Option<String>,
+    }
+
+    #[derive(Deserialize)]
+    pub struct Github {
+        pub team: String,
+        #[serde(default = "bool_false")]
+        pub do_not_add_to_codeowners_file: bool,
+    }
+
+    #[derive(Deserialize)]
+    pub struct Ruby {
+        #[serde(default = "empty_string_vec")]
+        pub owned_gems: Vec<String>,
+    }
+
+    #[derive(Deserialize)]
+    pub struct Team {
+        pub name: String,
+        pub github: Github,
+        pub ruby: Option<Ruby>,
+
+        #[serde(default = "empty_string_vec")]
+        pub owned_globs: Vec<String>,
+
+        #[serde(alias = "unowned_globs", default = "empty_string_vec")]
+        pub subtracted_globs: Vec<String>,
+    }
+
+    fn empty_string_vec() -> Vec<String> {
+        Vec::new()
+    }
+
+    fn bool_false() -> bool {
+        false
+    }
+}
+
+#[derive(Debug)]
+pub enum Error {
+    Io,
+    SerdeYaml,
+    SerdeJson,
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Error::Io => fmt.write_str("IO operation failed"),
+            Error::SerdeYaml => fmt.write_str("YAML serialization/deserialization failed"),
+            Error::SerdeJson => fmt.write_str("JSON serialization/deserialization failed"),
+        }
+    }
+}
+
+impl Context for Error {}
+
+impl Project {
+    pub fn get_codeowners_file(&self) -> Result<String, Error> {
+        let codeowners_file: String = if self.codeowners_file_path.exists() {
+            std::fs::read_to_string(&self.codeowners_file_path).change_context(Error::Io)?
+        } else {
+            "".to_owned()
+        };
+        Ok(codeowners_file)
+    }
+
+    pub fn relative_path<'a>(&'a self, absolute_path: &'a Path) -> &'a Path {
+        absolute_path.strip_prefix(&self.base_path).unwrap_or(absolute_path)
+    }
+
+    pub fn get_team(&self, name: &str) -> Option<Team> {
+        self.teams_by_name.get(name).cloned()
+    }
+
+    pub fn vendored_gem_by_name(&self) -> HashMap<String, VendoredGem> {
+        let mut result: HashMap<String, VendoredGem> = HashMap::new();
+
+        for vendored_gem in &self.vendored_gems {
+            result.insert(vendored_gem.name.clone(), vendored_gem.clone());
+        }
+
+        result
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_vendored_gem_by_name_maps_all_gems() {
+        let vg1 = VendoredGem {
+            path: PathBuf::from("vendored/a"),
+            name: "a".to_string(),
+        };
+        let vg2 = VendoredGem {
+            path: PathBuf::from("vendored/b"),
+            name: "b".to_string(),
+        };
+        let project = Project {
+            base_path: PathBuf::from("."),
+            files: vec![],
+            packages: vec![],
+            vendored_gems: vec![vg1.clone(), vg2.clone()],
+            teams: vec![],
+            codeowners_file_path: PathBuf::from(".github/CODEOWNERS"),
+            directory_codeowner_files: vec![],
+            teams_by_name: HashMap::new(),
+        };
+
+        let map = project.vendored_gem_by_name();
+        assert_eq!(map.len(), 2);
+        assert_eq!(map.get("a").unwrap().name, vg1.name);
+        assert_eq!(map.get("b").unwrap().name, vg2.name);
+    }
+}

data/ext/cargo-vendor/codeowners-0.2.17/src/project_builder.rs

@@ -0,0 +1,337 @@
+use std::{
+    fs::File,
+    path::{Path, PathBuf},
+    sync::{Arc, Mutex},
+};
+
+use error_stack::{Report, Result, ResultExt};
+use fast_glob::glob_match;
+use ignore::{DirEntry, WalkBuilder, WalkParallel, WalkState};
+use rayon::iter::{IntoParallelIterator, ParallelIterator};
+use tracing::{instrument, warn};
+
+use crate::{
+    cache::Cache,
+    config::Config,
+    project::{DirectoryCodeownersFile, Error, Package, PackageType, Project, ProjectFile, Team, VendoredGem, deserializers},
+    project_file_builder::ProjectFileBuilder,
+    tracked_files,
+};
+
+type AbsolutePath = PathBuf;
+type RelativePath = PathBuf;
+
+#[derive(Debug)]
+enum EntryType {
+    Directory(AbsolutePath, RelativePath),
+    RubyPackage(AbsolutePath, RelativePath),
+    JavascriptPackage(AbsolutePath, RelativePath),
+    CodeownerFile(AbsolutePath, RelativePath),
+    TeamFile(AbsolutePath, RelativePath),
+    OwnedFile(ProjectFile),
+    NullEntry(),
+}
+
+pub struct ProjectBuilder<'a> {
+    config: &'a Config,
+    base_path: PathBuf,
+    codeowners_file_path: PathBuf,
+    project_file_builder: ProjectFileBuilder<'a>,
+}
+
+const INITIAL_VECTOR_CAPACITY: usize = 1000;
+
+impl<'a> ProjectBuilder<'a> {
+    pub fn new(config: &'a Config, base_path: PathBuf, codeowners_file_path: PathBuf, cache: &'a Cache) -> Self {
+        let project_file_builder = ProjectFileBuilder::new(cache);
+        Self {
+            project_file_builder,
+            config,
+            base_path,
+            codeowners_file_path,
+        }
+    }
+
+    #[instrument(level = "debug", skip_all, fields(base_path = %self.base_path.display()))]
+    pub fn build(&mut self) -> Result<Project, Error> {
+        tracing::info!("Starting project build");
+        let mut builder = WalkBuilder::new(&self.base_path);
+        builder.hidden(false);
+        builder.follow_links(false);
+
+        // Prune traversal early: skip heavy and irrelevant directories
+        let ignore_dirs = self.config.ignore_dirs.clone();
+        let base_path = self.base_path.clone();
+        let tracked_files = tracked_files::find_tracked_files(&self.base_path);
+
+        builder.filter_entry(move |entry: &DirEntry| {
+            let path = entry.path();
+            let file_name = entry.file_name().to_str().unwrap_or("");
+            if let Some(tracked_files) = &tracked_files
+                && let Some(ft) = entry.file_type()
+                && ft.is_file()
+                && !tracked_files.contains_key(path)
+            {
+                return false;
+            }
+            if let Some(ft) = entry.file_type()
+                && ft.is_dir()
+                && let Ok(rel) = path.strip_prefix(&base_path)
+                && rel.components().count() == 1
+                && ignore_dirs.iter().any(|d| *d == file_name)
+            {
+                return false;
+            }
+
+            true
+        });
+
+        let walk_parallel: WalkParallel = builder.build_parallel();
+
+        let (tx, rx) = crossbeam_channel::unbounded::<EntryType>();
+        let error_holder: Arc<Mutex<Option<Report<Error>>>> = Arc::new(Mutex::new(None));
+        let error_holder_for_threads = Arc::clone(&error_holder);
+
+        let this: &ProjectBuilder<'a> = self;
+
+        walk_parallel.run(move || {
+            let error_holder = Arc::clone(&error_holder_for_threads);
+            let tx = tx.clone();
+            Box::new(move |res| {
+                if let Ok(entry) = res {
+                    match this.build_entry_type(entry) {
+                        Ok(entry_type) => {
+                            let _ = tx.send(entry_type);
+                        }
+                        Err(report) => {
+                            if let Ok(mut slot) = error_holder.lock()
+                                && slot.is_none()
+                            {
+                                *slot = Some(report);
+                            }
+                        }
+                    }
+                }
+                WalkState::Continue
+            })
+        });
+
+        // Take ownership of the collected entry types
+        let entry_types: Vec<EntryType> = rx.iter().collect();
+
+        // If any error occurred while building entry types, return it
+        let maybe_error = match Arc::try_unwrap(error_holder) {
+            Ok(mutex) => match mutex.into_inner() {
+                Ok(err_opt) => err_opt,
+                Err(poisoned) => poisoned.into_inner(),
+            },
+            Err(arc) => match arc.lock() {
+                Ok(mut guard) => guard.take(),
+                Err(poisoned) => poisoned.into_inner().take(),
+            },
+        };
+        if let Some(report) = maybe_error {
+            return Err(report);
+        }
+        self.build_project_from_entry_types(entry_types)
+    }
+
+    fn build_entry_type(&self, entry: ignore::DirEntry) -> Result<EntryType, Error> {
+        let absolute_path = entry.path();
+
+        let is_dir = entry.file_type().ok_or(Error::Io).change_context(Error::Io)?.is_dir();
+        let relative_path = absolute_path.strip_prefix(&self.base_path).change_context(Error::Io)?.to_owned();
+
+        if is_dir {
+            return Ok(EntryType::Directory(absolute_path.to_owned(), relative_path.to_owned()));
+        }
+        let file_name = match relative_path.file_name() {
+            Some(name) => name.to_string_lossy().to_lowercase(),
+            None => return Ok(EntryType::NullEntry()),
+        };
+
+        match file_name.as_str() {
+            name if name == "package.yml"
+                && relative_path
+                    .parent()
+                    .is_some_and(|parent| matches_globs(parent, &self.config.ruby_package_paths)) =>
+            {
+                Ok(EntryType::RubyPackage(absolute_path.to_owned(), relative_path.to_owned()))
+            }
+            name if name == "package.json"
+                && relative_path
+                    .parent()
+                    .is_some_and(|parent| matches_globs(parent, &self.config.javascript_package_paths)) =>
+            {
+                Ok(EntryType::JavascriptPackage(absolute_path.to_owned(), relative_path.to_owned()))
+            }
+            ".codeowner" => Ok(EntryType::CodeownerFile(absolute_path.to_owned(), relative_path.to_owned())),
+            _ if matches_globs(&relative_path, &self.config.team_file_glob) => {
+                Ok(EntryType::TeamFile(absolute_path.to_owned(), relative_path.to_owned()))
+            }
+            _ if matches_globs(&relative_path, &self.config.owned_globs) && !matches_globs(&relative_path, &self.config.unowned_globs) => {
+                let project_file = self.project_file_builder.build(absolute_path.to_path_buf());
+                Ok(EntryType::OwnedFile(project_file))
+            }
+            _ => Ok(EntryType::NullEntry()),
+        }
+    }
+
+    fn build_project_from_entry_types(&mut self, entry_types: Vec<EntryType>) -> Result<Project, Error> {
+        let (project_files, packages, vendored_gems, directory_codeowners, teams): (Vec<_>, Vec<_>, Vec<_>, Vec<_>, Vec<_>) = entry_types
+            .into_par_iter()
+            .fold(
+                || {
+                    (
+                        Vec::<ProjectFile>::with_capacity(INITIAL_VECTOR_CAPACITY),
+                        Vec::<Package>::new(),
+                        Vec::<VendoredGem>::new(),
+                        Vec::<DirectoryCodeownersFile>::new(),
+                        Vec::<Team>::new(),
+                    )
+                },
+                |(mut project_files, mut pkgs, mut gems, mut codeowners, mut team_files), entry_type| {
+                    match entry_type {
+                        EntryType::OwnedFile(project_file) => {
+                            project_files.push(project_file);
+                        }
+                        EntryType::Directory(absolute_path, relative_path) => {
+                            if relative_path.parent() == Some(Path::new(&self.config.vendored_gems_path)) {
+                                if let Some(file_name) = relative_path.file_name() {
+                                    gems.push(VendoredGem {
+                                        path: absolute_path,
+                                        name: file_name.to_string_lossy().to_string(),
+                                    });
+                                } else {
+                                    warn!("Vendored gem path without file name: {:?}", relative_path);
+                                }
+                            }
+                        }
+                        EntryType::RubyPackage(absolute_path, relative_path) => {
+                            match ruby_package_owner(&absolute_path) {
+                                Ok(Some(owner)) => {
+                                    pkgs.push(Package {
+                                        path: relative_path.clone(),
+                                        owner,
+                                        package_type: PackageType::Ruby,
+                                    });
+                                }
+                                Ok(None) => { /* No owner, do nothing */ }
+                                Err(e) => {
+                                    warn!("Error reading ruby package owner for {:?}: {:?}", absolute_path, e);
+                                }
+                            }
+                        }
+                        EntryType::JavascriptPackage(absolute_path, relative_path) => {
+                            match javascript_package_owner(&absolute_path) {
+                                Ok(Some(owner)) => {
+                                    pkgs.push(Package {
+                                        path: relative_path.clone(),
+                                        owner,
+                                        package_type: PackageType::Javascript,
+                                    });
+                                }
+                                Ok(None) => { /* No owner, do nothing */ }
+                                Err(e) => {
+                                    warn!("Error reading javascript package owner for {:?}: {:?}", absolute_path, e);
+                                }
+                            }
+                        }
+                        EntryType::CodeownerFile(absolute_path, relative_path) => match std::fs::read_to_string(&absolute_path) {
+                            Ok(owner) => {
+                                let owner = owner.trim().to_owned();
+                                codeowners.push(DirectoryCodeownersFile {
+                                    path: relative_path.clone(),
+                                    owner,
+                                });
+                            }
+                            Err(e) => {
+                                warn!("Error reading codeowner file for {:?}: {:?}", absolute_path, e);
+                            }
+                        },
+                        EntryType::TeamFile(absolute_path, _relative_path) => match Team::from_team_file_path(absolute_path) {
+                            Ok(team) => {
+                                team_files.push(team);
+                            }
+                            Err(e) => {
+                                warn!("Error building team from team file path: {}", e);
+                            }
+                        },
+                        EntryType::NullEntry() => {}
+                    }
+                    (project_files, pkgs, gems, codeowners, team_files)
+                },
+            )
+            .reduce(
+                || (Vec::new(), Vec::new(), Vec::new(), Vec::new(), Vec::new()),
+                |mut acc, item| {
+                    acc.0.extend(item.0);
+                    acc.1.extend(item.1);
+                    acc.2.extend(item.2);
+                    acc.3.extend(item.3);
+                    acc.4.extend(item.4);
+                    acc
+                },
+            );
+        let teams_by_name = teams
+            .iter()
+            .flat_map(|team| vec![(team.name.clone(), team.clone()), (team.github_team.clone(), team.clone())])
+            .collect();
+
+        tracing::info!(
+            files_count = %project_files.len(),
+            teams_count = %teams.len(),
+            packages_count = %packages.len(),
+            "Project build completed successfully"
+        );
+
+        Ok(Project {
+            base_path: self.base_path.to_owned(),
+            files: project_files,
+            vendored_gems,
+            teams,
+            packages,
+            codeowners_file_path: self.codeowners_file_path.to_path_buf(),
+            directory_codeowner_files: directory_codeowners,
+            teams_by_name,
+        })
+    }
+}
+
+fn matches_globs(path: &Path, globs: &[String]) -> bool {
+    match path.to_str() {
+        Some(s) => globs.iter().any(|glob| glob_match(glob, s)),
+        None => false,
+    }
+}
+
+fn ruby_package_owner(path: &Path) -> Result<Option<String>, Error> {
+    let file = File::open(path).change_context(Error::Io)?;
+    let deserializer: deserializers::RubyPackage = serde_yaml::from_reader(file).change_context(Error::SerdeYaml)?;
+
+    Ok(deserializer.owner)
+}
+
+fn javascript_package_owner(path: &Path) -> Result<Option<String>, Error> {
+    let file = File::open(path).change_context(Error::Io)?;
+    let deserializer: deserializers::JavascriptPackage = serde_json::from_reader(file).change_context(Error::SerdeJson)?;
+
+    Ok(deserializer.metadata.and_then(|metadata| metadata.owner))
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    const OWNED_GLOB: &str = "{app,components,config,frontend,lib,packs,spec,danger,script}/**/*.{rb,arb,erb,rake,js,jsx,ts,tsx}";
+
+    #[test]
+    fn test_matches_globs() {
+        assert!(matches_globs(Path::new("script/.eslintrc.js"), &[OWNED_GLOB.to_string()]));
+    }
+
+    #[test]
+    fn test_glob_match() {
+        assert!(glob_match(OWNED_GLOB, "script/.eslintrc.js"));
+    }
+}

data/ext/cargo-vendor/codeowners-0.2.17/src/project_file_builder.rs

@@ -0,0 +1,107 @@
+use error_stack::Result;
+use lazy_static::lazy_static;
+use regex::Regex;
+use std::path::{Path, PathBuf};
+
+use crate::{
+    cache::{Cache, Caching},
+    project::{Error, ProjectFile},
+};
+
+pub struct ProjectFileBuilder<'a> {
+    global_cache: &'a Cache,
+}
+
+lazy_static! {
+    static ref TEAM_REGEX: Regex =
+        Regex::new(r#"^(?:#|//|<!--|<%#)\s*@team:?\s*(.*?)\s*(?:-->|%>)?$"#).expect("error compiling regular expression");
+}
+
+impl<'a> ProjectFileBuilder<'a> {
+    pub fn new(global_cache: &'a Cache) -> Self {
+        Self { global_cache }
+    }
+
+    pub(crate) fn build(&self, path: PathBuf) -> ProjectFile {
+        if let Ok(Some(cached_project_file)) = self.get_project_file_from_cache(&path) {
+            return cached_project_file;
+        }
+
+        let project_file = build_project_file_without_cache(&path);
+
+        self.save_project_file_to_cache(&path, &project_file);
+
+        project_file
+    }
+
+    fn get_project_file_from_cache(&self, path: &Path) -> Result<Option<ProjectFile>, Error> {
+        self.global_cache.get_file_owner(path).map(|entry| {
+            entry.map(|e| ProjectFile {
+                path: path.to_path_buf(),
+                owner: e.owner,
+            })
+        })
+    }
+
+    fn save_project_file_to_cache(&self, path: &Path, project_file: &ProjectFile) {
+        self.global_cache.write_file_owner(path, project_file.owner.clone());
+    }
+}
+
+pub(crate) fn build_project_file_without_cache(path: &PathBuf) -> ProjectFile {
+    let content = match std::fs::read_to_string(path) {
+        Ok(content) => content,
+        Err(_) => {
+            return ProjectFile {
+                path: path.clone(),
+                owner: None,
+            };
+        }
+    };
+
+    let first_line = content.lines().next();
+    let Some(first_line) = first_line else {
+        return ProjectFile {
+            path: path.clone(),
+            owner: None,
+        };
+    };
+
+    let owner = TEAM_REGEX
+        .captures(first_line)
+        .and_then(|cap| cap.get(1))
+        .map(|m| m.as_str().to_string());
+
+    ProjectFile { path: path.clone(), owner }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::collections::HashMap;
+
+    use super::*;
+    type FirstLine = &'static str;
+    type Owner = &'static str;
+
+    #[test]
+    fn test_team_regex() {
+        let mut map: HashMap<FirstLine, Owner> = HashMap::new();
+        map.insert("// @team Foo", "Foo");
+        map.insert("// @team Foo Bar", "Foo Bar");
+        map.insert("// @team Zoo", "Zoo");
+        map.insert("// @team: Zoo Foo", "Zoo Foo");
+        map.insert("# @team: Bap", "Bap");
+        map.insert("# @team: Bap Hap", "Bap Hap");
+        map.insert("<!-- @team: Zoink -->", "Zoink");
+        map.insert("<!-- @team: Zoink Err -->", "Zoink Err");
+        map.insert("<%# @team: Zap %>", "Zap");
+        map.insert("<%# @team: Zap Zip%>", "Zap Zip");
+        map.insert("<!-- @team Blast -->", "Blast");
+        map.insert("<!-- @team Blast Off -->", "Blast Off");
+
+        for (key, value) in map {
+            let owner = TEAM_REGEX.captures(key).and_then(|cap| cap.get(1)).map(|m| m.as_str());
+            assert_eq!(owner, Some(value));
+        }
+    }
+}