obtain a repository-list with classifiers

Byron · Byron · commit 4c799d3f5e87 · 2023-06-14T22:06:25.000+02:00
If the obtained list is empty, we update against that empty list which
fills the repositories tables for the first time.

Additionally we provide a new sub-command to refresh the list (additions only).
diff --git a/gitoxide-core/Cargo.toml b/gitoxide-core/Cargo.toml
@@ -22,7 +22,8 @@ estimate-hours = ["dep:itertools", "dep:fs-err", "dep:crossbeam-channel", "dep:s
 ## Gather information about repositories and store it in a database for easy querying.
 query = ["dep:rusqlite"]
 ## Run algorithms on a corpus of repositories and store their results for later comparison and intelligence gathering.
-corpus = ["dep:rusqlite", "dep:sysinfo"]
+## *Note that* `organize` we need for finding git repositories fast.
+corpus = ["dep:rusqlite", "dep:sysinfo", "organize", "dep:crossbeam-channel"]
 
 #! ### Mutually Exclusive Networking
 #! If both are set, _blocking-client_ will take precedence, allowing `--all-features` to be used.
diff --git a/gitoxide-core/src/corpus/mod.rs b/gitoxide-core/src/corpus/mod.rs
@@ -1,13 +1,25 @@
+pub const PROGRESS_RANGE: std::ops::RangeInclusive<u8> = 0..=3;
+
 pub struct Engine<P> {
     progress: P,
     con: rusqlite::Connection,
     gitoxide_version: String,
 }
 
+pub struct RunOutcome {
+    /// the relative path to the repositories that could not be found on disk
+    pub missing_repos_rela_paths: usize,
+}
+
 pub mod engine {
+    use super::db;
     use crate::corpus::Engine;
+    use crate::organize::find_git_repository_workdirs;
     use anyhow::Context;
-    use std::path::PathBuf;
+    use bytesize::ByteSize;
+    use rusqlite::params;
+    use std::path::{Path, PathBuf};
+    use std::time::Instant;
 
     pub(crate) type Id = u32;
 
@@ -26,11 +38,124 @@ pub mod engine {
         }
 
         /// Run on the existing set of repositories we have already seen or obtain them from `path` if there is none yet.
-        pub fn run(&self, path: PathBuf) -> anyhow::Result<()> {
-            let _corpus_id = self.corpus_id_or_insert(&path)?;
+        pub fn run(&mut self, corpus_path: PathBuf) -> anyhow::Result<()> {
+            let corpus_path = gix::path::realpath(corpus_path)?;
+            let corpus_id = self.corpus_id_or_insert(&corpus_path)?;
             let _gitoxide_id = self.gitoxide_version_id_or_insert()?;
             let _runner_id = self.runner_id_or_insert()?;
-            todo!()
+            let _repos = self.find_repos_or_insert(&corpus_path, corpus_id)?;
+            todo!("do run on repos")
+        }
+
+        fn find_repos(&mut self, corpus_id: Id) -> anyhow::Result<Vec<db::Repo>> {
+            self.progress.set_name("query db-repos");
+            self.progress.init(None, gix::progress::count("repos"));
+
+            Ok(self
+                .con
+                .prepare(
+                    "SELECT id, rela_path, odb_size, num_objects, num_references FROM repository WHERE corpus = ?1",
+                )?
+                .query_map([corpus_id], |r| {
+                    Ok(db::Repo {
+                        id: r.get(0)?,
+                        path: r.get::<_, String>(1)?.into(),
+                        odb_size: ByteSize(r.get(2)?),
+                        num_objects: r.get(3)?,
+                        num_references: r.get(4)?,
+                    })
+                })?
+                .inspect(|_| self.progress.inc())
+                .collect::<Result<_, _>>()?)
+        }
+
+        fn refresh_repos(&mut self, corpus_path: &Path, corpus_id: Id) -> anyhow::Result<Vec<db::Repo>> {
+            let start = Instant::now();
+            self.progress.set_name("refresh");
+            self.progress.init(None, gix::progress::count("repos"));
+
+            let repos = std::thread::scope({
+                let progress = &mut self.progress;
+                let con = &mut self.con;
+                |scope| -> anyhow::Result<_> {
+                    let threads = std::thread::available_parallelism()
+                        .map(std::num::NonZeroUsize::get)
+                        .ok()
+                        .unwrap_or(1);
+                    let (path_tx, repo_rx) = {
+                        let (path_tx, path_rx) = crossbeam_channel::bounded(threads * 2);
+                        let (repo_tx, repo_rx) = std::sync::mpsc::channel::<(PathBuf, anyhow::Result<db::Repo>)>();
+                        (0..threads).for_each(|_| {
+                            scope.spawn({
+                                let path_rx = path_rx.clone();
+                                let repo_tx = repo_tx.clone();
+                                move || -> anyhow::Result<_> {
+                                    for repo_path in path_rx {
+                                        let res = (|| {
+                                            let repo = gix::open_opts(&repo_path, gix::open::Options::isolated())?;
+                                            db::Repo::try_from(&repo)
+                                        })();
+                                        repo_tx.send((repo_path, res))?;
+                                    }
+                                    Ok(())
+                                }
+                            });
+                        });
+                        (path_tx, repo_rx)
+                    };
+
+                    let find_progress = progress.add_child("find");
+                    let write_db = scope.spawn(move || -> anyhow::Result<Vec<db::Repo>> {
+                        progress.set_name("write to DB");
+                        progress.init(None, gix::progress::count("repos"));
+                        let start = Instant::now();
+
+                        let mut out = Vec::new();
+                        let mut statement = con.prepare("INSERT INTO repository (rela_path, corpus, odb_size, num_objects, num_references) VALUES (?1, ?2, ?3, ?4, ?5)\
+                                                        ON CONFLICT DO UPDATE SET rela_path = rela_path, corpus = corpus, odb_size = ?3, num_objects = ?4, num_references = ?5\
+                                                        RETURNING id")?;
+                        for (repo_path, repo_res) in repo_rx {
+                            match repo_res {
+                                Ok(mut repo) => {
+                                    let rela_path = repo.path.strip_prefix(corpus_path)?;
+                                    repo.id = statement.query_row(params![rela_path.to_str().context("only valid UTF8 is allowed for repository paths")?, corpus_id, repo.odb_size.as_u64(), repo.num_objects, repo.num_references], |r| r.get(0))?;
+                                    out.push(repo);
+                                    progress.inc();
+                                }
+                                Err(err) => progress.fail(format!("{repo_path:?}: {err:#?}")),
+                            }
+                        }
+                        statement.finalize()?;
+                        progress.show_throughput(start);
+                        Ok(out)
+                    });
+
+                    let repos = gix::interrupt::Iter::new(
+                        find_git_repository_workdirs(corpus_path, find_progress, false, Some(threads)),
+                        || anyhow::anyhow!("interrupted by user"),
+                    );
+                    for res in repos {
+                        let (repo_path, _kind) = res?;
+                        path_tx.send(repo_path)?;
+                    }
+                    drop(path_tx);
+                    write_db.join().expect("no panic")
+                }
+            })?;
+
+            self.progress.show_throughput(start);
+            Ok(repos)
+        }
+
+        fn find_repos_or_insert(&mut self, corpus_path: &Path, corpus_id: Id) -> anyhow::Result<Vec<db::Repo>> {
+            let start = Instant::now();
+            let repos = self.find_repos(corpus_id)?;
+            if repos.is_empty() {
+                self.refresh_repos(corpus_path, corpus_id)
+            } else {
+                self.progress.show_throughput(start);
+                Ok(repos)
+            }
         }
     }
 }
@@ -39,10 +164,49 @@ pub mod db {
     use crate::corpus::engine::Id;
     use crate::corpus::Engine;
     use anyhow::{bail, Context};
+    use bytesize::ByteSize;
     use rusqlite::{params, OptionalExtension};
-    use std::path::Path;
+    use std::path::{Path, PathBuf};
     use sysinfo::{CpuExt, CpuRefreshKind, RefreshKind, SystemExt};
 
+    /// a husk of a repository
+    pub(crate) struct Repo {
+        pub(crate) id: Id,
+        /// The full path to the repository on disk, not yet validated to exist.
+        pub(crate) path: PathBuf,
+        /// The size of the object database, counted quickly by packs only.
+        pub(crate) odb_size: ByteSize,
+        /// The amount of objects stored in the object database.
+        pub(crate) num_objects: u64,
+        /// The total amount of references, no matter which type.
+        pub(crate) num_references: usize,
+    }
+
+    impl Repo {
+        pub(crate) fn try_from(repo: &gix::Repository) -> anyhow::Result<Self> {
+            let num_references = repo.refs.iter()?.all()?.count();
+            let num_objects = repo.objects.packed_object_count()?;
+            let odb_size = ByteSize(
+                std::fs::read_dir(repo.objects.store_ref().path().join("pack"))
+                    .map(|dir| {
+                        dir.filter_map(Result::ok)
+                            .filter_map(|e| e.metadata().ok())
+                            .filter_map(|m| m.is_file().then_some(m.len()))
+                            .sum()
+                    })
+                    .unwrap_or_default(),
+            );
+
+            Ok(Repo {
+                id: 0,
+                path: repo.path().to_owned(),
+                odb_size,
+                num_objects,
+                num_references,
+            })
+        }
+    }
+
     /// A version to be incremented whenever the database layout is changed, to refresh it automatically.
     const VERSION: usize = 1;
 
@@ -67,9 +231,11 @@ pub mod db {
             },
             _ => {}
         }
+        con.execute_batch("PRAGMA synchronous = OFF;")?;
         con.execute_batch(
             r#"
         CREATE TABLE if not exists runner(
+            id integer PRIMARY KEY,
             vendor text,
             brand text,
             host_name text, -- this is just to help ID the runner
@@ -80,22 +246,29 @@ pub mod db {
         con.execute_batch(
             r#"
         CREATE TABLE if not exists corpus(
+            id integer PRIMARY KEY,
             root text UNIQUE -- the root path of all repositories we want to consider, as canonicalized path
         )
         "#,
         )?;
         con.execute_batch(
             r#"
         CREATE TABLE if not exists repository(
-            rela_path text UNIQUE, -- the path to the repository on disk, relative to the corpus root path, without leading `./` or `.\`
+            id integer PRIMARY KEY,
+            rela_path text, -- the path to the repository on disk, relative to the corpus root path, without leading `./` or `.\`
             corpus integer,
-            FOREIGN KEY (corpus) REFERENCES corpus (rowid)
+            odb_size integer, -- the object database size in bytes
+            num_references integer, -- the total amount of references
+            num_objects integer, -- the total amount of objects
+            FOREIGN KEY (corpus) REFERENCES corpus (id)
+            UNIQUE (rela_path, corpus)
         )
         "#,
         )?;
         con.execute_batch(
             r#"
         CREATE TABLE if not exists gitoxide_version(
+            id integer PRIMARY KEY,
             version text UNIQUE -- the unique git version via gix describe
         )
         "#,
@@ -109,9 +282,9 @@ pub mod db {
             start_time integer,
             end_time integer, -- or NULL if not yet finished (either successfull or with failure)
             error text, -- or NULL if there was on error
-            FOREIGN KEY (repository) REFERENCES repository (rowid),
-            FOREIGN KEY (runner) REFERENCES runner (rowid),
-            FOREIGN KEY (gitoxide_version) REFERENCES gitoxide_version (rowid)
+            FOREIGN KEY (repository) REFERENCES repository (id),
+            FOREIGN KEY (runner) REFERENCES runner (id),
+            FOREIGN KEY (gitoxide_version) REFERENCES gitoxide_version (id)
         )
         "#,
         )?;
@@ -129,73 +302,30 @@ pub mod db {
             let vendor = Some(cpu.vendor_id().to_owned());
             let host = sys.host_name();
             let brand = Some(cpu.brand().to_owned());
-            Ok(
-                match self
-                    .con
-                    .query_row(
-                        "SELECT rowid FROM runner WHERE vendor = ?1 AND brand = ?2",
-                        [vendor.as_deref(), brand.as_deref()],
-                        |r| r.get(0),
-                    )
-                    .optional()?
-                {
-                    Some(existing) => existing,
-                    None => {
-                        self.con.execute(
-                            "INSERT INTO runner (vendor, brand, host_name) VALUES (?1, ?2, ?3)",
-                            [vendor.as_deref(), brand.as_deref(), host.as_deref()],
-                        )?;
-                        self.con.query_row(
-                            "SELECT rowid FROM runner WHERE vendor = ?1 AND brand = ?2",
-                            [vendor, brand],
-                            |r| r.get(0),
-                        )?
-                    }
-                },
-            )
+            Ok(self.con.query_row(
+                "INSERT INTO runner (vendor, brand, host_name) VALUES (?1, ?2, ?3) \
+                        ON CONFLICT DO UPDATE SET vendor = vendor, brand = brand, host_name = ?3 RETURNING id",
+                [vendor.as_deref(), brand.as_deref(), host.as_deref()],
+                |r| r.get(0),
+            )?)
         }
         pub(crate) fn corpus_id_or_insert(&self, path: &Path) -> anyhow::Result<Id> {
             let path = path.to_str().context("corpus root cannot contain illformed UTF-8")?;
-            Ok(
-                match self
-                    .con
-                    .query_row("SELECT rowid FROM corpus WHERE root = ?1", [path], |r| r.get(0))
-                    .optional()?
-                {
-                    Some(existing) => existing,
-                    None => {
-                        self.con.execute("INSERT INTO corpus (root) VALUES (?1)", [path])?;
-                        self.con
-                            .query_row("SELECT rowid FROM corpus WHERE root = ?1", [path], |r| r.get(0))?
-                    }
-                },
-            )
+            Ok(self.con.query_row(
+                "INSERT INTO corpus (root) VALUES (?1) \
+                    ON CONFLICT DO UPDATE SET root = root RETURNING id",
+                [path],
+                |r| r.get(0),
+            )?)
         }
         pub(crate) fn gitoxide_version_id_or_insert(&self) -> anyhow::Result<Id> {
-            Ok(
-                match self
+            Ok(self
                     .con
                     .query_row(
-                        "SELECT rowid FROM gitoxide_version WHERE version = ?1",
+                        "INSERT INTO gitoxide_version (version) VALUES (?1) ON CONFLICT DO UPDATE SET version = version RETURNING id",
                         [&self.gitoxide_version],
                         |r| r.get(0),
-                    )
-                    .optional()?
-                {
-                    Some(existing) => existing,
-                    None => {
-                        self.con.execute(
-                            "INSERT INTO gitoxide_version (version) VALUES (?1)",
-                            [&self.gitoxide_version],
-                        )?;
-                        self.con.query_row(
-                            "SELECT rowid FROM gitoxide_version WHERE version = ?1",
-                            [&self.gitoxide_version],
-                            |r| r.get(0),
-                        )?
-                    }
-                },
-            )
+                    )?)
         }
     }
 }
diff --git a/gitoxide-core/src/organize.rs b/gitoxide-core/src/organize.rs
@@ -12,7 +12,7 @@ pub enum Mode {
     Simulate,
 }
 
-fn find_git_repository_workdirs(
+pub fn find_git_repository_workdirs(
     root: impl AsRef<Path>,
     mut progress: impl Progress,
     debug: bool,
diff --git a/src/plumbing/main.rs b/src/plumbing/main.rs
@@ -134,9 +134,9 @@ pub fn main() -> Result<()> {
             auto_verbose,
             progress,
             progress_keep_open,
-            None,
+            core::corpus::PROGRESS_RANGE,
             move |progress, _out, _err| {
-                let engine = core::corpus::Engine::open_or_create(db, env!("GITOXIDE_VERSION").into(), progress)?;
+                let mut engine = core::corpus::Engine::open_or_create(db, env!("GITOXIDE_VERSION").into(), progress)?;
                 match cmd {
                     crate::plumbing::options::corpus::SubCommands::Run => engine.run(path),
                 }

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ pub enum Mode {`
`12`	`12`	`Simulate,`
`13`	`13`	`}`
`14`	`14`
`15`		`-fn find_git_repository_workdirs(`
	`15`	`+pub fn find_git_repository_workdirs(`
`16`	`16`	`root: impl AsRef<Path>,`
`17`	`17`	`mut progress: impl Progress,`
`18`	`18`	`debug: bool,`