trailbase-refinery 0.1.0

Fork of Refinery's refinery-core/macro crates
Documentation
use std::ops::Deref;

use crate::error::WrapMigrationError;
use crate::traits::{
  ASSERT_MIGRATIONS_TABLE_QUERY, GET_APPLIED_MIGRATIONS_QUERY, GET_LAST_APPLIED_MIGRATION_QUERY,
  insert_migration_query, verify_migrations,
};
use crate::{Error, Migration, Report, Target};

pub trait Transaction {
  type Error: std::error::Error + Send + Sync + 'static;

  fn execute<'a, T: Iterator<Item = &'a str>>(&mut self, queries: T) -> Result<usize, Self::Error>;
}

pub trait Query<T>: Transaction {
  fn query(&mut self, query: &str) -> Result<T, Self::Error>;
}

pub fn migrate<T: Transaction>(
  transaction: &mut T,
  migrations: Vec<Migration>,
  target: Target,
  migration_table_name: &str,
  grouped: bool,
) -> Result<Report, Error> {
  let mut migration_batch = Vec::new();
  let mut applied_migrations = Vec::new();

  for mut migration in migrations.into_iter() {
    if let Target::Version(input_target) | Target::FakeVersion(input_target) = target {
      if input_target < migration.version() {
        log::info!(
          "stopping at migration: {}, due to user option",
          input_target
        );
        break;
      }
    }

    log::info!("applying migration: {}", migration);
    migration.set_applied();
    let insert_migration = insert_migration_query(&migration, migration_table_name);
    let migration_sql = migration.sql().expect("sql must be Some!").to_string();

    // If Target is Fake, we only update schema migrations table
    if !matches!(target, Target::Fake | Target::FakeVersion(_)) {
      applied_migrations.push(migration);
      migration_batch.push(migration_sql);
    }
    migration_batch.push(insert_migration);
  }

  match (target, grouped) {
    (Target::Fake | Target::FakeVersion(_), _) => {
      log::info!("not going to apply any migration as fake flag is enabled");
    }
    (Target::Latest | Target::Version(_), true) => {
      log::info!(
        "going to apply batch migrations in single transaction: {:#?}",
        applied_migrations.iter().map(ToString::to_string)
      );
    }
    (Target::Latest | Target::Version(_), false) => {
      log::info!(
        "preparing to apply {} migrations: {:#?}",
        applied_migrations.len(),
        applied_migrations.iter().map(ToString::to_string)
      );
    }
  };

  if grouped {
    transaction
      .execute(migration_batch.iter().map(Deref::deref))
      .migration_err("error applying migrations", None)?;
  } else {
    for (i, update) in migration_batch.into_iter().enumerate() {
      transaction
        .execute([update.as_str()].into_iter())
        .migration_err("error applying update", Some(&applied_migrations[0..i / 2]))?;
    }
  }

  Ok(Report::new(applied_migrations))
}

pub trait Migrate: Query<Vec<Migration>>
where
  Self: Sized,
{
  fn assert_migrations_table(&mut self, migration_table_name: &str) -> Result<usize, Error> {
    // Needed cause some database vendors like Mssql have a non sql standard way of checking the
    // migrations table, thou on this case it's just to be consistent with the async trait
    // `AsyncMigrate`
    self
      .execute(
        [ASSERT_MIGRATIONS_TABLE_QUERY
          .replace("%MIGRATION_TABLE_NAME%", migration_table_name)
          .as_str()]
        .into_iter(),
      )
      .migration_err("error asserting migrations table", None)
  }

  fn get_last_applied_migration(
    &mut self,
    migration_table_name: &str,
  ) -> Result<Option<Migration>, Error> {
    let mut migrations = self
      .query(
        &GET_LAST_APPLIED_MIGRATION_QUERY.replace("%MIGRATION_TABLE_NAME%", migration_table_name),
      )
      .migration_err("error getting last applied migration", None)?;

    Ok(migrations.pop())
  }

  fn get_applied_migrations(
    &mut self,
    migration_table_name: &str,
  ) -> Result<Vec<Migration>, Error> {
    let migrations = self
      .query(&GET_APPLIED_MIGRATIONS_QUERY.replace("%MIGRATION_TABLE_NAME%", migration_table_name))
      .migration_err("error getting applied migrations", None)?;

    Ok(migrations)
  }

  fn get_unapplied_migrations(
    &mut self,
    migrations: &[Migration],
    abort_divergent: bool,
    abort_missing: bool,
    migration_table_name: &str,
  ) -> Result<Vec<Migration>, Error> {
    self.assert_migrations_table(migration_table_name)?;

    let applied_migrations = self.get_applied_migrations(migration_table_name)?;

    let migrations = verify_migrations(
      applied_migrations,
      migrations.to_vec(),
      abort_divergent,
      abort_missing,
    )?;

    if migrations.is_empty() {
      log::info!("no migrations to apply");
    }

    Ok(migrations)
  }

  fn migrate(
    &mut self,
    migrations: &[Migration],
    abort_divergent: bool,
    abort_missing: bool,
    grouped: bool,
    target: Target,
    migration_table_name: &str,
  ) -> Result<Report, Error> {
    let migrations = self.get_unapplied_migrations(
      migrations,
      abort_divergent,
      abort_missing,
      migration_table_name,
    )?;

    if grouped || matches!(target, Target::Fake | Target::FakeVersion(_)) {
      migrate(self, migrations, target, migration_table_name, true)
    } else {
      migrate(self, migrations, target, migration_table_name, false)
    }
  }
}