Change ID Database

Cargo.toml

@@ -7,14 +7,15 @@ members = [
     "crates/gitbutler-watcher/vendor/debouncer",
     "crates/gitbutler-testsupport",
     "crates/gitbutler-cli",
+    "crates/gitbutler-project-store"
 ]
 resolver = "2"
 
 [workspace.dependencies]
 # Add the `tracing` or `tracing-detail` features to see more of gitoxide in the logs. Useful to see which programs it invokes.
 gix = { git = "https://github.com/Byron/gitoxide", rev = "55cbc1b9d6f210298a86502a7f20f9736c7e963e", default-features = false, features = [] }
 git2 = { version = "0.18.3", features = ["vendored-openssl", "vendored-libgit2"] }
-uuid = { version = "1.8.0", features = ["serde"] }
+uuid = { version = "1.8.0", features = ["serde", "v4", "v7"] }
 serde = { version = "1.0", features = ["derive"] }
 thiserror = "1.0.61"
 tokio = { version = "1.38.0", default-features = false }
@@ -25,6 +26,7 @@ gitbutler-core = { path = "crates/gitbutler-core" }
 gitbutler-watcher = { path = "crates/gitbutler-watcher" }
 gitbutler-testsupport = { path = "crates/gitbutler-testsupport" }
 gitbutler-cli ={ path = "crates/gitbutler-cli" }
+gitbutler-project-store = { path = "crates/gitbutler-project-store" }
 
 [profile.release]
 codegen-units = 1 # Compile crates one after another so the compiler can optimize better

crates/gitbutler-core/Cargo.toml

@@ -57,6 +57,7 @@ uuid.workspace = true
 walkdir = "2.5.0"
 zip = "0.6.5"
 gitbutler-git.workspace = true
+gitbutler-project-store.workspace = true
 
 [features]
 # by default Tauri runs in production mode

crates/gitbutler-project-store/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "gitbutler-project-store"
+version = "0.0.0"
+edition = "2021"
+publish = false
+
+[lib]
+path = "src/lib.rs"
+doctest = false
+test = false
+
+[dev.dependencies]
+gitbutler-testsupport.workspace = true
+
+[dependencies]
+rusqlite = { version = "0.31.0", features = ["bundled", "uuid"] }
+anyhow = "1.0.86"
+uuid.workspace = true

crates/gitbutler-project-store/src/changes.rs

@@ -0,0 +1,9 @@
+use rusqlite::Connection;
+
+// TODO: rename to patches
+/// The changes struct provides a
+pub struct Changes<'l> {
+    connection: &'l mut Connection,
+}
+
+impl<'l> Changes<'l> {}

crates/gitbutler-project-store/src/lib.rs

@@ -0,0 +1,92 @@
+use anyhow::{anyhow, Context, Result};
+use migrations::{gitbutler_migrations::gitbutler_migrations, migrator::Migrator};
+use rusqlite::Connection;
+use std::path::Path;
+
+mod changes;
+mod migrations;
+
+const DATABASE_NAME: &str = "project.sqlite";
+
+/// ProjectStore provides a light wrapper around a sqlite database
+struct ProjectStore {
+    connection: Connection,
+}
+
+impl ProjectStore {}
+
+/// Database setup
+///
+/// Before touching any database related code, please read https://github.com/the-lean-crate/criner/discussions/5 first.
+impl ProjectStore {
+    /// Creates an instance of ProjectStore and runs any pending sqlite migrations
+    /// gitbutler_project_directory should be the `.git/gitbutler` path of a given
+    /// repository
+    pub fn initialize(gitbutler_project_directory: &Path) -> Result<ProjectStore> {
+        let database_path = gitbutler_project_directory.join(DATABASE_NAME);
+        let database_path = database_path.to_str().ok_or(anyhow!(
+            "Failed to get database {}",
+            gitbutler_project_directory.display()
+        ))?;
+
+        let connection = Connection::open(database_path)?;
+
+        ProjectStore::configure_connection(&connection)?;
+
+        let mut project_store = ProjectStore { connection };
+
+        project_store.run_migrations()?;
+
+        Ok(project_store)
+    }
+
+    /// Configures a sqlite connection to behave sensibly in a concurrent environemnt.
+    ///
+    /// Busy handler and pargma's have been taken from https://github.com/the-lean-crate/criner/discussions/5
+    /// and will help with concurrent reading and writing.
+    ///
+    /// This should be run before a project store is created and any other SQL is run.
+    fn configure_connection(connection: &Connection) -> Result<()> {
+        connection
+            .busy_handler(Some(sleeper))
+            .context("Failed to set connection's busy handler")?;
+
+        connection.execute_batch("
+            PRAGMA journal_mode = WAL;          -- better write-concurrency
+            PRAGMA synchronous = NORMAL;        -- fsync only in critical moments
+            PRAGMA wal_autocheckpoint = 1000;   -- write WAL changes back every 1000 pages, for an in average 1MB WAL file. May affect readers if number is increased
+            PRAGMA wal_checkpoint(TRUNCATE);    -- free some space by truncating possibly massive WAL files from the last run.
+        ").context("Failed to set PRAGMA's for connection")?;
+
+        Ok(())
+    }
+
+    /// Calls the migrator with appropriate migrations
+    fn run_migrations(&mut self) -> Result<()> {
+        let mut migrator = Migrator::new(&mut self.connection);
+        migrator.migrate(gitbutler_migrations())?;
+        Ok(())
+    }
+}
+
+fn sleeper(attempts: i32) -> bool {
+    println!("SQLITE_BUSY, retrying after 50ms (attempt {})", attempts);
+    std::thread::sleep(std::time::Duration::from_millis(50));
+    true
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn run_migrations_should_succeed() {
+        let connection = Connection::open_in_memory().unwrap();
+
+        ProjectStore::configure_connection(&connection).unwrap();
+
+        let mut project_store = ProjectStore { connection };
+
+        project_store.run_migrations().unwrap()
+    }
+}

crates/gitbutler-project-store/src/migrations/gitbutler_migrations.rs

@@ -0,0 +1,29 @@
+use super::migration::Migration;
+
+const CREATE_BASE_SCHEMA: &str = "
+CREATE TABLE changes (
+    id BLOB PRIMARY KEY NOT NULL, -- A UUID v4
+    is_unapplied_wip INTEGER NOT NULL,
+    unapplied_vbranch_name TEXT,
+    created_at INTEGER -- A unix timestamp in seconds when the record was created
+);
+CREATE TABLE commits (
+    sha TEXT PRIMARY KEY NOT NULL, -- A commit SHA as a base16 string
+    created_at INTEGER, -- A unix timestamp in seconds when the record was created
+    change_id BLOB NOT NULL,
+    FOREIGN KEY(change_id) REFERENCES changes(change_id)
+);
+";
+
+pub(crate) fn gitbutler_migrations() -> Vec<Migration> {
+    let base_migration = Migration {
+        name: "base".to_string(),
+        up: |connection| {
+            connection.execute_batch(CREATE_BASE_SCHEMA)?;
+
+            Ok(())
+        },
+    };
+
+    vec![base_migration]
+}

crates/gitbutler-project-store/src/migrations/migration.rs

@@ -0,0 +1,10 @@
+use anyhow::Result;
+use rusqlite::Connection;
+
+pub(crate) struct Migration {
+    /// A unique identifier for the migration
+    pub name: String,
+    /// A function which performs the migration. The up function gets run inside
+    /// of a transaction.
+    pub up: fn(&Connection) -> Result<()>,
+}