fakecloud-s3 0.15.2

S3 implementation for FakeCloud
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
use std::time::Duration;

use chrono::{NaiveDate, Utc};

use crate::state::SharedS3State;
use crate::xml_util::extract_tag;

/// Background task that processes S3 lifecycle rules.
///
/// Every 60 seconds, iterates all buckets with lifecycle configurations,
/// parses the lifecycle XML, and:
/// - Deletes objects matching expiration rules (by Days or Date)
/// - Updates storage class for objects matching transition rules
pub struct LifecycleProcessor {
    state: SharedS3State,
}

impl LifecycleProcessor {
    pub fn new(state: SharedS3State) -> Self {
        Self { state }
    }

    pub async fn run(self) {
        let mut interval = tokio::time::interval(Duration::from_secs(60));

        loop {
            interval.tick().await;
            self.tick();
        }
    }

    pub fn tick(&self) {
        let now = Utc::now();
        let today = now.date_naive();

        // Collect bucket names, their lifecycle configs, and owning account id
        let bucket_configs: Vec<(String, String, String)> = {
            let __mas = self.state.read();
            __mas
                .iter()
                .flat_map(|(acct_id, state)| {
                    state.buckets.values().filter_map(move |b| {
                        b.lifecycle_config
                            .as_ref()
                            .map(|cfg| (b.name.clone(), cfg.clone(), acct_id.to_string()))
                    })
                })
                .collect()
        };

        for (bucket_name, config_xml, account_id) in bucket_configs {
            let rules = match parse_lifecycle_rules(&config_xml) {
                Some(r) => r,
                None => continue,
            };

            for rule in &rules {
                if rule.status != "Enabled" {
                    continue;
                }

                self.process_rule(&account_id, &bucket_name, rule, today);
            }
        }
    }

    fn process_rule(
        &self,
        account_id: &str,
        bucket_name: &str,
        rule: &LifecycleRule,
        today: NaiveDate,
    ) {
        let mut __mas = self.state.write();
        let state = match __mas.get_mut(account_id) {
            Some(s) => s,
            None => return,
        };
        let bucket = match state.buckets.get_mut(bucket_name) {
            Some(b) => b,
            None => return,
        };

        // Collect keys to expire
        let mut keys_to_delete: Vec<String> = Vec::new();
        // Collect keys to transition (key, new_storage_class)
        let mut keys_to_transition: Vec<(String, String)> = Vec::new();

        for (key, obj) in bucket.objects.iter() {
            // Check prefix filter
            if let Some(ref prefix) = rule.prefix {
                if !prefix.is_empty() && !key.starts_with(prefix) {
                    continue;
                }
            }

            // Check tag filter
            if let Some(ref tag_filter) = rule.tag_filter {
                let matches = obj
                    .tags
                    .get(&tag_filter.key)
                    .map(|v| v == &tag_filter.value)
                    .unwrap_or(false);
                if !matches {
                    continue;
                }
            }

            // Check expiration by Days
            if let Some(days) = rule.expiration_days {
                let age = today
                    .signed_duration_since(obj.last_modified.date_naive())
                    .num_days();
                if age >= days as i64 {
                    keys_to_delete.push(key.clone());
                    continue;
                }
            }

            // Check expiration by Date
            if let Some(ref date) = rule.expiration_date {
                if &today >= date {
                    keys_to_delete.push(key.clone());
                    continue;
                }
            }

            // Check transition by Days
            for transition in &rule.transitions {
                let should_transition = if let Some(days) = transition.days {
                    let age = today
                        .signed_duration_since(obj.last_modified.date_naive())
                        .num_days();
                    age >= days as i64
                } else if let Some(ref date) = transition.date {
                    &today >= date
                } else {
                    false
                };

                if should_transition && obj.storage_class != transition.storage_class {
                    keys_to_transition.push((key.clone(), transition.storage_class.clone()));
                    break; // Only apply first matching transition
                }
            }
        }

        // Apply deletions
        if !keys_to_delete.is_empty() {
            tracing::info!(
                bucket = %bucket_name,
                count = keys_to_delete.len(),
                "S3 lifecycle: expiring objects"
            );
            for key in &keys_to_delete {
                bucket.objects.remove(key);
            }
        }

        // Apply transitions
        if !keys_to_transition.is_empty() {
            tracing::info!(
                bucket = %bucket_name,
                count = keys_to_transition.len(),
                "S3 lifecycle: transitioning object storage classes"
            );
            for (key, new_class) in &keys_to_transition {
                if let Some(obj) = bucket.objects.get_mut(key) {
                    obj.storage_class = new_class.clone();
                }
            }
        }
    }
}

/// A parsed lifecycle rule.
struct LifecycleRule {
    status: String,
    prefix: Option<String>,
    tag_filter: Option<TagFilter>,
    expiration_days: Option<u32>,
    expiration_date: Option<NaiveDate>,
    transitions: Vec<Transition>,
}

