refactor(db): add sqlx-migrate-validate and optimize backup logic

.changes/unreleased/Fixed and Improvements-20241226-202337.yaml

@@ -0,0 +1,3 @@
+kind: Fixed and Improvements
+body: Backup database only when there's pending schema migrations
+time: 2024-12-26T20:23:37.914517+08:00

Cargo.toml

@@ -14,12 +14,13 @@ members = [
     "crates/llama-cpp-server",
     "crates/ollama-api-bindings",
     "crates/tabby-index-cli",
+    "crates/hash-ids",
+    "crates/sqlx-migrate-validate",
 
     "ee/tabby-webserver",
     "ee/tabby-db",
     "ee/tabby-db-macros",
     "ee/tabby-schema",
-    "crates/hash-ids",
 ]
 
 [workspace.package]
@@ -76,6 +77,8 @@ opentelemetry = { version = "0.27.0", features = ["trace", "metrics"] }
 opentelemetry_sdk = { version = "0.27.0", default-features = false, features = ["trace", "rt-tokio"] }
 opentelemetry-otlp = { version = "0.27.0" }
 opentelemetry-semantic-conventions = { version = "0.27.0", features = ["semconv_experimental"] }
+# https://github.com/wsxiaoys/sqlx/tree/fix-0-7-4-remove-datetime-utc-encode
+sqlx = { git = "https://github.com/wsxiaoys/sqlx", rev = "8ca573c" }
 
 [workspace.dependencies.uuid]
 version = "1.3.3"

crates/sqlx-migrate-validate/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "sqlx-migrate-validate"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+homepage.workspace = true
+
+[dependencies]
+thiserror.workspace = true
+async-trait.workspace = true
+sqlx = { workspace = true, features = ["sqlite", "runtime-tokio"] }
+
+[dev-dependencies]
+anyhow.workspace = true
+tokio = { workspace = true, features = ["macros", "rt"] }
+sqlx-rt = { version = "0.6", features = [ "runtime-tokio-rustls" ] }

crates/sqlx-migrate-validate/README.md

@@ -0,0 +1,3 @@
+# sqlx-migrate-validate
+
+Vendored fork of https://github.com/tobikris/sqlx-migrate-validate

crates/sqlx-migrate-validate/src/error.rs

@@ -0,0 +1,11 @@
+use sqlx::migrate::MigrateError;
+
+#[derive(Debug, thiserror::Error)]
+#[non_exhaustive]
+pub enum ValidateError {
+    #[error("migration {0} was not applied")]
+    VersionNotApplied(i64),
+
+    #[error(transparent)]
+    MigrateError(#[from] MigrateError),
+}

crates/sqlx-migrate-validate/src/lib.rs

@@ -0,0 +1,36 @@
+//! With [sqlx] and its [sqlx::migrate!] macro it is possible to create migrations and apply them to a database.
+//! When starting an application it is important to validate that the database is in the correct state.
+//! This crate provides a way to validate that the applied migrations match the desired migrations.
+//! In combination with the [sqlx::migrate!] macro it is possible to validate that the database schema
+//! matches the migrations present in the source code at the time of compilation.
+//!
+//! While this does not ensure full compatibility between the database and the application it can help
+//! to detect issues early.
+//!
+//! Examples:
+//!
+//! ```rust,no_run
+//! use sqlx_migrate_validate::{Validate, Validator};
+//!
+//! #[tokio::main]
+//! async fn main() -> Result<(), anyhow::Error> {
+//!     let pool = sqlx::SqlitePool::connect("sqlite::memory:").await?;
+//!     let mut conn = pool.acquire().await?;
+//!
+//!     sqlx::migrate!("./tests/migrations-1")
+//!         .validate(&mut *conn)
+//!         .await?;
+//!
+//!     Ok(())
+//! }
+//! ```
+
+mod error;
+mod validate;
+
+pub use error::ValidateError;
+pub use validate::*;
+
+#[doc = include_str!("../README.md")]
+#[cfg(doctest)]
+pub struct ReadmeDoctests;