run_migrations

Author: epompeii

Cargo.lock

@@ -53,6 +53,7 @@ uuid = { workspace = true, features = ["v4", "serde"] }
 aws-credential-types = "1.2"
 aws-sdk-s3 = { version = "1.57", features = ["behavior-version-latest"] }
 css-inline = "0.14"
+diesel_migrations = "2.2"
 mail-send = "0.5"
 sentry = { version = "0.36", optional = true, default-features = false, features = [
     "reqwest",

lib/bencher_schema/Cargo.toml

@@ -3,6 +3,9 @@
 // Needed for distroless builds
 use libsqlite3_sys as _;
 
+use diesel::connection::SimpleConnection;
+use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
+
 pub mod context;
 pub mod error;
 pub mod headers;
@@ -14,3 +17,36 @@ pub mod schema;
 pub mod view;
 
 pub const API_VERSION: &str = env!("CARGO_PKG_VERSION");
+
+const MIGRATIONS: EmbeddedMigrations = embed_migrations!("./migrations");
+
+#[derive(Debug, thiserror::Error)]
+pub enum MigrationError {
+    #[error("Failed to run database migrations: {0}")]
+    Migrations(Box<dyn std::error::Error + Send + Sync>),
+    #[error("Failed to run database pragma off: {0}")]
+    PragmaOff(diesel::result::Error),
+    #[error("Failed to run database pragma on: {0}")]
+    PragmaOn(diesel::result::Error),
+}
+
+pub fn run_migrations(database: &mut context::DbConnection) -> Result<(), MigrationError> {
+    // It is not possible to enable or disable foreign key constraints in the middle of a multi-statement transaction
+    // (when SQLite is not in autocommit mode).
+    // Attempting to do so does not return an error; it simply has no effect.
+    // https://www.sqlite.org/foreignkeys.html#fk_enable
+    // Therefore, we must run all migrations with foreign key constraints disabled.
+    // Still use `PRAGMA foreign_keys = OFF` in the migration scripts to disable foreign key constraints when using the CLI.
+    database
+        .batch_execute("PRAGMA foreign_keys = OFF")
+        .map_err(MigrationError::PragmaOff)?;
+    database
+        .run_pending_migrations(MIGRATIONS)
+        .map(|_| ())
+        .map_err(MigrationError::Migrations)?;
+    database
+        .batch_execute("PRAGMA foreign_keys = ON")
+        .map_err(MigrationError::PragmaOn)?;
+
+    Ok(())
+}

lib/bencher_schema/src/lib.rs

@@ -12,6 +12,7 @@ chrono.workspace = true
 jsonwebtoken.workspace = true
 serde.workspace = true
 thiserror.workspace = true
+uuid = { workspace = true, features = ["v4"] }
 
 [lints]
 workspace = true

lib/bencher_token/Cargo.toml

@@ -1,5 +1,8 @@
 use std::sync::LazyLock;
 
+#[cfg(debug_assertions)]
+use uuid as _;
+
 use bencher_json::Secret;
 
 mod audience;

lib/bencher_token/src/lib.rs

@@ -45,7 +45,6 @@ url.workspace = true
 uuid = { workspace = true, features = ["v4", "serde"] }
 # Crate
 async-compression = { version = "0.4", features = ["tokio", "gzip"] }
-diesel_migrations = "2.2"
 paste = "1.0"
 sentry = { version = "0.36", optional = true, default-features = false, features = [
     "reqwest",

services/api/Cargo.toml

@@ -15,7 +15,6 @@ use bencher_schema::context::{ApiContext, Database, DbConnection};
 use bencher_schema::model::server::QueryServer;
 use bencher_token::TokenKey;
 use diesel::{connection::SimpleConnection, Connection};
-use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
 use dropshot::{
     ApiDescription, ConfigDropshot, ConfigLogging, ConfigLoggingIfExists, ConfigLoggingLevel,
     ConfigTls, HttpServer,
@@ -29,7 +28,6 @@ use super::{plus::Plus, DEFAULT_BUSY_TIMEOUT};
 use crate::endpoints::Api;
 
 const DATABASE_URL: &str = "DATABASE_URL";
-const MIGRATIONS: EmbeddedMigrations = embed_migrations!("../../lib/bencher_schema/migrations");
 
 pub struct ConfigTx {
     pub config: Config,
@@ -40,8 +38,8 @@ pub struct ConfigTx {
 pub enum ConfigTxError {
     #[error("Failed to create server logger: {0}")]
     CreateLogger(std::io::Error),
-    #[error("Failed to run database migrations: {0}")]
-    Migrations(Box<dyn std::error::Error + Send + Sync>),
+    #[error("{0}")]
+    Migrations(#[from] bencher_schema::MigrationError),
     #[error("Failed to run database pragma: {0}")]
     Pragma(diesel::result::Error),
     #[error("Failed to parse role based access control (RBAC) rules: {0}")]
@@ -172,7 +170,7 @@ fn into_context(
     }
 
     info!(&log, "Running database migrations");
-    run_migrations(&mut database_connection)?;
+    bencher_schema::run_migrations(&mut database_connection)?;
 
     let data_store = if let Some(data_store) = json_database.data_store {
         Some(data_store.try_into().map_err(ConfigTxError::DataStore)?)
@@ -243,27 +241,6 @@ fn diesel_database_url(log: &Logger, database_path: &str) {
     std::env::set_var(DATABASE_URL, database_path);
 }
 
-fn run_migrations(database: &mut DbConnection) -> Result<(), ConfigTxError> {
-    // It is not possible to enable or disable foreign key constraints in the middle of a multi-statement transaction
-    // (when SQLite is not in autocommit mode).
-    // Attempting to do so does not return an error; it simply has no effect.
-    // https://www.sqlite.org/foreignkeys.html#fk_enable
-    // Therefore, we must run all migrations with foreign key constraints disabled.
-    // Still use `PRAGMA foreign_keys = OFF` in the migration scripts to disable foreign key constraints when using the CLI.
-    database
-        .batch_execute("PRAGMA foreign_keys = OFF")
-        .map_err(ConfigTxError::Pragma)?;
-    database
-        .run_pending_migrations(MIGRATIONS)
-        .map(|_| ())
-        .map_err(ConfigTxError::Migrations)?;
-    database
-        .batch_execute("PRAGMA foreign_keys = ON")
-        .map_err(ConfigTxError::Pragma)?;
-
-    Ok(())
-}
-
 #[cfg(feature = "plus")]
 fn run_litestream(
     database: &mut DbConnection,

services/api/src/config/config_tx.rs

@@ -219,7 +219,7 @@ pub struct Delete;
 impl_method!(Delete, DELETE);
 
 impl Delete {
-    pub fn response_deleted<T>(auth: bool) -> ResponseDeleted {
+    pub fn response_deleted(auth: bool) -> ResponseDeleted {
         if auth {
             Self::auth_response_deleted()
         } else {