mirror of
https://github.com/launchbadge/sqlx.git
synced 2026-03-19 16:44:07 +00:00
0c8fe729ff
* Traverse symlinks when resolving migrations When enumerating the source directory seeking migration files, `sqlx` ignores entries that aren't files. This was previously reported as #614 and fixed in #985 but apparently regressed somewhere along the way. This commit reintroduces the fix from #985 to the current implementation: use `std::fs::metadata` instead of `std::fs::DirEntry::metadata`. The former is documented to traverse symlinks; the latter does not. * add migrations_symlink test
74 lines
2.6 KiB
Rust
74 lines
2.6 KiB
Rust
use crate::error::BoxDynError;
|
|
use crate::fs;
|
|
use crate::migrate::{Migration, MigrationType};
|
|
use futures_core::future::BoxFuture;
|
|
|
|
use std::borrow::Cow;
|
|
use std::fmt::Debug;
|
|
use std::path::{Path, PathBuf};
|
|
|
|
pub trait MigrationSource<'s>: Debug {
|
|
fn resolve(self) -> BoxFuture<'s, Result<Vec<Migration>, BoxDynError>>;
|
|
}
|
|
|
|
/// Implementation of the `MigrationSource` for [std::path::Path].
|
|
///
|
|
/// The path has to point to a directory, which contains the migration SQL scripts. All these
|
|
/// scripts must be stored in files with names using the format `<VERSION>_<DESCRIPTION>.sql`,
|
|
/// where `<VERSION>` is a string that can be parsed into `i64` and its value is greater than zero,
|
|
/// and `<DESCRIPTION>` is a string.
|
|
impl<'s> MigrationSource<'s> for &'s Path {
|
|
fn resolve(self) -> BoxFuture<'s, Result<Vec<Migration>, BoxDynError>> {
|
|
Box::pin(async move {
|
|
let mut s = fs::read_dir(self.canonicalize()?).await?;
|
|
let mut migrations = Vec::new();
|
|
|
|
while let Some(entry) = s.next().await? {
|
|
// std::fs::metadata traverses symlinks
|
|
if !std::fs::metadata(&entry.path)?.is_file() {
|
|
// not a file; ignore
|
|
continue;
|
|
}
|
|
|
|
let file_name = entry.file_name.to_string_lossy();
|
|
|
|
let parts = file_name.splitn(2, '_').collect::<Vec<_>>();
|
|
|
|
if parts.len() != 2 || !parts[1].ends_with(".sql") {
|
|
// not of the format: <VERSION>_<DESCRIPTION>.sql; ignore
|
|
continue;
|
|
}
|
|
|
|
let version: i64 = parts[0].parse()?;
|
|
|
|
let migration_type = MigrationType::from_filename(parts[1]);
|
|
// remove the `.sql` and replace `_` with ` `
|
|
let description = parts[1]
|
|
.trim_end_matches(migration_type.suffix())
|
|
.replace('_', " ")
|
|
.to_owned();
|
|
|
|
let sql = fs::read_to_string(&entry.path).await?;
|
|
|
|
migrations.push(Migration::new(
|
|
version,
|
|
Cow::Owned(description),
|
|
migration_type,
|
|
Cow::Owned(sql),
|
|
));
|
|
}
|
|
|
|
// ensure that we are sorted by `VERSION ASC`
|
|
migrations.sort_by_key(|m| m.version);
|
|
|
|
Ok(migrations)
|
|
})
|
|
}
|
|
}
|
|
|
|
impl MigrationSource<'static> for PathBuf {
|
|
fn resolve(self) -> BoxFuture<'static, Result<Vec<Migration>, BoxDynError>> {
|
|
Box::pin(async move { self.as_path().resolve().await })
|
|
}
|
|
}
|