mirror of
https://github.com/rustfs/rustfs.git
synced 2026-11-08 11:33:41 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3736d14501 |
@@ -110,7 +110,7 @@ threads-required = "num-test-threads"
|
||||
# Reserve capacity so sibling disk-heavy tests cannot consume its 2s
|
||||
# registration budget; retain the queued backup and deadlock assertions.
|
||||
[[profile.default.overrides]]
|
||||
filter = 'package(rustfs) & test(=admin::handlers::table_catalog::tests::cold_object_registration_completes_while_other_bucket_backup_waits)'
|
||||
filter = 'package(rustfs) & test(=admin::handlers::table_catalog::tests::cold_strong_registration_completes_while_other_bucket_backup_waits)'
|
||||
threads-required = "num-test-threads"
|
||||
|
||||
[[profile.default.overrides]]
|
||||
@@ -410,7 +410,7 @@ threads-required = "num-test-threads"
|
||||
# Reserve capacity so sibling disk-heavy tests cannot consume its 2s
|
||||
# registration budget; retain the queued backup and deadlock assertions.
|
||||
[[profile.ci.overrides]]
|
||||
filter = 'package(rustfs) & test(=admin::handlers::table_catalog::tests::cold_object_registration_completes_while_other_bucket_backup_waits)'
|
||||
filter = 'package(rustfs) & test(=admin::handlers::table_catalog::tests::cold_strong_registration_completes_while_other_bucket_backup_waits)'
|
||||
threads-required = "num-test-threads"
|
||||
|
||||
[[profile.ci.overrides]]
|
||||
|
||||
Generated
-2
@@ -10759,7 +10759,6 @@ dependencies = [
|
||||
"arc-swap",
|
||||
"async-compression",
|
||||
"async-trait",
|
||||
"brotli 9.1.1",
|
||||
"bytes",
|
||||
"chrono",
|
||||
"crc-fast",
|
||||
@@ -10769,7 +10768,6 @@ dependencies = [
|
||||
"futures-core",
|
||||
"hotpath",
|
||||
"http 1.5.0",
|
||||
"lz4",
|
||||
"memchr",
|
||||
"metrics",
|
||||
"parking_lot 0.13.0",
|
||||
|
||||
@@ -32,9 +32,8 @@ pub const ENV_OBJECT_MEDIUM_CONCURRENCY_THRESHOLD: &str = "RUSTFS_OBJECT_MEDIUM_
|
||||
|
||||
/// Environment variable name for maximum concurrent disk reads for object operations.
|
||||
/// - Purpose: Limit the number of concurrent disk read operations for object reads to prevent I/O saturation.
|
||||
/// - Unit: request count (usize) for GET; estimated drive fanout for native LIST.
|
||||
/// - Semantics: GET bodies and native LIST walks use separate per-instance budgets of this size.
|
||||
/// A LIST consumes up to one budget, including its disk-producer cleanup. `0` disables both caps.
|
||||
/// - Unit: request count (usize).
|
||||
/// - Semantics: Throttling disk reads helps maintain overall system responsiveness under load.
|
||||
/// - Example: `export RUSTFS_OBJECT_MAX_CONCURRENT_DISK_READS=16`
|
||||
/// - Note: This setting may interact with OS-level I/O scheduling and should be tuned based on hardware capabilities.
|
||||
pub const ENV_OBJECT_MAX_CONCURRENT_DISK_READS: &str = "RUSTFS_OBJECT_MAX_CONCURRENT_DISK_READS";
|
||||
|
||||
@@ -114,10 +114,10 @@ fn staged_commit(metadata: &Value, location: &str) -> Value {
|
||||
})
|
||||
}
|
||||
|
||||
async fn location_claim_preserves_other_users_objects_after_drop_and_restart() -> TestResult {
|
||||
async fn location_claim_preserves_other_users_objects_after_drop_and_restart(backing: &str) -> TestResult {
|
||||
init_logging();
|
||||
let mut env = RustFSTestEnvironment::new().await?;
|
||||
let server_env = [("RUSTFS_TABLE_CATALOG_BACKING", "object")];
|
||||
let server_env = [("RUSTFS_TABLE_CATALOG_BACKING", backing)];
|
||||
env.start_rustfs_server_without_cleanup_with_env(&[("RUSTFS_TABLE_CATALOG_BACKING", "object")])
|
||||
.await?;
|
||||
env.wait_for_server_ready().await?;
|
||||
@@ -147,6 +147,39 @@ async fn location_claim_preserves_other_users_objects_after_drop_and_restart() -
|
||||
StatusCode::OK,
|
||||
)
|
||||
.await?;
|
||||
if backing == "durable-strong" {
|
||||
catalog_request(
|
||||
&env,
|
||||
&root,
|
||||
Method::POST,
|
||||
&format!("/iceberg/v1/{bucket}/catalog/warehouse-index/backfill"),
|
||||
None,
|
||||
StatusCode::NO_CONTENT,
|
||||
)
|
||||
.await?;
|
||||
let preflight = catalog_request(
|
||||
&env,
|
||||
&root,
|
||||
Method::GET,
|
||||
&format!("/iceberg/v1/{bucket}/catalog/migration"),
|
||||
None,
|
||||
StatusCode::OK,
|
||||
)
|
||||
.await?;
|
||||
assert_eq!(preflight["blockers"], json!([]), "{preflight}");
|
||||
let migration = catalog_request(
|
||||
&env,
|
||||
&root,
|
||||
Method::POST,
|
||||
&format!("/iceberg/v1/{bucket}/catalog/migration"),
|
||||
None,
|
||||
StatusCode::OK,
|
||||
)
|
||||
.await?;
|
||||
assert_eq!(migration["ready_to_enable_durable_strong"], json!(true), "{migration}");
|
||||
env.restart_server_preserving_data(vec![], &server_env).await?;
|
||||
env.wait_for_server_ready().await?;
|
||||
}
|
||||
admin_create_user(&env, &creator.0, &creator.1).await?;
|
||||
admin_create_user(&env, &reader.0, &reader.1).await?;
|
||||
let create_statement = json!({
|
||||
@@ -308,7 +341,7 @@ async fn location_claim_preserves_other_users_objects_after_drop_and_restart() -
|
||||
StatusCode::FORBIDDEN,
|
||||
)
|
||||
.await?;
|
||||
{
|
||||
if backing == "object" {
|
||||
catalog_request(
|
||||
&env,
|
||||
&creator,
|
||||
@@ -375,5 +408,10 @@ async fn location_claim_preserves_other_users_objects_after_drop_and_restart() -
|
||||
|
||||
#[tokio::test]
|
||||
async fn object_catalog_location_claim_preserves_objects_after_drop_and_restart() -> TestResult {
|
||||
location_claim_preserves_other_users_objects_after_drop_and_restart().await
|
||||
location_claim_preserves_other_users_objects_after_drop_and_restart("object").await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn durable_strong_catalog_location_claim_preserves_objects_after_drop_and_restart() -> TestResult {
|
||||
location_claim_preserves_other_users_objects_after_drop_and_restart("durable-strong").await
|
||||
}
|
||||
|
||||
@@ -217,8 +217,6 @@ impl Drop for NotifyOnDrop {
|
||||
|
||||
#[derive(Default)]
|
||||
pub struct ListPathRawOptions {
|
||||
/// Retain native listing admission through producer cancellation/draining.
|
||||
pub read_budget: Option<Arc<tokio::sync::OwnedSemaphorePermit>>,
|
||||
pub disks: Vec<Option<DiskStore>>,
|
||||
pub fallback_disks: Vec<Option<DiskStore>>,
|
||||
pub bucket: String,
|
||||
@@ -257,7 +255,6 @@ pub struct ListPathRawOptions {
|
||||
impl Clone for ListPathRawOptions {
|
||||
fn clone(&self) -> Self {
|
||||
Self {
|
||||
read_budget: self.read_budget.clone(),
|
||||
disks: self.disks.clone(),
|
||||
fallback_disks: self.fallback_disks.clone(),
|
||||
bucket: self.bucket.clone(),
|
||||
@@ -392,9 +389,7 @@ async fn list_path_raw_inner(
|
||||
let disk_io_context_clone = disk_io_context.clone();
|
||||
let (rd, wr) = tokio::io::duplex(64 * 1024);
|
||||
readers.push(MetacacheReader::new(rd));
|
||||
let read_budget = opts.read_budget.clone();
|
||||
let producer = with_optional_disk_io_context(disk_io_context_clone, async move {
|
||||
let _read_budget = read_budget;
|
||||
let mut wr = PublishedBytesWriter::new(wr);
|
||||
#[cfg(test)]
|
||||
if let Some(observer) = &test_disk_io_context_observed {
|
||||
@@ -1902,42 +1897,6 @@ mod tests {
|
||||
assert_eq!(seen.lock().expect("seen mutex poisoned").as_slice(), &["bucket/object".to_string()]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_is_retained_by_raw_producer_until_cancellation() {
|
||||
let semaphore = Arc::new(tokio::sync::Semaphore::new(4));
|
||||
let grant = Arc::new(semaphore.clone().acquire_many_owned(4).await.expect("listing grant"));
|
||||
let weak_grant = Arc::downgrade(&grant);
|
||||
let entered = Arc::new(tokio::sync::Notify::new());
|
||||
let stopped = Arc::new(tokio::sync::Notify::new());
|
||||
let worker = tokio::spawn(list_path_raw(
|
||||
CancellationToken::new(),
|
||||
ListPathRawOptions {
|
||||
read_budget: Some(grant),
|
||||
disks: vec![None],
|
||||
min_disks: 1,
|
||||
test_reader_behaviors: vec![TestReaderBehavior::StallWithSignals {
|
||||
entered: entered.clone(),
|
||||
stopped: stopped.clone(),
|
||||
}],
|
||||
..Default::default()
|
||||
},
|
||||
));
|
||||
timeout(Duration::from_secs(5), entered.notified())
|
||||
.await
|
||||
.expect("producer entered");
|
||||
assert!(weak_grant.strong_count() >= 2, "producer must retain a grant independently of the parent");
|
||||
assert_eq!(semaphore.available_permits(), 0);
|
||||
worker.abort();
|
||||
assert!(worker.await.expect_err("parent cancelled").is_cancelled());
|
||||
timeout(Duration::from_secs(5), stopped.notified())
|
||||
.await
|
||||
.expect("producer stopped");
|
||||
let _next = timeout(Duration::from_secs(5), semaphore.acquire_many(4))
|
||||
.await
|
||||
.expect("cancelled listing releases all permits")
|
||||
.expect("budget stays open");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_path_raw_aborts_unresponsive_producer_after_quorum_eof() {
|
||||
let result = timeout(
|
||||
|
||||
@@ -127,14 +127,9 @@ const HTTP_PUT_FILE_CAPABILITY_AUTH_DOMAIN: &[u8] = b"rustfs-http-put-file-capab
|
||||
const UNSIGNED_PAYLOAD: &str = "UNSIGNED-PAYLOAD";
|
||||
const UNSIGNED_PAYLOAD_NONCE: &str = "unsigned";
|
||||
const SIGNATURE_VALID_DURATION: i64 = 300; // 5 minutes
|
||||
// Timestamp validity and the wall-clock high-water mark still gate eviction,
|
||||
// including future-dated signatures and replay attempts after clock rollback.
|
||||
const REPLAY_CACHE_RETENTION: Duration = Duration::from_secs(301);
|
||||
// Preserve capacity for the full validity window at maximum accepted clock skew.
|
||||
const REPLAY_CACHE_CAPACITY_WINDOW_SECS: usize = 601;
|
||||
// A reserved index avoids overlapping old/new tables during a rehash. Include
|
||||
// index slack, compact expiry storage, and page/allocator bookkeeping.
|
||||
const REPLAY_CACHE_ENTRY_BYTES_ESTIMATE: usize = 2 * std::mem::size_of::<Uuid>() + std::mem::size_of::<RpcNonceExpiration>() + 16;
|
||||
const REPLAY_CACHE_RETENTION: Duration = Duration::from_secs(601);
|
||||
const REPLAY_CACHE_RETENTION_SECS: usize = 601;
|
||||
const REPLAY_CACHE_ENTRY_BYTES_ESTIMATE: u64 = 128;
|
||||
// Keep 16 CPU / 32 GiB field nodes at the 32M cap without requiring an env override.
|
||||
const REPLAY_CACHE_AUTO_MEMORY_PERCENT: u64 = 13;
|
||||
const REPLAY_CACHE_AUTO_RPC_RPS_PER_CPU: usize = 4096;
|
||||
@@ -227,11 +222,11 @@ fn replay_cache_capacity_from_resources(cpu_count: usize, memory_limit_bytes: Op
|
||||
let cpu_count = cpu_count.max(1);
|
||||
let cpu_based_capacity = cpu_count
|
||||
.saturating_mul(REPLAY_CACHE_AUTO_RPC_RPS_PER_CPU)
|
||||
.saturating_mul(REPLAY_CACHE_CAPACITY_WINDOW_SECS);
|
||||
.saturating_mul(REPLAY_CACHE_RETENTION_SECS);
|
||||
let memory_based_capacity = memory_limit_bytes
|
||||
.map(|bytes| {
|
||||
let budget = bytes.saturating_mul(REPLAY_CACHE_AUTO_MEMORY_PERCENT) / 100;
|
||||
saturating_usize_from_u64(budget / u64::try_from(REPLAY_CACHE_ENTRY_BYTES_ESTIMATE).unwrap_or(u64::MAX))
|
||||
saturating_usize_from_u64(budget / REPLAY_CACHE_ENTRY_BYTES_ESTIMATE)
|
||||
})
|
||||
.unwrap_or(REPLAY_CACHE_AUTO_MAX_CAPACITY);
|
||||
let capacity = memory_based_capacity
|
||||
@@ -502,12 +497,6 @@ fn publish_nonce_cache_metrics(metrics: Option<RpcNonceCacheMetrics<'_>>) {
|
||||
}
|
||||
|
||||
impl RpcNonceCache {
|
||||
fn reserve_index(&mut self, capacity: usize) -> std::io::Result<()> {
|
||||
self.nonces
|
||||
.try_reserve(capacity)
|
||||
.map_err(|error| std::io::Error::new(std::io::ErrorKind::OutOfMemory, error))
|
||||
}
|
||||
|
||||
fn remove_expired(&mut self, now: Instant, wall_time: i64) -> usize {
|
||||
let mut removed = 0;
|
||||
while let Some(nonce) = self.expirations.pop_expired(now, wall_time) {
|
||||
@@ -548,11 +537,6 @@ impl RpcNonceCache {
|
||||
}),
|
||||
);
|
||||
}
|
||||
if self.nonces.is_empty()
|
||||
&& let Err(error) = self.reserve_index(record.capacity.min(REPLAY_CACHE_AUTO_MAX_CAPACITY))
|
||||
{
|
||||
return (Err(error), Some(metrics));
|
||||
}
|
||||
self.nonces.insert(record.nonce);
|
||||
self.expirations
|
||||
.push_back(record.expires_at, record.signed_at.saturating_add(SIGNATURE_VALID_DURATION), record.nonce);
|
||||
@@ -1715,9 +1699,6 @@ pub fn verify_tonic_rpc_signature_with_bootstrap(
|
||||
}
|
||||
|
||||
pub fn tonic_rpc_auth_failure_reason(error: &std::io::Error) -> &'static str {
|
||||
if error.kind() == std::io::ErrorKind::OutOfMemory {
|
||||
return "replay_cache_allocation";
|
||||
}
|
||||
match error.to_string().as_str() {
|
||||
"Missing RPC audience" => "missing_audience",
|
||||
"Invalid RPC request path" => "invalid_request_path",
|
||||
@@ -3157,9 +3138,9 @@ mod tests {
|
||||
|
||||
assert_eq!(decision.source, ReplayCacheCapacitySource::Auto);
|
||||
assert_eq!(decision.memory_basis, Some(MemoryBasis::Host));
|
||||
assert_eq!(decision.memory_based_capacity, 31_019_208);
|
||||
assert_eq!(decision.memory_based_capacity, 17_448_304);
|
||||
assert_eq!(decision.cpu_based_capacity, 19_693_568);
|
||||
assert_eq!(decision.capacity, 19_693_568);
|
||||
assert_eq!(decision.capacity, 17_448_304);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -3169,13 +3150,13 @@ mod tests {
|
||||
replay_cache_capacity_decision(rustfs_utils::EnvParseOutcome::Absent, 16, Some(32 * gib), Some(MemoryBasis::Host));
|
||||
|
||||
assert_eq!(decision.source, ReplayCacheCapacitySource::Auto);
|
||||
assert_eq!(decision.memory_based_capacity, 62_038_416);
|
||||
assert_eq!(decision.memory_based_capacity, 34_896_609);
|
||||
assert_eq!(decision.cpu_based_capacity, 39_387_136);
|
||||
assert_eq!(decision.capacity, REPLAY_CACHE_AUTO_MAX_CAPACITY);
|
||||
|
||||
let observed_field_node =
|
||||
replay_cache_capacity_decision(rustfs_utils::EnvParseOutcome::Absent, 16, Some(31 * gib), Some(MemoryBasis::Host));
|
||||
assert_eq!(observed_field_node.memory_based_capacity, 60_099_715);
|
||||
assert_eq!(observed_field_node.memory_based_capacity, 33_806_090);
|
||||
assert_eq!(observed_field_node.cpu_based_capacity, 39_387_136);
|
||||
assert_eq!(observed_field_node.capacity, REPLAY_CACHE_AUTO_MAX_CAPACITY);
|
||||
}
|
||||
@@ -3248,138 +3229,6 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nonce_cache_releases_expired_timestamp_capacity_without_allowing_clock_rollback_replay() {
|
||||
let now = Instant::now();
|
||||
let expiry = now + REPLAY_CACHE_RETENTION;
|
||||
let later = now + Duration::from_secs(302);
|
||||
let nonce = Uuid::new_v4();
|
||||
let replacement = Uuid::new_v4();
|
||||
let mut cache = RpcNonceCache::default();
|
||||
cache
|
||||
.check_and_record(test_nonce_record(nonce, 1_000, now, 1_000, expiry, 1))
|
||||
.0
|
||||
.expect("record initial nonce");
|
||||
|
||||
let boundary = cache
|
||||
.check_and_record(test_nonce_record(nonce, 1_000, later, 1_300, later + REPLAY_CACHE_RETENTION, 1))
|
||||
.0
|
||||
.expect_err("a signature at the inclusive freshness boundary must remain protected");
|
||||
assert_eq!(boundary.to_string(), "RPC request replay detected");
|
||||
cache
|
||||
.check_and_record(test_nonce_record(replacement, 1_302, later, 1_302, later + REPLAY_CACHE_RETENTION, 1))
|
||||
.0
|
||||
.expect("an expired signature must release bounded cache capacity");
|
||||
assert!(!cache.nonces.contains(&nonce));
|
||||
assert!(cache.nonces.contains(&replacement));
|
||||
|
||||
let rollback = cache
|
||||
.check_and_record(test_nonce_record(nonce, 1_000, later, 1_000, later + REPLAY_CACHE_RETENTION, 1))
|
||||
.0
|
||||
.expect_err("clock rollback must not resurrect an evicted signature");
|
||||
assert_eq!(rollback.to_string(), "RPC request timestamp expired after clock regression");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nonce_cache_keeps_future_timestamp_reserved_until_its_full_validity_window_closes() {
|
||||
let now = Instant::now();
|
||||
let expiry = now + REPLAY_CACHE_RETENTION;
|
||||
let later = now + Duration::from_secs(302);
|
||||
let nonce = Uuid::new_v4();
|
||||
let mut cache = RpcNonceCache::default();
|
||||
cache
|
||||
.check_and_record(test_nonce_record(nonce, 1_300, now, 1_000, expiry, 1))
|
||||
.0
|
||||
.expect("record nonce signed at maximum allowed forward skew");
|
||||
let replay = cache
|
||||
.check_and_record(test_nonce_record(nonce, 1_300, later, 1_302, later + REPLAY_CACHE_RETENTION, 1))
|
||||
.0
|
||||
.expect_err("monotonic expiry must not remove a still-valid future signature");
|
||||
assert_eq!(replay.to_string(), "RPC request replay detected");
|
||||
let full = cache
|
||||
.check_and_record(test_nonce_record(Uuid::new_v4(), 1_302, later, 1_302, later + REPLAY_CACHE_RETENTION, 1))
|
||||
.0
|
||||
.expect_err("a still-valid nonce must continue consuming capacity");
|
||||
assert_eq!(full.to_string(), "RPC replay cache capacity exceeded");
|
||||
let expired = now + Duration::from_secs(602);
|
||||
cache
|
||||
.check_and_record(test_nonce_record(
|
||||
Uuid::new_v4(),
|
||||
1_602,
|
||||
expired,
|
||||
1_602,
|
||||
expired + REPLAY_CACHE_RETENTION,
|
||||
1,
|
||||
))
|
||||
.0
|
||||
.expect("release capacity only once future timestamp validity has closed");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nonce_index_rejects_unallocatable_capacity_with_typed_error() {
|
||||
let mut cache = RpcNonceCache::default();
|
||||
let error = cache
|
||||
.reserve_index(usize::MAX)
|
||||
.expect_err("unallocatable capacity must fail without a panic");
|
||||
assert_eq!(error.kind(), std::io::ErrorKind::OutOfMemory);
|
||||
assert!(
|
||||
error
|
||||
.get_ref()
|
||||
.is_some_and(|source| source.is::<std::collections::TryReserveError>())
|
||||
);
|
||||
assert_eq!(tonic_rpc_auth_failure_reason(&error), "replay_cache_allocation");
|
||||
assert!(cache.nonces.is_empty());
|
||||
assert!(cache.expirations.pages.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nonce_cache_reserves_the_bounded_index_before_sustained_traffic() {
|
||||
let now = Instant::now();
|
||||
let expiry = now + REPLAY_CACHE_RETENTION;
|
||||
let mut cache = RpcNonceCache::default();
|
||||
let capacity = 4096;
|
||||
cache
|
||||
.check_and_record(test_nonce_record(Uuid::from_u128(1), 1000, now, 1000, expiry, capacity))
|
||||
.0
|
||||
.expect("record first nonce");
|
||||
let allocated = cache.nonces.capacity();
|
||||
assert!(allocated >= capacity, "the hash index must not rehash while serving the bounded window");
|
||||
for n in 2..=capacity {
|
||||
cache
|
||||
.check_and_record(test_nonce_record(
|
||||
Uuid::from_u128(u128::try_from(n).expect("nonce index")),
|
||||
1000,
|
||||
now,
|
||||
1000,
|
||||
expiry,
|
||||
capacity,
|
||||
))
|
||||
.0
|
||||
.expect("record within bounded capacity");
|
||||
}
|
||||
assert_eq!(cache.nonces.capacity(), allocated);
|
||||
let full = cache
|
||||
.check_and_record(test_nonce_record(Uuid::from_u128(9999), 1000, now, 1000, expiry, capacity))
|
||||
.0
|
||||
.expect_err("preallocation must not relax the logical capacity fence");
|
||||
assert_eq!(full.to_string(), "RPC replay cache capacity exceeded");
|
||||
assert_eq!(cache.nonces.len(), capacity);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn replay_cache_compact_storage_fits_two_cpu_window_in_2800_mib() {
|
||||
let decision = replay_cache_capacity_decision(
|
||||
rustfs_utils::EnvParseOutcome::Absent,
|
||||
2,
|
||||
Some(2800 * 1024 * 1024),
|
||||
Some(MemoryBasis::Cgroup),
|
||||
);
|
||||
assert_eq!(decision.cpu_based_capacity, 4_923_392);
|
||||
assert_eq!(decision.capacity, decision.cpu_based_capacity);
|
||||
assert!(decision.memory_based_capacity >= decision.capacity);
|
||||
assert_eq!(decision.source, ReplayCacheCapacitySource::Auto);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn nonce_cache_expires_by_monotonic_deadline_and_fails_closed_at_capacity() {
|
||||
let now = Instant::now();
|
||||
|
||||
@@ -376,21 +376,6 @@ struct WalkCopyError {
|
||||
source: io::Error,
|
||||
}
|
||||
|
||||
impl WalkCopyError {
|
||||
fn into_disk_error(self) -> DiskError {
|
||||
// Only a local output write/flush proves the metacache consumer closed.
|
||||
// An identical I/O kind from the remote input remains a transport failure.
|
||||
if matches!(self.reason, RemoteWalkFailureReason::Write | RemoteWalkFailureReason::Flush)
|
||||
&& self.source.kind() == io::ErrorKind::BrokenPipe
|
||||
&& self.source.get_ref().is_none()
|
||||
{
|
||||
DiskError::metacache_output_stream_closed()
|
||||
} else {
|
||||
DiskError::Io(self.source)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async fn copy_stream_with_buffer<R, W>(
|
||||
reader: &mut R,
|
||||
writer: &mut W,
|
||||
@@ -2111,7 +2096,6 @@ impl RemoteDisk {
|
||||
failure_health_action: FailureHealthAction,
|
||||
) {
|
||||
if let Err(err) = operation_result
|
||||
&& !err.is_metacache_output_stream_closed()
|
||||
&& is_network_like_disk_error(err)
|
||||
{
|
||||
counter!(
|
||||
@@ -4072,7 +4056,7 @@ impl DiskAPI for RemoteDisk {
|
||||
Ok(_) => return Ok(()),
|
||||
Err(error) => {
|
||||
failure_reason = Some(error.reason);
|
||||
return Err(error.into_disk_error());
|
||||
return Err(DiskError::Io(error.source));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -9703,43 +9687,6 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn remote_walk_preserves_local_metacache_consumer_close() {
|
||||
let transport =
|
||||
RetryingWalkDirInternodeDataTransport::with_steps(vec![WalkDirTestStep::Data(b"metacache payload".to_vec())]);
|
||||
let disk = new_remote_disk_with_transport(Arc::new(transport.clone())).await;
|
||||
let (mut writer, reader) = tokio::io::duplex(1);
|
||||
drop(reader);
|
||||
let error = disk
|
||||
.walk_dir(WalkDirOptions::default(), &mut writer)
|
||||
.await
|
||||
.expect_err("a dropped metacache consumer must stop the producer");
|
||||
assert!(
|
||||
error.is_metacache_output_stream_closed(),
|
||||
"preserve the benign completion marker: {error:?}"
|
||||
);
|
||||
assert_eq!(transport.calls().len(), 1, "local consumer closure is not a remote open retry");
|
||||
assert!(!disk.health.is_faulty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn remote_walk_keeps_remote_read_broken_pipe_as_transport_failure() {
|
||||
let transport = RetryingWalkDirInternodeDataTransport::with_steps(vec![WalkDirTestStep::PartialDataThenError {
|
||||
data: b"partial metacache".to_vec(),
|
||||
error: io::ErrorKind::BrokenPipe.into(),
|
||||
}]);
|
||||
let disk = new_remote_disk_with_transport(Arc::new(transport.clone())).await;
|
||||
let mut writer = Vec::new();
|
||||
let error = disk
|
||||
.walk_dir(WalkDirOptions::default(), &mut writer)
|
||||
.await
|
||||
.expect_err("an upstream close after partial output is a failed walk");
|
||||
assert!(!error.is_metacache_output_stream_closed());
|
||||
assert!(error.contains_io_error_kind(io::ErrorKind::BrokenPipe));
|
||||
assert_eq!(writer, b"partial metacache");
|
||||
assert_eq!(transport.calls().len(), 1, "partial output must not be replayed");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn walk_stream_backpressure_limits_read_ahead_and_is_cancellable() {
|
||||
let mut reader = Cursor::new(vec![5; 4 * DEFAULT_READ_BUFFER_SIZE]);
|
||||
|
||||
@@ -423,15 +423,11 @@ impl RemoteClient {
|
||||
/// peer toward the offline threshold. See issue #4567.
|
||||
fn is_transport_failure(status: &tonic::Status) -> bool {
|
||||
use tonic::Code;
|
||||
// A valid stale-epoch request is rejected before execution. Its signed
|
||||
// response refreshes the peer epoch on the existing healthy channel.
|
||||
let epoch_rejection = status.code() == Code::Unavailable && status.message() == "RPC boot epoch changed";
|
||||
std::error::Error::source(status).is_some()
|
||||
|| (!epoch_rejection
|
||||
&& matches!(
|
||||
status.code(),
|
||||
Code::Unavailable | Code::DeadlineExceeded | Code::Unknown | Code::Cancelled
|
||||
))
|
||||
|| matches!(
|
||||
status.code(),
|
||||
Code::Unavailable | Code::DeadlineExceeded | Code::Unknown | Code::Cancelled
|
||||
)
|
||||
}
|
||||
|
||||
async fn evict_connection(&self, op: &'static str, reason: &str, resource_summary: &str) {
|
||||
@@ -2831,37 +2827,6 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn stale_boot_epoch_rejections_do_not_open_lock_request_breaker() {
|
||||
let addr = "http://stale-boot-epoch-lock-breaker:9000";
|
||||
let client = RemoteClient::new(addr.to_string());
|
||||
reset_lock_peer_health_for_test(addr);
|
||||
|
||||
for _ in 0..LOCK_RPC_REQUEST_BACKOFF_THRESHOLD {
|
||||
let error = client
|
||||
.execute_rpc::<(), _>(
|
||||
"lock",
|
||||
"bucket/new-object",
|
||||
Duration::from_secs(1),
|
||||
async { Err(tonic::Status::unavailable("RPC boot epoch changed")) },
|
||||
RpcCleanup::new(None, None, None),
|
||||
)
|
||||
.await
|
||||
.expect_err("a stale epoch still rejects the operation before execution");
|
||||
assert!(error.to_string().contains("RPC boot epoch changed"));
|
||||
}
|
||||
|
||||
let health = lock_peer_health_for_test(addr);
|
||||
assert_eq!(health.request_consecutive_timeouts, 0);
|
||||
assert!(health.request_backoff_until.is_none());
|
||||
assert!(health.last_eviction.is_none());
|
||||
let admission = client
|
||||
.admit_lock_request("lock")
|
||||
.expect("authenticated epoch refresh may proceed immediately");
|
||||
client.release_lock_request("lock", Some(admission));
|
||||
reset_lock_peer_health_for_test(addr);
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[serial_test::serial]
|
||||
fn test_remote_client_rpc_timeout_honors_configured_deadline() {
|
||||
|
||||
@@ -682,11 +682,15 @@ async fn get_pools_info(all_disks: &[Disk]) -> Result<HashMap<i32, HashMap<i32,
|
||||
return Err(Error::other("ServerNotInitialized"));
|
||||
};
|
||||
|
||||
collect_pools_info(all_disks, |pool_index, set_index| {
|
||||
let store = store.clone();
|
||||
async move {
|
||||
let mut pools_info: HashMap<i32, HashMap<i32, ErasureSetInfo>> = HashMap::new();
|
||||
for d in all_disks {
|
||||
let pool_info = pools_info.entry(d.pool_index).or_default();
|
||||
let erasure_set = pool_info.entry(d.set_index).or_default();
|
||||
|
||||
if erasure_set.id == 0 {
|
||||
erasure_set.id = d.set_index;
|
||||
let load = load_data_usage_cache(
|
||||
store.pools[pool_index as usize].disk_set[set_index as usize].as_ref(),
|
||||
store.pools[d.pool_index as usize].disk_set[d.set_index as usize].as_ref(),
|
||||
DATA_USAGE_CACHE_NAME,
|
||||
);
|
||||
#[cfg(feature = "diagnostic-read-version-caller")]
|
||||
@@ -694,34 +698,11 @@ async fn get_pools_info(all_disks: &[Disk]) -> Result<HashMap<i32, HashMap<i32,
|
||||
rustfs_io_metrics::internode_metrics::ReadVersionEntrySource::ServerInfoPools,
|
||||
load,
|
||||
);
|
||||
load.await
|
||||
}
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
async fn collect_pools_info<F, Fut>(all_disks: &[Disk], mut load_usage: F) -> Result<HashMap<i32, HashMap<i32, ErasureSetInfo>>>
|
||||
where
|
||||
F: FnMut(i32, i32) -> Fut,
|
||||
Fut: std::future::Future<Output = Result<rustfs_data_usage::DataUsageCache>>,
|
||||
{
|
||||
let mut pools_info: HashMap<i32, HashMap<i32, ErasureSetInfo>> = HashMap::new();
|
||||
for d in all_disks {
|
||||
let pool_info = pools_info.entry(d.pool_index).or_default();
|
||||
let erasure_set = match pool_info.entry(d.set_index) {
|
||||
std::collections::hash_map::Entry::Occupied(entry) => entry.into_mut(),
|
||||
std::collections::hash_map::Entry::Vacant(entry) => {
|
||||
let erasure_set = entry.insert(ErasureSetInfo {
|
||||
id: d.set_index,
|
||||
..Default::default()
|
||||
});
|
||||
match load_usage(d.pool_index, d.set_index).await {
|
||||
Ok(cache) => apply_erasure_set_usage(&cache, erasure_set),
|
||||
Err(_) => erasure_set.usage_error = Some(DATA_USAGE_UNAVAILABLE_ERROR.to_string()),
|
||||
}
|
||||
erasure_set
|
||||
match load.await {
|
||||
Ok(cache) => apply_erasure_set_usage(&cache, erasure_set),
|
||||
Err(_) => erasure_set.usage_error = Some(DATA_USAGE_UNAVAILABLE_ERROR.to_string()),
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
erasure_set.raw_capacity += d.total_space;
|
||||
erasure_set.raw_usage += d.used_space;
|
||||
@@ -1260,59 +1241,6 @@ mod tests {
|
||||
assert_eq!(info.deployment_id, expected_deployment_id);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn pool_usage_is_loaded_once_per_set_including_set_zero() {
|
||||
let mut disks = Vec::new();
|
||||
for (pool, set, count) in [(0, 0, 16), (1, 0, 16), (1, 1, 4)] {
|
||||
disks.extend((0..count).map(|_| Disk {
|
||||
pool_index: pool,
|
||||
set_index: set,
|
||||
used_space: 10,
|
||||
total_space: 100,
|
||||
..Default::default()
|
||||
}));
|
||||
}
|
||||
let mut loads = Vec::new();
|
||||
let info = super::collect_pools_info(&disks, |pool, set| {
|
||||
loads.push((pool, set));
|
||||
async move {
|
||||
if pool == 1 && set == 0 {
|
||||
return Err(crate::error::Error::other("usage unavailable"));
|
||||
}
|
||||
let mut cache = rustfs_data_usage::DataUsageCache::default();
|
||||
cache.info.name = DATA_USAGE_ROOT.to_owned();
|
||||
cache.info.last_update = Some(std::time::SystemTime::UNIX_EPOCH);
|
||||
cache.info.snapshot_complete = true;
|
||||
cache.replace(
|
||||
DATA_USAGE_ROOT,
|
||||
"",
|
||||
rustfs_data_usage::DataUsageEntry {
|
||||
size: 25,
|
||||
objects: 2,
|
||||
..Default::default()
|
||||
},
|
||||
);
|
||||
Ok(cache)
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("collect mixed successful and unavailable usage");
|
||||
assert_eq!(loads, [(0, 0), (1, 0), (1, 1)]);
|
||||
for (pool, set, count) in [(0, 0, 16), (1, 0, 16), (1, 1, 4)] {
|
||||
let set_info = &info[&pool][&set];
|
||||
assert_eq!(set_info.id, set);
|
||||
assert_eq!(set_info.raw_usage, count * 10);
|
||||
assert_eq!(set_info.raw_capacity, count * 100);
|
||||
if pool == 1 && set == 0 {
|
||||
assert_eq!(set_info.usage_error.as_deref(), Some(DATA_USAGE_UNAVAILABLE_ERROR));
|
||||
} else {
|
||||
assert_eq!(set_info.usage, 25, "logical usage must not multiply by drive count");
|
||||
assert_eq!(set_info.objects_count, 2);
|
||||
assert!(set_info.usage_error.is_none());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[serial]
|
||||
#[tokio::test]
|
||||
async fn local_server_property_includes_runtime_stats_without_endpoint_pools() {
|
||||
|
||||
@@ -562,57 +562,12 @@ fn remove_dir_all_if_exists(path: &Path) -> std::io::Result<()> {
|
||||
fn snapshot_part_transaction_file(src: &Path, backup: &Path, absent: &Path) -> std::io::Result<bool> {
|
||||
match std::fs::symlink_metadata(src) {
|
||||
Ok(metadata) if metadata.is_file() => std::fs::hard_link(src, backup).map(|()| true),
|
||||
Ok(metadata) if metadata.file_type().is_symlink() => {
|
||||
Err(std::io::Error::new(ErrorKind::InvalidInput, "multipart transaction source is a symlink"))
|
||||
}
|
||||
Ok(_) => Err(std::io::Error::new(ErrorKind::InvalidData, "multipart transaction source is not a file")),
|
||||
Err(err) if err.kind() == ErrorKind::NotFound => std::fs::write(absent, []).map(|()| false),
|
||||
Err(err) => Err(err),
|
||||
}
|
||||
}
|
||||
|
||||
struct PreparedPartTxnReceipt {
|
||||
src_volume_dir: PathBuf,
|
||||
dst_volume_dir: PathBuf,
|
||||
src_file_path: PathBuf,
|
||||
dst_file_path: PathBuf,
|
||||
dst_meta_path: PathBuf,
|
||||
transaction_path: PathBuf,
|
||||
meta: Bytes,
|
||||
had_old_meta: bool,
|
||||
}
|
||||
|
||||
struct PublishedPartTxnReceipt {
|
||||
current_data_path: PathBuf,
|
||||
current_meta_path: PathBuf,
|
||||
transaction_path: PathBuf,
|
||||
had_old_meta: bool,
|
||||
}
|
||||
|
||||
const PART_TXN_RECEIPTS_PER_SHARD: usize = 64;
|
||||
|
||||
static PREPARED_PART_TXN_RECEIPTS: std::sync::LazyLock<os::ShardedPathCache<PreparedPartTxnReceipt>> =
|
||||
std::sync::LazyLock::new(|| os::ShardedPathCache::new(PART_TXN_RECEIPTS_PER_SHARD));
|
||||
|
||||
static PUBLISHED_PART_TXN_RECEIPTS: std::sync::LazyLock<os::ShardedPathCache<PublishedPartTxnReceipt>> =
|
||||
std::sync::LazyLock::new(|| os::ShardedPathCache::new(PART_TXN_RECEIPTS_PER_SHARD));
|
||||
|
||||
fn put_prepared_part_txn_receipt(transaction_path: &Path, entry: PreparedPartTxnReceipt) {
|
||||
PREPARED_PART_TXN_RECEIPTS.insert(transaction_path, entry);
|
||||
}
|
||||
|
||||
fn take_prepared_part_txn_receipt(transaction_path: &Path) -> Option<PreparedPartTxnReceipt> {
|
||||
PREPARED_PART_TXN_RECEIPTS.remove(transaction_path)
|
||||
}
|
||||
|
||||
fn put_published_part_txn_receipt(transaction_path: &Path, entry: PublishedPartTxnReceipt) {
|
||||
PUBLISHED_PART_TXN_RECEIPTS.insert(transaction_path, entry);
|
||||
}
|
||||
|
||||
fn take_published_part_txn_receipt(transaction_path: &Path) -> Option<PublishedPartTxnReceipt> {
|
||||
PUBLISHED_PART_TXN_RECEIPTS.remove(transaction_path)
|
||||
}
|
||||
|
||||
fn restore_part_transaction_file(current: &Path, backup: &Path, absent: &Path, restore: &Path) -> std::io::Result<()> {
|
||||
match std::fs::symlink_metadata(backup) {
|
||||
Ok(metadata) if metadata.is_file() => {
|
||||
@@ -3205,10 +3160,6 @@ pub(super) fn has_rename_data_test_failpoints(dst_path: &str) -> bool {
|
||||
|| os::has_dir_fsync_test_failures()
|
||||
|| os::file_sync_probe::is_active()
|
||||
|| os::prepared_publication_test_hooks::has_any_hooks()
|
||||
|| !OWNED_FILE_BEFORE_OPEN
|
||||
.lock()
|
||||
.expect("test file open hook lock should not be poisoned")
|
||||
.is_empty()
|
||||
}
|
||||
|
||||
#[cfg(all(not(test), feature = "test-util", target_os = "linux"))]
|
||||
@@ -9269,14 +9220,15 @@ impl LocalDisk {
|
||||
.await;
|
||||
}
|
||||
|
||||
let (volume_dir, file_path) = self.io_get_bucket_and_object_path(volume, path)?;
|
||||
let volume_dir = self.io_get_bucket_path(volume)?;
|
||||
|
||||
let file_path = self.io_get_object_path(volume, path)?;
|
||||
|
||||
check_path_length(file_path.to_string_lossy().as_ref())?;
|
||||
|
||||
let xl_path = path_join(&[file_path.as_path(), Path::new(STORAGE_FORMAT_FILE)]);
|
||||
let object_path = self.get_object_path(volume, path)?;
|
||||
let mut namespace_owner: Option<Arc<dyn Send + Sync>> =
|
||||
Some(os::acquire_metadata_mutation_lease(&object_path, namespace_owner).await);
|
||||
Some(os::acquire_metadata_mutation_lease(&self.get_object_path(volume, path)?, namespace_owner).await);
|
||||
if opts.recoverable_delete || (opts.undo_write && opts.undo_delete) {
|
||||
let volume_guard = os::disk_volume_mutation_lock(&self.root, volume).read_owned().await;
|
||||
namespace_owner = Some(Arc::new((namespace_owner, volume_guard)));
|
||||
@@ -9301,15 +9253,7 @@ impl LocalDisk {
|
||||
let rollback_dir = opts.old_data_dir;
|
||||
if let Some(rollback_dir) = rollback_dir
|
||||
&& let Some(()) = self
|
||||
.try_fused_recoverable_delete_version_with_paths(
|
||||
volume,
|
||||
path,
|
||||
&fi,
|
||||
&opts,
|
||||
rollback_dir,
|
||||
namespace_owner.clone(),
|
||||
Some((object_path, volume_dir.clone(), file_path.clone())),
|
||||
)
|
||||
.try_fused_recoverable_delete_version(volume, path, &fi, &opts, rollback_dir, namespace_owner.clone())
|
||||
.await?
|
||||
{
|
||||
return Ok(());
|
||||
@@ -14374,8 +14318,7 @@ impl DiskAPI for LocalDisk {
|
||||
all_cached = false;
|
||||
break;
|
||||
};
|
||||
let Ok(source) = self.io_get_object_open_path(bucket, multipart_staging::upload_scope_root(path_str, true))
|
||||
else {
|
||||
let Ok(source) = self.io_get_object_path(bucket, multipart_staging::upload_scope_root(path_str, true)) else {
|
||||
all_cached = false;
|
||||
break;
|
||||
};
|
||||
@@ -14502,8 +14445,8 @@ impl DiskAPI for LocalDisk {
|
||||
multipart_staging::reject_noncanonical_scope(&self.root, self.io_root(), src_volume, src_path)?;
|
||||
let source_owner = self.multipart_source_owner(dst_volume, dst_path, true, false, None).await?;
|
||||
let admission = self.multipart_source_admission(dst_volume, dst_path, true, false)?;
|
||||
let (src_volume_dir, src_file_path) = self.io_get_bucket_and_object_path(src_volume, src_path)?;
|
||||
let (dst_volume_dir, dst_file_path) = self.io_get_bucket_and_object_path(dst_volume, dst_path)?;
|
||||
let src_volume_dir = self.io_get_bucket_path(src_volume)?;
|
||||
let dst_volume_dir = self.io_get_bucket_path(dst_volume)?;
|
||||
if !skip_access_checks(src_volume) {
|
||||
super::fs::access_std(&src_volume_dir).map_err(|err| to_access_error(err, DiskError::VolumeAccessDenied))?;
|
||||
}
|
||||
@@ -14511,8 +14454,10 @@ impl DiskAPI for LocalDisk {
|
||||
super::fs::access_std(&dst_volume_dir).map_err(|err| to_access_error(err, DiskError::VolumeAccessDenied))?;
|
||||
}
|
||||
|
||||
let dst_meta_path = self.io_get_object_open_path(dst_volume, &format!("{dst_path}.meta"))?;
|
||||
let transaction_path = self.io_get_object_open_path(dst_volume, &crate::disk::part_transaction_path(dst_path))?;
|
||||
let src_file_path = self.io_get_object_path(src_volume, src_path)?;
|
||||
let dst_file_path = self.io_get_object_path(dst_volume, dst_path)?;
|
||||
let dst_meta_path = self.io_get_object_path(dst_volume, &format!("{dst_path}.meta"))?;
|
||||
let transaction_path = self.io_get_object_path(dst_volume, &crate::disk::part_transaction_path(dst_path))?;
|
||||
for path in [&src_file_path, &dst_file_path, &dst_meta_path, &transaction_path] {
|
||||
check_path_length(path.to_string_lossy().as_ref())?;
|
||||
}
|
||||
@@ -14557,11 +14502,8 @@ impl DiskAPI for LocalDisk {
|
||||
if !source.is_file() {
|
||||
return Ok(Err(DiskError::FileAccessDenied));
|
||||
}
|
||||
match std::fs::symlink_metadata(&transaction_path) {
|
||||
Err(err) if err.kind() == ErrorKind::NotFound => {}
|
||||
Ok(m) if m.file_type().is_symlink() => return Ok(Err(DiskError::InvalidPath)),
|
||||
Ok(_) => return Ok(Err(DiskError::FileAccessDenied)),
|
||||
Err(err) => return Ok(Err(to_file_error(err).into())),
|
||||
if transaction_path.exists() {
|
||||
return Ok(Err(DiskError::FileAccessDenied));
|
||||
}
|
||||
if let Some((integrity, source, destination, expected_len)) = integrity_prep {
|
||||
let stat = match std::fs::symlink_metadata(&source) {
|
||||
@@ -14618,7 +14560,7 @@ impl DiskAPI for LocalDisk {
|
||||
return Ok(Err(to_file_error(err).into()));
|
||||
}
|
||||
|
||||
let prepare_result = (|| -> std::io::Result<bool> {
|
||||
let prepare_result = (|| -> std::io::Result<()> {
|
||||
let had_old_data = snapshot_part_transaction_file(
|
||||
&dst_file_path,
|
||||
&staging_path.join(PART_TRANSACTION_OLD_DATA),
|
||||
@@ -14630,11 +14572,10 @@ impl DiskAPI for LocalDisk {
|
||||
&staging_path.join(PART_TRANSACTION_OLD_META_ABSENT),
|
||||
)?;
|
||||
|
||||
let new_meta_path = staging_path.join(PART_TRANSACTION_NEW_META);
|
||||
let mut new_meta = std::fs::OpenOptions::new()
|
||||
.create_new(true)
|
||||
.write(true)
|
||||
.open(&new_meta_path)?;
|
||||
.open(staging_path.join(PART_TRANSACTION_NEW_META))?;
|
||||
std::io::Write::write_all(&mut new_meta, &meta)?;
|
||||
if durability.syncs_commit_metadata() {
|
||||
new_meta.sync_data()?;
|
||||
@@ -14642,7 +14583,6 @@ impl DiskAPI for LocalDisk {
|
||||
// Windows rejects renaming a directory while one of its children is
|
||||
// still open, even when the child handle shares delete access.
|
||||
drop(new_meta);
|
||||
let _ = std::fs::hard_link(&new_meta_path, staging_path.join(PART_TRANSACTION_PUBLISH_META));
|
||||
let sync_overwrite_backup = durability.syncs_commit_metadata() && (had_old_data || had_old_meta);
|
||||
if sync_overwrite_backup {
|
||||
os::fsync_dir_std(&staging_path)?;
|
||||
@@ -14651,29 +14591,13 @@ impl DiskAPI for LocalDisk {
|
||||
if sync_overwrite_backup {
|
||||
os::fsync_dir_std(transaction_parent)?;
|
||||
}
|
||||
Ok(had_old_meta)
|
||||
Ok(())
|
||||
})();
|
||||
|
||||
let had_old_meta = match prepare_result {
|
||||
Ok(had_old_meta) => had_old_meta,
|
||||
Err(err) => {
|
||||
let _ = remove_dir_all_if_exists(&staging_path);
|
||||
return Ok(Err(to_file_error(err).into()));
|
||||
}
|
||||
};
|
||||
put_prepared_part_txn_receipt(
|
||||
&transaction_path,
|
||||
PreparedPartTxnReceipt {
|
||||
src_volume_dir,
|
||||
dst_volume_dir,
|
||||
src_file_path,
|
||||
dst_file_path,
|
||||
dst_meta_path,
|
||||
transaction_path: transaction_path.clone(),
|
||||
meta,
|
||||
had_old_meta,
|
||||
},
|
||||
);
|
||||
if let Err(err) = prepare_result {
|
||||
let _ = remove_dir_all_if_exists(&staging_path);
|
||||
return Ok(Err(to_file_error(err).into()));
|
||||
}
|
||||
|
||||
Ok(Ok(()))
|
||||
})
|
||||
@@ -14692,28 +14616,13 @@ impl DiskAPI for LocalDisk {
|
||||
let source_owner = self.multipart_source_owner(volume, path, true, false, None).await?;
|
||||
let admission = self.multipart_source_admission(volume, path, true, false)?;
|
||||
let admission_source = admission.as_ref().map(|a| a.source().to_path_buf());
|
||||
let txn_rel_path = crate::disk::part_transaction_path(path);
|
||||
let cached_published = self
|
||||
.io_get_object_open_path(volume, &txn_rel_path)
|
||||
.ok()
|
||||
.and_then(|txn_open| take_published_part_txn_receipt(&txn_open));
|
||||
let (current_data_path, current_meta_path, transaction_path, skip_obsolete_read_on_commit) = match cached_published {
|
||||
Some(entry) => (
|
||||
entry.current_data_path,
|
||||
entry.current_meta_path,
|
||||
entry.transaction_path,
|
||||
!entry.had_old_meta,
|
||||
),
|
||||
None => {
|
||||
let (_, current_data_path) = self.io_get_bucket_and_object_path(volume, path)?;
|
||||
let current_meta_path = self.io_get_object_path(volume, &format!("{path}.meta"))?;
|
||||
let transaction_path = self.io_get_object_path(volume, &txn_rel_path)?;
|
||||
for candidate in [¤t_data_path, ¤t_meta_path, &transaction_path] {
|
||||
check_path_length(candidate.to_string_lossy().as_ref())?;
|
||||
}
|
||||
(current_data_path, current_meta_path, transaction_path, false)
|
||||
}
|
||||
};
|
||||
self.io_get_bucket_path(volume)?;
|
||||
let current_data_path = self.io_get_object_path(volume, path)?;
|
||||
let current_meta_path = self.io_get_object_path(volume, &format!("{path}.meta"))?;
|
||||
let transaction_path = self.io_get_object_path(volume, &crate::disk::part_transaction_path(path))?;
|
||||
for candidate in [¤t_data_path, ¤t_meta_path, &transaction_path] {
|
||||
check_path_length(candidate.to_string_lossy().as_ref())?;
|
||||
}
|
||||
let durability = effective_durability(volume);
|
||||
let sync = durability.syncs_commit_metadata();
|
||||
let part_number = current_data_path
|
||||
@@ -14779,8 +14688,7 @@ impl DiskAPI for LocalDisk {
|
||||
PartTransactionAction::Commit => (PART_TRANSACTION_NEW_META, PART_TRANSACTION_OLD_META),
|
||||
PartTransactionAction::Rollback => (PART_TRANSACTION_OLD_META, PART_TRANSACTION_NEW_META),
|
||||
};
|
||||
if !(action == PartTransactionAction::Commit && skip_obsolete_read_on_commit && !cfg!(test))
|
||||
&& let Ok(obsolete) = std::fs::read(transaction_path.join(obsolete_name))
|
||||
if let Ok(obsolete) = std::fs::read(transaction_path.join(obsolete_name))
|
||||
&& let Ok(obsolete) = ObjectPartInfo::unmarshal(&obsolete)
|
||||
&& let Some(integrity) = obsolete.integrity
|
||||
&& integrity.validate().is_ok()
|
||||
@@ -14846,6 +14754,15 @@ impl DiskAPI for LocalDisk {
|
||||
let admission_source = admission.as_ref().map(|a| a.source().to_path_buf());
|
||||
pool_meta_native::reject_raw_path(&self.root, src_volume, src_path)?;
|
||||
pool_meta_native::reject_raw_path(&self.root, dst_volume, dst_path)?;
|
||||
let src_volume_dir = self.io_get_bucket_path(src_volume)?;
|
||||
let dst_volume_dir = self.io_get_bucket_path(dst_volume)?;
|
||||
if !skip_access_checks(src_volume) {
|
||||
super::fs::access_std(&src_volume_dir).map_err(|e| to_access_error(e, DiskError::VolumeAccessDenied))?
|
||||
}
|
||||
if !skip_access_checks(dst_volume) {
|
||||
super::fs::access_std(&dst_volume_dir).map_err(|e| to_access_error(e, DiskError::VolumeAccessDenied))?
|
||||
}
|
||||
|
||||
let src_is_dir = has_suffix(src_path, SLASH_SEPARATOR);
|
||||
let dst_is_dir = has_suffix(dst_path, SLASH_SEPARATOR);
|
||||
|
||||
@@ -14862,74 +14779,25 @@ impl DiskAPI for LocalDisk {
|
||||
return Err(DiskError::FileAccessDenied);
|
||||
}
|
||||
|
||||
let cached_prepared = if !src_is_dir {
|
||||
let txn_rel = crate::disk::part_transaction_path(dst_path);
|
||||
self.io_get_object_open_path(dst_volume, &txn_rel)
|
||||
.ok()
|
||||
.and_then(|txn_open| take_prepared_part_txn_receipt(&txn_open))
|
||||
.filter(|entry| {
|
||||
entry.meta == meta
|
||||
&& self
|
||||
.io_get_object_open_path(src_volume, src_path)
|
||||
.is_ok_and(|src_open| src_open == entry.src_file_path)
|
||||
})
|
||||
} else {
|
||||
let src_file_path = self.io_get_object_path(src_volume, src_path)?;
|
||||
let dst_file_path = self.io_get_object_path(dst_volume, dst_path)?;
|
||||
|
||||
// warn!("rename_part src_file_path:{:?}, dst_file_path:{:?}", &src_file_path, &dst_file_path);
|
||||
|
||||
check_path_length(src_file_path.to_string_lossy().as_ref())?;
|
||||
check_path_length(dst_file_path.to_string_lossy().as_ref())?;
|
||||
|
||||
let dst_meta_path = if src_is_dir {
|
||||
None
|
||||
} else {
|
||||
let path = self.io_get_object_path(dst_volume, &format!("{dst_path}.meta"))?;
|
||||
check_path_length(path.to_string_lossy().as_ref())?;
|
||||
Some(path)
|
||||
};
|
||||
|
||||
let (
|
||||
src_volume_dir,
|
||||
dst_volume_dir,
|
||||
src_file_path,
|
||||
dst_file_path,
|
||||
dst_meta_path,
|
||||
transaction_path,
|
||||
preverified_meta_and_old_flag,
|
||||
) = match cached_prepared {
|
||||
Some(entry) => (
|
||||
entry.src_volume_dir,
|
||||
entry.dst_volume_dir,
|
||||
entry.src_file_path,
|
||||
entry.dst_file_path,
|
||||
Some(entry.dst_meta_path),
|
||||
Some(entry.transaction_path),
|
||||
Some(entry.had_old_meta),
|
||||
),
|
||||
None => {
|
||||
let (src_volume_dir, src_file_path) = self.io_get_bucket_and_object_path(src_volume, src_path)?;
|
||||
let (dst_volume_dir, dst_file_path) = self.io_get_bucket_and_object_path(dst_volume, dst_path)?;
|
||||
if !skip_access_checks(src_volume) {
|
||||
super::fs::access_std(&src_volume_dir).map_err(|e| to_access_error(e, DiskError::VolumeAccessDenied))?
|
||||
}
|
||||
if !skip_access_checks(dst_volume) {
|
||||
super::fs::access_std(&dst_volume_dir).map_err(|e| to_access_error(e, DiskError::VolumeAccessDenied))?
|
||||
}
|
||||
|
||||
check_path_length(src_file_path.to_string_lossy().as_ref())?;
|
||||
check_path_length(dst_file_path.to_string_lossy().as_ref())?;
|
||||
|
||||
let dst_meta_path = if src_is_dir {
|
||||
None
|
||||
} else {
|
||||
let path = self.io_get_object_path(dst_volume, &format!("{dst_path}.meta"))?;
|
||||
check_path_length(path.to_string_lossy().as_ref())?;
|
||||
Some(path)
|
||||
};
|
||||
let transaction_path = if src_is_dir {
|
||||
None
|
||||
} else {
|
||||
Some(self.io_get_object_path(dst_volume, &crate::disk::part_transaction_path(dst_path))?)
|
||||
};
|
||||
(
|
||||
src_volume_dir,
|
||||
dst_volume_dir,
|
||||
src_file_path,
|
||||
dst_file_path,
|
||||
dst_meta_path,
|
||||
transaction_path,
|
||||
None,
|
||||
)
|
||||
}
|
||||
let transaction_path = if src_is_dir {
|
||||
None
|
||||
} else {
|
||||
Some(self.io_get_object_path(dst_volume, &crate::disk::part_transaction_path(dst_path))?)
|
||||
};
|
||||
|
||||
// UploadPart is acknowledged once this rename lands, so the part data and
|
||||
@@ -14988,43 +14856,35 @@ impl DiskAPI for LocalDisk {
|
||||
|
||||
let transaction_publish_meta = if let Some(transaction_path) = transaction_path.as_ref() {
|
||||
let transaction_meta_path = transaction_path.join(PART_TRANSACTION_NEW_META);
|
||||
let publish_meta_path = transaction_path.join(PART_TRANSACTION_PUBLISH_META);
|
||||
if !cfg!(test)
|
||||
&& preverified_meta_and_old_flag.is_some()
|
||||
&& publish_meta_path.is_file()
|
||||
&& std::fs::metadata(&transaction_meta_path).is_ok_and(|m| m.is_file() && m.len() == meta.len() as u64)
|
||||
{
|
||||
Some(publish_meta_path)
|
||||
} else {
|
||||
match std::fs::File::open(&transaction_meta_path) {
|
||||
Ok(mut file) => {
|
||||
let file_len = file.metadata().map_err(to_file_error)?.len();
|
||||
if file_len != meta.len() as u64 {
|
||||
return Err(DiskError::FileCorrupt.into());
|
||||
}
|
||||
let mut expected_meta = Vec::with_capacity(meta.len());
|
||||
std::io::Read::read_to_end(&mut std::io::Read::take(&mut file, file_len), &mut expected_meta)
|
||||
.map_err(to_file_error)?;
|
||||
drop(file);
|
||||
if expected_meta.as_slice() != meta.as_ref() {
|
||||
return Err(DiskError::FileCorrupt.into());
|
||||
}
|
||||
|
||||
remove_file_if_exists(&publish_meta_path).map_err(to_file_error)?;
|
||||
std::fs::hard_link(&transaction_meta_path, &publish_meta_path).map_err(to_file_error)?;
|
||||
Some(publish_meta_path)
|
||||
match std::fs::File::open(&transaction_meta_path) {
|
||||
Ok(mut file) => {
|
||||
let file_len = file.metadata().map_err(to_file_error)?.len();
|
||||
if file_len != meta.len() as u64 {
|
||||
return Err(DiskError::FileCorrupt.into());
|
||||
}
|
||||
// Old peers know only RenamePart. The new coordinator never
|
||||
// reaches rename unless prepare succeeded, so an absent
|
||||
// transaction directory identifies the rolling-upgrade legacy
|
||||
// path. A present directory without new.meta is corruption.
|
||||
Err(err) if err.kind() == ErrorKind::NotFound => match std::fs::metadata(transaction_path) {
|
||||
Ok(_) => return Err(DiskError::FileCorrupt.into()),
|
||||
Err(meta_err) if meta_err.kind() == ErrorKind::NotFound => None,
|
||||
Err(meta_err) => return Err(to_file_error(meta_err)),
|
||||
},
|
||||
Err(err) => return Err(to_file_error(err)),
|
||||
let mut expected_meta = Vec::with_capacity(meta.len());
|
||||
std::io::Read::read_to_end(&mut std::io::Read::take(&mut file, file_len), &mut expected_meta)
|
||||
.map_err(to_file_error)?;
|
||||
drop(file);
|
||||
if expected_meta.as_slice() != meta.as_ref() {
|
||||
return Err(DiskError::FileCorrupt.into());
|
||||
}
|
||||
|
||||
let publish_meta_path = transaction_path.join(PART_TRANSACTION_PUBLISH_META);
|
||||
remove_file_if_exists(&publish_meta_path).map_err(to_file_error)?;
|
||||
std::fs::hard_link(&transaction_meta_path, &publish_meta_path).map_err(to_file_error)?;
|
||||
Some(publish_meta_path)
|
||||
}
|
||||
// Old peers know only RenamePart. The new coordinator never
|
||||
// reaches rename unless prepare succeeded, so an absent
|
||||
// transaction directory identifies the rolling-upgrade legacy
|
||||
// path. A present directory without new.meta is corruption.
|
||||
Err(err) if err.kind() == ErrorKind::NotFound => match std::fs::metadata(transaction_path) {
|
||||
Ok(_) => return Err(DiskError::FileCorrupt.into()),
|
||||
Err(meta_err) if meta_err.kind() == ErrorKind::NotFound => None,
|
||||
Err(meta_err) => return Err(to_file_error(meta_err)),
|
||||
},
|
||||
Err(err) => return Err(to_file_error(err)),
|
||||
}
|
||||
} else {
|
||||
None
|
||||
@@ -15087,19 +14947,6 @@ impl DiskAPI for LocalDisk {
|
||||
}
|
||||
}
|
||||
}
|
||||
if let (Some(had_old_meta), Some(txn_path), Some(meta_path)) =
|
||||
(preverified_meta_and_old_flag, transaction_path.as_ref(), dst_meta_path.as_path().into())
|
||||
{
|
||||
put_published_part_txn_receipt(
|
||||
txn_path,
|
||||
PublishedPartTxnReceipt {
|
||||
current_data_path: dst_file_path,
|
||||
current_meta_path: meta_path.to_path_buf(),
|
||||
transaction_path: txn_path.clone(),
|
||||
had_old_meta,
|
||||
},
|
||||
);
|
||||
}
|
||||
Ok(true)
|
||||
} else {
|
||||
Ok(false)
|
||||
|
||||
@@ -15,6 +15,8 @@
|
||||
//! Single-disk object rename publication and rollback. The shared execution core
|
||||
//! retains instrumentation, mutation leases, and commit guards through the syscall.
|
||||
|
||||
#[cfg(target_os = "linux")]
|
||||
use super::has_rename_data_test_failpoints;
|
||||
#[cfg(all(test, windows))]
|
||||
use super::run_destination_commit_directory_preparation;
|
||||
#[cfg(any(not(windows), test))]
|
||||
@@ -22,8 +24,8 @@ use super::should_fail_local_inline_rollback_hardlink;
|
||||
use super::{
|
||||
EVENT_DISK_LOCAL_ACCESS_FAILED, EVENT_DISK_LOCAL_HEAL_PURGE_FAILED, EVENT_DISK_LOCAL_RENAME_REJECTED, LOG_COMPONENT_ECSTORE,
|
||||
LOG_SUBSYSTEM_DISK_LOCAL, LocalDisk, SyncMode, effective_durability, has_inline_commit_test_failpoints,
|
||||
has_rename_data_test_failpoints, inline_metadata_rollback_dir, observe_old_current, remove_dir_all_if_exists,
|
||||
remove_dst_base_before_commit, remove_file_if_exists, rename_data_versions_signature, run_inline_preparation_before_backup,
|
||||
inline_metadata_rollback_dir, observe_old_current, remove_dir_all_if_exists, remove_dst_base_before_commit,
|
||||
remove_file_if_exists, rename_data_versions_signature, run_inline_preparation_before_backup,
|
||||
should_fail_after_metadata_commit, should_fail_before_old_metadata_backup, should_fail_commit_rename,
|
||||
should_remove_staged_meta_before_commit, skip_access_checks, tmp_staging_mutation_path,
|
||||
};
|
||||
@@ -170,44 +172,6 @@ impl RenameCommitContext<'_> {
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(any(not(windows), test))]
|
||||
fn inline_rollback_backup_path(staging_file_path: &Path) -> std::io::Result<PathBuf> {
|
||||
let Some(staging_parent) = staging_file_path.parent() else {
|
||||
return Err(std::io::Error::new(ErrorKind::InvalidInput, "missing staging metadata parent"));
|
||||
};
|
||||
let backup_path = if staging_file_path.file_name().and_then(|n| n.to_str()) == Some(STORAGE_FORMAT_FILE) {
|
||||
staging_parent.join(STORAGE_FORMAT_FILE_BACKUP)
|
||||
} else {
|
||||
staging_file_path.with_extension("meta.bkp")
|
||||
};
|
||||
remove_file_if_exists(&backup_path)?;
|
||||
Ok(backup_path)
|
||||
}
|
||||
|
||||
#[cfg(any(not(windows), test))]
|
||||
fn write_local_inline_rollback_backup_from_bytes(
|
||||
staging_file_path: &Path,
|
||||
old_metadata: &[u8],
|
||||
sync: bool,
|
||||
) -> std::io::Result<PathBuf> {
|
||||
let backup_path = inline_rollback_backup_path(staging_file_path)?;
|
||||
let write_res = (|| -> std::io::Result<()> {
|
||||
#[cfg(test)]
|
||||
run_owned_file_before_open(&backup_path);
|
||||
let mut file = std::fs::File::create(&backup_path)?;
|
||||
std::io::Write::write_all(&mut file, old_metadata)?;
|
||||
if sync && !old_metadata.is_empty() {
|
||||
file.sync_data()?;
|
||||
}
|
||||
Ok(())
|
||||
})();
|
||||
if let Err(err) = write_res {
|
||||
let _ = remove_file_if_exists(&backup_path);
|
||||
return Err(err);
|
||||
}
|
||||
Ok(backup_path)
|
||||
}
|
||||
|
||||
#[cfg(any(not(windows), test))]
|
||||
pub(super) fn create_local_inline_rollback_backup(
|
||||
dst_file_path: &Path,
|
||||
@@ -215,12 +179,27 @@ pub(super) fn create_local_inline_rollback_backup(
|
||||
old_metadata: &[u8],
|
||||
sync: bool,
|
||||
) -> std::io::Result<PathBuf> {
|
||||
let backup_path = inline_rollback_backup_path(staging_file_path)?;
|
||||
let Some(staging_parent) = staging_file_path.parent() else {
|
||||
return Err(std::io::Error::new(ErrorKind::InvalidInput, "missing staging metadata parent"));
|
||||
};
|
||||
let backup_path = staging_parent.join(STORAGE_FORMAT_FILE_BACKUP);
|
||||
remove_file_if_exists(&backup_path)?;
|
||||
if should_fail_local_inline_rollback_hardlink(dst_file_path) || std::fs::hard_link(dst_file_path, &backup_path).is_err() {
|
||||
return write_local_inline_rollback_backup_from_bytes(staging_file_path, old_metadata, sync);
|
||||
} else if cfg!(test) && sync && !old_metadata.is_empty() {
|
||||
// Skip redundant fdatasync on hardlinked rollback backups in production;
|
||||
// keep a Windows-safe sync open in tests.
|
||||
let write_res = (|| -> std::io::Result<()> {
|
||||
#[cfg(test)]
|
||||
run_owned_file_before_open(&backup_path);
|
||||
let mut file = std::fs::File::create(&backup_path)?;
|
||||
std::io::Write::write_all(&mut file, old_metadata)?;
|
||||
if sync && !old_metadata.is_empty() {
|
||||
file.sync_data()?;
|
||||
}
|
||||
Ok(())
|
||||
})();
|
||||
if let Err(err) = write_res {
|
||||
let _ = remove_file_if_exists(&backup_path);
|
||||
return Err(err);
|
||||
}
|
||||
} else if sync && !old_metadata.is_empty() {
|
||||
os::open_file_for_sync_std(&backup_path)?.sync_data()?;
|
||||
}
|
||||
Ok(backup_path)
|
||||
@@ -679,14 +658,7 @@ impl LocalDisk {
|
||||
})
|
||||
.collect()
|
||||
};
|
||||
let src_volume_dir = if cfg!(target_os = "linux")
|
||||
&& src_volume == super::super::RUSTFS_META_TMP_BUCKET
|
||||
&& skip_access_checks(src_volume)
|
||||
{
|
||||
self.io_root().join(src_volume)
|
||||
} else {
|
||||
self.io_get_bucket_path(src_volume)?
|
||||
};
|
||||
let src_volume_dir = self.io_get_bucket_path(src_volume)?;
|
||||
if !skip_access_checks(src_volume)
|
||||
&& let Err(e) = super::super::fs::access_std(&src_volume_dir)
|
||||
{
|
||||
@@ -730,24 +702,8 @@ impl LocalDisk {
|
||||
} else {
|
||||
STORAGE_FORMAT_FILE
|
||||
};
|
||||
let flat_inline_tmp = cfg!(target_os = "linux")
|
||||
&& !no_inline
|
||||
&& src_volume == super::super::RUSTFS_META_TMP_BUCKET
|
||||
&& !preserve_upload_metadata
|
||||
&& multipart_publication.is_none()
|
||||
&& pool_meta_condition.is_none()
|
||||
&& !fi_healing
|
||||
&& !os::dst_dir_fsync_group_commit_enabled()
|
||||
&& !os::file_fdatasync_group_commit_enabled()
|
||||
&& !has_rename_data_test_failpoints(dst_path);
|
||||
let src_file_path = match multipart_publication.as_ref() {
|
||||
Some(publication) => publication.canonical_head(),
|
||||
None if flat_inline_tmp => {
|
||||
self.io_get_object_open_path(src_volume, format!("{src_path}.{source_metadata_name}").as_str())?
|
||||
}
|
||||
None if cfg!(target_os = "linux") => {
|
||||
self.io_get_object_open_path(src_volume, format!("{src_path}/{source_metadata_name}").as_str())?
|
||||
}
|
||||
None => self.io_get_object_path(src_volume, format!("{src_path}/{source_metadata_name}").as_str())?,
|
||||
};
|
||||
let dst_file_path = self.io_get_object_open_path(dst_volume, format!("{}/{}", dst_path, STORAGE_FORMAT_FILE).as_str())?;
|
||||
@@ -758,13 +714,14 @@ impl LocalDisk {
|
||||
.data_dir
|
||||
.map(|dir| rustfs_utils::path::retain_slash(dir.to_string().as_str()))
|
||||
{
|
||||
let src_rel = rustfs_utils::path::retain_slash(format!("{}/{}", src_path, data_dir).as_str());
|
||||
let src_data_path = if cfg!(target_os = "linux") && multipart_publication.is_none() && !fi_healing {
|
||||
self.io_get_object_open_path(src_volume, src_rel.as_str())?
|
||||
} else {
|
||||
self.io_get_object_path(src_volume, src_rel.as_str())?
|
||||
};
|
||||
let dst_data_path = destination_object_path.join(data_dir.trim_matches('/'));
|
||||
let src_data_path = self.io_get_object_path(
|
||||
src_volume,
|
||||
rustfs_utils::path::retain_slash(format!("{}/{}", src_path, data_dir).as_str()).as_str(),
|
||||
)?;
|
||||
let dst_data_path = self.io_get_object_path(
|
||||
dst_volume,
|
||||
rustfs_utils::path::retain_slash(format!("{}/{}", dst_path, data_dir).as_str()).as_str(),
|
||||
)?;
|
||||
|
||||
Some((src_data_path, dst_data_path))
|
||||
} else {
|
||||
@@ -847,7 +804,7 @@ impl LocalDisk {
|
||||
|
||||
let fused_attempt = move |is_cancelled: &dyn Fn() -> bool| -> std::io::Result<FusedCommitAttempt> {
|
||||
let (guard, has_dst_buf) = prepare_rename_commit_and_destination_metadata_std(
|
||||
!no_inline && !flat_inline_tmp,
|
||||
!no_inline,
|
||||
&src_parent_owned,
|
||||
&dst_parent_owned,
|
||||
&dst_file_path_owned,
|
||||
@@ -919,16 +876,7 @@ impl LocalDisk {
|
||||
run_owned_file_before_open(&src_file_path_owned);
|
||||
let mut prepared_metadata_source =
|
||||
os::create_prepared_rename_source_with_commit_guard(&src_file_path_owned, &dst_file_path_owned, &guard)?;
|
||||
let cleanup_flat_tmp = || {
|
||||
if flat_inline_tmp {
|
||||
let _ = remove_file_if_exists(&src_file_path_owned);
|
||||
}
|
||||
};
|
||||
if let Err(err) = prepared_metadata_source.write_all(&new_dst_buf, false) {
|
||||
drop(prepared_metadata_source);
|
||||
cleanup_flat_tmp();
|
||||
return Err(err);
|
||||
}
|
||||
prepared_metadata_source.write_all(&new_dst_buf, false)?;
|
||||
if !no_inline {
|
||||
run_inline_preparation_before_backup(&dst_path_str);
|
||||
}
|
||||
@@ -936,21 +884,14 @@ impl LocalDisk {
|
||||
let mut staged_rollback_path = None;
|
||||
if (!no_inline || rollback_data_dir.is_none())
|
||||
&& let Some(ref old_metadata) = has_dst_buf
|
||||
&& (rollback_data_dir.is_some() || cfg!(test))
|
||||
&& (rollback_data_dir.is_some() || sync_commit_metadata || cfg!(test))
|
||||
{
|
||||
let backup_path = match create_local_inline_rollback_backup(
|
||||
let backup_path = create_local_inline_rollback_backup(
|
||||
&dst_file_path_owned,
|
||||
&src_file_path_owned,
|
||||
old_metadata,
|
||||
sync_commit_metadata,
|
||||
) {
|
||||
Ok(path) => path,
|
||||
Err(err) => {
|
||||
drop(prepared_metadata_source);
|
||||
cleanup_flat_tmp();
|
||||
return Err(err);
|
||||
}
|
||||
};
|
||||
)?;
|
||||
staged_rollback_path = Some(StagedRollbackBackup(backup_path));
|
||||
}
|
||||
|
||||
@@ -979,8 +920,6 @@ impl LocalDisk {
|
||||
return Err(err);
|
||||
}
|
||||
} else if sync_commit_metadata && let Err(err) = prepared_metadata_source.sync_data() {
|
||||
drop(prepared_metadata_source);
|
||||
cleanup_flat_tmp();
|
||||
if let Some(backup_path) = staged_rollback_path.as_ref().map(StagedRollbackBackup::path) {
|
||||
let _ = remove_file_if_exists(backup_path);
|
||||
}
|
||||
@@ -989,7 +928,6 @@ impl LocalDisk {
|
||||
|
||||
if is_cancelled() {
|
||||
drop(prepared_metadata_source);
|
||||
cleanup_flat_tmp();
|
||||
if let Some(backup_path) = staged_rollback_path.as_ref().map(StagedRollbackBackup::path) {
|
||||
let _ = remove_file_if_exists(backup_path);
|
||||
}
|
||||
@@ -1006,8 +944,6 @@ impl LocalDisk {
|
||||
) {
|
||||
Ok(guard) => guard,
|
||||
Err(err) => {
|
||||
drop(prepared_metadata_source);
|
||||
cleanup_flat_tmp();
|
||||
if let Some(backup_path) = staged_rollback_path.as_ref().map(StagedRollbackBackup::path) {
|
||||
let _ = remove_file_if_exists(backup_path);
|
||||
}
|
||||
@@ -1091,8 +1027,6 @@ impl LocalDisk {
|
||||
None,
|
||||
sync_commit_metadata,
|
||||
) {
|
||||
drop(prepared_metadata_source);
|
||||
cleanup_flat_tmp();
|
||||
let _ = remove_file_if_exists(staged_backup);
|
||||
return Ok(FusedCommitAttempt::CommitErr(to_file_error(err).into()));
|
||||
}
|
||||
@@ -1113,7 +1047,6 @@ impl LocalDisk {
|
||||
)
|
||||
};
|
||||
if let Err(err) = rename_res {
|
||||
cleanup_flat_tmp();
|
||||
if let Some(backup_path) = staged_rollback_path.as_ref().map(StagedRollbackBackup::path) {
|
||||
let _ = remove_file_if_exists(backup_path);
|
||||
}
|
||||
@@ -1142,38 +1075,8 @@ impl LocalDisk {
|
||||
return Ok(FusedCommitAttempt::CommitErr(DiskError::Unexpected));
|
||||
}
|
||||
|
||||
if sync_commit_metadata {
|
||||
if staged_rollback_path.is_none()
|
||||
&& rollback_data_dir.is_none()
|
||||
&& let Some(ref old_metadata) = has_dst_buf
|
||||
&& (!no_inline || rollback_data_dir.is_none())
|
||||
{
|
||||
let fsync_res = (|| -> std::io::Result<()> {
|
||||
if let Some(dst_parent) = dst_file_path_owned.parent() {
|
||||
os::fsync_commit_directory_limited_std(dst_parent, &guard)?;
|
||||
}
|
||||
Ok(())
|
||||
})();
|
||||
if let Err(err) = fsync_res {
|
||||
let rollback_ok =
|
||||
write_local_inline_rollback_backup_from_bytes(&src_file_path_owned, old_metadata, true)
|
||||
.and_then(|backup_path| {
|
||||
let backup = StagedRollbackBackup(backup_path);
|
||||
let res =
|
||||
rollback_inline_metadata_std(&dst_file_path_owned, rollback_data_dir, Some(&backup));
|
||||
let _ = remove_file_if_exists(backup.path());
|
||||
res
|
||||
})
|
||||
.is_ok();
|
||||
if no_inline {
|
||||
if rollback_ok && let Some((_, new_data_path)) = has_data_dir_path_owned.as_ref() {
|
||||
let _ = remove_dir_all_if_exists(new_data_path);
|
||||
}
|
||||
return Ok(FusedCommitAttempt::CommitErr(to_file_error(err).into()));
|
||||
}
|
||||
return Ok(FusedCommitAttempt::CommitErr(DiskError::from(err)));
|
||||
}
|
||||
} else if let Err(err) = fsync_inline_commit_std(
|
||||
if sync_commit_metadata
|
||||
&& let Err(err) = fsync_inline_commit_std(
|
||||
&dst_file_path_owned,
|
||||
&dst_volume_dir_owned,
|
||||
destination_was_absent,
|
||||
@@ -1184,19 +1087,19 @@ impl LocalDisk {
|
||||
.filter(|_| no_inline)
|
||||
.map(|(_, new_data_path)| new_data_path.as_path()),
|
||||
&guard,
|
||||
) {
|
||||
if no_inline {
|
||||
return Ok(FusedCommitAttempt::CommitErr(to_file_error(err).into()));
|
||||
}
|
||||
return Ok(FusedCommitAttempt::CommitErr(DiskError::from(err)));
|
||||
)
|
||||
{
|
||||
if no_inline {
|
||||
return Ok(FusedCommitAttempt::CommitErr(to_file_error(err).into()));
|
||||
}
|
||||
return Ok(FusedCommitAttempt::CommitErr(DiskError::from(err)));
|
||||
}
|
||||
|
||||
if let Some(backup_path) = staged_rollback_path.as_ref().map(StagedRollbackBackup::path) {
|
||||
let _ = remove_file_if_exists(backup_path);
|
||||
}
|
||||
|
||||
if !flat_inline_tmp && let Some(parent) = src_file_path_owned.parent() {
|
||||
if let Some(parent) = src_file_path_owned.parent() {
|
||||
let _ = std::fs::remove_dir(parent);
|
||||
}
|
||||
|
||||
@@ -1461,7 +1364,7 @@ impl LocalDisk {
|
||||
}
|
||||
}
|
||||
}
|
||||
match publication_owned.finish_on_thread(sync_commit_metadata, !cfg!(test), staging_cleanup) {
|
||||
match publication_owned.finish_on_thread(sync_commit_metadata, staging_cleanup) {
|
||||
Ok(result) => Ok(MultipartFusedCommitOutcome::Committed(Box::new(RenameDataResp {
|
||||
multipart_source: Some(Box::new(result)),
|
||||
old_data_dir: has_old_data_dir,
|
||||
|
||||
@@ -856,12 +856,6 @@ pub(super) fn inspection_with_markers_bounded(
|
||||
let prepared_digest = prepared.as_deref().map(digest);
|
||||
let target_digest = target.as_deref().map(digest);
|
||||
let receipt_digest = receipt_bytes.as_deref().map(digest);
|
||||
let finished = finished
|
||||
|| (committed
|
||||
&& prepared.is_none()
|
||||
&& before.is_none()
|
||||
&& target.is_none()
|
||||
&& current_digest == journal.as_ref().and_then(|j| j.target_digest));
|
||||
if let Some(journal) = &journal {
|
||||
if (!finished
|
||||
&& journal.target_digest != target_digest
|
||||
@@ -1119,34 +1113,13 @@ pub(super) fn inspection_with_markers_bounded(
|
||||
Ok((inspection, has_physical_data_dirs_or_markers))
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
struct PreparedDeleteReceiptEntry {
|
||||
object_path: PathBuf,
|
||||
bucket_path: PathBuf,
|
||||
file_path: PathBuf,
|
||||
staging_root: PathBuf,
|
||||
journal_raw: Vec<u8>,
|
||||
journal: DeleteRecoveryJournal,
|
||||
sole_transaction: bool,
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
struct PublishedDeleteReceiptEntry {
|
||||
object_path: PathBuf,
|
||||
bucket_path: PathBuf,
|
||||
file_path: PathBuf,
|
||||
staging_root: PathBuf,
|
||||
journal_raw: Vec<u8>,
|
||||
}
|
||||
type PreparedDeleteReceiptEntry = (DeleteRecoveryJournal, bool);
|
||||
|
||||
const PREPARED_DELETE_RECEIPTS_PER_SHARD: usize = 64;
|
||||
|
||||
static PREPARED_DELETE_RECEIPTS: std::sync::LazyLock<os::ShardedPathCache<PreparedDeleteReceiptEntry>> =
|
||||
std::sync::LazyLock::new(|| os::ShardedPathCache::new(PREPARED_DELETE_RECEIPTS_PER_SHARD));
|
||||
|
||||
static PUBLISHED_DELETE_RECEIPTS: std::sync::LazyLock<os::ShardedPathCache<PublishedDeleteReceiptEntry>> =
|
||||
std::sync::LazyLock::new(|| os::ShardedPathCache::new(PREPARED_DELETE_RECEIPTS_PER_SHARD));
|
||||
|
||||
fn put_prepared_delete_receipt(rollback: impl AsRef<Path>, entry: PreparedDeleteReceiptEntry) {
|
||||
PREPARED_DELETE_RECEIPTS.insert(rollback.as_ref(), entry);
|
||||
}
|
||||
@@ -1155,27 +1128,6 @@ fn take_prepared_delete_receipt(rollback: &Path) -> Option<PreparedDeleteReceipt
|
||||
PREPARED_DELETE_RECEIPTS.remove(rollback)
|
||||
}
|
||||
|
||||
fn put_published_delete_receipt(rollback: impl AsRef<Path>, entry: PublishedDeleteReceiptEntry) {
|
||||
PUBLISHED_DELETE_RECEIPTS.insert(rollback.as_ref(), entry);
|
||||
}
|
||||
|
||||
fn take_published_delete_receipt(rollback: &Path) -> Option<PublishedDeleteReceiptEntry> {
|
||||
PUBLISHED_DELETE_RECEIPTS.remove(rollback)
|
||||
}
|
||||
|
||||
fn format_commit_receipt_bytes(journal_raw: &[u8], finished: bool) -> Vec<u8> {
|
||||
let suffix: &[u8] = if finished {
|
||||
b",\"finished\":true}"
|
||||
} else {
|
||||
b",\"finished\":false}"
|
||||
};
|
||||
let mut out = Vec::with_capacity(11 + journal_raw.len() + suffix.len());
|
||||
out.extend_from_slice(b"{\"journal\":");
|
||||
out.extend_from_slice(journal_raw);
|
||||
out.extend_from_slice(suffix);
|
||||
out
|
||||
}
|
||||
|
||||
impl LocalDisk {
|
||||
// Native MPU source closure has its own conditional protocol. Generic
|
||||
// object recovery must never restore its head or acquire SourceRW under
|
||||
@@ -2424,7 +2376,6 @@ impl LocalDisk {
|
||||
barrier(volume, object, transaction, stage, &self.root).await
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(super) async fn try_fused_recoverable_delete_version(
|
||||
&self,
|
||||
volume: &str,
|
||||
@@ -2433,21 +2384,6 @@ impl LocalDisk {
|
||||
opts: &DeleteOptions,
|
||||
transaction: Uuid,
|
||||
owner: Option<Arc<dyn Send + Sync>>,
|
||||
) -> Result<Option<()>> {
|
||||
self.try_fused_recoverable_delete_version_with_paths(volume, object, fi, opts, transaction, owner, None)
|
||||
.await
|
||||
}
|
||||
|
||||
#[expect(clippy::too_many_arguments)]
|
||||
pub(super) async fn try_fused_recoverable_delete_version_with_paths(
|
||||
&self,
|
||||
volume: &str,
|
||||
object: &str,
|
||||
fi: &FileInfo,
|
||||
opts: &DeleteOptions,
|
||||
transaction: Uuid,
|
||||
owner: Option<Arc<dyn Send + Sync>>,
|
||||
prevalidated_paths: Option<(PathBuf, PathBuf, PathBuf)>,
|
||||
) -> Result<Option<()>> {
|
||||
if !opts.recoverable_delete
|
||||
|| opts.undo_write
|
||||
@@ -2460,22 +2396,11 @@ impl LocalDisk {
|
||||
self.reject_multipart_delete_recovery_mutation(volume, object)?;
|
||||
self.wait_for_startup_cleanup().await;
|
||||
|
||||
let (object_path, bucket_path, file_path) = match prevalidated_paths {
|
||||
Some(paths) => paths,
|
||||
None => {
|
||||
let obj = self.get_object_path(volume, object)?;
|
||||
let (b, f) = self.io_get_bucket_and_object_path(volume, object)?;
|
||||
check_path_length(f.to_string_lossy().as_ref())?;
|
||||
(obj, b, f)
|
||||
}
|
||||
};
|
||||
let (_, file_path) = self.io_get_bucket_and_object_path(volume, object)?;
|
||||
check_path_length(file_path.to_string_lossy().as_ref())?;
|
||||
let xl_path = path_join(&[file_path.as_path(), Path::new(STORAGE_FORMAT_FILE)]);
|
||||
let destination = file_path.join(transaction.to_string());
|
||||
let staging_root = if cfg!(target_os = "linux") {
|
||||
self.io_root().join(RUSTFS_META_TMP_BUCKET)
|
||||
} else {
|
||||
self.io_get_bucket_path(RUSTFS_META_TMP_BUCKET)?
|
||||
};
|
||||
let staging_root = self.io_get_bucket_path(RUSTFS_META_TMP_BUCKET)?;
|
||||
let sync = effective_durability(volume).syncs_commit_metadata();
|
||||
let incarnation = opts.delete_recovery_bucket_incarnation;
|
||||
let lease = os::acquire_namespace_mutation_lease_with_owner(&destination, owner).await;
|
||||
@@ -2662,8 +2587,6 @@ impl LocalDisk {
|
||||
let _ = std::fs::remove_dir_all(&destination);
|
||||
return Err(err);
|
||||
}
|
||||
#[cfg(all(test, unix))]
|
||||
fused_prepare_checkpoint::run(&file_path);
|
||||
let mut reserved_data_path = None;
|
||||
if let Some(old_path) = old_data_path {
|
||||
let reserved_marker = old_path.join(format!("{RESERVED_DELETE_DATA_DIR_MARKER_PREFIX}{transaction}"));
|
||||
@@ -2683,7 +2606,6 @@ impl LocalDisk {
|
||||
reserved_data_path = Some((old_path, reserved_marker));
|
||||
}
|
||||
if let Some(ref target_bytes) = target {
|
||||
// A provisional head must stay outside the published recovery transaction.
|
||||
let target_in_rollback = destination.join(TARGET);
|
||||
let linked_xl = staging_root.join(format!("delete-xl-{transaction}"));
|
||||
let _ = std::fs::remove_file(&linked_xl);
|
||||
@@ -2731,18 +2653,7 @@ impl LocalDisk {
|
||||
Err(err) => return Err(err),
|
||||
}
|
||||
}
|
||||
put_prepared_delete_receipt(
|
||||
destination,
|
||||
PreparedDeleteReceiptEntry {
|
||||
object_path,
|
||||
bucket_path,
|
||||
file_path,
|
||||
staging_root,
|
||||
journal_raw,
|
||||
journal,
|
||||
sole_transaction,
|
||||
},
|
||||
);
|
||||
put_prepared_delete_receipt(destination, (journal, sole_transaction));
|
||||
Ok(Ok(Some(old_dir)))
|
||||
},
|
||||
)
|
||||
@@ -2779,45 +2690,19 @@ impl LocalDisk {
|
||||
namespace_owner: Option<Arc<dyn Send + Sync>>,
|
||||
work_budget: Option<Arc<crate::object_api::DeleteRecoveryWorkBudget>>,
|
||||
) -> Result<Option<(DeleteRecoveryJournal, bool, bool)>> {
|
||||
if transaction.is_nil() {
|
||||
self.reject_multipart_delete_recovery_mutation(volume, object)?;
|
||||
if !safe_path(object, false) || transaction.is_nil() {
|
||||
return Err(DiskError::InvalidPath);
|
||||
}
|
||||
let rollback_open_path = if volume != RUSTFS_META_MULTIPART_BUCKET {
|
||||
self.io_get_object_open_path(volume, object)
|
||||
.ok()
|
||||
.map(|p| p.join(transaction.to_string()))
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let cached_prepared = rollback_open_path.as_deref().and_then(take_prepared_delete_receipt);
|
||||
let (object_path, bucket_path, root, staging_root, cached_receipt) = match cached_prepared {
|
||||
Some(entry) => (
|
||||
entry.object_path,
|
||||
Some(entry.bucket_path),
|
||||
entry.file_path,
|
||||
entry.staging_root,
|
||||
Some((entry.journal_raw, entry.journal, entry.sole_transaction)),
|
||||
),
|
||||
None => {
|
||||
self.reject_multipart_delete_recovery_mutation(volume, object)?;
|
||||
if !safe_path(object, false) {
|
||||
return Err(DiskError::InvalidPath);
|
||||
}
|
||||
let obj_path = self.get_object_path(volume, object)?;
|
||||
(
|
||||
obj_path,
|
||||
None,
|
||||
self.io_get_object_path(volume, object)?,
|
||||
self.io_get_bucket_path(RUSTFS_META_TMP_BUCKET)?,
|
||||
None,
|
||||
)
|
||||
}
|
||||
};
|
||||
let object_path = self.get_object_path(volume, object)?;
|
||||
let metadata_owner = os::acquire_metadata_mutation_lease(&object_path, namespace_owner).await;
|
||||
let volume_guard = os::disk_volume_mutation_lock(&self.root, volume).read_owned().await;
|
||||
let owner: Option<Arc<dyn Send + Sync>> = Some(Arc::new((metadata_owner, volume_guard)));
|
||||
|
||||
let root = self.io_get_object_path(volume, object)?;
|
||||
let rollback = root.join(transaction.to_string());
|
||||
let receipt_path = rollback.join(DELETE_QUORUM_COMMITTED_FILE);
|
||||
let staging_root = self.io_get_bucket_path(RUSTFS_META_TMP_BUCKET)?;
|
||||
let sync = effective_durability(volume).syncs_commit_metadata();
|
||||
let lease = os::acquire_namespace_mutation_lease_with_owner(&receipt_path, owner).await;
|
||||
let volume_str = volume.to_owned();
|
||||
@@ -2827,38 +2712,23 @@ impl LocalDisk {
|
||||
lease,
|
||||
sync,
|
||||
move || -> std::io::Result<Result<Option<(DeleteRecoveryJournal, bool, bool)>>> {
|
||||
if let Some((journal_raw, journal, sole_transaction)) = cached_receipt
|
||||
if let Some((journal, sole_transaction)) = take_prepared_delete_receipt(&rollback)
|
||||
&& rollback.join(PREPARED).is_file()
|
||||
{
|
||||
let tmp_receipt = staging_root.join(format!("receipt-{transaction}.tmp"));
|
||||
let receipt_bytes = format_commit_receipt_bytes(&journal_raw, false);
|
||||
let write_res = (|| -> std::io::Result<()> {
|
||||
let mut file = std::fs::File::create(&tmp_receipt)?;
|
||||
std::io::Write::write_all(&mut file, &receipt_bytes)?;
|
||||
if sync && !receipt_bytes.is_empty() {
|
||||
file.sync_data()?;
|
||||
}
|
||||
std::fs::rename(&tmp_receipt, &receipt_path)?;
|
||||
if sync {
|
||||
os::fsync_dir_std(&rollback)?;
|
||||
}
|
||||
Ok(())
|
||||
})();
|
||||
if let Err(err) = write_res {
|
||||
let _ = std::fs::remove_file(&tmp_receipt);
|
||||
return Err(err);
|
||||
let receipt = CommitReceipt {
|
||||
journal: journal.clone(),
|
||||
finished: false,
|
||||
};
|
||||
let receipt_bytes = serde_json::to_vec(&receipt).map_err(std::io::Error::other)?;
|
||||
std::fs::create_dir_all(&staging_root)?;
|
||||
let mut staged = tempfile::NamedTempFile::new_in(&staging_root)?;
|
||||
std::io::Write::write_all(staged.as_file_mut(), &receipt_bytes)?;
|
||||
if sync && !receipt_bytes.is_empty() {
|
||||
staged.as_file().sync_data()?;
|
||||
}
|
||||
if let Some(bucket_path) = bucket_path {
|
||||
put_published_delete_receipt(
|
||||
rollback,
|
||||
PublishedDeleteReceiptEntry {
|
||||
object_path,
|
||||
bucket_path,
|
||||
file_path: root,
|
||||
staging_root,
|
||||
journal_raw,
|
||||
},
|
||||
);
|
||||
std::fs::rename(staged.path(), &receipt_path)?;
|
||||
if sync {
|
||||
os::fsync_dir_std(&rollback)?;
|
||||
}
|
||||
return Ok(Ok(Some((journal, sole_transaction, true))));
|
||||
}
|
||||
@@ -2981,46 +2851,14 @@ impl LocalDisk {
|
||||
Err(err) => Err(err),
|
||||
}
|
||||
}
|
||||
if transaction.is_nil() {
|
||||
self.reject_multipart_delete_recovery_mutation(volume, object)?;
|
||||
if !safe_path(object, false) || transaction.is_nil() {
|
||||
return Err(DiskError::InvalidPath);
|
||||
}
|
||||
let rollback_open_path = if volume != RUSTFS_META_MULTIPART_BUCKET {
|
||||
self.io_get_object_open_path(volume, object)
|
||||
.ok()
|
||||
.map(|p| p.join(transaction.to_string()))
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let cached_published = rollback_open_path.as_deref().and_then(take_published_delete_receipt);
|
||||
let (object_path, bucket_path, staging_root, root, cached_journal_raw) = match cached_published {
|
||||
Some(entry) => (
|
||||
entry.object_path,
|
||||
entry.bucket_path,
|
||||
entry.staging_root,
|
||||
entry.file_path,
|
||||
Some(entry.journal_raw),
|
||||
),
|
||||
None => {
|
||||
self.reject_multipart_delete_recovery_mutation(volume, object)?;
|
||||
if !safe_path(object, false) {
|
||||
return Err(DiskError::InvalidPath);
|
||||
}
|
||||
let obj_path = self.get_object_path(volume, object)?;
|
||||
(
|
||||
obj_path,
|
||||
self.io_get_bucket_path(volume)?,
|
||||
self.io_get_bucket_path(RUSTFS_META_TMP_BUCKET)?,
|
||||
self.io_get_object_path(volume, object)?,
|
||||
None,
|
||||
)
|
||||
}
|
||||
};
|
||||
let object_path = self.get_object_path(volume, object)?;
|
||||
let metadata_owner = os::acquire_metadata_mutation_lease(&object_path, namespace_owner).await;
|
||||
let volume_guard = os::disk_volume_mutation_lock(&self.root, volume).read_owned().await;
|
||||
let owner: Option<Arc<dyn Send + Sync>> = Some(Arc::new((metadata_owner, volume_guard)));
|
||||
let rollback = root.join(transaction.to_string());
|
||||
let receipt_path = rollback.join(DELETE_QUORUM_COMMITTED_FILE);
|
||||
let sync = effective_durability(volume).syncs_commit_metadata();
|
||||
|
||||
let mut claims: Vec<SnapshotLeaseDeleteClaim> = Vec::with_capacity(journal.data_dirs.len());
|
||||
for data_dir in &journal.data_dirs {
|
||||
@@ -3042,9 +2880,15 @@ impl LocalDisk {
|
||||
claims.push(claim);
|
||||
}
|
||||
|
||||
let bucket_path = self.io_get_bucket_path(volume)?;
|
||||
let staging_root = self.io_get_bucket_path(RUSTFS_META_TMP_BUCKET)?;
|
||||
let root = self.io_get_object_path(volume, object)?;
|
||||
let rollback = root.join(transaction.to_string());
|
||||
let receipt_path = rollback.join(DELETE_QUORUM_COMMITTED_FILE);
|
||||
let sync = effective_durability(volume).syncs_commit_metadata();
|
||||
let data_dirs = journal.data_dirs.clone();
|
||||
let has_target = journal.target_digest.is_some();
|
||||
let journal_for_receipt = cached_journal_raw.is_none().then(|| journal.clone());
|
||||
let journal_for_receipt = journal.clone();
|
||||
let lease = os::acquire_namespace_mutation_lease_with_owner(&receipt_path, owner).await;
|
||||
let prune_paths: Vec<_> = rollback
|
||||
.ancestors()
|
||||
@@ -3053,31 +2897,6 @@ impl LocalDisk {
|
||||
.collect();
|
||||
|
||||
let res = os::run_blocking_namespace_operation_with_sync(lease, sync, move || -> std::io::Result<()> {
|
||||
let persist_receipt = |finished: bool| -> std::io::Result<()> {
|
||||
let receipt_bytes = match &cached_journal_raw {
|
||||
Some(raw) => format_commit_receipt_bytes(raw, finished),
|
||||
None => {
|
||||
let receipt = CommitReceipt {
|
||||
journal: journal_for_receipt
|
||||
.clone()
|
||||
.ok_or_else(|| std::io::Error::other("missing journal for receipt"))?,
|
||||
finished,
|
||||
};
|
||||
serde_json::to_vec(&receipt).map_err(std::io::Error::other)?
|
||||
}
|
||||
};
|
||||
std::fs::create_dir_all(&staging_root)?;
|
||||
let mut staged_receipt = tempfile::NamedTempFile::new_in(&staging_root)?;
|
||||
std::io::Write::write_all(staged_receipt.as_file_mut(), &receipt_bytes)?;
|
||||
if sync && !receipt_bytes.is_empty() {
|
||||
staged_receipt.as_file().sync_data()?;
|
||||
}
|
||||
std::fs::rename(staged_receipt.path(), &receipt_path)?;
|
||||
if sync {
|
||||
let _ = os::fsync_dir_std(&rollback);
|
||||
}
|
||||
Ok(())
|
||||
};
|
||||
let committed = format!("{DELETE_DATA_DIR_MARKER_PREFIX}{transaction}");
|
||||
let recovery_committed = format!("{RECOVERY_DELETE_DATA_DIR_MARKER_PREFIX}{transaction}");
|
||||
let reserved = format!("{RESERVED_DELETE_DATA_DIR_MARKER_PREFIX}{transaction}");
|
||||
@@ -3132,38 +2951,38 @@ impl LocalDisk {
|
||||
os::fsync_dir_std(&root)?;
|
||||
}
|
||||
for name in [STORAGE_FORMAT_FILE_BACKUP, DELETE_MARKER_ROLLBACK_FILE] {
|
||||
if let Err(err) = ignore_not_found(std::fs::remove_file(rollback.join(name))) {
|
||||
if has_target || had_physical_data_dirs {
|
||||
let _ = persist_receipt(true);
|
||||
}
|
||||
return Err(err);
|
||||
ignore_not_found(std::fs::remove_file(rollback.join(name)))?;
|
||||
}
|
||||
if has_target || had_physical_data_dirs {
|
||||
let finished_receipt = CommitReceipt {
|
||||
journal: journal_for_receipt,
|
||||
finished: true,
|
||||
};
|
||||
let receipt_bytes = serde_json::to_vec(&finished_receipt).map_err(std::io::Error::other)?;
|
||||
std::fs::create_dir_all(&staging_root)?;
|
||||
let mut staged_receipt = tempfile::NamedTempFile::new_in(&staging_root)?;
|
||||
std::io::Write::write_all(staged_receipt.as_file_mut(), &receipt_bytes)?;
|
||||
if sync && !receipt_bytes.is_empty() {
|
||||
staged_receipt.as_file().sync_data()?;
|
||||
}
|
||||
std::fs::rename(staged_receipt.path(), &receipt_path)?;
|
||||
let _ = std::fs::File::create(rollback.join(FINISHED))?;
|
||||
if sync {
|
||||
os::fsync_dir_std(&rollback)?;
|
||||
}
|
||||
}
|
||||
for name in [PREPARED, TARGET, FINISHED] {
|
||||
for name in [TARGET, PREPARED, FINISHED] {
|
||||
let path = rollback.join(name);
|
||||
#[cfg(all(any(test, feature = "test-util"), not(windows)))]
|
||||
os::prepared_publication_test_hooks::run(os::prepared_publication_test_hooks::Stage::Remove, &path);
|
||||
if let Err(err) = ignore_not_found(std::fs::remove_file(path)) {
|
||||
if has_target || had_physical_data_dirs {
|
||||
let _ = persist_receipt(true);
|
||||
}
|
||||
return Err(err);
|
||||
}
|
||||
ignore_not_found(std::fs::remove_file(path))?;
|
||||
}
|
||||
if sync && let Err(err) = os::fsync_dir_std(&rollback) {
|
||||
if has_target || had_physical_data_dirs {
|
||||
let _ = persist_receipt(true);
|
||||
}
|
||||
return Err(err);
|
||||
if sync {
|
||||
os::fsync_dir_std(&rollback)?;
|
||||
}
|
||||
#[cfg(all(any(test, feature = "test-util"), not(windows)))]
|
||||
os::prepared_publication_test_hooks::run(os::prepared_publication_test_hooks::Stage::Remove, &receipt_path);
|
||||
if let Err(err) = ignore_not_found(std::fs::remove_file(&receipt_path)) {
|
||||
if has_target || had_physical_data_dirs {
|
||||
let _ = persist_receipt(true);
|
||||
}
|
||||
return Err(err);
|
||||
}
|
||||
ignore_not_found(std::fs::remove_file(&receipt_path))?;
|
||||
for dir_path in &prune_paths {
|
||||
#[cfg(all(any(test, feature = "test-util"), not(windows)))]
|
||||
os::prepared_publication_test_hooks::run(os::prepared_publication_test_hooks::Stage::Remove, dir_path);
|
||||
@@ -3286,42 +3105,6 @@ pub(super) async fn restore_barrier(volume: &str, object_dir: &Path, transaction
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(all(test, unix))]
|
||||
mod fused_prepare_checkpoint {
|
||||
use std::collections::HashMap;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::{LazyLock, Mutex};
|
||||
|
||||
type Hook = Box<dyn FnOnce() + Send>;
|
||||
static HOOKS: LazyLock<Mutex<HashMap<PathBuf, Hook>>> = LazyLock::new(|| Mutex::new(HashMap::new()));
|
||||
|
||||
pub(super) struct Guard(PathBuf);
|
||||
|
||||
impl Drop for Guard {
|
||||
fn drop(&mut self) {
|
||||
HOOKS.lock().expect("checkpoint hooks").remove(&self.0);
|
||||
}
|
||||
}
|
||||
|
||||
pub(super) fn install(root: &Path, hook: impl FnOnce() + Send + 'static) -> Guard {
|
||||
assert!(
|
||||
HOOKS
|
||||
.lock()
|
||||
.expect("checkpoint hooks")
|
||||
.insert(root.to_path_buf(), Box::new(hook))
|
||||
.is_none()
|
||||
);
|
||||
Guard(root.to_path_buf())
|
||||
}
|
||||
|
||||
pub(super) fn run(root: &Path) {
|
||||
let hook = HOOKS.lock().expect("checkpoint hooks").remove(root);
|
||||
if let Some(hook) = hook {
|
||||
hook();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
@@ -7237,73 +7020,6 @@ mod tests {
|
||||
marker.deleted = false;
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[tokio::test]
|
||||
async fn delete_recovery_fused_prepare_checkpoint_reopens_before_head_publication() {
|
||||
let (_temp, disk, mut first, _) = fixture().await;
|
||||
first.version_id = Some(Uuid::new_v4());
|
||||
let mut second = first.clone();
|
||||
second.version_id = Some(Uuid::new_v4());
|
||||
let mut meta = FileMeta::new();
|
||||
meta.add_version(first).expect("add surviving version");
|
||||
meta.add_version(second.clone()).expect("add deleted version");
|
||||
let original = meta.marshal_msg().expect("encode original versions");
|
||||
let (_, root) = disk.io_get_bucket_and_object_path("recovery", "object").expect("object path");
|
||||
fs::write(root.join(STORAGE_FORMAT_FILE), &original)
|
||||
.await
|
||||
.expect("write versions");
|
||||
|
||||
let (checkpoint_temp, checkpoint_disk, _, _) = fixture().await;
|
||||
let checkpoint_root = checkpoint_temp.path().join("recovery/object");
|
||||
drop(checkpoint_disk);
|
||||
let transaction = Uuid::new_v4();
|
||||
let source_root = root.clone();
|
||||
let copy_root = checkpoint_root.clone();
|
||||
let _capture = fused_prepare_checkpoint::install(&root, move || {
|
||||
let source = source_root.join(transaction.to_string());
|
||||
let destination = copy_root.join(transaction.to_string());
|
||||
std::fs::create_dir(&destination).expect("create checkpoint transaction");
|
||||
std::fs::copy(source_root.join(STORAGE_FORMAT_FILE), copy_root.join(STORAGE_FORMAT_FILE))
|
||||
.expect("capture head before publication");
|
||||
for entry in std::fs::read_dir(source).expect("read published preparation") {
|
||||
let entry = entry.expect("prepared file");
|
||||
assert!(entry.file_type().expect("prepared file type").is_file());
|
||||
std::fs::copy(entry.path(), destination.join(entry.file_name())).expect("capture prepared file");
|
||||
}
|
||||
});
|
||||
let opts = DeleteOptions {
|
||||
recoverable_delete: true,
|
||||
..Default::default()
|
||||
};
|
||||
assert_eq!(
|
||||
disk.try_fused_recoverable_delete_version("recovery", "object", &second, &opts, transaction, None)
|
||||
.await
|
||||
.expect("finish original preparation"),
|
||||
Some(())
|
||||
);
|
||||
assert!(checkpoint_root.join(transaction.to_string()).join(PREPARED).is_file());
|
||||
let endpoint =
|
||||
Endpoint::try_from(checkpoint_temp.path().to_str().expect("checkpoint path")).expect("checkpoint endpoint");
|
||||
let reopened = LocalDisk::new(&endpoint, false)
|
||||
.await
|
||||
.expect("reopen checkpoint as a fresh disk");
|
||||
let inspection = reopened
|
||||
.delete_recovery_inspect("recovery", "object", transaction)
|
||||
.await
|
||||
.expect("actual preparation checkpoint must remain recoverable");
|
||||
assert_eq!(inspection.state, DeleteRecoveryState::NewPrepared);
|
||||
reopened
|
||||
.settle_delete_transaction("recovery", "object", transaction, inspection.fingerprint, DeleteRecoveryAction::Rollback)
|
||||
.await
|
||||
.expect("roll back interrupted preparation");
|
||||
assert_eq!(
|
||||
fs::read(checkpoint_root.join(STORAGE_FORMAT_FILE))
|
||||
.await
|
||||
.expect("read rolled-back versions"),
|
||||
original
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn delete_recovery_fused_versioned_delete_with_surviving_version_and_interrupted_target_cleanup() {
|
||||
let (_temp, disk, mut v1, _) = fixture().await;
|
||||
|
||||
@@ -372,32 +372,29 @@ impl IndexOwner {
|
||||
#[cfg(unix)]
|
||||
{
|
||||
use rustix::fs::{Mode, OFlags, mkdirat, openat};
|
||||
let open_dir = |parent: rustix::fd::BorrowedFd<'_>, component: &str| -> io::Result<rustix::fd::OwnedFd> {
|
||||
let flags = OFlags::RDONLY | OFlags::DIRECTORY | OFlags::NOFOLLOW | OFlags::CLOEXEC;
|
||||
match openat(parent, component, flags, Mode::empty()) {
|
||||
Ok(dir) => Ok(dir),
|
||||
Err(rustix::io::Errno::NOENT) => {
|
||||
match mkdirat(parent, component, Mode::RWXU | Mode::RWXG | Mode::RWXO) {
|
||||
Ok(()) | Err(rustix::io::Errno::EXIST) => {}
|
||||
Err(error) => return Err(error.into()),
|
||||
}
|
||||
openat(parent, component, flags, Mode::empty()).map_err(Into::into)
|
||||
}
|
||||
Err(error) => Err(error.into()),
|
||||
let mut directories = vec![self._identity_pin.try_clone()?];
|
||||
for component in [".rustfs.sys", "multipart-index-v1", &sha(bucket)] {
|
||||
let parent = directories.last().ok_or_else(|| io::Error::other("index parent missing"))?;
|
||||
match mkdirat(parent, component, Mode::RWXU | Mode::RWXG | Mode::RWXO) {
|
||||
Ok(()) | Err(rustix::io::Errno::EXIST) => {}
|
||||
Err(error) => return Err(error.into()),
|
||||
}
|
||||
};
|
||||
use std::os::fd::AsFd;
|
||||
let bucket_sha = sha(bucket);
|
||||
let sys_dir = open_dir(self._identity_pin.as_fd(), ".rustfs.sys")?;
|
||||
let index_dir = open_dir(sys_dir.as_fd(), "multipart-index-v1")?;
|
||||
let parent = open_dir(index_dir.as_fd(), &bucket_sha)?;
|
||||
let directory = openat(
|
||||
parent,
|
||||
component,
|
||||
OFlags::RDONLY | OFlags::DIRECTORY | OFlags::NOFOLLOW | OFlags::CLOEXEC,
|
||||
Mode::empty(),
|
||||
)?;
|
||||
directories.push(std::fs::File::from(directory));
|
||||
}
|
||||
let parent = directories.last().ok_or_else(|| io::Error::other("index parent missing"))?;
|
||||
// The index is boot-local: every start rescans the staging area
|
||||
// before serving it, so a marker lost to a crash is recreated before
|
||||
// it can be consulted. Creation is enough; no fsync of the marker or
|
||||
// its ancestors. An existing marker is touched so pruning sees the
|
||||
// new upload's age, not the previous one's.
|
||||
match openat(
|
||||
&parent,
|
||||
parent,
|
||||
source_root,
|
||||
OFlags::CREATE | OFlags::EXCL | OFlags::WRONLY | OFlags::NOFOLLOW | OFlags::CLOEXEC,
|
||||
Mode::RUSR | Mode::WUSR,
|
||||
@@ -412,7 +409,7 @@ impl IndexOwner {
|
||||
// the previous upload's age, which only shortens the prune
|
||||
// grace for this key; index completeness does not depend on it.
|
||||
if let Ok(marker) =
|
||||
openat(&parent, source_root, OFlags::WRONLY | OFlags::NOFOLLOW | OFlags::CLOEXEC, Mode::empty())
|
||||
openat(parent, source_root, OFlags::WRONLY | OFlags::NOFOLLOW | OFlags::CLOEXEC, Mode::empty())
|
||||
{
|
||||
let _ = std::fs::File::from(marker).set_modified(std::time::SystemTime::now());
|
||||
}
|
||||
@@ -433,18 +430,6 @@ impl IndexOwner {
|
||||
}
|
||||
|
||||
fn ensure_current_root(&self) -> io::Result<()> {
|
||||
#[cfg(unix)]
|
||||
let current = {
|
||||
use std::os::unix::fs::MetadataExt;
|
||||
let metadata = std::fs::symlink_metadata(&*self.root_path)?;
|
||||
if !metadata.is_dir() {
|
||||
return Err(io::Error::other("multipart index physical root is not a directory"));
|
||||
}
|
||||
let mut inode = [0; 16];
|
||||
inode[..8].copy_from_slice(&metadata.ino().to_le_bytes());
|
||||
(metadata.dev(), inode)
|
||||
};
|
||||
#[cfg(not(unix))]
|
||||
let current = os::PublicationRoot::new(&self.root_path)?.physical_identity()?;
|
||||
if current != self.physical {
|
||||
self.disabled.store(true, Ordering::Release);
|
||||
|
||||
@@ -1979,28 +1979,25 @@ impl NativeMultipartPublication {
|
||||
let canonical = self.canonical_head();
|
||||
let prepared = (|| -> std::io::Result<os::PreparedRenameSource> {
|
||||
if let Some((ref original_bytes, _, _)) = deferred_initial {
|
||||
if cfg!(test) || !can_mark_presynced {
|
||||
let current =
|
||||
load_source(source, base, root, path, disk_id, physical_slot, disk_ids).map_err(IoError::other)?;
|
||||
let snapshot = current
|
||||
.snapshot
|
||||
.as_ref()
|
||||
.ok_or_else(|| IoError::other(DiskError::ConditionalDeleteConflict))?;
|
||||
let current_head = current
|
||||
.head
|
||||
.as_ref()
|
||||
.and_then(SourceHead::raw)
|
||||
.ok_or_else(|| IoError::other(DiskError::ConditionalDeleteConflict))?;
|
||||
if !current.head_matches_state
|
||||
|| snapshot.phase != MultipartSourcePhase::Active
|
||||
|| snapshot.capability_sha256.is_some()
|
||||
|| snapshot.lineage != expected_lineage
|
||||
|| snapshot.generation != expected_generation
|
||||
|| snapshot.revision.checked_add(1) != Some(expected_revision)
|
||||
|| current_head != original_bytes.as_slice()
|
||||
{
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
}
|
||||
let current = load_source(source, base, root, path, disk_id, physical_slot, disk_ids).map_err(IoError::other)?;
|
||||
let snapshot = current
|
||||
.snapshot
|
||||
.as_ref()
|
||||
.ok_or_else(|| IoError::other(DiskError::ConditionalDeleteConflict))?;
|
||||
let current_head = current
|
||||
.head
|
||||
.as_ref()
|
||||
.and_then(SourceHead::raw)
|
||||
.ok_or_else(|| IoError::other(DiskError::ConditionalDeleteConflict))?;
|
||||
if !current.head_matches_state
|
||||
|| snapshot.phase != MultipartSourcePhase::Active
|
||||
|| snapshot.capability_sha256.is_some()
|
||||
|| snapshot.lineage != expected_lineage
|
||||
|| snapshot.generation != expected_generation
|
||||
|| snapshot.revision.checked_add(1) != Some(expected_revision)
|
||||
|| current_head != original_bytes.as_slice()
|
||||
{
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
}
|
||||
} else {
|
||||
let current = load_source(source, base, root, path, disk_id, physical_slot, disk_ids).map_err(IoError::other)?;
|
||||
@@ -2053,7 +2050,7 @@ impl NativeMultipartPublication {
|
||||
let _ = std::fs::remove_file(prepared_path);
|
||||
return Err(err);
|
||||
}
|
||||
os::install_multipart_prepared_head(prepared_metadata_source, &canonical, base, root, Some(directory_guard))
|
||||
os::install_multipart_prepared_head(prepared_metadata_source, &canonical, base, root)
|
||||
})()
|
||||
.map_err(DiskError::from)?;
|
||||
*self.state.lock() = state;
|
||||
@@ -2163,7 +2160,7 @@ impl NativeMultipartPublication {
|
||||
let mut prepared_metadata_source =
|
||||
os::create_prepared_rename_source_with_commit_guard(&prepared_path, &dst_file_path, &owned_directory_guard)?;
|
||||
prepared_metadata_source.write_all(&new_bytes, true)?;
|
||||
os::install_multipart_prepared_head(prepared_metadata_source, &canonical, &base, &root, Some(&owned_directory_guard))
|
||||
os::install_multipart_prepared_head(prepared_metadata_source, &canonical, &base, &root)
|
||||
})
|
||||
.await
|
||||
.map_err(DiskError::from)?;
|
||||
@@ -2210,7 +2207,7 @@ impl NativeMultipartPublication {
|
||||
let base = self.store.base.clone();
|
||||
let root = self.store.publication_root.clone();
|
||||
os::run_blocking_namespace_operation(self.store.lease.clone(), move || {
|
||||
os::install_multipart_prepared_head(prepared, &canonical, &base, &root, None)
|
||||
os::install_multipart_prepared_head(prepared, &canonical, &base, &root)
|
||||
})
|
||||
.await
|
||||
.map_err(DiskError::from)
|
||||
@@ -2267,7 +2264,6 @@ impl NativeMultipartPublication {
|
||||
pub(super) fn finish_on_thread(
|
||||
&self,
|
||||
target_already_synced: bool,
|
||||
fused_in_place: bool,
|
||||
staging_cleanup: Option<(PathBuf, Arc<std::sync::atomic::AtomicBool>)>,
|
||||
) -> Result<MultipartPublicationResult> {
|
||||
let mut state = self.state.lock().clone();
|
||||
@@ -2297,64 +2293,62 @@ impl NativeMultipartPublication {
|
||||
let disk_ids = &self.store.disk_ids;
|
||||
let terminal = terminal_record_path(source, &state);
|
||||
(|| -> std::io::Result<()> {
|
||||
if !fused_in_place {
|
||||
let current = load_source(source, base, root, path, disk_id, physical_slot, disk_ids).map_err(IoError::other)?;
|
||||
let current_state = current
|
||||
.state
|
||||
.as_ref()
|
||||
.ok_or_else(|| IoError::other(DiskError::ConditionalDeleteConflict))?;
|
||||
let current_raw = encode(current_state).map_err(IoError::other)?;
|
||||
if current.head.is_some() || current_raw != expected_state_raw {
|
||||
let current = load_source(source, base, root, path, disk_id, physical_slot, disk_ids).map_err(IoError::other)?;
|
||||
let current_state = current
|
||||
.state
|
||||
.as_ref()
|
||||
.ok_or_else(|| IoError::other(DiskError::ConditionalDeleteConflict))?;
|
||||
let current_raw = encode(current_state).map_err(IoError::other)?;
|
||||
if current.head.is_some() || current_raw != expected_state_raw {
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
}
|
||||
if target_already_synced {
|
||||
let pinned = os::pin_multipart_source_directory(&target_dir, base, root).map_err(|error| {
|
||||
if error.kind() == std::io::ErrorKind::NotFound {
|
||||
IoError::other(DiskError::ConditionalDeleteConflict)
|
||||
} else {
|
||||
error
|
||||
}
|
||||
})?;
|
||||
let target = os::read_multipart_source_metadata_in_pinned(
|
||||
&pinned,
|
||||
&target_dir,
|
||||
std::ffi::OsStr::new(STORAGE_FORMAT_FILE),
|
||||
base,
|
||||
root,
|
||||
)
|
||||
.map_err(|error| {
|
||||
if error.kind() == std::io::ErrorKind::NotFound {
|
||||
IoError::other(DiskError::ConditionalDeleteConflict)
|
||||
} else {
|
||||
error
|
||||
}
|
||||
})?;
|
||||
if target.len() as u64 != expected_length || raw_sha(&target) != expected_sha256 {
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
}
|
||||
if target_already_synced {
|
||||
let pinned = os::pin_multipart_source_directory(&target_dir, base, root).map_err(|error| {
|
||||
if error.kind() == std::io::ErrorKind::NotFound {
|
||||
IoError::other(DiskError::ConditionalDeleteConflict)
|
||||
} else {
|
||||
error
|
||||
} else {
|
||||
os::read_and_sync_multipart_target_metadata(
|
||||
&target_dir,
|
||||
std::ffi::OsStr::new(STORAGE_FORMAT_FILE),
|
||||
base,
|
||||
root,
|
||||
|target| {
|
||||
if target.len() as u64 != expected_length || raw_sha(target) != expected_sha256 {
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
}
|
||||
})?;
|
||||
let target = os::read_multipart_source_metadata_in_pinned(
|
||||
&pinned,
|
||||
&target_dir,
|
||||
std::ffi::OsStr::new(STORAGE_FORMAT_FILE),
|
||||
base,
|
||||
root,
|
||||
)
|
||||
.map_err(|error| {
|
||||
if error.kind() == std::io::ErrorKind::NotFound {
|
||||
IoError::other(DiskError::ConditionalDeleteConflict)
|
||||
} else {
|
||||
error
|
||||
}
|
||||
})?;
|
||||
if target.len() as u64 != expected_length || raw_sha(&target) != expected_sha256 {
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
Ok(())
|
||||
},
|
||||
)
|
||||
.map_err(|error| {
|
||||
if error.kind() == std::io::ErrorKind::NotFound {
|
||||
IoError::other(DiskError::ConditionalDeleteConflict)
|
||||
} else {
|
||||
error
|
||||
}
|
||||
} else {
|
||||
os::read_and_sync_multipart_target_metadata(
|
||||
&target_dir,
|
||||
std::ffi::OsStr::new(STORAGE_FORMAT_FILE),
|
||||
base,
|
||||
root,
|
||||
|target| {
|
||||
if target.len() as u64 != expected_length || raw_sha(target) != expected_sha256 {
|
||||
return Err(IoError::other(DiskError::ConditionalDeleteConflict));
|
||||
}
|
||||
Ok(())
|
||||
},
|
||||
)
|
||||
.map_err(|error| {
|
||||
if error.kind() == std::io::ErrorKind::NotFound {
|
||||
IoError::other(DiskError::ConditionalDeleteConflict)
|
||||
} else {
|
||||
error
|
||||
}
|
||||
})?;
|
||||
}
|
||||
})?;
|
||||
}
|
||||
SourceStore::persist_state_std(source, base, root, &next_state_raw, terminal.as_deref(), !fused_in_place)?;
|
||||
SourceStore::persist_state_std(source, base, root, &next_state_raw, terminal.as_deref(), true)?;
|
||||
if let Some((io_path, cleaned)) = staging_cleanup {
|
||||
match std::fs::remove_dir(&io_path) {
|
||||
Ok(()) => cleaned.store(true, std::sync::atomic::Ordering::Release),
|
||||
@@ -2387,7 +2381,7 @@ impl NativeMultipartPublication {
|
||||
) -> Result<MultipartPublicationResult> {
|
||||
let this = Arc::clone(self);
|
||||
os::run_blocking_namespace_operation_with_sync(target_lease, true, move || {
|
||||
this.finish_on_thread(target_already_synced, false, staging_cleanup)
|
||||
this.finish_on_thread(target_already_synced, staging_cleanup)
|
||||
.map_err(IoError::other)
|
||||
})
|
||||
.await
|
||||
|
||||
@@ -2200,7 +2200,6 @@ pub(crate) const MAX_FSYNC_WORKERS_PER_DISK: usize = 8;
|
||||
// Return busy workers to the shared pool so other disks can acquire a slot.
|
||||
const MAX_BLOCKING_JOBS_PER_WORKER: usize = 64;
|
||||
const WORKER_IDLE_SPIN_ITERS: usize = 256;
|
||||
const FSYNC_WORKER_IDLE_SPIN_ITERS: usize = 1024;
|
||||
const FALLBACK_NAMESPACE_QUEUE_SHARDS: usize = 8;
|
||||
|
||||
#[derive(Clone, Copy, PartialEq, Eq)]
|
||||
@@ -2409,7 +2408,7 @@ impl DiskBlockingQueue {
|
||||
.ready
|
||||
.store(!state.jobs.is_empty(), std::sync::atomic::Ordering::Relaxed);
|
||||
if job.is_none() {
|
||||
if lane != DiskBlockingLane::Fsync && state.idle_workers > 0 {
|
||||
if state.idle_workers > 0 {
|
||||
state.active_workers = state.active_workers.saturating_sub(1);
|
||||
guard.state = DiskBlockingWorkerState::Retired;
|
||||
return;
|
||||
@@ -2427,12 +2426,7 @@ impl DiskBlockingQueue {
|
||||
}
|
||||
idle_polled = false;
|
||||
} else {
|
||||
let spin_iters = if lane == DiskBlockingLane::Fsync {
|
||||
FSYNC_WORKER_IDLE_SPIN_ITERS
|
||||
} else {
|
||||
WORKER_IDLE_SPIN_ITERS
|
||||
};
|
||||
for _ in 0..spin_iters {
|
||||
for _ in 0..WORKER_IDLE_SPIN_ITERS {
|
||||
if queue.lane(lane).ready.load(std::sync::atomic::Ordering::Relaxed) {
|
||||
break;
|
||||
}
|
||||
@@ -7449,7 +7443,6 @@ pub(crate) fn install_multipart_prepared_head(
|
||||
canonical_head: &Path,
|
||||
base: &Path,
|
||||
publication_root: &PublicationRoot,
|
||||
directory_guard: Option<&RenameCommitGuard>,
|
||||
) -> io::Result<PreparedRenameSource> {
|
||||
let original_path = prepared.path.clone();
|
||||
let parent = canonical_head
|
||||
@@ -7458,37 +7451,9 @@ pub(crate) fn install_multipart_prepared_head(
|
||||
if original_path.parent() != Some(parent) || original_path == canonical_head {
|
||||
return Err(io::Error::new(io::ErrorKind::InvalidInput, "MPU proxy must be a private sibling"));
|
||||
}
|
||||
#[cfg(target_os = "linux")]
|
||||
let guard = if let Some(directory_guard) = directory_guard.filter(|g| g.directories.source_path == parent) {
|
||||
let dir = &directory_guard.directories.source;
|
||||
RenameCommitGuard {
|
||||
directories: Arc::new(LinuxCommitDirectories {
|
||||
root: directory_guard.directories.root.clone(),
|
||||
source_path: parent.to_path_buf(),
|
||||
destination_path: parent.to_path_buf(),
|
||||
source: LinuxCommitDirectory {
|
||||
file: Arc::clone(&dir.file),
|
||||
device: dir.device,
|
||||
inode: dir.inode,
|
||||
},
|
||||
destination: std::sync::OnceLock::from(LinuxCommitDirectory {
|
||||
file: Arc::clone(&dir.file),
|
||||
device: dir.device,
|
||||
inode: dir.inode,
|
||||
}),
|
||||
destination_base: base.to_path_buf(),
|
||||
}),
|
||||
}
|
||||
} else {
|
||||
prepare_rename_commit_guard(parent, parent, base, publication_root)?
|
||||
};
|
||||
#[cfg(not(target_os = "linux"))]
|
||||
let _pinned = pin_multipart_source_directory(parent, base, publication_root)?;
|
||||
#[cfg(not(target_os = "linux"))]
|
||||
let guard = {
|
||||
let _ = directory_guard;
|
||||
prepare_rename_commit_guard(parent, parent, base, publication_root)?
|
||||
};
|
||||
let guard = prepare_rename_commit_guard(parent, parent, base, publication_root)?;
|
||||
rename_prepared_source_std(&prepared, &original_path, canonical_head, base, publication_root, &guard)?;
|
||||
prepared.path = canonical_head.to_path_buf();
|
||||
fsync_commit_directory_limited_std(parent, &guard)?;
|
||||
|
||||
@@ -58,7 +58,7 @@ use std::sync::{
|
||||
Arc, OnceLock,
|
||||
atomic::{AtomicBool, AtomicU8, AtomicU64, Ordering},
|
||||
};
|
||||
use tokio::sync::{Mutex, Notify, OnceCell, OwnedRwLockReadGuard, OwnedSemaphorePermit, RwLock, Semaphore};
|
||||
use tokio::sync::{Mutex, Notify, OnceCell, OwnedRwLockReadGuard, RwLock};
|
||||
use tokio::time::Instant;
|
||||
use tokio_util::sync::CancellationToken;
|
||||
use tokio_util::task::TaskTracker;
|
||||
@@ -187,38 +187,6 @@ impl DecommissionCountLedger {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
struct ListReadBudget {
|
||||
permits: Arc<Semaphore>,
|
||||
capacity: usize,
|
||||
}
|
||||
|
||||
impl ListReadBudget {
|
||||
fn new(capacity: usize) -> Self {
|
||||
let capacity = capacity
|
||||
.min(Semaphore::MAX_PERMITS)
|
||||
.min(usize::try_from(u32::MAX).unwrap_or(usize::MAX));
|
||||
Self {
|
||||
permits: Arc::new(Semaphore::new(capacity)),
|
||||
capacity,
|
||||
}
|
||||
}
|
||||
|
||||
async fn acquire(&self, fanout: usize) -> Result<Option<Arc<OwnedSemaphorePermit>>, tokio::sync::AcquireError> {
|
||||
if self.capacity == 0 {
|
||||
return Ok(None);
|
||||
}
|
||||
// A single walk must remain admissible even when the topology exceeds
|
||||
// the configured budget. Tokio accepts at most u32::MAX in one grant.
|
||||
let weight = u32::try_from(fanout.max(1).min(self.capacity)).unwrap_or(u32::MAX);
|
||||
self.permits
|
||||
.clone()
|
||||
.acquire_many_owned(weight)
|
||||
.await
|
||||
.map(|permit| Some(Arc::new(permit)))
|
||||
}
|
||||
}
|
||||
|
||||
/// Runtime state owned by a single `ECStore` instance.
|
||||
///
|
||||
/// This is intentionally minimal in the first migration slice; subsequent
|
||||
@@ -233,7 +201,6 @@ pub struct InstanceContext {
|
||||
/// drift out of sync). Stored as one value so the three predicates can
|
||||
/// never observe a torn intermediate state.
|
||||
erasure_kind: RwLock<SetupType>,
|
||||
list_read_budget: OnceLock<ListReadBudget>,
|
||||
/// This instance's namespace lock manager (Phase 5 Slice 3, backlog#939).
|
||||
///
|
||||
/// Owned per-instance so two instances no longer share a lock namespace
|
||||
@@ -387,24 +354,6 @@ impl InstanceContext {
|
||||
Self::with_lock_manager(Arc::new(GlobalLockManager::new()))
|
||||
}
|
||||
|
||||
/// Bound native listing fanout independently of GET body permits. A walk
|
||||
/// keeps its shared grant until all of its disk producers have terminated.
|
||||
/// Acquire before creating the merge channels or taking object locks.
|
||||
pub(crate) async fn acquire_list_read_budget(
|
||||
&self,
|
||||
fanout: usize,
|
||||
) -> Result<Option<Arc<OwnedSemaphorePermit>>, tokio::sync::AcquireError> {
|
||||
self.list_read_budget
|
||||
.get_or_init(|| {
|
||||
ListReadBudget::new(rustfs_utils::get_env_usize(
|
||||
rustfs_config::ENV_OBJECT_MAX_CONCURRENT_DISK_READS,
|
||||
rustfs_config::DEFAULT_OBJECT_MAX_CONCURRENT_DISK_READS,
|
||||
))
|
||||
})
|
||||
.acquire(fanout)
|
||||
.await
|
||||
}
|
||||
|
||||
/// Build a context bound to a specific lock manager.
|
||||
///
|
||||
/// [`bootstrap_ctx`] uses this to alias the process-global lock manager so
|
||||
@@ -413,7 +362,6 @@ impl InstanceContext {
|
||||
fn with_lock_manager(lock_manager: Arc<GlobalLockManager>) -> Self {
|
||||
Self {
|
||||
erasure_kind: RwLock::new(SetupType::Unknown),
|
||||
list_read_budget: OnceLock::new(),
|
||||
lock_manager,
|
||||
region: OnceLock::new(),
|
||||
deployment_id: OnceLock::new(),
|
||||
@@ -1163,85 +1111,6 @@ pub fn bootstrap_ctx() -> Arc<InstanceContext> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_weights_and_clamps_fanout() {
|
||||
let budget = ListReadBudget::new(8);
|
||||
let first = budget.acquire(3).await.expect("first walk").expect("bounded grant");
|
||||
assert_eq!(budget.permits.available_permits(), 5);
|
||||
let mut blocked = std::pin::pin!(budget.acquire(6));
|
||||
assert!(futures::poll!(&mut blocked).is_pending());
|
||||
drop(first);
|
||||
let second = blocked.await.expect("queued walk").expect("bounded grant");
|
||||
assert_eq!(budget.permits.available_permits(), 2);
|
||||
drop(second);
|
||||
let oversized = budget
|
||||
.acquire(usize::MAX)
|
||||
.await
|
||||
.expect("oversized walk")
|
||||
.expect("bounded grant");
|
||||
assert_eq!(budget.permits.available_permits(), 0);
|
||||
drop(oversized);
|
||||
assert_eq!(budget.permits.available_permits(), 8);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_zero_preserves_unbounded_configuration() {
|
||||
let budget = ListReadBudget::new(0);
|
||||
assert!(budget.acquire(usize::MAX).await.expect("disabled budget").is_none());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_cancelled_waiter_returns_partial_grant() {
|
||||
let budget = ListReadBudget::new(4);
|
||||
let held = budget.acquire(3).await.expect("first walk");
|
||||
{
|
||||
let mut waiter = std::pin::pin!(budget.acquire(4));
|
||||
assert!(futures::poll!(&mut waiter).is_pending());
|
||||
}
|
||||
assert_eq!(budget.permits.available_permits(), 1);
|
||||
drop(held);
|
||||
assert!(budget.acquire(4).await.expect("next walk").is_some());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_shared_grant_survives_parent_drop() {
|
||||
let budget = ListReadBudget::new(4);
|
||||
let parent = budget.acquire(4).await.expect("first walk").expect("bounded grant");
|
||||
let producer = parent.clone();
|
||||
drop(parent);
|
||||
assert_eq!(budget.permits.available_permits(), 0);
|
||||
drop(producer);
|
||||
assert_eq!(budget.permits.available_permits(), 4);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_is_shared_by_context_and_isolated_between_instances() {
|
||||
let first = Arc::new(InstanceContext::new());
|
||||
first.list_read_budget.set(ListReadBudget::new(4)).expect("fresh context");
|
||||
let same = first.clone();
|
||||
let other = InstanceContext::new();
|
||||
other.list_read_budget.set(ListReadBudget::new(4)).expect("fresh context");
|
||||
let held = first.acquire_list_read_budget(4).await.expect("first context");
|
||||
let mut waiter = std::pin::pin!(same.acquire_list_read_budget(1));
|
||||
assert!(futures::poll!(&mut waiter).is_pending());
|
||||
assert!(
|
||||
other
|
||||
.acquire_list_read_budget(4)
|
||||
.await
|
||||
.expect("independent context")
|
||||
.is_some()
|
||||
);
|
||||
drop(held);
|
||||
assert!(waiter.await.expect("shared context resumed").is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn list_read_budget_extreme_configuration_is_bounded_without_panicking() {
|
||||
let budget = ListReadBudget::new(usize::MAX);
|
||||
assert!(budget.capacity <= Semaphore::MAX_PERMITS);
|
||||
assert!(u32::try_from(budget.capacity).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn decommission_count_ledger_bounds_retained_entries() {
|
||||
let mut ledger = super::DecommissionCountLedger::default();
|
||||
|
||||
@@ -2979,11 +2979,10 @@ fn build_legacy_per_part_fallback_reader(
|
||||
part_length: usize,
|
||||
part_size: usize,
|
||||
read_repair: Option<(DecodeReadRepairContext, bool)>,
|
||||
) -> Box<LegacyPerPartDecodeReader> {
|
||||
) -> Box<dyn AsyncRead + Unpin + Send + Sync> {
|
||||
let buffer = adaptive_duplex_buffer_size(part_size as i64);
|
||||
let (read_half, write_half) = tokio::io::duplex(buffer);
|
||||
let (read_half, mut write_half) = tokio::io::duplex(buffer);
|
||||
let decode = tokio::spawn(async move {
|
||||
let mut write_half = GetObjectDownstreamWriter::new(write_half);
|
||||
let outcome = erasure
|
||||
.decode_with_stripe_handles_and_reopeners_with_diagnostics(
|
||||
&mut write_half,
|
||||
@@ -8909,42 +8908,6 @@ mod tests {
|
||||
assert!(err.to_string().contains("inconsistent read source shards"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn legacy_per_part_output_close_retains_downstream_classification() {
|
||||
let erasure = coding::Erasure::new(2, 2, 64);
|
||||
let data = (0..64u8).collect::<Vec<_>>();
|
||||
let setup =
|
||||
setup_codec_data_blocks_first_encoded_bitrot_readers(&erasure, &data, &[0], &[], &[], HashAlgorithm::HighwayHash256)
|
||||
.await;
|
||||
let mut reader = build_legacy_per_part_fallback_reader(
|
||||
erasure,
|
||||
setup.readers,
|
||||
setup.deferred_stripe_handles,
|
||||
Vec::new(),
|
||||
None,
|
||||
0,
|
||||
data.len(),
|
||||
data.len(),
|
||||
None,
|
||||
);
|
||||
// Closing the actual output pipe models the body consumer disappearing
|
||||
// while retaining the executor long enough to inspect its typed result.
|
||||
assert!(!reader.finished);
|
||||
let (replacement, _unused) = tokio::io::duplex(1);
|
||||
drop(std::mem::replace(&mut reader.inner, replacement));
|
||||
let handle = reader.decode.take().expect("fallback decode task");
|
||||
let error = handle
|
||||
.await
|
||||
.expect("join the fallback task")
|
||||
.expect("closed pipe must interrupt output");
|
||||
assert_eq!(error.kind(), std::io::ErrorKind::BrokenPipe);
|
||||
assert_eq!(
|
||||
crate::diagnostics::get::classify_io_error(&error),
|
||||
GetObjectFailureReason::DownstreamClosed,
|
||||
"fallback output must carry the same marker as the normal GET path"
|
||||
);
|
||||
}
|
||||
|
||||
// backlog#879: a later multipart part that loses a shard (read quorum still
|
||||
// holds) must be reconstructed in place through the legacy per-part decode
|
||||
// bridge instead of failing the stream. This exercises the exact reader the
|
||||
|
||||
@@ -368,9 +368,6 @@ fn log_list_path_finished(
|
||||
#[derive(Debug, Default, Clone)]
|
||||
pub struct ListPathOptions {
|
||||
pub caller: ListObjectsGatherCaller,
|
||||
/// Internal native-walk admission, shared with every disk producer so
|
||||
/// aborting an HTTP request cannot release its budget ahead of cleanup.
|
||||
pub read_budget: Option<Arc<tokio::sync::OwnedSemaphorePermit>>,
|
||||
pub id: Option<String>,
|
||||
|
||||
// Bucket of the listing.
|
||||
@@ -1481,11 +1478,6 @@ impl ECStore {
|
||||
if o.transient {
|
||||
o.create = false;
|
||||
}
|
||||
let fanout = self.pools.iter().fold(0usize, |total, pool| {
|
||||
total.saturating_add(pool.disk_set.len().saturating_mul(pool.set_drive_count))
|
||||
});
|
||||
o.read_budget = self.ctx.acquire_list_read_budget(fanout).await.map_err(Error::other)?;
|
||||
|
||||
let log_context = ListPathLogContext::from_options(&o);
|
||||
|
||||
// cancel channel
|
||||
@@ -2886,12 +2878,6 @@ impl SetDisks {
|
||||
if o.transient {
|
||||
o.create = false;
|
||||
}
|
||||
o.read_budget = self
|
||||
.instance_ctx()
|
||||
.acquire_list_read_budget(self.set_drive_count)
|
||||
.await
|
||||
.map_err(Error::other)?;
|
||||
|
||||
let log_context = ListPathLogContext::from_options(&o);
|
||||
|
||||
let cancel = CancellationToken::new();
|
||||
@@ -2963,7 +2949,6 @@ impl SetDisks {
|
||||
let result = list_path_raw_with_claim_tracker(
|
||||
rx,
|
||||
ListPathRawOptions {
|
||||
read_budget: opts.read_budget.clone(),
|
||||
disks: disks.into_iter().map(Some).collect(),
|
||||
bucket: opts.bucket,
|
||||
path: opts.base_dir,
|
||||
@@ -3122,7 +3107,6 @@ impl SetDisks {
|
||||
let result = list_path_raw_with_outcome(
|
||||
rx,
|
||||
ListPathRawOptions {
|
||||
read_budget: opts.read_budget.clone(),
|
||||
disks: disks.into_iter().map(Some).collect(),
|
||||
fallback_disks: fallback_disks.into_iter().map(Some).collect(),
|
||||
bucket: opts.bucket,
|
||||
@@ -6804,58 +6788,6 @@ mod test {
|
||||
(dirs, store)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn list_read_budget_bounds_store_and_set_entrypoints_and_recovers_after_errors() {
|
||||
let (_dirs, store) = single_set_store(4).await;
|
||||
let held = store
|
||||
.ctx
|
||||
.acquire_list_read_budget(usize::MAX)
|
||||
.await
|
||||
.expect("occupy native budget");
|
||||
let semaphore = held.as_ref().expect("bounded instance budget").semaphore();
|
||||
let owners = Arc::strong_count(semaphore);
|
||||
let opts = ListPathOptions {
|
||||
bucket: "list-budget-absent-bucket".into(),
|
||||
limit: 1,
|
||||
authoritative: true,
|
||||
..Default::default()
|
||||
};
|
||||
let set = store.pools[0].disk_set[0].clone();
|
||||
set.disks.write().await.fill(None);
|
||||
{
|
||||
let mut store_walk = std::pin::pin!(store.clone().list_path(&opts));
|
||||
let mut set_walk = std::pin::pin!(set.clone().list_path_result(&opts));
|
||||
assert!(futures::poll!(&mut store_walk).is_pending(), "store walk must await its budget");
|
||||
assert_eq!(Arc::strong_count(semaphore), owners + 1, "store must queue on the shared budget");
|
||||
assert!(futures::poll!(&mut set_walk).is_pending(), "set walk shares the same instance budget");
|
||||
assert_eq!(Arc::strong_count(semaphore), owners + 2, "set must queue on the same budget");
|
||||
let empty = store
|
||||
.clone()
|
||||
.list_path(&ListPathOptions {
|
||||
limit: 0,
|
||||
..opts.clone()
|
||||
})
|
||||
.await
|
||||
.expect("empty page needs no disk admission");
|
||||
assert!(empty.exhausted);
|
||||
}
|
||||
assert_eq!(Arc::strong_count(semaphore), owners, "cancelled entry points release the queue ownership");
|
||||
drop(held);
|
||||
let result = timeout(Duration::from_secs(5), store.clone().list_path(&opts))
|
||||
.await
|
||||
.expect("failed walk terminates");
|
||||
assert_eq!(
|
||||
result.err(),
|
||||
Some(DiskError::ErasureReadQuorum.into()),
|
||||
"offline drives retain their quorum error"
|
||||
);
|
||||
let next = timeout(Duration::from_secs(5), store.ctx.acquire_list_read_budget(usize::MAX))
|
||||
.await
|
||||
.expect("failed and cancelled walks release their grants")
|
||||
.expect("budget remains open");
|
||||
assert!(next.is_some());
|
||||
}
|
||||
|
||||
fn versioned_object_metadata(bucket: &str, name: &str, versions: &[(u128, i64)], slot: usize) -> Bytes {
|
||||
let mut meta = FileMeta::new();
|
||||
for (id, modified) in versions {
|
||||
|
||||
@@ -58,7 +58,7 @@ pub enum Error {
|
||||
TaskExecutionFailed { message: String },
|
||||
|
||||
/// Only the qualified MRF Deep check may produce this terminal result.
|
||||
#[error("Independent verification unavailable for legacy object {target}; durable MRF responsibility retained")]
|
||||
#[error("Heal task execution failed: Missing exact storage proof for durable MRF repair {target}")]
|
||||
LegacyMrfUnverified { target: String },
|
||||
|
||||
#[error("Replacement failure could not be persisted: {failure}; persistence error: {persistence}")]
|
||||
|
||||
@@ -292,20 +292,6 @@ impl HealManager {
|
||||
"Heal scheduler task completed"
|
||||
);
|
||||
}
|
||||
Err(e @ Error::LegacyMrfUnverified { .. }) => {
|
||||
warn!(
|
||||
target: "rustfs::heal::manager",
|
||||
event = EVENT_HEAL_SCHEDULER_STATE,
|
||||
component = LOG_COMPONENT_HEAL,
|
||||
subsystem = LOG_SUBSYSTEM_MANAGER,
|
||||
state = "verification_unavailable",
|
||||
task_id,
|
||||
heal_type = %task_type_label_for_spawn,
|
||||
set = %task_set_label_for_spawn,
|
||||
detail = %e,
|
||||
"Heal attempt completed without independent verification"
|
||||
);
|
||||
}
|
||||
Err(e) => {
|
||||
let will_retry = retry_request.is_some();
|
||||
if will_retry {
|
||||
@@ -497,9 +483,6 @@ impl HealManager {
|
||||
// update statistics
|
||||
let mut stats = statistics_clone.write().await;
|
||||
match completed_status {
|
||||
HealTaskStatus::Completed if matches!(&result, Err(Error::LegacyMrfUnverified { .. })) => {
|
||||
stats.update_unverified_task_completion();
|
||||
}
|
||||
HealTaskStatus::Completed => {
|
||||
stats.update_task_completion(true);
|
||||
stats.add_healed_objects(completed_progress.objects_healed, completed_progress.bytes_processed);
|
||||
|
||||
@@ -1106,22 +1106,6 @@ impl HealStorageAPI for MockStorage {
|
||||
if bucket.starts_with("legacy-ambiguity-scheduler-") {
|
||||
return Err(Error::Storage(EcstoreError::DeleteRecoveryLegacyAmbiguous));
|
||||
}
|
||||
if bucket == "legacy-held-pending-scheduler" {
|
||||
let drives = vec![rustfs_madmin::heal_commands::HealDriveInfo {
|
||||
state: "ok".to_owned(),
|
||||
..Default::default()
|
||||
}];
|
||||
return Ok((
|
||||
HealResultItem {
|
||||
legacy_identity_unverified: true,
|
||||
detail: rustfs_heal_contracts::heal_channel::LEGACY_OBJECT_IDENTITY_UNVERIFIED_DETAIL.to_owned(),
|
||||
before: rustfs_madmin::heal_commands::Infos { drives: drives.clone() },
|
||||
after: rustfs_madmin::heal_commands::Infos { drives },
|
||||
..Default::default()
|
||||
},
|
||||
None,
|
||||
));
|
||||
}
|
||||
if bucket == "completed-retention-failed" {
|
||||
return Err(Error::TaskExecutionFailed {
|
||||
message: "retention fixture failure".to_string(),
|
||||
@@ -2169,53 +2153,6 @@ fn only_typed_mrf_result_can_pause_unverified_legacy() {
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(flavor = "current_thread")]
|
||||
async fn mrf_legacy_completed_attempt_retains_responsibility_without_failed_statistics() {
|
||||
use crate::heal::failure_logging::test_support::FailureLogCapture;
|
||||
|
||||
let capture = FailureLogCapture::default();
|
||||
let _subscriber = tracing::subscriber::set_default(capture.clone());
|
||||
let (target, _) = unverified_legacy_fixture("legacy-held-pending-scheduler");
|
||||
let bucket = target.bucket.clone();
|
||||
let anchor = target.durable_anchor.clone().expect("durable MRF anchor");
|
||||
let manager = HealManager::new_without_root_recovery_for_test(Arc::new(MockStorage), None);
|
||||
let mut request = HealRequest::object(bucket.to_string(), target.object.to_string(), None);
|
||||
request.source = HealRequestSource::Mrf;
|
||||
request.expected_mrf_bucket_incarnation_id = Some(anchor.bucket_incarnation_id);
|
||||
request.options.pool_index = Some(1);
|
||||
request.options.set_index = Some(2);
|
||||
let receipt = manager
|
||||
.submit_mrf_heal_request_with_receipt_and_identity(request, target)
|
||||
.await
|
||||
.expect("admit durable MRF check");
|
||||
assert_eq!(receipt.result, HealAdmissionResult::Accepted);
|
||||
process_manager_queue_once(&manager).await;
|
||||
tokio::time::timeout(Duration::from_secs(2), async {
|
||||
while manager.get_statistics().await.unverified_tasks == 0 {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("publish completed unverified attempt");
|
||||
let stats = manager.get_statistics().await;
|
||||
assert_eq!(stats.unverified_tasks, 1);
|
||||
assert_eq!(stats.failed_tasks, 0);
|
||||
assert_eq!(stats.successful_tasks, 0);
|
||||
assert_eq!(stats.total_objects_healed, 0);
|
||||
let report = manager.get_task_report(&receipt.task_id).await.expect("retained task report");
|
||||
assert_eq!(report.status, HealTaskStatus::Completed);
|
||||
let outcome = report.outcome.expect("retained unknown outcome");
|
||||
assert_eq!(outcome.counters.unknown, 1);
|
||||
assert_eq!(outcome.counters.failed, 0);
|
||||
assert!(rustfs_common::mrf_channel::take_mrf_verified_repair_events_for(&bucket).is_empty());
|
||||
let held = rustfs_common::mrf_channel::take_mrf_unverified_legacy_events_for(&bucket);
|
||||
assert_eq!(held.len(), 1);
|
||||
assert_eq!(held[0].anchor, anchor);
|
||||
assert!(manager.retrying_heals.lock().await.is_empty());
|
||||
assert_eq!(capture.count(tracing::Level::ERROR, Some("rustfs::heal::manager")), 0);
|
||||
assert_eq!(capture.count(tracing::Level::WARN, Some("rustfs::heal::manager")), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn completed_mrf_notice_publishes_only_verified_positive_events() {
|
||||
use crate::heal::outcome::{HealObjectIdentity, HealObjectKind, HealObjectOutcome, HealTaskOutcome};
|
||||
|
||||
@@ -506,9 +506,6 @@ pub struct HealStatistics {
|
||||
pub successful_tasks: u64,
|
||||
/// Failed tasks
|
||||
pub failed_tasks: u64,
|
||||
/// Completed attempts without independent verification; not the current durable MRF backlog.
|
||||
#[serde(default)]
|
||||
pub unverified_tasks: u64,
|
||||
/// Running tasks
|
||||
pub running_tasks: u64,
|
||||
/// Total healed objects
|
||||
@@ -531,7 +528,6 @@ impl HealStatistics {
|
||||
total_tasks: 0,
|
||||
successful_tasks: 0,
|
||||
failed_tasks: 0,
|
||||
unverified_tasks: 0,
|
||||
running_tasks: 0,
|
||||
total_objects_healed: 0,
|
||||
total_bytes_healed: 0,
|
||||
@@ -553,11 +549,6 @@ impl HealStatistics {
|
||||
self.last_update_time = SystemTime::now();
|
||||
}
|
||||
|
||||
pub(crate) fn update_unverified_task_completion(&mut self) {
|
||||
self.unverified_tasks = self.unverified_tasks.saturating_add(1);
|
||||
self.last_update_time = SystemTime::now();
|
||||
}
|
||||
|
||||
pub fn add_healed_objects(&mut self, count: u64, bytes: u64) {
|
||||
self.total_objects_healed += count;
|
||||
self.total_bytes_healed += bytes;
|
||||
@@ -924,21 +915,6 @@ mod tests {
|
||||
assert_eq!(stats.failed_tasks, 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unverified_statistics_preserve_old_snapshot_compatibility() {
|
||||
let mut stats = HealStatistics::new();
|
||||
stats.update_unverified_task_completion();
|
||||
assert_eq!(stats.unverified_tasks, 1);
|
||||
assert_eq!(stats.successful_tasks, 0);
|
||||
assert_eq!(stats.failed_tasks, 0);
|
||||
let mut wire = serde_json::to_value(&stats).expect("serialize task statistics");
|
||||
let current: HealStatistics = serde_json::from_value(wire.clone()).expect("read new statistics");
|
||||
assert_eq!(current.unverified_tasks, 1);
|
||||
wire.as_object_mut().expect("statistics object").remove("unverified_tasks");
|
||||
let old: HealStatistics = serde_json::from_value(wire).expect("read statistics without new field");
|
||||
assert_eq!(old.unverified_tasks, 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_heal_statistics_update_task_completion_success() {
|
||||
let mut stats = HealStatistics::new();
|
||||
|
||||
@@ -291,7 +291,7 @@ pub enum HealTaskStatus {
|
||||
Running,
|
||||
/// Retrying after a recoverable failure
|
||||
Retrying { error: String, retry_attempt: u32 },
|
||||
/// Execution completed; the outcome and durable MRF ledger retain any unverified responsibility.
|
||||
/// Completed
|
||||
Completed,
|
||||
/// Failed
|
||||
Failed { error: String },
|
||||
@@ -1232,22 +1232,6 @@ impl HealTask {
|
||||
"Heal task completed"
|
||||
});
|
||||
}
|
||||
Err(Error::LegacyMrfUnverified { .. }) => {
|
||||
// The qualified Deep attempt finished, but its Unknown outcome
|
||||
// cannot discharge the separately owned durable responsibility.
|
||||
self.progress.write().await.mark_completed();
|
||||
*self.status.write().await = HealTaskStatus::Completed;
|
||||
debug!(
|
||||
target: "rustfs::heal::task",
|
||||
event = EVENT_HEAL_TASK_STATE,
|
||||
component = LOG_COMPONENT_HEAL,
|
||||
subsystem = LOG_SUBSYSTEM_TASK,
|
||||
state = "verification_unavailable",
|
||||
task_id = %self.id,
|
||||
heal_type = self.heal_type.kind_label(),
|
||||
"Heal attempt completed without independent verification"
|
||||
);
|
||||
}
|
||||
Err(Error::TaskCancelled) => {
|
||||
let mut status = self.status.write().await;
|
||||
*status = HealTaskStatus::Cancelled;
|
||||
@@ -1297,16 +1281,11 @@ impl HealTask {
|
||||
|
||||
let terminal_state = match &result {
|
||||
Ok(_) => "completed",
|
||||
Err(Error::LegacyMrfUnverified { .. }) => "verification_unavailable",
|
||||
Err(Error::TaskCancelled) => "cancelled",
|
||||
Err(Error::TaskTimeout) => "timed_out",
|
||||
Err(_) => "failed",
|
||||
};
|
||||
let terminal_error = result
|
||||
.as_ref()
|
||||
.err()
|
||||
.filter(|error| !matches!(error, Error::LegacyMrfUnverified { .. }));
|
||||
self.emit_trace_task_state(terminal_state, start_instant.elapsed(), terminal_error);
|
||||
self.emit_trace_task_state(terminal_state, start_instant.elapsed(), result.as_ref().err());
|
||||
|
||||
result
|
||||
}
|
||||
|
||||
@@ -3285,29 +3285,6 @@ async fn durable_mrf_unverified_object_names_cannot_change_retry_classification(
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn mrf_legacy_verification_pending_is_a_completed_unverified_attempt() {
|
||||
let (task, _) = mrf_task_for_item("legacy-pending", healthy_legacy_heal_item());
|
||||
let error = task.execute().await.expect_err("unverified result must retain MRF ownership");
|
||||
assert!(matches!(error, Error::LegacyMrfUnverified { .. }));
|
||||
assert!(!error.is_recoverable_heal());
|
||||
assert_eq!(task.get_status().await, HealTaskStatus::Completed);
|
||||
let outcome = task.get_outcome().await;
|
||||
assert_eq!(outcome.execution, HealExecutionOutcome::Completed);
|
||||
assert_eq!(outcome.counters.unknown, 1);
|
||||
assert_eq!(outcome.counters.failed, 0);
|
||||
assert_eq!(outcome.counters.healed, 0);
|
||||
assert_eq!(outcome.counters.unchanged, 0);
|
||||
assert!(matches!(outcome.objects[0].disposition, HealObjectDisposition::Unknown));
|
||||
let (status, detail) = outcome.legacy_status("finished", None);
|
||||
assert_eq!(status, "finished");
|
||||
assert!(
|
||||
detail
|
||||
.expect("visible unverified result")
|
||||
.contains("authoritative storage proof is unavailable")
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn mrf_legacy_object_names_cannot_change_retry_classification() {
|
||||
for object in [
|
||||
@@ -3327,9 +3304,7 @@ async fn mrf_legacy_object_names_cannot_change_retry_classification() {
|
||||
assert!(matches!(error, Error::LegacyMrfUnverified { .. }));
|
||||
assert_eq!(
|
||||
error.to_string(),
|
||||
format!(
|
||||
"Independent verification unavailable for legacy object bucket-a/{object}; durable MRF responsibility retained"
|
||||
)
|
||||
format!("Heal task execution failed: Missing exact storage proof for durable MRF repair bucket-a/{object}")
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -3387,14 +3362,11 @@ async fn mrf_legacy_pause_requires_storage_owned_healthy_deep_result() {
|
||||
let outcome = task.get_outcome().await;
|
||||
assert_eq!(outcome.counters.healed, 0);
|
||||
if case == "qualified" {
|
||||
assert_eq!(task.get_status().await, HealTaskStatus::Completed);
|
||||
assert_eq!(outcome.counters.unknown, 1);
|
||||
assert_eq!(outcome.objects[0].detail.as_deref(), Some("updated diagnostic wording"));
|
||||
let opts = storage.object_heal_opts.lock().expect("storage options");
|
||||
assert_eq!(opts.len(), 1);
|
||||
assert_eq!(opts[0].scan_mode, HealScanMode::Deep);
|
||||
} else {
|
||||
assert!(matches!(task.get_status().await, HealTaskStatus::Failed { .. }), "case={case}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -30,78 +30,6 @@ use storage_api::integration::{
|
||||
WriteCommitGuard, WriteCompletion,
|
||||
};
|
||||
|
||||
async fn complete_fixture_replicas(env: &TestECStoreEnv, bucket: &str, object: &str) {
|
||||
// TailDrained completes fan-out, but a successful quorum write may still
|
||||
// have minority failures. Fault injection needs a fully repaired baseline.
|
||||
let result = ECStoreHealStorage::new(env.ecstore.clone())
|
||||
.heal_object_with_receipt(
|
||||
bucket,
|
||||
object,
|
||||
None,
|
||||
&HealOpts {
|
||||
scan_mode: HealScanMode::Deep,
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.await
|
||||
.expect("complete protected fixture replicas before fault injection");
|
||||
assert!(result.error.is_none(), "fixture repair failed: {:?}", result.error);
|
||||
assert_eq!(result.item.after.drives.len(), env.disk_paths.len());
|
||||
assert!(
|
||||
result.item.after.drives.iter().all(|drive| drive.state == "ok"),
|
||||
"fixture requires every replica, not only read/write quorum: {:?}",
|
||||
result.item.after.drives
|
||||
);
|
||||
assert!(result.item.integrity_verified, "fixture must retain protected payload verification");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn mixed_batch_fixture_repairs_a_missing_minority_replica() {
|
||||
let root = tempfile::tempdir().expect("minority replica fixture");
|
||||
let env = TestECStoreEnv::builder().base_dir(root.path()).build().await;
|
||||
let bucket = "mixed-fixture-baseline";
|
||||
let object = "object";
|
||||
env.make_bucket(bucket, false).await;
|
||||
let expected = vec![0x5a; 1024 * 1024 + 123];
|
||||
env.ecstore
|
||||
.put_object(
|
||||
bucket,
|
||||
object,
|
||||
&mut PutObjReader::from_vec(expected.clone()),
|
||||
&ObjectOptions {
|
||||
shard_integrity_write_mode: Some(ShardIntegrityWriteMode::Protected),
|
||||
write_completion: WriteCompletion::TailDrained,
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.await
|
||||
.expect("quorum commit fixture");
|
||||
// Guarantee a minority failure regardless of whether the original write
|
||||
// succeeded on every disk, then repair it before any test fault is applied.
|
||||
let replica = env.disk_paths[0].join(bucket).join(object);
|
||||
if replica.exists() {
|
||||
tokio::fs::remove_dir_all(&replica)
|
||||
.await
|
||||
.expect("remove one complete replica");
|
||||
}
|
||||
complete_fixture_replicas(&env, bucket, object).await;
|
||||
let disks = env.ecstore.pools[0].get_disks(0);
|
||||
for disk in disks.disks.read().await.iter().flatten() {
|
||||
disk.read_version("", bucket, object, "", &ReadOptions::default())
|
||||
.await
|
||||
.expect("every fixture replica has metadata after completion");
|
||||
}
|
||||
let mut reader = env
|
||||
.ecstore
|
||||
.get_object_reader(bucket, object, None, Default::default(), &ObjectOptions::default())
|
||||
.await
|
||||
.expect("read the completed fixture");
|
||||
let mut actual = Vec::new();
|
||||
reader.stream.read_to_end(&mut actual).await.expect("completed fixture body");
|
||||
assert_eq!(actual, expected);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn disabled_lock_reports_only_quorum_selection_and_deep_check_observations() {
|
||||
const CHILD_ENV: &str = "RUSTFS_TEST_DISABLED_LOCK_HEAL_CHILD";
|
||||
@@ -776,7 +704,6 @@ fn admin_mixed_batch_retains_repairs_after_object_retry_exhaustion() {
|
||||
)
|
||||
.await
|
||||
.expect("commit complete fixture");
|
||||
complete_fixture_replicas(&env, bucket, object).await;
|
||||
for (slot, disk) in disks.iter().enumerate() {
|
||||
let meta = disk
|
||||
.read_version("", bucket, object, "", &ReadOptions::default())
|
||||
|
||||
@@ -66,26 +66,11 @@ pub fn select_effective_memory(host_total: u64, host_available: u64, cgroup: Opt
|
||||
|
||||
/// Resolves the effective memory from an already-refreshed system handle.
|
||||
///
|
||||
/// On Linux, the current process cgroup and its ancestors are read on each call,
|
||||
/// including limits imposed by systemd services. System-wide cgroup limits are
|
||||
/// used if process information is unavailable. Other platforms use host values.
|
||||
/// `cgroup_limits()` is computed fresh on each call and is only implemented on
|
||||
/// Linux (it returns `None` elsewhere), so non-Linux hosts always use host
|
||||
/// values.
|
||||
pub fn effective_memory_from_system(system: &System) -> EffectiveMemory {
|
||||
#[cfg(target_os = "linux")]
|
||||
let limits = sysinfo::get_current_pid()
|
||||
.ok()
|
||||
.and_then(|pid| {
|
||||
let mut processes = System::new().ok()?;
|
||||
processes.refresh_processes_specifics(
|
||||
sysinfo::ProcessesToUpdate::Some(&[pid]),
|
||||
false,
|
||||
sysinfo::ProcessRefreshKind::nothing().with_memory(),
|
||||
);
|
||||
processes.process(pid)?.cgroup_limits()
|
||||
})
|
||||
.or_else(|| system.cgroup_limits());
|
||||
#[cfg(not(target_os = "linux"))]
|
||||
let limits = system.cgroup_limits();
|
||||
let cgroup = limits.map(|limits| (limits.total_memory, limits.free_memory));
|
||||
let cgroup = system.cgroup_limits().map(|limits| (limits.total_memory, limits.free_memory));
|
||||
select_effective_memory(system.total_memory(), system.available_memory(), cgroup)
|
||||
}
|
||||
|
||||
@@ -104,32 +89,6 @@ mod tests {
|
||||
|
||||
const GIB: u64 = 1024 * 1024 * 1024;
|
||||
|
||||
#[cfg(target_os = "linux")]
|
||||
#[test]
|
||||
fn effective_memory_uses_current_process_cgroup() {
|
||||
use sysinfo::{ProcessRefreshKind, ProcessesToUpdate, System, get_current_pid};
|
||||
|
||||
let pid = get_current_pid().expect("current process ID");
|
||||
let mut system = System::new().expect("system memory handle");
|
||||
system.refresh_memory();
|
||||
let mut process_system = System::new().expect("process memory handle");
|
||||
process_system.refresh_processes_specifics(
|
||||
ProcessesToUpdate::Some(&[pid]),
|
||||
false,
|
||||
ProcessRefreshKind::nothing().with_memory(),
|
||||
);
|
||||
let limits = process_system.process(pid).expect("current process entry").cgroup_limits();
|
||||
let expected = select_effective_memory(
|
||||
system.total_memory(),
|
||||
system.available_memory(),
|
||||
limits.map(|limits| (limits.total_memory, limits.free_memory)),
|
||||
);
|
||||
let actual = super::effective_memory_from_system(&system);
|
||||
assert_eq!(actual.basis, expected.basis);
|
||||
assert_eq!(actual.total_bytes, expected.total_bytes);
|
||||
assert!(actual.available_bytes <= actual.total_bytes);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn select_effective_memory_prefers_constraining_cgroup() {
|
||||
let effective = select_effective_memory(64 * GIB, 40 * GIB, Some((2 * GIB, GIB)));
|
||||
|
||||
@@ -642,7 +642,6 @@ impl AdminAction {
|
||||
self,
|
||||
AdminAction::GetTableBucketAction
|
||||
| AdminAction::SetTableBucketAction
|
||||
| AdminAction::MigrateTableCatalogAction
|
||||
| AdminAction::GetTableNamespaceAction
|
||||
| AdminAction::SetTableNamespaceAction
|
||||
| AdminAction::UpdateTableNamespacePropertiesAction
|
||||
|
||||
@@ -1795,146 +1795,6 @@ mod test {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn assert_catalog_migration_policy_matrix(data: &[u8], cases: &[(&str, AdminAction, bool)]) -> Result<()> {
|
||||
let policy = Policy::parse_config(data)?;
|
||||
let conditions = HashMap::new();
|
||||
let claims = HashMap::new();
|
||||
let groups = None;
|
||||
for (bucket, action, expected) in cases {
|
||||
let args = Args {
|
||||
account: "catalog-migration-operator",
|
||||
groups: &groups,
|
||||
action: Action::AdminAction(*action),
|
||||
bucket,
|
||||
conditions: &conditions,
|
||||
is_owner: false,
|
||||
object: "",
|
||||
claims: &claims,
|
||||
deny_only: false,
|
||||
};
|
||||
assert_eq!(policy.is_allowed(&args).await, *expected, "{action:?} on warehouse {bucket:?}");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_migration_allow_resource_is_limited_to_the_requested_warehouse() -> Result<()> {
|
||||
assert_catalog_migration_policy_matrix(
|
||||
br#"{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [{
|
||||
"Effect": "Allow",
|
||||
"Action": "admin:MigrateTableCatalog",
|
||||
"Resource": "arn:aws:s3:::warehouse-a"
|
||||
}]
|
||||
}"#,
|
||||
&[
|
||||
("warehouse-a", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::MigrateTableCatalogAction, false),
|
||||
("", AdminAction::MigrateTableCatalogAction, false),
|
||||
],
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_migration_allow_not_resource_excludes_only_the_named_warehouse() -> Result<()> {
|
||||
assert_catalog_migration_policy_matrix(
|
||||
br#"{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [{
|
||||
"Effect": "Allow",
|
||||
"Action": "admin:MigrateTableCatalog",
|
||||
"NotResource": "arn:aws:s3:::warehouse-b"
|
||||
}]
|
||||
}"#,
|
||||
&[
|
||||
("warehouse-a", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::MigrateTableCatalogAction, false),
|
||||
("warehouse-c", AdminAction::MigrateTableCatalogAction, true),
|
||||
],
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_migration_explicit_deny_resource_does_not_spread_to_other_warehouses() -> Result<()> {
|
||||
assert_catalog_migration_policy_matrix(
|
||||
br#"{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{"Effect": "Allow", "Action": "admin:*", "Resource": "*"},
|
||||
{"Effect": "Deny", "Action": "admin:MigrateTableCatalog", "Resource": "arn:aws:s3:::warehouse-b"}
|
||||
]
|
||||
}"#,
|
||||
&[
|
||||
("warehouse-a", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::MigrateTableCatalogAction, false),
|
||||
("warehouse-c", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::ServerInfoAdminAction, true),
|
||||
],
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_migration_explicit_deny_not_resource_preserves_its_exception() -> Result<()> {
|
||||
assert_catalog_migration_policy_matrix(
|
||||
br#"{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{"Effect": "Allow", "Action": "admin:*", "Resource": "*"},
|
||||
{"Effect": "Deny", "Action": "admin:MigrateTableCatalog", "NotResource": "arn:aws:s3:::warehouse-a"}
|
||||
]
|
||||
}"#,
|
||||
&[
|
||||
("warehouse-a", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::MigrateTableCatalogAction, false),
|
||||
("warehouse-c", AdminAction::MigrateTableCatalogAction, false),
|
||||
("warehouse-b", AdminAction::ServerInfoAdminAction, true),
|
||||
],
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_migration_admin_wildcard_still_honors_the_requested_action_scope() -> Result<()> {
|
||||
assert_catalog_migration_policy_matrix(
|
||||
br#"{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [{
|
||||
"Effect": "Allow",
|
||||
"Action": "admin:*",
|
||||
"Resource": "arn:aws:s3:::warehouse-a"
|
||||
}]
|
||||
}"#,
|
||||
&[
|
||||
("warehouse-a", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::MigrateTableCatalogAction, false),
|
||||
("", AdminAction::MigrateTableCatalogAction, false),
|
||||
("warehouse-b", AdminAction::ServerInfoAdminAction, true),
|
||||
("", AdminAction::GetTableCatalogAction, true),
|
||||
],
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn catalog_migration_resource_free_admin_grants_keep_their_global_behavior() -> Result<()> {
|
||||
assert_catalog_migration_policy_matrix(
|
||||
br#"{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [{"Effect": "Allow", "Action": "admin:MigrateTableCatalog"}]
|
||||
}"#,
|
||||
&[
|
||||
("warehouse-a", AdminAction::MigrateTableCatalogAction, true),
|
||||
("warehouse-b", AdminAction::MigrateTableCatalogAction, true),
|
||||
("", AdminAction::MigrateTableCatalogAction, true),
|
||||
],
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn test_table_admin_action_with_resource_is_limited_to_bucket() -> Result<()> {
|
||||
use crate::policy::action::{Action, AdminAction};
|
||||
|
||||
@@ -73,8 +73,6 @@ rustfs-storage-api.workspace = true
|
||||
futures = { workspace = true }
|
||||
futures-core = { workspace = true }
|
||||
flate2.workspace = true
|
||||
brotli.workspace = true
|
||||
lz4.workspace = true
|
||||
http.workspace = true
|
||||
memchr.workspace = true
|
||||
s3s = { workspace = true, features = ["minio"] }
|
||||
|
||||
@@ -27,7 +27,6 @@ mod csv_input;
|
||||
mod input_stream;
|
||||
mod metrics;
|
||||
pub mod object_store;
|
||||
pub mod parquet_budget;
|
||||
pub mod query;
|
||||
pub mod server;
|
||||
mod storage_api;
|
||||
@@ -219,14 +218,6 @@ fn classify_select_error_source(err: &(dyn StdError + 'static)) -> Option<Select
|
||||
if let Some(error) = err.downcast_ref::<SelectError>() {
|
||||
return Some(error.clone());
|
||||
}
|
||||
if let Some(error) = err.downcast_ref::<parquet_budget::ParquetBudgetError>() {
|
||||
return Some(match error {
|
||||
parquet_budget::ParquetBudgetError::Exceeded => SelectError::ResourceExhausted,
|
||||
parquet_budget::ParquetBudgetError::Invalid(_) | parquet_budget::ParquetBudgetError::Codec(_) => {
|
||||
SelectError::ParquetParsingError
|
||||
}
|
||||
});
|
||||
}
|
||||
if let Some(error) = err.downcast_ref::<object_store::SelectObjectStoreError>() {
|
||||
return Some(error.select_error());
|
||||
}
|
||||
@@ -341,32 +332,9 @@ impl Display for ResolvedTable {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use datafusion::common::DataFusionError;
|
||||
use datafusion::sql::sqlparser::parser::ParserError;
|
||||
|
||||
#[test]
|
||||
fn parquet_admission_errors_preserve_select_error_codes() {
|
||||
for (source, expected) in [
|
||||
(parquet_budget::ParquetBudgetError::Exceeded, SelectError::ResourceExhausted),
|
||||
(
|
||||
parquet_budget::ParquetBudgetError::Invalid("malformed footer".into()),
|
||||
SelectError::ParquetParsingError,
|
||||
),
|
||||
(
|
||||
parquet_budget::ParquetBudgetError::Codec(std::io::Error::from(std::io::ErrorKind::InvalidData)),
|
||||
SelectError::ParquetParsingError,
|
||||
),
|
||||
] {
|
||||
let error = QueryError::from(DataFusionError::External(Box::new(source)));
|
||||
assert_eq!(error.select_error(), expected);
|
||||
}
|
||||
let nested = QueryError::from(DataFusionError::ParquetError(Box::new(ParquetError::External(Box::new(
|
||||
parquet_budget::ParquetBudgetError::Exceeded,
|
||||
)))));
|
||||
assert_eq!(nested.select_error(), SelectError::ResourceExhausted);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_query_error_display() {
|
||||
let err = QueryError::NotImplemented {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -424,8 +424,7 @@ impl SimpleQueryDispatcher {
|
||||
tracker: &QueryExecutionTracker,
|
||||
) -> QueryResult<MetadataProvider> {
|
||||
if self.input.request.input_serialization.parquet.is_some() {
|
||||
let query_guard = tracker.query_guard().ok_or(QueryError::Cancel)?;
|
||||
let provider = ParquetSelectTable::try_new(session.inner(), self.input.as_ref(), Some(query_guard)).await?;
|
||||
let provider = ParquetSelectTable::try_new(session.inner(), self.input.as_ref()).await?;
|
||||
let current_session_table_provider = self.build_table_handle_provider()?;
|
||||
let metadata_provider =
|
||||
MetadataProvider::new(provider, current_session_table_provider, self.func_manager.clone(), session.clone());
|
||||
|
||||
@@ -27,10 +27,7 @@ use datafusion::{
|
||||
datasource::{
|
||||
TableProvider,
|
||||
listing::{ListingTableUrl, PartitionedFile},
|
||||
physical_plan::{
|
||||
FileScanConfigBuilder, ParquetSource,
|
||||
parquet::{ParquetAccessPlan, ParquetFileReaderFactory},
|
||||
},
|
||||
physical_plan::{FileScanConfigBuilder, ParquetSource, parquet::ParquetAccessPlan},
|
||||
source::DataSourceExec,
|
||||
},
|
||||
execution::{memory_pool::MemoryLimit, object_store::ObjectStoreUrl},
|
||||
@@ -43,7 +40,6 @@ use datafusion::{
|
||||
},
|
||||
physical_plan::{
|
||||
ExecutionPlan, SendableRecordBatchStream,
|
||||
metrics::ExecutionPlanMetricsSet,
|
||||
stream::RecordBatchStreamAdapter,
|
||||
streaming::{PartitionStream, StreamingTableExec},
|
||||
},
|
||||
@@ -52,8 +48,6 @@ use futures::{FutureExt, TryFutureExt, TryStreamExt, future::BoxFuture, stream};
|
||||
use rustfs_s3select_api::{
|
||||
QueryResult,
|
||||
object_store::{SelectScanRange, scan_range_from_bounds},
|
||||
parquet_budget::{ParquetBudgetError, page_decode_budget, validate_footer},
|
||||
query::session::QueryExecutionGuard,
|
||||
};
|
||||
use s3s::dto::SelectObjectContentInput;
|
||||
|
||||
@@ -65,7 +59,6 @@ pub struct ParquetSelectTable {
|
||||
object_size: u64,
|
||||
access_plan: Option<Arc<ParquetAccessPlan>>,
|
||||
expanded_row_budget: usize,
|
||||
reader_factory: Arc<BudgetParquetReaderFactory>,
|
||||
}
|
||||
|
||||
impl fmt::Debug for ParquetSelectTable {
|
||||
@@ -79,30 +72,11 @@ impl fmt::Debug for ParquetSelectTable {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
struct ObjectStoreParquetReader {
|
||||
store: Arc<dyn ObjectStore>,
|
||||
path: Path,
|
||||
file_size: u64,
|
||||
metadata_read_limit: usize,
|
||||
metadata_decode_limit: usize,
|
||||
metadata: Option<Arc<ParquetMetaData>>,
|
||||
query_guard: Option<QueryExecutionGuard>,
|
||||
}
|
||||
|
||||
async fn validate_in_worker<T: Send + 'static>(
|
||||
query_guard: Option<QueryExecutionGuard>,
|
||||
operation: impl FnOnce() -> Result<T, ParquetBudgetError> + Send + 'static,
|
||||
) -> ParquetResult<T> {
|
||||
tokio::task::spawn_blocking(move || {
|
||||
// Cancellation cannot release admission while the decoder preflight
|
||||
// still owns input buffers or codec allocations.
|
||||
let _query_guard = query_guard;
|
||||
operation()
|
||||
})
|
||||
.await
|
||||
.map_err(|error| ParquetError::External(Box::new(error)))?
|
||||
.map_err(|error| ParquetError::External(Box::new(error)))
|
||||
}
|
||||
|
||||
impl AsyncFileReader for ObjectStoreParquetReader {
|
||||
@@ -120,16 +94,7 @@ impl AsyncFileReader for ObjectStoreParquetReader {
|
||||
if total.is_none_or(|total| total > self.metadata_read_limit as u64) {
|
||||
return async { Err(ParquetError::External(Box::new(parquet_budget_error()))) }.boxed();
|
||||
}
|
||||
async move {
|
||||
// Read requested ranges directly so sparse offsets cannot amplify
|
||||
// a small request into a large coalesced allocation.
|
||||
let mut bytes = Vec::with_capacity(ranges.len());
|
||||
for range in ranges {
|
||||
bytes.push(self.store.get_range(&self.path, range).await.map_err(parquet_store_error)?);
|
||||
}
|
||||
Ok(bytes)
|
||||
}
|
||||
.boxed()
|
||||
async move { self.store.get_ranges(&self.path, &ranges).await.map_err(parquet_store_error) }.boxed()
|
||||
}
|
||||
|
||||
fn get_metadata<'a>(
|
||||
@@ -137,27 +102,6 @@ impl AsyncFileReader for ObjectStoreParquetReader {
|
||||
options: Option<&'a ArrowReaderOptions>,
|
||||
) -> BoxFuture<'a, ParquetResult<Arc<ParquetMetaData>>> {
|
||||
async move {
|
||||
if let Some(metadata) = self.metadata.as_ref() {
|
||||
return Ok(Arc::clone(metadata));
|
||||
}
|
||||
let tail_start = self
|
||||
.file_size
|
||||
.checked_sub(8)
|
||||
.ok_or_else(|| ParquetError::EOF("Parquet footer is truncated".into()))?;
|
||||
let tail = self.get_bytes(tail_start..self.file_size).await?;
|
||||
let tail: &[u8; 8] = tail
|
||||
.as_ref()
|
||||
.try_into()
|
||||
.map_err(|_| ParquetError::EOF("Parquet footer is truncated".into()))?;
|
||||
let footer = datafusion::parquet::file::metadata::FooterTail::try_new(tail)?;
|
||||
let length =
|
||||
u64::try_from(footer.metadata_length()).map_err(|_| ParquetError::External(Box::new(parquet_budget_error())))?;
|
||||
let start = tail_start
|
||||
.checked_sub(length)
|
||||
.ok_or_else(|| ParquetError::EOF("Parquet metadata is truncated".into()))?;
|
||||
let bytes = self.get_bytes(start..tail_start).await?;
|
||||
let limit = self.metadata_decode_limit;
|
||||
validate_in_worker(self.query_guard.clone(), move || validate_footer(&bytes, limit)).await?;
|
||||
let metadata_options = options.map(|options| options.metadata_options().clone());
|
||||
let mut metadata_reader = ParquetMetaDataReader::new().with_metadata_options(metadata_options);
|
||||
|
||||
@@ -175,84 +119,8 @@ impl AsyncFileReader for ObjectStoreParquetReader {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
struct BudgetParquetReaderFactory {
|
||||
store: Arc<dyn ObjectStore>,
|
||||
path: Path,
|
||||
file_size: u64,
|
||||
metadata: Arc<ParquetMetaData>,
|
||||
read_limit: usize,
|
||||
}
|
||||
|
||||
impl ParquetFileReaderFactory for BudgetParquetReaderFactory {
|
||||
fn create_reader(
|
||||
&self,
|
||||
_partition_index: usize,
|
||||
file: PartitionedFile,
|
||||
_metadata_size_hint: Option<usize>,
|
||||
_metrics: &ExecutionPlanMetricsSet,
|
||||
) -> DFResult<Box<dyn AsyncFileReader + Send>> {
|
||||
if file.object_meta.location != self.path || file.object_meta.size != self.file_size {
|
||||
return Err(DataFusionError::Execution("Parquet reader input differs from its admitted object".into()));
|
||||
}
|
||||
Ok(Box::new(ObjectStoreParquetReader {
|
||||
store: Arc::clone(&self.store),
|
||||
path: self.path.clone(),
|
||||
file_size: self.file_size,
|
||||
metadata_read_limit: self.read_limit,
|
||||
metadata_decode_limit: self.read_limit,
|
||||
metadata: Some(Arc::clone(&self.metadata)),
|
||||
query_guard: None,
|
||||
}))
|
||||
}
|
||||
}
|
||||
|
||||
async fn validate_parquet_pages(
|
||||
store: &Arc<dyn ObjectStore>,
|
||||
path: &Path,
|
||||
file_size: u64,
|
||||
metadata: &ParquetMetaData,
|
||||
plan: Option<&ParquetAccessPlan>,
|
||||
limit: usize,
|
||||
query_guard: &Option<QueryExecutionGuard>,
|
||||
) -> DFResult<()> {
|
||||
for (index, group) in metadata.row_groups().iter().enumerate() {
|
||||
if plan.is_some_and(|plan| !plan.should_scan(index)) {
|
||||
continue;
|
||||
}
|
||||
let mut resident = 0usize;
|
||||
for column in group.columns() {
|
||||
let start = u64::try_from(column.dictionary_page_offset().unwrap_or(column.data_page_offset()))
|
||||
.map_err(|_| parquet_budget_error())?;
|
||||
let length = u64::try_from(column.compressed_size()).map_err(|_| parquet_budget_error())?;
|
||||
let end = start
|
||||
.checked_add(length)
|
||||
.filter(|end| *end <= file_size)
|
||||
.ok_or_else(parquet_budget_error)?;
|
||||
if length > u64::try_from(limit).map_err(|_| parquet_budget_error())? {
|
||||
return Err(parquet_budget_error());
|
||||
}
|
||||
let bytes = store.get_range(path, start..end).await?;
|
||||
let declared = usize::try_from(column.uncompressed_size()).map_err(|_| parquet_budget_error())?;
|
||||
let codec = column.compression();
|
||||
let required = validate_in_worker(query_guard.clone(), move || page_decode_budget(&bytes, declared, limit, codec))
|
||||
.await
|
||||
.map_err(DataFusionError::from)?;
|
||||
resident = resident
|
||||
.checked_add(required)
|
||||
.filter(|total| *total <= limit)
|
||||
.ok_or_else(parquet_budget_error)?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
impl ParquetSelectTable {
|
||||
pub async fn try_new(
|
||||
state: &dyn Session,
|
||||
input: &SelectObjectContentInput,
|
||||
query_guard: Option<QueryExecutionGuard>,
|
||||
) -> QueryResult<Arc<dyn TableProvider>> {
|
||||
pub async fn try_new(state: &dyn Session, input: &SelectObjectContentInput) -> QueryResult<Arc<dyn TableProvider>> {
|
||||
let table_path = ListingTableUrl::parse(format!("s3://{}/{}", input.bucket, input.key))?;
|
||||
let object_store_url = table_path.object_store();
|
||||
let object_location = Path::from(input.key.clone());
|
||||
@@ -268,12 +136,9 @@ impl ParquetSelectTable {
|
||||
};
|
||||
let reader = ObjectStoreParquetReader {
|
||||
store: Arc::clone(&store),
|
||||
path: object_location.clone(),
|
||||
path: object_location,
|
||||
file_size: object_meta.size,
|
||||
metadata_read_limit: (memory_budget / 16).max(1),
|
||||
metadata_decode_limit: (memory_budget / 4).max(1),
|
||||
metadata: None,
|
||||
query_guard: query_guard.clone(),
|
||||
};
|
||||
let builder = ParquetRecordBatchStreamBuilder::new(reader)
|
||||
.await
|
||||
@@ -288,26 +153,11 @@ impl ParquetSelectTable {
|
||||
builder.schema().metadata().clone(),
|
||||
));
|
||||
let metadata = Arc::clone(builder.metadata());
|
||||
// This is admission for valid Parquet declarations, not a replacement
|
||||
// for limits inside the footer parser or native compression codecs.
|
||||
let expanded_row_budget = (memory_budget / 16).max(1);
|
||||
let access_plan = parquet_access_plan(input, object_meta.size, metadata.as_ref())?;
|
||||
admit_parquet_decode(metadata.as_ref(), access_plan.as_deref(), memory_budget / 4)?;
|
||||
validate_parquet_pages(
|
||||
&store,
|
||||
&object_location,
|
||||
object_meta.size,
|
||||
&metadata,
|
||||
access_plan.as_deref(),
|
||||
memory_budget / 4,
|
||||
&query_guard,
|
||||
)
|
||||
.await?;
|
||||
let reader_factory = Arc::new(BudgetParquetReaderFactory {
|
||||
store,
|
||||
path: object_location,
|
||||
file_size: object_meta.size,
|
||||
metadata,
|
||||
read_limit: (memory_budget / 4).max(1),
|
||||
});
|
||||
|
||||
Ok(Arc::new(Self {
|
||||
schema,
|
||||
@@ -316,7 +166,6 @@ impl ParquetSelectTable {
|
||||
object_size: object_meta.size,
|
||||
access_plan,
|
||||
expanded_row_budget,
|
||||
reader_factory,
|
||||
}))
|
||||
}
|
||||
|
||||
@@ -353,12 +202,7 @@ impl TableProvider for ParquetSelectTable {
|
||||
));
|
||||
}
|
||||
let scan_limit = if filters.is_empty() { limit } else { None };
|
||||
let file_source = Arc::new(
|
||||
ParquetSource::new(Arc::clone(&self.schema))
|
||||
.with_parquet_file_reader_factory(self.reader_factory.clone())
|
||||
.with_enable_page_index(false)
|
||||
.with_bloom_filter_on_read(false),
|
||||
);
|
||||
let file_source = Arc::new(ParquetSource::new(Arc::clone(&self.schema)));
|
||||
let config = FileScanConfigBuilder::new(self.object_store_url.clone(), file_source)
|
||||
.with_file(self.partitioned_file())
|
||||
.with_projection_indices(projection.cloned())?
|
||||
@@ -595,39 +439,6 @@ pub(super) fn dictionary_parquet_for_test(value_bytes: usize, rows: usize) -> Ve
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
|
||||
async fn parquet_cancelled_preflight_retains_admission_until_worker_finishes() {
|
||||
let admission = Arc::new(tokio::sync::Semaphore::new(1));
|
||||
let permit = Arc::clone(&admission).acquire_owned().await.expect("initial admission");
|
||||
let (started_tx, started_rx) = tokio::sync::oneshot::channel();
|
||||
let (release_tx, release_rx) = std::sync::mpsc::channel();
|
||||
let task = tokio::spawn(validate_in_worker(Some(Arc::new(permit)), move || {
|
||||
started_tx.send(()).expect("report running worker");
|
||||
release_rx
|
||||
.recv_timeout(std::time::Duration::from_secs(5))
|
||||
.expect("worker release");
|
||||
Ok(())
|
||||
}));
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), started_rx)
|
||||
.await
|
||||
.expect("worker starts before deadline")
|
||||
.expect("worker started");
|
||||
task.abort();
|
||||
assert!(task.await.expect_err("cancelled request task").is_cancelled());
|
||||
assert!(Arc::clone(&admission).try_acquire_owned().is_err(), "running worker still owns admission");
|
||||
release_tx.send(()).expect("release worker");
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), async {
|
||||
loop {
|
||||
if Arc::clone(&admission).try_acquire_owned().is_ok() {
|
||||
break;
|
||||
}
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("worker releases admission after completion");
|
||||
}
|
||||
use datafusion::{
|
||||
arrow::{
|
||||
array::Int32Array,
|
||||
@@ -708,7 +519,7 @@ mod tests {
|
||||
let context = parquet_session(store);
|
||||
let state = context.state();
|
||||
|
||||
let error = match ParquetSelectTable::try_new(&state, &parquet_input("missing.parquet"), None).await {
|
||||
let error = match ParquetSelectTable::try_new(&state, &parquet_input("missing.parquet")).await {
|
||||
Ok(_) => panic!("missing parquet object must fail"),
|
||||
Err(error) => error,
|
||||
};
|
||||
@@ -727,7 +538,7 @@ mod tests {
|
||||
let context = parquet_session(store);
|
||||
let state = context.state();
|
||||
|
||||
let error = match ParquetSelectTable::try_new(&state, &parquet_input(object.as_ref()), None).await {
|
||||
let error = match ParquetSelectTable::try_new(&state, &parquet_input(object.as_ref())).await {
|
||||
Ok(_) => panic!("corrupt parquet metadata must fail"),
|
||||
Err(error) => error,
|
||||
};
|
||||
@@ -770,7 +581,7 @@ mod tests {
|
||||
.put(&Path::from("dictionary.parquet"), Bytes::from(bytes).into())
|
||||
.await
|
||||
.expect("fixture");
|
||||
let table = ParquetSelectTable::try_new(&context.state(), &parquet_input("dictionary.parquet"), None)
|
||||
let table = ParquetSelectTable::try_new(&context.state(), &parquet_input("dictionary.parquet"))
|
||||
.await
|
||||
.expect("valid dictionary metadata");
|
||||
context.register_table("source", table).expect("table");
|
||||
@@ -941,7 +752,7 @@ mod tests {
|
||||
start: Some(starts[0]),
|
||||
end: Some(starts[0]),
|
||||
});
|
||||
let table = ParquetSelectTable::try_new(&context.state(), &input, None)
|
||||
let table = ParquetSelectTable::try_new(&context.state(), &input)
|
||||
.await
|
||||
.expect("an unselected large row group must not reject the small range");
|
||||
context.register_table("source", table).expect("table");
|
||||
@@ -959,7 +770,7 @@ mod tests {
|
||||
start: Some(starts[1]),
|
||||
end: Some(starts[1]),
|
||||
});
|
||||
let error = match ParquetSelectTable::try_new(&context.state(), &input, None).await {
|
||||
let error = match ParquetSelectTable::try_new(&context.state(), &input).await {
|
||||
Ok(_) => panic!("the selected oversized row group must still be rejected before decoding"),
|
||||
Err(error) => error,
|
||||
};
|
||||
@@ -995,117 +806,13 @@ mod tests {
|
||||
.put(&Path::from("large.parquet"), Bytes::from(bytes).into())
|
||||
.await
|
||||
.expect("fixture");
|
||||
let error = match ParquetSelectTable::try_new(&context.state(), &parquet_input("large.parquet"), None).await {
|
||||
let error = match ParquetSelectTable::try_new(&context.state(), &parquet_input("large.parquet")).await {
|
||||
Ok(_) => panic!("valid declared decoded size must be admitted before page decode"),
|
||||
Err(error) => error,
|
||||
};
|
||||
assert!(error.to_string().contains("query memory budget"));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn parquet_footer_collection_budget_is_checked_before_metadata_decode() {
|
||||
// A root schema with no leaves and 50 empty, valid row groups. The
|
||||
// encoded footer fits the read budget; its reservations do not.
|
||||
let mut footer = vec![0x15, 2, 0x19, 0x1c, 0x48, 4];
|
||||
footer.extend(b"root");
|
||||
footer.extend([0x15, 0, 0, 0x16, 0, 0x19, 0xfc, 50]);
|
||||
for _ in 0..50 {
|
||||
footer.extend([0x19, 0x0c, 0x16, 0, 0x16, 0, 0]);
|
||||
}
|
||||
footer.push(0);
|
||||
let decoded = ParquetMetaDataReader::decode_metadata(&footer).expect("valid compact footer fixture");
|
||||
assert_eq!(decoded.num_row_groups(), 50);
|
||||
let mut bytes = b"PAR1".to_vec();
|
||||
bytes.extend(&footer);
|
||||
bytes.extend(u32::try_from(footer.len()).expect("small footer").to_le_bytes());
|
||||
bytes.extend(b"PAR1");
|
||||
let store = Arc::new(InMemory::new());
|
||||
let context = parquet_session_with_memory(store.clone(), 8192);
|
||||
store
|
||||
.put(&Path::from("footer.parquet"), Bytes::from(bytes).into())
|
||||
.await
|
||||
.expect("fixture");
|
||||
let error = match ParquetSelectTable::try_new(&context.state(), &parquet_input("footer.parquet"), None).await {
|
||||
Ok(_) => panic!("footer collection reservations exceed the query budget"),
|
||||
Err(error) => error,
|
||||
};
|
||||
assert_eq!(error.select_error(), SelectError::ResourceExhausted);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn parquet_forged_footer_cannot_hide_oversized_compressed_pages() {
|
||||
use datafusion::parquet::file::metadata::ParquetMetaDataWriter;
|
||||
|
||||
let schema = Arc::new(Schema::new(vec![Field::new("v", DataType::Utf8, false)]));
|
||||
let batch = RecordBatch::try_new(
|
||||
Arc::clone(&schema),
|
||||
vec![Arc::new(datafusion::arrow::array::StringArray::from(vec![
|
||||
"x".repeat(32 * 1024 * 1024),
|
||||
]))],
|
||||
)
|
||||
.expect("large compressible value");
|
||||
let properties = datafusion::parquet::file::properties::WriterProperties::builder()
|
||||
.set_dictionary_page_size_limit(64 * 1024 * 1024)
|
||||
.set_compression(datafusion::parquet::basic::Compression::ZSTD(Default::default()))
|
||||
.build();
|
||||
let mut encoded = Vec::new();
|
||||
let mut writer = ArrowWriter::try_new(&mut encoded, schema, Some(properties)).expect("writer");
|
||||
writer.write(&batch).expect("compressed value");
|
||||
writer.close().expect("footer");
|
||||
let original = Bytes::from(encoded);
|
||||
let builder = ParquetRecordBatchReaderBuilder::try_new(original.clone()).expect("valid compressed fixture");
|
||||
let metadata = builder.metadata();
|
||||
let groups = metadata
|
||||
.row_groups()
|
||||
.iter()
|
||||
.map(|group| {
|
||||
let columns = group
|
||||
.columns()
|
||||
.iter()
|
||||
.cloned()
|
||||
.map(|column| {
|
||||
column
|
||||
.into_builder()
|
||||
.set_total_uncompressed_size(64)
|
||||
.build()
|
||||
.expect("forged column")
|
||||
})
|
||||
.collect();
|
||||
group
|
||||
.clone()
|
||||
.into_builder()
|
||||
.set_column_metadata(columns)
|
||||
.build()
|
||||
.expect("forged group")
|
||||
})
|
||||
.collect();
|
||||
let forged = metadata.as_ref().clone().into_builder().set_row_groups(groups).build();
|
||||
let footer_size = u32::from_le_bytes(
|
||||
original[original.len() - 8..original.len() - 4]
|
||||
.try_into()
|
||||
.expect("footer size"),
|
||||
);
|
||||
let mut bytes = original[..original.len() - 8 - usize::try_from(footer_size).expect("footer length")].to_vec();
|
||||
ParquetMetaDataWriter::new(&mut bytes, &forged)
|
||||
.finish()
|
||||
.expect("forged footer");
|
||||
assert!(bytes.len() < 256 * 1024, "compressed input remains small");
|
||||
admit_parquet_decode(&forged, None, 4 * 1024 * 1024).expect("footer-only admission misses the page size");
|
||||
|
||||
let store = Arc::new(InMemory::new());
|
||||
let context = parquet_session_with_memory(store.clone(), 16 * 1024 * 1024);
|
||||
store
|
||||
.put(&Path::from("forged.parquet"), Bytes::from(bytes).into())
|
||||
.await
|
||||
.expect("fixture");
|
||||
let result = ParquetSelectTable::try_new(&context.state(), &parquet_input("forged.parquet"), None).await;
|
||||
let error = match result {
|
||||
Ok(_) => panic!("actual query admission must reject oversized page buffers before decoding"),
|
||||
Err(error) => error,
|
||||
};
|
||||
assert_eq!(error.select_error(), SelectError::ResourceExhausted);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn parquet_nested_views_decode_through_the_actual_file_schema() {
|
||||
use datafusion::arrow::array::{ListArray, StringArray};
|
||||
|
||||
@@ -2348,10 +2348,6 @@ impl FolderScanner {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Budget and admission waits already pace this walker. Charge
|
||||
// only work performed after admission, never those waits again.
|
||||
let mut work_elapsed = work_started.elapsed();
|
||||
|
||||
// Reuse a resolved symlink's size; otherwise admit the size
|
||||
// stat only when the byte budget needs it.
|
||||
let budgeted_bytes = if self.sleeper.budgets_disk_io_bytes() {
|
||||
@@ -2361,12 +2357,7 @@ impl FolderScanner {
|
||||
wait_for_scanner_io(&ctx, self.sleeper.admit_disk_io(1, 0)).await?;
|
||||
wait_for_scanner_io(
|
||||
&ctx,
|
||||
run_scanner_node_operation(self.node_admission.as_ref(), &ctx, async {
|
||||
let started = tokio::time::Instant::now();
|
||||
let result = native_io::metadata(&item.path).await;
|
||||
work_elapsed = work_elapsed.saturating_add(started.elapsed());
|
||||
result
|
||||
}),
|
||||
run_scanner_node_operation(self.node_admission.as_ref(), &ctx, native_io::metadata(&item.path)),
|
||||
)
|
||||
.await??
|
||||
.map(|metadata| metadata.len())
|
||||
@@ -2378,7 +2369,6 @@ impl FolderScanner {
|
||||
wait_for_scanner_io(&ctx, self.sleeper.admit_disk_io(1, budgeted_bytes)).await?;
|
||||
|
||||
let size_result = run_scanner_metadata_operation(self.node_admission.as_ref(), &ctx, async {
|
||||
let started = tokio::time::Instant::now();
|
||||
self.object_metadata_visits.increment(1);
|
||||
#[cfg(feature = "diagnostic-prefix-attribution")]
|
||||
if let Some(attribution) = &self.prefix_attribution {
|
||||
@@ -2394,11 +2384,9 @@ impl FolderScanner {
|
||||
{
|
||||
attribution.record_success(&item.bucket, &item.prefix);
|
||||
}
|
||||
work_elapsed = work_elapsed.saturating_add(started.elapsed());
|
||||
result
|
||||
})
|
||||
.await?;
|
||||
let work_started = tokio::time::Instant::now();
|
||||
if self.node_admission.is_some() && ctx.is_cancelled() {
|
||||
return Err(ScannerError::Other("Operation cancelled".to_string()));
|
||||
}
|
||||
@@ -2495,12 +2483,8 @@ impl FolderScanner {
|
||||
}
|
||||
}
|
||||
|
||||
wait_for_scanner_io(
|
||||
&ctx,
|
||||
self.sleeper
|
||||
.pace_object(&mut self.pacing_debt, work_elapsed.saturating_add(work_started.elapsed())),
|
||||
)
|
||||
.await?;
|
||||
wait_for_scanner_io(&ctx, self.sleeper.pace_object(&mut self.pacing_debt, work_started.elapsed()))
|
||||
.await?;
|
||||
continue;
|
||||
}
|
||||
};
|
||||
@@ -2523,12 +2507,7 @@ impl FolderScanner {
|
||||
self.checkpoint_objects = self.checkpoint_objects.saturating_add(1);
|
||||
self.maybe_send_checkpoint(&folder, &this_hash, into);
|
||||
|
||||
wait_for_scanner_io(
|
||||
&ctx,
|
||||
self.sleeper
|
||||
.pace_object(&mut self.pacing_debt, work_elapsed.saturating_add(work_started.elapsed())),
|
||||
)
|
||||
.await?;
|
||||
wait_for_scanner_io(&ctx, self.sleeper.pace_object(&mut self.pacing_debt, work_started.elapsed())).await?;
|
||||
|
||||
if ctx.is_cancelled() {
|
||||
return Err(ScannerError::Other("Operation cancelled".to_string()));
|
||||
|
||||
@@ -29,69 +29,6 @@ impl Drop for IdleGuard {
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
#[serial]
|
||||
async fn object_pacing_does_not_multiply_disk_budget_waits() {
|
||||
let _idle = IdleGuard::enabled();
|
||||
for corrupt in [false, true] {
|
||||
let (mut scanner, temp_dir) = build_test_scanner().await;
|
||||
let _guard = TestGuard::new(60, 100, &mut scanner, temp_dir.clone());
|
||||
scanner.old_cache.info.name = "bucket".to_owned();
|
||||
scanner.new_cache.info.name = "bucket".to_owned();
|
||||
scanner.sleeper = DynamicSleeper::new(rustfs_config::ScannerSpeed::Default).for_disk_with_budget_for_tests(
|
||||
&temp_dir,
|
||||
crate::sleeper::ScannerDiskIoBudgetLimits {
|
||||
iops: Some(0),
|
||||
bytes_per_sec: Some(0),
|
||||
},
|
||||
);
|
||||
let mut metadata = FileMeta::new();
|
||||
let mut info = FileInfo::new("object", 4, 2);
|
||||
info.volume = "bucket".to_owned();
|
||||
info.size = 17;
|
||||
info.mod_time = Some(OffsetDateTime::from_unix_timestamp(1_700_000_000).expect("fixture timestamp"));
|
||||
metadata.add_version(info).expect("add object metadata");
|
||||
let bytes = if corrupt {
|
||||
Vec::new()
|
||||
} else {
|
||||
metadata.marshal_msg().expect("encode object metadata")
|
||||
};
|
||||
write_test_object_metadata_bytes(&temp_dir, "bucket", "object", &bytes).await;
|
||||
let mut entry = DataUsageEntry::default();
|
||||
scanner
|
||||
.scan_folder(
|
||||
CancellationToken::new(),
|
||||
CachedFolder {
|
||||
name: "bucket".to_owned(),
|
||||
parent: None,
|
||||
object_heal_prob_div: 1,
|
||||
},
|
||||
&mut entry,
|
||||
)
|
||||
.await
|
||||
.expect("finish budget-limited folder scan");
|
||||
let total = scanner
|
||||
.new_cache
|
||||
.size_recursive(&hash_path("bucket").0)
|
||||
.expect("root accounting");
|
||||
assert_eq!(total.objects, usize::from(!corrupt));
|
||||
assert_eq!(total.size, if corrupt { 0 } else { 17 });
|
||||
assert_eq!(total.failed_objects, usize::from(corrupt));
|
||||
let budget = crate::sleeper::scanner_disk_io_budget_status()
|
||||
.into_iter()
|
||||
.find(|status| status.disk == temp_dir.to_string_lossy())
|
||||
.expect("disk budget status");
|
||||
assert!(budget.wait_seconds >= 2.0, "the scan must actually exhaust its disk budget");
|
||||
assert_eq!(scanner.pacing_debt.charged_objects, 1);
|
||||
assert!(
|
||||
scanner.pacing_debt.charged_delay < Duration::from_millis(100),
|
||||
"budget waits must not become proportional work debt: {:?}",
|
||||
scanner.pacing_debt.charged_delay
|
||||
);
|
||||
assert_eq!(scanner.pacing_debt.pending(), Duration::ZERO);
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn pacing_preserves_real_folder_versions_bytes_checkpoints_and_maintenance() {
|
||||
|
||||
@@ -136,8 +136,6 @@ pub static SCANNER_SLEEPER: LazyLock<DynamicSleeper> = LazyLock::new(|| {
|
||||
/// `elapsed_work_time * factor`, clamped to `[MIN_SLEEP, max_sleep]`.
|
||||
/// Folder walkers accumulate proportional object waits without the per-object
|
||||
/// floor, paying bounded batches and the final bucket tail.
|
||||
/// Their work measurement excludes disk-budget and node-admission waits so
|
||||
/// foreground protection does not become an additional proportional delay.
|
||||
/// For folder-level gaps, [`sleep_folder`] uses `MIN_SLEEP * factor`,
|
||||
/// clamped only by `max_sleep`. All sleeps are gated on [`SCANNER_IDLE_MODE`];
|
||||
/// the per-disk background I/O budget bound with [`DynamicSleeper::for_disk`]
|
||||
@@ -230,17 +228,6 @@ impl DynamicSleeper {
|
||||
SCANNER_IDLE_MODE.load(Ordering::Relaxed)
|
||||
}
|
||||
|
||||
fn foreground_backoff(&self) -> Duration {
|
||||
// Local walkers already use disk-priority admission and a shared I/O
|
||||
// budget. A global per-operation floor duplicates that control and
|
||||
// throttles idle disks because unrelated foreground work is active.
|
||||
if self.disk_io_budget.is_some() {
|
||||
Duration::ZERO
|
||||
} else {
|
||||
foreground_workload_backoff_duration(crate::workload_admission::foreground_workload_activity())
|
||||
}
|
||||
}
|
||||
|
||||
fn read_params(&self) -> (f64, Duration) {
|
||||
let config = self.read_config();
|
||||
(config.factor, config.max_sleep)
|
||||
@@ -263,14 +250,15 @@ impl DynamicSleeper {
|
||||
}
|
||||
let (factor, max_sleep) = self.read_params();
|
||||
if factor == 0.0 || max_sleep.is_zero() {
|
||||
let foreground_sleep = self.foreground_backoff();
|
||||
let foreground_sleep =
|
||||
foreground_workload_backoff_duration(crate::workload_admission::foreground_workload_activity());
|
||||
if !foreground_sleep.is_zero() {
|
||||
tokio::time::sleep(foreground_sleep).await;
|
||||
global_metrics().record_scanner_throttle_sleep(foreground_sleep);
|
||||
}
|
||||
return;
|
||||
}
|
||||
let foreground_sleep = self.foreground_backoff();
|
||||
let foreground_sleep = foreground_workload_backoff_duration(crate::workload_admission::foreground_workload_activity());
|
||||
let sleep_dur = Duration::from_secs_f64(MIN_SLEEP.as_secs_f64() * factor)
|
||||
.min(max_sleep)
|
||||
.max(foreground_sleep);
|
||||
@@ -364,7 +352,8 @@ impl SleepTimer {
|
||||
}
|
||||
let (factor, max_sleep) = self.sleeper.read_params();
|
||||
if factor == 0.0 || max_sleep.is_zero() {
|
||||
let foreground_sleep = self.sleeper.foreground_backoff();
|
||||
let foreground_sleep =
|
||||
foreground_workload_backoff_duration(crate::workload_admission::foreground_workload_activity());
|
||||
if !foreground_sleep.is_zero() {
|
||||
tokio::time::sleep(foreground_sleep).await;
|
||||
global_metrics().record_scanner_throttle_sleep(foreground_sleep);
|
||||
@@ -372,7 +361,7 @@ impl SleepTimer {
|
||||
return;
|
||||
}
|
||||
let elapsed = self.start.elapsed();
|
||||
let foreground_sleep = self.sleeper.foreground_backoff();
|
||||
let foreground_sleep = foreground_workload_backoff_duration(crate::workload_admission::foreground_workload_activity());
|
||||
let sleep_dur = Duration::from_secs_f64(elapsed.as_secs_f64() * factor)
|
||||
.max(MIN_SLEEP)
|
||||
.min(max_sleep)
|
||||
|
||||
@@ -43,8 +43,6 @@ pub(crate) struct PacingDebt {
|
||||
pub(crate) charged_objects: u64,
|
||||
#[cfg(test)]
|
||||
pub(crate) batches: u64,
|
||||
#[cfg(test)]
|
||||
pub(crate) charged_delay: Duration,
|
||||
}
|
||||
|
||||
impl PacingDebt {
|
||||
@@ -75,7 +73,6 @@ impl PacingDebt {
|
||||
#[cfg(test)]
|
||||
{
|
||||
self.charged_objects += 1;
|
||||
self.charged_delay = self.charged_delay.saturating_add(delay);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -135,7 +132,7 @@ impl DynamicSleeper {
|
||||
if let Some(elapsed) = elapsed {
|
||||
debt.charge(proportional_delay(elapsed, config), Instant::now());
|
||||
}
|
||||
let foreground = self.foreground_backoff();
|
||||
let foreground = foreground_workload_backoff_duration(crate::workload_admission::foreground_workload_activity());
|
||||
let now = Instant::now();
|
||||
let folder_reaches_deadline = folder
|
||||
&& debt.started.is_some_and(|start| {
|
||||
|
||||
@@ -181,54 +181,6 @@ async fn active_wait_wakes_for_fastest_idle_off_and_smaller_max_wait() {
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
#[serial]
|
||||
async fn disk_bound_pacing_does_not_repeat_global_foreground_backoff() {
|
||||
let _idle = IdleGuard::enabled();
|
||||
struct ForegroundGuard;
|
||||
impl Drop for ForegroundGuard {
|
||||
fn drop(&mut self) {
|
||||
crate::reset_foreground_read_activity_for_test();
|
||||
}
|
||||
}
|
||||
let _foreground = ForegroundGuard;
|
||||
crate::set_foreground_read_activity(25);
|
||||
let disk = tempfile::tempdir().expect("disk identity");
|
||||
let sleeper = DynamicSleeper::new(ScannerSpeed::Default).for_disk_with_budget_for_tests(
|
||||
disk.path(),
|
||||
ScannerDiskIoBudgetLimits {
|
||||
iops: Some(0),
|
||||
bytes_per_sec: None,
|
||||
},
|
||||
);
|
||||
let mut debt = PacingDebt::default();
|
||||
let begin = Instant::now();
|
||||
for _ in 0..100 {
|
||||
sleeper.pace_object(&mut debt, Duration::from_micros(20)).await;
|
||||
}
|
||||
sleeper.flush_pacing(&mut debt).await;
|
||||
assert_eq!(begin.elapsed(), Duration::from_millis(4));
|
||||
assert_eq!(debt.charged_objects, 100);
|
||||
assert_eq!(debt.pending, Duration::ZERO);
|
||||
// The first operation consumes the token bucket's one-operation burst.
|
||||
sleeper.admit_disk_io(1, 0).await;
|
||||
let begin = Instant::now();
|
||||
sleeper.sleep_folder_paced(&mut debt).await;
|
||||
assert_eq!(
|
||||
begin.elapsed(),
|
||||
SCANNER_DISK_IO_BUDGET_MAX_WAIT + Duration::from_millis(2),
|
||||
"the per-disk budget and preset folder gap must still apply"
|
||||
);
|
||||
assert_eq!(
|
||||
scanner_disk_io_budget_status()
|
||||
.into_iter()
|
||||
.find(|status| status.disk == disk.path().to_string_lossy())
|
||||
.expect("disk charges remain visible")
|
||||
.charged_ops,
|
||||
2
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
#[serial]
|
||||
async fn foreground_backoff_flushes_tail_without_double_charging_or_max_wait_cap() {
|
||||
|
||||
@@ -19,8 +19,6 @@ collection:
|
||||
|
||||
- [Table maintenance periodic queueing](operations/s3-tables-maintenance-scheduler.md) — opt-in scheduling, limits, worker handoff, and recovery.
|
||||
|
||||
- [S3 Tables catalog lifecycle](operations/s3-tables-catalog-lifecycle.md) — disablement, fenced empty-table cleanup, and registration-cache boundaries.
|
||||
|
||||
For PUT cleanup admission, blocking-pool isolation, and optional CPU affinity,
|
||||
see [PUT cleanup isolation](operations/put-cleanup-isolation.md).
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ Required headings and strings in these files are asserted by `scripts/check_arch
|
||||
| Document | Use this when |
|
||||
|---|---|
|
||||
| [s3-compatibility-matrix.md](s3-compatibility-matrix.md) | writing or checking a user-facing S3 compatibility claim, or moving a Ceph s3tests case between lists |
|
||||
| [s3-tables-support-matrix.md](s3-tables-support-matrix.md) | writing a release note or client-compatibility statement about S3 Tables / Iceberg REST Catalog |
|
||||
| [s3-tables-support-matrix.md](s3-tables-support-matrix.md) | writing a release note or client-compatibility statement about S3 Tables / Iceberg REST Catalog (cutover procedure: [../operations/s3-tables-cutover-runbook.md](../operations/s3-tables-cutover-runbook.md)) |
|
||||
| [minio-rustfs-router-compatibility.md](minio-rustfs-router-compatibility.md) | a client or `mc` call that works against MinIO fails against RustFS and you need to know whether the endpoint is missing, stubbed, or deliberately different |
|
||||
| [minio-file-format-compat.md](minio-file-format-compat.md) | deciding whether a MinIO drive set, bucket-metadata blob, or SSE object can be read or imported by a given RustFS build, or before touching a listed version anchor |
|
||||
|
||||
|
||||
@@ -35,6 +35,9 @@
|
||||
- `s3gate-parse-strict` unreadable bucket versioning on object writes: a stored versioning configuration that cannot be parsed was historically read as unversioned, and existing clusters may already hold such buckets unnoticed. RUSTFS_BUCKET_CONFIG_PARSE_MODE defaults to permissive, which keeps that unversioned write and records it through rustfs_bucket_metadata_parse_failed_total, rustfs_bucket_metadata_unparsable_current, and an error log; strict refuses the write with 503. Paths that already refuse an unreadable configuration (typed getters, the read-modify-write guard, Object Lock, default encryption, delete-time versioning) refuse in both modes. Mixed-version risk window: older nodes lack the per-config read-modify-write guard and still write unversioned, so the metric must be driven to zero before relying on strict. Flip the default to strict after the parse-failure counter has read zero fleet-wide for two consecutive releases, and remove the permissive branch and the switch one release after that.
|
||||
- `rustfs-6339` legacy bucket policy ID casing: earlier RustFS releases persisted the top-level policy identifier as "ID", while current writes use the S3-compatible "Id" spelling. Readers accept both spellings so retained bucket metadata remains usable after upgrade. Remove the legacy alias after migration tooling has rewritten every retained bucket policy using "ID".
|
||||
- `table-publication-fence-v1` table publication fencing: nodes that predate table and table-bucket publication fences can mutate live files while a new node is publishing a catalog pointer. New nodes retain exact object guards until the operator confirms that every serving node uses the new fences. Fleet confirmation also requires non-overlapping active warehouse prefixes and lifecycle workers that exclude table buckets. Remove the exact live-file fallback and the fleet-confirmation gate after the minimum supported RustFS release acquires table fences for registered-table mutations and table-bucket fences for unresolved-prefix mutations.
|
||||
- `table-catalog-strong-snapshot-v1` durable strong catalog snapshot compatibility: version 1 writes continue during mixed-version rollout until operators confirm that every serving node reads version 2, and version 1 table/view identifier collisions remain available only for cleanup. Remove version 1 writes and collision cleanup after the minimum supported RustFS release reads version 2 and every retained durable strong snapshot is collision-free and has been upgraded to version 2.
|
||||
- `table-catalog-migration-fence-v1` durable strong migration fence compatibility: version 1 "PREPARING" fences did not distinguish a known-absent global strong snapshot from an unknown baseline, so retries read them but fail closed if the global snapshot is missing. Version 2 preserves the same JSON shape and records the pre-migration global snapshot ETag in the existing target_snapshot_etag field while the fence is "PREPARING". Remove version 1 reads after every supported direct-upgrade source writes version 2 fences and operators have completed or cancelled every older in-progress backing migration.
|
||||
- `table-catalog-backing-manifest-v1-wire-labels` durable strong backing manifest labels: version 1 published "STRONG_KV_WAL" and "CUT_OVER_LINEARIZABLE_READS" before the implementation was narrowed to the ETag-CAS durable snapshot backing. Internal names and operator documentation describe the implemented semantics, while version 1 responses retain those labels for existing clients. Replace the labels only in a new manifest version with an explicit client migration contract.
|
||||
- `replacement-recovery-status-v1` replacement recovery status capability: new peers treat an unimplemented ReplacementRecoveryStatus RPC as an explicitly non-definitive rolling-upgrade response, so Admin v4 cannot claim distributed replacement completion from old peers. Remove the fallback after the minimum supported RustFS peer version implements ReplacementRecoveryStatus.
|
||||
- `peer-drive-admission-v1` startup peer re-admission capability: a restarting node treats an unimplemented PeerDriveAdmission RPC as a peer that cannot report, so the startup re-admission gate fails open during rolling upgrades from older releases. Remove the fallback after the minimum supported RustFS peer version implements PeerDriveAdmission.
|
||||
- `table-catalog-dotted-namespace` Iceberg REST namespace path compatibility: existing RustFS clients use dotted namespace paths, while the standard multi-level contract uses the URL-encoded unit separator `%1F`. New servers accept both forms so a rolling upgrade does not invalidate existing catalog configuration. Remove the dotted fallback after the minimum supported RustFS release advertises `%1F` and all supported clients have refreshed their catalog configuration.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# S3 Tables Support Matrix
|
||||
|
||||
**Use this when:** writing a release note, README claim, or client-compatibility statement about RustFS S3 Tables / Iceberg REST Catalog, or deciding whether a feature is supported, preview, or not claimed.
|
||||
**Source of truth:** the table-catalog handlers under `rustfs/src/admin/handlers/table_catalog/`; the conformance scripts and their README in `scripts/table-catalog/`; and the object catalog backup/restore contracts exercised by the focused server tests.
|
||||
**Source of truth:** the table-catalog handlers under `rustfs/src/admin/handlers/table_catalog/`; the conformance scripts and their README in `scripts/table-catalog/`; the durable-backing cutover procedure in [docs/operations/s3-tables-cutover-runbook.md](../operations/s3-tables-cutover-runbook.md).
|
||||
|
||||
RustFS S3 Tables is an Iceberg REST Catalog and table-bucket implementation on top of the RustFS S3 data plane. It does not claim parity with the AWS S3 Tables control-plane API or with vendor-specific Iceberg catalog extensions.
|
||||
|
||||
@@ -38,7 +38,7 @@ RustFS S3 Tables is an Iceberg REST Catalog and table-bucket implementation on t
|
||||
|
||||
| Client or engine | Status | Claim |
|
||||
|---|---|---|
|
||||
| PyIceberg | Automated | Namespace and table create, append, exact-row reload/scan, metadata-location, refs, views, namespace properties, rename identity, maintenance, diagnostics, export, and credential negotiation against the object catalog. Optional vended credentials include an exact-prefix data-plane scope check. |
|
||||
| PyIceberg | Automated | Namespace and table create, append, exact-row reload/scan, metadata-location, refs, views, namespace properties, rename identity and credential negotiation. The smoke discovers the server backing and checks maintenance configuration, scheduler/worker dry-run, diagnostics and export on both backings. Direct metadata maintenance is checked as unsupported on durable-strong. Optional vended credentials include an exact-prefix data-plane scope check. |
|
||||
| Spark Iceberg REST catalog | Manual/live harness | Pinned package inputs, catalog properties, atomic CTAS SQL through staged create, expected `row_count=2`, and a CI opt-in gate for create/refresh/count/cleanup. Live execution and commit-conflict probing remain manual unless enabled in the runner. |
|
||||
| Trino Iceberg REST catalog | Manual/live harness | Catalog properties and a read-only `SELECT COUNT(*)` against a PyIceberg- or Spark-created table. Write compatibility not claimed. |
|
||||
| DuckDB Iceberg 1.5.5 | Automated | `duckdb_smoke.py` covers metadata-location read, single-table create/insert/update/delete/merge, schema evolution, snapshots, concurrent writers, drop, PyIceberg cross-read, and both signing profiles. Purge-on-drop and format v3 are verified fail-closed. Two-table mode runs without claiming cross-table atomicity. AWS `ENDPOINT_TYPE S3_TABLES`, staged-create client integration, and vended-credential integration are not claimed. |
|
||||
@@ -51,7 +51,7 @@ RustFS S3 Tables is an Iceberg REST Catalog and table-bucket implementation on t
|
||||
| Area | Status | Claim |
|
||||
|---|---|---|
|
||||
| Live conformance evidence | Automated for PyIceberg and DuckDB | `engine_compatibility.py --print-live-evidence-schema` defines the evidence schema and promotion boundaries; both smoke scripts write validated evidence records via `--live-evidence-output`. |
|
||||
| Production operations guide | Generated harness | `engine_compatibility.py --print-operations-guide` records commands, evidence, pass criteria, and fail-closed signals for conformance, object catalog backup/restore, maintenance, recovery, permissions, credential vending, and claim governance. |
|
||||
| Production operations guide | Generated harness | `engine_compatibility.py --print-operations-guide` records commands, evidence, pass criteria, and fail-closed signals for conformance, cutover, maintenance, recovery, permissions, credential vending, and claim governance. |
|
||||
| Vendor compatibility gap audit | Generated harness | `engine_compatibility.py --print-vendor-audit` records provider URLs, path and warehouse shapes, auth models, validation categories, and not-claimed boundaries for the four vendor profiles. |
|
||||
| Client claim promotion | Automated for scoped clients | PyIceberg and DuckDB claims are bounded by their smoke entrypoints and recorded versions; Spark needs recorded live evidence; Trino stays read-only; Snowflake and vendor profiles stay reference-only. |
|
||||
|
||||
@@ -59,8 +59,8 @@ RustFS S3 Tables is an Iceberg REST Catalog and table-bucket implementation on t
|
||||
|
||||
| Area | Status | Covered behavior |
|
||||
|---|---|---|
|
||||
| Catalog config | Supported | `GET /v1/config` advertises defaults and only the supported OpenAPI REST paths in `endpoints`; RustFS extensions (administration, maintenance, backup/restore, diagnostics, refs, metadata-location) are not presented as standard endpoints. |
|
||||
| Table bucket discovery | Supported | `PUT` / `GET /v1/buckets/{warehouse}` enable and inspect table bucket state. `DELETE` disables an empty catalog while preserving objects; discovery includes `disable-supported`. Namespaces, retained resources, staged metadata, and publication fences prevent disablement. |
|
||||
| Catalog config | Supported | `GET /v1/config` advertises defaults and only the supported OpenAPI REST paths in `endpoints`; RustFS extensions (administration, maintenance, migration, diagnostics, refs, metadata-location) are not presented as standard endpoints. |
|
||||
| Table bucket discovery | Supported | `PUT` / `GET /v1/buckets/{warehouse}` enable and inspect table bucket state. `DELETE` disables an empty catalog while preserving objects; discovery includes `disable-supported`. Namespaces, retained resources, staged metadata, and migration fences prevent disablement. |
|
||||
| Namespaces | Supported | Create, list, load, exists, drop on both prefixes; `pageSize`/`pageToken` pagination with context-bound tokens; identifiers limited to 512 ASCII characters. |
|
||||
| Tables | Supported | Direct and staged create, register, list, load, exists, rename, commit, metadata-location get/update, and drop on both prefixes. Staged create is stateless until an `assert-create` commit atomically publishes the initial metadata and table entry. Rename uses a bucket-scoped persistent fence, recoverable intent, and conditional publication; the source name is reusable only via an ETag-conditional tombstone replacement. Commit identifiers must match the URL; unknown requirements/updates fail as bad requests; register overwrite, purge-on-drop, and v3-only encryption-key updates return an explicit unsupported-operation response. |
|
||||
| Commit CAS | Supported | Single-table commits validate base metadata, version token, referenced object existence, warehouse scope, and Iceberg requirements before advancing the pointer; external metadata transitions preserve monotonic assignment watermarks and immutable retained definitions. `idempotency-key-lifetime` is not advertised; mutation-wide `Idempotency-Key` semantics are unsupported. |
|
||||
@@ -68,16 +68,12 @@ RustFS S3 Tables is an Iceberg REST Catalog and table-bucket implementation on t
|
||||
| Snapshot refs | Supported | List, create/replace, delete via commits; `main` is protected; refs with explicit retention need forced delete. |
|
||||
| Iceberg views | Supported | Create, list, load, replace, exists, drop with view-scoped authorization; only view format version 1. |
|
||||
| LoadTable and table credentials endpoint | Supported | Vending only on negotiated `vended-credentials`; one temporary session scoped to the warehouse prefix and current metadata location; missing credential permission falls back to metadata-only with an explicit reason; vended storage sessions cannot authenticate Catalog requests; responses carry `Cache-Control: no-store, private`. |
|
||||
| Catalog diagnostics and export | Supported | Object catalog state exposes recovery, consistency, commit-log, idempotency, maintenance, single-active-writer policy, and scale validation information. |
|
||||
| Catalog backup and restore | Preview / controlled | `POST /iceberg/v1/{warehouse}/catalog/backup` creates object-catalog artifact v2 with catalog/current table metadata and an inventory of current/direct `metadata-log` history, current view metadata, manifest lists/manifests, live data/delete files, and table/partition statistics. References up to 16 MiB use size/SHA-256; larger references require the captured size/ETag. Proven superseded requests retain their original staged records and any idempotency indexes with their winning history; missing or contradictory proof blocks backup and restore. External payloads are not packaged. `POST /iceberg/v1/{warehouse}/catalog/restore` applies objects conditionally; keep the target closed to clients until restore and recovery verification finish. Per-object CAS does not establish bucket-wide atomic publication or crash isolation. |
|
||||
| Catalog backup artifact transfer | Preview / controlled | `POST /iceberg/v1/{warehouse}/catalog/backup/export` takes strict `{"backup-id":"..."}` JSON and returns saved artifact bytes; `POST /iceberg/v1/{warehouse}/catalog/backup/import` accepts the raw artifact. Artifact transfer is limited to 64 MiB and does not publish catalog or prepare external objects. Existing object-catalog v1 bytes and their legacy catalog/current-table-metadata contract remain unchanged. |
|
||||
| Catalog backup object preparation | Preview / controlled | `POST /iceberg/v1/{warehouse}/catalog/backup/prepare` takes strict `{"backup-id":"...","object":"...","data-base64":"..."}` with standard padded Base64, up to 16 MiB decoded and 24 MiB JSON. It conditionally creates one v2-listed object within its validated table/view scope, returning `PREPARED` or `ALREADY_PRESENT`; identical bytes are idempotent and different existing bytes are never overwritten. Preparation does not publish catalog state. |
|
||||
| Catalog diagnostics and export | Supported | Object-backed and durable-strong stores expose recovery state, consistency, backing manifest, WAL state, migration target, single-active-writer policy, and scale validation matrix. Durable-strong responses also identify the snapshot path, ETag, and format version; diagnostics re-check the snapshot observation before returning and use zero-file retention until strong maintenance configuration is persisted. |
|
||||
| Durable catalog backup and restore | Preview / controlled | Durable-strong only. `POST /iceberg/v1/{warehouse}/catalog/backup` seals a table-bucket snapshot behind the publication and migration fences, records catalog/object watermarks, and stores an immutable backup artifact. `POST /iceberg/v1/{warehouse}/catalog/restore` verifies those watermarks, requires an explicit replacement decision for an existing target, applies the catalog snapshot with ETag-CAS, and leaves a recoverable restore intent if maintenance-state finalization fails. It does not copy data files or claim automatic cross-region failover. |
|
||||
| Catalog import and rollback | Supported | Import/register and online rollback go through validation and commit paths. Online rollback accepts only forward-safe targets; restoring an older target that lowers watermarks is an offline disaster-recovery operation with all writers stopped. |
|
||||
| External catalog bridge | Supported operator path | Operator-supplied metadata pointer sync/import. Vendor SDK polling and policy mirroring not claimed. |
|
||||
| Multi-table transactions | Not claimed | Single-table commit atomicity only. |
|
||||
|
||||
Backup extensions require a table-enabled warehouse and `admin:MigrateTableCatalog`; export, import, and prepare also accept `/_iceberg/v1`. Restore and disaster-recovery rollback require all writers and maintenance workers stopped and the target closed to clients until recovery verification finishes. Every serving/background node must understand persistent restore controls; otherwise keep those nodes/workers out of the target service until then. `RUSTFS_TABLE_CATALOG_PUBLICATION_FENCE_FLEET_CONFIRMED=true` confirms publication-fence deployment, not restore-control version compatibility; no restore isolation guarantee is claimed for a mixed old/new fleet.
|
||||
|
||||
## Data Plane And Credential Matrix
|
||||
|
||||
| Area | Status | Covered behavior |
|
||||
@@ -99,30 +95,27 @@ their warehouse prefixes.
|
||||
|
||||
## Maintenance Matrix
|
||||
|
||||
The object catalog supports the configuration, scheduler, worker, job
|
||||
inspection, heartbeat, and quarantine endpoints. Recoverable job and
|
||||
configuration records remain separate objects. The worker performs metadata and
|
||||
unreferenced-object cleanup without changing the catalog pointer. The direct
|
||||
`/maintenance/metadata` endpoint supports safe planning; snapshot expiration
|
||||
and compaction commits remain explicit controlled operations. A configured
|
||||
Object-backed and durable-strong catalogs support the configuration, scheduler,
|
||||
worker, job inspection, heartbeat, and quarantine endpoints. Durable-strong
|
||||
maintenance resolves table identity from the authoritative catalog snapshot;
|
||||
recoverable job and configuration records remain separate objects. The worker
|
||||
performs metadata and unreferenced-object cleanup without changing the catalog
|
||||
pointer. The direct `/maintenance/metadata` endpoint, including snapshot
|
||||
expiration and compaction plan/commit, remains object-backed only. A configured
|
||||
`background-enabled` table still requires explicit worker ticks. The standalone
|
||||
server has opt-in, allowlisted periodic queue admission; see the
|
||||
[scheduler runbook](../operations/s3-tables-maintenance-scheduler.md).
|
||||
|
||||
Renamed tables retain their original metadata paths. Object catalog scheduling,
|
||||
planning, and cleanup fail closed with a conflict if another table shares a scanned
|
||||
metadata or warehouse directory, including a recreated source name after rename.
|
||||
The object backing rechecks this ownership inventory under the bucket publication
|
||||
fence before every delete pass; the inventory reads every table entry in the bucket,
|
||||
so maintenance cost grows with the table count. Such tables require disjoint cleanup
|
||||
roots before maintenance can run; enabling deletion does not override this ownership
|
||||
check.
|
||||
Renamed tables retain their original metadata paths. Scheduling, planning,
|
||||
and cleanup on both backings fail closed with a conflict if another table
|
||||
shares a scanned metadata or warehouse directory, including a recreated source
|
||||
name after rename. The object backing rechecks this ownership inventory under
|
||||
the bucket publication fence before every delete pass; the inventory reads every
|
||||
table entry in the bucket, so maintenance cost grows with the table count. Such
|
||||
tables require disjoint cleanup roots before maintenance can run; enabling
|
||||
deletion does not override this ownership check.
|
||||
|
||||
Object catalog rename uses a persisted intent and publication fences. Recovery of an
|
||||
interrupted rename and recovery of a partially applied catalog restore are separate
|
||||
contracts; a successful rename test does not establish restore crash isolation.
|
||||
|
||||
Object-backed create, register, and commit publication share one preparation deadline, `RUSTFS_TABLE_CATALOG_PUBLICATION_PREPARATION_TIMEOUT_SECS` (default 30, never below the object lock-acquire timeout, capped at 86,400). Migration and bucket-lock queueing, reference HEAD validation, ownership inventories, metadata parsing, and snapshot preparation consume that same interval; repeated preparation does not renew it. A create writes its initial metadata file before registration without ending the deadline; when registration then fails before any catalog write may have begun, including on expiry, the handler removes that file, so the worst outcome of an expired create is a small orphan under a root no table owns, left by a crash or failed delete between the write and the removal. Expiry before a possible durable catalog write returns HTTP 503 and releases the preparation locks; a valid large operation that cannot finish within the interval keeps failing on retry until the interval is raised. Once a catalog write may have begun, this deadline no longer cancels that transaction. Individual PUT completion and persisted commit/rename recovery retain their existing cancellation guarantees. This is a preparation limit, not a hard bound on disk I/O or the durable tail. A rename that the client abandons mid-flight completes or recovers on a detached task, so the bucket's `active_rename_id` is always cleared.
|
||||
Object-backed create, register, and commit publication share one preparation deadline, `RUSTFS_TABLE_CATALOG_PUBLICATION_PREPARATION_TIMEOUT_SECS` (default 30, never below the object lock-acquire timeout, capped at 86,400). Migration and bucket-lock queueing, reference HEAD validation, ownership inventories, metadata parsing, and snapshot preparation consume that same interval; repeated preparation does not renew it. A create writes its initial metadata file before registration without ending the deadline; when registration then fails before any catalog write may have begun, including on expiry, the handler removes that file, so the worst outcome of an expired create is a small orphan under a root no table owns, left by a crash or failed delete between the write and the removal. Expiry before a possible durable catalog write returns HTTP 503 and releases the preparation locks; a valid large operation that cannot finish within the interval keeps failing on retry until the interval is raised. Once a catalog write may have begun, this deadline no longer cancels that transaction. Individual PUT completion and persisted commit/rename recovery retain their existing cancellation guarantees. This is a preparation limit, not a hard bound on disk I/O or the durable tail. The durable-strong backing does not implement this deadline; it is being retired. A rename that the client abandons mid-flight completes or recovers on a detached task, so the bucket's `active_rename_id` is always cleared.
|
||||
|
||||
Compaction commits hold inputs to a 512 MiB stored and decoded budget per rewrite group, validate the footer (including the row-group count the decoder would reserve for) and every page header before decoding a page (a recursive or over-deep Iceberg manifest Avro schema and a Parquet page that exceeds its budget are refused with HTTP 400), and run one compaction per node at a time; a concurrent request receives HTTP 503. The planner packs each rewrite group to the smaller of `max-rewrite-bytes-per-job` and that 512 MiB stored-input ceiling, so a larger configured value is accepted but yields several groups; a group whose stored inputs still exceed the ceiling at commit time (for example a plan produced by an older release) is refused with HTTP 400 naming the ceiling before any group's output is written (every group of the plan is checked first).
|
||||
|
||||
@@ -130,9 +123,27 @@ Object-backed commit publication identifies every catalog object it validated by
|
||||
|
||||
### Table-entry directory
|
||||
|
||||
An optional per-bucket directory of table entries under `.rustfs.sys` answers data-plane index-miss lookups without listing the catalog prefix. It is off by default: `RUSTFS_TABLE_CATALOG_DIRECTORY_INDEX=true` and `RUSTFS_TABLE_CATALOG_DIRECTORY_INDEX_FLEET_CONFIRMED=true` on every node, then `POST /iceberg/v1/{warehouse}/catalog/directory` (`admin:MigrateTableCatalog`) advances a backfill of 128 catalog objects per call until the directory reports `Ready`; `GET` reports the phase and `DELETE` rolls the directory back. Entry writers add a directory candidate only while the directory exists, and the backfill covers earlier entries. The directory state occupies the backing-migration fence object: nodes without this feature answer catalog mutations on that bucket with a parse error until they are upgraded, which is what the fleet-confirmed flag attests, and restores require disabling the directory first. Object catalog backups exclude the derived directory state and candidates. Re-enable the directory after a restore to rebuild it from the restored entries.
|
||||
An optional per-bucket directory of table entries under `.rustfs.sys` answers data-plane index-miss lookups without listing the catalog prefix. It is off by default: `RUSTFS_TABLE_CATALOG_DIRECTORY_INDEX=true` and `RUSTFS_TABLE_CATALOG_DIRECTORY_INDEX_FLEET_CONFIRMED=true` on every node, then `POST /iceberg/v1/{warehouse}/catalog/directory` (`admin:MigrateTableCatalog`) advances a backfill of 128 catalog objects per call until the directory reports `Ready`; `GET` reports the phase and `DELETE` rolls the directory back. Entry writers add a directory candidate only while the directory exists, and the backfill covers earlier entries. The directory state occupies the backing-migration fence object: nodes without this feature answer catalog mutations on that bucket with a parse error until they are upgraded, which is what the fleet-confirmed flag attests, and a backing migration is refused with a conflict while the directory is active.
|
||||
|
||||
|
||||
Durable-strong rename preserves maintenance configuration, job identifiers,
|
||||
current/latest aliases, history, audit events, and quarantine state. A persisted
|
||||
rename intent protects sidecar migration across interruption: the source remains
|
||||
authoritative until the catalog CAS succeeds, and the destination records are
|
||||
ready before publication. Retry the same rename to finish pending recovery.
|
||||
Backup, restore, register, drop, and subsequent rename operations recover a
|
||||
pending migration before proceeding. Complete pending rename recovery before
|
||||
rolling back to a version that does not understand maintenance migration intents.
|
||||
|
||||
Durable-strong scheduler reports read an observational history set, not an atomic
|
||||
snapshot of all maintenance jobs. They fix at most 4096 history-object names
|
||||
under the publication read fence, scan those objects outside the fence, and
|
||||
refresh the selected 10-job audit window, effective configuration, and current
|
||||
job under a final read fence. Exceeding the history budget fails closed with an
|
||||
unavailable response; retrying does not remove that size limit. A listed object
|
||||
that disappears during the scan also returns unavailable; retry after concurrent
|
||||
rename or maintenance activity has settled. No history object is silently omitted
|
||||
when a rename removes its old path.
|
||||
|
||||
| Capability | Status | Claim |
|
||||
|---|---|---|
|
||||
@@ -153,7 +164,7 @@ An optional per-bucket directory of table entries under `.rustfs.sys` answers da
|
||||
| Built-in periodic scheduler | Preview / queue-only | Default off; allowlisted, paged admission with jitter, per-pass quotas, current-job checks, and cooperative drain. Workers and failed/expired-job recovery remain operator-triggered; no automatic execution or hard per-table I/O deadline. |
|
||||
| Delete-file or row-level compaction execution | Not claimed | Manual-review maintenance item. |
|
||||
|
||||
## Recovery And Object Backing Matrix
|
||||
## Recovery And Strong Backing Matrix
|
||||
|
||||
| Area | Status | Claim |
|
||||
|---|---|---|
|
||||
@@ -161,21 +172,26 @@ An optional per-bucket directory of table entries under `.rustfs.sys` answers da
|
||||
| Idempotent retry | Supported | Repeated commit IDs return the finalized result or surface recoverable finalization gaps. |
|
||||
| Commit publication fencing | Supported with rolling-upgrade gate | Exact object guards protect referenced files during publication. Set `RUSTFS_TABLE_CATALOG_PUBLICATION_FENCE_FLEET_CONFIRMED=true` only after every serving node supports table and table-bucket fences. In scalable mode, warehouse prefixes must not overlap and enablement, first publication, drop, and relocation are serialized by the table-bucket fence. |
|
||||
| Post-CAS finalization recovery | Supported | Repairs stale or missing idempotency indexes without changing the pointer. |
|
||||
| Catalog export | Supported | Table state, current metadata pointer, commit recovery state, idempotency state, maintenance state, and object catalog manifest. |
|
||||
| Disaster recovery rehearsal | Manual/live harness | `failure_coverage.py --print-disaster-recovery-rehearsal`; controlled object catalog backup/restore requires referenced table objects to remain available and does not provide cross-region object replication. |
|
||||
| Catalog export | Supported | Table state, commit recovery state, and backing migration information. Durable-strong export is sourced from the linearizable snapshot rather than object marker files and includes the snapshot identity needed for a later backup operation. |
|
||||
| Strong backing state transfer | Supported | Object-backed catalog state is materialized into the durable strong snapshot deterministically, ETag-CAS protected, idempotent after interrupted finalization, and validated through the restart decoder before publication; conflicts between inactive explicit namespaces and active descendants fail closed. Hydration requires a stable non-empty ETag, caps the snapshot at 64 MiB, and rejects disappearance or format-version rollback after observation. Configured durable-strong mode rejects a missing snapshot on first access; only object-backed migration may initialize an empty target. |
|
||||
| Durable backing migration preflight | Supported | `GET /iceberg/v1/{warehouse}/catalog/migration` (and the alias) reports inventory, recovery blockers, prefix-index readiness, identifier collisions, fence state, target agreement, and per-bucket cutover readiness. |
|
||||
| Durable backing migration execution | Preview / controlled | `POST /iceberg/v1/{warehouse}/catalog/migration` fences registry changes, acquires a persistent per-bucket write fence, drains in-flight mutations, materializes the snapshot, and reports `ready_to_enable_durable_strong`. `DELETE` cancels only while the target has not advanced. Both mutations require `admin:MigrateTableCatalog`. Procedure: [s3-tables-cutover-runbook.md](../operations/s3-tables-cutover-runbook.md). |
|
||||
| Strong snapshot rolling compatibility | Supported | Reads snapshot versions 1 and 2; writes version 1 by default and version 2 only after both `RUSTFS_TABLE_CATALOG_STRONG_SNAPSHOT_V2` and `RUSTFS_TABLE_CATALOG_STRONG_SNAPSHOT_V2_FLEET_CONFIRMED` are set. A process rejects a lower format after observing a higher one; once v2 is fleet-confirmed, data-plane resolution fails closed until the persisted snapshot is v2. |
|
||||
| Disaster recovery rehearsal | Manual/live harness | `failure_coverage.py --print-disaster-recovery-rehearsal`; the controlled catalog backup/restore path additionally requires referenced table objects to remain available and does not provide cross-region object replication. |
|
||||
| Scale and fault rehearsal | Manual/live harness | `failure_coverage.py --print-scale-fault-rehearsal`. |
|
||||
| Durable strong snapshot backing cutover | Preview / controlled | `RUSTFS_TABLE_CATALOG_BACKING=durable-strong` only after every table bucket reports `SNAPSHOT_MATERIALIZED` and `ready_to_enable_durable_strong: true`. No separate external KV/WAL service is claimed; the legacy `STRONG_KV_WAL` and `CUT_OVER_LINEARIZABLE_READS` labels in v1 manifests are wire-compatibility labels, not claims. |
|
||||
| Single active writer region | Supported policy | Diagnostics publish single-active-writer semantics and read-only replica limits. |
|
||||
| Active-active multi-region writes | Not claimed | A table must not accept independent concurrent writers in multiple regions. |
|
||||
|
||||
## Production Failure Coverage
|
||||
|
||||
Failure probes prove RustFS does not silently advance table state on failure. Tracked cases: stale commit token or base metadata returns a conflict without advancing the pointer; missing metadata, manifest, data, or delete objects fail closed before commit, backup, restore, or maintenance; concurrent writers produce one CAS winner and retryable conflicts; catalog and S3 permission denials prevent data-plane bypass; stale maintenance plans fail closed before deletion or commit; post-CAS finalization gaps are visible and safely recoverable; external catalog sync conflicts leave pointer, token, and generation unchanged; object backup/restore stays blocked until recovery and referenced-object validation are clean.
|
||||
Failure probes prove RustFS does not silently advance table state on failure. Tracked cases: stale commit token or base metadata returns a conflict without advancing the pointer; missing metadata, manifest, data, or delete objects fail closed before commit or maintenance; concurrent writers produce one CAS winner and retryable conflicts; catalog and S3 permission denials prevent data-plane bypass; stale maintenance plans fail closed before deletion or commit; post-CAS finalization gaps are visible and safely recoverable; external catalog sync conflicts leave pointer, token, and generation unchanged; backing migration stays blocked until WAL and recovery replay are clean.
|
||||
|
||||
Do not promote a failure case from live probe or load test to an automated claim until the exact RustFS build, client version, and expected response shape are recorded.
|
||||
|
||||
## Unsupported Or Not Claimed
|
||||
|
||||
Full AWS S3 Tables control-plane parity; full MinIO AIStor private extensions; full Cloudflare R2 Data Catalog or Alibaba OSS Tables interoperability; automatic maintenance execution and failed/expired-job recovery; active-active multi-region writes; multi-table transactions; no-long-term-data-credential bootstrap; online vendor SDK polling; external catalog policy mirroring; delete-file rewrite or row-level compaction execution; built-in SQL execution; Delta Lake or Hudi; end-to-end SQL row-level DML validation through Spark or Trino. DuckDB single-table UPDATE/DELETE/MERGE has its own automated smoke coverage as listed above; this does not establish other engines' DML compatibility.
|
||||
Full AWS S3 Tables control-plane parity; full MinIO AIStor private extensions; full Cloudflare R2 Data Catalog or Alibaba OSS Tables interoperability; automatic maintenance execution and failed/expired-job recovery; durable-strong snapshot-expiration and compaction plan/commit; active-active multi-region writes; multi-table transactions; no-long-term-data-credential bootstrap; online vendor SDK polling; external catalog policy mirroring; delete-file rewrite or row-level compaction execution; built-in SQL execution; Delta Lake or Hudi; end-to-end SQL row-level DML validation through Spark or Trino. DuckDB single-table UPDATE/DELETE/MERGE has its own automated smoke coverage as listed above; this does not establish other engines' DML compatibility.
|
||||
|
||||
## Verification
|
||||
|
||||
@@ -192,5 +208,6 @@ Any stronger vendor or engine claim needs a repeatable live harness, the exact c
|
||||
## Related
|
||||
|
||||
- [Table catalog conformance scripts](../../scripts/table-catalog/README.md)
|
||||
- [Durable backing cutover runbook](../operations/s3-tables-cutover-runbook.md)
|
||||
- [Admin route action snapshot](admin-route-action-snapshot.md)
|
||||
- [Runtime capability contracts](runtime-capability-contracts.md)
|
||||
|
||||
@@ -61,7 +61,7 @@ The `object_namespace_lock` event covers store GET/read and write acquisition, s
|
||||
|
||||
The diagnostic retains the parent tracing span available at acquisition. When an HTTP request span carries `request_id`, guard events retain that parent even if the guard moves into a background PUT commit tail. Heal events retain the available task span. Missing parent fields must not be reconstructed from adjacent log lines.
|
||||
|
||||
Use `read_repair_data`, `read_repair_commit`, and `heal_object` to distinguish shared read-repair reconstruction, its exclusive revalidation/rename phase, and ordinary exclusive object healing. Application PUTs use `TailDrained` completion and await rename fan-out before returning success. Completion can succeed at write quorum with minority failures routed to repair. Internal quorum-completion callers may acknowledge before their rename tail and lock lifetime end.
|
||||
Use `read_repair_data`, `read_repair_commit`, and `heal_object` to distinguish shared read-repair reconstruction, its exclusive revalidation/rename phase, and ordinary exclusive object healing. A PUT quorum ACK can precede the end of its rename tail and lock lifetime.
|
||||
|
||||
## Distinguish the waiting chains
|
||||
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
# S3 Tables Catalog Lifecycle
|
||||
|
||||
**Use this when:** disabling an object-backed table catalog, cleaning up metadata left by deleted empty tables, or diagnosing catalog registration reads.
|
||||
**Source of truth:** `rustfs/src/admin/handlers/table_catalog/config.rs`, `rustfs/src/table_catalog/store/cleanup.rs`, and `rustfs/src/table_catalog/store/registration_cache.rs`.
|
||||
|
||||
## Disable A Table Catalog
|
||||
|
||||
Use `GET /iceberg/v1/buckets/{warehouse}` to inspect the table-bucket configuration. A signed `DELETE /iceberg/v1/buckets/{warehouse}` disables an empty catalog with `admin:SetTableBucket`; the `/_iceberg/v1` alias accepts the same request. Ordinary disablement and re-enablement preserve table metadata and object data.
|
||||
|
||||
Delete tables and namespaces through the catalog APIs before disabling. Active namespaces, retained catalog resources, active renames, and unfinished recovery operations block disablement. Do not manually delete internal metadata to bypass these checks. Review the bucket lifecycle configuration: disabling table protection allows existing object expiration rules to apply again.
|
||||
|
||||
The server persists an inactive catalog entry before clearing the bucket marker. If marker publication fails, retry the same DELETE; object protection remains until publication succeeds. A subsequent PUT explicitly enables the bucket again, while stale requests cannot reactivate an inactive entry. Re-enable disabled catalogs before rolling back to a version that does not recognize inactive entries.
|
||||
|
||||
## Clean Up Deleted Empty Tables
|
||||
|
||||
`DELETE /iceberg/v1/buckets/{warehouse}?cleanup=true` removes recognized metadata and internal records left by deleted empty tables, then disables the catalog. Ordinary table deletion continues to preserve files. Cleanup preserves the existing table-record formats and accepts eligible empty tables deleted before the server upgrade.
|
||||
|
||||
Complete the upgrade across all serving nodes and set `RUSTFS_TABLE_CATALOG_PUBLICATION_FENCE_FLEET_CONFIRMED=true` before cleanup. Delete the empty tables and namespaces through catalog APIs. The cleanup principal needs `admin:SetTableBucket` and `s3:GetObject`/`s3:DeleteObject` permissions for the target metadata objects. Omitting `cleanup` or setting it to `false` keeps ordinary disablement; repeated or invalid values are rejected.
|
||||
|
||||
Cleanup accepts only recognized empty-table metadata in the default managed warehouse. Active resources, snapshots and other data references, user objects, object versions, incomplete multipart uploads, corrupt or unknown metadata, and unfinished catalog operations block cleanup. The server validates the complete plan and all object permissions before deletion. Persisted restore barriers and legacy catalog control state also block cleanup until recovery resolves them.
|
||||
|
||||
If a storage operation fails, retry the same request. The server checks remaining objects again and retains table-bucket protection until cleanup and catalog disablement complete. It does not create a separate cleanup task file. After a successful response with `enabled: false`, delete the empty bucket through the normal S3 `DeleteBucket` operation.
|
||||
|
||||
## Registration Reads
|
||||
|
||||
Registration checks table-ID uniqueness and warehouse-directory overlap using existing catalog and warehouse-index records. Each registration obtains a complete authoritative inventory under the publication and catalog control guards. Inventory records must satisfy the same metadata commit checks as ordinary catalog reads; an incomplete or failed inventory rejects registration.
|
||||
|
||||
Each server keeps a bounded memory cache of validated ownership records. Reuse requires the same object identity and ETag in the current inventory. New or changed records are read and validated again; eviction and restarts cause additional reads. The cache is automatic, requires no configuration or new stored objects, and is isolated by application context.
|
||||
|
||||
Registration still enumerates namespace and warehouse-index prefixes, so enumeration grows with catalog size. Cache hits reduce object-body reads and JSON parsing. A hit reuses previously validated content without reading the current body again to prove physical readability. Conditional writes, rollback, and lock-loss fencing continue to control publication; the cache does not synchronize writers that bypass those guards.
|
||||
|
||||
Existing catalog, Iceberg metadata, and Console/client request formats remain unchanged. See the [S3 Tables support matrix](../architecture/s3-tables-support-matrix.md) for supported API boundaries.
|
||||
@@ -0,0 +1,116 @@
|
||||
# S3 Tables Durable Backing Cutover Runbook
|
||||
|
||||
**Use this when:** moving a table-catalog warehouse from object-backed catalog state to the durable strong snapshot backing (`RUSTFS_TABLE_CATALOG_BACKING=durable-strong`), or rolling the strong snapshot format from version 1 to version 2.
|
||||
**Source of truth:** the `{warehouse}/catalog/migration` routes registered in `rustfs/src/admin/handlers/table_catalog/routes.rs`; the env constants named below; claims and status labels in [docs/architecture/s3-tables-support-matrix.md](../architecture/s3-tables-support-matrix.md).
|
||||
|
||||
## Preconditions
|
||||
|
||||
| Requirement | Why |
|
||||
|---|---|
|
||||
| A principal with `GetTableCatalogAction` on each table bucket (preflight) and `admin:MigrateTableCatalog` (migration `POST` / `DELETE`). | The mutations are admin-gated. |
|
||||
| Every catalog writer runs a release that recognizes the durable-backing migration fence. | An older writer does not see the persisted fence and can mutate the object-backed source after the snapshot inventory is captured. |
|
||||
| An object-backed catalog backup, plus the current metadata pointer and version token for representative tables. | Recovery after a failed cutover is an operator-selected restore, not a restart against the stale pointer. |
|
||||
| Every mutating object-only operation (maintenance workers, catalog recovery, export, diagnostics, external catalog bridge writes) is inventoried and confirmed supported in durable-strong mode. | Unsupported operations fail closed after cutover rather than continuing against object-backed state. |
|
||||
|
||||
## Cutover Procedure
|
||||
|
||||
1. Take the object-backed backup and record pointer and version token for representative tables.
|
||||
2. Run the preflight for each warehouse and treat every `blockers` entry as fail-closed. Repair commit recovery state and backfill the warehouse prefix index before continuing. Requests are SigV4-signed with the catalog's REST signing name; the `/_iceberg/v1` alias accepts the same paths.
|
||||
|
||||
```text
|
||||
GET /iceberg/v1/{warehouse}/catalog/migration
|
||||
```
|
||||
3. Drain every catalog writer that predates the migration fence and restart it on a fence-aware release. Keep all writers on that release until cutover completes.
|
||||
4. Quiesce mutating object-only operations (step 4 of Preconditions).
|
||||
5. Run the migration `POST` with `admin:MigrateTableCatalog`. It acquires the exclusive migration fence to drain in-flight fence-aware mutations, persists the source fence while exclusivity is held, then copies catalog state and reports `ready_to_enable_durable_strong`.
|
||||
|
||||
```text
|
||||
POST /iceberg/v1/{warehouse}/catalog/migration
|
||||
```
|
||||
|
||||
6. Repeat preflight and materialization for every table bucket. Do not proceed until the preflight reports `SNAPSHOT_MATERIALIZED`, no blockers, and `ready_to_enable_durable_strong: true` for all of them.
|
||||
7. Restart with `RUSTFS_TABLE_CATALOG_BACKING=durable-strong`, then verify catalog config, table and view loads, commit idempotency, and table data-plane policy resolution before admitting writers.
|
||||
8. Preserve the object-backed backup until durable strong backing has passed the operator's retention window.
|
||||
|
||||
## Cancelling Before Cutover
|
||||
|
||||
Before the restart in step 7, `DELETE` on the migration endpoint removes a migration-created target bucket snapshot and releases the source fence. It releases the bucket fence only while the target state has not advanced, and releases the registry fence after the last bucket is cancelled. Retries and `DELETE` may restore a known-absent initial target after an ambiguous first write, but fail closed if a previously existing or materialized global snapshot disappears.
|
||||
|
||||
```text
|
||||
DELETE /iceberg/v1/{warehouse}/catalog/migration
|
||||
```
|
||||
|
||||
After the durable-strong state advances, cancellation fails closed; recovery requires an operator-selected restore or reverse migration.
|
||||
|
||||
## Controlled Catalog Backup And Restore
|
||||
|
||||
The durable catalog backup and restore endpoints are a controlled, same-table-bucket recovery mechanism. They are available only with `RUSTFS_TABLE_CATALOG_BACKING=durable-strong`; they protect the catalog snapshot and maintenance state, but do not copy or replicate table data, metadata, manifest, or delete objects.
|
||||
|
||||
Backup artifacts and restore intents use a strict internal format version. A binary rejects artifacts or pending intents from another format version; create a new backup after upgrading instead of assuming cross-version restore compatibility.
|
||||
|
||||
1. Stop or drain catalog writers and maintenance workers for the table bucket. The backup operation acquires the table-bucket publication fence and the durable migration fence, rejects pending commit recovery and pending restore recovery, rejects active maintenance leases, and records the current snapshot ETag, format version, catalog fingerprint, and referenced object watermarks.
|
||||
2. Create a backup with a principal authorized for `MigrateTableCatalogAction`. Backup creation persists an immutable recovery artifact and is therefore not covered by read-only catalog permission. The optional `expected-snapshot-etag` provides an additional compare-and-capture guard.
|
||||
|
||||
```text
|
||||
POST /iceberg/v1/{warehouse}/catalog/backup
|
||||
{"expected-snapshot-etag":"<current-etag>"}
|
||||
```
|
||||
|
||||
3. Keep every referenced table object available for the retention period. A successful backup is immutable and idempotent by content-derived backup ID; it is not a copy of those objects and cannot restore an object that was deleted or changed after capture.
|
||||
4. Before restoring, stop writers and maintenance workers again. Verify the target table bucket is still table-enabled, obtain its current snapshot ETag, and use `expected-snapshot-etag` whenever replacing an existing catalog. `allow-replace` must be explicitly `true` to replace a non-identical existing bucket snapshot.
|
||||
|
||||
```text
|
||||
POST /iceberg/v1/{warehouse}/catalog/restore
|
||||
{"backup-id":"<backup-id>","expected-snapshot-etag":"<current-etag>","allow-replace":true}
|
||||
```
|
||||
|
||||
5. Treat a restore conflict as a stale-target or changed-object condition, not as permission to retry blindly. The service verifies all recorded object watermarks before applying an ETag-CAS snapshot replacement. If the process fails after catalog replacement, retrying the same backup ID is safe only while maintenance state is exactly the persisted source state or already exactly the backup target state. A partial multi-object reconciliation fails closed with a conflict and requires operator inspection before manual cleanup.
|
||||
|
||||
This procedure is not cross-region failover. Cross-region recovery requires an independent object replication/backup system and an operator-selected catalog import or restore procedure.
|
||||
|
||||
## Strong Snapshot Version 1 to Version 2
|
||||
|
||||
1. Keep snapshot writes on version 1 during a rolling binary upgrade. Current binaries read both versions.
|
||||
2. After every catalog writer can read version 2, set both `RUSTFS_TABLE_CATALOG_STRONG_SNAPSHOT_V2=true` and `RUSTFS_TABLE_CATALOG_STRONG_SNAPSHOT_V2_FLEET_CONFIRMED=true` and restart the catalog writers. Setting only one gate does not change the write format.
|
||||
3. Perform a controlled catalog write or migration materialization and confirm the persisted snapshot is version 2 before serving table data-plane traffic. Once v2 is fleet-confirmed, data-plane resolution fails closed until the persisted snapshot is v2.
|
||||
4. After any version 2 snapshot is persisted, do not roll writers back to a binary that only reads version 1. Current binaries preserve version 2 even when the gates are later disabled.
|
||||
|
||||
## Rollback And Collision Repair Rules
|
||||
|
||||
- A running process rejects restored version 1 content after observing version 2, but cannot distinguish an older snapshot with the same format version from a deliberate restore. The format high-water mark is process-local: restoring any older snapshot and restarting every writer is a privileged disaster-recovery rollback that must restore a compatible binary and an operator-selected snapshot together.
|
||||
- Migration preflight rejects an active table/view identifier collision before writing a migration fence. A pre-existing version 1 strong snapshot with such a collision loads in cleanup-only quarantine: ambiguous reads fail closed, each cleanup mutation must reduce the collision set, and unrelated writes stay blocked until all collisions are removed. Drain writers that predate cleanup quarantine before starting the repair, and finish cleanup before the first version 2 write.
|
||||
|
||||
## Related
|
||||
|
||||
- [S3 Tables support matrix](../architecture/s3-tables-support-matrix.md)
|
||||
- [Table catalog conformance scripts](../../scripts/table-catalog/README.md) (`failure_coverage.py --print-disaster-recovery-rehearsal` generates the rehearsal for this procedure)
|
||||
|
||||
## Disable an Empty Table Catalog
|
||||
|
||||
Use `GET /iceberg/v1/buckets/{warehouse}` to check `enabled` and `disable-supported`. When supported, `DELETE` on the same route requires `admin:SetTableBucket` and returns the bucket discovery response with `enabled: false`. The `/_iceberg/v1` alias behaves identically. Existing enable and query requests remain unchanged.
|
||||
|
||||
Review the bucket lifecycle configuration before disabling: clearing table-bucket protection allows existing object expiration rules to run again. Objects are preserved by the disable operation itself. Catalog disablement requires no namespaces, retained table/view resources, or objects under `.rustfs-table/`; an active rename or backing migration also blocks it. Clean up through supported catalog operations; do not manually delete internal metadata to bypass these checks.
|
||||
|
||||
The server persists an inactive catalog entry before clearing the bucket marker. If marker publication fails, retry the same DELETE; the marker retains object protections until the retry succeeds. A subsequent PUT explicitly enables the bucket again. Stale requests cannot initialize an inactive catalog entry. A plain DELETE and a subsequent PUT preserve table metadata and object data.
|
||||
|
||||
### Clean Up Deleted Empty Tables
|
||||
|
||||
For the object-backed catalog, `DELETE /iceberg/v1/buckets/{warehouse}?cleanup=true` removes the metadata and internal records left by deleted empty tables, then disables the table catalog. Ordinary table deletion continues to preserve files. Cleanup preserves existing table record formats and can process empty tables deleted before the server upgrade.
|
||||
|
||||
Complete the server upgrade across all serving nodes and set the existing `RUSTFS_TABLE_CATALOG_PUBLICATION_FENCE_FLEET_CONFIRMED=true` setting before requesting cleanup. Delete the empty tables and their namespaces through the catalog APIs, then send the cleanup request with `admin:SetTableBucket` and `s3:GetObject`/`s3:DeleteObject` permissions for the target metadata objects. The `/_iceberg/v1` alias accepts the same option. Omitting `cleanup` or setting it to `false` keeps the ordinary disable behavior; repeated or invalid values are rejected.
|
||||
|
||||
Cleanup accepts only recognized empty-table metadata in the default managed warehouse. Active catalog resources, snapshots or other data references, user objects, object versions, incomplete multipart uploads, corrupt or unknown metadata, and unfinished catalog operations block cleanup. The server validates the complete cleanup plan and object permissions before deleting any object. Durable-strong catalogs retain their existing disable procedure.
|
||||
|
||||
If a storage operation fails during cleanup, retry the same request. The server checks the remaining objects again and keeps the bucket's table protection enabled until cleanup and catalog disablement complete. No separate cleanup task file is created. After a successful response with `enabled: false`, delete the empty bucket through the normal S3 `DeleteBucket` operation.
|
||||
|
||||
## Object-Backed Registration Reads
|
||||
|
||||
Table registration checks table ID uniqueness and warehouse directory overlap using the existing catalog and warehouse index records. Each registration obtains a complete inventory under the existing publication and migration guards. System-bucket inventory records must satisfy the same metadata commit checks as ordinary catalog reads. An incomplete or failed inventory rejects registration.
|
||||
|
||||
Each server keeps a bounded memory cache of validated ownership records. A record can be reused only when its object identity and ETag match the current inventory. New or changed records are read and validated again. Cache eviction and process restarts cause additional reads; catalog state continues to come from the existing persisted records. The cache is automatic and requires no additional configuration or stored objects.
|
||||
|
||||
Registration still enumerates the namespace and warehouse index prefixes, so enumeration work grows with catalog size. Cache hits reduce object-body reads and JSON parsing. A cache hit verifies the current metadata identity and reuses previously validated content; it does not re-read the current body to check its physical readability. Conditional writes, rollback, and lock-loss fencing continue to control publication.
|
||||
|
||||
Existing catalog formats and Console and Iceberg client request formats are preserved. Concurrent writers must follow the existing publication, migration, and storage fencing protocol; the memory cache does not provide synchronization for writers that bypass those guards.
|
||||
|
||||
Before rolling back to a server version without this endpoint, re-enable disabled catalogs with PUT while the supporting version is running. Older enable handlers do not reactivate inactive catalog entries. Complete the server upgrade across the cluster before using disablement.
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
**Use this when:** planning table maintenance, enabling automatic job admission, or recovering a stalled queue.
|
||||
|
||||
The server can periodically **queue** maintenance jobs for explicitly selected table buckets. It does not run workers, delete objects, expire snapshots, or compact data automatically. Workers remain an explicit operator action. The object catalog uses the maintenance configuration and job format described below.
|
||||
The server can periodically **queue** maintenance jobs for explicitly selected table buckets. It does not run workers, delete objects, expire snapshots, or compact data automatically. Workers remain an explicit operator action. Both object-backed and durable-strong catalogs use the existing maintenance configuration and job format.
|
||||
|
||||
## Direct Metadata Maintenance
|
||||
## Read-only Metadata Maintenance Planning
|
||||
|
||||
The object catalog accepts authenticated maintenance requests at:
|
||||
Both backings accept authenticated planning requests at:
|
||||
|
||||
```text
|
||||
POST /iceberg/v1/{warehouse}/namespaces/{namespace}/tables/{table}/maintenance/metadata
|
||||
@@ -30,13 +30,13 @@ For example:
|
||||
}
|
||||
```
|
||||
|
||||
`max-rewrite-bytes-per-job` is accepted up to any value at or above `target-file-size-bytes`, but each rewrite group is packed to at most the smaller of that value and the 512 MiB per-group stored-input ceiling that the commit path holds in memory; the 1 GiB example therefore produces groups of at most 512 MiB. The optional snapshot-expiration and compaction fields request plans, not commits. An empty JSON object requests ordinary metadata planning. The request's retention value overrides the configured retention for this invocation. Omission or zero adds no recent-file retention. Existing protections for referenced metadata still apply.
|
||||
`max-rewrite-bytes-per-job` is accepted up to any value at or above `target-file-size-bytes`, but each rewrite group is packed to at most the smaller of that value and the 512 MiB per-group stored-input ceiling that the commit path holds in memory; the 1 GiB example therefore produces groups of at most 512 MiB. The optional snapshot-expiration and compaction fields request plans, not commits. An empty JSON object requests ordinary metadata planning. A nonzero retention value overrides the effective maintenance configuration for this request; omission or zero uses the effective configured retention.
|
||||
|
||||
Successful planning returns HTTP 200 with a completed `DRY_RUN` job. It leaves table data, metadata pointers, and catalog generations unchanged. The endpoint writes named, current, and latest maintenance reports and requires the table-scoped `admin:RunTableMaintenance` permission.
|
||||
In durable-strong mode, successful planning returns HTTP 200 with a completed `DRY_RUN` job and persists its named, current, and latest reports with audit events. Read-only means that table data, metadata pointers, and catalog generations are unchanged; the request still writes maintenance report sidecars and requires the table-scoped `admin:RunTableMaintenance` permission. Inspect the returned plan and any manual-review state before taking further action.
|
||||
|
||||
The same endpoint supports explicit operations with `delete`, `commit-snapshot-expiration`, or `commit-compaction`. Enable at most one of these flags. Metadata deletion requires `delete-enabled`. To commit snapshot expiration or compaction, also supply the corresponding plan configuration.
|
||||
This direct endpoint rejects `delete=true`, `commit-snapshot-expiration=true`, or `commit-compaction=true` with HTTP 400 in durable-strong mode, without publishing a job or changing table objects. The existing object-backed mutation behavior is unchanged. These restrictions do not change the separate explicit maintenance worker or quarantine APIs.
|
||||
|
||||
Before invoking this endpoint, including a dry run, pause scheduler admission and competing maintenance workers, then resolve outstanding jobs, active quarantine, or inconsistent current/latest aliases. The direct endpoint can replace the current and latest reports even when a job already exists; it does not guarantee HTTP 409 for these states or preserve an outstanding job's retry budget. Prior named reports remain available for inspection. If a request fails, inspect the scheduler state and named reports before retrying. Resume scheduler admission and workers only after inspecting the direct invocation's result and report state.
|
||||
A queued, running, or failed job, active quarantine, or inconsistent current/latest aliases or their named report returns HTTP 409 instead of replacing the existing job or discarding its retry budget. Inspect that state before retrying or taking explicit worker/recovery action. A failed publication that saved only a completed named dry-run report leaves harmless history: no alias advertises a running claim, and replanning is safe because there were no table-object effects. Planning revalidates table identity, metadata pointer, configuration, and the prior report before publication; concurrent changes also conflict. It does not introduce automatic workers, snapshot-expiration commits, or compaction commits on durable-strong backing.
|
||||
|
||||
## Enablement
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ Bitrot cycle resolution differs because the canonical persistent key belongs to
|
||||
| `scanner.cycle_max_objects` | `RUSTFS_SCANNER_CYCLE_MAX_OBJECTS` | objects | `0` (`DEFAULT_SCANNER_CYCLE_MAX_OBJECTS`) | Caps objects processed by one cycle. `0` disables this budget. |
|
||||
| `scanner.cycle_max_directories` | `RUSTFS_SCANNER_CYCLE_MAX_DIRECTORIES` | directories | `0` (`DEFAULT_SCANNER_CYCLE_MAX_DIRECTORIES`) | Caps directories entered by one cycle. `0` disables this budget. |
|
||||
| `heal.bitrot_cycle` | `RUSTFS_SCANNER_BITROT_CYCLE_SECS` | seconds | `2592000` (`DEFAULT_HEAL_BITROT_CYCLE_SECS`, 30 days) | Controls periodic deep bitrot scans. `false`, `off`, `no`, or `disabled` disables periodic deep scans; `0`, `true`, `on`, or `yes` runs deep mode every scanner cycle. |
|
||||
| `scanner.idle_mode` | `RUSTFS_SCANNER_IDLE_MODE` | boolean | `true` (`DEFAULT_SCANNER_IDLE_MODE`) | Enables preset scanner sleeps and the foreground backoff for callers without a disk binding. `false` disables those sleeps; per-disk foreground-priority admission remains active. |
|
||||
| `scanner.idle_mode` | `RUSTFS_SCANNER_IDLE_MODE` | boolean | `true` (`DEFAULT_SCANNER_IDLE_MODE`) | Enables preset scanner sleeps and foreground-read backoff. `false` disables those sleeps; per-disk foreground-priority admission remains active. |
|
||||
| `scanner.cache_save_timeout` | `RUSTFS_SCANNER_CACHE_SAVE_TIMEOUT_SECS` | seconds | `14` (`DEFAULT_SCANNER_CACHE_SAVE_TIMEOUT_SECS`) | Timeout for saving scanner cache; runtime enforces a minimum of `1` and keeps the default persistence budget within the distributed publication lease. |
|
||||
| `scanner.recovery_backoff_cap` | `RUSTFS_SCANNER_RECOVERY_BACKOFF_CAP_SECS` | seconds | `600` (`DEFAULT_SCANNER_RECOVERY_BACKOFF_CAP_SECS`) | Caps the wait between automatic startup recovery retries. Must be a positive integer; `0` and malformed values are rejected, so retries never stop. Applies to the next computed retry, not to a wait already in progress. The retry count resets after 24 hours, which bounds a single wait at about one day even with a larger cap. |
|
||||
| `scanner.max_concurrent_set_scans` | `RUSTFS_SCANNER_MAX_CONCURRENT_SET_SCANS` | count | `4` (`DEFAULT_SCANNER_MAX_CONCURRENT_SET_SCANS`) | Caps concurrent set-level scanner tasks. `0` keeps topology-derived concurrency. |
|
||||
@@ -63,7 +63,7 @@ Speed presets (`crates/config/src/constants/scanner.rs`) set the base sleep mult
|
||||
| `slow` | 10x | 15s | 60s |
|
||||
| `slowest` | 100x | 15s | 30m |
|
||||
|
||||
Use `scanner.delay`, `scanner.max_wait`, and `scanner.cycle` when the preset is close but one axis needs a precise override. With `idle_mode=true`, directory-level sleep is `1ms x factor` and object-level sleep is admitted work time multiplied by the factor, capped at `max_wait`; object pacing batches small waits and settles remaining debt at bucket completion. Local walkers bound with `DynamicSleeper::for_disk` use disk-priority admission and their shared I/O budget without an additional global foreground-request sleep. A caller without that binding retains a foreground-workload floor of 10ms per active request, capped at 250ms, which can exceed `max_wait` (`crates/scanner/src/sleeper.rs`). The per-disk foreground-priority gate and disk budget remain active when preset sleeps are disabled. Removing redundant global backoff does not guarantee a fixed snapshot age: scans still compete for admitted resources and may checkpoint at their cycle budget.
|
||||
Use `scanner.delay`, `scanner.max_wait`, and `scanner.cycle` when the preset is close but one axis needs a precise override. With `idle_mode=true`, directory-level sleep is `1ms x factor` and object-level sleep is `time spent on the object x factor`, both capped at `max_wait`; a foreground-read floor of `FOREGROUND_READ_BACKOFF_PER_REQUEST_MS` (10ms) per concurrent GetObject/streaming read, capped at `FOREGROUND_READ_BACKOFF_MAX_MS` (250ms), is applied on top and can exceed the preset's `max_wait` (`crates/scanner/src/sleeper.rs`). The per-disk foreground-priority gate is independent of `idle_mode` and remains active when sleeps are disabled.
|
||||
|
||||
### Startup and cycle budgets
|
||||
|
||||
|
||||
@@ -62,9 +62,6 @@ because object identity is unproven; that is distinct from execution progress.
|
||||
MRF likewise retains durable legacy repair obligations after physical recovery
|
||||
when no independent verification receipt can discharge them. An idle attempt
|
||||
queue does not imply that these persistent obligations have been cleared.
|
||||
|
||||
After a qualified all-healthy Deep check, the attempt is `Completed` with an `Unknown` object outcome; it is counted in `unverified_tasks`, not `successful_tasks` or `failed_tasks`. This cumulative attempt count is distinct from the current `held_unverified_legacy` responsibility count. The scheduler reports `verification_unavailable`, and the durable obligation remains subject to the existing explicit recheck or audited operator disposition. Execution completion never supplies a missing integrity receipt.
|
||||
|
||||
Partial-write MRF replay uses Deep verification so a protected object's repair
|
||||
can discharge its obligation after verifying the payload. This adds full-object
|
||||
read work to those background attempts, including healthy replay targets.
|
||||
|
||||
Generated
+6
-6
@@ -2,11 +2,11 @@
|
||||
"nodes": {
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1793977579,
|
||||
"narHash": "sha256-WrSODdZFVIs/Hh2NzC0bY+ROByi0bATg8WfePX8dPj8=",
|
||||
"lastModified": 1793466162,
|
||||
"narHash": "sha256-pt+peAEoOK3lLLdtbnQ1AGIBTZbdB6jrkgmurfcQwig=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "4fe25e12eb9f4c744966dd3de5a05246cf098601",
|
||||
"rev": "a0788123ada57ec92a79ab2581cda6d3c6cca75f",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -29,11 +29,11 @@
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1794040562,
|
||||
"narHash": "sha256-7eEiezSku3lbZPUOXW8we1a7+xd5axkCQdyI3rzOKjo=",
|
||||
"lastModified": 1793434469,
|
||||
"narHash": "sha256-+sgVNI2c67di+XIeMaz5KSei4T65kX68s5Nl0E5Gzbc=",
|
||||
"owner": "oxalica",
|
||||
"repo": "rust-overlay",
|
||||
"rev": "d3fe74269f2a6652437e21e78eb7e83be81f6982",
|
||||
"rev": "6ecf534a7c16e7c969f26838fdd8c93597ae93f3",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
||||
@@ -88,6 +88,67 @@ impl Operation for GetTableBucketHandler {
|
||||
}
|
||||
}
|
||||
|
||||
pub struct GetTableCatalogMigrationHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Operation for GetTableCatalogMigrationHandler {
|
||||
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::GetTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let store = table_catalog_object_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.plan_durable_strong_backing_migration(&warehouse)
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("migration", &warehouse, "", "", started, &result);
|
||||
let response = result?;
|
||||
build_json_response(StatusCode::OK, &response)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct MaterializeTableCatalogMigrationHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Operation for MaterializeTableCatalogMigrationHandler {
|
||||
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
authorize_table_catalog_request(&req, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let store = table_catalog_object_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.materialize_durable_strong_backing_migration(&warehouse)
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("migration-materialize", &warehouse, "", "", started, &result);
|
||||
let response = result?;
|
||||
build_json_response(StatusCode::OK, &response)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct CancelTableCatalogMigrationHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Operation for CancelTableCatalogMigrationHandler {
|
||||
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
authorize_table_catalog_request(&req, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let store = table_catalog_object_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.cancel_durable_strong_backing_migration(&warehouse)
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("migration-cancel", &warehouse, "", "", started, &result);
|
||||
let response = result?;
|
||||
build_json_response(StatusCode::OK, &response)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct CreateTableCatalogBackupHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
@@ -101,7 +162,7 @@ impl Operation for CreateTableCatalogBackupHandler {
|
||||
let store = table_catalog_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.create_catalog_backup(&warehouse, request.expected_snapshot_etag.as_deref())
|
||||
.create_durable_catalog_backup(&warehouse, request.expected_snapshot_etag.as_deref())
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("catalog-backup", &warehouse, "", "", started, &result);
|
||||
@@ -110,98 +171,6 @@ impl Operation for CreateTableCatalogBackupHandler {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns the saved artifact bytes without applying or re-encoding its catalog.
|
||||
pub struct ExportTableCatalogBackupHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Operation for ExportTableCatalogBackupHandler {
|
||||
async fn call(&self, mut req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let request = read_json_body::<CatalogBackupExportRequest>(std::mem::take(&mut req.input)).await?;
|
||||
let store = table_catalog_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.export_catalog_backup(&warehouse, &request.backup_id)
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("catalog-backup-export", &warehouse, "", "", started, &result);
|
||||
let mut headers = HeaderMap::new();
|
||||
headers.insert(CONTENT_TYPE, HeaderValue::from_static(JSON_CONTENT_TYPE));
|
||||
headers.insert(http::header::CACHE_CONTROL, HeaderValue::from_static("no-store, private"));
|
||||
headers.insert(http::header::PRAGMA, HeaderValue::from_static("no-cache"));
|
||||
headers.insert(http::header::EXPIRES, HeaderValue::from_static("0"));
|
||||
Ok(S3Response::with_headers((StatusCode::OK, Body::from(result?)), headers))
|
||||
}
|
||||
}
|
||||
|
||||
/// Stores a validated candidate artifact; catalog publication is a separate restore.
|
||||
pub struct ImportTableCatalogBackupHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Operation for ImportTableCatalogBackupHandler {
|
||||
async fn call(&self, mut req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let data = read_limited_body(
|
||||
std::mem::take(&mut req.input),
|
||||
CATALOG_BACKUP_IMPORT_BODY_MAX_SIZE,
|
||||
TABLE_CATALOG_REQUEST_BODY_TIMEOUT,
|
||||
Some("catalog backup import"),
|
||||
)
|
||||
.await?;
|
||||
let store = table_catalog_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.import_catalog_backup(&warehouse, data.to_vec())
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("catalog-backup-import", &warehouse, "", "", started, &result);
|
||||
build_sensitive_json_response(StatusCode::OK, &result?)
|
||||
}
|
||||
}
|
||||
|
||||
/// Prepares one verified small object while leaving catalog publication to restore.
|
||||
pub struct PrepareTableCatalogBackupObjectHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl Operation for PrepareTableCatalogBackupObjectHandler {
|
||||
async fn call(&self, mut req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let request = read_bounded_json_body::<CatalogBackupObjectPrepareRequest>(
|
||||
&req.headers,
|
||||
std::mem::take(&mut req.input),
|
||||
CATALOG_BACKUP_PREPARE_BODY_MAX_SIZE,
|
||||
TABLE_CATALOG_REQUEST_BODY_TIMEOUT,
|
||||
"catalog backup object preparation",
|
||||
)
|
||||
.await?;
|
||||
if request.data_base64.len() > CATALOG_BACKUP_PREPARE_BASE64_MAX_SIZE {
|
||||
return Err(S3Error::from(ApiError::invalid_request(
|
||||
"data-base64 exceeds the encoded preparation limit",
|
||||
)));
|
||||
}
|
||||
let data = base64_simd::STANDARD
|
||||
.decode_to_vec(request.data_base64.as_bytes())
|
||||
.map_err(|_| S3Error::from(ApiError::invalid_request("data-base64 must be standard padded Base64")))?;
|
||||
let store = table_catalog_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.prepare_catalog_backup_object(&warehouse, &request.backup_id, &request.object, data)
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
record_table_catalog_admin_operation_result("catalog-backup-prepare", &warehouse, "", "", started, &result);
|
||||
build_sensitive_json_response(StatusCode::OK, &result?)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct RestoreTableCatalogBackupHandler {}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
@@ -215,12 +184,11 @@ impl Operation for RestoreTableCatalogBackupHandler {
|
||||
let store = table_catalog_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
let result = store
|
||||
.restore_catalog_backup_with_id(
|
||||
.restore_durable_catalog_backup(
|
||||
&warehouse,
|
||||
&request.backup_id,
|
||||
request.expected_snapshot_etag.as_deref(),
|
||||
request.allow_replace,
|
||||
request.restore_id.as_deref(),
|
||||
)
|
||||
.await
|
||||
.map_err(catalog_store_error);
|
||||
@@ -236,8 +204,7 @@ pub struct BackfillTableWarehouseIndexHandler {}
|
||||
impl Operation for BackfillTableWarehouseIndexHandler {
|
||||
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::MigrateTableCatalogAction).await?;
|
||||
authorize_table_catalog_request(&req, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let store = table_catalog_object_store_from_extensions(&req.extensions)?;
|
||||
let started = Instant::now();
|
||||
@@ -348,8 +315,7 @@ pub struct AdvanceTableDirectoryHandler {}
|
||||
impl Operation for AdvanceTableDirectoryHandler {
|
||||
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::MigrateTableCatalogAction).await?;
|
||||
authorize_table_catalog_request(&req, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let store = table_catalog_object_store_from_extensions(&req.extensions)?;
|
||||
let response = store.advance_table_directory(&warehouse).await.map_err(catalog_store_error)?;
|
||||
@@ -363,8 +329,7 @@ pub struct DisableTableDirectoryHandler {}
|
||||
impl Operation for DisableTableDirectoryHandler {
|
||||
async fn call(&self, req: S3Request<Body>, params: Params<'_, '_>) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let warehouse = warehouse_from_params(¶ms)?;
|
||||
let resource = TableCatalogResource::warehouse(&warehouse);
|
||||
authorize_table_catalog_resource_request(&req, &resource, AdminAction::MigrateTableCatalogAction).await?;
|
||||
authorize_table_catalog_request(&req, AdminAction::MigrateTableCatalogAction).await?;
|
||||
ensure_table_bucket_enabled_from_extensions(&req.extensions, &warehouse).await?;
|
||||
let store = table_catalog_object_store_from_extensions(&req.extensions)?;
|
||||
let response = store.disable_table_directory(&warehouse).await.map_err(catalog_store_error)?;
|
||||
|
||||
@@ -46,8 +46,30 @@ async fn configured_table_metadata_maintenance_response<B>(
|
||||
where
|
||||
B: crate::table_catalog::TableCatalogObjectBackend + Clone,
|
||||
{
|
||||
let crate::table_catalog::ConfiguredTableCatalogStore::ObjectBacked(store) = store;
|
||||
table_metadata_maintenance_response(store, metadata_backend, bucket, namespace, table, request).await
|
||||
match store {
|
||||
crate::table_catalog::ConfiguredTableCatalogStore::ObjectBacked(store) => {
|
||||
table_metadata_maintenance_response(store, metadata_backend, bucket, namespace, table, request).await
|
||||
}
|
||||
crate::table_catalog::ConfiguredTableCatalogStore::DurableStrong(store) => {
|
||||
if request.delete || request.commit_snapshot_expiration || request.commit_compaction {
|
||||
return Err(s3_error!(
|
||||
InvalidRequest,
|
||||
"metadata maintenance deletion and snapshot expiration or compaction commits are not supported with durable-strong table catalog backing"
|
||||
));
|
||||
}
|
||||
store
|
||||
.run_table_metadata_maintenance_planning(
|
||||
bucket,
|
||||
&namespace.public_name(),
|
||||
table,
|
||||
request.retain_recent_metadata_files,
|
||||
request.snapshot_expiration,
|
||||
request.compaction,
|
||||
)
|
||||
.await
|
||||
.map_err(catalog_store_error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub struct GetTableMaintenanceConfigHandler {}
|
||||
|
||||
@@ -79,10 +79,6 @@ const DEFAULT_TABLE_CATALOG_CREDENTIAL_TTL_SECONDS: i64 = 15 * 60;
|
||||
const MIN_TABLE_CATALOG_CREDENTIAL_TTL_SECONDS: i64 = 60;
|
||||
const MAX_TABLE_CATALOG_CREDENTIAL_TTL_SECONDS: i64 = 60 * 60;
|
||||
const TABLE_CATALOG_REQUEST_BODY_TIMEOUT: StdDuration = StdDuration::from_secs(30);
|
||||
const CATALOG_BACKUP_IMPORT_BODY_MAX_SIZE: usize = 64 * 1024 * 1024;
|
||||
const CATALOG_BACKUP_PREPARE_BODY_MAX_SIZE: usize = 24 * 1024 * 1024;
|
||||
const CATALOG_BACKUP_PREPARE_OBJECT_MAX_SIZE: usize = 16 * 1024 * 1024;
|
||||
const CATALOG_BACKUP_PREPARE_BASE64_MAX_SIZE: usize = CATALOG_BACKUP_PREPARE_OBJECT_MAX_SIZE.div_ceil(3) * 4;
|
||||
const TABLE_CATALOG_COMMIT_REQUIREMENT_MAX_COUNT: usize = 1_024;
|
||||
const TABLE_CATALOG_COMMIT_UPDATE_MAX_COUNT: usize = 1_024;
|
||||
const NAMESPACE_REQUEST_BODY_MAX_SIZE: usize = MAX_ADMIN_REQUEST_BODY_SIZE;
|
||||
@@ -181,15 +177,18 @@ const TABLE_CATALOG_ENDPOINTS: &[&str] = &[
|
||||
"POST /v1/{prefix}/namespaces/{namespace}/views/{view}",
|
||||
"DELETE /v1/{prefix}/namespaces/{namespace}/views/{view}",
|
||||
];
|
||||
const TABLE_CATALOG_DURABLE_STRONG_ENDPOINTS: &[&str] =
|
||||
&["POST /v1/{prefix}/catalog/backup", "POST /v1/{prefix}/catalog/restore"];
|
||||
|
||||
static GET_CONFIG_HANDLER: GetCatalogConfigHandler = GetCatalogConfigHandler {};
|
||||
static ENABLE_TABLE_BUCKET_HANDLER: EnableTableBucketHandler = EnableTableBucketHandler {};
|
||||
static DISABLE_TABLE_BUCKET_HANDLER: DisableTableBucketHandler = DisableTableBucketHandler {};
|
||||
static GET_TABLE_BUCKET_HANDLER: GetTableBucketHandler = GetTableBucketHandler {};
|
||||
static GET_TABLE_CATALOG_MIGRATION_HANDLER: GetTableCatalogMigrationHandler = GetTableCatalogMigrationHandler {};
|
||||
static MATERIALIZE_TABLE_CATALOG_MIGRATION_HANDLER: MaterializeTableCatalogMigrationHandler =
|
||||
MaterializeTableCatalogMigrationHandler {};
|
||||
static CANCEL_TABLE_CATALOG_MIGRATION_HANDLER: CancelTableCatalogMigrationHandler = CancelTableCatalogMigrationHandler {};
|
||||
static CREATE_TABLE_CATALOG_BACKUP_HANDLER: CreateTableCatalogBackupHandler = CreateTableCatalogBackupHandler {};
|
||||
static EXPORT_TABLE_CATALOG_BACKUP_HANDLER: ExportTableCatalogBackupHandler = ExportTableCatalogBackupHandler {};
|
||||
static IMPORT_TABLE_CATALOG_BACKUP_HANDLER: ImportTableCatalogBackupHandler = ImportTableCatalogBackupHandler {};
|
||||
static PREPARE_TABLE_CATALOG_BACKUP_OBJECT_HANDLER: PrepareTableCatalogBackupObjectHandler =
|
||||
PrepareTableCatalogBackupObjectHandler {};
|
||||
static RESTORE_TABLE_CATALOG_BACKUP_HANDLER: RestoreTableCatalogBackupHandler = RestoreTableCatalogBackupHandler {};
|
||||
static BACKFILL_TABLE_WAREHOUSE_INDEX_HANDLER: BackfillTableWarehouseIndexHandler = BackfillTableWarehouseIndexHandler {};
|
||||
static LIST_NAMESPACES_HANDLER: RestListNamespacesHandler = RestListNamespacesHandler {};
|
||||
@@ -514,30 +513,11 @@ struct CatalogBackupRequest {
|
||||
expected_snapshot_etag: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct CatalogBackupExportRequest {
|
||||
#[serde(rename = "backup-id")]
|
||||
backup_id: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct CatalogBackupObjectPrepareRequest {
|
||||
#[serde(rename = "backup-id")]
|
||||
backup_id: String,
|
||||
object: String,
|
||||
#[serde(rename = "data-base64")]
|
||||
data_base64: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct CatalogRestoreRequest {
|
||||
#[serde(rename = "backup-id")]
|
||||
backup_id: String,
|
||||
#[serde(default, rename = "restore-id")]
|
||||
restore_id: Option<String>,
|
||||
#[serde(default, rename = "expected-snapshot-etag")]
|
||||
expected_snapshot_etag: Option<String>,
|
||||
#[serde(default, rename = "allow-replace")]
|
||||
@@ -1057,7 +1037,10 @@ fn catalog_config_response(warehouse: Option<&str>) -> S3Result<CatalogConfigRes
|
||||
if let Some(warehouse) = warehouse {
|
||||
defaults.insert(PREFIX_PROPERTY.to_string(), warehouse.to_string());
|
||||
}
|
||||
let endpoints = TABLE_CATALOG_ENDPOINTS.to_vec();
|
||||
let mut endpoints = TABLE_CATALOG_ENDPOINTS.to_vec();
|
||||
if backing_mode == crate::table_catalog::TableCatalogBackingMode::DurableStrong {
|
||||
endpoints.extend_from_slice(TABLE_CATALOG_DURABLE_STRONG_ENDPOINTS);
|
||||
}
|
||||
Ok(CatalogConfigResponse {
|
||||
defaults,
|
||||
overrides,
|
||||
@@ -2110,6 +2093,10 @@ where
|
||||
&& publication.guards.iter().all(|guard| !guard.is_lock_lost())
|
||||
}
|
||||
|
||||
fn acquires_catalog_migration_read_permit(&self) -> bool {
|
||||
self.backend.acquires_catalog_migration_read_permit()
|
||||
}
|
||||
|
||||
fn catalog_migration_read_permit_status(&self) -> Option<bool> {
|
||||
let publication = self.publication.lock();
|
||||
publication
|
||||
@@ -2592,8 +2579,9 @@ fn table_catalog_backend_from_extensions(
|
||||
) -> S3Result<crate::table_catalog::EcStoreTableCatalogObjectBackend<ECStore>> {
|
||||
let context = runtime_sources::app_context_from_extensions(extensions)
|
||||
.ok_or_else(|| table_catalog_internal_error("request application context is not initialized"))?;
|
||||
Ok(crate::table_catalog::EcStoreTableCatalogObjectBackend::new_with_registration_cache(
|
||||
Ok(crate::table_catalog::EcStoreTableCatalogObjectBackend::new_with_runtimes(
|
||||
context.object_store(),
|
||||
context.table_catalog_strong_runtime(),
|
||||
context.table_catalog_registration_cache(),
|
||||
))
|
||||
}
|
||||
@@ -2614,10 +2602,16 @@ fn table_catalog_store_from_extensions(
|
||||
}
|
||||
|
||||
fn table_catalog_object_store_from_extensions(extensions: &http::Extensions) -> S3Result<EcStoreObjectTableCatalogStore> {
|
||||
crate::table_catalog::TableCatalogBackingMode::from_env().map_err(catalog_store_error)?;
|
||||
Ok(crate::table_catalog::ObjectTableCatalogStore::new(table_catalog_backend_from_extensions(
|
||||
extensions,
|
||||
)?))
|
||||
match crate::table_catalog::TableCatalogBackingMode::from_env().map_err(catalog_store_error)? {
|
||||
crate::table_catalog::TableCatalogBackingMode::ObjectBacked => Ok(crate::table_catalog::ObjectTableCatalogStore::new(
|
||||
table_catalog_backend_from_extensions(extensions)?,
|
||||
)),
|
||||
crate::table_catalog::TableCatalogBackingMode::DurableStrong => Err(s3_error!(
|
||||
InvalidRequest,
|
||||
"operation is not supported with {} table catalog backing",
|
||||
crate::table_catalog::TABLE_CATALOG_BACKING_DURABLE_STRONG
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
async fn table_bucket_enabled_from_extensions(extensions: &http::Extensions, bucket: &str) -> S3Result<bool> {
|
||||
|
||||
@@ -54,26 +54,26 @@ fn register_table_catalog_prefix_routes(r: &mut S3Router<AdminOperation>, prefix
|
||||
format!("{prefix}/{{warehouse}}/catalog/directory").as_str(),
|
||||
AdminOperation(&DisableTableDirectoryHandler {}),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::GET,
|
||||
format!("{prefix}/{{warehouse}}/catalog/migration").as_str(),
|
||||
AdminOperation(&GET_TABLE_CATALOG_MIGRATION_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::POST,
|
||||
format!("{prefix}/{{warehouse}}/catalog/migration").as_str(),
|
||||
AdminOperation(&MATERIALIZE_TABLE_CATALOG_MIGRATION_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::DELETE,
|
||||
format!("{prefix}/{{warehouse}}/catalog/migration").as_str(),
|
||||
AdminOperation(&CANCEL_TABLE_CATALOG_MIGRATION_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::POST,
|
||||
format!("{prefix}/{{warehouse}}/catalog/backup").as_str(),
|
||||
AdminOperation(&CREATE_TABLE_CATALOG_BACKUP_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::POST,
|
||||
format!("{prefix}/{{warehouse}}/catalog/backup/export").as_str(),
|
||||
AdminOperation(&EXPORT_TABLE_CATALOG_BACKUP_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::POST,
|
||||
format!("{prefix}/{{warehouse}}/catalog/backup/import").as_str(),
|
||||
AdminOperation(&IMPORT_TABLE_CATALOG_BACKUP_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::POST,
|
||||
format!("{prefix}/{{warehouse}}/catalog/backup/prepare").as_str(),
|
||||
AdminOperation(&PREPARE_TABLE_CATALOG_BACKUP_OBJECT_HANDLER),
|
||||
)?;
|
||||
r.insert(
|
||||
Method::POST,
|
||||
format!("{prefix}/{{warehouse}}/catalog/restore").as_str(),
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,306 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use crate::admin::storage_api::RUSTFS_META_BUCKET;
|
||||
use crate::storage::storage_api::contract::bucket::BucketOperations as _;
|
||||
use crate::table_catalog::TableCatalogObject;
|
||||
use rustfs_iam::store::Store as _;
|
||||
|
||||
const SCOPED_WAREHOUSE: &str = "migration-scope-owned";
|
||||
const FOREIGN_WAREHOUSE: &str = "migration-scope-foreign";
|
||||
const UNMARKED_WAREHOUSE: &str = "migration-scope-unmarked";
|
||||
const SCOPED_USER: &str = "catalog-migration-scoped-user";
|
||||
const SCOPED_SECRET: &str = "catalog-migration-scoped-user-secret";
|
||||
|
||||
#[derive(Clone, Copy, Debug)]
|
||||
enum CatalogMigrationScopeOperation {
|
||||
Backfill,
|
||||
Backup,
|
||||
Restore,
|
||||
}
|
||||
|
||||
impl CatalogMigrationScopeOperation {
|
||||
fn suffix(self) -> &'static str {
|
||||
match self {
|
||||
Self::Backfill => "/catalog/warehouse-index/backfill",
|
||||
Self::Backup => "/catalog/backup",
|
||||
Self::Restore => "/catalog/restore",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
struct CatalogMigrationScopeFixture {
|
||||
_temp_dir: tempfile::TempDir,
|
||||
context: Arc<AppContext>,
|
||||
}
|
||||
|
||||
impl CatalogMigrationScopeFixture {
|
||||
async fn new() -> Self {
|
||||
let (temp_dir, _disk_paths, object_store) = crate::app::gating_test_env::isolated_multi_pool_ecstore().await;
|
||||
for bucket in [SCOPED_WAREHOUSE, FOREIGN_WAREHOUSE, UNMARKED_WAREHOUSE] {
|
||||
object_store
|
||||
.make_bucket(bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("create isolated scope fixture bucket");
|
||||
}
|
||||
rustfs_iam::store::object::ObjectStore::new(object_store.clone())
|
||||
.save_iam_config(
|
||||
serde_json::json!({"version": 1}),
|
||||
format!("{}/format.json", *rustfs_iam::store::object::IAM_CONFIG_PREFIX),
|
||||
)
|
||||
.await
|
||||
.expect("seed isolated IAM format");
|
||||
let iam = rustfs_iam::build_iam_sys(object_store.clone())
|
||||
.await
|
||||
.expect("build isolated request IAM");
|
||||
let context = Arc::new(AppContext::new(
|
||||
object_store.clone(),
|
||||
Arc::new(RequestIam { handle: iam.clone() }),
|
||||
Arc::new(RequestKms),
|
||||
));
|
||||
// Preserve the existing process-global winner. When this test publishes
|
||||
// first, use the same root as the existing load-table fixture.
|
||||
let mut root = rustfs_credentials::get_global_action_cred().unwrap_or_else(|| rustfs_credentials::Credentials {
|
||||
access_key: "load-table-root-access-key".to_string(),
|
||||
secret_key: "load-table-root-secret-key".to_string(),
|
||||
..Default::default()
|
||||
});
|
||||
root.status = "on".to_string();
|
||||
assert!(context.publish_action_credentials(root));
|
||||
iam.create_user(
|
||||
SCOPED_USER,
|
||||
&AddOrUpdateUserReq {
|
||||
secret_key: SCOPED_SECRET.to_string(),
|
||||
policy: None,
|
||||
status: AccountStatus::Enabled,
|
||||
},
|
||||
)
|
||||
.await
|
||||
.expect("create a regular non-owner migration user");
|
||||
let policy = serde_json::to_vec(&serde_json::json!({
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [{
|
||||
"Effect": "Allow",
|
||||
"Action": "admin:MigrateTableCatalog",
|
||||
"Resource": format!("arn:aws:s3:::{SCOPED_WAREHOUSE}")
|
||||
}]
|
||||
}))
|
||||
.expect("encode warehouse-limited migration policy");
|
||||
iam.set_policy(
|
||||
"catalog-migration-resource-scope",
|
||||
Policy::parse_config(&policy).expect("parse warehouse-limited migration policy"),
|
||||
)
|
||||
.await
|
||||
.expect("store migration policy");
|
||||
iam.policy_db_set(SCOPED_USER, UserType::Reg, false, "catalog-migration-resource-scope")
|
||||
.await
|
||||
.expect("attach migration policy to the regular user");
|
||||
|
||||
let setup = table_catalog_handler_request(context.clone(), SCOPED_USER, SCOPED_SECRET);
|
||||
let backend = table_catalog_backend_from_extensions(&setup.extensions).expect("resolve the isolated catalog backend");
|
||||
let catalog = table_catalog_store_from_backend(backend).expect("resolve object catalog");
|
||||
for bucket in [SCOPED_WAREHOUSE, FOREIGN_WAREHOUSE] {
|
||||
enable_table_bucket_marker(object_store.as_ref(), bucket)
|
||||
.await
|
||||
.expect("enable fixture table bucket marker");
|
||||
ensure_table_bucket_entry(&catalog, bucket, true)
|
||||
.await
|
||||
.expect("seed fixture catalog bucket");
|
||||
}
|
||||
Self {
|
||||
_temp_dir: temp_dir,
|
||||
context,
|
||||
}
|
||||
}
|
||||
|
||||
fn request(&self, prefix: &str, warehouse: &str, operation: CatalogMigrationScopeOperation, body: &[u8]) -> S3Request<Body> {
|
||||
let mut request = table_catalog_handler_request(self.context.clone(), SCOPED_USER, SCOPED_SECRET);
|
||||
request.method = Method::POST;
|
||||
request.uri = format!("{prefix}/{warehouse}{}", operation.suffix())
|
||||
.parse()
|
||||
.expect("scope handler URI");
|
||||
request
|
||||
.headers
|
||||
.insert(http::header::CONTENT_TYPE, HeaderValue::from_static("application/json"));
|
||||
request.input = Body::from(body.to_vec());
|
||||
request
|
||||
}
|
||||
|
||||
async fn inventory(&self) -> BTreeMap<(String, String), TableCatalogObject> {
|
||||
let setup = table_catalog_handler_request(self.context.clone(), SCOPED_USER, SCOPED_SECRET);
|
||||
let backend = table_catalog_backend_from_extensions(&setup.extensions).expect("resolve inventory backend");
|
||||
let mut result = BTreeMap::new();
|
||||
for bucket in [RUSTFS_META_BUCKET, SCOPED_WAREHOUSE, FOREIGN_WAREHOUSE, UNMARKED_WAREHOUSE] {
|
||||
for object in backend.list_objects(bucket, "").await.expect("list isolated fixture objects") {
|
||||
let stored = backend
|
||||
.read_object(bucket, &object)
|
||||
.await
|
||||
.expect("read isolated fixture object")
|
||||
.expect("listed fixture object exists");
|
||||
result.insert((bucket.to_string(), object), stored);
|
||||
}
|
||||
}
|
||||
result
|
||||
}
|
||||
}
|
||||
|
||||
async fn call_catalog_migration_scope_handler(
|
||||
request: S3Request<Body>,
|
||||
prefix: &str,
|
||||
operation: CatalogMigrationScopeOperation,
|
||||
) -> S3Result<S3Response<(StatusCode, Body)>> {
|
||||
let mut router = matchit::Router::new();
|
||||
router
|
||||
.insert(format!("{prefix}/{{warehouse}}{}", operation.suffix()), ())
|
||||
.expect("insert the real catalog route shape");
|
||||
let path = request.uri.path().to_string();
|
||||
let matched = router.at(&path).expect("match the warehouse parameter");
|
||||
match operation {
|
||||
CatalogMigrationScopeOperation::Backfill => BackfillTableWarehouseIndexHandler {}.call(request, matched.params).await,
|
||||
CatalogMigrationScopeOperation::Backup => CreateTableCatalogBackupHandler {}.call(request, matched.params).await,
|
||||
CatalogMigrationScopeOperation::Restore => RestoreTableCatalogBackupHandler {}.call(request, matched.params).await,
|
||||
}
|
||||
}
|
||||
|
||||
async fn catalog_migration_scope_response_json(response: S3Response<(StatusCode, Body)>) -> serde_json::Value {
|
||||
assert_eq!(response.output.0, StatusCode::OK);
|
||||
let bytes = http_body_util::BodyExt::collect(response.output.1)
|
||||
.await
|
||||
.expect("collect successful catalog response")
|
||||
.to_bytes();
|
||||
serde_json::from_slice(&bytes).expect("parse successful catalog response JSON")
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial_test::serial]
|
||||
async fn catalog_backfill_handler_enforces_warehouse_scope_before_marker_or_store_access() {
|
||||
let fixture = CatalogMigrationScopeFixture::new().await;
|
||||
for prefix in [TABLE_CATALOG_PREFIX, TABLE_CATALOG_COMPAT_PREFIX] {
|
||||
let operation = CatalogMigrationScopeOperation::Backfill;
|
||||
let request = fixture.request(prefix, SCOPED_WAREHOUSE, operation, b"");
|
||||
let principal = authorize_table_catalog_resource_request(
|
||||
&request,
|
||||
&TableCatalogResource::warehouse(SCOPED_WAREHOUSE),
|
||||
AdminAction::MigrateTableCatalogAction,
|
||||
)
|
||||
.await
|
||||
.expect("the scoped policy allows its own warehouse");
|
||||
assert!(!principal.owner, "scope checks must use the regular user rather than owner bypass");
|
||||
let response = call_catalog_migration_scope_handler(request, prefix, operation)
|
||||
.await
|
||||
.expect("authorized warehouse-index backfill succeeds");
|
||||
assert_eq!(response.output.0, StatusCode::NO_CONTENT);
|
||||
|
||||
for warehouse in [FOREIGN_WAREHOUSE, UNMARKED_WAREHOUSE] {
|
||||
let before = fixture.inventory().await;
|
||||
let request = fixture.request(prefix, warehouse, operation, b"{body must not be consumed");
|
||||
let error = call_catalog_migration_scope_handler(request, prefix, operation)
|
||||
.await
|
||||
.expect_err("a different warehouse must be denied before marker or store access");
|
||||
assert_eq!(error.code(), &S3ErrorCode::AccessDenied, "{prefix} {warehouse}");
|
||||
assert_eq!(error.status_code(), Some(StatusCode::FORBIDDEN), "{prefix} {warehouse}");
|
||||
assert_eq!(fixture.inventory().await, before, "denied backfill changed persistent state");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial_test::serial]
|
||||
async fn catalog_backup_restore_enforce_migration_scope_and_replay_own_receipts() {
|
||||
let fixture = CatalogMigrationScopeFixture::new().await;
|
||||
for (index, prefix) in [TABLE_CATALOG_PREFIX, TABLE_CATALOG_COMPAT_PREFIX].into_iter().enumerate() {
|
||||
let request = fixture.request(prefix, SCOPED_WAREHOUSE, CatalogMigrationScopeOperation::Backup, b"{}");
|
||||
let principal = table_catalog_request_principal(&request)
|
||||
.await
|
||||
.expect("authenticate the scoped backup caller");
|
||||
assert!(!principal.owner, "backup and restore must not use owner bypass");
|
||||
let response = call_catalog_migration_scope_handler(request, prefix, CatalogMigrationScopeOperation::Backup)
|
||||
.await
|
||||
.expect("the scoped user can create its own object catalog backup");
|
||||
let backup = catalog_migration_scope_response_json(response).await;
|
||||
assert_eq!(backup["table_bucket"], SCOPED_WAREHOUSE);
|
||||
assert!(matches!(backup["status"].as_str(), Some("CREATED" | "ALREADY_PRESENT")));
|
||||
assert!(backup["object_count"].as_u64().is_some_and(|count| count > 0));
|
||||
let backup_id = backup["backup_id"].as_str().expect("successful backup id").to_string();
|
||||
assert_eq!(backup_id.len(), 64);
|
||||
assert!(
|
||||
backup_id
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
|
||||
);
|
||||
let watermark = backup["source_snapshot_etag"]
|
||||
.as_str()
|
||||
.expect("successful backup source watermark");
|
||||
assert!(!watermark.is_empty());
|
||||
let restore_id = format!("scoped-handler-restore-{index}");
|
||||
let restore_body = serde_json::to_vec(&serde_json::json!({
|
||||
"backup-id": backup_id,
|
||||
"restore-id": restore_id,
|
||||
"expected-snapshot-etag": watermark,
|
||||
"allow-replace": false
|
||||
}))
|
||||
.expect("bind the restore request to the successful backup and explicit restore id");
|
||||
let request = fixture.request(prefix, SCOPED_WAREHOUSE, CatalogMigrationScopeOperation::Restore, &restore_body);
|
||||
let response = call_catalog_migration_scope_handler(request, prefix, CatalogMigrationScopeOperation::Restore)
|
||||
.await
|
||||
.expect("the scoped user can restore the unchanged catalog from its own backup");
|
||||
let restored = catalog_migration_scope_response_json(response).await;
|
||||
assert_eq!(restored["table_bucket"], SCOPED_WAREHOUSE);
|
||||
assert_eq!(restored["backup_id"], backup_id);
|
||||
assert_eq!(restored["status"], "RESTORED");
|
||||
assert_eq!(restored["object_count"], backup["object_count"]);
|
||||
assert_eq!(restored["maintenance_object_count"], backup["maintenance_object_count"]);
|
||||
|
||||
let setup = table_catalog_handler_request(fixture.context.clone(), SCOPED_USER, SCOPED_SECRET);
|
||||
let backend = table_catalog_backend_from_extensions(&setup.extensions).expect("resolve restore control backend");
|
||||
let state_path = crate::table_catalog::TableCatalogObjectPaths::default().catalog_restore_state_path(SCOPED_WAREHOUSE);
|
||||
let barrier = backend
|
||||
.read_object(RUSTFS_META_BUCKET, &state_path)
|
||||
.await
|
||||
.expect("read identified restore barrier")
|
||||
.expect("identified restore barrier exists");
|
||||
let barrier: serde_json::Value = serde_json::from_slice(&barrier.data).expect("identified restore barrier JSON");
|
||||
assert_eq!(barrier["restore_id"], restore_id, "handler did not forward the explicit restore id");
|
||||
assert_eq!(barrier["backup_id"], backup_id);
|
||||
assert_eq!(barrier["state"], "COMPLETED");
|
||||
|
||||
let before_replay = fixture.inventory().await;
|
||||
let request = fixture.request(prefix, SCOPED_WAREHOUSE, CatalogMigrationScopeOperation::Restore, &restore_body);
|
||||
let response = call_catalog_migration_scope_handler(request, prefix, CatalogMigrationScopeOperation::Restore)
|
||||
.await
|
||||
.expect("the same restore id replays the completed receipt");
|
||||
let mut replay = catalog_migration_scope_response_json(response).await;
|
||||
assert_eq!(replay["status"], "ALREADY_RESTORED");
|
||||
replay["status"] = restored["status"].clone();
|
||||
assert_eq!(replay, restored, "replay changed the original receipt");
|
||||
assert_eq!(fixture.inventory().await, before_replay, "completed replay changed persistent state");
|
||||
|
||||
for warehouse in [FOREIGN_WAREHOUSE, UNMARKED_WAREHOUSE] {
|
||||
for operation in [
|
||||
CatalogMigrationScopeOperation::Backup,
|
||||
CatalogMigrationScopeOperation::Restore,
|
||||
] {
|
||||
let before = fixture.inventory().await;
|
||||
let request = fixture.request(prefix, warehouse, operation, b"{body must not be consumed");
|
||||
let error = call_catalog_migration_scope_handler(request, prefix, operation)
|
||||
.await
|
||||
.expect_err("foreign warehouse must fail authorization before malformed JSON or marker checks");
|
||||
assert_eq!(error.code(), &S3ErrorCode::AccessDenied, "{prefix} {warehouse} {operation:?}");
|
||||
assert_eq!(error.status_code(), Some(StatusCode::FORBIDDEN), "{prefix} {warehouse} {operation:?}");
|
||||
assert_eq!(fixture.inventory().await, before, "foreign backup/restore changed persistent state");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1150,6 +1150,24 @@ pub const ADMIN_ROUTE_POLICY_SPECS: &[AdminRouteSpec] = &[
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Get,
|
||||
"/iceberg/v1/{warehouse}/catalog/migration",
|
||||
GET_TABLE_CATALOG,
|
||||
RouteRiskLevel::Sensitive,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/migration",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Delete,
|
||||
"/iceberg/v1/{warehouse}/catalog/migration",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/backup",
|
||||
@@ -1162,24 +1180,6 @@ pub const ADMIN_ROUTE_POLICY_SPECS: &[AdminRouteSpec] = &[
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/backup/export",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/backup/import",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/backup/prepare",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/warehouse-index/backfill",
|
||||
@@ -1476,6 +1476,24 @@ pub const ADMIN_ROUTE_POLICY_SPECS: &[AdminRouteSpec] = &[
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Get,
|
||||
"/_iceberg/v1/{warehouse}/catalog/migration",
|
||||
GET_TABLE_CATALOG,
|
||||
RouteRiskLevel::Sensitive,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/_iceberg/v1/{warehouse}/catalog/migration",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Delete,
|
||||
"/_iceberg/v1/{warehouse}/catalog/migration",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/_iceberg/v1/{warehouse}/catalog/backup",
|
||||
@@ -1488,24 +1506,6 @@ pub const ADMIN_ROUTE_POLICY_SPECS: &[AdminRouteSpec] = &[
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/_iceberg/v1/{warehouse}/catalog/backup/export",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/_iceberg/v1/{warehouse}/catalog/backup/import",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/_iceberg/v1/{warehouse}/catalog/backup/prepare",
|
||||
MIGRATE_TABLE_CATALOG,
|
||||
RouteRiskLevel::High,
|
||||
),
|
||||
admin(
|
||||
HttpMethod::Post,
|
||||
"/_iceberg/v1/{warehouse}/catalog/warehouse-index/backfill",
|
||||
@@ -2346,16 +2346,16 @@ mod tests {
|
||||
assert_action(HttpMethod::Get, "/_iceberg/v1/{warehouse}/catalog/directory", GET_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/directory", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Delete, "/_iceberg/v1/{warehouse}/catalog/directory", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Get, "/iceberg/v1/{warehouse}/catalog/migration", GET_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Get, "/_iceberg/v1/{warehouse}/catalog/migration", GET_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/iceberg/v1/{warehouse}/catalog/migration", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/migration", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Delete, "/iceberg/v1/{warehouse}/catalog/migration", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Delete, "/_iceberg/v1/{warehouse}/catalog/migration", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/iceberg/v1/{warehouse}/catalog/backup", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/backup", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/iceberg/v1/{warehouse}/catalog/restore", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/restore", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/iceberg/v1/{warehouse}/catalog/backup/export", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/backup/export", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/iceberg/v1/{warehouse}/catalog/backup/import", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/backup/import", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/iceberg/v1/{warehouse}/catalog/backup/prepare", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(HttpMethod::Post, "/_iceberg/v1/{warehouse}/catalog/backup/prepare", MIGRATE_TABLE_CATALOG);
|
||||
assert_action(
|
||||
HttpMethod::Post,
|
||||
"/iceberg/v1/{warehouse}/catalog/warehouse-index/backfill",
|
||||
|
||||
@@ -511,14 +511,14 @@ fn expected_admin_route_matrix() -> Vec<RouteMatrixEntry> {
|
||||
table_route_sample(Method::PUT, "/buckets/{warehouse}", "/buckets/analytics"),
|
||||
table_route_sample(Method::DELETE, "/buckets/{warehouse}", "/buckets/analytics"),
|
||||
table_route_sample(Method::GET, "/buckets/{warehouse}", "/buckets/analytics"),
|
||||
table_route_sample(Method::GET, "/{warehouse}/catalog/migration", "/analytics/catalog/migration"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/migration", "/analytics/catalog/migration"),
|
||||
table_route_sample(Method::DELETE, "/{warehouse}/catalog/migration", "/analytics/catalog/migration"),
|
||||
table_route_sample(Method::GET, "/{warehouse}/catalog/directory", "/analytics/catalog/directory"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/directory", "/analytics/catalog/directory"),
|
||||
table_route_sample(Method::DELETE, "/{warehouse}/catalog/directory", "/analytics/catalog/directory"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/backup", "/analytics/catalog/backup"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/restore", "/analytics/catalog/restore"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/backup/export", "/analytics/catalog/backup/export"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/backup/import", "/analytics/catalog/backup/import"),
|
||||
table_route_sample(Method::POST, "/{warehouse}/catalog/backup/prepare", "/analytics/catalog/backup/prepare"),
|
||||
table_route_sample(
|
||||
Method::POST,
|
||||
"/{warehouse}/catalog/warehouse-index/backfill",
|
||||
@@ -719,14 +719,14 @@ fn expected_admin_route_matrix() -> Vec<RouteMatrixEntry> {
|
||||
compat_table_route_sample(Method::PUT, "/buckets/{warehouse}", "/buckets/analytics"),
|
||||
compat_table_route_sample(Method::DELETE, "/buckets/{warehouse}", "/buckets/analytics"),
|
||||
compat_table_route_sample(Method::GET, "/buckets/{warehouse}", "/buckets/analytics"),
|
||||
compat_table_route_sample(Method::GET, "/{warehouse}/catalog/migration", "/analytics/catalog/migration"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/migration", "/analytics/catalog/migration"),
|
||||
compat_table_route_sample(Method::DELETE, "/{warehouse}/catalog/migration", "/analytics/catalog/migration"),
|
||||
compat_table_route_sample(Method::GET, "/{warehouse}/catalog/directory", "/analytics/catalog/directory"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/directory", "/analytics/catalog/directory"),
|
||||
compat_table_route_sample(Method::DELETE, "/{warehouse}/catalog/directory", "/analytics/catalog/directory"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/backup", "/analytics/catalog/backup"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/restore", "/analytics/catalog/restore"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/backup/export", "/analytics/catalog/backup/export"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/backup/import", "/analytics/catalog/backup/import"),
|
||||
compat_table_route_sample(Method::POST, "/{warehouse}/catalog/backup/prepare", "/analytics/catalog/backup/prepare"),
|
||||
compat_table_route_sample(
|
||||
Method::POST,
|
||||
"/{warehouse}/catalog/warehouse-index/backfill",
|
||||
|
||||
@@ -75,6 +75,7 @@ pub struct AppContext {
|
||||
buffer_config: Arc<dyn BufferConfigInterface>,
|
||||
object_data_cache: Arc<ObjectDataCacheAdapter>,
|
||||
object_traffic_health: Arc<ObjectTrafficHealth>,
|
||||
table_catalog_strong_runtime: crate::table_catalog::StrongTableCatalogRuntime,
|
||||
table_catalog_registration_cache: crate::table_catalog::TableCatalogRegistrationCache,
|
||||
}
|
||||
|
||||
@@ -126,6 +127,7 @@ impl AppContext {
|
||||
buffer_config: default_buffer_config_interface(),
|
||||
object_data_cache,
|
||||
object_traffic_health: Arc::new(ObjectTrafficHealth::from_env()),
|
||||
table_catalog_strong_runtime: crate::table_catalog::StrongTableCatalogRuntime::default(),
|
||||
table_catalog_registration_cache: crate::table_catalog::TableCatalogRegistrationCache::default(),
|
||||
}
|
||||
}
|
||||
@@ -146,9 +148,14 @@ impl AppContext {
|
||||
Arc::clone(&self.object_traffic_health)
|
||||
}
|
||||
|
||||
pub(crate) fn table_catalog_strong_runtime(&self) -> crate::table_catalog::StrongTableCatalogRuntime {
|
||||
self.table_catalog_strong_runtime.clone()
|
||||
}
|
||||
|
||||
pub(crate) fn table_catalog_registration_cache(&self) -> crate::table_catalog::TableCatalogRegistrationCache {
|
||||
self.table_catalog_registration_cache.clone()
|
||||
}
|
||||
|
||||
pub fn iam(&self) -> Arc<dyn IamInterface> {
|
||||
self.iam.clone()
|
||||
}
|
||||
@@ -358,6 +365,7 @@ impl AppContext {
|
||||
buffer_config: interfaces.buffer_config,
|
||||
object_data_cache: ObjectDataCacheAdapter::disabled_arc(),
|
||||
object_traffic_health: Arc::new(ObjectTrafficHealth::from_env()),
|
||||
table_catalog_strong_runtime: crate::table_catalog::StrongTableCatalogRuntime::default(),
|
||||
table_catalog_registration_cache: crate::table_catalog::TableCatalogRegistrationCache::default(),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -902,7 +902,8 @@ mod tests {
|
||||
status: "on".to_owned(),
|
||||
..Default::default()
|
||||
}));
|
||||
let backend = EcStoreTableCatalogObjectBackend::new(Arc::clone(&store));
|
||||
let backend =
|
||||
EcStoreTableCatalogObjectBackend::new_with_strong_runtime(Arc::clone(&store), context.table_catalog_strong_runtime());
|
||||
let catalog =
|
||||
ConfiguredTableCatalogStore::new_for_test(backend, TableCatalogBackingMode::from_env().expect("catalog mode"));
|
||||
catalog
|
||||
|
||||
@@ -243,7 +243,10 @@ impl DefaultObjectUsecase {
|
||||
.clone()
|
||||
.or_else(current_app_context)
|
||||
.ok_or_else(not_initialized)?;
|
||||
let backend = EcStoreTableCatalogObjectBackend::new(context.object_store());
|
||||
let backend = EcStoreTableCatalogObjectBackend::new_with_strong_runtime(
|
||||
context.object_store(),
|
||||
context.table_catalog_strong_runtime(),
|
||||
);
|
||||
let guard = backend
|
||||
.acquire_read_lock(bucket, &default_table_bucket_publication_lock_path())
|
||||
.await
|
||||
|
||||
@@ -33,7 +33,6 @@ enum PutStorageTestStage {
|
||||
#[cfg(test)]
|
||||
tokio::task_local! {
|
||||
static PUT_STORAGE_TEST_FAILURE: (PutStorageTestStage, StorageError);
|
||||
static PUT_STORAGE_TEST_COMPLETION: std::cell::Cell<Option<crate::app::storage_api::object_usecase::WriteCompletion>>;
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
@@ -1572,8 +1571,6 @@ impl DefaultObjectUsecase {
|
||||
)
|
||||
.await
|
||||
.map_err(ApiError::from)?;
|
||||
// Keep the request awaiting the rename fan-out that owns its namespace guard.
|
||||
opts.write_completion = crate::app::storage_api::object_usecase::WriteCompletion::TailDrained;
|
||||
if let Some(etag) = preserve_etag {
|
||||
opts.preserve_etag = Some(etag);
|
||||
}
|
||||
@@ -1882,16 +1879,9 @@ impl DefaultObjectUsecase {
|
||||
|
||||
reader = write_plan.apply(reader, actual_size).map_err(ApiError::from)?;
|
||||
if let Some(control) = progress_control {
|
||||
if !should_compress
|
||||
&& (use_zero_copy_eager_put_path || use_empty_or_small_eager_put_path)
|
||||
&& trailing_headers.is_none()
|
||||
{
|
||||
control.finish();
|
||||
} else {
|
||||
use rustfs_rio::HashReaderMut;
|
||||
let inner = reader.take_inner();
|
||||
reader.inner = rustfs_rio::boxed_reader(super::request_body::DemandReader::new(inner, control));
|
||||
}
|
||||
use rustfs_rio::HashReaderMut;
|
||||
let inner = reader.take_inner();
|
||||
reader.inner = rustfs_rio::boxed_reader(super::request_body::DemandReader::new(inner, control));
|
||||
}
|
||||
rustfs_io_metrics::record_put_object_stage_duration_from("app_encryption_prepare", encryption_stage_start);
|
||||
|
||||
@@ -1969,8 +1959,6 @@ impl DefaultObjectUsecase {
|
||||
None
|
||||
};
|
||||
#[cfg(test)]
|
||||
let _ = PUT_STORAGE_TEST_COMPLETION.try_with(|observed| observed.set(Some(opts.write_completion)));
|
||||
#[cfg(test)]
|
||||
let injected_commit_error = injected_put_storage_failure(PutStorageTestStage::Commit);
|
||||
let put_commit_future = {
|
||||
let store = Arc::clone(&store);
|
||||
@@ -2239,43 +2227,6 @@ mod tests {
|
||||
use futures::StreamExt;
|
||||
use http::{HeaderMap, HeaderName, HeaderValue, Method};
|
||||
|
||||
#[tokio::test]
|
||||
#[serial_test::serial]
|
||||
async fn s3_put_uses_tail_drained_completion_before_acknowledgement() {
|
||||
use crate::app::storage_api::object_usecase::WriteCompletion;
|
||||
use crate::app::storage_api::test::contract::bucket::{BucketOperations as _, MakeBucketOptions};
|
||||
|
||||
let (store, context) = real_store_test_context().await;
|
||||
let bucket = format!("put-tail-completion-{}", Uuid::new_v4());
|
||||
store
|
||||
.make_bucket(&bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("create PUT completion bucket");
|
||||
let payload = Bytes::from_static(b"readable after PUT acknowledgement");
|
||||
let input = PutObjectInput::builder()
|
||||
.bucket(bucket.clone())
|
||||
.key("object".to_owned())
|
||||
.content_length(Some(i64::try_from(payload.len()).expect("small payload length")))
|
||||
.body(Some(StreamingBlob::from_bytes(payload.clone())))
|
||||
.build()
|
||||
.expect("PUT completion request");
|
||||
let usecase = DefaultObjectUsecase::with_context(Some(context));
|
||||
let fs = FS::new();
|
||||
let (response, observed) = PUT_STORAGE_TEST_COMPLETION
|
||||
.scope(std::cell::Cell::new(None), async {
|
||||
let response = Box::pin(usecase.execute_put_object(&fs, build_request(input, Method::PUT))).await;
|
||||
(response, PUT_STORAGE_TEST_COMPLETION.with(std::cell::Cell::get))
|
||||
})
|
||||
.await;
|
||||
response.expect("PUT completion response");
|
||||
assert_eq!(observed, Some(WriteCompletion::TailDrained));
|
||||
let object = store
|
||||
.get_object_info(&bucket, "object", &ObjectOptions::default())
|
||||
.await
|
||||
.expect("acknowledged PUT metadata remains readable");
|
||||
assert_eq!(object.size, i64::try_from(payload.len()).expect("small payload length"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[serial_test::serial]
|
||||
fn put_commit_lock_failure_keeps_request_operation_in_spawned_owner() {
|
||||
|
||||
@@ -160,7 +160,7 @@ impl BodyReadControl {
|
||||
state.waited = Duration::ZERO;
|
||||
}
|
||||
|
||||
pub(super) fn finish(&self) {
|
||||
fn finish(&self) {
|
||||
let mut state = self.0.budget.lock();
|
||||
self.0.active.store(false, Ordering::Release);
|
||||
state.finished = true;
|
||||
|
||||
@@ -2060,7 +2060,10 @@ fn table_catalog_backend_for_data_plane<T>(
|
||||
None => runtime_sources::current_app_context(),
|
||||
}
|
||||
.ok_or_else(object_store_not_initialized_error)?;
|
||||
Ok(crate::table_catalog::EcStoreTableCatalogObjectBackend::new(context.object_store()))
|
||||
Ok(crate::table_catalog::EcStoreTableCatalogObjectBackend::new_with_strong_runtime(
|
||||
context.object_store(),
|
||||
context.table_catalog_strong_runtime(),
|
||||
))
|
||||
}
|
||||
|
||||
fn table_catalog_store_for_data_plane<T>(
|
||||
@@ -2325,7 +2328,7 @@ async fn table_data_plane_resource_for_request<T>(
|
||||
.get::<TableDataPlanePublicationGuards>()
|
||||
.cloned()
|
||||
.unwrap_or_default();
|
||||
let publication_held = {
|
||||
{
|
||||
let state = retained.state.lock();
|
||||
if state.missing_resources.contains(&key) {
|
||||
return Ok(None);
|
||||
@@ -2339,16 +2342,11 @@ async fn table_data_plane_resource_for_request<T>(
|
||||
{
|
||||
return Ok(Some(resource));
|
||||
}
|
||||
!state.keys.is_empty()
|
||||
};
|
||||
}
|
||||
|
||||
let store = table_catalog_store_for_data_plane(req)?;
|
||||
let resource = if catalog_metadata {
|
||||
crate::table_catalog::table_metadata_data_plane_resource_for_object(&store, bucket, object).await
|
||||
} else if publication_held {
|
||||
store
|
||||
.resolve_table_data_plane_resource_for_authorization(bucket, object)
|
||||
.await
|
||||
} else {
|
||||
crate::table_catalog::table_data_plane_resource_for_object(&store, bucket, object).await
|
||||
}
|
||||
@@ -4730,87 +4728,6 @@ mod tests {
|
||||
.expect("dropping the request must release its publication guard");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
#[serial]
|
||||
async fn table_data_plane_cold_lookup_does_not_wait_for_backup_while_holding_publication() {
|
||||
use crate::table_catalog::{TableCatalogObjectBackend as _, TableCatalogStore as _};
|
||||
let (_temp_dir, _disk_paths, object_store) = crate::app::gating_test_env::isolated_multi_pool_ecstore().await;
|
||||
let bucket = "cold-authorization";
|
||||
object_store
|
||||
.make_bucket(bucket, &MakeBucketOptions::default())
|
||||
.await
|
||||
.expect("create table bucket");
|
||||
let context = Arc::new(AppContext::new(object_store.clone(), Arc::new(UnreadyIam), Arc::new(TestKms)));
|
||||
let server_ctx = ServerContextSlot::new();
|
||||
assert!(server_ctx.install(context));
|
||||
let mut request = build_request((), Method::PUT);
|
||||
request.extensions.insert(server_ctx.clone());
|
||||
let backend = super::table_catalog_backend_for_data_plane(&request).expect("request backend");
|
||||
let catalog = crate::table_catalog::ConfiguredTableCatalogStore::new_for_test(
|
||||
backend.clone(),
|
||||
crate::table_catalog::TableCatalogBackingMode::ObjectBacked,
|
||||
);
|
||||
catalog
|
||||
.put_table_bucket(crate::table_catalog::TableBucketEntry {
|
||||
version: crate::table_catalog::TABLE_CATALOG_ENTRY_VERSION,
|
||||
table_bucket: bucket.to_string(),
|
||||
catalog_type: crate::table_catalog::TABLE_BUCKET_CATALOG_TYPE.to_string(),
|
||||
warehouse_root: format!("s3://{bucket}/"),
|
||||
state: crate::table_catalog::TableCatalogEntryState::Active,
|
||||
properties: Default::default(),
|
||||
active_rename_id: None,
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
})
|
||||
.await
|
||||
.expect("newly enabled catalog entry");
|
||||
super::retain_table_bucket_publication_guard(&mut request, bucket)
|
||||
.await
|
||||
.expect("S3 owns publication first");
|
||||
let backup_guard = backend
|
||||
.acquire_write_lock(
|
||||
crate::admin::storage_api::RUSTFS_META_BUCKET,
|
||||
&crate::table_catalog::TableCatalogObjectPaths::default().catalog_backup_fence_lock_path(bucket),
|
||||
)
|
||||
.await
|
||||
.expect("backup owns its catalog fence");
|
||||
let resource = tokio::time::timeout(
|
||||
std::time::Duration::from_secs(5),
|
||||
table_data_plane_resource_for_request(&mut request, bucket, "ordinary-object", true),
|
||||
)
|
||||
.await
|
||||
.expect("cold S3 lookup must not wait for the backup catalog fence")
|
||||
.expect("resolve newly enabled table bucket");
|
||||
assert!(resource.is_none());
|
||||
assert!(
|
||||
request
|
||||
.extensions
|
||||
.get::<TableDataPlanePublicationGuards>()
|
||||
.expect("retained publication")
|
||||
.state
|
||||
.lock()
|
||||
.missing_resources
|
||||
.contains(&(bucket.to_string(), "ordinary-object".to_string()))
|
||||
);
|
||||
drop(backup_guard);
|
||||
drop(request);
|
||||
let mut read_request = build_request((), Method::GET);
|
||||
read_request.extensions.insert(server_ctx);
|
||||
table_data_plane_resource_for_request(&mut read_request, bucket, "ordinary-object", true)
|
||||
.await
|
||||
.expect("unfenced reads retain normal index initialization");
|
||||
assert!(
|
||||
backend
|
||||
.read_object(
|
||||
crate::admin::storage_api::RUSTFS_META_BUCKET,
|
||||
&crate::table_catalog::TableCatalogObjectPaths::default().warehouse_index_state_path(bucket),
|
||||
)
|
||||
.await
|
||||
.expect("read initialized index marker")
|
||||
.is_some()
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn table_data_plane_mutations_fence_before_table_bucket_marker_lookup() {
|
||||
let source = include_str!("access.rs");
|
||||
|
||||
@@ -523,6 +523,8 @@ pub(crate) mod table {
|
||||
#[cfg(test)]
|
||||
pub(crate) mod test_support {
|
||||
pub(crate) use crate::storage::storage_api::contract::bucket::{BucketOperations, MakeBucketOptions};
|
||||
pub(crate) use crate::storage::storage_api::ecstore_bucket::metadata_sys::init_bucket_metadata_sys;
|
||||
pub(crate) use crate::storage::storage_api::ecstore_bucket::metadata_sys::test_support::isolated_store_over_temp_disks;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -61,6 +61,27 @@ pub(crate) fn metadata_log_locations_matching(
|
||||
locations
|
||||
}
|
||||
|
||||
pub(crate) async fn metadata_locations_for_protected_snapshot_refs<B>(
|
||||
backend: &B,
|
||||
table_bucket: &str,
|
||||
namespace: &Namespace,
|
||||
table: &IdentifierSegment,
|
||||
current_metadata: &serde_json::Value,
|
||||
metadata_locations: &[String],
|
||||
) -> TableCatalogStoreResult<BTreeSet<String>>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
metadata_locations_for_protected_snapshot_refs_matching(
|
||||
backend,
|
||||
table_bucket,
|
||||
current_metadata,
|
||||
metadata_locations,
|
||||
|location| is_valid_table_metadata_location(namespace, table, location),
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
pub(crate) async fn metadata_locations_for_protected_snapshot_refs_matching<B>(
|
||||
backend: &B,
|
||||
table_bucket: &str,
|
||||
|
||||
@@ -2756,28 +2756,11 @@ struct SnapshotGraphManifestLocation {
|
||||
from_manifest_list: bool,
|
||||
}
|
||||
|
||||
enum SnapshotGraphValidation<'a> {
|
||||
Commit(Option<&'a serde_json::Value>),
|
||||
BackupInventory,
|
||||
}
|
||||
|
||||
pub(crate) async fn validate_table_snapshot_changes<B>(
|
||||
context: &TableSnapshotGraphValidationContext<'_, B>,
|
||||
current_metadata: Option<&serde_json::Value>,
|
||||
metadata: &serde_json::Value,
|
||||
) -> TableCatalogStoreResult<()>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
validate_table_snapshot_changes_with_budget(context, SnapshotGraphValidation::Commit(current_metadata), metadata).await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn validate_table_snapshot_changes_with_budget<B>(
|
||||
context: &TableSnapshotGraphValidationContext<'_, B>,
|
||||
validation: SnapshotGraphValidation<'_>,
|
||||
metadata: &serde_json::Value,
|
||||
) -> TableCatalogStoreResult<SnapshotGraphReadBudget>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
@@ -2787,44 +2770,29 @@ where
|
||||
let mut budget = SnapshotGraphReadBudget::default();
|
||||
validate_table_statistics_objects(context, metadata).await?;
|
||||
let format_version = table_metadata_format_version(metadata)?;
|
||||
let current_metadata = match validation {
|
||||
SnapshotGraphValidation::Commit(current_metadata) => current_metadata,
|
||||
SnapshotGraphValidation::BackupInventory => None,
|
||||
};
|
||||
let snapshots = snapshots_requiring_graph_validation(current_metadata, metadata)?;
|
||||
for snapshot in snapshots {
|
||||
snapshot
|
||||
.get("snapshot-id")
|
||||
.and_then(serde_json::Value::as_i64)
|
||||
.ok_or_else(|| TableCatalogStoreError::Invalid("snapshot-id must be an integer".to_string()))?;
|
||||
if format_version == 2
|
||||
&& snapshot.get("manifests").is_some()
|
||||
&& !snapshot_is_retained_v1_history(current_metadata, snapshot)
|
||||
{
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"new Iceberg v2 snapshots require manifest-list".to_string(),
|
||||
));
|
||||
}
|
||||
let snapshot_sequence_number = snapshot
|
||||
.get("sequence-number")
|
||||
.and_then(serde_json::Value::as_i64)
|
||||
.unwrap_or(0);
|
||||
let graph_format_version = if format_version == 2 && snapshot.get("manifests").is_some() {
|
||||
match validation {
|
||||
// A persisted upgrade can retain an inline v1 snapshot. Walk
|
||||
// its full graph using v1 manifest and file constraints.
|
||||
SnapshotGraphValidation::BackupInventory if snapshot_sequence_number == 0 => 1,
|
||||
SnapshotGraphValidation::Commit(current_metadata)
|
||||
if snapshot_is_retained_v1_history(current_metadata, snapshot) =>
|
||||
{
|
||||
format_version
|
||||
}
|
||||
_ => {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"new Iceberg v2 snapshots require manifest-list".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
} else {
|
||||
format_version
|
||||
};
|
||||
let manifests = snapshot_graph_manifest_references(
|
||||
context,
|
||||
metadata,
|
||||
snapshot,
|
||||
graph_format_version,
|
||||
format_version,
|
||||
snapshot_sequence_number,
|
||||
&mut budget,
|
||||
)
|
||||
@@ -2840,69 +2808,6 @@ where
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(budget)
|
||||
}
|
||||
|
||||
/// Validates every retained snapshot and returns its bounded physical object inventory.
|
||||
///
|
||||
/// Manifest lists and manifests are retained even when all their entries are deleted. Only live data/delete
|
||||
/// references are included, and every such object has passed the existing existence validation. This uses the
|
||||
/// validator's existing caches without another storage traversal or Avro decode. Statistics are enumerated
|
||||
/// separately with `table_statistics_object_references`.
|
||||
pub(crate) async fn validated_table_snapshot_graph_inventory<B>(
|
||||
context: &TableSnapshotGraphValidationContext<'_, B>,
|
||||
metadata: &serde_json::Value,
|
||||
) -> TableCatalogStoreResult<BTreeMap<String, TableMetadataMaintenanceObjectKind>>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
let budget = validate_table_snapshot_changes_with_budget(context, SnapshotGraphValidation::BackupInventory, metadata).await?;
|
||||
let mut inventory = BTreeMap::new();
|
||||
for object in budget.manifest_lists.keys() {
|
||||
insert_validated_snapshot_graph_inventory_object(
|
||||
&mut inventory,
|
||||
object.clone(),
|
||||
TableMetadataMaintenanceObjectKind::ManifestList,
|
||||
)?;
|
||||
}
|
||||
for (object, manifest) in &budget.manifests {
|
||||
insert_validated_snapshot_graph_inventory_object(
|
||||
&mut inventory,
|
||||
object.clone(),
|
||||
TableMetadataMaintenanceObjectKind::ManifestFile,
|
||||
)?;
|
||||
for reference in manifest.references.iter() {
|
||||
if !matches!(reference.entry_status, Some(0 | 1)) {
|
||||
continue;
|
||||
}
|
||||
let object = snapshot_graph_object_key(context, &reference.location, reference.object_kind.clone())?;
|
||||
if !budget.validated_live_objects.contains(&object) {
|
||||
return Err(TableCatalogStoreError::Internal(
|
||||
"snapshot inventory contains a live object without successful existence validation".to_string(),
|
||||
));
|
||||
}
|
||||
insert_validated_snapshot_graph_inventory_object(&mut inventory, object, reference.object_kind.clone())?;
|
||||
}
|
||||
}
|
||||
Ok(inventory)
|
||||
}
|
||||
|
||||
fn insert_validated_snapshot_graph_inventory_object(
|
||||
inventory: &mut BTreeMap<String, TableMetadataMaintenanceObjectKind>,
|
||||
object: String,
|
||||
kind: TableMetadataMaintenanceObjectKind,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
match inventory.entry(object) {
|
||||
std::collections::btree_map::Entry::Vacant(entry) => {
|
||||
entry.insert(kind);
|
||||
}
|
||||
std::collections::btree_map::Entry::Occupied(entry) if *entry.get() != kind => {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"snapshot inventory object is referenced with conflicting kinds".to_string(),
|
||||
));
|
||||
}
|
||||
std::collections::btree_map::Entry::Occupied(_) => {}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
||||
@@ -303,7 +303,6 @@ pub(crate) fn table_name_from_marker_path(namespace: &Namespace, object_key: &st
|
||||
.map(ToString::to_string)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn metadata_location_from_metadata_file_path(
|
||||
namespace: &Namespace,
|
||||
table: &IdentifierSegment,
|
||||
|
||||
@@ -21,7 +21,8 @@ use datafusion::arrow::datatypes::{DataType, Field, Schema};
|
||||
use datafusion::parquet::arrow::{
|
||||
add_encoded_arrow_schema_to_metadata, arrow_reader::ArrowReaderOptions, arrow_writer::ArrowWriterOptions,
|
||||
};
|
||||
use datafusion::parquet::file::metadata::ColumnChunkMetaData;
|
||||
use datafusion::parquet::file::FOOTER_SIZE;
|
||||
use datafusion::parquet::file::metadata::{ColumnChunkMetaData, FooterTail, RowGroupMetaData};
|
||||
use datafusion::parquet::file::properties::{EnabledStatistics, WriterProperties};
|
||||
use std::io::Write;
|
||||
use std::sync::OnceLock;
|
||||
@@ -73,54 +74,279 @@ fn add_budget(total: &mut usize, amount: usize, limit: usize) -> TableCatalogSto
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_STOP: u8 = 0;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_BOOL_TRUE: u8 = 1;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_I16: u8 = 4;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_I32: u8 = 5;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_I64: u8 = 6;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_BINARY: u8 = 8;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_LIST: u8 = 9;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_MAP: u8 = 11;
|
||||
#[cfg(test)]
|
||||
const THRIFT_COMPACT_STRUCT: u8 = 12;
|
||||
/// Sizes read from one Parquet page header (Thrift compact encoding).
|
||||
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
|
||||
struct PageHeaderSizes {
|
||||
uncompressed: usize,
|
||||
compressed: usize,
|
||||
}
|
||||
|
||||
fn parquet_admission_error(error: rustfs_s3select_api::parquet_budget::ParquetBudgetError) -> TableCatalogStoreError {
|
||||
match error {
|
||||
rustfs_s3select_api::parquet_budget::ParquetBudgetError::Exceeded => budget_error(),
|
||||
error => TableCatalogStoreError::Invalid(format!("compaction {error}")),
|
||||
const THRIFT_COMPACT_STOP: u8 = 0;
|
||||
const THRIFT_COMPACT_BOOL_TRUE: u8 = 1;
|
||||
const THRIFT_COMPACT_BOOL_FALSE: u8 = 2;
|
||||
const THRIFT_COMPACT_BYTE: u8 = 3;
|
||||
const THRIFT_COMPACT_I16: u8 = 4;
|
||||
const THRIFT_COMPACT_I32: u8 = 5;
|
||||
const THRIFT_COMPACT_I64: u8 = 6;
|
||||
const THRIFT_COMPACT_DOUBLE: u8 = 7;
|
||||
const THRIFT_COMPACT_BINARY: u8 = 8;
|
||||
const THRIFT_COMPACT_LIST: u8 = 9;
|
||||
const THRIFT_COMPACT_SET: u8 = 10;
|
||||
const THRIFT_COMPACT_MAP: u8 = 11;
|
||||
const THRIFT_COMPACT_STRUCT: u8 = 12;
|
||||
const THRIFT_MAX_NESTING: usize = 16;
|
||||
const PAGE_HEADER_FIELD_UNCOMPRESSED_SIZE: i16 = 2;
|
||||
const PAGE_HEADER_FIELD_COMPRESSED_SIZE: i16 = 3;
|
||||
const FILE_METADATA_FIELD_ROW_GROUPS: i16 = 4;
|
||||
|
||||
/// Minimal Thrift compact-protocol cursor: enough to read a `PageHeader`'s
|
||||
/// size fields and skip everything else so the next header can be located.
|
||||
struct ThriftCompactCursor<'a> {
|
||||
bytes: &'a [u8],
|
||||
pos: usize,
|
||||
}
|
||||
|
||||
impl ThriftCompactCursor<'_> {
|
||||
fn error() -> TableCatalogStoreError {
|
||||
TableCatalogStoreError::Invalid("compaction parquet thrift metadata is malformed".to_owned())
|
||||
}
|
||||
|
||||
fn byte(&mut self) -> TableCatalogStoreResult<u8> {
|
||||
let byte = *self.bytes.get(self.pos).ok_or_else(Self::error)?;
|
||||
self.pos += 1;
|
||||
Ok(byte)
|
||||
}
|
||||
|
||||
fn skip_bytes(&mut self, count: usize) -> TableCatalogStoreResult<()> {
|
||||
self.pos = self
|
||||
.pos
|
||||
.checked_add(count)
|
||||
.filter(|end| *end <= self.bytes.len())
|
||||
.ok_or_else(Self::error)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn varint(&mut self) -> TableCatalogStoreResult<u64> {
|
||||
let mut value = 0_u64;
|
||||
for shift in (0..64).step_by(7) {
|
||||
let byte = self.byte()?;
|
||||
value |= u64::from(byte & 0x7f) << shift;
|
||||
if byte & 0x80 == 0 {
|
||||
return Ok(value);
|
||||
}
|
||||
}
|
||||
Err(Self::error())
|
||||
}
|
||||
|
||||
fn zigzag(&mut self) -> TableCatalogStoreResult<i64> {
|
||||
let raw = self.varint()?;
|
||||
Ok(((raw >> 1) as i64) ^ -((raw & 1) as i64))
|
||||
}
|
||||
|
||||
/// Every collection element occupies at least one byte, so a declared
|
||||
/// count beyond the remaining bytes is malformed. This bounds the walk to
|
||||
/// the chunk's size instead of the count a hostile header declares.
|
||||
fn collection_count(&self, count: u64) -> TableCatalogStoreResult<usize> {
|
||||
usize::try_from(count)
|
||||
.ok()
|
||||
.filter(|count| *count <= self.bytes.len() - self.pos)
|
||||
.ok_or_else(Self::error)
|
||||
}
|
||||
|
||||
fn list_header(&mut self) -> TableCatalogStoreResult<(u8, usize)> {
|
||||
let header = self.byte()?;
|
||||
let count = match header >> 4 {
|
||||
15 => self.varint()?,
|
||||
short => u64::from(short),
|
||||
};
|
||||
Ok((header & 0x0f, self.collection_count(count)?))
|
||||
}
|
||||
|
||||
fn field_id(&mut self, last: i16, header: u8) -> TableCatalogStoreResult<i16> {
|
||||
match header >> 4 {
|
||||
0 => i16::try_from(self.zigzag()?).map_err(|_| Self::error()),
|
||||
delta => last.checked_add(i16::from(delta)).ok_or_else(Self::error),
|
||||
}
|
||||
}
|
||||
|
||||
/// parquet reads the page size fields by id as a zigzag varint whatever
|
||||
/// the wire kind says. Follow the id; a kind that is not an integer is
|
||||
/// rejected rather than skipped, so the walker never records a smaller
|
||||
/// size than the decoder will allocate.
|
||||
fn size_field(&mut self, kind: u8) -> TableCatalogStoreResult<usize> {
|
||||
match kind {
|
||||
THRIFT_COMPACT_I16 | THRIFT_COMPACT_I32 | THRIFT_COMPACT_I64 => {
|
||||
usize::try_from(self.zigzag()?).map_err(|_| Self::error())
|
||||
}
|
||||
_ => Err(Self::error()),
|
||||
}
|
||||
}
|
||||
|
||||
fn skip_value(&mut self, kind: u8, depth: usize) -> TableCatalogStoreResult<()> {
|
||||
if depth > THRIFT_MAX_NESTING {
|
||||
return Err(Self::error());
|
||||
}
|
||||
match kind {
|
||||
// A struct field's bool value lives in its header byte.
|
||||
THRIFT_COMPACT_BOOL_TRUE | THRIFT_COMPACT_BOOL_FALSE => Ok(()),
|
||||
THRIFT_COMPACT_BYTE => self.skip_bytes(1),
|
||||
THRIFT_COMPACT_I16 | THRIFT_COMPACT_I32 | THRIFT_COMPACT_I64 => self.varint().map(drop),
|
||||
THRIFT_COMPACT_DOUBLE => self.skip_bytes(8),
|
||||
THRIFT_COMPACT_BINARY => {
|
||||
let len = usize::try_from(self.varint()?).map_err(|_| Self::error())?;
|
||||
self.skip_bytes(len)
|
||||
}
|
||||
THRIFT_COMPACT_LIST | THRIFT_COMPACT_SET => {
|
||||
let (element, count) = self.list_header()?;
|
||||
for _ in 0..count {
|
||||
self.skip_element(element, depth + 1)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
THRIFT_COMPACT_MAP => {
|
||||
let count = self.varint()?;
|
||||
let count = self.collection_count(count)?;
|
||||
if count == 0 {
|
||||
return Ok(());
|
||||
}
|
||||
let kinds = self.byte()?;
|
||||
for _ in 0..count {
|
||||
self.skip_element(kinds >> 4, depth + 1)?;
|
||||
self.skip_element(kinds & 0x0f, depth + 1)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
THRIFT_COMPACT_STRUCT => self.skip_struct(depth + 1),
|
||||
_ => Err(Self::error()),
|
||||
}
|
||||
}
|
||||
|
||||
/// A collection element carries its own bytes, but parquet skips a bool
|
||||
/// element without consuming any. Either width would let the walker and
|
||||
/// the decoder disagree on where the next header starts; no Parquet
|
||||
/// struct holds a bool collection, so fail closed instead.
|
||||
fn skip_element(&mut self, kind: u8, depth: usize) -> TableCatalogStoreResult<()> {
|
||||
match kind {
|
||||
THRIFT_COMPACT_BOOL_TRUE | THRIFT_COMPACT_BOOL_FALSE => Err(Self::error()),
|
||||
kind => self.skip_value(kind, depth),
|
||||
}
|
||||
}
|
||||
|
||||
fn skip_struct(&mut self, depth: usize) -> TableCatalogStoreResult<()> {
|
||||
let mut field_id = 0_i16;
|
||||
loop {
|
||||
let header = self.byte()?;
|
||||
if header == THRIFT_COMPACT_STOP {
|
||||
return Ok(());
|
||||
}
|
||||
field_id = self.field_id(field_id, header)?;
|
||||
self.skip_value(header & 0x0f, depth)?;
|
||||
}
|
||||
}
|
||||
|
||||
/// Read a `PageHeader` struct, returning its sizes and leaving the cursor at
|
||||
/// the first page byte.
|
||||
fn page_header(&mut self) -> TableCatalogStoreResult<PageHeaderSizes> {
|
||||
let mut sizes = PageHeaderSizes::default();
|
||||
let mut field_id = 0_i16;
|
||||
loop {
|
||||
let header = self.byte()?;
|
||||
if header == THRIFT_COMPACT_STOP {
|
||||
return Ok(sizes);
|
||||
}
|
||||
let kind = header & 0x0f;
|
||||
field_id = self.field_id(field_id, header)?;
|
||||
match field_id {
|
||||
PAGE_HEADER_FIELD_UNCOMPRESSED_SIZE => sizes.uncompressed = self.size_field(kind)?,
|
||||
PAGE_HEADER_FIELD_COMPRESSED_SIZE => sizes.compressed = self.size_field(kind)?,
|
||||
_ => self.skip_value(kind, 1)?,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Walk the footer's `FileMetaData`. The pinned parquet reserves the
|
||||
/// declared `row_groups` capacity before reading one element; charge that
|
||||
/// reservation to the budget so a small footer cannot request gigabytes.
|
||||
fn file_metadata(&mut self, limit: usize) -> TableCatalogStoreResult<()> {
|
||||
let mut field_id = 0_i16;
|
||||
let mut reserved = 0_usize;
|
||||
loop {
|
||||
let header = self.byte()?;
|
||||
if header == THRIFT_COMPACT_STOP {
|
||||
return Ok(());
|
||||
}
|
||||
let kind = header & 0x0f;
|
||||
field_id = self.field_id(field_id, header)?;
|
||||
if field_id == FILE_METADATA_FIELD_ROW_GROUPS && kind == THRIFT_COMPACT_LIST {
|
||||
let (element, count) = self.list_header()?;
|
||||
if element != THRIFT_COMPACT_STRUCT {
|
||||
return Err(Self::error());
|
||||
}
|
||||
let reservation = count.checked_mul(size_of::<RowGroupMetaData>()).ok_or_else(Self::error)?;
|
||||
add_budget(&mut reserved, reservation, limit)?;
|
||||
for _ in 0..count {
|
||||
self.skip_struct(2)?;
|
||||
}
|
||||
} else {
|
||||
self.skip_value(kind, 0)?;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Reject footer collection counts the decoder would allocate for before it
|
||||
/// reads a single element. Bytes after the struct are ignored, as parquet does.
|
||||
fn validate_footer_metadata(data: &Bytes, limit: usize) -> TableCatalogStoreResult<()> {
|
||||
rustfs_s3select_api::parquet_budget::validate_file_footer(data, limit).map_err(parquet_admission_error)
|
||||
let error = || TableCatalogStoreError::Invalid("compaction parquet footer is malformed".to_owned());
|
||||
let tail_start = data.len().checked_sub(FOOTER_SIZE).ok_or_else(error)?;
|
||||
let tail: &[u8; FOOTER_SIZE] = data[tail_start..].try_into().map_err(|_| error())?;
|
||||
let tail = FooterTail::try_new(tail).map_err(|_| error())?;
|
||||
let metadata_start = tail_start.checked_sub(tail.metadata_length()).ok_or_else(error)?;
|
||||
let mut cursor = ThriftCompactCursor {
|
||||
bytes: &data[metadata_start..tail_start],
|
||||
pos: 0,
|
||||
};
|
||||
cursor.file_metadata(limit)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
fn validate_page_headers_in_range(chunk: &[u8], declared: usize, limit: usize) -> TableCatalogStoreResult<usize> {
|
||||
rustfs_s3select_api::parquet_budget::validate_page_headers(chunk, declared, limit).map_err(parquet_admission_error)
|
||||
/// Sum the page headers of one column chunk (`[start, end)` in the file) and
|
||||
/// hold every page and the chunk total to `limit`. Pages are never decompressed.
|
||||
fn validate_page_headers_in_range(chunk: &[u8], chunk_declared: usize, limit: usize) -> TableCatalogStoreResult<usize> {
|
||||
let mut cursor = ThriftCompactCursor { bytes: chunk, pos: 0 };
|
||||
let mut total = 0_usize;
|
||||
while cursor.pos < chunk.len() {
|
||||
let sizes = cursor.page_header()?;
|
||||
add_budget(&mut total, sizes.uncompressed, limit)?;
|
||||
if total > chunk_declared.max(limit.min(chunk_declared.saturating_mul(2))) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"compaction parquet page headers exceed the footer's declared chunk size".to_owned(),
|
||||
));
|
||||
}
|
||||
cursor.skip_bytes(sizes.compressed)?;
|
||||
}
|
||||
Ok(total)
|
||||
}
|
||||
|
||||
fn validate_column_chunk_page_headers(
|
||||
data: &Bytes,
|
||||
column: &ColumnChunkMetaData,
|
||||
declared: usize,
|
||||
chunk_declared: usize,
|
||||
limit: usize,
|
||||
location: &str,
|
||||
) -> TableCatalogStoreResult<usize> {
|
||||
rustfs_s3select_api::parquet_budget::validate_column_chunk_page_headers(data, column, declared, limit).map_err(|error| {
|
||||
match parquet_admission_error(error) {
|
||||
TableCatalogStoreError::Invalid(message) => TableCatalogStoreError::Invalid(format!("{location}: {message}")),
|
||||
error => error,
|
||||
}
|
||||
})
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
// parquet's `byte_range`: the chunk starts at the dictionary page when the
|
||||
// footer declares one, wherever that is. Walk exactly the bytes it decodes.
|
||||
let start = column.dictionary_page_offset().unwrap_or(column.data_page_offset());
|
||||
let start = usize::try_from(start).map_err(|_| budget_error())?;
|
||||
let length = usize::try_from(column.compressed_size()).map_err(|_| budget_error())?;
|
||||
let end = start.checked_add(length).filter(|end| *end <= data.len()).ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid(format!("compaction parquet {location} column chunk lies outside the file"))
|
||||
})?;
|
||||
validate_page_headers_in_range(&data[start..end], chunk_declared, limit).map_err(|err| match err {
|
||||
TableCatalogStoreError::Invalid(message) => TableCatalogStoreError::Invalid(format!("{location}: {message}")),
|
||||
other => other,
|
||||
})?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn view_field(field: &Field, depth: usize, fields: &mut usize) -> TableCatalogStoreResult<Arc<Field>> {
|
||||
@@ -316,11 +542,11 @@ fn compact_parquet_with_budgets(
|
||||
let mut columns = 0;
|
||||
for column in group.columns() {
|
||||
let chunk_declared = usize::try_from(column.uncompressed_size()).map_err(|_| budget_error())?;
|
||||
add_budget(&mut columns, chunk_declared, limit)?;
|
||||
// The footer is one claim; the page headers the decoder actually
|
||||
// sizes its buffers from are another. Check the page headers
|
||||
// and codec expansion before admitting the decoder.
|
||||
let resident = validate_column_chunk_page_headers(&data, column, chunk_declared, limit, &location)?;
|
||||
add_budget(&mut columns, chunk_declared.max(resident), limit)?;
|
||||
// sizes its buffers from are another. Walk them without
|
||||
// decompressing and hold both to the budget.
|
||||
validate_column_chunk_page_headers(&data, column, chunk_declared, limit, &location)?;
|
||||
}
|
||||
let group_bytes = usize::try_from(group.total_byte_size()).map_err(|_| budget_error())?;
|
||||
add_budget(&mut declared, group_bytes.max(columns), limit)?;
|
||||
@@ -624,9 +850,9 @@ mod tests {
|
||||
#[test]
|
||||
fn compaction_page_header_walker_bounds_collection_counts_by_remaining_bytes() {
|
||||
let limit = 64 * 1024 * 1024;
|
||||
// Unknown field 10: LIST<BOOL> with long-form count 2^63. Parquet's skip
|
||||
// Unknown field 4: LIST<BOOL> with long-form count 2^63. Parquet's skip
|
||||
// would spin; the walker must reject it before iterating.
|
||||
let mut list = vec![(7 << 4) | THRIFT_COMPACT_LIST, 0xf0 | THRIFT_COMPACT_BOOL_TRUE];
|
||||
let mut list = vec![(1 << 4) | THRIFT_COMPACT_LIST, 0xf0 | THRIFT_COMPACT_BOOL_TRUE];
|
||||
list.extend(varint(1 << 63));
|
||||
let started = std::time::Instant::now();
|
||||
let error = validate_page_headers_in_range(&page_chunk(compact_i32_field(1, 8), &list), 4096, limit)
|
||||
@@ -638,15 +864,15 @@ mod tests {
|
||||
assert!(started.elapsed() < std::time::Duration::from_secs(1));
|
||||
// A bool collection of any size is rejected: parquet consumes no bytes
|
||||
// per element, so either width would desynchronize the two parsers.
|
||||
let list = [(7 << 4) | THRIFT_COMPACT_LIST, (2 << 4) | THRIFT_COMPACT_BOOL_TRUE, 1, 1];
|
||||
let list = [(1 << 4) | THRIFT_COMPACT_LIST, (2 << 4) | THRIFT_COMPACT_BOOL_TRUE, 1, 1];
|
||||
assert!(validate_page_headers_in_range(&page_chunk(compact_i32_field(1, 8), &list), 4096, limit).is_err());
|
||||
// MAP<BOOL, BOOL> with a huge count is rejected the same way.
|
||||
let mut map = vec![(7 << 4) | THRIFT_COMPACT_MAP];
|
||||
let mut map = vec![(1 << 4) | THRIFT_COMPACT_MAP];
|
||||
map.extend(varint(1 << 62));
|
||||
map.push((THRIFT_COMPACT_BOOL_TRUE << 4) | THRIFT_COMPACT_BOOL_TRUE);
|
||||
assert!(validate_page_headers_in_range(&page_chunk(compact_i32_field(1, 8), &map), 4096, limit).is_err());
|
||||
// Collections whose elements carry bytes still skip when the count fits.
|
||||
let mut list = vec![(7 << 4) | THRIFT_COMPACT_LIST, (2 << 4) | THRIFT_COMPACT_I32];
|
||||
let mut list = vec![(1 << 4) | THRIFT_COMPACT_LIST, (2 << 4) | THRIFT_COMPACT_I32];
|
||||
list.extend(compact_i32_field(0, 7)[1..].iter());
|
||||
list.extend(compact_i32_field(0, -7)[1..].iter());
|
||||
assert_eq!(
|
||||
@@ -654,7 +880,7 @@ mod tests {
|
||||
8
|
||||
);
|
||||
// A LIST<I32> whose count exceeds the chunk is malformed, not truncated.
|
||||
let list = [(7 << 4) | THRIFT_COMPACT_LIST, 0xf0 | THRIFT_COMPACT_I32, 0x7f];
|
||||
let list = [(1 << 4) | THRIFT_COMPACT_LIST, 0xf0 | THRIFT_COMPACT_I32, 0x7f];
|
||||
assert!(validate_page_headers_in_range(&page_chunk(compact_i32_field(1, 8), &list), 4096, limit).is_err());
|
||||
}
|
||||
|
||||
@@ -730,35 +956,6 @@ mod tests {
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compaction_aggregates_column_decode_working_sets() {
|
||||
let columns =
|
||||
(0..4).map(|index| (format!("value_{index}"), Arc::new(StringArray::from(vec!["v"; 1000])) as Arc<dyn Array>));
|
||||
let batch = RecordBatch::try_from_iter(columns).expect("multi-column batch");
|
||||
let properties = WriterProperties::builder()
|
||||
.set_compression(Compression::ZSTD(ZstdLevel::default()))
|
||||
.build();
|
||||
let mut writer = ArrowWriter::try_new(Vec::new(), batch.schema(), Some(properties)).expect("Parquet writer");
|
||||
writer.write(&batch).expect("multi-column data");
|
||||
let data = Bytes::from(writer.into_inner().expect("Parquet footer"));
|
||||
let limit = 100 * 1024;
|
||||
let reader = ParquetRecordBatchReaderBuilder::try_new(data.clone()).expect("valid fixture metadata");
|
||||
let mut working_set = 0;
|
||||
for column in reader.metadata().row_group(0).columns() {
|
||||
let declared = usize::try_from(column.uncompressed_size()).expect("positive size");
|
||||
working_set += validate_column_chunk_page_headers(&data, column, declared, limit, "columns.parquet")
|
||||
.expect("each column fits individually");
|
||||
}
|
||||
assert!(working_set > limit, "the aggregate exceeds the decode budget");
|
||||
let error = compact_parquet_with_limits(vec![("columns.parquet".to_owned(), data.to_vec())], limit, limit)
|
||||
.err()
|
||||
.expect("aggregate column allocations must be admitted before decoding");
|
||||
assert!(
|
||||
matches!(&error, TableCatalogStoreError::Invalid(message) if message.contains("budget")),
|
||||
"{error:?}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compaction_rejects_compressed_expansion_before_decoding_pages() {
|
||||
let file = parquet_strings(&"x".repeat(64 * 1024), 32, false);
|
||||
|
||||
@@ -230,8 +230,8 @@ mod tests {
|
||||
|
||||
type TestStore = ConfiguredTableCatalogStore<TestCatalogObjectBackend>;
|
||||
|
||||
fn backings() -> [TableCatalogBackingMode; 1] {
|
||||
[TableCatalogBackingMode::ObjectBacked]
|
||||
fn backings() -> [TableCatalogBackingMode; 2] {
|
||||
[TableCatalogBackingMode::ObjectBacked, TableCatalogBackingMode::DurableStrong]
|
||||
}
|
||||
|
||||
fn enabled_config() -> TableMaintenanceConfig {
|
||||
|
||||
@@ -16,8 +16,8 @@ use super::periodic::PeriodicMaintenanceScheduler;
|
||||
use crate::storage_api::startup::services::ServerContextSlot;
|
||||
use crate::storage_api::table::check_valid_bucket_name_strict;
|
||||
use crate::table_catalog::{
|
||||
ConfiguredTableCatalogStore, EcStoreTableCatalogObjectBackend, ObjectTableCatalogStore, TableCatalogBackingMode,
|
||||
TableCatalogStoreError, TableCatalogStoreResult,
|
||||
ConfiguredTableCatalogStore, EcStoreTableCatalogObjectBackend, ObjectTableCatalogStore, StrongTableCatalogStore,
|
||||
TableCatalogBackingMode, TableCatalogStoreError, TableCatalogStoreResult,
|
||||
};
|
||||
use std::{collections::BTreeSet, future::Future, sync::Arc, time::Duration};
|
||||
use tokio::{task::JoinHandle, time::Instant};
|
||||
@@ -166,11 +166,17 @@ async fn run(config: PeriodicMaintenanceConfig, server: Arc<ServerContextSlot>,
|
||||
let Some(context) = server.installed_app_context() else {
|
||||
continue;
|
||||
};
|
||||
let backend = EcStoreTableCatalogObjectBackend::new(context.object_store());
|
||||
let backend = EcStoreTableCatalogObjectBackend::new_with_strong_runtime(
|
||||
context.object_store(),
|
||||
context.table_catalog_strong_runtime(),
|
||||
);
|
||||
let store = match config.backing {
|
||||
TableCatalogBackingMode::ObjectBacked => {
|
||||
ConfiguredTableCatalogStore::ObjectBacked(ObjectTableCatalogStore::new(backend))
|
||||
}
|
||||
TableCatalogBackingMode::DurableStrong => {
|
||||
ConfiguredTableCatalogStore::DurableStrong(StrongTableCatalogStore::new_requiring_snapshot(backend))
|
||||
}
|
||||
};
|
||||
scheduler = Some(PeriodicMaintenanceScheduler::new(store, config.buckets.clone(), config.interval));
|
||||
}
|
||||
@@ -219,7 +225,7 @@ mod tests {
|
||||
.find(|(name, _)| *name == key)
|
||||
.map(|(_, value)| value.to_string()))
|
||||
},
|
||||
|| Ok(TableCatalogBackingMode::ObjectBacked),
|
||||
|| Ok(TableCatalogBackingMode::DurableStrong),
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
@@ -732,6 +732,29 @@ pub(crate) fn metadata_maintenance_reachability_graph_report(
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) async fn metadata_maintenance_object_cleanup_reports<B>(
|
||||
backend: &B,
|
||||
table_bucket: &str,
|
||||
namespace: &Namespace,
|
||||
table: &IdentifierSegment,
|
||||
warehouse_object_prefix: Option<&str>,
|
||||
referenced_object_reports: &[TableMetadataMaintenanceReferencedObjectReport],
|
||||
now: OffsetDateTime,
|
||||
) -> TableCatalogStoreResult<(usize, Vec<String>, Vec<String>, Vec<TableMetadataMaintenanceObjectCleanupReport>)>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
metadata_maintenance_object_cleanup_reports_in_scope(
|
||||
backend,
|
||||
table_bucket,
|
||||
TableMaintenanceObjectScope::Logical { namespace, table },
|
||||
warehouse_object_prefix,
|
||||
referenced_object_reports,
|
||||
now,
|
||||
)
|
||||
.await
|
||||
}
|
||||
|
||||
pub(crate) async fn metadata_maintenance_object_cleanup_reports_for_entry<B>(
|
||||
backend: &B,
|
||||
entry: &TableEntry,
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
use std::{
|
||||
collections::{BTreeMap, BTreeSet},
|
||||
num::NonZeroUsize,
|
||||
ops::Bound,
|
||||
sync::Arc,
|
||||
time::{Duration as StdDuration, Instant},
|
||||
};
|
||||
@@ -70,15 +71,13 @@ mod store;
|
||||
pub use error::{CatalogIdentifierError, TableObjectMutationError};
|
||||
pub(crate) use error::{TableCatalogStoreError, TableCatalogStoreResult};
|
||||
pub(crate) use iceberg::*;
|
||||
#[cfg(test)]
|
||||
use identifier::metadata_location_from_metadata_file_path;
|
||||
pub use identifier::{IdentifierSegment, Namespace, is_reserved_table_object_key};
|
||||
pub(crate) use identifier::{
|
||||
default_table_bucket_publication_lock_path, default_table_data_dir_path, default_table_delete_dir_path,
|
||||
default_table_metadata_dir_path, default_table_metadata_file_path, default_table_publication_lock_path,
|
||||
default_view_metadata_file_path, is_valid_table_metadata_location, is_valid_table_metadata_location_for_entry,
|
||||
is_valid_view_metadata_location, table_identity_from_metadata_object_key, table_metadata_dir_path_for_entry,
|
||||
table_metadata_file_path_for_entry, validate_bucket_object_mutation,
|
||||
is_valid_view_metadata_location, metadata_location_from_metadata_file_path, table_identity_from_metadata_object_key,
|
||||
table_metadata_dir_path_for_entry, table_metadata_file_path_for_entry, validate_bucket_object_mutation,
|
||||
};
|
||||
pub(crate) use maintenance::*;
|
||||
pub(crate) use model::*;
|
||||
@@ -122,7 +121,11 @@ pub(crate) const DEFAULT_TABLE_CATALOG_PUBLICATION_PREPARATION_TIMEOUT_SECS: u64
|
||||
pub(crate) const MAX_TABLE_CATALOG_PUBLICATION_PREPARATION_TIMEOUT_SECS: u64 = 86_400;
|
||||
pub(crate) const ENV_TABLE_CATALOG_PUBLICATION_FENCE_FLEET_CONFIRMED: &str =
|
||||
"RUSTFS_TABLE_CATALOG_PUBLICATION_FENCE_FLEET_CONFIRMED";
|
||||
pub(crate) const ENV_TABLE_CATALOG_STRONG_SNAPSHOT_V2: &str = "RUSTFS_TABLE_CATALOG_STRONG_SNAPSHOT_V2";
|
||||
pub(crate) const ENV_TABLE_CATALOG_STRONG_SNAPSHOT_V2_FLEET_CONFIRMED: &str =
|
||||
"RUSTFS_TABLE_CATALOG_STRONG_SNAPSHOT_V2_FLEET_CONFIRMED";
|
||||
pub(crate) const TABLE_CATALOG_BACKING_OBJECT: &str = "object";
|
||||
pub(crate) const TABLE_CATALOG_BACKING_DURABLE_STRONG: &str = "durable-strong";
|
||||
pub(crate) const TABLE_METADATA_DIGEST_REQUIREMENT_TYPE: &str = "assert-rustfs-metadata-sha256";
|
||||
pub(crate) const TABLE_METADATA_FILE_NAME_MAX_LEN: usize = 128;
|
||||
pub(crate) const TABLE_METADATA_JSON_MAX_SIZE: usize = 50 * 1024 * 1024;
|
||||
@@ -196,6 +199,7 @@ const MAINTENANCE_JOB_ALIAS_LATEST: &str = "latest";
|
||||
const MAINTENANCE_JOB_ALIAS_CURRENT: &str = "current";
|
||||
const TABLE_CATALOG_LIST_MAX_KEYS: usize = 1000;
|
||||
const OBJECT_CATALOG_LIST_CURSOR_PREFIX: &str = "object:";
|
||||
const STRONG_CATALOG_LIST_CURSOR_PREFIX: &str = "strong:";
|
||||
const TABLE_METADATA_CLEANUP_SAFETY_WINDOW_SECONDS: i64 = 15 * 60;
|
||||
const TABLE_MAINTENANCE_RETRY_BACKOFF_MAX_SECONDS: u64 = 24 * 60 * 60;
|
||||
const TABLE_MAINTENANCE_WORKER_LEASE_TIMEOUT_DEFAULT_SECONDS: u64 = 15 * 60;
|
||||
@@ -210,8 +214,24 @@ const ICEBERG_MAX_REF_AGE_MS_PROPERTY: &str = "history.expire.max-ref-age-ms";
|
||||
const ICEBERG_REF_MIN_SNAPSHOTS_TO_KEEP_FIELD: &str = "min-snapshots-to-keep";
|
||||
const ICEBERG_REF_MAX_SNAPSHOT_AGE_MS_FIELD: &str = "max-snapshot-age-ms";
|
||||
const ICEBERG_REF_MAX_REF_AGE_MS_FIELD: &str = "max-ref-age-ms";
|
||||
const STRONG_TABLE_CATALOG_SNAPSHOT_MIN_READ_VERSION: u16 = 1;
|
||||
const STRONG_TABLE_CATALOG_SNAPSHOT_VERSION: u16 = 2;
|
||||
const STRONG_TABLE_CATALOG_BACKING_ROOT: &str = "strong-backing";
|
||||
const STRONG_TABLE_CATALOG_SNAPSHOT_FILE: &str = "snapshot.json";
|
||||
const TABLE_CATALOG_MIGRATION_MIN_READ_VERSION: u16 = 1;
|
||||
const TABLE_CATALOG_MIGRATION_VERSION: u16 = 2;
|
||||
const TABLE_CATALOG_MIGRATION_ROOT: &str = "backing-migration";
|
||||
const TABLE_CATALOG_MIGRATION_FENCE_FILE: &str = "durable-strong-fence.json";
|
||||
const TABLE_CATALOG_MIGRATION_FENCE_LOCK: &str = "durable-strong-fence.lock";
|
||||
const TABLE_CATALOG_MIGRATION_GLOBAL_FENCE_FILE: &str = "durable-strong-global-fence.json";
|
||||
const TABLE_CATALOG_MIGRATION_GLOBAL_FENCE_LOCK: &str = "durable-strong-global-fence.lock";
|
||||
pub(crate) const TABLE_CATALOG_BACKUP_VERSION: u16 = 2;
|
||||
const TABLE_CATALOG_BACKUP_ROOT: &str = "backups";
|
||||
const TABLE_CATALOG_BACKUP_RESTORE_ROOT: &str = "restore-intents";
|
||||
const TABLE_CATALOG_BACKUP_RESTORE_INTENT_FILE: &str = "intent.json";
|
||||
const TABLE_CATALOG_BACKUP_MAX_SIZE: usize = 64 * 1024 * 1024;
|
||||
const TABLE_CATALOG_BACKUP_MAX_OBJECTS: usize = 1_000_000;
|
||||
const TABLE_CATALOG_BACKUP_HASH_MAX_SIZE: u64 = 16 * 1024 * 1024;
|
||||
const TABLE_CATALOG_BACKUP_MAX_MAINTENANCE_OBJECT_SIZE: usize = 4 * 1024 * 1024;
|
||||
const TABLE_CATALOG_BACKUP_MAX_MAINTENANCE_BYTES: usize = 32 * 1024 * 1024;
|
||||
|
||||
@@ -283,6 +303,7 @@ impl<T> TableCatalogStorage for T where
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub(crate) enum TableCatalogBackingMode {
|
||||
ObjectBacked,
|
||||
DurableStrong,
|
||||
}
|
||||
|
||||
impl TableCatalogBackingMode {
|
||||
@@ -299,8 +320,9 @@ impl TableCatalogBackingMode {
|
||||
fn parse(value: &str) -> TableCatalogStoreResult<Self> {
|
||||
match value.trim() {
|
||||
"" | TABLE_CATALOG_BACKING_OBJECT => Ok(Self::ObjectBacked),
|
||||
TABLE_CATALOG_BACKING_DURABLE_STRONG => Ok(Self::DurableStrong),
|
||||
value => Err(TableCatalogStoreError::Invalid(format!(
|
||||
"unsupported table catalog backing {value}; expected {TABLE_CATALOG_BACKING_OBJECT}"
|
||||
"unsupported table catalog backing {value}; expected {TABLE_CATALOG_BACKING_OBJECT} or {TABLE_CATALOG_BACKING_DURABLE_STRONG}"
|
||||
))),
|
||||
}
|
||||
}
|
||||
@@ -308,6 +330,7 @@ impl TableCatalogBackingMode {
|
||||
pub(crate) fn as_str(self) -> &'static str {
|
||||
match self {
|
||||
Self::ObjectBacked => TABLE_CATALOG_BACKING_OBJECT,
|
||||
Self::DurableStrong => TABLE_CATALOG_BACKING_DURABLE_STRONG,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -65,8 +65,6 @@ pub(crate) struct TableBucketEntry {
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableRenameIntentState {
|
||||
Prepared,
|
||||
/// The maintenance plan is durable before any destination sidecar is written.
|
||||
MaintenancePrepared,
|
||||
SourceFenced,
|
||||
DestinationWritten,
|
||||
SourceTombstoned,
|
||||
@@ -1088,6 +1086,7 @@ pub(crate) struct TableCatalogExport {
|
||||
pub(crate) struct TableCatalogBackingManifest {
|
||||
pub version: u16,
|
||||
pub current: TableCatalogBackingProfile,
|
||||
pub migration: TableCatalogBackingMigrationPlan,
|
||||
pub ha: TableCatalogHaPolicy,
|
||||
pub scale_validation: TableCatalogScaleValidation,
|
||||
}
|
||||
@@ -1107,24 +1106,42 @@ pub(crate) struct TableCatalogBackingProfile {
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingKind {
|
||||
ObjectBacked,
|
||||
// RUSTFS_COMPAT_TODO(table-catalog-backing-manifest-v1-wire-labels): Keep the version 1 wire label for existing clients. Remove after a versioned manifest with an explicit client migration contract replaces it.
|
||||
#[serde(rename = "STRONG_KV_WAL")]
|
||||
DurableStrongSnapshot,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogAuthority {
|
||||
RustfsSysObject,
|
||||
#[allow(
|
||||
dead_code,
|
||||
reason = "exercised by table_catalog/tests.rs; the lib target cannot see test-only consumers (backlog#1823)"
|
||||
)]
|
||||
LinearizableMetadataKv,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogConsistencyMode {
|
||||
ConditionalObjectCas,
|
||||
#[allow(
|
||||
dead_code,
|
||||
reason = "exercised by table_catalog/tests.rs; the lib target cannot see test-only consumers (backlog#1823)"
|
||||
)]
|
||||
LinearizableCas,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogDurabilityMode {
|
||||
StagedCommitLogBeforePointerUpdate,
|
||||
#[allow(
|
||||
dead_code,
|
||||
reason = "exercised by table_catalog/tests.rs; the lib target cannot see test-only consumers (backlog#1823)"
|
||||
)]
|
||||
WalBeforeStateMachineApply,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
@@ -1160,6 +1177,132 @@ pub(crate) struct TableCatalogSnapshotState {
|
||||
pub snapshot_version: Option<u16>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackingMigrationPlan {
|
||||
pub source_kind: TableCatalogBackingKind,
|
||||
pub target_kind: TableCatalogBackingKind,
|
||||
pub status: TableCatalogBackingMigrationStatus,
|
||||
pub required_steps: Vec<TableCatalogBackingMigrationStep>,
|
||||
pub blockers: Vec<TableCatalogBackingMigrationBlocker>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackingMigrationDryRunReport {
|
||||
pub table_bucket: String,
|
||||
pub source_kind: TableCatalogBackingKind,
|
||||
pub target_kind: TableCatalogBackingKind,
|
||||
pub status: TableCatalogBackingMigrationStatus,
|
||||
pub namespace_count: usize,
|
||||
pub table_count: usize,
|
||||
pub view_count: usize,
|
||||
pub commit_log_count: usize,
|
||||
pub idempotency_index_count: usize,
|
||||
pub warehouse_prefix_count: usize,
|
||||
pub warehouse_index_ready: bool,
|
||||
pub object_backed_writes_fenced: bool,
|
||||
pub ready_to_enable_durable_strong: bool,
|
||||
pub blockers: Vec<TableCatalogBackingMigrationBlocker>,
|
||||
pub recommended_actions: Vec<TableCatalogBackingMigrationAction>,
|
||||
pub rollback: TableCatalogBackingRollbackPlan,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackingMigrationExecutionReport {
|
||||
pub table_bucket: String,
|
||||
pub source_kind: TableCatalogBackingKind,
|
||||
pub target_kind: TableCatalogBackingKind,
|
||||
pub status: TableCatalogBackingMigrationExecutionStatus,
|
||||
pub namespace_count: usize,
|
||||
pub table_count: usize,
|
||||
pub view_count: usize,
|
||||
pub commit_log_count: usize,
|
||||
pub idempotency_index_count: usize,
|
||||
pub source_fingerprint: String,
|
||||
pub target_snapshot_etag: String,
|
||||
pub object_backed_writes_fenced: bool,
|
||||
pub ready_to_enable_durable_strong: bool,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingMigrationExecutionStatus {
|
||||
SnapshotMaterialized,
|
||||
SnapshotAlreadyMaterialized,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackingMigrationCancelReport {
|
||||
pub table_bucket: String,
|
||||
pub status: TableCatalogBackingMigrationCancelStatus,
|
||||
pub object_backed_writes_fenced: bool,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingMigrationCancelStatus {
|
||||
FenceReleased,
|
||||
NoMigrationFence,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingMigrationStatus {
|
||||
ReadyToSnapshot,
|
||||
SnapshotMaterialized,
|
||||
RecoveryRequired,
|
||||
ManualReviewRequired,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingMigrationStep {
|
||||
SnapshotCatalogExport,
|
||||
ReplayCommitLog,
|
||||
VerifyCurrentPointer,
|
||||
EnableSingleWriterFencing,
|
||||
// RUSTFS_COMPAT_TODO(table-catalog-backing-manifest-v1-wire-labels): Keep the version 1 wire label for existing clients. Remove after a versioned manifest with an explicit client migration contract replaces it.
|
||||
#[serde(rename = "CUT_OVER_LINEARIZABLE_READS")]
|
||||
CutOverDurableSnapshotReads,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingMigrationBlocker {
|
||||
TableRenameRecoveryRequired,
|
||||
CommitRecoveryRequired,
|
||||
CommitManualReviewRequired,
|
||||
WarehouseIndexBackfillRequired,
|
||||
DuplicateWarehousePrefix,
|
||||
DuplicateTableIdentity,
|
||||
TableViewIdentifierCollision,
|
||||
DurableStrongSnapshotChanged,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackingMigrationAction {
|
||||
RunCatalogRecovery,
|
||||
BackfillWarehouseIndex,
|
||||
ReviewDuplicateWarehousePrefixes,
|
||||
ReviewDuplicateTableIdentities,
|
||||
ReviewTableViewIdentifierCollisions,
|
||||
SnapshotObjectBackedCatalog,
|
||||
EnableDurableStrongBacking,
|
||||
VerifyDurableStrongSnapshot,
|
||||
SnapshotRemainingTableBuckets,
|
||||
ReviewDurableStrongSnapshot,
|
||||
KeepObjectBackedRollbackConfig,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackingRollbackPlan {
|
||||
pub backing_config_key: &'static str,
|
||||
pub current_backing_value: &'static str,
|
||||
pub rollback_backing_value: &'static str,
|
||||
pub preserves_object_backed_catalog: bool,
|
||||
pub requires_operator_restart: bool,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogHaPolicy {
|
||||
pub writer_region_model: TableCatalogHaWriterModel,
|
||||
@@ -1205,6 +1348,7 @@ pub(crate) enum TableCatalogScaleValidationStatus {
|
||||
pub(crate) enum TableCatalogScaleValidationScenario {
|
||||
ConcurrentCommitCas,
|
||||
CommitLogRecoveryReplay,
|
||||
MigrationSnapshotReplay,
|
||||
ReadReplicaStaleReadGuard,
|
||||
ClientConformanceMatrix,
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,74 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use serde::Serialize;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackupStatus {
|
||||
Created,
|
||||
AlreadyPresent,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogBackupObjectPreparationStatus {
|
||||
Prepared,
|
||||
AlreadyPresent,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackupObjectPreparationReport {
|
||||
pub table_bucket: String,
|
||||
pub backup_id: String,
|
||||
pub object: String,
|
||||
pub status: TableCatalogBackupObjectPreparationStatus,
|
||||
pub size_bytes: u64,
|
||||
pub sha256: String,
|
||||
pub etag: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogBackupReport {
|
||||
pub table_bucket: String,
|
||||
pub backup_id: String,
|
||||
pub status: TableCatalogBackupStatus,
|
||||
pub backup_path: String,
|
||||
pub source_snapshot_etag: String,
|
||||
pub source_snapshot_version: u16,
|
||||
pub catalog_fingerprint: String,
|
||||
pub object_count: usize,
|
||||
pub verified_object_count: usize,
|
||||
pub verified_bytes: u64,
|
||||
pub maintenance_object_count: usize,
|
||||
pub created_at: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(crate) enum TableCatalogRestoreStatus {
|
||||
Restored,
|
||||
AlreadyRestored,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
pub(crate) struct TableCatalogRestoreReport {
|
||||
pub table_bucket: String,
|
||||
pub backup_id: String,
|
||||
pub status: TableCatalogRestoreStatus,
|
||||
pub previous_snapshot_etag: Option<String>,
|
||||
pub restored_snapshot_etag: String,
|
||||
pub object_count: usize,
|
||||
pub maintenance_object_count: usize,
|
||||
}
|
||||
@@ -58,7 +58,14 @@ impl<B: TableCatalogObjectBackend> ObjectTableCatalogStore<B> {
|
||||
validate_table_bucket_entry(&entry)?;
|
||||
let mut guards = Vec::new();
|
||||
if publication.is_some_and(|publication| publication.catalog_migration_read_permit_status() == Some(true)) {
|
||||
self.reject_legacy_catalog_global_state().await?;
|
||||
if self
|
||||
.backend
|
||||
.read_object(self.catalog_bucket(), &self.paths.backing_migration_global_fence_path())
|
||||
.await?
|
||||
.is_some()
|
||||
{
|
||||
return Err(cleanup_conflict("table bucket registry migration is in progress"));
|
||||
}
|
||||
self.ensure_object_backed_catalog_write_permit_after_lock(&entry.table_bucket)
|
||||
.await?;
|
||||
} else {
|
||||
@@ -246,8 +253,12 @@ impl<B: TableCatalogObjectBackend> ConfiguredTableCatalogStore<B> {
|
||||
entry: TableBucketEntry,
|
||||
publication: &impl TableCatalogObjectBackend,
|
||||
) -> TableCatalogStoreResult<EmptyTableBucketCleanup> {
|
||||
let Self::ObjectBacked(store) = self;
|
||||
store.prepare_empty_table_bucket_cleanup(entry, publication).await
|
||||
match self {
|
||||
Self::ObjectBacked(store) => store.prepare_empty_table_bucket_cleanup(entry, publication).await,
|
||||
Self::DurableStrong(_) => Err(TableCatalogStoreError::Unsupported(
|
||||
"empty table bucket cleanup requires object-backed catalog storage".to_string(),
|
||||
)),
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) async fn execute_empty_table_bucket_cleanup(
|
||||
@@ -255,7 +266,11 @@ impl<B: TableCatalogObjectBackend> ConfiguredTableCatalogStore<B> {
|
||||
cleanup: &mut EmptyTableBucketCleanup,
|
||||
incarnation: Uuid,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
let Self::ObjectBacked(store) = self;
|
||||
store.execute_empty_table_bucket_cleanup(cleanup, incarnation).await
|
||||
match self {
|
||||
Self::ObjectBacked(store) => store.execute_empty_table_bucket_cleanup(cleanup, incarnation).await,
|
||||
Self::DurableStrong(_) => Err(TableCatalogStoreError::Unsupported(
|
||||
"empty table bucket cleanup requires object-backed catalog storage".to_string(),
|
||||
)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -266,7 +266,6 @@ impl<B: TableCatalogObjectBackend> ObjectTableCatalogStore<B> {
|
||||
.backend
|
||||
.acquire_write_lock(self.catalog_bucket(), &self.paths.backing_migration_fence_lock_path(table_bucket))
|
||||
.await?;
|
||||
self.ensure_no_active_restore(table_bucket).await?;
|
||||
if self
|
||||
.backend
|
||||
.object_metadata(self.catalog_bucket(), &fence_path)
|
||||
@@ -370,7 +369,6 @@ impl<B: TableCatalogObjectBackend> ObjectTableCatalogStore<B> {
|
||||
.backend
|
||||
.acquire_write_lock(self.catalog_bucket(), &self.paths.backing_migration_fence_lock_path(table_bucket))
|
||||
.await?;
|
||||
self.ensure_no_active_restore(table_bucket).await?;
|
||||
if self.read_table_directory_state(table_bucket).await?.is_some() {
|
||||
// Entry publication has always retained the legacy objects. Exclude
|
||||
// backfill and all writers until the old authority is restored.
|
||||
@@ -633,25 +631,6 @@ fn validate_directory_page(
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
enum LegacyBackingMigrationFenceStatus {
|
||||
Preparing,
|
||||
Materialized,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct LegacyBackingMigrationFence {
|
||||
version: u16,
|
||||
table_bucket: String,
|
||||
migration_id: String,
|
||||
status: LegacyBackingMigrationFenceStatus,
|
||||
target_bucket_existed: bool,
|
||||
source_fingerprint: Option<String>,
|
||||
target_snapshot_etag: Option<String>,
|
||||
}
|
||||
use crate::table_catalog::test_support::TestCatalogObjectBackend;
|
||||
use crate::table_catalog::tests::{test_bucket_entry, test_namespace_entry, test_table_entry};
|
||||
|
||||
@@ -737,7 +716,7 @@ mod tests {
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
assert!(
|
||||
serde_json::from_slice::<LegacyBackingMigrationFence>(&fence.data).is_err(),
|
||||
serde_json::from_slice::<super::super::strong::TableCatalogBackingMigrationFence>(&fence.data).is_err(),
|
||||
"legacy writer parser must reject the directory capability fence"
|
||||
);
|
||||
finish(&store).await;
|
||||
@@ -787,39 +766,6 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_and_restore_treat_directory_objects_as_derived() {
|
||||
let (backend, store) = fixture().await;
|
||||
let baseline = store
|
||||
.create_object_catalog_backup("warehouse", None)
|
||||
.await
|
||||
.expect("empty enabled catalog is a valid backup source");
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let orphan = entry("warehouse", &namespace, "aborted");
|
||||
let table = IdentifierSegment::parse("aborted").unwrap();
|
||||
let target = store.paths.table_entry_path("warehouse", &namespace, &table);
|
||||
let candidate = store.paths.table_directory_candidate(&orphan).unwrap();
|
||||
// This is the exact immutable path reference a writer persists before its
|
||||
// entry PUT. An aborted PUT followed by rollback leaves only the candidate.
|
||||
backend.seed_object(RUSTFS_META_BUCKET, &candidate, target.into_bytes()).await;
|
||||
finish(&store).await;
|
||||
let with_directory = store.create_object_catalog_backup("warehouse", None).await.unwrap();
|
||||
assert_eq!(with_directory.backup_id, baseline.backup_id);
|
||||
assert!(matches!(
|
||||
store.restore_object_catalog_backup("warehouse", &baseline.backup_id, None, false).await,
|
||||
Err(TableCatalogStoreError::Conflict(message)) if message.contains("disable the table directory")
|
||||
));
|
||||
|
||||
store.disable_table_directory("warehouse").await.unwrap();
|
||||
let after_rollback = store.create_object_catalog_backup("warehouse", None).await.unwrap();
|
||||
assert_eq!(after_rollback.backup_id, baseline.backup_id);
|
||||
store
|
||||
.restore_object_catalog_backup("warehouse", &after_rollback.backup_id, None, false)
|
||||
.await
|
||||
.expect("derived candidates must not count as restore targets");
|
||||
assert!(backend.object_exists(RUSTFS_META_BUCKET, &candidate).await.unwrap());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn directory_index_excludes_reports_but_preserves_colliding_nested_namespaces() {
|
||||
let (backend, store) = fixture().await;
|
||||
@@ -1033,55 +979,6 @@ mod tests {
|
||||
"renamed"
|
||||
);
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn directory_activation_drains_in_flight_entry_writer_before_first_page() {
|
||||
let (backend, store) = fixture().await;
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
store
|
||||
.create_namespace(test_namespace_entry("warehouse", &namespace))
|
||||
.await
|
||||
.unwrap();
|
||||
let table = entry("warehouse", &namespace, "orders");
|
||||
let table_path = store
|
||||
.paths
|
||||
.table_entry_path("warehouse", &namespace, &IdentifierSegment::parse("orders").unwrap());
|
||||
let pause = backend.pause_next_put(RUSTFS_META_BUCKET, &table_path).await;
|
||||
let create_store = store.clone();
|
||||
let create = tokio::spawn(async move { create_store.create_table(table).await });
|
||||
tokio::time::timeout(StdDuration::from_secs(5), pause.wait_started())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
// An in-flight writer has checked that directory state is absent and
|
||||
// holds its per-bucket permit. Activation must queue on the same key.
|
||||
let lock_path = store.paths.catalog_backup_fence_lock_path("warehouse");
|
||||
let writes = backend.write_lock_acquisition_count(RUSTFS_META_BUCKET, &lock_path).await;
|
||||
let advance_store = store.clone();
|
||||
let mut advance = tokio::spawn(async move {
|
||||
advance_store
|
||||
.advance_table_directory_with_confirmation("warehouse", true, true)
|
||||
.await
|
||||
});
|
||||
tokio::time::timeout(StdDuration::from_secs(5), async {
|
||||
tokio::select! {
|
||||
result = &mut advance => panic!("activation passed an in-flight writer: {result:?}"),
|
||||
() = async {
|
||||
while backend.write_lock_acquisition_count(RUSTFS_META_BUCKET, &lock_path).await == writes {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
} => {}
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("activation must queue on the writer's per-bucket fence");
|
||||
pause.release();
|
||||
create.await.unwrap().unwrap();
|
||||
assert_eq!(advance.await.unwrap().unwrap().phase, Some(TableDirectoryPhase::Building));
|
||||
finish(&store).await;
|
||||
let scan = store.table_directory_objects("warehouse", None).await.unwrap().unwrap();
|
||||
assert_eq!(scan.objects, vec![table_path]);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn directory_index_cancelled_initial_write_retains_guard_until_rollback_can_finish() {
|
||||
let (backend, store) = fixture().await;
|
||||
@@ -1381,7 +1278,7 @@ mod tests {
|
||||
use crate::storage_api::table::test_support::{BucketOperations as _, MakeBucketOptions};
|
||||
let (_temp, paths, storage) = crate::app::gating_test_env::isolated_multi_pool_ecstore().await;
|
||||
storage.make_bucket("warehouse", &MakeBucketOptions::default()).await.unwrap();
|
||||
let backend = EcStoreTableCatalogObjectBackend::new(storage);
|
||||
let backend = EcStoreTableCatalogObjectBackend::new_with_strong_runtime(storage, StrongTableCatalogRuntime::default());
|
||||
let catalog = ObjectTableCatalogStore::new(backend.clone());
|
||||
catalog.put_table_bucket(test_bucket_entry("warehouse")).await.unwrap();
|
||||
let prefix = catalog.paths.namespace_entries_prefix("warehouse");
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
|
||||
pub(super) fn table_catalog_backing_manifest(
|
||||
paths: &TableCatalogObjectPaths,
|
||||
namespace: &Namespace,
|
||||
table: &IdentifierSegment,
|
||||
entry: &TableEntry,
|
||||
commit_recovery: &TableCommitRecoveryReport,
|
||||
) -> TableCatalogBackingManifest {
|
||||
let recovery_required = commit_recovery.staged_before_table_update_count > 0
|
||||
|| commit_recovery.finalization_required_count > 0
|
||||
|| commit_recovery.idempotency_repair_required_count > 0;
|
||||
let manual_review_required = commit_recovery.manual_review_count > 0;
|
||||
let wal_status = if manual_review_required {
|
||||
TableCatalogWalStatus::ManualReviewRequired
|
||||
} else if recovery_required {
|
||||
TableCatalogWalStatus::RecoveryRequired
|
||||
} else {
|
||||
TableCatalogWalStatus::Recoverable
|
||||
};
|
||||
TableCatalogBackingManifest {
|
||||
version: TABLE_CATALOG_BACKING_MANIFEST_VERSION,
|
||||
current: TableCatalogBackingProfile {
|
||||
kind: TableCatalogBackingKind::ObjectBacked,
|
||||
authority: TableCatalogAuthority::RustfsSysObject,
|
||||
consistency: TableCatalogConsistencyMode::ConditionalObjectCas,
|
||||
durability: TableCatalogDurabilityMode::StagedCommitLogBeforePointerUpdate,
|
||||
current_pointer_path: paths.table_entry_path(&entry.table_bucket, namespace, table),
|
||||
wal: TableCatalogWalState {
|
||||
status: wal_status,
|
||||
commit_log_prefix: paths.commit_log_entries_prefix(&entry.table_bucket, &entry.table_id),
|
||||
idempotency_index_prefix: paths.commit_idempotency_entries_prefix(&entry.table_bucket, &entry.table_id),
|
||||
committed_generation: entry.generation,
|
||||
staged_before_table_update_count: commit_recovery.staged_before_table_update_count,
|
||||
finalization_required_count: commit_recovery.finalization_required_count,
|
||||
idempotency_repair_required_count: commit_recovery.idempotency_repair_required_count,
|
||||
manual_review_count: commit_recovery.manual_review_count,
|
||||
},
|
||||
snapshot: TableCatalogSnapshotState {
|
||||
export_api: "GET /iceberg/v1/{warehouse}/namespaces/{namespace}/tables/{table}/catalog/export".to_string(),
|
||||
includes_table_bucket: true,
|
||||
includes_namespace: true,
|
||||
includes_table_pointer: true,
|
||||
includes_backing_manifest: true,
|
||||
snapshot_etag: None,
|
||||
snapshot_version: None,
|
||||
},
|
||||
},
|
||||
ha: TableCatalogHaPolicy {
|
||||
writer_region_model: TableCatalogHaWriterModel::SingleActiveWriterRegion,
|
||||
read_replica_strategy: TableCatalogReadReplicaStrategy::ReadOnlyReplicasForListAndLoad,
|
||||
commit_read_requirement: TableCatalogCommitReadRequirement::LinearizableLeaderRead,
|
||||
active_active_supported: false,
|
||||
failover_requires_operator_promotion: true,
|
||||
},
|
||||
scale_validation: TableCatalogScaleValidation {
|
||||
status: TableCatalogScaleValidationStatus::MatrixPublished,
|
||||
benchmark_required: true,
|
||||
required_scenarios: vec![
|
||||
TableCatalogScaleValidationScenario::ConcurrentCommitCas,
|
||||
TableCatalogScaleValidationScenario::CommitLogRecoveryReplay,
|
||||
TableCatalogScaleValidationScenario::ReadReplicaStaleReadGuard,
|
||||
TableCatalogScaleValidationScenario::ClientConformanceMatrix,
|
||||
],
|
||||
},
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
+1028
-148
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,156 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::super::object::{validate_commit_idempotency_entry_object, validate_commit_log_entry_object};
|
||||
use super::*;
|
||||
|
||||
impl<B> ObjectTableCatalogStore<B>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
/// Rejects a captured snapshot that still requires commit/index recovery.
|
||||
///
|
||||
/// This reads only the supplied snapshot. Callers hold the backup/publication
|
||||
/// fences and validate ordinary artifact hashes and metadata separately.
|
||||
/// Recovery classification is shared with the normal commit-recovery API;
|
||||
/// this check never finalizes a log, repairs an index, or changes a pointer.
|
||||
pub(super) fn validate_backup_commit_recovery(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
objects: &[ObjectCatalogBackupObject],
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
let mut active = BTreeMap::<String, TableEntry>::new();
|
||||
let mut logs = BTreeMap::<String, BTreeMap<String, CommitLogEntry>>::new();
|
||||
let mut indexes = BTreeMap::<String, BTreeMap<String, CommitLogEntry>>::new();
|
||||
let mut seen_paths = BTreeSet::new();
|
||||
let root = self.paths.table_bucket_root_prefix(table_bucket);
|
||||
let commit_root = format!("{root}{COMMIT_LOG_ROOT}/");
|
||||
let index_root = format!("{root}{COMMIT_IDEMPOTENCY_ROOT}/");
|
||||
|
||||
for object in objects.iter().filter(|object| object.bucket == self.catalog_bucket()) {
|
||||
if !seen_paths.insert(object.object.as_str()) {
|
||||
return Err(TableCatalogStoreError::Invalid("catalog backup has a duplicate object path".to_string()));
|
||||
}
|
||||
if object.object.ends_with(TABLE_ENTRY_FILE) {
|
||||
let entry: TableEntry = serde_json::from_slice(&object.data)
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("invalid table owner in backup commit state".to_string()))?;
|
||||
validate_table_entry_object(&self.paths, &object.object, &entry)?;
|
||||
if entry.table_bucket != table_bucket {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"backup commit owner belongs to another bucket".to_string(),
|
||||
));
|
||||
}
|
||||
if matches!(entry.state, TableCatalogEntryState::Renaming | TableCatalogEntryState::Deleting) {
|
||||
return Err(backup_commit_recovery_required("table owner has a pending operation"));
|
||||
}
|
||||
if entry.state == TableCatalogEntryState::Active && active.insert(entry.table_id.clone(), entry).is_some() {
|
||||
return Err(backup_commit_recovery_required("more than one active catalog pointer owns a table id"));
|
||||
}
|
||||
} else if object.object.starts_with(&commit_root) {
|
||||
let commit: CommitLogEntry = serde_json::from_slice(&object.data)
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("invalid commit log in catalog backup".to_string()))?;
|
||||
validate_commit_log_entry_object(&self.paths, &object.object, table_bucket, &commit.table_id, &commit)?;
|
||||
if logs
|
||||
.entry(commit.table_id.clone())
|
||||
.or_default()
|
||||
.insert(commit.commit_id.clone(), commit)
|
||||
.is_some()
|
||||
{
|
||||
return Err(TableCatalogStoreError::Invalid("duplicate backup commit lookup identity".to_string()));
|
||||
}
|
||||
} else if object.object.starts_with(&index_root) {
|
||||
let commit: CommitLogEntry = serde_json::from_slice(&object.data)
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("invalid idempotency index in catalog backup".to_string()))?;
|
||||
validate_commit_idempotency_entry_object(&self.paths, &object.object, table_bucket, &commit.table_id, &commit)?;
|
||||
let key = commit
|
||||
.idempotency_key
|
||||
.as_ref()
|
||||
.ok_or_else(|| TableCatalogStoreError::Invalid("backup idempotency index has no lookup key".to_string()))?;
|
||||
if indexes
|
||||
.entry(commit.table_id.clone())
|
||||
.or_default()
|
||||
.insert(key.clone(), commit)
|
||||
.is_some()
|
||||
{
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"duplicate backup idempotency lookup identity".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (table_id, entry) in &active {
|
||||
let Some(commits) = logs.get(table_id) else {
|
||||
continue;
|
||||
};
|
||||
// Commit records are keyed by immutable table id, not its logical
|
||||
// name. A rename source tombstone is not a second current pointer.
|
||||
let history = TableCommitHistoryIndex::new(entry, commits.values());
|
||||
for commit in commits.values() {
|
||||
let indexed = commit
|
||||
.idempotency_key
|
||||
.as_ref()
|
||||
.and_then(|key| indexes.get(table_id).and_then(|records| records.get(key)));
|
||||
let recovery = table_commit_recovery_entry_from_history(entry, commit, indexed, &history);
|
||||
if !matches!(
|
||||
recovery.recovery_state,
|
||||
TableCommitRecoveryState::Committed | TableCommitRecoveryState::Superseded
|
||||
) {
|
||||
return Err(TableCatalogStoreError::Conflict(format!(
|
||||
"commit recovery required before backup or restore: {}/{}/{} commit {} is {:?}: {}",
|
||||
entry.table_bucket,
|
||||
entry.namespace,
|
||||
entry.table,
|
||||
recovery.commit_id,
|
||||
recovery.recovery_state,
|
||||
recovery.reason,
|
||||
)));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Check both directions. Looking up indexes only while iterating logs
|
||||
// would miss an index whose commit record disappeared. Dropped-table
|
||||
// history can remain in object backing; retain valid paired records
|
||||
// without inventing a current pointer or comparing a rename tombstone.
|
||||
for (table_id, commits) in &logs {
|
||||
for commit in commits.values() {
|
||||
let Some(key) = commit.idempotency_key.as_ref() else {
|
||||
continue;
|
||||
};
|
||||
if indexes.get(table_id).and_then(|records| records.get(key)) != Some(commit) {
|
||||
return Err(backup_commit_recovery_required("commit log has no identical idempotency receipt"));
|
||||
}
|
||||
}
|
||||
}
|
||||
for (table_id, records) in &indexes {
|
||||
for indexed in records.values() {
|
||||
if logs.get(table_id).and_then(|commits| commits.get(&indexed.commit_id)) != Some(indexed) {
|
||||
return Err(backup_commit_recovery_required("idempotency receipt has no identical commit log"));
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
fn backup_commit_recovery_required(reason: &str) -> TableCatalogStoreError {
|
||||
TableCatalogStoreError::Conflict(format!(
|
||||
"commit recovery required before backup or restore: {reason}; inspect the persisted commit and idempotency records, recover the existing request, then capture a stable backup"
|
||||
))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "object_backup_commit_recovery_tests.rs"]
|
||||
mod tests;
|
||||
@@ -1,384 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use crate::table_catalog::test_support::TestCatalogObjectBackend;
|
||||
|
||||
fn fixture() -> (
|
||||
ObjectTableCatalogStore<TestCatalogObjectBackend>,
|
||||
Vec<ObjectCatalogBackupObject>,
|
||||
TableEntry,
|
||||
) {
|
||||
let backup: ObjectCatalogBackup =
|
||||
serde_json::from_slice(include_bytes!("../tests/fixtures/object-catalog-backup-v1.json")).expect("existing v1 fixture");
|
||||
let entry = serde_json::from_slice(
|
||||
&backup
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.object.ends_with(TABLE_ENTRY_FILE))
|
||||
.unwrap()
|
||||
.data,
|
||||
)
|
||||
.expect("fixture table owner");
|
||||
let store = ObjectTableCatalogStore::new(TestCatalogObjectBackend::default());
|
||||
store
|
||||
.validate_catalog_backup_metadata_identities("analytics", &backup.objects)
|
||||
.expect("real current metadata is valid before testing recovery policy");
|
||||
(store, backup.objects, entry)
|
||||
}
|
||||
|
||||
fn object(path: String, data: Vec<u8>) -> ObjectCatalogBackupObject {
|
||||
ObjectCatalogBackupObject {
|
||||
bucket: RUSTFS_META_BUCKET.to_string(),
|
||||
object: path,
|
||||
size_bytes: u64::try_from(data.len()).unwrap(),
|
||||
etag: Some("fixture-etag".to_string()),
|
||||
sha256: backup_sha256(&data),
|
||||
data,
|
||||
}
|
||||
}
|
||||
|
||||
fn current_commit(entry: &TableEntry) -> CommitLogEntry {
|
||||
CommitLogEntry {
|
||||
version: TABLE_CATALOG_ENTRY_VERSION,
|
||||
commit_id: "current-commit".to_string(),
|
||||
idempotency_key: Some("current-request".to_string()),
|
||||
table_id: entry.table_id.clone(),
|
||||
operation: "append".to_string(),
|
||||
expected_version_token: "base-token".to_string(),
|
||||
new_version_token: entry.version_token.clone(),
|
||||
previous_metadata_location: "tables/table-id/metadata/00000.metadata.json".to_string(),
|
||||
new_metadata_location: entry.metadata_location.clone(),
|
||||
requirements: Vec::new(),
|
||||
status: CommitLogStatus::Committed,
|
||||
writer: Some("fixture-writer".to_string()),
|
||||
created_at: Some("2026-10-31T00:00:00Z".to_string()),
|
||||
updated_at: Some("2026-10-31T00:00:01Z".to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
fn log_path(commit: &CommitLogEntry) -> String {
|
||||
TableCatalogObjectPaths::default().commit_log_entry_path("analytics", &commit.table_id, &commit.commit_id)
|
||||
}
|
||||
|
||||
fn index_path(commit: &CommitLogEntry) -> String {
|
||||
TableCatalogObjectPaths::default().commit_idempotency_entry_path(
|
||||
"analytics",
|
||||
&commit.table_id,
|
||||
commit.idempotency_key.as_deref().expect("fixture index key"),
|
||||
)
|
||||
}
|
||||
|
||||
fn put_record(objects: &mut Vec<ObjectCatalogBackupObject>, path: String, commit: &CommitLogEntry) {
|
||||
objects.retain(|object| object.object != path);
|
||||
objects.push(object(path, serde_json::to_vec(commit).unwrap()));
|
||||
}
|
||||
|
||||
fn publish(objects: &mut Vec<ObjectCatalogBackupObject>, commit: &CommitLogEntry) {
|
||||
put_record(objects, log_path(commit), commit);
|
||||
if commit.idempotency_key.is_some() {
|
||||
put_record(objects, index_path(commit), commit);
|
||||
}
|
||||
}
|
||||
|
||||
fn assert_recovery(result: TableCatalogStoreResult<()>, state: &str) {
|
||||
let error = result.expect_err("unstable commit state must be rejected");
|
||||
assert!(
|
||||
matches!(&error, TableCatalogStoreError::Conflict(message)
|
||||
if message.contains("commit recovery required") && message.contains(state)),
|
||||
"{error}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_accepts_the_original_v1_snapshot_with_valid_metadata() {
|
||||
let (store, objects, _) = fixture();
|
||||
let before = objects.clone();
|
||||
store.validate_backup_commit_recovery("analytics", &objects).unwrap();
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_accepts_finalized_current_commits_with_or_without_idempotency() {
|
||||
for idempotent in [false, true] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let mut commit = current_commit(&entry);
|
||||
if !idempotent {
|
||||
commit.idempotency_key = None;
|
||||
}
|
||||
publish(&mut objects, &commit);
|
||||
let before = objects.clone();
|
||||
store.validate_backup_commit_recovery("analytics", &objects).unwrap();
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_rejects_post_cas_finalization_without_mutating_source_bytes() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let mut staged = current_commit(&entry);
|
||||
staged.status = CommitLogStatus::Staged;
|
||||
publish(&mut objects, &staged);
|
||||
let before = objects.clone();
|
||||
assert_recovery(store.validate_backup_commit_recovery("analytics", &objects), "FinalizationRequired");
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_rejects_staging_before_the_table_pointer_advanced() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let mut staged = current_commit(&entry);
|
||||
staged.status = CommitLogStatus::Staged;
|
||||
staged.expected_version_token = entry.version_token;
|
||||
staged.previous_metadata_location = entry.metadata_location;
|
||||
staged.new_version_token = "next-token".to_string();
|
||||
staged.new_metadata_location = "tables/table-id/metadata/00002.metadata.json".to_string();
|
||||
publish(&mut objects, &staged);
|
||||
assert_recovery(store.validate_backup_commit_recovery("analytics", &objects), "StagedBeforeTableUpdate");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_rejects_missing_and_stale_idempotency_receipts() {
|
||||
for missing in [false, true] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let commit = current_commit(&entry);
|
||||
publish(&mut objects, &commit);
|
||||
if missing {
|
||||
objects.retain(|object| object.object != index_path(&commit));
|
||||
} else {
|
||||
let mut stale = commit.clone();
|
||||
stale.status = CommitLogStatus::Staged;
|
||||
put_record(&mut objects, index_path(&commit), &stale);
|
||||
}
|
||||
assert_recovery(
|
||||
store.validate_backup_commit_recovery("analytics", &objects),
|
||||
"IdempotencyIndexRepairRequired",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_keeps_manual_review_failures_distinct() {
|
||||
for failure in ["conflicting-index", "failed-log", "unreachable-log"] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let mut commit = current_commit(&entry);
|
||||
if failure == "failed-log" {
|
||||
commit.status = CommitLogStatus::Failed;
|
||||
} else if failure == "unreachable-log" {
|
||||
commit.new_version_token = "unreachable-token".to_string();
|
||||
commit.new_metadata_location = "tables/table-id/metadata/00099.metadata.json".to_string();
|
||||
}
|
||||
publish(&mut objects, &commit);
|
||||
if failure == "conflicting-index" {
|
||||
let mut conflicting = commit.clone();
|
||||
conflicting.operation = "overwrite".to_string();
|
||||
put_record(&mut objects, index_path(&commit), &conflicting);
|
||||
}
|
||||
assert_recovery(store.validate_backup_commit_recovery("analytics", &objects), "ManualReview");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_uses_the_existing_history_proof_for_older_staged_commits() {
|
||||
for older_status in [CommitLogStatus::Committed, CommitLogStatus::Staged] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let mut latest = current_commit(&entry);
|
||||
latest.expected_version_token = "intermediate-token".to_string();
|
||||
latest.previous_metadata_location = "tables/table-id/metadata/00002.metadata.json".to_string();
|
||||
let mut older = current_commit(&entry);
|
||||
older.commit_id = "historical-commit".to_string();
|
||||
older.idempotency_key = Some("historical-request".to_string());
|
||||
older.new_version_token = latest.expected_version_token.clone();
|
||||
older.new_metadata_location = latest.previous_metadata_location.clone();
|
||||
older.status = older_status.clone();
|
||||
publish(&mut objects, &older);
|
||||
publish(&mut objects, &latest);
|
||||
let result = store.validate_backup_commit_recovery("analytics", &objects);
|
||||
if older_status == CommitLogStatus::Committed {
|
||||
result.expect("healthy history retains earlier finalized receipts");
|
||||
} else {
|
||||
assert_recovery(result, "FinalizationRequired");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_detects_an_idempotency_receipt_without_its_commit() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let commit = current_commit(&entry);
|
||||
publish(&mut objects, &commit);
|
||||
objects.retain(|object| object.object != log_path(&commit));
|
||||
assert_recovery(
|
||||
store.validate_backup_commit_recovery("analytics", &objects),
|
||||
"idempotency receipt has no identical commit log",
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_reuses_owner_and_lookup_path_validation() {
|
||||
for changed in ["table-id", "commit-id", "idempotency-key", "version"] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let commit = current_commit(&entry);
|
||||
publish(&mut objects, &commit);
|
||||
let mut corrupt = commit.clone();
|
||||
let path = match changed {
|
||||
"table-id" => {
|
||||
corrupt.table_id = "another-table-id".to_string();
|
||||
log_path(&commit)
|
||||
}
|
||||
"commit-id" => {
|
||||
corrupt.commit_id = "another-commit".to_string();
|
||||
log_path(&commit)
|
||||
}
|
||||
"idempotency-key" => {
|
||||
corrupt.idempotency_key = Some("another-request".to_string());
|
||||
index_path(&commit)
|
||||
}
|
||||
"version" => {
|
||||
corrupt.version = 0;
|
||||
log_path(&commit)
|
||||
}
|
||||
_ => unreachable!(),
|
||||
};
|
||||
put_record(&mut objects, path, &corrupt);
|
||||
assert!(matches!(
|
||||
store.validate_backup_commit_recovery("analytics", &objects),
|
||||
Err(TableCatalogStoreError::Invalid(_))
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_uses_the_renamed_active_pointer_instead_of_the_source_tombstone() {
|
||||
let (store, mut objects, mut destination) = fixture();
|
||||
objects.retain(|object| !object.object.ends_with(TABLE_ENTRY_FILE));
|
||||
let mut source = destination.clone();
|
||||
source.state = TableCatalogEntryState::Deleted;
|
||||
source.version_token = "old-token".to_string();
|
||||
source.metadata_location = "tables/table-id/metadata/00000.metadata.json".to_string();
|
||||
source.generation = source.generation.saturating_sub(1);
|
||||
destination.table = "renamed_orders".to_string();
|
||||
for entry in [&source, &destination] {
|
||||
let path = TableCatalogObjectPaths::default().table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse(&entry.namespace).unwrap(),
|
||||
&IdentifierSegment::parse(&entry.table).unwrap(),
|
||||
);
|
||||
objects.push(object(path, serde_json::to_vec(entry).unwrap()));
|
||||
}
|
||||
store
|
||||
.validate_catalog_backup_metadata_identities("analytics", &objects)
|
||||
.expect("renamed active pointer still uses the original valid metadata");
|
||||
publish(&mut objects, ¤t_commit(&destination));
|
||||
let before = objects.clone();
|
||||
store
|
||||
.validate_backup_commit_recovery("analytics", &objects)
|
||||
.expect("source tombstone is not current commit authority");
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_rejects_two_active_pointers_for_one_table_id() {
|
||||
let (store, mut objects, mut duplicate) = fixture();
|
||||
duplicate.table = "duplicate_owner".to_string();
|
||||
let path = TableCatalogObjectPaths::default().table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse(&duplicate.namespace).unwrap(),
|
||||
&IdentifierSegment::parse(&duplicate.table).unwrap(),
|
||||
);
|
||||
objects.push(object(path, serde_json::to_vec(&duplicate).unwrap()));
|
||||
assert_recovery(
|
||||
store.validate_backup_commit_recovery("analytics", &objects),
|
||||
"more than one active catalog pointer",
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_preserves_paired_history_left_after_an_object_table_drop() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
publish(&mut objects, ¤t_commit(&entry));
|
||||
objects.retain(|object| !object.object.ends_with(TABLE_ENTRY_FILE) && object.bucket == RUSTFS_META_BUCKET);
|
||||
let before = objects.clone();
|
||||
store
|
||||
.validate_backup_commit_recovery("analytics", &objects)
|
||||
.expect("normal object drop retains paired history without a current owner");
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_checks_both_receipt_directions_even_without_an_active_table() {
|
||||
for keep_log in [false, true] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let commit = current_commit(&entry);
|
||||
publish(&mut objects, &commit);
|
||||
objects.retain(|object| !object.object.ends_with(TABLE_ENTRY_FILE) && object.bucket == RUSTFS_META_BUCKET);
|
||||
let missing = if keep_log { index_path(&commit) } else { log_path(&commit) };
|
||||
objects.retain(|object| object.object != missing);
|
||||
assert_recovery(store.validate_backup_commit_recovery("analytics", &objects), "receipt");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_preserves_proven_superseded_receipts_without_rewriting_them() {
|
||||
for idempotent in [false, true] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let winner = current_commit(&entry);
|
||||
let loser = CommitLogEntry {
|
||||
commit_id: "superseded-commit".to_string(),
|
||||
idempotency_key: idempotent.then(|| "superseded-request".to_string()),
|
||||
new_version_token: "superseded-token".to_string(),
|
||||
new_metadata_location: "tables/table-id/metadata/loser.metadata.json".to_string(),
|
||||
status: CommitLogStatus::Staged,
|
||||
..winner.clone()
|
||||
};
|
||||
publish(&mut objects, &winner);
|
||||
publish(&mut objects, &loser);
|
||||
let before = objects.clone();
|
||||
store
|
||||
.validate_backup_commit_recovery("analytics", &objects)
|
||||
.expect("a proven losing request is not pending recovery");
|
||||
assert_eq!(objects, before, "sealing must retain the original STAGED audit bytes");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_commit_policy_never_accepts_a_loser_without_intact_winner_and_index_proof() {
|
||||
for failure in ["missing-winner", "wrong-base", "conflicting-index"] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let winner = current_commit(&entry);
|
||||
let mut loser = CommitLogEntry {
|
||||
commit_id: "superseded-commit".to_string(),
|
||||
idempotency_key: Some("superseded-request".to_string()),
|
||||
new_version_token: "superseded-token".to_string(),
|
||||
new_metadata_location: "tables/table-id/metadata/loser.metadata.json".to_string(),
|
||||
status: CommitLogStatus::Staged,
|
||||
..winner.clone()
|
||||
};
|
||||
if failure == "wrong-base" {
|
||||
loser.expected_version_token = "unknown-base-token".to_string();
|
||||
}
|
||||
publish(&mut objects, &winner);
|
||||
publish(&mut objects, &loser);
|
||||
if failure == "missing-winner" {
|
||||
objects.retain(|object| object.object != log_path(&winner) && object.object != index_path(&winner));
|
||||
} else if failure == "conflicting-index" {
|
||||
let mut conflicting = loser.clone();
|
||||
conflicting.operation = "overwrite".to_string();
|
||||
put_record(&mut objects, index_path(&loser), &conflicting);
|
||||
}
|
||||
let before = objects.clone();
|
||||
assert_recovery(store.validate_backup_commit_recovery("analytics", &objects), "ManualReview");
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
}
|
||||
@@ -1,526 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
|
||||
const OBJECT_CATALOG_BACKUP_REFERENCE_MAX_OBJECTS: usize = 1_000_000;
|
||||
const OBJECT_CATALOG_BACKUP_REFERENCE_HASH_MAX_SIZE: u64 = 16 * 1024 * 1024;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub(super) struct ObjectCatalogBackupReference {
|
||||
pub(super) bucket: String,
|
||||
pub(super) object: String,
|
||||
pub(super) kind: ObjectCatalogBackupReferenceKind,
|
||||
pub(super) size_bytes: u64,
|
||||
pub(super) etag: Option<String>,
|
||||
pub(super) sha256: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
|
||||
pub(super) enum ObjectCatalogBackupReferenceKind {
|
||||
TableMetadata,
|
||||
ViewMetadata,
|
||||
ManifestList,
|
||||
ManifestFile,
|
||||
DataFile,
|
||||
DeleteFile,
|
||||
TableStatistics,
|
||||
PartitionStatistics,
|
||||
}
|
||||
|
||||
impl ObjectCatalogBackupReferenceKind {
|
||||
fn from_maintenance_kind(kind: &TableMetadataMaintenanceObjectKind) -> Self {
|
||||
match kind {
|
||||
TableMetadataMaintenanceObjectKind::MetadataFile => Self::TableMetadata,
|
||||
TableMetadataMaintenanceObjectKind::ManifestList => Self::ManifestList,
|
||||
TableMetadataMaintenanceObjectKind::ManifestFile => Self::ManifestFile,
|
||||
TableMetadataMaintenanceObjectKind::DataFile => Self::DataFile,
|
||||
TableMetadataMaintenanceObjectKind::DeleteFile => Self::DeleteFile,
|
||||
}
|
||||
}
|
||||
|
||||
fn from_statistics_kind(kind: IcebergStatisticsFileKind) -> Self {
|
||||
match kind {
|
||||
IcebergStatisticsFileKind::Table => Self::TableStatistics,
|
||||
IcebergStatisticsFileKind::Partition => Self::PartitionStatistics,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub(super) fn validate_object_catalog_backup_reference_shape(
|
||||
table_bucket: &str,
|
||||
references: &[ObjectCatalogBackupReference],
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
if references.len() > OBJECT_CATALOG_BACKUP_REFERENCE_MAX_OBJECTS {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup reference count exceeds its limit".to_string(),
|
||||
));
|
||||
}
|
||||
if references
|
||||
.windows(2)
|
||||
.any(|pair| (&pair[0].bucket, &pair[0].object) >= (&pair[1].bucket, &pair[1].object))
|
||||
{
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup references must be sorted and unique".to_string(),
|
||||
));
|
||||
}
|
||||
for reference in references {
|
||||
if reference.bucket != table_bucket || !safe_object_key(&reference.object) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup reference is outside its table bucket".to_string(),
|
||||
));
|
||||
}
|
||||
if reference.size_bytes <= OBJECT_CATALOG_BACKUP_REFERENCE_HASH_MAX_SIZE {
|
||||
if reference.sha256.as_deref().is_none_or(|digest| {
|
||||
digest.len() != 64
|
||||
|| !digest
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
|
||||
}) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"small catalog backup reference requires a SHA-256 watermark".to_string(),
|
||||
));
|
||||
}
|
||||
} else if reference.sha256.is_some() || reference.etag.as_deref().is_none_or(str::is_empty) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"large catalog backup reference requires an ETag watermark and no inline digest".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn insert_backup_reference_kind(
|
||||
keys: &mut BTreeMap<(String, String), ObjectCatalogBackupReferenceKind>,
|
||||
bucket: &str,
|
||||
object: &str,
|
||||
kind: ObjectCatalogBackupReferenceKind,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
if !safe_object_key(object) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup reference has an invalid object key".to_string(),
|
||||
));
|
||||
}
|
||||
let key = (bucket.to_string(), object.to_string());
|
||||
if let Some(existing) = keys.get(&key) {
|
||||
if *existing != kind {
|
||||
return Err(TableCatalogStoreError::Invalid(format!(
|
||||
"catalog backup reference has conflicting kinds: {bucket}/{object}"
|
||||
)));
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
if keys.len() == OBJECT_CATALOG_BACKUP_REFERENCE_MAX_OBJECTS {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup reference count exceeds its limit".to_string(),
|
||||
));
|
||||
}
|
||||
keys.insert(key, kind);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(super) fn backup_reference_metadata_log_locations(
|
||||
metadata: &serde_json::Value,
|
||||
entry: &TableEntry,
|
||||
) -> TableCatalogStoreResult<BTreeSet<String>> {
|
||||
let Some(metadata_log) = metadata.get("metadata-log") else {
|
||||
return Ok(BTreeSet::new());
|
||||
};
|
||||
let entries = metadata_log
|
||||
.as_array()
|
||||
.ok_or_else(|| TableCatalogStoreError::Invalid("table metadata-log must be an array for a catalog backup".to_string()))?;
|
||||
if entries.len() > OBJECT_CATALOG_BACKUP_REFERENCE_MAX_OBJECTS {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup metadata history exceeds its limit".to_string(),
|
||||
));
|
||||
}
|
||||
let mut locations = BTreeSet::new();
|
||||
for log_entry in entries {
|
||||
let location = log_entry
|
||||
.get("metadata-file")
|
||||
.and_then(serde_json::Value::as_str)
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid("catalog backup metadata-log entry requires a metadata-file".to_string())
|
||||
})?;
|
||||
let key = table_catalog_object_key_from_location(&entry.table_bucket, location).ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid("catalog backup metadata history is outside its table bucket".to_string())
|
||||
})?;
|
||||
if !is_valid_table_metadata_location_for_entry(entry, &key) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup metadata history is outside its metadata directory".to_string(),
|
||||
));
|
||||
}
|
||||
locations.insert(key);
|
||||
}
|
||||
Ok(locations)
|
||||
}
|
||||
|
||||
pub(super) fn validate_backup_reference_table_metadata(
|
||||
entry: &TableEntry,
|
||||
object: &str,
|
||||
metadata: &serde_json::Value,
|
||||
current: bool,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
validate_supported_table_metadata(metadata)?;
|
||||
if table_metadata_uuid(metadata)? != entry.table_uuid {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup metadata UUID does not match its table".to_string(),
|
||||
));
|
||||
}
|
||||
let warehouse_location = table_metadata_location(metadata)?;
|
||||
validate_table_warehouse_location(&entry.table_bucket, warehouse_location)?;
|
||||
if current && warehouse_location != entry.warehouse_location {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup current metadata does not match its warehouse".to_string(),
|
||||
));
|
||||
}
|
||||
if current && table_metadata_format_version(metadata)? != entry.format_version {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup current metadata does not match its table format version".to_string(),
|
||||
));
|
||||
}
|
||||
if !is_valid_table_metadata_location_for_entry(entry, object) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup metadata is outside its metadata directory".to_string(),
|
||||
));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(super) fn validate_backup_reference_view_metadata(
|
||||
entry: &ViewEntry,
|
||||
namespace: &Namespace,
|
||||
view: &IdentifierSegment,
|
||||
object: &str,
|
||||
metadata: &serde_json::Value,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
validate_supported_view_metadata(metadata)?;
|
||||
if metadata.get("view-uuid").and_then(serde_json::Value::as_str) != Some(entry.view_uuid.as_str())
|
||||
|| metadata.get("location").and_then(serde_json::Value::as_str) != Some(entry.warehouse_location.as_str())
|
||||
|| metadata.get("format-version").and_then(serde_json::Value::as_u64) != Some(u64::from(entry.format_version))
|
||||
{
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup metadata does not match its view identity".to_string(),
|
||||
));
|
||||
}
|
||||
validate_view_warehouse_location(&entry.table_bucket, &entry.warehouse_location)?;
|
||||
if !is_valid_view_metadata_location(namespace, view, object) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup view metadata is outside its metadata directory".to_string(),
|
||||
));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
impl<B> ObjectTableCatalogStore<B>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
pub(super) fn backup_reference_view_entries(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
objects: &[ObjectCatalogBackupObject],
|
||||
) -> TableCatalogStoreResult<Vec<ViewEntry>> {
|
||||
if objects.is_empty() || objects.len() > OBJECT_CATALOG_BACKUP_REFERENCE_MAX_OBJECTS {
|
||||
return Err(TableCatalogStoreError::Invalid("catalog backup object count is invalid".to_string()));
|
||||
}
|
||||
let mut paths = BTreeSet::new();
|
||||
let mut views = Vec::new();
|
||||
for object in objects.iter().filter(|object| object.bucket == self.catalog_bucket()) {
|
||||
if object.object.ends_with(TABLE_ENTRY_FILE) {
|
||||
let entry: TableEntry = serde_json::from_slice(&object.data).map_err(|_| {
|
||||
TableCatalogStoreError::Invalid("invalid table entry in catalog backup references".to_string())
|
||||
})?;
|
||||
validate_table_entry_object(&self.paths, &object.object, &entry)?;
|
||||
if entry.table_bucket != table_bucket || !paths.insert(object.object.as_str()) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup table identity is invalid or duplicated".to_string(),
|
||||
));
|
||||
}
|
||||
if matches!(entry.state, TableCatalogEntryState::Renaming | TableCatalogEntryState::Deleting) {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup requires a stable table operation".to_string(),
|
||||
));
|
||||
}
|
||||
} else if object.object.ends_with(VIEW_ENTRY_FILE) {
|
||||
let entry: ViewEntry = serde_json::from_slice(&object.data).map_err(|_| {
|
||||
TableCatalogStoreError::Invalid("invalid view entry in catalog backup references".to_string())
|
||||
})?;
|
||||
validate_view_entry_object(&self.paths, &object.object, &entry)?;
|
||||
if entry.table_bucket != table_bucket || !paths.insert(object.object.as_str()) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup view identity is invalid or duplicated".to_string(),
|
||||
));
|
||||
}
|
||||
if matches!(entry.state, TableCatalogEntryState::Renaming | TableCatalogEntryState::Deleting) {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup requires a stable view operation".to_string(),
|
||||
));
|
||||
}
|
||||
if entry.state == TableCatalogEntryState::Active {
|
||||
views.push(entry);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(views)
|
||||
}
|
||||
|
||||
async fn collect_object_catalog_backup_reference_keys(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
objects: &[ObjectCatalogBackupObject],
|
||||
) -> TableCatalogStoreResult<BTreeMap<(String, String), ObjectCatalogBackupReferenceKind>> {
|
||||
let views = self.backup_reference_view_entries(table_bucket, objects)?;
|
||||
let tables = self.validate_catalog_backup_metadata_identities(table_bucket, objects)?;
|
||||
let mut keys = BTreeMap::new();
|
||||
for (entry, current_metadata) in &tables {
|
||||
let current_object =
|
||||
table_catalog_object_key_from_location(table_bucket, &entry.metadata_location).ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid("catalog backup current metadata location is invalid".to_string())
|
||||
})?;
|
||||
validate_backup_reference_table_metadata(entry, ¤t_object, current_metadata, true)?;
|
||||
let mut metadata_locations = backup_reference_metadata_log_locations(current_metadata, entry)?;
|
||||
metadata_locations.insert(current_object.clone());
|
||||
for object in metadata_locations {
|
||||
insert_backup_reference_kind(&mut keys, table_bucket, &object, ObjectCatalogBackupReferenceKind::TableMetadata)?;
|
||||
let historical;
|
||||
let metadata = if object == current_object {
|
||||
current_metadata
|
||||
} else {
|
||||
historical = read_table_metadata_value(&self.backend, table_bucket, &object)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::NotFound(format!("catalog backup metadata history {object}")))?;
|
||||
&historical
|
||||
};
|
||||
validate_backup_reference_table_metadata(entry, &object, metadata, object == current_object)?;
|
||||
let mut metadata_entry = entry.clone();
|
||||
metadata_entry.warehouse_location = table_metadata_location(metadata)?.to_string();
|
||||
let warehouse_prefix = table_warehouse_object_prefix(&metadata_entry)?;
|
||||
for (other, _) in &tables {
|
||||
if other.table_id != entry.table_id
|
||||
&& warehouse_object_prefixes_overlap(&warehouse_prefix, &table_warehouse_object_prefix(other)?)
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup metadata warehouse overlaps another active table".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
let context = TableSnapshotGraphValidationContext::new(&self.backend, table_bucket, &metadata_entry);
|
||||
let graph = validated_table_snapshot_graph_inventory(&context, metadata).await?;
|
||||
for reference in table_statistics_object_references(metadata)? {
|
||||
let statistics_object = table_catalog_object_key_from_location(table_bucket, &reference.location)
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid(
|
||||
"catalog backup statistics are outside their table bucket".to_string(),
|
||||
)
|
||||
})?;
|
||||
if !statistics_object.starts_with(&warehouse_prefix) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup statistics are outside their table warehouse".to_string(),
|
||||
));
|
||||
}
|
||||
insert_backup_reference_kind(
|
||||
&mut keys,
|
||||
table_bucket,
|
||||
&statistics_object,
|
||||
ObjectCatalogBackupReferenceKind::from_statistics_kind(reference.kind),
|
||||
)?;
|
||||
}
|
||||
for (graph_object, kind) in graph {
|
||||
insert_backup_reference_kind(
|
||||
&mut keys,
|
||||
table_bucket,
|
||||
&graph_object,
|
||||
ObjectCatalogBackupReferenceKind::from_maintenance_kind(&kind),
|
||||
)?;
|
||||
}
|
||||
}
|
||||
}
|
||||
for entry in views {
|
||||
let namespace = parse_namespace_for_store(&entry.namespace)?;
|
||||
let view = parse_table_for_store(&entry.view)?;
|
||||
let object = table_catalog_object_key_from_location(table_bucket, &entry.metadata_location)
|
||||
.ok_or_else(|| TableCatalogStoreError::Invalid("catalog backup view metadata location is invalid".to_string()))?;
|
||||
let metadata = read_table_metadata_value(&self.backend, table_bucket, &object)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::NotFound(format!("catalog backup view metadata {object}")))?;
|
||||
validate_backup_reference_view_metadata(&entry, &namespace, &view, &object, &metadata)?;
|
||||
insert_backup_reference_kind(&mut keys, table_bucket, &object, ObjectCatalogBackupReferenceKind::ViewMetadata)?;
|
||||
}
|
||||
Ok(keys)
|
||||
}
|
||||
|
||||
async fn object_catalog_backup_reference_fingerprint(
|
||||
&self,
|
||||
bucket: &str,
|
||||
object: &str,
|
||||
kind: ObjectCatalogBackupReferenceKind,
|
||||
) -> TableCatalogStoreResult<ObjectCatalogBackupReference> {
|
||||
let metadata = self
|
||||
.backend
|
||||
.object_metadata(bucket, object)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::NotFound(format!("catalog backup reference {bucket}/{object}")))?;
|
||||
let etag = metadata.etag.as_deref().filter(|etag| !etag.is_empty()).ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid(format!("catalog backup reference has no stable ETag: {bucket}/{object}"))
|
||||
})?;
|
||||
let sha256 = if metadata.size <= OBJECT_CATALOG_BACKUP_REFERENCE_HASH_MAX_SIZE {
|
||||
let max_size = usize::try_from(OBJECT_CATALOG_BACKUP_REFERENCE_HASH_MAX_SIZE).map_err(|_| {
|
||||
TableCatalogStoreError::Internal("catalog backup hash limit exceeds addressable size".to_string())
|
||||
})?;
|
||||
let stored = self
|
||||
.backend
|
||||
.read_object_limited(bucket, object, max_size)
|
||||
.await?
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Conflict(format!("catalog backup reference disappeared: {bucket}/{object}"))
|
||||
})?;
|
||||
if u64::try_from(stored.data.len()).ok() != Some(metadata.size) || stored.etag.as_deref() != Some(etag) {
|
||||
return Err(TableCatalogStoreError::Conflict(format!(
|
||||
"catalog backup reference changed during its read: {bucket}/{object}"
|
||||
)));
|
||||
}
|
||||
Some(backup_sha256(&stored.data))
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let final_metadata = self.backend.object_metadata(bucket, object).await?.ok_or_else(|| {
|
||||
TableCatalogStoreError::Conflict(format!("catalog backup reference disappeared: {bucket}/{object}"))
|
||||
})?;
|
||||
if final_metadata.size != metadata.size || final_metadata.etag != metadata.etag {
|
||||
return Err(TableCatalogStoreError::Conflict(format!(
|
||||
"catalog backup reference changed during verification: {bucket}/{object}"
|
||||
)));
|
||||
}
|
||||
Ok(ObjectCatalogBackupReference {
|
||||
bucket: bucket.to_string(),
|
||||
object: object.to_string(),
|
||||
kind,
|
||||
size_bytes: metadata.size,
|
||||
etag: metadata.etag,
|
||||
sha256,
|
||||
})
|
||||
}
|
||||
|
||||
/// Captures the finite object inventory required by one stable catalog payload.
|
||||
///
|
||||
/// The caller retains its publication and restore fences throughout capture. The inventory includes current
|
||||
/// metadata, its direct metadata-log history, each corresponding snapshot graph and statistics, and current view
|
||||
/// metadata. It contains watermarks, not payload copies. Cancellation makes no storage changes.
|
||||
pub(super) async fn capture_object_catalog_backup_references(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
objects: &[ObjectCatalogBackupObject],
|
||||
) -> TableCatalogStoreResult<Vec<ObjectCatalogBackupReference>> {
|
||||
let keys = self
|
||||
.collect_object_catalog_backup_reference_keys(table_bucket, objects)
|
||||
.await?;
|
||||
let mut references = Vec::with_capacity(keys.len());
|
||||
for ((bucket, object), kind) in keys {
|
||||
references.push(
|
||||
self.object_catalog_backup_reference_fingerprint(&bucket, &object, kind)
|
||||
.await?,
|
||||
);
|
||||
}
|
||||
// Current metadata embedded in the catalog payload must be exactly the object whose graph was inventoried.
|
||||
for object in objects.iter().filter(|object| object.bucket == table_bucket) {
|
||||
let index = references
|
||||
.binary_search_by(|reference| {
|
||||
reference
|
||||
.bucket
|
||||
.cmp(&object.bucket)
|
||||
.then_with(|| reference.object.cmp(&object.object))
|
||||
})
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("catalog backup embeds an unreferenced table object".to_string()))?;
|
||||
let reference = &references[index];
|
||||
if u64::try_from(object.data.len()).ok() != Some(reference.size_bytes)
|
||||
|| reference.sha256.as_deref() != Some(backup_sha256(&object.data).as_str())
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup embedded metadata differs from the prepared object".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
Ok(references)
|
||||
}
|
||||
|
||||
/// Verifies the closed inventory without publishing any catalog state.
|
||||
///
|
||||
/// The caller retains its restore/publication fences. Small objects compare size and SHA-256 across targets; their
|
||||
/// individual reads still require stable target ETags. An absent current metadata object may be supplied by its
|
||||
/// validated inline restore payload; existing different bytes are never accepted. All external objects must
|
||||
/// already be prepared. Large objects retain the recorded size and ETag. Invalid references fail closed.
|
||||
pub(super) async fn validate_object_catalog_backup_references(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
objects: &[ObjectCatalogBackupObject],
|
||||
references: &[ObjectCatalogBackupReference],
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
validate_object_catalog_backup_reference_shape(table_bucket, references)?;
|
||||
let keys = self
|
||||
.collect_object_catalog_backup_reference_keys(table_bucket, objects)
|
||||
.await?;
|
||||
if keys.len() != references.len() {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup reference graph does not match the prepared target".to_string(),
|
||||
));
|
||||
}
|
||||
let embedded = objects
|
||||
.iter()
|
||||
.filter(|object| object.bucket == table_bucket)
|
||||
.map(|object| ((object.bucket.as_str(), object.object.as_str()), object))
|
||||
.collect::<BTreeMap<_, _>>();
|
||||
for (expected, ((bucket, object), kind)) in references.iter().zip(&keys) {
|
||||
if expected.bucket != *bucket || expected.object != *object || expected.kind != *kind {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup reference identity does not match its graph".to_string(),
|
||||
));
|
||||
}
|
||||
if let Some(payload) = embedded.get(&(bucket.as_str(), object.as_str()))
|
||||
&& self.backend.object_metadata(bucket, object).await?.is_none()
|
||||
{
|
||||
if u64::try_from(payload.data.len()).ok() != Some(expected.size_bytes)
|
||||
|| expected.sha256.as_deref() != Some(backup_sha256(&payload.data).as_str())
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"inline restore metadata does not match its saved inventory".to_string(),
|
||||
));
|
||||
}
|
||||
continue;
|
||||
}
|
||||
let actual = self
|
||||
.object_catalog_backup_reference_fingerprint(bucket, object, *kind)
|
||||
.await?;
|
||||
if expected.size_bytes != actual.size_bytes
|
||||
|| if expected.size_bytes <= OBJECT_CATALOG_BACKUP_REFERENCE_HASH_MAX_SIZE {
|
||||
expected.sha256 != actual.sha256
|
||||
} else {
|
||||
expected.etag != actual.etag
|
||||
}
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict(format!(
|
||||
"catalog backup reference watermark does not match the prepared target: {}/{}",
|
||||
expected.bucket, expected.object
|
||||
)));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "object_backup_inventory_tests.rs"]
|
||||
mod tests;
|
||||
@@ -1,721 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use crate::table_catalog::test_support::{
|
||||
TestCatalogObjectBackend, manifest_avro_bytes, manifest_list_avro_entries_with_content, table_metadata_json,
|
||||
};
|
||||
|
||||
const BUCKET: &str = "analytics";
|
||||
const DATA: &str = "tables/table-id/data/part.parquet";
|
||||
const DATA_MANIFEST: &str = "tables/table-id/metadata/data.avro";
|
||||
const MANIFEST_LIST: &str = "tables/table-id/metadata/snap-42.avro";
|
||||
const TABLE_STATISTICS: &str = "tables/table-id/metadata/statistics.puffin";
|
||||
const PARTITION_STATISTICS: &str = "tables/table-id/metadata/partition-statistics.orc";
|
||||
const HISTORY_MANIFEST_LIST: &str = "tables/table-id/metadata/snap-20.avro";
|
||||
const HISTORY_MANIFEST: &str = "tables/table-id/metadata/history.avro";
|
||||
const HISTORY_DATA: &str = "tables/table-id/data/history.parquet";
|
||||
const HISTORY_STATISTICS: &str = "tables/table-id/metadata/history-statistics.puffin";
|
||||
|
||||
struct InventoryFixture {
|
||||
backend: TestCatalogObjectBackend,
|
||||
objects: Vec<ObjectCatalogBackupObject>,
|
||||
current: String,
|
||||
history: String,
|
||||
unretained_history: String,
|
||||
view: String,
|
||||
}
|
||||
|
||||
async fn embedded_object(backend: &TestCatalogObjectBackend, bucket: &str, object: &str) -> ObjectCatalogBackupObject {
|
||||
let stored = backend.read_object(bucket, object).await.unwrap().unwrap();
|
||||
ObjectCatalogBackupObject {
|
||||
bucket: bucket.to_string(),
|
||||
object: object.to_string(),
|
||||
size_bytes: u64::try_from(stored.data.len()).unwrap(),
|
||||
etag: stored.etag,
|
||||
sha256: backup_sha256(&stored.data),
|
||||
data: stored.data,
|
||||
}
|
||||
}
|
||||
|
||||
async fn inventory_fixture() -> InventoryFixture {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let table = IdentifierSegment::parse("orders").unwrap();
|
||||
let view = IdentifierSegment::parse("summary").unwrap();
|
||||
let current = default_table_metadata_file_path(&namespace, &table, "00002.metadata.json");
|
||||
let history = default_table_metadata_file_path(&namespace, &table, "00001.metadata.json");
|
||||
let unretained_history = default_table_metadata_file_path(&namespace, &table, "00000.metadata.json");
|
||||
let view_metadata = default_view_metadata_file_path(&namespace, &view, "00001.metadata.json");
|
||||
let entry = TableEntry {
|
||||
version: TABLE_CATALOG_ENTRY_VERSION,
|
||||
table_bucket: BUCKET.to_string(),
|
||||
namespace: namespace.public_name(),
|
||||
table: table.as_str().to_string(),
|
||||
table_id: "table-id".to_string(),
|
||||
table_uuid: "table-uuid".to_string(),
|
||||
format: "ICEBERG".to_string(),
|
||||
format_version: 2,
|
||||
warehouse_location: format!("s3://{BUCKET}/tables/table-id"),
|
||||
metadata_location: current.clone(),
|
||||
version_token: "token-v1".to_string(),
|
||||
generation: 1,
|
||||
state: TableCatalogEntryState::Active,
|
||||
properties: BTreeMap::new(),
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
let view_entry = ViewEntry {
|
||||
version: TABLE_CATALOG_ENTRY_VERSION,
|
||||
table_bucket: BUCKET.to_string(),
|
||||
namespace: namespace.public_name(),
|
||||
view: view.as_str().to_string(),
|
||||
view_id: "view-id".to_string(),
|
||||
view_uuid: "view-uuid".to_string(),
|
||||
format: "ICEBERG_VIEW".to_string(),
|
||||
format_version: 1,
|
||||
warehouse_location: format!("s3://{BUCKET}/views/view-id"),
|
||||
metadata_location: view_metadata.clone(),
|
||||
version_token: "view-token-v1".to_string(),
|
||||
generation: 1,
|
||||
state: TableCatalogEntryState::Active,
|
||||
properties: BTreeMap::new(),
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
let mut current_metadata = table_metadata_json(&entry.table_uuid, &entry.warehouse_location);
|
||||
current_metadata["last-sequence-number"] = serde_json::json!(7);
|
||||
current_metadata["last-updated-ms"] = serde_json::json!(2);
|
||||
current_metadata["snapshots"] = serde_json::json!([{
|
||||
"snapshot-id": 42,
|
||||
"sequence-number": 7,
|
||||
"timestamp-ms": 2,
|
||||
"manifest-list": format!("s3://{BUCKET}/{MANIFEST_LIST}"),
|
||||
"summary": {"operation": "append"}
|
||||
}]);
|
||||
current_metadata["current-snapshot-id"] = serde_json::json!(42);
|
||||
current_metadata["snapshot-log"] = serde_json::json!([{"timestamp-ms": 2, "snapshot-id": 42}]);
|
||||
current_metadata["refs"] = serde_json::json!({"main": {"type": "branch", "snapshot-id": 42}});
|
||||
current_metadata["metadata-log"] = serde_json::json!([{
|
||||
"timestamp-ms": 1,
|
||||
"metadata-file": format!("s3://{BUCKET}/{history}")
|
||||
}]);
|
||||
current_metadata["statistics"] = serde_json::json!([{
|
||||
"snapshot-id": 42,
|
||||
"statistics-path": format!("s3://{BUCKET}/{TABLE_STATISTICS}"),
|
||||
"file-size-in-bytes": 8,
|
||||
"file-footer-size-in-bytes": 4,
|
||||
"blob-metadata": []
|
||||
}]);
|
||||
current_metadata["partition-statistics"] = serde_json::json!([{
|
||||
"snapshot-id": 42,
|
||||
"statistics-path": format!("s3://{BUCKET}/{PARTITION_STATISTICS}"),
|
||||
"file-size-in-bytes": 3
|
||||
}]);
|
||||
let mut historical_metadata = table_metadata_json(&entry.table_uuid, &entry.warehouse_location);
|
||||
historical_metadata["last-sequence-number"] = serde_json::json!(6);
|
||||
historical_metadata["snapshots"] = serde_json::json!([{
|
||||
"snapshot-id": 20, "sequence-number": 6, "timestamp-ms": 1,
|
||||
"manifest-list": format!("s3://{BUCKET}/{HISTORY_MANIFEST_LIST}"),
|
||||
"summary": {"operation": "append"}
|
||||
}]);
|
||||
historical_metadata["current-snapshot-id"] = serde_json::json!(20);
|
||||
historical_metadata["snapshot-log"] = serde_json::json!([{"timestamp-ms": 1, "snapshot-id": 20}]);
|
||||
historical_metadata["refs"] = serde_json::json!({"main": {"type": "branch", "snapshot-id": 20}});
|
||||
historical_metadata["statistics"] = serde_json::json!([{
|
||||
"snapshot-id": 20,
|
||||
"statistics-path": format!("s3://{BUCKET}/{HISTORY_STATISTICS}"),
|
||||
"file-size-in-bytes": 8, "file-footer-size-in-bytes": 4, "blob-metadata": []
|
||||
}]);
|
||||
historical_metadata["metadata-log"] = serde_json::json!([{
|
||||
"timestamp-ms": 0,
|
||||
"metadata-file": format!("s3://{BUCKET}/{unretained_history}")
|
||||
}]);
|
||||
let view_metadata_json = serde_json::json!({
|
||||
"format-version": 1,
|
||||
"view-uuid": view_entry.view_uuid,
|
||||
"location": view_entry.warehouse_location,
|
||||
"schemas": [{
|
||||
"type": "struct", "schema-id": 0,
|
||||
"fields": [{"id": 1, "name": "id", "required": true, "type": "long"}]
|
||||
}],
|
||||
"current-schema-id": 0,
|
||||
"current-version-id": 1,
|
||||
"versions": [{
|
||||
"version-id": 1, "timestamp-ms": 1, "schema-id": 0, "summary": {},
|
||||
"representations": [{"type": "sql", "sql": "SELECT 1", "dialect": "spark"}],
|
||||
"default-namespace": ["sales"]
|
||||
}],
|
||||
"version-log": [{"timestamp-ms": 1, "version-id": 1}],
|
||||
"properties": {}
|
||||
});
|
||||
let mut manifests = Vec::new();
|
||||
for (manifest, object, content) in [
|
||||
(DATA_MANIFEST, DATA, 0),
|
||||
("tables/table-id/metadata/positions.avro", "tables/table-id/data/positions.parquet", 1),
|
||||
("tables/table-id/metadata/equality.avro", "tables/table-id/data/equality.parquet", 2),
|
||||
] {
|
||||
let location = format!("s3://{BUCKET}/{object}");
|
||||
let bytes = manifest_avro_bytes(&[(&location, content, 1, 42, 7)]);
|
||||
manifests.push((format!("s3://{BUCKET}/{manifest}"), bytes.len(), if content == 0 { 0 } else { 1 }));
|
||||
backend.seed_object(BUCKET, manifest, bytes).await;
|
||||
backend.seed_object(BUCKET, object, vec![1]).await;
|
||||
}
|
||||
let manifest_entries = manifests
|
||||
.iter()
|
||||
.map(|(path, size, content)| (path.as_str(), *size, 0, *content, 7, 42))
|
||||
.collect::<Vec<_>>();
|
||||
backend
|
||||
.seed_object(BUCKET, MANIFEST_LIST, manifest_list_avro_entries_with_content(&manifest_entries))
|
||||
.await;
|
||||
let history_data_location = format!("s3://{BUCKET}/{HISTORY_DATA}");
|
||||
let history_manifest_bytes = manifest_avro_bytes(&[(&history_data_location, 0, 1, 20, 6)]);
|
||||
let history_manifest_location = format!("s3://{BUCKET}/{HISTORY_MANIFEST}");
|
||||
backend
|
||||
.seed_object(
|
||||
BUCKET,
|
||||
HISTORY_MANIFEST_LIST,
|
||||
manifest_list_avro_entries_with_content(&[(&history_manifest_location, history_manifest_bytes.len(), 0, 0, 6, 20)]),
|
||||
)
|
||||
.await;
|
||||
backend.seed_object(BUCKET, HISTORY_MANIFEST, history_manifest_bytes).await;
|
||||
backend.seed_object(BUCKET, HISTORY_DATA, vec![1]).await;
|
||||
backend.seed_object(BUCKET, HISTORY_STATISTICS, b"PFA1PFA1".to_vec()).await;
|
||||
backend.seed_object(BUCKET, TABLE_STATISTICS, b"PFA1PFA1".to_vec()).await;
|
||||
backend.seed_object(BUCKET, PARTITION_STATISTICS, b"ORC".to_vec()).await;
|
||||
backend
|
||||
.seed_object(BUCKET, ¤t, serde_json::to_vec(¤t_metadata).unwrap())
|
||||
.await;
|
||||
backend
|
||||
.seed_object(BUCKET, &history, serde_json::to_vec(&historical_metadata).unwrap())
|
||||
.await;
|
||||
backend
|
||||
.seed_object(BUCKET, &view_metadata, serde_json::to_vec(&view_metadata_json).unwrap())
|
||||
.await;
|
||||
let table_path = paths.table_entry_path(BUCKET, &namespace, &table);
|
||||
let view_path = paths.view_entry_path(BUCKET, &namespace, &view);
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &table_path, serde_json::to_vec(&entry).unwrap())
|
||||
.await;
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &view_path, serde_json::to_vec(&view_entry).unwrap())
|
||||
.await;
|
||||
let mut objects = vec![
|
||||
embedded_object(&backend, RUSTFS_META_BUCKET, &table_path).await,
|
||||
embedded_object(&backend, RUSTFS_META_BUCKET, &view_path).await,
|
||||
embedded_object(&backend, BUCKET, ¤t).await,
|
||||
];
|
||||
objects.sort_by(|left, right| (&left.bucket, &left.object).cmp(&(&right.bucket, &right.object)));
|
||||
InventoryFixture {
|
||||
backend,
|
||||
objects,
|
||||
current,
|
||||
history,
|
||||
unretained_history,
|
||||
view: view_metadata,
|
||||
}
|
||||
}
|
||||
|
||||
async fn copied_backend_with_new_etags(source: &TestCatalogObjectBackend) -> TestCatalogObjectBackend {
|
||||
let objects = source
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.iter()
|
||||
.map(|(key, value)| (key.clone(), value.data.clone()))
|
||||
.collect::<Vec<_>>();
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
for _ in 0..=objects.len() {
|
||||
target.seed_object("unrelated", "etag-offset", vec![0]).await;
|
||||
}
|
||||
for ((bucket, object), bytes) in objects {
|
||||
target.seed_object(&bucket, &object, bytes).await;
|
||||
}
|
||||
target
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn inventory_captures_all_reference_kinds_and_only_direct_metadata_history() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = store
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
validate_object_catalog_backup_reference_shape(BUCKET, &references).unwrap();
|
||||
for kind in [
|
||||
ObjectCatalogBackupReferenceKind::TableMetadata,
|
||||
ObjectCatalogBackupReferenceKind::ViewMetadata,
|
||||
ObjectCatalogBackupReferenceKind::ManifestList,
|
||||
ObjectCatalogBackupReferenceKind::ManifestFile,
|
||||
ObjectCatalogBackupReferenceKind::DataFile,
|
||||
ObjectCatalogBackupReferenceKind::DeleteFile,
|
||||
ObjectCatalogBackupReferenceKind::TableStatistics,
|
||||
ObjectCatalogBackupReferenceKind::PartitionStatistics,
|
||||
] {
|
||||
assert!(references.iter().any(|reference| reference.kind == kind), "missing {kind:?}");
|
||||
}
|
||||
for object in [&fixture.current, &fixture.history, &fixture.view] {
|
||||
assert_eq!(references.iter().filter(|reference| &reference.object == object).count(), 1);
|
||||
}
|
||||
for object in [HISTORY_MANIFEST_LIST, HISTORY_MANIFEST, HISTORY_DATA, HISTORY_STATISTICS] {
|
||||
assert_eq!(references.iter().filter(|reference| reference.object == object).count(), 1);
|
||||
}
|
||||
assert!(
|
||||
!references
|
||||
.iter()
|
||||
.any(|reference| reference.object == fixture.unretained_history)
|
||||
);
|
||||
assert_eq!(
|
||||
references
|
||||
.iter()
|
||||
.filter(|reference| reference.kind == ObjectCatalogBackupReferenceKind::DeleteFile)
|
||||
.count(),
|
||||
2
|
||||
);
|
||||
assert!(references.iter().all(|reference| reference.sha256.is_some()));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn prepared_small_objects_verify_by_bytes_across_different_etags_without_writes() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
let target_backend = copied_backend_with_new_etags(&fixture.backend).await;
|
||||
let target = ObjectTableCatalogStore::new(target_backend.clone());
|
||||
let observed = target
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(
|
||||
references
|
||||
.iter()
|
||||
.zip(&observed)
|
||||
.all(|(source, target)| source.etag != target.etag)
|
||||
);
|
||||
target_backend.reset_call_counts().await;
|
||||
target
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await
|
||||
.unwrap();
|
||||
let state = target_backend.state.lock().await;
|
||||
assert!(state.put_attempts.is_empty());
|
||||
assert!(state.delete_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn deleted_only_missing_files_are_excluded_but_a_retained_snapshot_still_requires_its_live_file() {
|
||||
let mut fixture = inventory_fixture().await;
|
||||
let missing_deleted = "tables/table-id/data/expired.parquet";
|
||||
let shared_location = format!("s3://{BUCKET}/{DATA}");
|
||||
let missing_location = format!("s3://{BUCKET}/{missing_deleted}");
|
||||
let history_manifest = manifest_avro_bytes(&[(&shared_location, 0, 0, 20, 6)]);
|
||||
let history_manifest_location = format!("s3://{BUCKET}/{HISTORY_MANIFEST}");
|
||||
fixture
|
||||
.backend
|
||||
.seed_object(
|
||||
BUCKET,
|
||||
HISTORY_MANIFEST_LIST,
|
||||
manifest_list_avro_entries_with_content(&[(&history_manifest_location, history_manifest.len(), 0, 0, 6, 20)]),
|
||||
)
|
||||
.await;
|
||||
fixture.backend.seed_object(BUCKET, HISTORY_MANIFEST, history_manifest).await;
|
||||
let deleted_manifest = manifest_avro_bytes(&[(&missing_location, 0, 2, 42, 7), (&shared_location, 0, 2, 42, 7)]);
|
||||
fixture.backend.seed_object(BUCKET, DATA_MANIFEST, deleted_manifest).await;
|
||||
let mut manifest_entries = Vec::new();
|
||||
for (object, content) in [
|
||||
(DATA_MANIFEST, 0),
|
||||
("tables/table-id/metadata/positions.avro", 1),
|
||||
("tables/table-id/metadata/equality.avro", 1),
|
||||
] {
|
||||
let size = fixture.backend.object_metadata(BUCKET, object).await.unwrap().unwrap().size;
|
||||
manifest_entries.push((format!("s3://{BUCKET}/{object}"), usize::try_from(size).unwrap(), content));
|
||||
}
|
||||
let manifest_references = manifest_entries
|
||||
.iter()
|
||||
.map(|(path, size, content)| (path.as_str(), *size, 0, *content, 7, 42))
|
||||
.collect::<Vec<_>>();
|
||||
fixture
|
||||
.backend
|
||||
.seed_object(BUCKET, MANIFEST_LIST, manifest_list_avro_entries_with_content(&manifest_references))
|
||||
.await;
|
||||
let index = fixture
|
||||
.objects
|
||||
.iter()
|
||||
.position(|object| object.bucket == BUCKET && object.object == fixture.current)
|
||||
.unwrap();
|
||||
let mut metadata: serde_json::Value = serde_json::from_slice(&fixture.objects[index].data).unwrap();
|
||||
let historical = fixture.backend.read_object(BUCKET, &fixture.history).await.unwrap().unwrap();
|
||||
let historical: serde_json::Value = serde_json::from_slice(&historical.data).unwrap();
|
||||
metadata["snapshots"]
|
||||
.as_array_mut()
|
||||
.unwrap()
|
||||
.insert(0, historical["snapshots"][0].clone());
|
||||
metadata["snapshot-log"] = serde_json::json!([
|
||||
{"timestamp-ms": 1, "snapshot-id": 20}, {"timestamp-ms": 2, "snapshot-id": 42}
|
||||
]);
|
||||
metadata["refs"]["retained"] = serde_json::json!({"type": "branch", "snapshot-id": 20});
|
||||
fixture
|
||||
.backend
|
||||
.seed_object(BUCKET, &fixture.current, serde_json::to_vec(&metadata).unwrap())
|
||||
.await;
|
||||
fixture.objects[index] = embedded_object(&fixture.backend, BUCKET, &fixture.current).await;
|
||||
let entry = fixture
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.bucket == RUSTFS_META_BUCKET && object.object.ends_with(TABLE_ENTRY_FILE))
|
||||
.unwrap();
|
||||
let entry: TableEntry = serde_json::from_slice(&entry.data).unwrap();
|
||||
let context = TableSnapshotGraphValidationContext::new(&fixture.backend, BUCKET, &entry);
|
||||
fixture.backend.reset_call_counts().await;
|
||||
let reads_before = fixture.backend.state.lock().await.read_attempts.clone();
|
||||
let graph = validated_table_snapshot_graph_inventory(&context, &metadata).await.unwrap();
|
||||
assert!(!graph.contains_key(missing_deleted));
|
||||
assert_eq!(graph.get(DATA), Some(&TableMetadataMaintenanceObjectKind::DataFile));
|
||||
assert_eq!(graph.get(DATA_MANIFEST), Some(&TableMetadataMaintenanceObjectKind::ManifestFile));
|
||||
let state = fixture.backend.state.lock().await;
|
||||
for object in [MANIFEST_LIST, DATA_MANIFEST, HISTORY_MANIFEST_LIST, HISTORY_MANIFEST] {
|
||||
let key = (BUCKET.to_string(), object.to_string());
|
||||
let expected = reads_before.get(&key).copied().unwrap_or_default() + 1;
|
||||
assert_eq!(state.read_attempts.get(&key), Some(&expected), "repeated graph read: {object}");
|
||||
}
|
||||
drop(state);
|
||||
let store = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = store
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(!references.iter().any(|reference| reference.object == missing_deleted));
|
||||
assert_eq!(references.iter().filter(|reference| reference.object == DATA).count(), 1);
|
||||
fixture
|
||||
.backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.remove(&(BUCKET.to_string(), DATA.to_string()));
|
||||
assert!(matches!(
|
||||
validated_table_snapshot_graph_inventory(&context, &metadata).await,
|
||||
Err(TableCatalogStoreError::Invalid(message)) if message == "manifest referenced data file is missing"
|
||||
));
|
||||
assert!(
|
||||
store
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn changed_small_content_is_rejected_even_when_size_and_graph_are_unchanged() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
let target_backend = copied_backend_with_new_etags(&fixture.backend).await;
|
||||
target_backend.seed_object(BUCKET, DATA, vec![9]).await;
|
||||
let target = ObjectTableCatalogStore::new(target_backend.clone());
|
||||
target_backend.reset_call_counts().await;
|
||||
assert!(matches!(
|
||||
target
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
let state = target_backend.state.lock().await;
|
||||
assert!(state.put_attempts.is_empty());
|
||||
assert!(state.delete_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn absent_history_view_manifest_data_or_statistics_prevents_validation() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
for object in [
|
||||
fixture.history.as_str(),
|
||||
fixture.view.as_str(),
|
||||
MANIFEST_LIST,
|
||||
DATA_MANIFEST,
|
||||
DATA,
|
||||
TABLE_STATISTICS,
|
||||
PARTITION_STATISTICS,
|
||||
] {
|
||||
let backend = copied_backend_with_new_etags(&fixture.backend).await;
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.remove(&(BUCKET.to_string(), object.to_string()));
|
||||
backend.reset_call_counts().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(
|
||||
store
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await
|
||||
.is_err(),
|
||||
"accepted missing {object}"
|
||||
);
|
||||
let state = backend.state.lock().await;
|
||||
assert!(state.put_attempts.is_empty());
|
||||
assert!(state.delete_attempts.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn absent_inline_current_metadata_remains_a_planned_immutable_restore_write() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.expect("source inventory");
|
||||
let backend = copied_backend_with_new_etags(&fixture.backend).await;
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.remove(&(BUCKET.to_string(), fixture.current.clone()));
|
||||
backend.reset_call_counts().await;
|
||||
let target = ObjectTableCatalogStore::new(backend.clone());
|
||||
target
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await
|
||||
.expect("the inline immutable metadata can be published later by the fenced restore plan");
|
||||
{
|
||||
let state = backend.state.lock().await;
|
||||
assert!(!state.objects.contains_key(&(BUCKET.to_string(), fixture.current.clone())));
|
||||
assert!(state.put_attempts.is_empty());
|
||||
assert!(state.delete_attempts.is_empty());
|
||||
}
|
||||
let mut changed = fixture
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.bucket == BUCKET && object.object == fixture.current)
|
||||
.expect("inline current metadata")
|
||||
.data
|
||||
.clone();
|
||||
changed[0] ^= 1;
|
||||
backend.seed_object(BUCKET, &fixture.current, changed).await;
|
||||
backend.reset_call_counts().await;
|
||||
assert!(matches!(
|
||||
target
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
let state = backend.state.lock().await;
|
||||
assert!(state.put_attempts.is_empty());
|
||||
assert!(state.delete_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn reference_shape_is_rejected_before_backend_access() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
let mut cases = Vec::new();
|
||||
let mut duplicate = references.clone();
|
||||
duplicate.insert(0, duplicate[0].clone());
|
||||
cases.push(duplicate);
|
||||
let mut unsorted = references.clone();
|
||||
unsorted.reverse();
|
||||
cases.push(unsorted);
|
||||
for (foreign_bucket, invalid_key, missing_digest) in [(true, false, false), (false, true, false), (false, false, true)] {
|
||||
let mut invalid = references.clone();
|
||||
if foreign_bucket {
|
||||
invalid[0].bucket = "foreign".to_string();
|
||||
}
|
||||
if invalid_key {
|
||||
invalid[0].object = "../outside.parquet".to_string();
|
||||
}
|
||||
if missing_digest {
|
||||
invalid[0].sha256 = None;
|
||||
}
|
||||
cases.push(invalid);
|
||||
}
|
||||
for invalid in cases {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(matches!(
|
||||
store
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &invalid)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Invalid(_))
|
||||
));
|
||||
let state = backend.state.lock().await;
|
||||
assert_eq!(state.read_calls, 0);
|
||||
assert_eq!(state.metadata_calls, 0);
|
||||
assert_eq!(state.list_calls, 0);
|
||||
assert!(state.put_attempts.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn saved_inventory_cannot_omit_add_or_relabel_graph_objects() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
let mut omitted = references.clone();
|
||||
omitted.pop();
|
||||
let mut extra = references.clone();
|
||||
let mut unrelated = extra[0].clone();
|
||||
unrelated.object = "tables/table-id/data/unrelated.parquet".to_string();
|
||||
extra.push(unrelated);
|
||||
extra.sort_by(|left, right| (&left.bucket, &left.object).cmp(&(&right.bucket, &right.object)));
|
||||
let mut relabeled = references.clone();
|
||||
relabeled[0].kind = if relabeled[0].kind == ObjectCatalogBackupReferenceKind::DataFile {
|
||||
ObjectCatalogBackupReferenceKind::DeleteFile
|
||||
} else {
|
||||
ObjectCatalogBackupReferenceKind::DataFile
|
||||
};
|
||||
for invalid in [omitted, extra, relabeled] {
|
||||
assert!(matches!(
|
||||
source
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &invalid)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn capture_rejects_malformed_manifest_and_wrong_history_or_view_identity() {
|
||||
for case in 0..3 {
|
||||
let fixture = inventory_fixture().await;
|
||||
let object = match case {
|
||||
0 => DATA_MANIFEST,
|
||||
1 => fixture.history.as_str(),
|
||||
_ => fixture.view.as_str(),
|
||||
};
|
||||
let stored = fixture.backend.read_object(BUCKET, object).await.unwrap().unwrap();
|
||||
let bytes = if case == 0 {
|
||||
b"invalid-avro".to_vec()
|
||||
} else {
|
||||
let mut value: serde_json::Value = serde_json::from_slice(&stored.data).unwrap();
|
||||
value[if case == 1 { "table-uuid" } else { "view-uuid" }] = serde_json::json!("another-identity");
|
||||
serde_json::to_vec(&value).unwrap()
|
||||
};
|
||||
fixture.backend.seed_object(BUCKET, object, bytes).await;
|
||||
fixture.backend.reset_call_counts().await;
|
||||
let store = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
assert!(
|
||||
store
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert!(fixture.backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn fingerprint_rejects_changed_etag_after_the_content_read() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
backend.seed_object(BUCKET, DATA, vec![1]).await;
|
||||
let pause = backend.pause_next_read(BUCKET, DATA).await;
|
||||
let reader_backend = backend.clone();
|
||||
let task = tokio::spawn(async move {
|
||||
ObjectTableCatalogStore::new(reader_backend)
|
||||
.object_catalog_backup_reference_fingerprint(BUCKET, DATA, ObjectCatalogBackupReferenceKind::DataFile)
|
||||
.await
|
||||
});
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), pause.wait_started())
|
||||
.await
|
||||
.unwrap();
|
||||
backend.seed_object(BUCKET, DATA, vec![1]).await;
|
||||
pause.release();
|
||||
let result = tokio::time::timeout(std::time::Duration::from_secs(5), task)
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
assert!(matches!(result, Err(TableCatalogStoreError::Conflict(_))));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn fingerprint_propagates_read_failure_and_rejects_etagless_objects() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
backend.seed_object(BUCKET, DATA, vec![1]).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
*backend.fail_read_object_path.lock().await = Some(DATA.to_string());
|
||||
assert!(matches!(
|
||||
store
|
||||
.object_catalog_backup_reference_fingerprint(BUCKET, DATA, ObjectCatalogBackupReferenceKind::DataFile)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Internal(_))
|
||||
));
|
||||
backend.omit_etag_for_object(BUCKET, DATA).await;
|
||||
assert!(matches!(
|
||||
store
|
||||
.object_catalog_backup_reference_fingerprint(BUCKET, DATA, ObjectCatalogBackupReferenceKind::DataFile)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Invalid(_))
|
||||
));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn large_objects_keep_the_size_etag_contract_and_are_not_read_into_memory() {
|
||||
let fixture = inventory_fixture().await;
|
||||
let length = usize::try_from(OBJECT_CATALOG_BACKUP_REFERENCE_HASH_MAX_SIZE).unwrap() + 1;
|
||||
fixture.backend.seed_object(BUCKET, DATA, vec![1; length]).await;
|
||||
fixture.backend.reset_call_counts().await;
|
||||
let source = ObjectTableCatalogStore::new(fixture.backend.clone());
|
||||
let references = source
|
||||
.capture_object_catalog_backup_references(BUCKET, &fixture.objects)
|
||||
.await
|
||||
.unwrap();
|
||||
let large = references.iter().find(|reference| reference.object == DATA).unwrap();
|
||||
assert_eq!(large.size_bytes, u64::try_from(length).unwrap());
|
||||
assert_eq!(large.sha256, None);
|
||||
assert_eq!(fixture.backend.last_read_limit(BUCKET, DATA).await, None);
|
||||
let backend = copied_backend_with_new_etags(&fixture.backend).await;
|
||||
let target = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(matches!(
|
||||
target
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.get_mut(&(BUCKET.to_string(), DATA.to_string()))
|
||||
.unwrap()
|
||||
.etag = large.etag.clone().unwrap();
|
||||
target
|
||||
.validate_object_catalog_backup_references(BUCKET, &fixture.objects, &references)
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(backend.last_read_limit(BUCKET, DATA).await, None);
|
||||
}
|
||||
@@ -1,262 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::super::object::validate_table_maintenance_report_owner;
|
||||
use super::*;
|
||||
|
||||
#[derive(Debug, Default, PartialEq, Eq)]
|
||||
pub(super) struct ObjectCatalogBackupMaintenanceSummary {
|
||||
pub(super) object_count: usize,
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct BackupMaintenanceOwner {
|
||||
named: BTreeMap<String, TableMetadataMaintenanceReport>,
|
||||
latest: Option<TableMetadataMaintenanceReport>,
|
||||
current: Option<TableMetadataMaintenanceReport>,
|
||||
}
|
||||
|
||||
impl<B> ObjectTableCatalogStore<B>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
/// Counts recognized sidecars without granting authority to a candidate.
|
||||
pub(super) fn backup_maintenance_object_count(&self, table_bucket: &str, objects: &[ObjectCatalogBackupObject]) -> usize {
|
||||
let config = self.paths.table_bucket_maintenance_config_path(table_bucket);
|
||||
objects
|
||||
.iter()
|
||||
.filter(|object| {
|
||||
object.bucket == self.catalog_bucket()
|
||||
&& (object.object == config
|
||||
|| backup_historical_maintenance_path(&self.paths, table_bucket, &object.object).is_some())
|
||||
})
|
||||
.count()
|
||||
}
|
||||
|
||||
/// Validates maintenance authority in an already captured catalog snapshot.
|
||||
///
|
||||
/// Callers hold the backup/publication fences and validate the artifact's
|
||||
/// ordinary entry, size, hash and metadata contracts separately. This pure
|
||||
/// check never expires a lease or repairs aliases. It preserves all source
|
||||
/// bytes, including audit, quarantine and historical worker identities.
|
||||
pub(super) fn validate_backup_maintenance_authority(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
objects: &[ObjectCatalogBackupObject],
|
||||
) -> TableCatalogStoreResult<ObjectCatalogBackupMaintenanceSummary> {
|
||||
let mut owners = BTreeSet::new();
|
||||
let mut seen_paths = BTreeSet::new();
|
||||
for object in objects.iter().filter(|object| object.bucket == self.catalog_bucket()) {
|
||||
if !seen_paths.insert(object.object.as_str()) {
|
||||
return Err(TableCatalogStoreError::Invalid("catalog backup has a duplicate object path".to_string()));
|
||||
}
|
||||
if !object.object.ends_with(TABLE_ENTRY_FILE) {
|
||||
continue;
|
||||
}
|
||||
let entry: TableEntry = serde_json::from_slice(&object.data)
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("invalid maintenance catalog owner in backup".to_string()))?;
|
||||
validate_table_entry_object(&self.paths, &object.object, &entry)?;
|
||||
if entry.table_bucket != table_bucket {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"backup maintenance owner belongs to another bucket".to_string(),
|
||||
));
|
||||
}
|
||||
if matches!(entry.state, TableCatalogEntryState::Renaming | TableCatalogEntryState::Deleting) {
|
||||
return Err(backup_maintenance_recovery_required("catalog owner has a pending table operation"));
|
||||
}
|
||||
// read_table_with_etag_unlocked does not filter Deleted entries.
|
||||
// Retained owners must therefore also fence their current lease.
|
||||
let namespace = parse_namespace_for_store(&entry.namespace)?;
|
||||
let table = parse_table_for_store(&entry.table)?;
|
||||
let config = self
|
||||
.paths
|
||||
.table_maintenance_config_path(table_bucket, &namespace, &table, &entry.table_id);
|
||||
owners.insert(config.trim_end_matches(MAINTENANCE_CONFIG_FILE).to_string());
|
||||
}
|
||||
|
||||
let mut summary = ObjectCatalogBackupMaintenanceSummary::default();
|
||||
let mut reports = BTreeMap::<String, BackupMaintenanceOwner>::new();
|
||||
let bucket_config = self.paths.table_bucket_maintenance_config_path(table_bucket);
|
||||
for object in objects.iter().filter(|object| object.bucket == self.catalog_bucket()) {
|
||||
if object.object == bucket_config {
|
||||
validate_backup_maintenance_config(&object.data)?;
|
||||
summary.object_count += 1;
|
||||
continue;
|
||||
}
|
||||
if object.object.ends_with(TABLE_ENTRY_FILE)
|
||||
|| object.object.ends_with(NAMESPACE_ENTRY_FILE)
|
||||
|| object.object.ends_with(VIEW_ENTRY_FILE)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
let owned_prefix = owners
|
||||
.range(..=object.object.clone())
|
||||
.next_back()
|
||||
.filter(|prefix| object.object.starts_with(prefix.as_str()));
|
||||
let path = match owned_prefix {
|
||||
Some(prefix) => Some((prefix.as_str(), &object.object[prefix.len()..])),
|
||||
None => backup_historical_maintenance_path(&self.paths, table_bucket, &object.object),
|
||||
};
|
||||
let Some((prefix, suffix)) = path else {
|
||||
continue;
|
||||
};
|
||||
summary.object_count += 1;
|
||||
if suffix == MAINTENANCE_CONFIG_FILE {
|
||||
validate_backup_maintenance_config(&object.data)?;
|
||||
continue;
|
||||
}
|
||||
let report: TableMetadataMaintenanceReport = serde_json::from_slice(&object.data)
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("invalid maintenance report in backup".to_string()))?;
|
||||
if report.job.table_id.is_empty() {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"backup maintenance report has no table identity".to_string(),
|
||||
));
|
||||
}
|
||||
let namespace = parse_namespace_for_store(&report.job.namespace)?;
|
||||
let table = parse_table_for_store(&report.job.table)?;
|
||||
validate_table_maintenance_report_owner(&report, table_bucket, &namespace, &table, &report.job.table_id)?;
|
||||
let owner = reports.entry(prefix.to_string()).or_default();
|
||||
let expected = match suffix {
|
||||
MAINTENANCE_CURRENT_JOB_FILE => {
|
||||
owner.current = Some(report.clone());
|
||||
self.paths
|
||||
.table_maintenance_current_job_path(table_bucket, &namespace, &table, &report.job.table_id)
|
||||
}
|
||||
MAINTENANCE_LATEST_JOB_FILE => {
|
||||
owner.latest = Some(report.clone());
|
||||
self.paths
|
||||
.table_maintenance_latest_job_path(table_bucket, &namespace, &table, &report.job.table_id)
|
||||
}
|
||||
_ if suffix.starts_with(&format!("{MAINTENANCE_JOB_ROOT}/")) => {
|
||||
owner.named.insert(report.job.job_id.clone(), report.clone());
|
||||
self.paths.table_maintenance_job_path(
|
||||
table_bucket,
|
||||
&namespace,
|
||||
&table,
|
||||
&report.job.table_id,
|
||||
&report.job.job_id,
|
||||
)
|
||||
}
|
||||
_ => {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"unexpected maintenance object path in backup".to_string(),
|
||||
));
|
||||
}
|
||||
};
|
||||
if object.object != expected {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"backup maintenance report does not match its object path".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
for (prefix, owner) in reports {
|
||||
if !owners.contains(&prefix) {
|
||||
// No restored catalog owner can discover this incarnation.
|
||||
// Keep its historical bytes without granting execution authority.
|
||||
continue;
|
||||
}
|
||||
let current = owner
|
||||
.current
|
||||
.as_ref()
|
||||
.ok_or_else(|| backup_maintenance_recovery_required("maintenance reports have no current authority"))?;
|
||||
let latest = owner
|
||||
.latest
|
||||
.as_ref()
|
||||
.ok_or_else(|| backup_maintenance_recovery_required("current maintenance authority has no latest report"))?;
|
||||
let named = owner
|
||||
.named
|
||||
.get(¤t.job.job_id)
|
||||
.ok_or_else(|| backup_maintenance_recovery_required("current maintenance authority has no named report"))?;
|
||||
if current != latest || current != named {
|
||||
return Err(backup_maintenance_recovery_required(
|
||||
"named, latest and current maintenance reports are not consistently published",
|
||||
));
|
||||
}
|
||||
if matches!(
|
||||
current.job.status,
|
||||
TableMetadataMaintenanceJobStatus::Queued | TableMetadataMaintenanceJobStatus::Running
|
||||
) {
|
||||
return Err(TableCatalogStoreError::Conflict(format!(
|
||||
"maintenance recovery required before backup or restore: {}/{}/{} job {} attempt {} is {:?}; finish or recover the current job and capture a new stable backup",
|
||||
current.job.table_bucket,
|
||||
current.job.namespace,
|
||||
current.job.table,
|
||||
current.job.job_id,
|
||||
current.job.attempt,
|
||||
current.job.status,
|
||||
)));
|
||||
}
|
||||
// Only aliases grant authority. A historical named Running job with
|
||||
// another id cannot heartbeat or reclaim this stable current job.
|
||||
}
|
||||
Ok(summary)
|
||||
}
|
||||
}
|
||||
|
||||
fn backup_maintenance_recovery_required(reason: &str) -> TableCatalogStoreError {
|
||||
TableCatalogStoreError::Conflict(format!(
|
||||
"maintenance recovery required before backup or restore: {reason}; inspect the named, latest and current reports, recover their existing authority, then capture a stable backup"
|
||||
))
|
||||
}
|
||||
|
||||
fn validate_backup_maintenance_config(data: &[u8]) -> TableCatalogStoreResult<()> {
|
||||
let config: TableMaintenanceConfig = serde_json::from_slice(data)
|
||||
.map_err(|_| TableCatalogStoreError::Invalid("invalid maintenance config in backup".to_string()))?;
|
||||
validate_table_maintenance_config(&config)
|
||||
}
|
||||
|
||||
/// Recognizes canonical, known-format sidecars from superseded incarnations.
|
||||
/// Their embedded reports still undergo the ordinary owner/path validation.
|
||||
fn backup_historical_maintenance_path<'a>(
|
||||
paths: &TableCatalogObjectPaths,
|
||||
table_bucket: &str,
|
||||
object: &'a str,
|
||||
) -> Option<(&'a str, &'a str)> {
|
||||
let namespace_prefix = paths.namespace_entries_prefix(table_bucket);
|
||||
let relative = object.strip_prefix(&namespace_prefix)?;
|
||||
let (head, tail) = relative.rsplit_once(&format!("/{MAINTENANCE_ROOT}/"))?;
|
||||
let (namespace_path, table) = head.rsplit_once(&format!("/{TABLE_ROOT}/"))?;
|
||||
if table.contains('/')
|
||||
|| IdentifierSegment::parse(table).is_err()
|
||||
|| Namespace::from_segments(namespace_path.split('/').map(str::to_string).collect()).is_err()
|
||||
{
|
||||
return None;
|
||||
}
|
||||
let (identity_hash, suffix) = tail.split_once('/')?;
|
||||
if identity_hash.len() != 64
|
||||
|| !identity_hash
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
|
||||
{
|
||||
return None;
|
||||
}
|
||||
let is_known = matches!(
|
||||
suffix,
|
||||
MAINTENANCE_CONFIG_FILE | MAINTENANCE_CURRENT_JOB_FILE | MAINTENANCE_LATEST_JOB_FILE
|
||||
) || suffix
|
||||
.strip_prefix(&format!("{MAINTENANCE_JOB_ROOT}/"))
|
||||
.and_then(|name| name.strip_suffix(".json"))
|
||||
.is_some_and(|hash| {
|
||||
hash.len() == 64
|
||||
&& hash
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
|
||||
});
|
||||
is_known.then(|| (&object[..object.len() - suffix.len()], suffix))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "object_backup_maintenance_tests.rs"]
|
||||
mod tests;
|
||||
@@ -1,347 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use crate::table_catalog::test_support::TestCatalogObjectBackend;
|
||||
|
||||
fn fixture() -> (
|
||||
ObjectTableCatalogStore<TestCatalogObjectBackend>,
|
||||
Vec<ObjectCatalogBackupObject>,
|
||||
TableEntry,
|
||||
) {
|
||||
let backup: ObjectCatalogBackup =
|
||||
serde_json::from_slice(include_bytes!("../tests/fixtures/object-catalog-backup-v1.json")).expect("existing v1 fixture");
|
||||
let entry = serde_json::from_slice(
|
||||
&backup
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.object.ends_with(TABLE_ENTRY_FILE))
|
||||
.unwrap()
|
||||
.data,
|
||||
)
|
||||
.expect("fixture table owner");
|
||||
(ObjectTableCatalogStore::new(TestCatalogObjectBackend::default()), backup.objects, entry)
|
||||
}
|
||||
|
||||
fn report(entry: &TableEntry, job_id: &str, status: TableMetadataMaintenanceJobStatus) -> TableMetadataMaintenanceReport {
|
||||
serde_json::from_value(serde_json::json!({
|
||||
"job": {
|
||||
"job_id": job_id,
|
||||
"table_bucket": entry.table_bucket,
|
||||
"namespace": entry.namespace,
|
||||
"table": entry.table,
|
||||
"table_id": entry.table_id,
|
||||
"status": status,
|
||||
"worker_id": "retained-worker",
|
||||
"lease_id": "retained-lease",
|
||||
"attempt": 1,
|
||||
"heartbeat_at": "2000-01-01T00:00:00Z",
|
||||
"started_at": "2000-01-01T00:00:00Z",
|
||||
"finished_at": "2000-01-01T00:01:00Z",
|
||||
"current_metadata_location": entry.metadata_location,
|
||||
"current_generation": entry.generation,
|
||||
"retain_recent_metadata_files": 2,
|
||||
"safety_window_seconds": 900,
|
||||
"cleanup_watermark_unix_seconds": 1,
|
||||
"quarantine-enabled": true,
|
||||
"quarantine-retention-seconds": 86400,
|
||||
"quarantined_object_count": 1
|
||||
},
|
||||
"current_metadata_location": entry.metadata_location,
|
||||
"retained_metadata_locations": [entry.metadata_location],
|
||||
"cleanup_candidate_locations": [],
|
||||
"deletable_metadata_locations": []
|
||||
}))
|
||||
.expect("valid maintenance report")
|
||||
}
|
||||
|
||||
fn object(path: String, data: Vec<u8>) -> ObjectCatalogBackupObject {
|
||||
ObjectCatalogBackupObject {
|
||||
bucket: RUSTFS_META_BUCKET.to_string(),
|
||||
object: path,
|
||||
size_bytes: u64::try_from(data.len()).unwrap(),
|
||||
etag: Some("retained-etag".to_string()),
|
||||
sha256: backup_sha256(&data),
|
||||
data,
|
||||
}
|
||||
}
|
||||
|
||||
fn report_paths(entry: &TableEntry, job_id: &str) -> [String; 3] {
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let namespace = Namespace::parse(&entry.namespace).unwrap();
|
||||
let table = IdentifierSegment::parse(&entry.table).unwrap();
|
||||
[
|
||||
paths.table_maintenance_job_path(&entry.table_bucket, &namespace, &table, &entry.table_id, job_id),
|
||||
paths.table_maintenance_latest_job_path(&entry.table_bucket, &namespace, &table, &entry.table_id),
|
||||
paths.table_maintenance_current_job_path(&entry.table_bucket, &namespace, &table, &entry.table_id),
|
||||
]
|
||||
}
|
||||
|
||||
fn publish(objects: &mut Vec<ObjectCatalogBackupObject>, entry: &TableEntry, report: &TableMetadataMaintenanceReport) {
|
||||
for path in report_paths(entry, &report.job.job_id) {
|
||||
objects.retain(|existing| existing.object != path);
|
||||
objects.push(object(path, serde_json::to_vec(report).unwrap()));
|
||||
}
|
||||
}
|
||||
|
||||
fn assert_recovery_required(result: TableCatalogStoreResult<ObjectCatalogBackupMaintenanceSummary>) {
|
||||
let error = result.expect_err("unstable maintenance must fail closed");
|
||||
assert!(
|
||||
matches!(&error, TableCatalogStoreError::Conflict(message) if message.contains("maintenance recovery required")),
|
||||
"{error}"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_without_maintenance_keeps_v1_objects_unchanged() {
|
||||
let (store, objects, _) = fixture();
|
||||
let before = objects.clone();
|
||||
assert_eq!(
|
||||
store
|
||||
.validate_backup_maintenance_authority("analytics", &objects)
|
||||
.unwrap()
|
||||
.object_count,
|
||||
0
|
||||
);
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_rejects_current_queued_and_running_even_after_their_timestamps_expired() {
|
||||
for status in [
|
||||
TableMetadataMaintenanceJobStatus::Queued,
|
||||
TableMetadataMaintenanceJobStatus::Running,
|
||||
] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let mut active = report(&entry, "active-job", status);
|
||||
active.job.finished_at = None;
|
||||
publish(&mut objects, &entry, &active);
|
||||
let before = objects.clone();
|
||||
assert_recovery_required(store.validate_backup_maintenance_authority("analytics", &objects));
|
||||
assert_eq!(objects, before, "lease, worker, attempt or aliases were silently rewritten");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn stable_authority_keeps_historical_running_jobs_configs_and_quarantine_bytes() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let stable = report(&entry, "new-job", TableMetadataMaintenanceJobStatus::Successful);
|
||||
publish(&mut objects, &entry, &stable);
|
||||
let historical = report(&entry, "old-job", TableMetadataMaintenanceJobStatus::Running);
|
||||
objects.push(object(
|
||||
report_paths(&entry, &historical.job.job_id)[0].clone(),
|
||||
serde_json::to_vec(&historical).unwrap(),
|
||||
));
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let namespace = Namespace::parse(&entry.namespace).unwrap();
|
||||
let table = IdentifierSegment::parse(&entry.table).unwrap();
|
||||
let config = TableMaintenanceConfig {
|
||||
quarantine_enabled: true,
|
||||
quarantine_retention_seconds: 86_400,
|
||||
..Default::default()
|
||||
};
|
||||
for path in [
|
||||
paths.table_bucket_maintenance_config_path("analytics"),
|
||||
paths.table_maintenance_config_path("analytics", &namespace, &table, &entry.table_id),
|
||||
] {
|
||||
objects.push(object(path, serde_json::to_vec(&config).unwrap()));
|
||||
}
|
||||
// Additive audit/quarantine fields remain raw bytes, including across aliases.
|
||||
for path in report_paths(&entry, &stable.job.job_id) {
|
||||
let saved = objects.iter_mut().find(|object| object.object == path).unwrap();
|
||||
let mut value: serde_json::Value = serde_json::from_slice(&saved.data).unwrap();
|
||||
value["future-quarantine-audit"] = serde_json::json!({"original-worker": "retained-worker", "receipt": [1, 2, 3]});
|
||||
*saved = object(path, serde_json::to_vec(&value).unwrap());
|
||||
}
|
||||
let before = objects.clone();
|
||||
assert_eq!(
|
||||
store
|
||||
.validate_backup_maintenance_authority("analytics", &objects)
|
||||
.unwrap()
|
||||
.object_count,
|
||||
6
|
||||
);
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_requires_every_current_report_view() {
|
||||
for missing in 0..3 {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let stable = report(&entry, "stable-job", TableMetadataMaintenanceJobStatus::Successful);
|
||||
publish(&mut objects, &entry, &stable);
|
||||
let missing = report_paths(&entry, &stable.job.job_id)[missing].clone();
|
||||
objects.retain(|object| object.object != missing);
|
||||
assert_recovery_required(store.validate_backup_maintenance_authority("analytics", &objects));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_rejects_different_attempt_or_lease_even_with_the_same_job_id() {
|
||||
for changed_field in ["attempt", "lease"] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let stable = report(&entry, "stable-job", TableMetadataMaintenanceJobStatus::Successful);
|
||||
publish(&mut objects, &entry, &stable);
|
||||
let mut changed = stable.clone();
|
||||
if changed_field == "attempt" {
|
||||
changed.job.attempt += 1;
|
||||
} else {
|
||||
changed.job.lease_id = "another-lease".to_string();
|
||||
}
|
||||
let latest = report_paths(&entry, &stable.job.job_id)[1].clone();
|
||||
let target = objects
|
||||
.iter_mut()
|
||||
.find(|object| object.object == latest)
|
||||
.expect("latest maintenance receipt");
|
||||
*target = object(latest, serde_json::to_vec(&changed).unwrap());
|
||||
assert_recovery_required(store.validate_backup_maintenance_authority("analytics", &objects));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_does_not_repair_partially_published_terminal_receipts() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let running = report(&entry, "same-attempt", TableMetadataMaintenanceJobStatus::Running);
|
||||
publish(&mut objects, &entry, &running);
|
||||
let terminal = report(&entry, "same-attempt", TableMetadataMaintenanceJobStatus::Successful);
|
||||
let named = report_paths(&entry, &terminal.job.job_id)[0].clone();
|
||||
let target = objects
|
||||
.iter_mut()
|
||||
.find(|object| object.object == named)
|
||||
.expect("named maintenance receipt");
|
||||
*target = object(named, serde_json::to_vec(&terminal).unwrap());
|
||||
let before = objects.clone();
|
||||
assert_recovery_required(store.validate_backup_maintenance_authority("analytics", &objects));
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_validates_report_owner_and_named_job_path() {
|
||||
for changed in ["bucket", "owner", "job-path"] {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let stable = report(&entry, "stable-job", TableMetadataMaintenanceJobStatus::Successful);
|
||||
publish(&mut objects, &entry, &stable);
|
||||
let named = report_paths(&entry, &stable.job.job_id)[0].clone();
|
||||
let saved = objects.iter_mut().find(|object| object.object == named).unwrap();
|
||||
let mut changed_report = stable.clone();
|
||||
match changed {
|
||||
"bucket" => changed_report.job.table_bucket = "another-bucket".to_string(),
|
||||
"owner" => changed_report.job.table_id = "another-table-id".to_string(),
|
||||
"job-path" => changed_report.job.job_id = "another-job".to_string(),
|
||||
_ => unreachable!(),
|
||||
}
|
||||
*saved = object(named, serde_json::to_vec(&changed_report).unwrap());
|
||||
assert!(matches!(
|
||||
store.validate_backup_maintenance_authority("analytics", &objects),
|
||||
Err(TableCatalogStoreError::Invalid(_))
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backup_rejects_an_unknown_sidecar_under_the_current_owner() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let config = TableCatalogObjectPaths::default().table_maintenance_config_path(
|
||||
"analytics",
|
||||
&Namespace::parse(&entry.namespace).unwrap(),
|
||||
&IdentifierSegment::parse(&entry.table).unwrap(),
|
||||
&entry.table_id,
|
||||
);
|
||||
let path = format!("{}unknown.json", config.trim_end_matches(MAINTENANCE_CONFIG_FILE));
|
||||
objects.push(object(
|
||||
path,
|
||||
serde_json::to_vec(&report(&entry, "job", TableMetadataMaintenanceJobStatus::Successful)).unwrap(),
|
||||
));
|
||||
assert!(matches!(
|
||||
store.validate_backup_maintenance_authority("analytics", &objects),
|
||||
Err(TableCatalogStoreError::Invalid(_))
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn superseded_incarnation_sidecars_do_not_gain_authority_on_restore() {
|
||||
let (store, mut objects, mut old_entry) = fixture();
|
||||
old_entry.table_id = "superseded-incarnation".to_string();
|
||||
let old = report(&old_entry, "old-running", TableMetadataMaintenanceJobStatus::Running);
|
||||
publish(&mut objects, &old_entry, &old);
|
||||
let before = objects.clone();
|
||||
assert_eq!(
|
||||
store
|
||||
.validate_backup_maintenance_authority("analytics", &objects)
|
||||
.unwrap()
|
||||
.object_count,
|
||||
3
|
||||
);
|
||||
assert_eq!(objects, before);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn isolated_running_history_for_a_retained_owner_requires_explicit_recovery() {
|
||||
let (store, mut objects, entry) = fixture();
|
||||
let running = report(&entry, "unresolved-job", TableMetadataMaintenanceJobStatus::Running);
|
||||
objects.push(object(
|
||||
report_paths(&entry, &running.job.job_id)[0].clone(),
|
||||
serde_json::to_vec(&running).unwrap(),
|
||||
));
|
||||
assert_recovery_required(store.validate_backup_maintenance_authority("analytics", &objects));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_deleted_catalog_owner_still_cannot_restore_a_discoverable_running_lease() {
|
||||
let (store, mut objects, mut entry) = fixture();
|
||||
entry.state = TableCatalogEntryState::Deleted;
|
||||
let path = objects
|
||||
.iter()
|
||||
.find(|object| object.object.ends_with(TABLE_ENTRY_FILE))
|
||||
.unwrap()
|
||||
.object
|
||||
.clone();
|
||||
let target = objects
|
||||
.iter_mut()
|
||||
.find(|object| object.object == path)
|
||||
.expect("catalog owner entry");
|
||||
*target = object(path, serde_json::to_vec(&entry).unwrap());
|
||||
publish(
|
||||
&mut objects,
|
||||
&entry,
|
||||
&report(&entry, "retained-running", TableMetadataMaintenanceJobStatus::Running),
|
||||
);
|
||||
assert_recovery_required(store.validate_backup_maintenance_authority("analytics", &objects));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hierarchical_namespaces_and_a_table_named_maintenance_keep_canonical_paths() {
|
||||
let (store, mut objects, mut entry) = fixture();
|
||||
objects.retain(|object| !object.object.ends_with(TABLE_ENTRY_FILE));
|
||||
entry.namespace = "sales.history".to_string();
|
||||
entry.table = "maintenance".to_string();
|
||||
let path = TableCatalogObjectPaths::default().table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse(&entry.namespace).unwrap(),
|
||||
&IdentifierSegment::parse(&entry.table).unwrap(),
|
||||
);
|
||||
objects.push(object(path, serde_json::to_vec(&entry).unwrap()));
|
||||
publish(
|
||||
&mut objects,
|
||||
&entry,
|
||||
&report(&entry, "stable", TableMetadataMaintenanceJobStatus::Successful),
|
||||
);
|
||||
assert_eq!(
|
||||
store
|
||||
.validate_backup_maintenance_authority("analytics", &objects)
|
||||
.unwrap()
|
||||
.object_count,
|
||||
3
|
||||
);
|
||||
}
|
||||
@@ -1,490 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::super::backup_types::{TableCatalogBackupObjectPreparationReport, TableCatalogBackupObjectPreparationStatus};
|
||||
use super::inventory::{
|
||||
backup_reference_metadata_log_locations, validate_backup_reference_table_metadata, validate_backup_reference_view_metadata,
|
||||
};
|
||||
use super::*;
|
||||
|
||||
const BACKUP_PREPARATION_MAX_HISTORY_SCOPES: usize = 1024;
|
||||
|
||||
enum BackupObjectPreparationRestoreGate {
|
||||
Unblocked { version: Option<String> },
|
||||
Pending { controls: [(String, String); 2] },
|
||||
}
|
||||
|
||||
fn preparation_pending_phases_match(state: ObjectCatalogRestoreStateKind, intent: ObjectCatalogRestoreStateKind) -> bool {
|
||||
matches!(
|
||||
(state, intent),
|
||||
(ObjectCatalogRestoreStateKind::Prepared, ObjectCatalogRestoreStateKind::Prepared)
|
||||
| (ObjectCatalogRestoreStateKind::Applying, ObjectCatalogRestoreStateKind::Prepared)
|
||||
| (ObjectCatalogRestoreStateKind::Applying, ObjectCatalogRestoreStateKind::CatalogApplied)
|
||||
| (
|
||||
ObjectCatalogRestoreStateKind::CatalogApplied,
|
||||
ObjectCatalogRestoreStateKind::CatalogApplied
|
||||
)
|
||||
| (ObjectCatalogRestoreStateKind::CatalogApplied, ObjectCatalogRestoreStateKind::Completed)
|
||||
)
|
||||
}
|
||||
|
||||
fn preparation_graph_scope_matches(
|
||||
entry: &TableEntry,
|
||||
metadata: &serde_json::Value,
|
||||
reference: &ObjectCatalogBackupReference,
|
||||
) -> TableCatalogStoreResult<bool> {
|
||||
let prefix = table_warehouse_object_prefix(entry)?;
|
||||
let expected_kind = match reference.kind {
|
||||
ObjectCatalogBackupReferenceKind::ManifestList => TableMetadataMaintenanceObjectKind::ManifestList,
|
||||
ObjectCatalogBackupReferenceKind::ManifestFile => TableMetadataMaintenanceObjectKind::ManifestFile,
|
||||
ObjectCatalogBackupReferenceKind::DataFile => TableMetadataMaintenanceObjectKind::DataFile,
|
||||
ObjectCatalogBackupReferenceKind::DeleteFile => TableMetadataMaintenanceObjectKind::DeleteFile,
|
||||
ObjectCatalogBackupReferenceKind::TableStatistics | ObjectCatalogBackupReferenceKind::PartitionStatistics => {
|
||||
for statistics in table_statistics_object_references(metadata)? {
|
||||
let kind_matches = matches!(
|
||||
(reference.kind, statistics.kind),
|
||||
(ObjectCatalogBackupReferenceKind::TableStatistics, IcebergStatisticsFileKind::Table)
|
||||
| (
|
||||
ObjectCatalogBackupReferenceKind::PartitionStatistics,
|
||||
IcebergStatisticsFileKind::Partition
|
||||
)
|
||||
);
|
||||
if kind_matches
|
||||
&& reference.object.starts_with(&prefix)
|
||||
&& table_catalog_object_key_from_location(&entry.table_bucket, &statistics.location).as_deref()
|
||||
== Some(reference.object.as_str())
|
||||
{
|
||||
return Ok(true);
|
||||
}
|
||||
}
|
||||
return Ok(false);
|
||||
}
|
||||
ObjectCatalogBackupReferenceKind::TableMetadata | ObjectCatalogBackupReferenceKind::ViewMetadata => return Ok(false),
|
||||
};
|
||||
Ok(table_maintenance_object_kind_for_entry(entry, Some(&prefix), &reference.object)
|
||||
.is_some_and(|actual| table_maintenance_object_kind_matches_reference(&actual, &expected_kind)))
|
||||
}
|
||||
|
||||
fn validate_preparation_warehouse_owner(
|
||||
entry: &TableEntry,
|
||||
tables: &[(TableEntry, serde_json::Value)],
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
let prefix = table_warehouse_object_prefix(entry)?;
|
||||
for (other, _) in tables {
|
||||
if other.table_id != entry.table_id && warehouse_object_prefixes_overlap(&prefix, &table_warehouse_object_prefix(other)?)
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"backup object preparation scope overlaps another active table".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
impl<B> ObjectTableCatalogStore<B>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
async fn backup_object_preparation_restore_gate(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
backup: &ObjectCatalogBackup,
|
||||
) -> TableCatalogStoreResult<BackupObjectPreparationRestoreGate> {
|
||||
self.reject_legacy_catalog_control_state(table_bucket).await?;
|
||||
let state = self.read_object_catalog_restore_state(table_bucket).await?;
|
||||
let Some((state, state_etag)) = state else {
|
||||
self.ensure_no_active_restore(table_bucket).await?;
|
||||
return Ok(BackupObjectPreparationRestoreGate::Unblocked { version: None });
|
||||
};
|
||||
if state.state == ObjectCatalogRestoreStateKind::Completed {
|
||||
self.ensure_no_active_restore(table_bucket).await?;
|
||||
return Ok(BackupObjectPreparationRestoreGate::Unblocked {
|
||||
version: Some(state_etag),
|
||||
});
|
||||
}
|
||||
if state.backup_id != backup.backup_id {
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"backup object preparation cannot cross another backup's pending restore".to_string(),
|
||||
));
|
||||
}
|
||||
let (intent, intent_etag) = self
|
||||
.read_object_catalog_restore_intent(table_bucket, &state.restore_id)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::Unavailable("pending restore is missing its durable intent".to_string()))?;
|
||||
if state.restore_epoch != intent.restore_epoch
|
||||
|| state.restore_id != intent.restore_id
|
||||
|| state.backup_id != intent.backup_id
|
||||
|| state.request_fingerprint != intent.request_fingerprint
|
||||
|| state.completed_intent_etag.is_some()
|
||||
|| state.backup_etag.is_some()
|
||||
|| !preparation_pending_phases_match(state.state, intent.state)
|
||||
{
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"pending restore does not authorize backup object preparation for this request".to_string(),
|
||||
));
|
||||
}
|
||||
self.validate_restore_plan(backup, &intent)?;
|
||||
Ok(BackupObjectPreparationRestoreGate::Pending {
|
||||
controls: [
|
||||
(self.paths.catalog_restore_state_path(table_bucket), state_etag),
|
||||
(self.paths.catalog_restore_intent_path(table_bucket, &state.restore_id), intent_etag),
|
||||
],
|
||||
})
|
||||
}
|
||||
|
||||
async fn finish_backup_object_preparation_gate(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
gate: &BackupObjectPreparationRestoreGate,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
match gate {
|
||||
BackupObjectPreparationRestoreGate::Unblocked { version } => {
|
||||
self.finish_catalog_restore_read(table_bucket, version.as_deref()).await
|
||||
}
|
||||
BackupObjectPreparationRestoreGate::Pending { controls } => {
|
||||
for (object, expected) in controls {
|
||||
let actual = self.backend.object_metadata(self.catalog_bucket(), object).await?;
|
||||
if actual.as_ref().and_then(|actual| actual.etag.as_deref()) != Some(expected.as_str()) {
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"pending restore controls changed during backup object preparation".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async fn read_stable_preparation_object(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
object: &str,
|
||||
) -> TableCatalogStoreResult<Option<TableCatalogObject>> {
|
||||
let Some(before) = self.backend.object_metadata(table_bucket, object).await? else {
|
||||
return Ok(None);
|
||||
};
|
||||
let max_size = u64::try_from(OBJECT_CATALOG_BACKUP_OBJECT_MAX_SIZE)
|
||||
.map_err(|_| TableCatalogStoreError::Internal("backup preparation size limit is invalid".to_string()))?;
|
||||
if before.size > max_size || before.etag.as_deref().is_none_or(str::is_empty) {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"existing preparation object cannot be safely compared within the size and ETag limits".to_string(),
|
||||
));
|
||||
}
|
||||
let stored = self
|
||||
.backend
|
||||
.read_object_limited(table_bucket, object, OBJECT_CATALOG_BACKUP_OBJECT_MAX_SIZE)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::Conflict("preparation object disappeared during its read".to_string()))?;
|
||||
let after = self
|
||||
.backend
|
||||
.object_metadata(table_bucket, object)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::Conflict("preparation object disappeared after its read".to_string()))?;
|
||||
if stored.etag != before.etag
|
||||
|| after.etag != before.etag
|
||||
|| after.size != before.size
|
||||
|| u64::try_from(stored.data.len()).ok() != Some(before.size)
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict("preparation object changed during its read".to_string()));
|
||||
}
|
||||
Ok(Some(stored))
|
||||
}
|
||||
|
||||
async fn validate_backup_object_preparation_scope(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
backup: &ObjectCatalogBackup,
|
||||
references: &[ObjectCatalogBackupReference],
|
||||
reference: &ObjectCatalogBackupReference,
|
||||
data: &[u8],
|
||||
fence: &TableCatalogObjectMutationFence,
|
||||
) -> TableCatalogStoreResult<()> {
|
||||
let views = self.backup_reference_view_entries(table_bucket, &backup.objects)?;
|
||||
let tables = self.validate_catalog_backup_metadata_identities(table_bucket, &backup.objects)?;
|
||||
for (entry, metadata) in &tables {
|
||||
let current = table_catalog_object_key_from_location(table_bucket, &entry.metadata_location).ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid("backup table current metadata location is invalid".to_string())
|
||||
})?;
|
||||
validate_backup_reference_table_metadata(entry, ¤t, metadata, true)?;
|
||||
validate_preparation_warehouse_owner(entry, &tables)?;
|
||||
if reference.kind == ObjectCatalogBackupReferenceKind::TableMetadata {
|
||||
let historical = backup_reference_metadata_log_locations(metadata, entry)?;
|
||||
if reference.object == current || historical.contains(&reference.object) {
|
||||
if reference.object == current {
|
||||
let embedded = backup
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.bucket == table_bucket && object.object == current)
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid("backup is missing its current metadata payload".to_string())
|
||||
})?;
|
||||
if embedded.data.as_slice() != data {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"current metadata preparation differs from the embedded backup payload".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
let prepared = decode_table_metadata_json(&reference.object, data)?;
|
||||
validate_backup_reference_table_metadata(entry, &reference.object, &prepared, reference.object == current)?;
|
||||
let mut prepared_entry = entry.clone();
|
||||
prepared_entry.warehouse_location = table_metadata_location(&prepared)?.to_string();
|
||||
validate_preparation_warehouse_owner(&prepared_entry, &tables)?;
|
||||
return Ok(());
|
||||
}
|
||||
} else if preparation_graph_scope_matches(entry, metadata, reference)? {
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
if reference.kind == ObjectCatalogBackupReferenceKind::ViewMetadata {
|
||||
for entry in views {
|
||||
if table_catalog_object_key_from_location(table_bucket, &entry.metadata_location).as_deref()
|
||||
== Some(reference.object.as_str())
|
||||
{
|
||||
let metadata = decode_table_metadata_json(&reference.object, data)?;
|
||||
validate_backup_reference_view_metadata(
|
||||
&entry,
|
||||
&parse_namespace_for_store(&entry.namespace)?,
|
||||
&parse_table_for_store(&entry.view)?,
|
||||
&reference.object,
|
||||
&metadata,
|
||||
)?;
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
}
|
||||
if matches!(
|
||||
reference.kind,
|
||||
ObjectCatalogBackupReferenceKind::TableMetadata | ObjectCatalogBackupReferenceKind::ViewMetadata
|
||||
) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"backup metadata preparation is outside an active entry's direct metadata scope".to_string(),
|
||||
));
|
||||
}
|
||||
|
||||
let mut inspected = 0usize;
|
||||
let mut read_bytes = 0u64;
|
||||
let mut missing_history = false;
|
||||
let max_read_bytes = u64::try_from(OBJECT_CATALOG_BACKUP_MAX_SIZE)
|
||||
.map_err(|_| TableCatalogStoreError::Internal("backup preparation history budget is invalid".to_string()))?;
|
||||
for (entry, metadata) in &tables {
|
||||
let current = table_catalog_object_key_from_location(table_bucket, &entry.metadata_location).ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid("backup table current metadata location is invalid".to_string())
|
||||
})?;
|
||||
for object in backup_reference_metadata_log_locations(metadata, entry)? {
|
||||
fence.ensure_held()?;
|
||||
if object == current {
|
||||
continue;
|
||||
}
|
||||
inspected += 1;
|
||||
if inspected > BACKUP_PREPARATION_MAX_HISTORY_SCOPES {
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"historical preparation scope lookup exceeds its 1024-object budget".to_string(),
|
||||
));
|
||||
}
|
||||
let saved = references
|
||||
.binary_search_by(|candidate| {
|
||||
candidate
|
||||
.bucket
|
||||
.as_str()
|
||||
.cmp(table_bucket)
|
||||
.then_with(|| candidate.object.cmp(&object))
|
||||
})
|
||||
.ok()
|
||||
.and_then(|index| references.get(index))
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Invalid(
|
||||
"direct history metadata is missing from the backup reference inventory".to_string(),
|
||||
)
|
||||
})?;
|
||||
if saved.kind != ObjectCatalogBackupReferenceKind::TableMetadata {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"direct history has a conflicting backup reference kind".to_string(),
|
||||
));
|
||||
}
|
||||
read_bytes = read_bytes
|
||||
.checked_add(saved.size_bytes)
|
||||
.filter(|bytes| *bytes <= max_read_bytes)
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Unavailable(
|
||||
"historical preparation scope lookup exceeds its byte budget".to_string(),
|
||||
)
|
||||
})?;
|
||||
let Some(stored) = self.read_stable_preparation_object(table_bucket, &object).await? else {
|
||||
missing_history = true;
|
||||
continue;
|
||||
};
|
||||
if u64::try_from(stored.data.len()).ok() != Some(saved.size_bytes)
|
||||
|| saved.sha256.as_deref() != Some(backup_sha256(&stored.data).as_str())
|
||||
{
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"prepared historical metadata does not match its backup watermark".to_string(),
|
||||
));
|
||||
}
|
||||
let metadata = decode_table_metadata_json(&object, &stored.data)?;
|
||||
validate_backup_reference_table_metadata(entry, &object, &metadata, false)?;
|
||||
let mut historical_entry = entry.clone();
|
||||
historical_entry.warehouse_location = table_metadata_location(&metadata)?.to_string();
|
||||
validate_preparation_warehouse_owner(&historical_entry, &tables)?;
|
||||
if preparation_graph_scope_matches(&historical_entry, &metadata, reference)? {
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
}
|
||||
if missing_history {
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"prepare the referenced direct history metadata before preparing an object outside current warehouse scope"
|
||||
.to_string(),
|
||||
));
|
||||
}
|
||||
Err(TableCatalogStoreError::Invalid(
|
||||
"backup object preparation is outside its active entries and prepared direct history scopes".to_string(),
|
||||
))
|
||||
}
|
||||
|
||||
/// Prepares one small object referenced by a saved v2 backup without publishing catalog state.
|
||||
///
|
||||
/// Only an absent key is written. Exact-byte retries keep the target ETag; different existing bytes are never
|
||||
/// replaced. An ambiguous put is confirmed by a stable read of the original bytes. Cancellation may leave that
|
||||
/// immutable object prepared; retrying the same input confirms it. Pending restore controls are never changed.
|
||||
pub(crate) async fn prepare_object_catalog_backup_object(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
backup_id: &str,
|
||||
object: &str,
|
||||
data: Vec<u8>,
|
||||
) -> TableCatalogStoreResult<TableCatalogBackupObjectPreparationReport> {
|
||||
if table_bucket == self.catalog_bucket() || !safe_object_key(object) || data.len() > OBJECT_CATALOG_BACKUP_OBJECT_MAX_SIZE
|
||||
{
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"backup object preparation has an invalid bucket, key, or body size".to_string(),
|
||||
));
|
||||
}
|
||||
let guards = self.acquire_object_backup_fence(table_bucket).await?;
|
||||
let fence = Self::object_backup_mutation_fence(&guards);
|
||||
fence.ensure_held()?;
|
||||
let backup_path = self.paths.catalog_backup_path(table_bucket, backup_id);
|
||||
let artifact = self
|
||||
.backend
|
||||
.read_object_limited(self.catalog_bucket(), &backup_path, OBJECT_CATALOG_BACKUP_MAX_SIZE)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::NotFound(format!("catalog backup {backup_id}")))?;
|
||||
let artifact_etag = artifact.etag.as_deref().filter(|etag| !etag.is_empty()).ok_or_else(|| {
|
||||
TableCatalogStoreError::Unavailable("catalog backup has no stable ETag for preparation".to_string())
|
||||
})?;
|
||||
let backup = self.decode_object_catalog_backup(table_bucket, &artifact.data)?;
|
||||
if backup.backup_id != backup_id {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup identity does not match its preparation request".to_string(),
|
||||
));
|
||||
}
|
||||
let references = backup
|
||||
.references
|
||||
.as_deref()
|
||||
.filter(|_| backup.version == OBJECT_CATALOG_BACKUP_INVENTORY_VERSION)
|
||||
.ok_or_else(|| {
|
||||
TableCatalogStoreError::Unsupported("object preparation requires a v2 catalog backup inventory".to_string())
|
||||
})?;
|
||||
validate_object_catalog_backup_reference_shape(table_bucket, references)?;
|
||||
let index = references
|
||||
.binary_search_by(|reference| {
|
||||
reference
|
||||
.bucket
|
||||
.as_str()
|
||||
.cmp(table_bucket)
|
||||
.then_with(|| reference.object.as_str().cmp(object))
|
||||
})
|
||||
.map_err(|_| {
|
||||
TableCatalogStoreError::Invalid("object is not present in this catalog backup reference inventory".to_string())
|
||||
})?;
|
||||
let reference = &references[index];
|
||||
let sha256 = backup_sha256(&data);
|
||||
if u64::try_from(data.len()).ok() != Some(reference.size_bytes) || reference.sha256.as_deref() != Some(sha256.as_str()) {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"prepared object body does not match its backup size and SHA-256 watermark".to_string(),
|
||||
));
|
||||
}
|
||||
let gate = self.backup_object_preparation_restore_gate(table_bucket, &backup).await?;
|
||||
self.validate_backup_object_preparation_scope(table_bucket, &backup, references, reference, &data, &fence)
|
||||
.await?;
|
||||
match reference.kind {
|
||||
ObjectCatalogBackupReferenceKind::ManifestList => {
|
||||
decode_manifest_list_avro_async(data.clone()).await?;
|
||||
}
|
||||
ObjectCatalogBackupReferenceKind::ManifestFile => {
|
||||
decode_manifest_avro_async(data.clone()).await?;
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
fence.ensure_held()?;
|
||||
self.finish_backup_object_preparation_gate(table_bucket, &gate).await?;
|
||||
let (status, stored) = if let Some(stored) = self.read_stable_preparation_object(table_bucket, object).await? {
|
||||
if stored.data != data {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"backup preparation never replaces different existing object bytes".to_string(),
|
||||
));
|
||||
}
|
||||
(TableCatalogBackupObjectPreparationStatus::AlreadyPresent, stored)
|
||||
} else {
|
||||
let result = self
|
||||
.backend
|
||||
.put_object_fenced(table_bucket, object, data.clone(), TableCatalogPutPrecondition::IfAbsent, &fence)
|
||||
.await;
|
||||
fence.ensure_held()?;
|
||||
let saved = self.read_stable_preparation_object(table_bucket, object).await?;
|
||||
match saved {
|
||||
Some(saved) if saved.data == data => (
|
||||
if result.is_ok() {
|
||||
TableCatalogBackupObjectPreparationStatus::Prepared
|
||||
} else {
|
||||
TableCatalogBackupObjectPreparationStatus::AlreadyPresent
|
||||
},
|
||||
saved,
|
||||
),
|
||||
Some(_) => {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"backup preparation key is occupied by different object bytes".to_string(),
|
||||
));
|
||||
}
|
||||
None => {
|
||||
result?;
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"prepared object disappeared after its conditional write".to_string(),
|
||||
));
|
||||
}
|
||||
}
|
||||
};
|
||||
fence.ensure_held()?;
|
||||
self.finish_backup_object_preparation_gate(table_bucket, &gate).await?;
|
||||
let final_artifact = self.backend.object_metadata(self.catalog_bucket(), &backup_path).await?;
|
||||
if final_artifact.as_ref().and_then(|metadata| metadata.etag.as_deref()) != Some(artifact_etag) {
|
||||
return Err(TableCatalogStoreError::Unavailable(
|
||||
"catalog backup changed during object preparation".to_string(),
|
||||
));
|
||||
}
|
||||
fence.ensure_held()?;
|
||||
Ok(TableCatalogBackupObjectPreparationReport {
|
||||
table_bucket: table_bucket.to_string(),
|
||||
backup_id: backup_id.to_string(),
|
||||
object: object.to_string(),
|
||||
status,
|
||||
size_bytes: reference.size_bytes,
|
||||
sha256,
|
||||
etag: stored.etag,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
#[path = "object_backup_prepare_tests.rs"]
|
||||
mod tests;
|
||||
@@ -1,631 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use crate::table_catalog::test_support::TestCatalogObjectBackend;
|
||||
|
||||
const BUCKET: &str = "analytics";
|
||||
|
||||
fn original_fixture() -> ObjectCatalogBackup {
|
||||
serde_json::from_slice(include_bytes!(concat!(
|
||||
env!("CARGO_MANIFEST_DIR"),
|
||||
"/src/table_catalog/tests/fixtures/object-catalog-backup-v1.json"
|
||||
)))
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
fn preparation_reference(object: &str, kind: ObjectCatalogBackupReferenceKind, data: &[u8]) -> ObjectCatalogBackupReference {
|
||||
ObjectCatalogBackupReference {
|
||||
bucket: BUCKET.to_string(),
|
||||
object: object.to_string(),
|
||||
kind,
|
||||
size_bytes: u64::try_from(data.len()).unwrap(),
|
||||
etag: Some("original-source-etag".to_string()),
|
||||
sha256: Some(backup_sha256(data)),
|
||||
}
|
||||
}
|
||||
|
||||
fn reseal_preparation_fixture(backup: &mut ObjectCatalogBackup) {
|
||||
backup.version = 2;
|
||||
backup
|
||||
.objects
|
||||
.sort_by(|left, right| (&left.bucket, &left.object).cmp(&(&right.bucket, &right.object)));
|
||||
backup.source_catalog_etag = catalog_backup_fingerprint(&backup.objects).unwrap();
|
||||
let references = backup.references.as_mut().unwrap();
|
||||
references.sort_by(|left, right| (&left.bucket, &left.object).cmp(&(&right.bucket, &right.object)));
|
||||
backup.backup_id =
|
||||
catalog_backup_inventory_identity(&backup.table_bucket, &backup.source_catalog_etag, &backup.objects, references)
|
||||
.unwrap();
|
||||
}
|
||||
|
||||
fn preparation_fixture() -> ObjectCatalogBackup {
|
||||
let mut backup = original_fixture();
|
||||
backup.references = Some(
|
||||
backup
|
||||
.objects
|
||||
.iter()
|
||||
.filter(|object| object.bucket == BUCKET)
|
||||
.map(|object| preparation_reference(&object.object, ObjectCatalogBackupReferenceKind::TableMetadata, &object.data))
|
||||
.collect(),
|
||||
);
|
||||
reseal_preparation_fixture(&mut backup);
|
||||
backup
|
||||
}
|
||||
|
||||
fn current_payload(backup: &ObjectCatalogBackup) -> &ObjectCatalogBackupObject {
|
||||
backup.objects.iter().find(|object| object.bucket == BUCKET).unwrap()
|
||||
}
|
||||
|
||||
async fn save_preparation_fixture(backend: &TestCatalogObjectBackend, backup: &ObjectCatalogBackup) {
|
||||
backend
|
||||
.seed_object(
|
||||
RUSTFS_META_BUCKET,
|
||||
&TableCatalogObjectPaths::default().catalog_backup_path(BUCKET, &backup.backup_id),
|
||||
serde_json::to_vec(backup).unwrap(),
|
||||
)
|
||||
.await;
|
||||
}
|
||||
|
||||
async fn object_versions(backend: &TestCatalogObjectBackend) -> BTreeMap<(String, String), (Vec<u8>, String)> {
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.iter()
|
||||
.map(|(key, record)| (key.clone(), (record.data.clone(), record.etag.clone())))
|
||||
.collect()
|
||||
}
|
||||
|
||||
async fn system_versions(backend: &TestCatalogObjectBackend) -> BTreeMap<(String, String), (Vec<u8>, String)> {
|
||||
object_versions(backend)
|
||||
.await
|
||||
.into_iter()
|
||||
.filter(|((bucket, _), _)| bucket == RUSTFS_META_BUCKET)
|
||||
.collect()
|
||||
}
|
||||
|
||||
async fn pending_preparation_controls(
|
||||
backend: &TestCatalogObjectBackend,
|
||||
backup: &ObjectCatalogBackup,
|
||||
barrier_phase: ObjectCatalogRestoreStateKind,
|
||||
intent_phase: ObjectCatalogRestoreStateKind,
|
||||
) -> (String, String) {
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let restore_id = "prepare-recovery";
|
||||
let epoch = Uuid::new_v4().to_string();
|
||||
let fingerprint = restore_request_fingerprint(BUCKET, restore_id, &backup.backup_id, None, false).unwrap();
|
||||
let intent = ObjectCatalogRestoreIntent {
|
||||
version: OBJECT_CATALOG_RESTORE_STATE_VERSION,
|
||||
table_bucket: BUCKET.to_string(),
|
||||
restore_epoch: epoch.clone(),
|
||||
restore_id: restore_id.to_string(),
|
||||
backup_id: backup.backup_id.clone(),
|
||||
request_fingerprint: fingerprint.clone(),
|
||||
expected_catalog_etag: None,
|
||||
allow_replace: false,
|
||||
source_catalog_etag: backup.source_catalog_etag.clone(),
|
||||
state: intent_phase,
|
||||
previous_snapshot_etag: None,
|
||||
restored_snapshot_etag: backup.source_catalog_etag.clone(),
|
||||
object_count: backup.objects.len(),
|
||||
maintenance_object_count: 0,
|
||||
writes: backup
|
||||
.objects
|
||||
.iter()
|
||||
.map(|object| ObjectCatalogRestoreWrite {
|
||||
bucket: object.bucket.clone(),
|
||||
object: object.object.clone(),
|
||||
expected_etag: None,
|
||||
already_present: false,
|
||||
})
|
||||
.collect(),
|
||||
deletes: Vec::new(),
|
||||
created_at: "2026-10-31T00:00:00Z".to_string(),
|
||||
updated_at: "2026-10-31T00:00:00Z".to_string(),
|
||||
};
|
||||
let state = ObjectCatalogRestoreState {
|
||||
version: OBJECT_CATALOG_RESTORE_STATE_VERSION,
|
||||
table_bucket: BUCKET.to_string(),
|
||||
restore_epoch: epoch,
|
||||
restore_id: restore_id.to_string(),
|
||||
backup_id: backup.backup_id.clone(),
|
||||
request_fingerprint: fingerprint,
|
||||
state: barrier_phase,
|
||||
completed_intent_etag: None,
|
||||
backup_etag: None,
|
||||
};
|
||||
let intent_path = paths.catalog_restore_intent_path(BUCKET, restore_id);
|
||||
let state_path = paths.catalog_restore_state_path(BUCKET);
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &intent_path, serde_json::to_vec(&intent).unwrap())
|
||||
.await;
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &state_path, serde_json::to_vec(&state).unwrap())
|
||||
.await;
|
||||
(state_path, intent_path)
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_only_creates_the_referenced_payload_and_replays_without_rewriting_it() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let payload = current_payload(&backup);
|
||||
let prepared = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(matches!(prepared.status, TableCatalogBackupObjectPreparationStatus::Prepared));
|
||||
assert_eq!(prepared.size_bytes, payload.size_bytes);
|
||||
assert_eq!(prepared.sha256, payload.sha256);
|
||||
assert_ne!(prepared.etag, backup.references.as_ref().unwrap()[0].etag);
|
||||
let after = object_versions(&backend).await;
|
||||
assert_eq!(after.len(), before.len() + 1);
|
||||
assert_eq!(system_versions(&backend).await, before);
|
||||
let retried = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(matches!(retried.status, TableCatalogBackupObjectPreparationStatus::AlreadyPresent));
|
||||
assert_eq!(retried.etag, prepared.etag);
|
||||
assert_eq!(object_versions(&backend).await, after);
|
||||
assert_eq!(
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.put_attempts
|
||||
.get(&(BUCKET.to_string(), payload.object.clone())),
|
||||
Some(&1)
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_accepts_identical_existing_bytes_with_a_different_target_etag() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
backend.seed_object(BUCKET, &payload.object, payload.data.clone()).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let report = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(matches!(report.status, TableCatalogBackupObjectPreparationStatus::AlreadyPresent));
|
||||
assert_ne!(report.etag, backup.references.as_ref().unwrap()[0].etag);
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_never_overwrites_unknown_existing_bytes() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
backend
|
||||
.seed_object(BUCKET, &payload.object, b"unknown-existing-metadata".to_vec())
|
||||
.await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(matches!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_rejects_an_existing_object_without_a_stable_etag() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
backend.seed_object(BUCKET, &payload.object, payload.data.clone()).await;
|
||||
backend.omit_etag_for_object(BUCKET, &payload.object).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(matches!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_rejects_an_existing_object_that_changes_during_comparison() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
backend.seed_object(BUCKET, &payload.object, payload.data.clone()).await;
|
||||
let before = system_versions(&backend).await;
|
||||
let pause = backend.pause_next_read(BUCKET, &payload.object).await;
|
||||
let task_backend = backend.clone();
|
||||
let backup_id = backup.backup_id.clone();
|
||||
let object = payload.object.clone();
|
||||
let bytes = payload.data.clone();
|
||||
let task = tokio::spawn(async move {
|
||||
ObjectTableCatalogStore::new(task_backend)
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup_id, &object, bytes)
|
||||
.await
|
||||
});
|
||||
tokio::time::timeout(std::time::Duration::from_secs(5), pause.wait_started())
|
||||
.await
|
||||
.unwrap();
|
||||
backend.seed_object(BUCKET, &payload.object, payload.data.clone()).await;
|
||||
pause.release();
|
||||
let result = tokio::time::timeout(std::time::Duration::from_secs(5), task)
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
assert!(matches!(result, Err(TableCatalogStoreError::Conflict(_))));
|
||||
assert_eq!(system_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_confirms_an_ambiguous_put_without_repeating_the_write() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = system_versions(&backend).await;
|
||||
backend.fail_after_next_put(BUCKET, &payload.object).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let report = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(matches!(report.status, TableCatalogBackupObjectPreparationStatus::AlreadyPresent));
|
||||
let first = object_versions(&backend).await;
|
||||
let retry = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(retry.etag, report.etag);
|
||||
assert_eq!(system_versions(&backend).await, before);
|
||||
assert_eq!(object_versions(&backend).await, first);
|
||||
assert_eq!(
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.put_attempts
|
||||
.get(&(BUCKET.to_string(), payload.object.clone())),
|
||||
Some(&1)
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_failure_before_put_has_no_effects_and_can_be_retried() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = object_versions(&backend).await;
|
||||
backend.fail_next_put(BUCKET, &payload.object).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
let retry = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(matches!(retry.status, TableCatalogBackupObjectPreparationStatus::Prepared));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_rejects_bad_bodies_unlisted_keys_and_system_bucket_without_writes() {
|
||||
let backup = preparation_fixture();
|
||||
let payload = current_payload(&backup);
|
||||
let mut corrupt = payload.data.clone();
|
||||
corrupt[0] ^= 1;
|
||||
for (bucket, object, data) in [
|
||||
(BUCKET, payload.object.as_str(), corrupt),
|
||||
(BUCKET, payload.object.as_str(), vec![0; OBJECT_CATALOG_BACKUP_OBJECT_MAX_SIZE + 1]),
|
||||
(BUCKET, "tables/table-id/data/unlisted.parquet", vec![1]),
|
||||
(BUCKET, "../outside", vec![1]),
|
||||
(RUSTFS_META_BUCKET, payload.object.as_str(), payload.data.clone()),
|
||||
] {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(bucket, &backup.backup_id, object, data)
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn inventory_membership_does_not_authorize_an_unowned_or_wrong_kind_key() {
|
||||
for (object, kind) in [
|
||||
("unowned/data/object.parquet", ObjectCatalogBackupReferenceKind::DataFile),
|
||||
("tables/table-id/data/wrong-role.parquet", ObjectCatalogBackupReferenceKind::ManifestFile),
|
||||
] {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let mut backup = preparation_fixture();
|
||||
backup
|
||||
.references
|
||||
.as_mut()
|
||||
.unwrap()
|
||||
.push(preparation_reference(object, kind, b"x"));
|
||||
reseal_preparation_fixture(&mut backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, object, b"x".to_vec())
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn same_backup_preparation_preserves_a_pending_restore_barrier_and_plan() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
pending_preparation_controls(
|
||||
&backend,
|
||||
&backup,
|
||||
ObjectCatalogRestoreStateKind::Applying,
|
||||
ObjectCatalogRestoreStateKind::Prepared,
|
||||
)
|
||||
.await;
|
||||
let before = system_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let payload = current_payload(&backup);
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(system_versions(&backend).await, before);
|
||||
assert!(matches!(
|
||||
store.ensure_no_active_restore(BUCKET).await,
|
||||
Err(TableCatalogStoreError::Unavailable(_))
|
||||
));
|
||||
store
|
||||
.restore_object_catalog_backup_with_id(BUCKET, &backup.backup_id, None, false, Some("prepare-recovery"))
|
||||
.await
|
||||
.unwrap();
|
||||
store.ensure_no_active_restore(BUCKET).await.unwrap();
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_after_completed_restore_repairs_only_the_missing_payload() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let payload = current_payload(&backup);
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
store
|
||||
.restore_object_catalog_backup_with_id(BUCKET, &backup.backup_id, None, false, Some("completed-prepare"))
|
||||
.await
|
||||
.unwrap();
|
||||
store.ensure_no_active_restore(BUCKET).await.unwrap();
|
||||
let before = system_versions(&backend).await;
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.objects
|
||||
.remove(&(BUCKET.to_string(), payload.object.clone()));
|
||||
let report = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
assert!(matches!(report.status, TableCatalogBackupObjectPreparationStatus::Prepared));
|
||||
assert_eq!(system_versions(&backend).await, before);
|
||||
store.ensure_no_active_restore(BUCKET).await.unwrap();
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn view_metadata_preparation_requires_the_active_view_identity() {
|
||||
for valid_identity in [true, false] {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let mut backup = preparation_fixture();
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let view = IdentifierSegment::parse("summary").unwrap();
|
||||
let path = default_view_metadata_file_path(&namespace, &view, "00001.metadata.json");
|
||||
let entry = ViewEntry {
|
||||
version: TABLE_CATALOG_ENTRY_VERSION,
|
||||
table_bucket: BUCKET.to_string(),
|
||||
namespace: namespace.public_name(),
|
||||
view: view.as_str().to_string(),
|
||||
view_id: "view-id".to_string(),
|
||||
view_uuid: "view-uuid".to_string(),
|
||||
format: "ICEBERG_VIEW".to_string(),
|
||||
format_version: 1,
|
||||
warehouse_location: "s3://analytics/views/view-id".to_string(),
|
||||
metadata_location: path.clone(),
|
||||
version_token: "view-token".to_string(),
|
||||
generation: 1,
|
||||
state: TableCatalogEntryState::Active,
|
||||
properties: BTreeMap::new(),
|
||||
created_at: None,
|
||||
updated_at: None,
|
||||
};
|
||||
let entry_data = serde_json::to_vec(&entry).unwrap();
|
||||
backup.objects.push(ObjectCatalogBackupObject {
|
||||
bucket: RUSTFS_META_BUCKET.to_string(),
|
||||
object: TableCatalogObjectPaths::default().view_entry_path(BUCKET, &namespace, &view),
|
||||
size_bytes: u64::try_from(entry_data.len()).unwrap(),
|
||||
etag: Some("source-view-entry-etag".to_string()),
|
||||
sha256: backup_sha256(&entry_data),
|
||||
data: entry_data,
|
||||
});
|
||||
let metadata = serde_json::json!({
|
||||
"format-version": 1, "view-uuid": if valid_identity { "view-uuid" } else { "foreign-view" },
|
||||
"location": "s3://analytics/views/view-id", "current-schema-id": 0, "current-version-id": 1,
|
||||
"schemas": [{"type": "struct", "schema-id": 0, "fields": [{"id": 1, "name": "id", "required": true, "type": "long"}]}],
|
||||
"versions": [{"version-id": 1, "timestamp-ms": 1, "schema-id": 0, "summary": {},
|
||||
"representations": [{"type": "sql", "sql": "SELECT 1", "dialect": "spark"}], "default-namespace": ["sales"]}],
|
||||
"version-log": [{"timestamp-ms": 1, "version-id": 1}], "properties": {}
|
||||
});
|
||||
let data = serde_json::to_vec(&metadata).unwrap();
|
||||
backup.references.as_mut().unwrap().push(preparation_reference(
|
||||
&path,
|
||||
ObjectCatalogBackupReferenceKind::ViewMetadata,
|
||||
&data,
|
||||
));
|
||||
reseal_preparation_fixture(&mut backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let result = store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &path, data)
|
||||
.await;
|
||||
if valid_identity {
|
||||
assert!(result.is_ok());
|
||||
assert_eq!(system_versions(&backend).await, before);
|
||||
} else {
|
||||
assert!(matches!(result, Err(TableCatalogStoreError::Invalid(_))));
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn pending_wrong_backup_epoch_request_or_plan_cannot_prepare_an_object() {
|
||||
for case in 0..4 {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = preparation_fixture();
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let (state_path, intent_path) = pending_preparation_controls(
|
||||
&backend,
|
||||
&backup,
|
||||
ObjectCatalogRestoreStateKind::Applying,
|
||||
ObjectCatalogRestoreStateKind::Prepared,
|
||||
)
|
||||
.await;
|
||||
let path = if case == 3 { &intent_path } else { &state_path };
|
||||
let bytes = backend.read_object(RUSTFS_META_BUCKET, path).await.unwrap().unwrap().data;
|
||||
let mut value: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
|
||||
match case {
|
||||
0 => value["backup_id"] = serde_json::json!("another-backup"),
|
||||
1 => value["restore_epoch"] = serde_json::json!(Uuid::new_v4().to_string()),
|
||||
2 => value["request_fingerprint"] = serde_json::json!("0".repeat(64)),
|
||||
_ => {
|
||||
value["writes"].as_array_mut().unwrap().pop();
|
||||
}
|
||||
}
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, path, serde_json::to_vec(&value).unwrap())
|
||||
.await;
|
||||
let before = object_versions(&backend).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let payload = current_payload(&backup);
|
||||
assert!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await
|
||||
.is_err()
|
||||
);
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
assert!(backend.state.lock().await.put_attempts.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn preparation_requires_prepared_history_before_using_its_different_warehouse_scope() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let mut backup = preparation_fixture();
|
||||
let current_index = backup.objects.iter().position(|object| object.bucket == BUCKET).unwrap();
|
||||
let current = backup.objects[current_index].object.clone();
|
||||
let history = current.replace("00001.metadata.json", "00000.metadata.json");
|
||||
let mut metadata: serde_json::Value = serde_json::from_slice(&backup.objects[current_index].data).unwrap();
|
||||
let mut historical = metadata.clone();
|
||||
historical["location"] = serde_json::json!("s3://analytics/archive/table-id");
|
||||
let historical = serde_json::to_vec(&historical).unwrap();
|
||||
metadata["metadata-log"] = serde_json::json!([{"timestamp-ms": 0, "metadata-file": format!("s3://{BUCKET}/{history}")}]);
|
||||
let current_data = serde_json::to_vec(&metadata).unwrap();
|
||||
backup.objects[current_index].data = current_data.clone();
|
||||
backup.objects[current_index].size_bytes = u64::try_from(current_data.len()).unwrap();
|
||||
backup.objects[current_index].sha256 = backup_sha256(¤t_data);
|
||||
let old_data = "archive/table-id/data/part.parquet";
|
||||
backup.references = Some(vec![
|
||||
preparation_reference(¤t, ObjectCatalogBackupReferenceKind::TableMetadata, ¤t_data),
|
||||
preparation_reference(&history, ObjectCatalogBackupReferenceKind::TableMetadata, &historical),
|
||||
preparation_reference(old_data, ObjectCatalogBackupReferenceKind::DataFile, b"x"),
|
||||
]);
|
||||
reseal_preparation_fixture(&mut backup);
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let before = object_versions(&backend).await;
|
||||
assert!(matches!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, old_data, b"x".to_vec())
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Unavailable(_))
|
||||
));
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &history, historical)
|
||||
.await
|
||||
.unwrap();
|
||||
let controls = system_versions(&backend).await;
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, old_data, b"x".to_vec())
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(system_versions(&backend).await, controls);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn v1_artifact_does_not_gain_an_implicit_object_preparation_capability() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let backup = original_fixture();
|
||||
save_preparation_fixture(&backend, &backup).await;
|
||||
let before = object_versions(&backend).await;
|
||||
let payload = current_payload(&backup);
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
assert!(matches!(
|
||||
store
|
||||
.prepare_object_catalog_backup_object(BUCKET, &backup.backup_id, &payload.object, payload.data.clone())
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Unsupported(_))
|
||||
));
|
||||
assert_eq!(object_versions(&backend).await, before);
|
||||
}
|
||||
@@ -1,129 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
|
||||
impl<B> ObjectTableCatalogStore<B>
|
||||
where
|
||||
B: TableCatalogObjectBackend,
|
||||
{
|
||||
/// Returns the saved v1 artifact bytes without reencoding or applying them.
|
||||
///
|
||||
/// This does not export external manifest/data/delete files. Pending restore
|
||||
/// or legacy control state is rejected; cancellation leaves catalog state unchanged.
|
||||
pub(crate) async fn export_object_catalog_backup(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
backup_id: &str,
|
||||
) -> TableCatalogStoreResult<Vec<u8>> {
|
||||
let guards = self.acquire_object_backup_fence(table_bucket).await?;
|
||||
let fence = Self::object_backup_mutation_fence(&guards);
|
||||
fence.ensure_held()?;
|
||||
self.ensure_no_active_restore(table_bucket).await?;
|
||||
let path = self.paths.catalog_backup_path(table_bucket, backup_id);
|
||||
let artifact = self
|
||||
.backend
|
||||
.read_object_limited(self.catalog_bucket(), &path, OBJECT_CATALOG_BACKUP_MAX_SIZE)
|
||||
.await?
|
||||
.ok_or_else(|| TableCatalogStoreError::NotFound(format!("catalog backup {backup_id}")))?;
|
||||
let backup = self.decode_object_catalog_backup(table_bucket, &artifact.data)?;
|
||||
if backup.backup_id != backup_id {
|
||||
return Err(TableCatalogStoreError::Invalid(
|
||||
"catalog backup identity does not match its request".to_string(),
|
||||
));
|
||||
}
|
||||
let _validated_tables = self.validate_catalog_backup_metadata_identities(table_bucket, &backup.objects)?;
|
||||
fence.ensure_held()?;
|
||||
Ok(artifact.data)
|
||||
}
|
||||
|
||||
/// Persists one validated versioned artifact without publishing catalog or metadata objects.
|
||||
///
|
||||
/// Only the artifact key is conditionally created. Exact retries keep its bytes,
|
||||
/// ETag and original creation timestamp; conflicting content is never replaced.
|
||||
/// A response lost after storage can be retried to confirm the saved artifact.
|
||||
/// Referenced objects must be prepared and validated separately before restore.
|
||||
pub(crate) async fn import_object_catalog_backup(
|
||||
&self,
|
||||
table_bucket: &str,
|
||||
data: Vec<u8>,
|
||||
) -> TableCatalogStoreResult<TableCatalogBackupReport> {
|
||||
let backup = self.decode_object_catalog_backup(table_bucket, &data)?;
|
||||
let _validated_tables = self.validate_catalog_backup_metadata_identities(table_bucket, &backup.objects)?;
|
||||
let (verified_object_count, verified_bytes) = catalog_backup_verification_totals(&backup)?;
|
||||
let path = self.paths.catalog_backup_path(table_bucket, &backup.backup_id);
|
||||
let guards = self.acquire_object_backup_fence(table_bucket).await?;
|
||||
let fence = Self::object_backup_mutation_fence(&guards);
|
||||
fence.ensure_held()?;
|
||||
self.ensure_no_active_restore(table_bucket).await?;
|
||||
|
||||
let existing = self
|
||||
.backend
|
||||
.read_object_limited(self.catalog_bucket(), &path, OBJECT_CATALOG_BACKUP_MAX_SIZE)
|
||||
.await?;
|
||||
let status = if let Some(existing) = existing {
|
||||
if existing.data != data {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup identity is already occupied by different bytes".to_string(),
|
||||
));
|
||||
}
|
||||
TableCatalogBackupStatus::AlreadyPresent
|
||||
} else {
|
||||
let result = self
|
||||
.backend
|
||||
.put_object_fenced(self.catalog_bucket(), &path, data.clone(), TableCatalogPutPrecondition::IfAbsent, &fence)
|
||||
.await;
|
||||
fence.ensure_held()?;
|
||||
let saved = self
|
||||
.backend
|
||||
.read_object_limited(self.catalog_bucket(), &path, OBJECT_CATALOG_BACKUP_MAX_SIZE)
|
||||
.await?;
|
||||
match saved {
|
||||
Some(saved) if saved.data == data => {
|
||||
if result.is_ok() {
|
||||
TableCatalogBackupStatus::Created
|
||||
} else {
|
||||
// The read proves an ambiguous write or identical concurrent
|
||||
// import completed; it does not authorize another put.
|
||||
TableCatalogBackupStatus::AlreadyPresent
|
||||
}
|
||||
}
|
||||
Some(_) => {
|
||||
return Err(TableCatalogStoreError::Conflict(
|
||||
"catalog backup identity is already occupied by different bytes".to_string(),
|
||||
));
|
||||
}
|
||||
None => {
|
||||
result?;
|
||||
return Err(TableCatalogStoreError::Unavailable("catalog backup disappeared after import".to_string()));
|
||||
}
|
||||
}
|
||||
};
|
||||
fence.ensure_held()?;
|
||||
Ok(TableCatalogBackupReport {
|
||||
table_bucket: table_bucket.to_string(),
|
||||
backup_id: backup.backup_id,
|
||||
status,
|
||||
backup_path: path,
|
||||
source_snapshot_etag: backup.source_catalog_etag.clone(),
|
||||
source_snapshot_version: backup.version,
|
||||
catalog_fingerprint: backup.source_catalog_etag,
|
||||
object_count: backup.objects.len(),
|
||||
verified_object_count,
|
||||
verified_bytes,
|
||||
maintenance_object_count: self.backup_maintenance_object_count(table_bucket, &backup.objects),
|
||||
created_at: backup.created_at,
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -1,217 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use crate::table_catalog::test_support::TestCatalogObjectBackend;
|
||||
|
||||
async fn inventory_backup_fixture() -> ObjectCatalogBackup {
|
||||
let mut backup: ObjectCatalogBackup =
|
||||
serde_json::from_slice(include_bytes!("../tests/fixtures/object-catalog-backup-v1.json"))
|
||||
.expect("captured historical v1 artifact");
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
for object in &backup.objects {
|
||||
backend.seed_object(&object.bucket, &object.object, object.data.clone()).await;
|
||||
}
|
||||
let store = ObjectTableCatalogStore::new(backend);
|
||||
backup.references = Some(
|
||||
store
|
||||
.capture_object_catalog_backup_references(&backup.table_bucket, &backup.objects)
|
||||
.await
|
||||
.expect("valid source reference graph"),
|
||||
);
|
||||
backup.version = OBJECT_CATALOG_BACKUP_INVENTORY_VERSION;
|
||||
reseal_inventory_backup(&mut backup);
|
||||
backup
|
||||
}
|
||||
|
||||
fn reseal_inventory_backup(backup: &mut ObjectCatalogBackup) {
|
||||
backup.backup_id = catalog_backup_inventory_identity(
|
||||
&backup.table_bucket,
|
||||
&backup.source_catalog_etag,
|
||||
&backup.objects,
|
||||
backup.references.as_deref().expect("v2 inventory"),
|
||||
)
|
||||
.expect("inventory identity");
|
||||
}
|
||||
|
||||
fn fixture_table(backup: &ObjectCatalogBackup) -> TableEntry {
|
||||
serde_json::from_slice(
|
||||
&backup
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.object.ends_with(TABLE_ENTRY_FILE))
|
||||
.expect("fixture table entry")
|
||||
.data,
|
||||
)
|
||||
.expect("fixture table identity")
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn version_two_raw_transfer_and_inline_metadata_restore_preserve_the_iceberg_identity() {
|
||||
let backup = inventory_backup_fixture().await;
|
||||
let entry = fixture_table(&backup);
|
||||
let bytes = serde_json::to_vec_pretty(&backup).expect("versioned artifact bytes");
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let imported = store
|
||||
.import_object_catalog_backup(&backup.table_bucket, bytes.clone())
|
||||
.await
|
||||
.expect("import candidate");
|
||||
assert_eq!(imported.source_snapshot_version, 2);
|
||||
assert_eq!(imported.verified_object_count, backup.references.as_ref().expect("references").len());
|
||||
assert_eq!(
|
||||
store
|
||||
.export_object_catalog_backup(&backup.table_bucket, &backup.backup_id)
|
||||
.await
|
||||
.expect("raw export"),
|
||||
bytes
|
||||
);
|
||||
assert!(
|
||||
store
|
||||
.get_table_bucket(&backup.table_bucket)
|
||||
.await
|
||||
.expect("no publication during transfer")
|
||||
.is_none()
|
||||
);
|
||||
let metadata_key =
|
||||
table_catalog_object_key_from_location(&entry.table_bucket, &entry.metadata_location).expect("metadata key");
|
||||
assert!(
|
||||
!backend
|
||||
.object_exists(&entry.table_bucket, &metadata_key)
|
||||
.await
|
||||
.expect("metadata initially absent")
|
||||
);
|
||||
store
|
||||
.restore_object_catalog_backup_with_id(&backup.table_bucket, &backup.backup_id, None, false, Some("inventory-v2"))
|
||||
.await
|
||||
.expect("restore can publish its validated inline metadata without a separate prepare request");
|
||||
assert_eq!(
|
||||
store
|
||||
.load_table(&entry.table_bucket, &entry.namespace, &entry.table)
|
||||
.await
|
||||
.expect("load restored table"),
|
||||
Some(entry)
|
||||
);
|
||||
let payload = backup
|
||||
.objects
|
||||
.iter()
|
||||
.find(|object| object.bucket == backup.table_bucket && object.object == metadata_key)
|
||||
.expect("inline metadata payload");
|
||||
assert_eq!(
|
||||
backend
|
||||
.read_object(&payload.bucket, &payload.object)
|
||||
.await
|
||||
.expect("read immutable restored metadata")
|
||||
.expect("restored metadata")
|
||||
.data,
|
||||
payload.data
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_versions_require_their_exact_inventory_shape_before_any_backend_access() {
|
||||
let backup = inventory_backup_fixture().await;
|
||||
for mode in [
|
||||
"v1-with-inventory",
|
||||
"v2-without-inventory",
|
||||
"null-inventory",
|
||||
"unknown-version",
|
||||
] {
|
||||
let mut value = serde_json::to_value(&backup).expect("artifact JSON");
|
||||
match mode {
|
||||
"v1-with-inventory" => value["version"] = serde_json::json!(1),
|
||||
"v2-without-inventory" => {
|
||||
value.as_object_mut().expect("object").remove("references");
|
||||
}
|
||||
"null-inventory" => value["references"] = serde_json::Value::Null,
|
||||
"unknown-version" => value["version"] = serde_json::json!(99),
|
||||
_ => unreachable!("fixed test case"),
|
||||
}
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let error = store
|
||||
.import_object_catalog_backup(&backup.table_bucket, serde_json::to_vec(&value).expect("test body"))
|
||||
.await
|
||||
.expect_err("unsupported shape cannot be persisted");
|
||||
assert!(matches!(error, TableCatalogStoreError::Invalid(_)), "{mode}: {error:?}");
|
||||
let state = backend.state.lock().await;
|
||||
assert!(state.objects.is_empty(), "{mode}");
|
||||
assert!(state.put_attempts.is_empty(), "{mode}");
|
||||
assert!(state.delete_attempts.is_empty(), "{mode}");
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_self_consistent_candidate_with_an_extra_reference_cannot_publish_a_catalog() {
|
||||
let mut backup = inventory_backup_fixture().await;
|
||||
let entry = fixture_table(&backup);
|
||||
let references = backup.references.as_mut().expect("inventory");
|
||||
references.push(ObjectCatalogBackupReference {
|
||||
bucket: backup.table_bucket.clone(),
|
||||
object: format!("{}unreachable.parquet", table_warehouse_object_prefix(&entry).expect("warehouse prefix")),
|
||||
kind: ObjectCatalogBackupReferenceKind::DataFile,
|
||||
size_bytes: 1,
|
||||
etag: Some("source-version".to_string()),
|
||||
sha256: Some(backup_sha256(&[1])),
|
||||
});
|
||||
references.sort_by(|left, right| left.bucket.cmp(&right.bucket).then_with(|| left.object.cmp(&right.object)));
|
||||
reseal_inventory_backup(&mut backup);
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
store
|
||||
.import_object_catalog_backup(&backup.table_bucket, serde_json::to_vec(&backup).expect("candidate"))
|
||||
.await
|
||||
.expect("raw transfer may preserve a candidate before its external graph is prepared");
|
||||
let (before_objects, before_puts, before_deletes) = {
|
||||
let state = backend.state.lock().await;
|
||||
(state.objects.clone(), state.put_attempts.clone(), state.delete_attempts.clone())
|
||||
};
|
||||
let error = store
|
||||
.restore_object_catalog_backup_with_id(&backup.table_bucket, &backup.backup_id, None, false, Some("extra-reference"))
|
||||
.await
|
||||
.expect_err("a forged graph must not be published");
|
||||
assert!(matches!(error, TableCatalogStoreError::Conflict(message) if message.contains("reference graph")));
|
||||
let state = backend.state.lock().await;
|
||||
assert_eq!(state.objects.len(), 1, "only the previously imported artifact may exist");
|
||||
assert_eq!(state.objects, before_objects, "rejected restore changed persisted objects");
|
||||
assert_eq!(state.put_attempts, before_puts, "rejected restore attempted a write");
|
||||
assert_eq!(state.delete_attempts, before_deletes, "rejected restore attempted a deletion");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn declared_reference_byte_overflow_is_rejected_before_saving_the_artifact() {
|
||||
let mut backup = inventory_backup_fixture().await;
|
||||
let entry = fixture_table(&backup);
|
||||
let references = backup.references.as_mut().expect("inventory");
|
||||
references.push(ObjectCatalogBackupReference {
|
||||
bucket: backup.table_bucket.clone(),
|
||||
object: format!("{}oversized.parquet", table_warehouse_object_prefix(&entry).expect("warehouse prefix")),
|
||||
kind: ObjectCatalogBackupReferenceKind::DataFile,
|
||||
size_bytes: u64::MAX,
|
||||
etag: Some("large-source-version".to_string()),
|
||||
sha256: None,
|
||||
});
|
||||
references.sort_by(|left, right| left.bucket.cmp(&right.bucket).then_with(|| left.object.cmp(&right.object)));
|
||||
reseal_inventory_backup(&mut backup);
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let error = store
|
||||
.import_object_catalog_backup(&backup.table_bucket, serde_json::to_vec(&backup).expect("overflow body"))
|
||||
.await
|
||||
.expect_err("overflow cannot leave an artifact stored before reporting failure");
|
||||
assert!(matches!(error, TableCatalogStoreError::Invalid(message) if message.contains("byte total overflows")));
|
||||
let state = backend.state.lock().await;
|
||||
assert!(state.objects.is_empty());
|
||||
assert!(state.put_attempts.is_empty());
|
||||
}
|
||||
@@ -72,9 +72,13 @@ async fn publication_deadline_registration_inventory_releases_fence_without_writ
|
||||
.unwrap();
|
||||
}
|
||||
|
||||
async fn commit_fixture() -> (TestCatalogObjectBackend, Arc<dyn TableCatalogStore>, TableCommitRequest) {
|
||||
async fn commit_fixture(strong: bool) -> (TestCatalogObjectBackend, Arc<dyn TableCatalogStore>, TableCommitRequest) {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store: Arc<dyn TableCatalogStore> = Arc::new(ObjectTableCatalogStore::new(backend.clone()));
|
||||
let store: Arc<dyn TableCatalogStore> = if strong {
|
||||
Arc::new(StrongTableCatalogStore::new(backend.clone()))
|
||||
} else {
|
||||
Arc::new(ObjectTableCatalogStore::new(backend.clone()))
|
||||
};
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let table = IdentifierSegment::parse("orders").unwrap();
|
||||
let current = default_table_metadata_file_path(&namespace, &table, "00001.metadata.json");
|
||||
@@ -112,7 +116,7 @@ async fn commit_fixture() -> (TestCatalogObjectBackend, Arc<dyn TableCatalogStor
|
||||
// so only the object backing is exercised here.
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn publication_deadline_commit_metadata_read_does_not_publish_object_backing() {
|
||||
let (backend, store, request) = commit_fixture().await;
|
||||
let (backend, store, request) = commit_fixture(false).await;
|
||||
let pause = backend
|
||||
.pause_before_next_read("analytics", &request.new_metadata_location)
|
||||
.await;
|
||||
@@ -155,24 +159,30 @@ async fn publication_deadline_commit_metadata_read_does_not_publish_object_backi
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn publication_deadline_create_finishes_after_first_write_on_object_backing() {
|
||||
let (backend, store, _) = commit_fixture().await;
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let candidate = registration_entry(&namespace, "candidate");
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let first_write = paths.warehouse_index_entry_path("analytics", "tables/id-candidate/");
|
||||
let pause = backend.pause_next_put(RUSTFS_META_BUCKET, &first_write).await;
|
||||
let creating = {
|
||||
let store = store.clone();
|
||||
tokio::spawn(async move { store.create_table(candidate).await })
|
||||
};
|
||||
pause.wait_started().await;
|
||||
tokio::time::advance(publication_preparation_timeout() + StdDuration::from_millis(1)).await;
|
||||
tokio::task::yield_now().await;
|
||||
assert!(!creating.is_finished(), "deadline must not cancel a possible durable write");
|
||||
pause.release();
|
||||
creating.await.unwrap().unwrap();
|
||||
assert!(store.load_table("analytics", "sales", "candidate").await.unwrap().is_some());
|
||||
async fn publication_deadline_create_finishes_after_first_write_on_either_backing() {
|
||||
for strong in [false, true] {
|
||||
let (backend, store, _) = commit_fixture(strong).await;
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let candidate = registration_entry(&namespace, "candidate");
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let first_write = if strong {
|
||||
StrongTableCatalogStore::<TestCatalogObjectBackend>::snapshot_object_path()
|
||||
} else {
|
||||
paths.warehouse_index_entry_path("analytics", "tables/id-candidate/")
|
||||
};
|
||||
let pause = backend.pause_next_put(RUSTFS_META_BUCKET, &first_write).await;
|
||||
let creating = {
|
||||
let store = store.clone();
|
||||
tokio::spawn(async move { store.create_table(candidate).await })
|
||||
};
|
||||
pause.wait_started().await;
|
||||
tokio::time::advance(publication_preparation_timeout() + StdDuration::from_millis(1)).await;
|
||||
tokio::task::yield_now().await;
|
||||
assert!(!creating.is_finished(), "deadline must not cancel a possible durable write");
|
||||
pause.release();
|
||||
creating.await.unwrap().unwrap();
|
||||
assert!(store.load_table("analytics", "sales", "candidate").await.unwrap().is_some());
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test(start_paused = true)]
|
||||
@@ -231,7 +241,7 @@ async fn publication_deadline_completed_recovery_cannot_exempt_a_new_transaction
|
||||
// so only the object backing is exercised here.
|
||||
#[tokio::test(start_paused = true)]
|
||||
async fn publication_deadline_create_queue_wait_cannot_restart_after_admission() {
|
||||
let (backend, store, _) = commit_fixture().await;
|
||||
let (backend, store, _) = commit_fixture(false).await;
|
||||
let key = default_table_bucket_publication_lock_path();
|
||||
let blocker = backend.acquire_read_lock("analytics", &key).await.unwrap();
|
||||
let attempts = backend.write_lock_acquisition_count("analytics", &key).await;
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -410,8 +410,8 @@ pub(crate) fn manifest_avro_bytes_with_entry_sequences(files: &[ManifestEntryWit
|
||||
pub(crate) struct TestCatalogObjectBackend {
|
||||
pub(crate) state: Arc<tokio::sync::Mutex<TestCatalogObjectState>>,
|
||||
pub(crate) locks: TestCatalogObjectLocks,
|
||||
pub(crate) strong_runtime: Option<StrongTableCatalogRuntime>,
|
||||
pub(crate) registration_cache: TableCatalogRegistrationCache,
|
||||
pub(crate) cleanup_publication: Option<Arc<TestCatalogCleanupPublication>>,
|
||||
// One-shot, path-keyed injection knobs from the admin handler tests'
|
||||
// former TestTableCatalogObjectBackend (backlog#1837 PR2): each fires
|
||||
// once for the named object and clears itself, mirroring the original
|
||||
@@ -425,7 +425,6 @@ pub(crate) struct TestCatalogObjectBackend {
|
||||
pub(crate) fail_write_lock_path: Arc<tokio::sync::Mutex<Option<(String, TableCatalogStoreError)>>>,
|
||||
pub(crate) lock_attempts: Arc<tokio::sync::Mutex<Vec<(String, String)>>>,
|
||||
pub(crate) reject_reads_while_write_locked: bool,
|
||||
pub(crate) serialize_object_reads: bool,
|
||||
/// Content-addressed (sha256) etags instead of the store fake's counter.
|
||||
/// The admin handler tests observe an object's etag and expect rewriting
|
||||
/// identical bytes to reproduce it, so their fixtures set this.
|
||||
@@ -452,6 +451,79 @@ impl TestCatalogObjectPause {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone)]
|
||||
pub(crate) struct BlockingObjectPublication {
|
||||
backend: TestCatalogObjectBackend,
|
||||
object: String,
|
||||
started: Arc<tokio::sync::Notify>,
|
||||
guard: Arc<parking_lot::Mutex<Option<TableCatalogLockGuard>>>,
|
||||
}
|
||||
|
||||
impl BlockingObjectPublication {
|
||||
pub(crate) fn new(backend: TestCatalogObjectBackend, object: impl Into<String>) -> Self {
|
||||
Self {
|
||||
backend,
|
||||
object: object.into(),
|
||||
started: Arc::new(tokio::sync::Notify::new()),
|
||||
guard: Arc::new(parking_lot::Mutex::new(None)),
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) async fn wait_started(&self) {
|
||||
self.started.notified().await;
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
pub(crate) struct UnserializedTestPublication;
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl TableCommitPublication for UnserializedTestPublication {
|
||||
async fn begin_table_bucket(&self, _table_bucket: &str) -> TableCatalogStoreResult<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn prepare(&self, _table_bucket: &str, _namespace: &str, _table: &str) -> TableCatalogStoreResult<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn holds_table_bucket(&self, _table_bucket: &str) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn holds_table(&self, _table_bucket: &str, _namespace: &str, _table: &str) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn complete(&self) {}
|
||||
}
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl TableCommitPublication for BlockingObjectPublication {
|
||||
async fn begin_table_bucket(&self, _table_bucket: &str) -> TableCatalogStoreResult<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn prepare(&self, table_bucket: &str, _namespace: &str, _table: &str) -> TableCatalogStoreResult<()> {
|
||||
self.started.notify_one();
|
||||
let guard = self.backend.acquire_read_lock(table_bucket, &self.object).await?;
|
||||
*self.guard.lock() = Some(guard);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn holds_table_bucket(&self, _table_bucket: &str) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
fn holds_table(&self, _table_bucket: &str, _namespace: &str, _table: &str) -> bool {
|
||||
self.guard.lock().is_some()
|
||||
}
|
||||
|
||||
fn complete(&self) {
|
||||
drop(self.guard.lock().take());
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
pub(crate) struct TestCatalogWorkerContext {
|
||||
pub(crate) access_key: Option<String>,
|
||||
@@ -469,8 +541,6 @@ pub(crate) struct TestCatalogObjectState {
|
||||
pub(crate) pause_read_attempts: BTreeMap<(String, String), BTreeMap<usize, TestCatalogObjectPause>>,
|
||||
pub(crate) read_attempts: BTreeMap<(String, String), usize>,
|
||||
pub(crate) read_limits: Vec<((String, String), usize)>,
|
||||
pub(crate) list_page_overrides: BTreeMap<(String, String), std::collections::VecDeque<TableCatalogObjectListPage>>,
|
||||
pub(crate) list_page_pauses: BTreeMap<(String, String), std::collections::VecDeque<TestCatalogObjectPause>>,
|
||||
pub(crate) fail_put_attempts: BTreeMap<(String, String), BTreeSet<usize>>,
|
||||
pub(crate) fail_after_put_attempts: BTreeMap<(String, String), BTreeSet<usize>>,
|
||||
pub(crate) pause_put_attempts: BTreeMap<(String, String), BTreeMap<usize, TestCatalogObjectPause>>,
|
||||
@@ -491,7 +561,7 @@ pub(crate) struct TestCatalogObjectState {
|
||||
pub(crate) next_etag: u64,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
#[derive(Clone)]
|
||||
pub(crate) struct TestCatalogObjectRecord {
|
||||
pub(crate) body_revision: Option<Uuid>,
|
||||
pub(crate) data: Vec<u8>,
|
||||
@@ -499,38 +569,7 @@ pub(crate) struct TestCatalogObjectRecord {
|
||||
pub(crate) mod_time: Option<OffsetDateTime>,
|
||||
}
|
||||
|
||||
pub(crate) struct TestCatalogCleanupPublication {
|
||||
table_bucket: String,
|
||||
guards: Mutex<Vec<TableCatalogLockGuard>>,
|
||||
}
|
||||
|
||||
impl TestCatalogCleanupPublication {
|
||||
fn is_held(&self) -> bool {
|
||||
let guards = self.guards.lock().expect("cleanup publication guards");
|
||||
!guards.is_empty() && guards.iter().all(|guard| !guard.is_lock_lost())
|
||||
}
|
||||
}
|
||||
|
||||
impl TestCatalogObjectBackend {
|
||||
pub(crate) async fn with_held_cleanup_publication(&self, table_bucket: &str) -> TableCatalogStoreResult<Self> {
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let guards = vec![
|
||||
self.acquire_read_lock(RUSTFS_META_BUCKET, &paths.catalog_backup_global_fence_lock_path())
|
||||
.await?,
|
||||
self.acquire_read_lock(RUSTFS_META_BUCKET, &paths.catalog_backup_fence_lock_path(table_bucket))
|
||||
.await?,
|
||||
self.acquire_write_lock(table_bucket, &default_table_bucket_publication_lock_path())
|
||||
.await?,
|
||||
];
|
||||
Ok(Self {
|
||||
cleanup_publication: Some(Arc::new(TestCatalogCleanupPublication {
|
||||
table_bucket: table_bucket.to_string(),
|
||||
guards: Mutex::new(guards),
|
||||
})),
|
||||
..self.clone()
|
||||
})
|
||||
}
|
||||
|
||||
pub(crate) async fn seed_object(&self, bucket: &str, object: &str, data: Vec<u8>) {
|
||||
self.seed_object_with_mod_time(bucket, object, data, Some(OffsetDateTime::UNIX_EPOCH))
|
||||
.await;
|
||||
@@ -621,18 +660,6 @@ impl TestCatalogObjectBackend {
|
||||
state.fail_read_attempts.entry(key).or_default().insert(next_attempt);
|
||||
}
|
||||
|
||||
pub(crate) async fn pause_next_list_page(&self, bucket: &str, prefix: &str) -> TestCatalogObjectPause {
|
||||
let pause = TestCatalogObjectPause::default();
|
||||
self.state
|
||||
.lock()
|
||||
.await
|
||||
.list_page_pauses
|
||||
.entry((bucket.to_string(), prefix.to_string()))
|
||||
.or_default()
|
||||
.push_back(pause.clone());
|
||||
pause
|
||||
}
|
||||
|
||||
pub(crate) async fn pause_next_read(&self, bucket: &str, object: &str) -> TestCatalogObjectPause {
|
||||
let mut state = self.state.lock().await;
|
||||
let key = (bucket.to_string(), object.to_string());
|
||||
@@ -954,37 +981,11 @@ impl TableCatalogObjectBackend for TestCatalogObjectBackend {
|
||||
Some(self.registration_cache.clone())
|
||||
}
|
||||
|
||||
fn table_bucket_commit_publication_is_held(&self, table_bucket: &str) -> bool {
|
||||
self.cleanup_publication
|
||||
.as_ref()
|
||||
.is_some_and(|publication| publication.table_bucket == table_bucket && publication.is_held())
|
||||
}
|
||||
|
||||
fn catalog_migration_read_permit_status(&self) -> Option<bool> {
|
||||
self.cleanup_publication.as_ref().map(|publication| publication.is_held())
|
||||
}
|
||||
|
||||
fn table_commit_object_mutation_fence(&self) -> Option<TableCatalogObjectMutationFence> {
|
||||
self.cleanup_publication.as_ref().and_then(|publication| {
|
||||
let guards = publication.guards.lock().expect("cleanup publication guards");
|
||||
(!guards.is_empty()).then(|| {
|
||||
TableCatalogObjectMutationFence::from_signals(guards.iter().map(TableCatalogLockGuard::lock_lost_signal))
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
fn complete_table_commit_publication(&self) {
|
||||
if let Some(publication) = &self.cleanup_publication {
|
||||
publication.guards.lock().expect("cleanup publication guards").clear();
|
||||
}
|
||||
fn strong_catalog_runtime(&self) -> Option<StrongTableCatalogRuntime> {
|
||||
self.strong_runtime.clone()
|
||||
}
|
||||
|
||||
async fn read_object(&self, bucket: &str, object: &str) -> TableCatalogStoreResult<Option<TableCatalogObject>> {
|
||||
let _read_guard = if self.serialize_object_reads {
|
||||
Some(self.acquire_read_lock(bucket, object).await?)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let mut missing_read_object_path = self.missing_read_object_path.lock().await;
|
||||
if missing_read_object_path.as_deref() == Some(object) {
|
||||
missing_read_object_path.take();
|
||||
@@ -1071,7 +1072,6 @@ impl TableCatalogObjectBackend for TestCatalogObjectBackend {
|
||||
async fn read_object_unlocked(&self, bucket: &str, object: &str) -> TableCatalogStoreResult<Option<TableCatalogObject>> {
|
||||
let mut backend = self.clone();
|
||||
backend.reject_reads_while_write_locked = false;
|
||||
backend.serialize_object_reads = false;
|
||||
backend.read_object(bucket, object).await
|
||||
}
|
||||
|
||||
@@ -1224,48 +1224,6 @@ impl TableCatalogObjectBackend for TestCatalogObjectBackend {
|
||||
.collect())
|
||||
}
|
||||
|
||||
async fn list_objects_page(
|
||||
&self,
|
||||
bucket: &str,
|
||||
prefix: &str,
|
||||
start_after: Option<&str>,
|
||||
limit: NonZeroUsize,
|
||||
) -> TableCatalogStoreResult<TableCatalogObjectListPage> {
|
||||
let pause = self
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.list_page_pauses
|
||||
.get_mut(&(bucket.to_string(), prefix.to_string()))
|
||||
.and_then(std::collections::VecDeque::pop_front);
|
||||
if let Some(pause) = pause {
|
||||
pause.started.notify_one();
|
||||
pause.release.notified().await;
|
||||
}
|
||||
let injected = {
|
||||
let mut state = self.state.lock().await;
|
||||
let page = state
|
||||
.list_page_overrides
|
||||
.get_mut(&(bucket.to_string(), prefix.to_string()))
|
||||
.and_then(std::collections::VecDeque::pop_front);
|
||||
if page.is_some() {
|
||||
state.list_calls += 1;
|
||||
}
|
||||
page
|
||||
};
|
||||
if let Some(page) = injected {
|
||||
return Ok(page);
|
||||
}
|
||||
let mut objects = self.list_objects(bucket, prefix).await?;
|
||||
objects.sort();
|
||||
if let Some(start_after) = start_after {
|
||||
objects.retain(|object| object.as_str() > start_after);
|
||||
}
|
||||
let is_truncated = objects.len() > limit.get();
|
||||
objects.truncate(limit.get());
|
||||
Ok(TableCatalogObjectListPage { objects, is_truncated })
|
||||
}
|
||||
|
||||
async fn list_objects_for_cleanup(
|
||||
&self,
|
||||
bucket: &str,
|
||||
|
||||
+11779
-2223
File diff suppressed because it is too large
Load Diff
@@ -1,227 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
struct BackupCaptureObjectFingerprint {
|
||||
size_bytes: usize,
|
||||
sha256: String,
|
||||
etag: String,
|
||||
mod_time: Option<OffsetDateTime>,
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
struct BackupCapturePersistedState {
|
||||
objects: BTreeMap<(String, String), BackupCaptureObjectFingerprint>,
|
||||
puts: BTreeMap<(String, String), usize>,
|
||||
deletes: BTreeMap<(String, String), usize>,
|
||||
}
|
||||
|
||||
async fn backup_capture_persisted_state(backend: &TestCatalogObjectBackend) -> BackupCapturePersistedState {
|
||||
let state = backend.state.lock().await;
|
||||
// Retain fingerprints rather than another copy of the bounded large fixtures.
|
||||
let objects = state
|
||||
.objects
|
||||
.iter()
|
||||
.map(|(key, object)| {
|
||||
let sha256 =
|
||||
hex_simd::encode_to_string(<sha2::Sha256 as sha2::Digest>::digest(&object.data), hex_simd::AsciiCase::Lower);
|
||||
(
|
||||
key.clone(),
|
||||
BackupCaptureObjectFingerprint {
|
||||
size_bytes: object.data.len(),
|
||||
sha256,
|
||||
etag: object.etag.clone(),
|
||||
mod_time: object.mod_time,
|
||||
},
|
||||
)
|
||||
})
|
||||
.collect();
|
||||
BackupCapturePersistedState {
|
||||
objects,
|
||||
puts: state.put_attempts.clone(),
|
||||
deletes: state.delete_attempts.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_capture_rejects_malformed_pages_before_publishing_any_object() {
|
||||
for scenario in [
|
||||
"foreign-prefix",
|
||||
"duplicate-object",
|
||||
"reverse-order",
|
||||
"oversized",
|
||||
"empty-truncated",
|
||||
"repeated-cursor",
|
||||
] {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let bucket_path = paths.table_bucket_entry_path("analytics");
|
||||
let (parent, _) = bucket_path.rsplit_once('/').expect("catalog bucket entry has a parent");
|
||||
let prefix = format!("{parent}/");
|
||||
let before = backup_capture_persisted_state(&backend).await;
|
||||
let existing = before
|
||||
.objects
|
||||
.keys()
|
||||
.filter(|(bucket, object)| bucket == RUSTFS_META_BUCKET && object.starts_with(&prefix))
|
||||
.map(|(_, object)| object.clone())
|
||||
.collect::<Vec<_>>();
|
||||
assert!(existing.len() >= 2, "the healthy fixture provides two real sorted catalog objects");
|
||||
let first = existing[0].clone();
|
||||
let second = existing[1].clone();
|
||||
let pages = match scenario {
|
||||
"foreign-prefix" => vec![TableCatalogObjectListPage {
|
||||
objects: vec![paths.table_bucket_entry_path("unrelated")],
|
||||
is_truncated: false,
|
||||
}],
|
||||
"duplicate-object" => vec![TableCatalogObjectListPage {
|
||||
objects: vec![first.clone(), first],
|
||||
is_truncated: false,
|
||||
}],
|
||||
"reverse-order" => vec![TableCatalogObjectListPage {
|
||||
objects: vec![second, first],
|
||||
is_truncated: false,
|
||||
}],
|
||||
"oversized" => vec![TableCatalogObjectListPage {
|
||||
objects: (0..=TABLE_CATALOG_LIST_MAX_KEYS)
|
||||
.map(|index| format!("{prefix}oversized/{index:04}.json"))
|
||||
.collect(),
|
||||
is_truncated: false,
|
||||
}],
|
||||
"empty-truncated" => vec![TableCatalogObjectListPage {
|
||||
objects: Vec::new(),
|
||||
is_truncated: true,
|
||||
}],
|
||||
"repeated-cursor" => vec![
|
||||
TableCatalogObjectListPage {
|
||||
objects: vec![first.clone()],
|
||||
is_truncated: true,
|
||||
},
|
||||
TableCatalogObjectListPage {
|
||||
objects: vec![first],
|
||||
is_truncated: false,
|
||||
},
|
||||
],
|
||||
_ => unreachable!(),
|
||||
};
|
||||
let page_key = (RUSTFS_META_BUCKET.to_string(), prefix);
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.list_page_overrides
|
||||
.entry(page_key.clone())
|
||||
.or_default()
|
||||
.extend(pages);
|
||||
|
||||
let error = ObjectTableCatalogStore::new(backend.clone())
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect_err("malformed backend pages must not become a backup");
|
||||
let expected = if matches!(scenario, "oversized" | "empty-truncated") {
|
||||
"invalid catalog backup listing page"
|
||||
} else {
|
||||
"catalog backup listing escaped its prefix or did not advance"
|
||||
};
|
||||
assert!(
|
||||
matches!(&error, TableCatalogStoreError::Invalid(message) if message == expected),
|
||||
"{scenario}: {error}"
|
||||
);
|
||||
assert_eq!(
|
||||
backup_capture_persisted_state(&backend).await,
|
||||
before,
|
||||
"{scenario} mutated an object, ETag or PUT/DELETE attempt count"
|
||||
);
|
||||
assert!(
|
||||
backend
|
||||
.state
|
||||
.lock()
|
||||
.await
|
||||
.list_page_overrides
|
||||
.get(&page_key)
|
||||
.expect("injected page queue")
|
||||
.is_empty(),
|
||||
"{scenario} did not consume the injected listing boundary"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_capture_stops_reading_when_the_encoded_payload_budget_is_exhausted() {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let bucket_path = TableCatalogObjectPaths::default().table_bucket_entry_path("analytics");
|
||||
let (parent, _) = bucket_path.rsplit_once('/').expect("catalog bucket entry has a parent");
|
||||
let prefix = format!("{parent}/");
|
||||
let first_path = format!("{prefix}zz-backup-budget-0.bin");
|
||||
let second_path = format!("{prefix}zz-backup-budget-1.bin");
|
||||
let tail_path = format!("{prefix}zz-backup-budget-2-tail.bin");
|
||||
// Byte 120 occupies four JSON bytes per array element. Each payload is just
|
||||
// below 8 MiB to keep its individual encoding below 32 MiB; the existing
|
||||
// valid catalog plus both payloads exceeds the shared 64 MiB budget.
|
||||
let payload_bytes = 8 * 1024 * 1024 - 256;
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &first_path, vec![b'x'; payload_bytes])
|
||||
.await;
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &second_path, vec![b'x'; payload_bytes])
|
||||
.await;
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &tail_path, b"unreachable tail".to_vec())
|
||||
.await;
|
||||
backend.fail_next_read(RUSTFS_META_BUCKET, &tail_path).await;
|
||||
let before = backup_capture_persisted_state(&backend).await;
|
||||
let before_reads = backend.state.lock().await.read_attempts.clone();
|
||||
|
||||
let error = ObjectTableCatalogStore::new(backend.clone())
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect_err("incremental payload accounting must stop before the unread tail");
|
||||
assert!(
|
||||
matches!(
|
||||
&error,
|
||||
TableCatalogStoreError::Invalid(message)
|
||||
if message == "catalog backup payload exceeds its encoded byte budget"
|
||||
),
|
||||
"expected the incremental byte budget, not the injected read or metadata validation error: {error}"
|
||||
);
|
||||
assert_eq!(
|
||||
backup_capture_persisted_state(&backend).await,
|
||||
before,
|
||||
"budget rejection changed persistent object bytes, ETags or write attempts"
|
||||
);
|
||||
let state = backend.state.lock().await;
|
||||
for object in [&first_path, &second_path] {
|
||||
let key = (RUSTFS_META_BUCKET.to_string(), object.clone());
|
||||
assert_eq!(
|
||||
state.read_attempts.get(&key).copied().unwrap_or_default(),
|
||||
before_reads.get(&key).copied().unwrap_or_default() + 1,
|
||||
"the collector did not measure the expected bounded payload: {object}"
|
||||
);
|
||||
}
|
||||
let tail_key = (RUSTFS_META_BUCKET.to_string(), tail_path);
|
||||
let tail_reads = before_reads.get(&tail_key).copied().unwrap_or_default();
|
||||
assert_eq!(
|
||||
state.read_attempts.get(&tail_key).copied().unwrap_or_default(),
|
||||
tail_reads,
|
||||
"the collector read beyond the exhausted byte budget"
|
||||
);
|
||||
assert!(
|
||||
state
|
||||
.fail_read_attempts
|
||||
.get(&tail_key)
|
||||
.is_some_and(|attempts| attempts.contains(&(tail_reads + 1))),
|
||||
"the unread tail fault was unexpectedly consumed"
|
||||
);
|
||||
}
|
||||
@@ -1,713 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
use sha2::Digest;
|
||||
|
||||
async fn backup_recovery_commit_request(
|
||||
backend: &TestCatalogObjectBackend,
|
||||
store: &ObjectTableCatalogStore<TestCatalogObjectBackend>,
|
||||
commit_id: &str,
|
||||
metadata_file: &str,
|
||||
) -> TableCommitRequest {
|
||||
let current = store.load_table("analytics", "sales", "orders").await.unwrap().unwrap();
|
||||
let namespace = Namespace::parse("sales").unwrap();
|
||||
let table = IdentifierSegment::parse("orders").unwrap();
|
||||
let metadata_path = default_table_metadata_file_path(&namespace, &table, metadata_file);
|
||||
let mut metadata = table_metadata_json_for_backup("analytics", ¤t.table_id, ¤t.table_uuid);
|
||||
metadata["last-updated-ms"] = serde_json::json!(current.generation + 2);
|
||||
metadata["properties"]["recovery-fixture-commit"] = serde_json::json!(commit_id);
|
||||
validate_supported_table_metadata(&metadata).expect("commit fixture must contain valid Iceberg metadata");
|
||||
backend
|
||||
.seed_object("analytics", &metadata_path, serde_json::to_vec(&metadata).unwrap())
|
||||
.await;
|
||||
TableCommitRequest {
|
||||
table_bucket: "analytics".to_string(),
|
||||
namespace: "sales".to_string(),
|
||||
table: "orders".to_string(),
|
||||
commit_id: commit_id.to_string(),
|
||||
idempotency_key: Some(format!("request-{commit_id}")),
|
||||
operation: "append".to_string(),
|
||||
expected_version_token: current.version_token,
|
||||
expected_metadata_location: current.metadata_location,
|
||||
new_metadata_location: metadata_path,
|
||||
requirements: Vec::new(),
|
||||
writer: Some("backup-recovery-fixture".to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
fn assert_backup_recovery_conflict(error: &TableCatalogStoreError, expected_state: &str) {
|
||||
assert!(
|
||||
matches!(error, TableCatalogStoreError::Conflict(message)
|
||||
if message.contains("commit recovery required") && message.contains(expected_state)),
|
||||
"{error}"
|
||||
);
|
||||
}
|
||||
|
||||
async fn assert_unhealthy_backup_has_no_writes(
|
||||
backend: &TestCatalogObjectBackend,
|
||||
store: &ObjectTableCatalogStore<TestCatalogObjectBackend>,
|
||||
expected_state: &str,
|
||||
) {
|
||||
let diagnostics = store.diagnose_table_catalog("analytics", "sales", "orders", 0).await.unwrap();
|
||||
assert_eq!(
|
||||
diagnostics.current_metadata_status,
|
||||
TableMetadataPointerStatus::Valid,
|
||||
"the regression must reach recovery policy instead of failing metadata validation"
|
||||
);
|
||||
let before = maintenance_test_object_versions(backend).await;
|
||||
let attempts = backend.state.lock().await.put_attempts.clone();
|
||||
let error = tokio::time::timeout(TABLE_CATALOG_TEST_TIMEOUT, store.create_object_catalog_backup("analytics", None))
|
||||
.await
|
||||
.expect("backup rejects unstable recovery without waiting for another lock")
|
||||
.unwrap_err();
|
||||
assert_backup_recovery_conflict(&error, expected_state);
|
||||
assert_eq!(
|
||||
maintenance_test_object_versions(backend).await,
|
||||
before,
|
||||
"rejected backup changed persisted objects"
|
||||
);
|
||||
assert_eq!(backend.state.lock().await.put_attempts, attempts, "rejected backup attempted a write");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_rejects_pre_cas_staging_until_the_same_commit_retry_converges() {
|
||||
// This public fixture already sealed a healthy backup with real metadata.
|
||||
let (backend, baseline, _) = backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let original = store.load_table("analytics", "sales", "orders").await.unwrap().unwrap();
|
||||
let request = backup_recovery_commit_request(&backend, &store, "before-cas", "00002.metadata.json").await;
|
||||
let table_path = TableCatalogObjectPaths::default().table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
);
|
||||
backend.fail_next_put(RUSTFS_META_BUCKET, &table_path).await;
|
||||
assert!(matches!(
|
||||
store.commit_table(request.clone()).await,
|
||||
Err(TableCatalogStoreError::Internal(_))
|
||||
));
|
||||
assert_eq!(store.load_table("analytics", "sales", "orders").await.unwrap(), Some(original.clone()));
|
||||
let recovery = store
|
||||
.plan_table_commit_recovery("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(recovery.staged_before_table_update_count, 1);
|
||||
assert_eq!(recovery.commits[0].recovery_state, TableCommitRecoveryState::StagedBeforeTableUpdate);
|
||||
assert_unhealthy_backup_has_no_writes(&backend, &store, "StagedBeforeTableUpdate").await;
|
||||
|
||||
let committed = store
|
||||
.commit_table(request.clone())
|
||||
.await
|
||||
.expect("same commit id safely retries its original staging");
|
||||
assert_eq!(committed.table.table_uuid, original.table_uuid);
|
||||
assert_eq!(committed.table.warehouse_location, original.warehouse_location);
|
||||
assert_eq!(committed.table.generation, original.generation + 1);
|
||||
assert_eq!(committed.table.metadata_location, request.new_metadata_location);
|
||||
assert_eq!(committed.commit_log.status, CommitLogStatus::Committed);
|
||||
let replay = store.commit_table(request).await.expect("same-id committed replay");
|
||||
assert_eq!(replay.table, committed.table, "replay advanced the catalog a second time");
|
||||
assert_eq!(replay.commit_log, committed.commit_log);
|
||||
let backup = store
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect("healthy retry is sealable");
|
||||
assert_ne!(backup.catalog_fingerprint, baseline.catalog_fingerprint);
|
||||
let diagnostics = store.diagnose_table_catalog("analytics", "sales", "orders", 0).await.unwrap();
|
||||
assert_eq!(diagnostics.recovery_status, TableCatalogRecoveryStatus::Healthy);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_rejects_post_cas_log_or_index_finalization_until_explicit_recovery() {
|
||||
for fail_index in [false, true] {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let request = backup_recovery_commit_request(&backend, &store, "after-cas", "00002.metadata.json").await;
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let failed_path = if fail_index {
|
||||
paths.commit_idempotency_entry_path("analytics", "table-id", request.idempotency_key.as_deref().unwrap())
|
||||
} else {
|
||||
paths.commit_log_entry_path("analytics", "table-id", &request.commit_id)
|
||||
};
|
||||
// First PUT is staging; the second is the durable finalization boundary.
|
||||
backend.fail_put_attempt(RUSTFS_META_BUCKET, &failed_path, 2).await;
|
||||
let committed = store
|
||||
.commit_table(request.clone())
|
||||
.await
|
||||
.expect("a successful pointer CAS remains a committed response despite finalization failure");
|
||||
let recovery = store
|
||||
.plan_table_commit_recovery("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap();
|
||||
let expected = if fail_index {
|
||||
assert_eq!(recovery.idempotency_repair_required_count, 1);
|
||||
"IdempotencyIndexRepairRequired"
|
||||
} else {
|
||||
assert_eq!(recovery.finalization_required_count, 1);
|
||||
"FinalizationRequired"
|
||||
};
|
||||
assert_unhealthy_backup_has_no_writes(&backend, &store, expected).await;
|
||||
let table_path = paths.table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
);
|
||||
let table_before = backend.read_object(RUSTFS_META_BUCKET, &table_path).await.unwrap().unwrap();
|
||||
let metadata_before = backend
|
||||
.read_object("analytics", &request.new_metadata_location)
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
|
||||
let repaired = store
|
||||
.recover_table_commits("analytics", "sales", "orders")
|
||||
.await
|
||||
.expect("explicit recovery repairs receipts");
|
||||
assert_eq!(repaired.finalized_count, 1);
|
||||
assert_eq!(repaired.finalization_required_count, 0);
|
||||
assert_eq!(repaired.idempotency_repair_required_count, 0);
|
||||
assert_eq!(repaired.staged_before_table_update_count, 0);
|
||||
assert_eq!(repaired.manual_review_count, 0);
|
||||
assert_eq!(store.load_table("analytics", "sales", "orders").await.unwrap(), Some(committed.table));
|
||||
assert_eq!(
|
||||
backend.read_object(RUSTFS_META_BUCKET, &table_path).await.unwrap(),
|
||||
Some(table_before),
|
||||
"receipt repair rewrote the table pointer, token, generation, bytes or ETag"
|
||||
);
|
||||
assert_eq!(
|
||||
backend
|
||||
.read_object("analytics", &request.new_metadata_location)
|
||||
.await
|
||||
.unwrap(),
|
||||
Some(metadata_before)
|
||||
);
|
||||
store
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect("recovered catalog can be sealed");
|
||||
let diagnostics = store.diagnose_table_catalog("analytics", "sales", "orders", 0).await.unwrap();
|
||||
assert_eq!(diagnostics.recovery_status, TableCatalogRecoveryStatus::Healthy);
|
||||
}
|
||||
}
|
||||
|
||||
// The historical v1 object field order is part of its identity encoding.
|
||||
// This fixture encoder deliberately omits the v2 references field entirely.
|
||||
#[derive(serde::Serialize, serde::Deserialize)]
|
||||
struct RecoveryLegacyBackupObject {
|
||||
bucket: String,
|
||||
object: String,
|
||||
size_bytes: u64,
|
||||
etag: Option<String>,
|
||||
sha256: String,
|
||||
data: Vec<u8>,
|
||||
}
|
||||
|
||||
fn backup_recovery_digest(data: &[u8]) -> String {
|
||||
hex_simd::encode_to_string(sha2::Sha256::digest(data), hex_simd::AsciiCase::Lower)
|
||||
}
|
||||
|
||||
fn reseal_recovery_legacy_artifact(mut artifact: serde_json::Value) -> (String, Vec<u8>) {
|
||||
artifact.as_object_mut().unwrap().remove("references");
|
||||
artifact["version"] = serde_json::json!(1);
|
||||
let mut objects: Vec<RecoveryLegacyBackupObject> = serde_json::from_value(artifact["objects"].clone()).unwrap();
|
||||
for object in &mut objects {
|
||||
object.size_bytes = u64::try_from(object.data.len()).unwrap();
|
||||
object.sha256 = backup_recovery_digest(&object.data);
|
||||
}
|
||||
objects.sort_by(|left, right| (&left.bucket, &left.object).cmp(&(&right.bucket, &right.object)));
|
||||
let fingerprint = backup_recovery_digest(
|
||||
&serde_json::to_vec(
|
||||
&objects
|
||||
.iter()
|
||||
.map(|object| (&object.bucket, &object.object, &object.sha256))
|
||||
.collect::<Vec<_>>(),
|
||||
)
|
||||
.unwrap(),
|
||||
);
|
||||
let id = backup_recovery_digest(&serde_json::to_vec(&(1u16, "analytics", &fingerprint, &objects)).unwrap());
|
||||
artifact["source_catalog_etag"] = serde_json::json!(fingerprint);
|
||||
artifact["backup_id"] = serde_json::json!(id);
|
||||
artifact["objects"] = serde_json::to_value(objects).unwrap();
|
||||
(id, serde_json::to_vec(&artifact).unwrap())
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raw_legacy_v1_import_keeps_pending_commit_state_but_restore_rejects_it_before_any_writes() {
|
||||
let (source, baseline, _) = backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source.clone());
|
||||
let baseline_bytes = source_store
|
||||
.export_object_catalog_backup("analytics", &baseline.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
let mut artifact: serde_json::Value = serde_json::from_slice(&baseline_bytes).unwrap();
|
||||
let request = backup_recovery_commit_request(&source, &source_store, "legacy-pending", "00002.metadata.json").await;
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let table_path = paths.table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
);
|
||||
source.fail_next_put(RUSTFS_META_BUCKET, &table_path).await;
|
||||
assert!(source_store.commit_table(request.clone()).await.is_err());
|
||||
for path in [
|
||||
paths.commit_log_entry_path("analytics", "table-id", &request.commit_id),
|
||||
paths.commit_idempotency_entry_path("analytics", "table-id", request.idempotency_key.as_deref().unwrap()),
|
||||
] {
|
||||
let stored = source.read_object(RUSTFS_META_BUCKET, &path).await.unwrap().unwrap();
|
||||
artifact["objects"].as_array_mut().unwrap().push(serde_json::json!({
|
||||
"bucket": RUSTFS_META_BUCKET,
|
||||
"object": path,
|
||||
"size_bytes": stored.data.len(),
|
||||
"etag": stored.etag,
|
||||
"sha256": backup_recovery_digest(&stored.data),
|
||||
"data": stored.data,
|
||||
}));
|
||||
}
|
||||
let (backup_id, bytes) = reseal_recovery_legacy_artifact(artifact);
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
let target_store = ObjectTableCatalogStore::new(target.clone());
|
||||
let imported = target_store
|
||||
.import_object_catalog_backup("analytics", bytes.clone())
|
||||
.await
|
||||
.expect("raw import stores a valid legacy candidate without publishing its unsafe recovery state");
|
||||
assert_eq!(imported.backup_id, backup_id);
|
||||
assert_eq!(imported.source_snapshot_version, 1);
|
||||
assert_eq!(
|
||||
target_store
|
||||
.export_object_catalog_backup("analytics", &backup_id)
|
||||
.await
|
||||
.unwrap(),
|
||||
bytes
|
||||
);
|
||||
assert_eq!(
|
||||
maintenance_test_object_versions(&target).await.len(),
|
||||
1,
|
||||
"import published more than its artifact"
|
||||
);
|
||||
let before = maintenance_test_object_versions(&target).await;
|
||||
let attempts = target.state.lock().await.put_attempts.clone();
|
||||
let error = target_store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup_id, None, false, Some("legacy-recovery"))
|
||||
.await
|
||||
.unwrap_err();
|
||||
assert_backup_recovery_conflict(&error, "StagedBeforeTableUpdate");
|
||||
assert_eq!(maintenance_test_object_versions(&target).await, before);
|
||||
assert_eq!(target.state.lock().await.put_attempts, attempts);
|
||||
assert!(
|
||||
!target
|
||||
.object_exists(RUSTFS_META_BUCKET, &paths.catalog_restore_state_path("analytics"))
|
||||
.await
|
||||
.unwrap()
|
||||
);
|
||||
assert!(
|
||||
!target
|
||||
.object_exists(RUSTFS_META_BUCKET, &paths.catalog_restore_intent_path("analytics", "legacy-recovery"))
|
||||
.await
|
||||
.unwrap()
|
||||
);
|
||||
assert!(target_store.get_table_bucket("analytics").await.unwrap().is_none());
|
||||
assert_eq!(
|
||||
target_store
|
||||
.export_object_catalog_backup("analytics", &backup_id)
|
||||
.await
|
||||
.unwrap(),
|
||||
bytes,
|
||||
"failed restore silently repaired or rewrote the historical artifact"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn allow_replace_cannot_overwrite_a_target_with_pending_commit_recovery() {
|
||||
let (source, _, _) = backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source.clone());
|
||||
let source_request = backup_recovery_commit_request(&source, &source_store, "source-stable", "00002.metadata.json").await;
|
||||
source_store.commit_table(source_request).await.unwrap();
|
||||
let backup = source_store.create_object_catalog_backup("analytics", None).await.unwrap();
|
||||
let bytes = source_store
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let (target, _, _) = backup_fixture().await;
|
||||
let target_store = ObjectTableCatalogStore::new(target.clone());
|
||||
let target_request = backup_recovery_commit_request(&target, &target_store, "target-pending", "00003.metadata.json").await;
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let table_path = paths.table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
);
|
||||
target.fail_next_put(RUSTFS_META_BUCKET, &table_path).await;
|
||||
assert!(target_store.commit_table(target_request).await.is_err());
|
||||
target_store.import_object_catalog_backup("analytics", bytes).await.unwrap();
|
||||
let before = maintenance_test_object_versions(&target).await;
|
||||
let attempts = target.state.lock().await.put_attempts.clone();
|
||||
let error = target_store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, true, Some("replace-pending-target"))
|
||||
.await
|
||||
.unwrap_err();
|
||||
assert_backup_recovery_conflict(&error, "StagedBeforeTableUpdate");
|
||||
assert_eq!(maintenance_test_object_versions(&target).await, before);
|
||||
assert_eq!(target.state.lock().await.put_attempts, attempts);
|
||||
assert!(
|
||||
!target
|
||||
.object_exists(RUSTFS_META_BUCKET, &paths.catalog_restore_state_path("analytics"))
|
||||
.await
|
||||
.unwrap()
|
||||
);
|
||||
assert!(
|
||||
!target
|
||||
.object_exists(
|
||||
RUSTFS_META_BUCKET,
|
||||
&paths.catalog_restore_intent_path("analytics", "replace-pending-target")
|
||||
)
|
||||
.await
|
||||
.unwrap()
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn restored_receipts_replay_and_completed_restore_never_rolls_back_a_later_commit() {
|
||||
let (source, _, _) = backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source.clone());
|
||||
let request = backup_recovery_commit_request(&source, &source_store, "portable-receipt", "00002.metadata.json").await;
|
||||
let original = source_store.commit_table(request.clone()).await.unwrap();
|
||||
let backup = source_store.create_object_catalog_backup("analytics", None).await.unwrap();
|
||||
let bytes = source_store
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
let target_store = ObjectTableCatalogStore::new(target.clone());
|
||||
target_store.import_object_catalog_backup("analytics", bytes).await.unwrap();
|
||||
let mut receipt = target_store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some("restore-portable-receipts"))
|
||||
.await
|
||||
.expect("healthy committed receipts restore into an isolated backend");
|
||||
assert_eq!(receipt.status, TableCatalogRestoreStatus::Restored);
|
||||
assert_eq!(
|
||||
target_store.load_table("analytics", "sales", "orders").await.unwrap(),
|
||||
Some(original.table.clone())
|
||||
);
|
||||
let replay = target_store
|
||||
.commit_table(request)
|
||||
.await
|
||||
.expect("restored same-id request returns its committed result");
|
||||
assert_eq!(replay.table, original.table);
|
||||
assert_eq!(replay.commit_log, original.commit_log);
|
||||
assert_eq!(
|
||||
target_store
|
||||
.get_commit_by_idempotency_key("analytics", "table-id", "request-portable-receipt")
|
||||
.await
|
||||
.unwrap(),
|
||||
Some(original.commit_log)
|
||||
);
|
||||
|
||||
let later_request =
|
||||
backup_recovery_commit_request(&target, &target_store, "later-pending-finalization", "00003.metadata.json").await;
|
||||
let later_log = TableCatalogObjectPaths::default().commit_log_entry_path("analytics", "table-id", &later_request.commit_id);
|
||||
target.fail_put_attempt(RUSTFS_META_BUCKET, &later_log, 2).await;
|
||||
let later = target_store.commit_table(later_request).await.unwrap();
|
||||
assert_eq!(later.table.generation, replay.table.generation + 1);
|
||||
assert_eq!(
|
||||
target_store
|
||||
.plan_table_commit_recovery("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap()
|
||||
.finalization_required_count,
|
||||
1
|
||||
);
|
||||
let before = maintenance_test_object_versions(&target).await;
|
||||
let attempts = target.state.lock().await.put_attempts.clone();
|
||||
receipt.status = TableCatalogRestoreStatus::AlreadyRestored;
|
||||
let repeated = target_store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some("restore-portable-receipts"))
|
||||
.await
|
||||
.expect("completed receipt wins before evaluating later target recovery state");
|
||||
assert_eq!(repeated, receipt);
|
||||
assert_eq!(target_store.load_table("analytics", "sales", "orders").await.unwrap(), Some(later.table));
|
||||
assert_eq!(
|
||||
maintenance_test_object_versions(&target).await,
|
||||
before,
|
||||
"completed restore rolled back later catalog or receipts"
|
||||
);
|
||||
assert_eq!(
|
||||
target.state.lock().await.put_attempts,
|
||||
attempts,
|
||||
"completed restore tried to publish again"
|
||||
);
|
||||
assert_eq!(
|
||||
target_store
|
||||
.plan_table_commit_recovery("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap()
|
||||
.finalization_required_count,
|
||||
1
|
||||
);
|
||||
}
|
||||
|
||||
struct SupersededBackupFixture {
|
||||
backend: TestCatalogObjectBackend,
|
||||
loser: TableCommitRequest,
|
||||
winner: TableCommitRequest,
|
||||
committed: TableCommitResult,
|
||||
}
|
||||
|
||||
async fn superseded_backup_fixture() -> SupersededBackupFixture {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let loser = backup_recovery_commit_request(&backend, &store, "losing-backup-cas", "00002.metadata.json").await;
|
||||
let table_path = TableCatalogObjectPaths::default().table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
);
|
||||
backend.fail_next_put(RUSTFS_META_BUCKET, &table_path).await;
|
||||
assert!(matches!(
|
||||
store.commit_table(loser.clone()).await,
|
||||
Err(TableCatalogStoreError::Internal(_))
|
||||
));
|
||||
let winner = backup_recovery_commit_request(&backend, &store, "winning-backup-cas", "00003.metadata.json").await;
|
||||
let committed = store.commit_table(winner.clone()).await.unwrap();
|
||||
let report = store.recover_table_commits("analytics", "sales", "orders").await.unwrap();
|
||||
assert_eq!(report.manual_review_count, 0);
|
||||
assert_eq!(report.finalized_count, 0);
|
||||
assert_eq!(
|
||||
report
|
||||
.commits
|
||||
.iter()
|
||||
.find(|entry| entry.commit_id == loser.commit_id)
|
||||
.unwrap()
|
||||
.recovery_state,
|
||||
TableCommitRecoveryState::Superseded
|
||||
);
|
||||
SupersededBackupFixture {
|
||||
backend,
|
||||
loser,
|
||||
winner,
|
||||
committed,
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_seals_proven_losers_without_changing_their_staged_receipts_or_the_winner() {
|
||||
let SupersededBackupFixture {
|
||||
backend,
|
||||
loser,
|
||||
winner,
|
||||
committed,
|
||||
} = superseded_backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let protected = [
|
||||
paths.table_entry_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
),
|
||||
paths.commit_log_entry_path("analytics", &committed.table.table_id, &loser.commit_id),
|
||||
paths.commit_idempotency_entry_path("analytics", &committed.table.table_id, loser.idempotency_key.as_deref().unwrap()),
|
||||
paths.commit_log_entry_path("analytics", &committed.table.table_id, &winner.commit_id),
|
||||
paths.commit_idempotency_entry_path("analytics", &committed.table.table_id, winner.idempotency_key.as_deref().unwrap()),
|
||||
];
|
||||
let mut before = Vec::new();
|
||||
for path in &protected {
|
||||
before.push(backend.read_object(RUSTFS_META_BUCKET, path).await.unwrap().unwrap());
|
||||
}
|
||||
let backup = store
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect("proven losers are sealable");
|
||||
for (path, original) in protected.iter().zip(&before) {
|
||||
assert_eq!(
|
||||
backend.read_object(RUSTFS_META_BUCKET, path).await.unwrap().as_ref(),
|
||||
Some(original),
|
||||
"backup rewrote {path}"
|
||||
);
|
||||
}
|
||||
let bytes = store
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
let artifact: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
|
||||
let archived = artifact["objects"]
|
||||
.as_array()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.find(|object| object["object"].as_str() == Some(protected[1].as_str()))
|
||||
.unwrap();
|
||||
let staged_bytes: Vec<u8> = serde_json::from_value(archived["data"].clone()).unwrap();
|
||||
assert_eq!(staged_bytes, before[1].data);
|
||||
let staged: CommitLogEntry = serde_json::from_slice(&staged_bytes).unwrap();
|
||||
assert_eq!(staged.status, CommitLogStatus::Staged);
|
||||
assert_eq!(staged.idempotency_key, loser.idempotency_key);
|
||||
assert!(matches!(store.commit_table(loser).await, Err(TableCatalogStoreError::Conflict(_))));
|
||||
assert_eq!(store.load_table("analytics", "sales", "orders").await.unwrap(), Some(committed.table));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn isolated_restore_retains_loser_proof_retry_conflicts_and_later_commits() {
|
||||
let SupersededBackupFixture {
|
||||
backend: source,
|
||||
loser,
|
||||
winner,
|
||||
committed,
|
||||
} = superseded_backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source.clone());
|
||||
let backup = source_store.create_object_catalog_backup("analytics", None).await.unwrap();
|
||||
let bytes = source_store
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
let source_before = maintenance_test_object_versions(&source).await;
|
||||
let loser_path =
|
||||
TableCatalogObjectPaths::default().commit_log_entry_path("analytics", &committed.table.table_id, &loser.commit_id);
|
||||
let original_loser = source.read_object(RUSTFS_META_BUCKET, &loser_path).await.unwrap().unwrap();
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
let target_store = ObjectTableCatalogStore::new(target.clone());
|
||||
target_store
|
||||
.import_object_catalog_backup("analytics", bytes.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
let mut receipt = target_store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some("restore-superseded-proof"))
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(receipt.status, TableCatalogRestoreStatus::Restored);
|
||||
assert_eq!(
|
||||
target_store.load_table("analytics", "sales", "orders").await.unwrap(),
|
||||
Some(committed.table.clone())
|
||||
);
|
||||
let restored_loser = target.read_object(RUSTFS_META_BUCKET, &loser_path).await.unwrap().unwrap();
|
||||
assert_eq!(restored_loser.data, original_loser.data);
|
||||
let restarted = ObjectTableCatalogStore::new(target.clone());
|
||||
let recovery = restarted.recover_table_commits("analytics", "sales", "orders").await.unwrap();
|
||||
assert_eq!(recovery.manual_review_count, 0);
|
||||
assert_eq!(recovery.finalized_count, 0);
|
||||
assert_eq!(
|
||||
recovery
|
||||
.commits
|
||||
.iter()
|
||||
.find(|entry| entry.commit_id == loser.commit_id)
|
||||
.unwrap()
|
||||
.recovery_state,
|
||||
TableCommitRecoveryState::Superseded
|
||||
);
|
||||
assert!(matches!(
|
||||
restarted.commit_table(loser.clone()).await,
|
||||
Err(TableCatalogStoreError::Conflict(_))
|
||||
));
|
||||
let replay = restarted.commit_table(winner).await.unwrap();
|
||||
assert_eq!(replay.table, committed.table);
|
||||
assert_eq!(replay.commit_log, committed.commit_log);
|
||||
assert_eq!(
|
||||
target.read_object(RUSTFS_META_BUCKET, &loser_path).await.unwrap(),
|
||||
Some(restored_loser.clone())
|
||||
);
|
||||
let indexed = restarted
|
||||
.get_commit_by_idempotency_key("analytics", &committed.table.table_id, loser.idempotency_key.as_deref().unwrap())
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
assert_eq!(indexed.status, CommitLogStatus::Staged);
|
||||
assert_eq!(indexed.commit_id, loser.commit_id);
|
||||
|
||||
let next_request = backup_recovery_commit_request(&target, &restarted, "reloaded-after-restore", "00004.metadata.json").await;
|
||||
let next = restarted.commit_table(next_request.clone()).await.unwrap();
|
||||
assert_eq!(next.table.generation, committed.table.generation + 1);
|
||||
assert_eq!(restarted.commit_table(next_request).await.unwrap().table, next.table);
|
||||
let versions = maintenance_test_object_versions(&target).await;
|
||||
receipt.status = TableCatalogRestoreStatus::AlreadyRestored;
|
||||
assert_eq!(
|
||||
restarted
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some("restore-superseded-proof"))
|
||||
.await
|
||||
.unwrap(),
|
||||
receipt
|
||||
);
|
||||
assert_eq!(
|
||||
maintenance_test_object_versions(&target).await,
|
||||
versions,
|
||||
"Completed replay republished old state"
|
||||
);
|
||||
let restarted = ObjectTableCatalogStore::new(target.clone());
|
||||
assert_eq!(restarted.load_table("analytics", "sales", "orders").await.unwrap(), Some(next.table));
|
||||
assert_eq!(
|
||||
restarted
|
||||
.diagnose_table_catalog("analytics", "sales", "orders", 0)
|
||||
.await
|
||||
.unwrap()
|
||||
.recovery_status,
|
||||
TableCatalogRecoveryStatus::Healthy
|
||||
);
|
||||
assert_eq!(target.read_object(RUSTFS_META_BUCKET, &loser_path).await.unwrap(), Some(restored_loser));
|
||||
restarted
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect("historical winner proof remains sealable after a later commit");
|
||||
assert_eq!(
|
||||
restarted
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap(),
|
||||
bytes
|
||||
);
|
||||
assert_eq!(
|
||||
maintenance_test_object_versions(&source).await,
|
||||
source_before,
|
||||
"isolated target changed the source"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn raw_v1_restore_rejects_a_loser_whose_winner_proof_is_missing_without_writes() {
|
||||
let SupersededBackupFixture {
|
||||
backend: source,
|
||||
winner,
|
||||
committed,
|
||||
..
|
||||
} = superseded_backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source);
|
||||
let backup = source_store.create_object_catalog_backup("analytics", None).await.unwrap();
|
||||
let bytes = source_store
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
let mut artifact: serde_json::Value = serde_json::from_slice(&bytes).unwrap();
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let winner_log = paths.commit_log_entry_path("analytics", &committed.table.table_id, &winner.commit_id);
|
||||
let winner_index =
|
||||
paths.commit_idempotency_entry_path("analytics", &committed.table.table_id, winner.idempotency_key.as_deref().unwrap());
|
||||
artifact["objects"].as_array_mut().unwrap().retain(|object| {
|
||||
object["object"].as_str() != Some(winner_log.as_str()) && object["object"].as_str() != Some(winner_index.as_str())
|
||||
});
|
||||
let (backup_id, malformed) = reseal_recovery_legacy_artifact(artifact);
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(target.clone());
|
||||
store
|
||||
.import_object_catalog_backup("analytics", malformed.clone())
|
||||
.await
|
||||
.unwrap();
|
||||
let before = maintenance_test_object_versions(&target).await;
|
||||
let attempts = target.state.lock().await.put_attempts.clone();
|
||||
let error = store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup_id, None, false, Some("missing-loser-proof"))
|
||||
.await
|
||||
.unwrap_err();
|
||||
assert_backup_recovery_conflict(&error, "ManualReview");
|
||||
assert_eq!(maintenance_test_object_versions(&target).await, before);
|
||||
assert_eq!(target.state.lock().await.put_attempts, attempts);
|
||||
assert!(store.get_table_bucket("analytics").await.unwrap().is_none());
|
||||
assert_eq!(store.export_object_catalog_backup("analytics", &backup_id).await.unwrap(), malformed);
|
||||
}
|
||||
@@ -1,169 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_waiting_for_publication_does_not_block_authorization_lookup() {
|
||||
for scenario in ["new-bucket", "cold-index", "missing-entry", "warm-index"] {
|
||||
let bucket = "analytics";
|
||||
let backend = if scenario == "new-bucket" {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
ObjectTableCatalogStore::new(backend.clone())
|
||||
.put_table_bucket(test_bucket_entry(bucket))
|
||||
.await
|
||||
.expect("enable a new empty table bucket");
|
||||
backend
|
||||
} else {
|
||||
backup_fixture().await.0
|
||||
};
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let index_path = paths.warehouse_index_entry_path(bucket, "tables/table-id/");
|
||||
if matches!(scenario, "cold-index" | "missing-entry") {
|
||||
backend
|
||||
.delete_object(RUSTFS_META_BUCKET, &index_path)
|
||||
.await
|
||||
.expect("remove index entry");
|
||||
}
|
||||
if scenario == "cold-index" {
|
||||
backend
|
||||
.delete_object(RUSTFS_META_BUCKET, &paths.warehouse_index_state_path(bucket))
|
||||
.await
|
||||
.expect("remove ready marker");
|
||||
}
|
||||
let publication_path = default_table_bucket_publication_lock_path();
|
||||
let reader_guard = backend
|
||||
.acquire_read_lock(bucket, &publication_path)
|
||||
.await
|
||||
.expect("retain S3 publication read guard");
|
||||
let publication_attempts = backend.write_lock_acquisition_count(bucket, &publication_path).await;
|
||||
let backup_store = store.clone();
|
||||
let backup = tokio::spawn(async move { backup_store.create_object_catalog_backup(bucket, None).await });
|
||||
tokio::time::timeout(TABLE_CATALOG_TEST_TIMEOUT, async {
|
||||
while backend.write_lock_acquisition_count(bucket, &publication_path).await == publication_attempts {
|
||||
tokio::task::yield_now().await;
|
||||
}
|
||||
})
|
||||
.await
|
||||
.expect("backup owns its catalog fences and is waiting for publication");
|
||||
assert!(!backup.is_finished(), "backup must wait for the S3 request");
|
||||
let objects_before = backend.state.lock().await.objects.clone();
|
||||
let catalog_lock_attempts = backend.lock_attempts.lock().await.clone();
|
||||
let resource = tokio::time::timeout(
|
||||
TABLE_CATALOG_TEST_TIMEOUT,
|
||||
store.resolve_table_data_plane_resource_for_authorization(bucket, "tables/table-id/data/part.parquet"),
|
||||
)
|
||||
.await
|
||||
.expect("S3 lookup must not wait for the backup fence")
|
||||
.expect("authorization lookup succeeds");
|
||||
if scenario == "new-bucket" {
|
||||
assert!(resource.is_none());
|
||||
} else {
|
||||
let resource = resource.expect("the table retains data-plane protection");
|
||||
assert_eq!(resource.table_id, "table-id");
|
||||
assert_eq!(resource.namespace, "sales");
|
||||
assert_eq!(resource.table, "orders");
|
||||
}
|
||||
assert_eq!(
|
||||
backend.state.lock().await.objects,
|
||||
objects_before,
|
||||
"authorization must not mutate or repair the catalog"
|
||||
);
|
||||
assert_eq!(
|
||||
*backend.lock_attempts.lock().await,
|
||||
catalog_lock_attempts,
|
||||
"authorization must not acquire catalog locks behind publication"
|
||||
);
|
||||
assert!(!backup.is_finished());
|
||||
drop(reader_guard);
|
||||
tokio::time::timeout(TABLE_CATALOG_TEST_TIMEOUT, backup)
|
||||
.await
|
||||
.expect("backup progresses after S3 completion")
|
||||
.expect("backup task joins")
|
||||
.expect("backup remains valid");
|
||||
if scenario != "new-bucket" {
|
||||
let repaired = table_data_plane_resource_for_object(&store, bucket, "tables/table-id/data/part.parquet")
|
||||
.await
|
||||
.expect("normal catalog lookup can still repair indexes")
|
||||
.expect("the table still resolves");
|
||||
assert_eq!(repaired.table_id, "table-id");
|
||||
assert!(store.warehouse_index_ready(bucket).await.expect("index readiness"));
|
||||
assert!(
|
||||
backend
|
||||
.read_object(RUSTFS_META_BUCKET, &index_path)
|
||||
.await
|
||||
.expect("read repaired index")
|
||||
.is_some()
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn cold_authorization_lookup_keeps_deleted_table_protection_without_repair() {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let bucket = "analytics";
|
||||
store.drop_table(bucket, "sales", "orders").await.expect("drop the table");
|
||||
backend
|
||||
.delete_object(RUSTFS_META_BUCKET, &store.paths.warehouse_index_state_path(bucket))
|
||||
.await
|
||||
.expect("make the warehouse index cold");
|
||||
let before = backend.state.lock().await.objects.clone();
|
||||
let resource = store
|
||||
.resolve_table_data_plane_resource_for_authorization(bucket, "tables/table-id/data/retained.parquet")
|
||||
.await
|
||||
.expect("read deleted table scope")
|
||||
.expect("the tombstone must retain data-plane protection");
|
||||
assert_eq!(resource.table_id, "table-id");
|
||||
assert_eq!(backend.state.lock().await.objects, before);
|
||||
let repaired = table_data_plane_resource_for_object(&store, bucket, "tables/table-id/data/retained.parquet")
|
||||
.await
|
||||
.expect("normal lookup may repair the cold index");
|
||||
assert_eq!(repaired, Some(resource));
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn cold_authorization_lookup_rejects_overlapping_tables_behind_partial_index() {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let namespace = Namespace::parse("sales").expect("namespace");
|
||||
let second = IdentifierSegment::parse("other_orders").expect("second table");
|
||||
let mut entry = test_table_entry(
|
||||
"analytics",
|
||||
&namespace,
|
||||
&second,
|
||||
default_table_metadata_file_path(&namespace, &second, "00001.metadata.json"),
|
||||
);
|
||||
entry.table_id = "other-id".to_string();
|
||||
entry.warehouse_location = "s3://analytics/tables/table-id/".to_string();
|
||||
backend
|
||||
.seed_object(
|
||||
RUSTFS_META_BUCKET,
|
||||
&store.paths.table_entry_path("analytics", &namespace, &second),
|
||||
serde_json::to_vec(&entry).expect("encode inconsistent catalog entry"),
|
||||
)
|
||||
.await;
|
||||
backend
|
||||
.delete_object(RUSTFS_META_BUCKET, &store.paths.warehouse_index_state_path("analytics"))
|
||||
.await
|
||||
.expect("clear the incomplete index readiness marker");
|
||||
let before = backend.state.lock().await.objects.clone();
|
||||
assert_matches!(
|
||||
store.resolve_table_data_plane_resource_for_authorization("analytics", "tables/table-id/data/part.parquet").await,
|
||||
Err(TableCatalogStoreError::Invalid(message)) if message.contains("overlapping active table warehouse prefixes")
|
||||
);
|
||||
assert_eq!(backend.state.lock().await.objects, before);
|
||||
}
|
||||
@@ -1,475 +0,0 @@
|
||||
// Copyright 2026 RustFS Team
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
use super::*;
|
||||
|
||||
#[derive(Debug, PartialEq)]
|
||||
struct BackupMaintenanceStoreWrites {
|
||||
objects: BTreeMap<(String, String), TableCatalogObject>,
|
||||
puts: BTreeMap<(String, String), usize>,
|
||||
deletes: BTreeMap<(String, String), usize>,
|
||||
}
|
||||
|
||||
async fn backup_maintenance_store_writes(backend: &TestCatalogObjectBackend) -> BackupMaintenanceStoreWrites {
|
||||
let objects = maintenance_test_object_versions(backend).await;
|
||||
let state = backend.state.lock().await;
|
||||
BackupMaintenanceStoreWrites {
|
||||
objects,
|
||||
puts: state.put_attempts.clone(),
|
||||
deletes: state.delete_attempts.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
fn backup_maintenance_store_report_paths(report: &TableMetadataMaintenanceReport) -> [String; 3] {
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let namespace = Namespace::parse(&report.job.namespace).expect("report namespace");
|
||||
let table = IdentifierSegment::parse(&report.job.table).expect("report table");
|
||||
[
|
||||
paths.table_maintenance_job_path(&report.job.table_bucket, &namespace, &table, &report.job.table_id, &report.job.job_id),
|
||||
paths.table_maintenance_latest_job_path(&report.job.table_bucket, &namespace, &table, &report.job.table_id),
|
||||
paths.table_maintenance_current_job_path(&report.job.table_bucket, &namespace, &table, &report.job.table_id),
|
||||
]
|
||||
}
|
||||
|
||||
async fn backup_maintenance_store_report(
|
||||
store: &ObjectTableCatalogStore<TestCatalogObjectBackend>,
|
||||
job_id: &str,
|
||||
status: TableMetadataMaintenanceJobStatus,
|
||||
) -> TableMetadataMaintenanceReport {
|
||||
let mut report = store
|
||||
.plan_table_metadata_maintenance("analytics", "sales", "orders", 0)
|
||||
.await
|
||||
.expect("plan against valid Iceberg metadata through the store");
|
||||
report.job.job_id = job_id.to_string();
|
||||
report.job.status = status;
|
||||
report.job.worker_id = Some("retained-worker".to_string());
|
||||
report.job.lease_id = "retained-lease".to_string();
|
||||
report.job.attempt = 3;
|
||||
let expired = maintenance_timestamp(OffsetDateTime::UNIX_EPOCH);
|
||||
report.job.started_at = Some(expired.clone());
|
||||
report.job.heartbeat_at = Some(expired);
|
||||
report.job.finished_at = if matches!(
|
||||
report.job.status,
|
||||
TableMetadataMaintenanceJobStatus::Queued | TableMetadataMaintenanceJobStatus::Running
|
||||
) {
|
||||
None
|
||||
} else {
|
||||
Some(maintenance_timestamp(OffsetDateTime::UNIX_EPOCH + Duration::seconds(1)))
|
||||
};
|
||||
report
|
||||
}
|
||||
|
||||
fn assert_backup_maintenance_store_recovery<T>(result: TableCatalogStoreResult<T>) {
|
||||
match result {
|
||||
Err(TableCatalogStoreError::Conflict(message)) => {
|
||||
assert!(message.contains("maintenance recovery required"), "{message}");
|
||||
}
|
||||
Err(error) => panic!("expected the maintenance recovery boundary, received {error}"),
|
||||
Ok(_) => panic!("an authoritative maintenance job was accepted by backup or restore"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_create_fences_expired_authoritative_jobs_without_writing_or_repairing_aliases() {
|
||||
for status in [
|
||||
TableMetadataMaintenanceJobStatus::Queued,
|
||||
TableMetadataMaintenanceJobStatus::Running,
|
||||
] {
|
||||
let (backend, _, _) = backup_fixture().await;
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let mut report = backup_maintenance_store_report(&store, "expired-authoritative-job", status).await;
|
||||
store
|
||||
.put_table_metadata_maintenance_report(&report)
|
||||
.await
|
||||
.expect("publish named, latest and current authority");
|
||||
let before = backup_maintenance_store_writes(&backend).await;
|
||||
|
||||
assert_backup_maintenance_store_recovery(
|
||||
ObjectTableCatalogStore::new(backend.clone())
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await,
|
||||
);
|
||||
assert_eq!(
|
||||
backup_maintenance_store_writes(&backend).await,
|
||||
before,
|
||||
"a backup attempt must neither expire a lease nor repair or rewrite reports"
|
||||
);
|
||||
|
||||
report.job.status = TableMetadataMaintenanceJobStatus::Successful;
|
||||
report.job.finished_at = Some(maintenance_timestamp(OffsetDateTime::UNIX_EPOCH + Duration::seconds(1)));
|
||||
store
|
||||
.put_table_metadata_maintenance_report(&report)
|
||||
.await
|
||||
.expect("publish all terminal aliases through the store");
|
||||
let backup = ObjectTableCatalogStore::new(backend.clone())
|
||||
.create_object_catalog_backup("analytics", None)
|
||||
.await
|
||||
.expect("the same valid metadata is acceptable after maintenance reaches a stable terminal state");
|
||||
assert_eq!(backup.maintenance_object_count, backup_maintenance_store_report_paths(&report).len());
|
||||
}
|
||||
}
|
||||
|
||||
// Match the saved v1 field order, as the existing transfer fixtures do, so a
|
||||
// negative authority fixture reaches the maintenance gate with valid digests.
|
||||
#[derive(serde::Deserialize, serde::Serialize)]
|
||||
struct BackupMaintenanceStoreArtifactObject {
|
||||
bucket: String,
|
||||
object: String,
|
||||
size_bytes: u64,
|
||||
etag: Option<String>,
|
||||
sha256: String,
|
||||
data: Vec<u8>,
|
||||
}
|
||||
|
||||
#[derive(serde::Deserialize, serde::Serialize)]
|
||||
struct BackupMaintenanceStoreArtifact {
|
||||
version: u16,
|
||||
backup_id: String,
|
||||
table_bucket: String,
|
||||
created_at: String,
|
||||
source_catalog_etag: String,
|
||||
objects: Vec<BackupMaintenanceStoreArtifactObject>,
|
||||
}
|
||||
|
||||
fn backup_maintenance_store_digest(bytes: &[u8]) -> String {
|
||||
hex_simd::encode_to_string(<sha2::Sha256 as sha2::Digest>::digest(bytes), hex_simd::AsciiCase::Lower)
|
||||
}
|
||||
|
||||
fn reseal_backup_maintenance_store_artifact(artifact: &mut BackupMaintenanceStoreArtifact) -> Vec<u8> {
|
||||
for object in &mut artifact.objects {
|
||||
object.size_bytes = u64::try_from(object.data.len()).expect("fixture object length fits u64");
|
||||
object.sha256 = backup_maintenance_store_digest(&object.data);
|
||||
}
|
||||
artifact
|
||||
.objects
|
||||
.sort_by(|left, right| (&left.bucket, &left.object).cmp(&(&right.bucket, &right.object)));
|
||||
artifact.source_catalog_etag = backup_maintenance_store_digest(
|
||||
&serde_json::to_vec(
|
||||
&artifact
|
||||
.objects
|
||||
.iter()
|
||||
.map(|object| (&object.bucket, &object.object, &object.sha256))
|
||||
.collect::<Vec<_>>(),
|
||||
)
|
||||
.expect("encode fixture fingerprint"),
|
||||
);
|
||||
artifact.backup_id = backup_maintenance_store_digest(
|
||||
&serde_json::to_vec(&(artifact.version, &artifact.table_bucket, &artifact.source_catalog_etag, &artifact.objects))
|
||||
.expect("encode fixture identity"),
|
||||
);
|
||||
serde_json::to_vec(artifact).expect("encode the saved v1 artifact")
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn unsafe_v1_maintenance_artifact_transfers_raw_but_restore_rejects_it_before_any_write() {
|
||||
let (source, baseline, _) = backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source.clone());
|
||||
let report =
|
||||
backup_maintenance_store_report(&source_store, "legacy-running-job", TableMetadataMaintenanceJobStatus::Running).await;
|
||||
source_store
|
||||
.put_table_metadata_maintenance_report(&report)
|
||||
.await
|
||||
.expect("publish the legacy running report through the store");
|
||||
let saved = source_store
|
||||
.export_object_catalog_backup("analytics", &baseline.backup_id)
|
||||
.await
|
||||
.expect("export the valid metadata baseline");
|
||||
let mut legacy: serde_json::Value = serde_json::from_slice(&saved).expect("decode healthy v2 baseline");
|
||||
assert_eq!(legacy["version"], 2);
|
||||
let references = legacy
|
||||
.as_object_mut()
|
||||
.unwrap()
|
||||
.remove("references")
|
||||
.expect("the v2 backup carries an inventory");
|
||||
assert!(references.is_array());
|
||||
// The fixture's complete current metadata remains embedded in objects.
|
||||
// Emit the historical v1 shape and recompute its v1 identity explicitly.
|
||||
legacy["version"] = serde_json::json!(1);
|
||||
let mut artifact: BackupMaintenanceStoreArtifact = serde_json::from_value(legacy).expect("construct v1 baseline");
|
||||
let report_paths = backup_maintenance_store_report_paths(&report);
|
||||
for path in &report_paths {
|
||||
let object = source.read_object(RUSTFS_META_BUCKET, path).await.unwrap().unwrap();
|
||||
artifact.objects.push(BackupMaintenanceStoreArtifactObject {
|
||||
bucket: RUSTFS_META_BUCKET.to_string(),
|
||||
object: path.clone(),
|
||||
size_bytes: u64::try_from(object.data.len()).unwrap(),
|
||||
etag: object.etag,
|
||||
sha256: backup_maintenance_store_digest(&object.data),
|
||||
data: object.data,
|
||||
});
|
||||
}
|
||||
let bytes = reseal_backup_maintenance_store_artifact(&mut artifact);
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(target.clone());
|
||||
let imported = store
|
||||
.import_object_catalog_backup("analytics", bytes.clone())
|
||||
.await
|
||||
.expect("raw import validates the v1 format without granting execution authority");
|
||||
assert_eq!(imported.maintenance_object_count, report_paths.len());
|
||||
assert_eq!(imported.source_snapshot_version, 1);
|
||||
assert_eq!(
|
||||
store
|
||||
.export_object_catalog_backup("analytics", &imported.backup_id)
|
||||
.await
|
||||
.unwrap(),
|
||||
bytes,
|
||||
"export must preserve the exact unsafe historical artifact bytes"
|
||||
);
|
||||
let before = backup_maintenance_store_writes(&target).await;
|
||||
assert_eq!(before.objects.len(), 1, "import must only publish the artifact");
|
||||
|
||||
assert_backup_maintenance_store_recovery(
|
||||
ObjectTableCatalogStore::new(target.clone())
|
||||
.restore_object_catalog_backup_with_id("analytics", &imported.backup_id, None, false, Some("unsafe-v1-maintenance"))
|
||||
.await,
|
||||
);
|
||||
assert_eq!(
|
||||
backup_maintenance_store_writes(&target).await,
|
||||
before,
|
||||
"rejected restore must not write an intent, barrier, catalog, report or metadata object"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn backup_restores_terminal_maintenance_bytes_and_replays_its_original_count_after_later_jobs() {
|
||||
let (source, _, _) = backup_fixture().await;
|
||||
let source_store = ObjectTableCatalogStore::new(source.clone());
|
||||
let config = TableMaintenanceConfig {
|
||||
background_enabled: true,
|
||||
quarantine_enabled: true,
|
||||
quarantine_retention_seconds: 86_400,
|
||||
max_retry_attempts: 2,
|
||||
..Default::default()
|
||||
};
|
||||
source_store
|
||||
.put_table_bucket_maintenance_config("analytics", config.clone())
|
||||
.await
|
||||
.expect("persist bucket maintenance config");
|
||||
source_store
|
||||
.put_table_maintenance_config("analytics", "sales", "orders", config.clone())
|
||||
.await
|
||||
.expect("persist table maintenance config");
|
||||
let mut terminal =
|
||||
backup_maintenance_store_report(&source_store, "terminal-quarantined-job", TableMetadataMaintenanceJobStatus::Failed)
|
||||
.await;
|
||||
terminal.job.failure_reason = Some("cleanup candidates remain quarantined".to_string());
|
||||
terminal.job.quarantine_enabled = true;
|
||||
terminal.job.quarantine_retention_seconds = 86_400;
|
||||
terminal.job.quarantined_object_count = 2;
|
||||
terminal.audit_events.push(TableMaintenanceAuditEvent {
|
||||
timestamp: terminal.job.finished_at.clone().expect("terminal timestamp"),
|
||||
actor: TableMaintenanceAuditActor::Worker,
|
||||
action: TableMaintenanceAuditAction::WorkerFailed,
|
||||
reason: terminal.job.failure_reason.clone(),
|
||||
before_status: Some(TableMetadataMaintenanceJobStatus::Running),
|
||||
after_status: Some(TableMetadataMaintenanceJobStatus::Failed),
|
||||
before_quarantined_object_count: Some(0),
|
||||
after_quarantined_object_count: Some(2),
|
||||
recommended_actions: Vec::new(),
|
||||
});
|
||||
source_store
|
||||
.put_table_metadata_maintenance_report(&terminal)
|
||||
.await
|
||||
.expect("publish a terminal quarantine report with its audit event");
|
||||
let expected_report = source_store
|
||||
.get_table_metadata_maintenance_report("analytics", "sales", "orders", &terminal.job.job_id)
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
let entry = source_store
|
||||
.load_table("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let mut sidecar_paths = backup_maintenance_store_report_paths(&terminal).to_vec();
|
||||
sidecar_paths.push(paths.table_bucket_maintenance_config_path("analytics"));
|
||||
sidecar_paths.push(paths.table_maintenance_config_path(
|
||||
"analytics",
|
||||
&Namespace::parse("sales").unwrap(),
|
||||
&IdentifierSegment::parse("orders").unwrap(),
|
||||
&entry.table_id,
|
||||
));
|
||||
let mut expected_bytes = BTreeMap::new();
|
||||
for path in &sidecar_paths {
|
||||
let object = source.read_object(RUSTFS_META_BUCKET, path).await.unwrap().unwrap();
|
||||
assert!(expected_bytes.insert(path.clone(), object.data).is_none());
|
||||
}
|
||||
assert_eq!(expected_bytes.len(), 5, "two configs and three report aliases are stored");
|
||||
|
||||
let backup = source_store.create_object_catalog_backup("analytics", None).await.unwrap();
|
||||
assert_eq!(backup.maintenance_object_count, expected_bytes.len());
|
||||
let raw = source_store
|
||||
.export_object_catalog_backup("analytics", &backup.backup_id)
|
||||
.await
|
||||
.unwrap();
|
||||
let artifact: serde_json::Value = serde_json::from_slice(&raw).unwrap();
|
||||
assert_eq!(artifact["version"], 2);
|
||||
assert!(artifact["references"].is_array(), "new backups include a v2 inventory");
|
||||
let target = TestCatalogObjectBackend::default();
|
||||
let target_store = ObjectTableCatalogStore::new(target.clone());
|
||||
let imported = target_store.import_object_catalog_backup("analytics", raw).await.unwrap();
|
||||
assert_eq!(imported.maintenance_object_count, expected_bytes.len());
|
||||
let restore_id = "terminal-maintenance-roundtrip";
|
||||
let mut first = target_store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some(restore_id))
|
||||
.await
|
||||
.expect("restore stable maintenance through the isolated target store");
|
||||
assert_eq!(first.maintenance_object_count, expected_bytes.len());
|
||||
assert_eq!(first.object_count, backup.object_count);
|
||||
assert_eq!(target_store.load_table("analytics", "sales", "orders").await.unwrap(), Some(entry));
|
||||
assert_eq!(
|
||||
target_store
|
||||
.get_table_maintenance_config("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap(),
|
||||
config
|
||||
);
|
||||
for (path, bytes) in &expected_bytes {
|
||||
let object = target.read_object(RUSTFS_META_BUCKET, path).await.unwrap().unwrap();
|
||||
assert_eq!(&object.data, bytes, "restoring rewrote config, quarantine or audit bytes: {path}");
|
||||
}
|
||||
assert_eq!(
|
||||
target_store
|
||||
.get_table_metadata_maintenance_report("analytics", "sales", "orders", &terminal.job.job_id)
|
||||
.await
|
||||
.unwrap(),
|
||||
Some(expected_report)
|
||||
);
|
||||
|
||||
let mut later_config = config;
|
||||
later_config.max_retry_attempts = 4;
|
||||
target_store
|
||||
.put_table_maintenance_config("analytics", "sales", "orders", later_config.clone())
|
||||
.await
|
||||
.expect("a later normal config update is allowed after restore");
|
||||
let later =
|
||||
backup_maintenance_store_report(&target_store, "later-successful-job", TableMetadataMaintenanceJobStatus::Successful)
|
||||
.await;
|
||||
target_store
|
||||
.put_table_metadata_maintenance_report(&later)
|
||||
.await
|
||||
.expect("publish a later normal job through the restored store");
|
||||
let later_report = target_store
|
||||
.get_table_metadata_maintenance_report("analytics", "sales", "orders", &later.job.job_id)
|
||||
.await
|
||||
.unwrap()
|
||||
.unwrap();
|
||||
let before_replay = backup_maintenance_store_writes(&target).await;
|
||||
|
||||
let replay = ObjectTableCatalogStore::new(target.clone())
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some(restore_id))
|
||||
.await
|
||||
.expect("completed restore returns its original receipt");
|
||||
first.status = TableCatalogRestoreStatus::AlreadyRestored;
|
||||
assert_eq!(replay, first, "the receipt count describes its original restore, not later maintenance");
|
||||
assert_eq!(backup_maintenance_store_writes(&target).await, before_replay);
|
||||
assert_eq!(
|
||||
target_store
|
||||
.get_table_maintenance_config("analytics", "sales", "orders")
|
||||
.await
|
||||
.unwrap(),
|
||||
later_config
|
||||
);
|
||||
assert_eq!(
|
||||
target_store
|
||||
.get_table_metadata_maintenance_report("analytics", "sales", "orders", &later.job.job_id)
|
||||
.await
|
||||
.unwrap(),
|
||||
Some(later_report)
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn legacy_v1_restore_controls_replay_an_explicit_zero_count_and_reject_a_missing_required_count() {
|
||||
let backend = TestCatalogObjectBackend::default();
|
||||
let store = ObjectTableCatalogStore::new(backend.clone());
|
||||
let backup = store
|
||||
.import_object_catalog_backup("analytics", include_bytes!("fixtures/object-catalog-backup-v1.json").to_vec())
|
||||
.await
|
||||
.expect("import the captured original v1 artifact");
|
||||
assert_eq!(backup.source_snapshot_version, 1);
|
||||
let restore_id = "legacy-v1-maintenance-count";
|
||||
let mut first = store
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some(restore_id))
|
||||
.await
|
||||
.expect("complete the no-maintenance restore");
|
||||
assert_eq!(first.maintenance_object_count, 0);
|
||||
let paths = TableCatalogObjectPaths::default();
|
||||
let intent_path = paths.catalog_restore_intent_path("analytics", restore_id);
|
||||
let barrier_path = paths.catalog_restore_state_path("analytics");
|
||||
let mut intent = restore_control_json(&backend, &intent_path).await;
|
||||
intent["version"] = serde_json::json!(1);
|
||||
assert_eq!(
|
||||
intent["maintenance_object_count"], 0,
|
||||
"the historical v1 intent requires an explicit zero"
|
||||
);
|
||||
let mut barrier = restore_control_json(&backend, &barrier_path).await;
|
||||
barrier["version"] = serde_json::json!(1);
|
||||
let fields = barrier.as_object_mut().unwrap();
|
||||
assert!(fields.remove("completed_intent_etag").is_some());
|
||||
assert!(fields.remove("backup_etag").is_some());
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &intent_path, serde_json::to_vec(&intent).unwrap())
|
||||
.await;
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &barrier_path, serde_json::to_vec(&barrier).unwrap())
|
||||
.await;
|
||||
let before = backup_maintenance_store_writes(&backend).await;
|
||||
|
||||
assert!(
|
||||
ObjectTableCatalogStore::new(backend.clone())
|
||||
.load_table("analytics", "sales", "orders")
|
||||
.await
|
||||
.expect("read existing v1 controls without a format migration")
|
||||
.is_some()
|
||||
);
|
||||
let replay = ObjectTableCatalogStore::new(backend.clone())
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some(restore_id))
|
||||
.await
|
||||
.expect("old v1 receipts remain replayable");
|
||||
first.status = TableCatalogRestoreStatus::AlreadyRestored;
|
||||
assert_eq!(replay, first);
|
||||
assert_eq!(
|
||||
backup_maintenance_store_writes(&backend).await,
|
||||
before,
|
||||
"reading v1 controls must not rewrite them"
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
intent.as_object_mut().unwrap().remove("maintenance_object_count"),
|
||||
Some(serde_json::json!(0))
|
||||
);
|
||||
backend
|
||||
.seed_object(RUSTFS_META_BUCKET, &intent_path, serde_json::to_vec(&intent).unwrap())
|
||||
.await;
|
||||
let before_missing_count = backup_maintenance_store_writes(&backend).await;
|
||||
assert!(matches!(
|
||||
ObjectTableCatalogStore::new(backend.clone())
|
||||
.load_table("analytics", "sales", "orders")
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Invalid(_) | TableCatalogStoreError::Unavailable(_))
|
||||
));
|
||||
assert!(matches!(
|
||||
ObjectTableCatalogStore::new(backend.clone())
|
||||
.restore_object_catalog_backup_with_id("analytics", &backup.backup_id, None, false, Some(restore_id))
|
||||
.await,
|
||||
Err(TableCatalogStoreError::Invalid(_) | TableCatalogStoreError::Unavailable(_))
|
||||
));
|
||||
assert_eq!(
|
||||
backup_maintenance_store_writes(&backend).await,
|
||||
before_missing_count,
|
||||
"a missing required v1 field must fail closed without defaulting or repairing it"
|
||||
);
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user