docbox-management 0.12.0

Management core library for managing docbox used by the cli and other tools
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use crate::database::{DatabaseProvider, close_pool_on_drop};
use docbox_core::database::{
    DbErr, ROOT_DATABASE_NAME,
    create::check_database_table_exists,
    migrations::{apply_root_migrations, initialize_root_migrations},
};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum MigrateRootError {
    #[error("error connecting to root database: {0}")]
    ConnectRootDatabase(DbErr),

    #[error("failed to check migrations table: {0}")]
    CheckMigrationTable(DbErr),

    #[error("failed to initialize migrations table: {0}")]
    CreateMigrationTable(DbErr),

    #[error("failed to apply migrations: {0}")]
    ApplyMigration(DbErr),

    #[error(transparent)]
    StartTransaction(DbErr),

    #[error(transparent)]
    CommitTransaction(DbErr),
}

#[tracing::instrument(skip(db_provider))]
pub async fn migrate_root(
    db_provider: &impl DatabaseProvider,
    target_migration_name: Option<&str>,
) -> Result<(), MigrateRootError> {
    // Connect to the root database
    let root_db = db_provider
        .connect(ROOT_DATABASE_NAME)
        .await
        .map_err(MigrateRootError::ConnectRootDatabase)?;

    let _guard = close_pool_on_drop(&root_db);

    // Check if the migrations table has been initialized
    // (Table did not exist before v0.4.0)
    if !check_database_table_exists(&root_db, "docbox_root_migrations")
        .await
        .map_err(MigrateRootError::CheckMigrationTable)?
    {
        // Initialize the migrations table
        initialize_root_migrations(&root_db)
            .await
            .map_err(MigrateRootError::CreateMigrationTable)?;
    }

    // Start transactions
    let mut root_t = root_db
        .begin()
        .await
        .map_err(MigrateRootError::StartTransaction)?;

    // Apply migrations
    apply_root_migrations(&mut root_t, target_migration_name)
        .await
        .map_err(MigrateRootError::ApplyMigration)?;

    // Commit database transaction
    root_t
        .commit()
        .await
        .map_err(MigrateRootError::CommitTransaction)?;

    Ok(())
}