mirror of
https://github.com/rustfs/rustfs.git
synced 2026-08-31 09:18:28 +00:00
fix(lifecycle): reject invalid modification times (#5370)
This commit is contained in:
Generated
+2
@@ -9477,6 +9477,8 @@ name = "rustfs-lifecycle"
|
|||||||
version = "1.0.0-beta.11"
|
version = "1.0.0-beta.11"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"async-trait",
|
"async-trait",
|
||||||
|
"metrics",
|
||||||
|
"metrics-util",
|
||||||
"proptest",
|
"proptest",
|
||||||
"rustfs-common",
|
"rustfs-common",
|
||||||
"rustfs-config",
|
"rustfs-config",
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ documentation = "https://docs.rs/rustfs-lifecycle/latest/rustfs_lifecycle/"
|
|||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
async-trait.workspace = true
|
async-trait.workspace = true
|
||||||
|
metrics.workspace = true
|
||||||
rustfs-common.workspace = true
|
rustfs-common.workspace = true
|
||||||
rustfs-config = { workspace = true, features = ["constants"] }
|
rustfs-config = { workspace = true, features = ["constants"] }
|
||||||
rustfs-replication.workspace = true
|
rustfs-replication.workspace = true
|
||||||
@@ -38,6 +39,7 @@ url.workspace = true
|
|||||||
uuid = { workspace = true, features = ["v4", "serde", "fast-rng", "macro-diagnostics"] }
|
uuid = { workspace = true, features = ["v4", "serde", "fast-rng", "macro-diagnostics"] }
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
|
metrics-util = { version = "0.20", features = ["debugging"] }
|
||||||
proptest = "1"
|
proptest = "1"
|
||||||
serial_test.workspace = true
|
serial_test.workspace = true
|
||||||
temp-env.workspace = true
|
temp-env.workspace = true
|
||||||
|
|||||||
+115
-20
@@ -34,6 +34,7 @@ const LOG_SUBSYSTEM_LIFECYCLE: &str = "lifecycle";
|
|||||||
const EVENT_LIFECYCLE_EXPIRY_COMPUTED: &str = "lifecycle_expiry_computed";
|
const EVENT_LIFECYCLE_EXPIRY_COMPUTED: &str = "lifecycle_expiry_computed";
|
||||||
const EVENT_LIFECYCLE_DEBUG_DAY_SECS: &str = "lifecycle_debug_day_secs";
|
const EVENT_LIFECYCLE_DEBUG_DAY_SECS: &str = "lifecycle_debug_day_secs";
|
||||||
const EVENT_LIFECYCLE_NONCURRENT_EXPIRY_SKIPPED: &str = "lifecycle_noncurrent_expiry_skipped";
|
const EVENT_LIFECYCLE_NONCURRENT_EXPIRY_SKIPPED: &str = "lifecycle_noncurrent_expiry_skipped";
|
||||||
|
const METRIC_LIFECYCLE_INVALID_MOD_TIME_TOTAL: &str = "rustfs_lifecycle_invalid_mod_time_total";
|
||||||
const ERR_LIFECYCLE_NO_RULE: &str = "Lifecycle configuration should have at least one rule";
|
const ERR_LIFECYCLE_NO_RULE: &str = "Lifecycle configuration should have at least one rule";
|
||||||
const ERR_LIFECYCLE_DUPLICATE_ID: &str = "Rule ID must be unique. Found same ID for more than one rule";
|
const ERR_LIFECYCLE_DUPLICATE_ID: &str = "Rule ID must be unique. Found same ID for more than one rule";
|
||||||
const _ERR_XML_NOT_WELL_FORMED: &str =
|
const _ERR_XML_NOT_WELL_FORMED: &str =
|
||||||
@@ -204,6 +205,21 @@ fn lifecycle_rule_prefix(rule: &LifecycleRule) -> Option<&str> {
|
|||||||
filter.and.as_ref().and_then(|and| and.prefix.as_deref())
|
filter.and.as_ref().and_then(|and| and.prefix.as_deref())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn lifecycle_mod_time(obj: &ObjectOpts) -> Option<OffsetDateTime> {
|
||||||
|
let reason = match obj.mod_time {
|
||||||
|
None => "missing",
|
||||||
|
Some(mod_time) if mod_time < OffsetDateTime::UNIX_EPOCH => "before_unix_epoch",
|
||||||
|
Some(mod_time) if mod_time == OffsetDateTime::UNIX_EPOCH => "unix_epoch",
|
||||||
|
Some(mod_time) => return Some(mod_time),
|
||||||
|
};
|
||||||
|
metrics::counter!(
|
||||||
|
METRIC_LIFECYCLE_INVALID_MOD_TIME_TOTAL,
|
||||||
|
"reason" => reason
|
||||||
|
)
|
||||||
|
.increment(1);
|
||||||
|
None
|
||||||
|
}
|
||||||
|
|
||||||
#[async_trait::async_trait]
|
#[async_trait::async_trait]
|
||||||
pub trait Lifecycle {
|
pub trait Lifecycle {
|
||||||
async fn has_transition(&self) -> bool;
|
async fn has_transition(&self) -> bool;
|
||||||
@@ -434,14 +450,8 @@ impl Lifecycle for BucketLifecycleConfiguration {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async fn predict_expiration(&self, obj: &ObjectOpts) -> Event {
|
async fn predict_expiration(&self, obj: &ObjectOpts) -> Event {
|
||||||
let mod_time = match obj.mod_time {
|
let Some(mod_time) = lifecycle_mod_time(obj) else {
|
||||||
Some(time) => {
|
return Event::default();
|
||||||
if time.unix_timestamp() == 0 {
|
|
||||||
return Event::default();
|
|
||||||
}
|
|
||||||
time
|
|
||||||
}
|
|
||||||
None => return Event::default(),
|
|
||||||
};
|
};
|
||||||
|
|
||||||
if obj.delete_marker || !(obj.is_latest || obj.version_id.is_none_or(|v| v.is_nil())) {
|
if obj.delete_marker || !(obj.is_latest || obj.version_id.is_none_or(|v| v.is_nil())) {
|
||||||
@@ -495,19 +505,9 @@ impl Lifecycle for BucketLifecycleConfiguration {
|
|||||||
obj.name, obj.mod_time, obj.successor_mod_time, now, obj.is_latest, obj.delete_marker
|
obj.name, obj.mod_time, obj.successor_mod_time, now, obj.is_latest, obj.delete_marker
|
||||||
);
|
);
|
||||||
|
|
||||||
// Gracefully handle missing mod_time instead of panicking
|
let Some(mod_time) = lifecycle_mod_time(obj) else {
|
||||||
let mod_time = match obj.mod_time {
|
|
||||||
Some(t) => t,
|
|
||||||
None => {
|
|
||||||
debug!("eval_inner: mod_time is None for object={}, returning default event", obj.name);
|
|
||||||
return Event::default();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
if mod_time.unix_timestamp() == 0 {
|
|
||||||
debug!("eval_inner: mod_time is 0, returning default event");
|
|
||||||
return Event::default();
|
return Event::default();
|
||||||
}
|
};
|
||||||
|
|
||||||
if let Some(restore_expires) = obj.restore_expires
|
if let Some(restore_expires) = obj.restore_expires
|
||||||
&& restore_expires.unix_timestamp() != 0
|
&& restore_expires.unix_timestamp() != 0
|
||||||
@@ -1082,6 +1082,8 @@ impl Default for TransitionOptions {
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
use metrics_util::MetricKind;
|
||||||
|
use metrics_util::debugging::{DebugValue, DebuggingRecorder};
|
||||||
use s3s::dto::{LifecycleRuleFilter, TransitionStorageClass};
|
use s3s::dto::{LifecycleRuleFilter, TransitionStorageClass};
|
||||||
use serial_test::serial;
|
use serial_test::serial;
|
||||||
use std::sync::Arc;
|
use std::sync::Arc;
|
||||||
@@ -1097,6 +1099,99 @@ mod tests {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn eval_inner_reports_invalid_mod_time_without_expiring_object() {
|
||||||
|
let lifecycle = BucketLifecycleConfiguration {
|
||||||
|
expiry_updated_at: None,
|
||||||
|
rules: vec![LifecycleRule {
|
||||||
|
status: ExpirationStatus::from_static(ExpirationStatus::ENABLED),
|
||||||
|
expiration: Some(LifecycleExpiration {
|
||||||
|
days: Some(1),
|
||||||
|
..Default::default()
|
||||||
|
}),
|
||||||
|
abort_incomplete_multipart_upload: None,
|
||||||
|
del_marker_expiration: None,
|
||||||
|
filter: None,
|
||||||
|
id: Some("expire-after-one-day".to_string()),
|
||||||
|
noncurrent_version_expiration: None,
|
||||||
|
noncurrent_version_transitions: None,
|
||||||
|
prefix: None,
|
||||||
|
transitions: None,
|
||||||
|
}],
|
||||||
|
};
|
||||||
|
let recorder = DebuggingRecorder::new();
|
||||||
|
let snapshotter = recorder.snapshotter();
|
||||||
|
let runtime = tokio::runtime::Builder::new_current_thread()
|
||||||
|
.build()
|
||||||
|
.expect("current-thread runtime should build");
|
||||||
|
|
||||||
|
let actions = metrics::with_local_recorder(&recorder, || {
|
||||||
|
runtime.block_on(async {
|
||||||
|
let now = OffsetDateTime::from_unix_timestamp(10 * 86_400).expect("fixed timestamp should be valid");
|
||||||
|
let mut opts = ObjectOpts {
|
||||||
|
name: "legacy-object".to_string(),
|
||||||
|
is_latest: true,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let mut actions = Vec::new();
|
||||||
|
for mod_time in [
|
||||||
|
None,
|
||||||
|
Some(OffsetDateTime::UNIX_EPOCH),
|
||||||
|
Some(OffsetDateTime::UNIX_EPOCH - Duration::nanoseconds(1)),
|
||||||
|
Some(OffsetDateTime::UNIX_EPOCH + Duration::nanoseconds(1)),
|
||||||
|
] {
|
||||||
|
opts.mod_time = mod_time;
|
||||||
|
actions.push((
|
||||||
|
lifecycle.eval_inner(&opts, now, 0).await.action,
|
||||||
|
lifecycle.predict_expiration(&opts).await.action,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
actions
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
actions,
|
||||||
|
[
|
||||||
|
(IlmAction::NoneAction, IlmAction::NoneAction),
|
||||||
|
(IlmAction::NoneAction, IlmAction::NoneAction),
|
||||||
|
(IlmAction::NoneAction, IlmAction::NoneAction),
|
||||||
|
(IlmAction::DeleteAction, IlmAction::DeleteAction)
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
|
let invalid_mod_time_metrics = snapshotter
|
||||||
|
.snapshot()
|
||||||
|
.into_vec()
|
||||||
|
.into_iter()
|
||||||
|
.filter_map(|(composite, _unit, _description, value)| {
|
||||||
|
(composite.kind() == MetricKind::Counter && composite.key().name() == METRIC_LIFECYCLE_INVALID_MOD_TIME_TOTAL)
|
||||||
|
.then(|| {
|
||||||
|
let reason = composite
|
||||||
|
.key()
|
||||||
|
.labels()
|
||||||
|
.find(|label| label.key() == "reason")
|
||||||
|
.map(|label| label.value().to_string())
|
||||||
|
.expect("invalid mod_time metric should have a reason");
|
||||||
|
(reason, value)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
assert_eq!(invalid_mod_time_metrics.len(), 3);
|
||||||
|
assert!(
|
||||||
|
invalid_mod_time_metrics
|
||||||
|
.iter()
|
||||||
|
.all(|(_, value)| matches!(value, DebugValue::Counter(2)))
|
||||||
|
);
|
||||||
|
assert!(invalid_mod_time_metrics.iter().any(|(reason, _)| reason == "missing"));
|
||||||
|
assert!(invalid_mod_time_metrics.iter().any(|(reason, _)| reason == "unix_epoch"));
|
||||||
|
assert!(
|
||||||
|
invalid_mod_time_metrics
|
||||||
|
.iter()
|
||||||
|
.any(|(reason, _)| reason == "before_unix_epoch")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
#[serial]
|
#[serial]
|
||||||
async fn validate_rejects_zero_expiration_days() {
|
async fn validate_rejects_zero_expiration_days() {
|
||||||
|
|||||||
Reference in New Issue
Block a user