rustfs-notify 1.0.0

File system notification service for RustFS, providing real-time updates on file changes and events.
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
// Copyright 2024 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.

//! Integration tests for BucketNotificationConfig
//!
//! This module contains tests that simulate the exact flow from XML configuration
//! to event matching, including filter rules with prefix and suffix.

use super::*;
use rustfs_s3_types::EventName;
use rustfs_targets::arn::{ARN, TargetID};
use std::io::Cursor;

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

    fn create_test_arn() -> ARN {
        ARN {
            partition: "rustfs".to_string(),
            service: "sqs".to_string(),
            region: "".to_string(),
            target_id: TargetID::new("primary".to_string(), "webhook".to_string()),
        }
    }

    #[test]
    fn test_create_arn() {
        let arn = create_test_arn();

        assert_eq!(arn.partition, "rustfs");
        assert_eq!(arn.service, "sqs");
        assert_eq!(arn.region, "");
        assert_eq!(arn.target_id, TargetID::new("primary".to_string(), "webhook".to_string()));
    }

    /// Test exact bug scenario from the bug report
    #[test]
    fn test_bug_report_exact_scenario_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRule>
                    <Name>prefix</Name>
                    <Value>uploads/</Value>
                </FilterRule>
                <FilterRule>
                    <Name>suffix</Name>
                    <Value>.csv</Value>
                </FilterRule>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        // Verify pattern is "uploads/*.csv"
        let rules_map = config.get_rules_map();

        // Debug: Print the patterns stored
        println!("\nPatterns stored in rules_map:");
        for (event_name, pattern_rules) in rules_map.inner().iter() {
            for pattern in pattern_rules.inner().keys() {
                println!("  Event: {:?}, Pattern: '{}'", event_name, pattern);
            }
        }

        // The event should be registered for ObjectCreatedAll and all its expansions
        assert!(rules_map.has_subscriber(&EventName::ObjectCreatedAll));
        assert!(rules_map.has_subscriber(&EventName::ObjectCreatedPut));

        // Test matching "uploads/test.csv" with ObjectCreatedPut
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/test.csv");

        println!("Matching 'uploads/test.csv' with ObjectCreatedPut: {} targets", targets.len());
        for target in &targets {
            println!("  Target: {:?}", target);
        }

        // Should find the target
        assert!(!targets.is_empty(), "Should find at least one target");

        // Test matching "uploads/subdir/file.csv" - should also match
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/subdir/file.csv");
        assert!(!targets.is_empty(), "Nested CSV files should match");

        // Test matching "uploads/test.txt" - should NOT match
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/test.txt");
        assert!(targets.is_empty(), "TXT files should not match");

        // Test matching "files/test.csv" - should NOT match (wrong prefix)
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "files/test.csv");
        assert!(targets.is_empty(), "Files in wrong prefix should not match");
    }

    /// Test prefix only filter
    #[test]
    fn test_prefix_only_filter_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRuleList>
                    <FilterRule>
                        <Name>prefix</Name>
                        <Value>images/</Value>
                    </FilterRule>
                </FilterRuleList>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // Debug: Print the patterns stored
        println!("\nPatterns stored in rules_map:");
        for (event_name, pattern_rules) in rules_map.inner().iter() {
            for pattern in pattern_rules.inner().keys() {
                println!("  Event: {:?}, Pattern: '{}'", event_name, pattern);
            }
        }

        // Test matching "images/photo.jpg"
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "images/photo.jpg");
        println!("Matching 'images/photo.jpg': {} targets", targets.len());
        assert!(!targets.is_empty(), "Files in images/ should match");

        // Test matching "uploads/photo.jpg" - should NOT match
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/photo.jpg");
        println!("Matching 'uploads/photo.jpg': {} targets", targets.len());
        assert!(targets.is_empty(), "Files not in images/ should not match");
    }

    #[test]
    fn test_capitalized_filter_names_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRule>
                    <Name>Prefix</Name>
                    <Value>uploads/</Value>
                </FilterRule>
                <FilterRule>
                    <Name>Suffix</Name>
                    <Value>.csv</Value>
                </FilterRule>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();
        let rules_map = config.get_rules_map();

        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/report.csv");
        assert!(!targets.is_empty(), "capitalized filter names should still build prefix/suffix rules");
    }

    /// Test suffix only filter
    #[test]
    fn test_suffix_only_filter_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRuleList>
                    <FilterRule>
                        <Name>suffix</Name>
                        <Value>.pdf</Value>
                    </FilterRule>
                </FilterRuleList>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // Test matching "document.pdf" - should match
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "document.pdf");
        assert!(!targets.is_empty(), "PDF files should match");

        // Test matching "document.txt" - should NOT match
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "document.txt");
        assert!(targets.is_empty(), "Non-PDF files should not match");
    }

    /// Test no filter (match all)
    #[test]
    fn test_no_filter_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // All files should match
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "anything.csv");
        assert!(!targets.is_empty(), "All files should match");

        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/test.txt");
        assert!(!targets.is_empty(), "All files should match");
    }

    /// Test specific event type instead of compound
    #[test]
    fn test_specific_event_type_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:Put</Event>
        <Filter>
            <S3Key>
                <FilterRule>
                    <Name>prefix</Name>
                    <Value>uploads/</Value>
                </FilterRule>
                <FilterRule>
                    <Name>suffix</Name>
                    <Value>.csv</Value>
                </FilterRule>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // Debug: Print all events that have subscribers
        println!("\nAll events with subscribers:");
        for (event_name, _pattern_rules) in rules_map.inner().iter() {
            println!("  Event: {:?}", event_name);
        }

        // Note: has_subscriber uses bitmask logic, so has_subscriber(&ObjectCreatedAll) returns true
        // if any ObjectCreated* event is registered. This is intentional for efficiency.
        // Only ObjectCreatedPut was explicitly registered in the XML.

        // Should have subscriber for ObjectCreatedPut
        assert!(rules_map.has_subscriber(&EventName::ObjectCreatedPut));

        // Should NOT have subscriber for ObjectCreatedPost (only Put was configured)
        assert!(!rules_map.has_subscriber(&EventName::ObjectCreatedPost));

        // Test matching with Put event
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/test.csv");
        assert!(!targets.is_empty(), "Put event should match");
    }

    /// Test URL-encoded object keys
    #[test]
    fn test_url_encoded_keys() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRule>
                    <Name>prefix</Name>
                    <Value>uploads/</Value>
                </FilterRule>
                <FilterRule>
                    <Name>suffix</Name>
                    <Value>.csv</Value>
                </FilterRule>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // Test with URL-encoded space: "uploads/my%20file.csv"
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/my%20file.csv");
        // This may or may not match depending on encoding
        println!("URL-encoded key 'uploads/my%20file.csv' matched: {}", !targets.is_empty());

        // Test with unencoded version
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/my file.csv");
        assert!(!targets.is_empty(), "Unencoded key should match");
    }

    /// Test multiple queue configurations
    #[test]
    fn test_multiple_queue_configs_xml() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>csv-queue</Id>
        <Queue>arn:rustfs:sqs::primary:webhook-csv</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRule>
                    <Name>prefix</Name>
                    <Value>uploads/</Value>
                </FilterRule>
                <FilterRule>
                    <Name>suffix</Name>
                    <Value>.csv</Value>
                </FilterRule>
            </S3Key>
        </Filter>
    </QueueConfiguration>
    <QueueConfiguration>
        <Id>jpg-queue</Id>
        <Queue>arn:rustfs:sqs::primary:webhook-jpg</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRuleList>
                    <FilterRule>
                        <Name>prefix</Name>
                        <Value>images/</Value>
                    </FilterRule>
                    <FilterRule>
                        <Name>suffix</Name>
                        <Value>.jpg</Value>
                    </FilterRule>
                </FilterRuleList>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec![
            "arn:rustfs:sqs:ap-northeast-1:primary:webhook-csv".to_string(),
            "arn:rustfs:sqs:ap-northeast-1:primary:webhook-jpg".to_string(),
        ];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // Test CSV files
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "uploads/test.csv");
        println!("Targets for 'uploads/test.csv': {:?}", targets);
        assert!(!targets.is_empty(), "CSV files should match");
        // Should have csv target (ARN: arn:rustfs:sqs::primary:webhook-csv)
        let csv_target = TargetID::new("primary".to_string(), "webhook-csv".to_string());
        assert!(targets.contains(&csv_target), "Should find CSV webhook, got: {:?}", targets);

        // Test JPG files
        let targets = rules_map.match_rules(EventName::ObjectCreatedPut, "images/photo.jpg");
        assert!(!targets.is_empty(), "JPG files should match");
        // Should have jpg target (ARN: arn:rustfs:sqs:primary:webhook-jpg)
        let jpg_target = TargetID::new("primary".to_string(), "webhook-jpg".to_string());
        assert!(targets.contains(&jpg_target), "Should find JPG webhook");
    }

    /// Test compound event type expansion
    #[test]
    fn test_compound_event_expansion_integration() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<NotificationConfiguration>
    <QueueConfiguration>
        <Id>test-queue</Id>
        <Queue>arn:rustfs:sqs:ap-northeast-1:primary:webhook</Queue>
        <Event>s3:ObjectCreated:*</Event>
        <Filter>
            <S3Key>
                <FilterRuleList>
                    <FilterRule>
                        <Name>prefix</Name>
                        <Value>data/</Value>
                    </FilterRule>
                </FilterRuleList>
            </S3Key>
        </Filter>
    </QueueConfiguration>
</NotificationConfiguration>"#;

        let current_region = "ap-northeast-1";
        let arn_list = vec!["arn:rustfs:sqs:ap-northeast-1:primary:webhook".to_string()];

        let config = BucketNotificationConfig::from_xml(Cursor::new(xml.as_bytes()), current_region, &arn_list).unwrap();

        let rules_map = config.get_rules_map();

        // AWS ObjectCreated:* should only include object creation operations.
        let event_types = [
            EventName::ObjectCreatedPut,
            EventName::ObjectCreatedPost,
            EventName::ObjectCreatedCopy,
            EventName::ObjectCreatedCompleteMultipartUpload,
        ];

        for event_type in event_types {
            assert!(rules_map.has_subscriber(&event_type), "Event {:?} should have subscribers", event_type);

            // All should match "data/file.csv"
            let targets = rules_map.match_rules(event_type, "data/file.csv");
            assert!(!targets.is_empty(), "Event {:?} should match", event_type);
        }

        assert!(!rules_map.has_subscriber(&EventName::ObjectTaggingPut));
        assert!(!rules_map.has_subscriber(&EventName::ObjectTaggingDelete));
    }
}