struct TagFilter {
    key: String,
    value: String,
}

struct Transition {
    days: Option<u32>,
    date: Option<NaiveDate>,
    storage_class: String,
}

/// Parse lifecycle configuration XML into rules.
fn parse_lifecycle_rules(xml: &str) -> Option<Vec<LifecycleRule>> {
    let mut rules = Vec::new();
    let mut remaining = xml;

    while let Some(rule_start) = remaining.find("<Rule>") {
        let after = &remaining[rule_start + 6..];
        let rule_end = after.find("</Rule>")?;
        let rule_body = &after[..rule_end];

        let status = extract_tag(rule_body, "Status").unwrap_or_default();

        // Parse prefix — can be at rule level or inside <Filter>
        let prefix = if let Some(filter_body) = extract_block(rule_body, "Filter") {
            // Check for <Prefix> inside Filter
            let filter_prefix = extract_tag(filter_body, "Prefix");
            // Also check for <And><Prefix> pattern
            if filter_prefix.is_some() {
                filter_prefix
            } else if let Some(and_body) = extract_block(filter_body, "And") {
                extract_tag(and_body, "Prefix")
            } else {
                None
            }
        } else {
            extract_tag(rule_body, "Prefix")
        };

        // Parse tag filter from <Filter><Tag> or <Filter><And><Tag>
        let tag_filter = if let Some(filter_body) = extract_block(rule_body, "Filter") {
            parse_tag_filter(filter_body)
        } else {
            None
        };

        // Parse expiration
        let (expiration_days, expiration_date) =
            if let Some(exp_body) = extract_block(rule_body, "Expiration") {
                let days = extract_tag(exp_body, "Days").and_then(|s| s.parse::<u32>().ok());
                let date = extract_tag(exp_body, "Date").and_then(|s| parse_date(&s));
                (days, date)
            } else {
                (None, None)
            };

        // Parse transitions
        let mut transitions = Vec::new();
        let mut trans_remaining = rule_body;
        while let Some(t_start) = trans_remaining.find("<Transition>") {
            let t_after = &trans_remaining[t_start + 12..];
            if let Some(t_end) = t_after.find("</Transition>") {
                let t_body = &t_after[..t_end];
                let days = extract_tag(t_body, "Days").and_then(|s| s.parse::<u32>().ok());
                let date = extract_tag(t_body, "Date").and_then(|s| parse_date(&s));
                let storage_class =
                    extract_tag(t_body, "StorageClass").unwrap_or_else(|| "GLACIER".to_string());
                transitions.push(Transition {
                    days,
                    date,
                    storage_class,
                });
                trans_remaining = &t_after[t_end + 13..];
            } else {
                break;
            }
        }

        rules.push(LifecycleRule {
            status,
            prefix,
            tag_filter,
            expiration_days,
            expiration_date,
            transitions,
        });

        remaining = &after[rule_end + 7..];
    }

    Some(rules)
}

/// Extract the body of a block element, e.g. `<Filter>...</Filter>` -> "...".
fn extract_block<'a>(body: &'a str, tag: &str) -> Option<&'a str> {
    let open = format!("<{tag}>");
    let close = format!("</{tag}>");
    let start = body.find(&open)?;
    let content_start = start + open.len();
    let end = body[content_start..].find(&close)?;
    Some(&body[content_start..content_start + end])
}

fn parse_tag_filter(filter_body: &str) -> Option<TagFilter> {
    // Try direct <Tag> inside <Filter>
    if let Some(tag_body) = extract_block(filter_body, "Tag") {
        let key = extract_tag(tag_body, "Key")?;
        let value = extract_tag(tag_body, "Value").unwrap_or_default();
        return Some(TagFilter { key, value });
    }
    // Try <And><Tag> inside <Filter>
    if let Some(and_body) = extract_block(filter_body, "And") {
        if let Some(tag_body) = extract_block(and_body, "Tag") {
            let key = extract_tag(tag_body, "Key")?;
            let value = extract_tag(tag_body, "Value").unwrap_or_default();
            return Some(TagFilter { key, value });
        }
    }
    None
}

/// Parse a date string like "2024-01-01" or "2024-01-01T00:00:00.000Z".
fn parse_date(s: &str) -> Option<NaiveDate> {
    // Try YYYY-MM-DD first
    if let Ok(d) = NaiveDate::parse_from_str(s, "%Y-%m-%d") {
        return Some(d);
    }
    // Try ISO 8601 with time
    if let Ok(dt) = chrono::DateTime::parse_from_rfc3339(s) {
        return Some(dt.date_naive());
    }
    // Try with T and Z suffix
    if let Some(date_part) = s.split('T').next() {
        if let Ok(d) = NaiveDate::parse_from_str(date_part, "%Y-%m-%d") {
            return Some(d);
        }
    }
    None
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_expiration_days_rule() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <Filter><Prefix>logs/</Prefix></Filter>
                <Status>Enabled</Status>
                <Expiration><Days>30</Days></Expiration>
            </Rule>
        </LifecycleConfiguration>"#;

        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].status, "Enabled");
        assert_eq!(rules[0].prefix.as_deref(), Some("logs/"));
        assert_eq!(rules[0].expiration_days, Some(30));
    }

    #[test]
    fn parse_expiration_date_rule() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <Filter><Prefix></Prefix></Filter>
                <Status>Enabled</Status>
                <Expiration><Date>2024-06-01</Date></Expiration>
            </Rule>
        </LifecycleConfiguration>"#;

        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
        assert_eq!(
            rules[0].expiration_date,
            Some(NaiveDate::from_ymd_opt(2024, 6, 1).unwrap())
        );
    }

    #[test]
    fn parse_transition_rule() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <Filter><Prefix>archive/</Prefix></Filter>
                <Status>Enabled</Status>
                <Transition>
                    <Days>90</Days>
                    <StorageClass>GLACIER</StorageClass>
                </Transition>
                <Transition>
                    <Days>365</Days>
                    <StorageClass>DEEP_ARCHIVE</StorageClass>
                </Transition>
            </Rule>
        </LifecycleConfiguration>"#;

        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].transitions.len(), 2);
        assert_eq!(rules[0].transitions[0].days, Some(90));
        assert_eq!(rules[0].transitions[0].storage_class, "GLACIER");
        assert_eq!(rules[0].transitions[1].days, Some(365));
        assert_eq!(rules[0].transitions[1].storage_class, "DEEP_ARCHIVE");
    }

    #[test]
    fn parse_disabled_rule() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <Filter><Prefix></Prefix></Filter>
                <Status>Disabled</Status>
                <Expiration><Days>1</Days></Expiration>
            </Rule>
        </LifecycleConfiguration>"#;

        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].status, "Disabled");
    }

    #[test]
    fn parse_tag_filter_rule() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <Filter>
                    <Tag><Key>env</Key><Value>test</Value></Tag>
                </Filter>
                <Status>Enabled</Status>
                <Expiration><Days>7</Days></Expiration>
            </Rule>
        </LifecycleConfiguration>"#;

        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
        let tag = rules[0].tag_filter.as_ref().unwrap();
        assert_eq!(tag.key, "env");
        assert_eq!(tag.value, "test");
    }

    #[test]
    fn parse_multiple_rules() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <Filter><Prefix>a/</Prefix></Filter>
                <Status>Enabled</Status>
                <Expiration><Days>10</Days></Expiration>
            </Rule>
            <Rule>
                <Filter><Prefix>b/</Prefix></Filter>
                <Status>Enabled</Status>
                <Expiration><Days>20</Days></Expiration>
            </Rule>
        </LifecycleConfiguration>"#;

        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 2);
        assert_eq!(rules[0].prefix.as_deref(), Some("a/"));
        assert_eq!(rules[0].expiration_days, Some(10));
        assert_eq!(rules[1].prefix.as_deref(), Some("b/"));
        assert_eq!(rules[1].expiration_days, Some(20));
    }

    #[test]
    fn parse_empty_lifecycle_xml_returns_empty() {
        let xml = "<LifecycleConfiguration></LifecycleConfiguration>";
        let rules = parse_lifecycle_rules(xml);
        assert!(rules.is_some());
        assert!(rules.unwrap().is_empty());
    }

    #[test]
    fn parse_rule_with_noncurrent_version_expiration() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <ID>nc-rule</ID>
                <Status>Enabled</Status>
                <Prefix>x/</Prefix>
                <NoncurrentVersionExpiration><NoncurrentDays>30</NoncurrentDays></NoncurrentVersionExpiration>
            </Rule>
        </LifecycleConfiguration>"#;
        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
    }

    #[test]
    fn parse_rule_with_abort_incomplete_multipart() {
        let xml = r#"<LifecycleConfiguration>
            <Rule>
                <ID>mp-rule</ID>
                <Status>Enabled</Status>
                <Prefix></Prefix>
                <AbortIncompleteMultipartUpload><DaysAfterInitiation>7</DaysAfterInitiation></AbortIncompleteMultipartUpload>
            </Rule>
        </LifecycleConfiguration>"#;
        let rules = parse_lifecycle_rules(xml).unwrap();
        assert_eq!(rules.len(), 1);
    }

    #[test]
    fn parse_date_valid() {
        let d = parse_date("2025-01-15T00:00:00Z");
        assert!(d.is_some());
    }

    #[test]
    fn parse_date_invalid_returns_none() {
        assert!(parse_date("bogus").is_none());
    }

    #[test]
    fn extract_block_finds_tag() {
        let body = "<a><b>content</b></a>";
        let block = extract_block(body, "b");
        assert_eq!(block, Some("content"));
    }

    #[test]
    fn extract_block_missing_tag_returns_none() {
        let body = "<a></a>";
        assert!(extract_block(body, "missing").is_none());
    }
}