rs3gw 0.2.1

High-Performance AI/HPC Object Storage Gateway powered by scirs2-io
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
//! WebSocket Streaming for Real-Time Event Delivery
//!
//! This module provides WebSocket support for streaming S3 events in real-time,
//! enabling clients to receive notifications about object changes, uploads, deletes, etc.
//!
//! # Features
//! - Live object change notifications
//! - Streaming S3 Select results
//! - Connection multiplexing
//! - Automatic reconnection with exponential backoff
//! - Event filtering by bucket/prefix
//! - JSON-based event format

use axum::{
    extract::{
        ws::{Message, WebSocket, WebSocketUpgrade},
        Query, State,
    },
    response::IntoResponse,
};
use futures::{SinkExt, StreamExt};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use tokio::sync::broadcast;
use tracing::{debug, error, info, warn};

use crate::AppState;

/// Maximum number of events to buffer per WebSocket connection
const MAX_EVENT_BUFFER: usize = 1000;

/// WebSocket query parameters for event filtering
#[derive(Debug, Deserialize, Default)]
pub struct WebSocketQuery {
    /// Filter events by bucket name
    pub bucket: Option<String>,
    /// Filter events by object key prefix
    pub prefix: Option<String>,
    /// Event types to subscribe to (comma-separated)
    pub events: Option<String>,
}

/// S3 event types that can be streamed via WebSocket
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum S3EventType {
    /// Object created (PUT, POST, COPY)
    ObjectCreated,
    /// Object deleted
    ObjectRemoved,
    /// Object metadata changed
    ObjectMetadataChanged,
    /// Object accessed (GET)
    ObjectAccessed,
    /// Multipart upload initiated
    MultipartUploadCreated,
    /// Multipart upload completed
    MultipartUploadCompleted,
    /// Multipart upload aborted
    MultipartUploadAborted,
    /// Bucket created
    BucketCreated,
    /// Bucket deleted
    BucketRemoved,
    /// Bucket policy changed
    BucketPolicyChanged,
    /// Bucket tagging changed
    BucketTaggingChanged,
}

impl S3EventType {
    /// Parse event types from comma-separated string
    pub fn parse_list(events_str: &str) -> Vec<S3EventType> {
        events_str
            .split(',')
            .filter_map(|s| match s.trim() {
                "object-created" => Some(S3EventType::ObjectCreated),
                "object-removed" => Some(S3EventType::ObjectRemoved),
                "object-metadata-changed" => Some(S3EventType::ObjectMetadataChanged),
                "object-accessed" => Some(S3EventType::ObjectAccessed),
                "multipart-upload-created" => Some(S3EventType::MultipartUploadCreated),
                "multipart-upload-completed" => Some(S3EventType::MultipartUploadCompleted),
                "multipart-upload-aborted" => Some(S3EventType::MultipartUploadAborted),
                "bucket-created" => Some(S3EventType::BucketCreated),
                "bucket-removed" => Some(S3EventType::BucketRemoved),
                "bucket-policy-changed" => Some(S3EventType::BucketPolicyChanged),
                "bucket-tagging-changed" => Some(S3EventType::BucketTaggingChanged),
                _ => None,
            })
            .collect()
    }
}

/// S3 event notification sent via WebSocket
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct S3Event {
    /// Event ID (unique identifier)
    pub event_id: String,
    /// Event type
    pub event_type: S3EventType,
    /// Event timestamp (RFC3339)
    pub event_time: String,
    /// Bucket name
    pub bucket: String,
    /// Object key (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Object size in bytes (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub size: Option<u64>,
    /// Object ETag (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub etag: Option<String>,
    /// Additional metadata
    #[serde(skip_serializing_if = "HashMap::is_empty")]
    pub metadata: HashMap<String, String>,
}

impl S3Event {
    /// Create a new S3 event
    pub fn new(event_type: S3EventType, bucket: String) -> Self {
        Self {
            event_id: uuid::Uuid::new_v4().to_string(),
            event_type,
            event_time: chrono::Utc::now().to_rfc3339(),
            bucket,
            key: None,
            size: None,
            etag: None,
            metadata: HashMap::new(),
        }
    }

    /// Set object key
    pub fn with_key(mut self, key: String) -> Self {
        self.key = Some(key);
        self
    }

    /// Set object size
    pub fn with_size(mut self, size: u64) -> Self {
        self.size = Some(size);
        self
    }

    /// Set object ETag
    pub fn with_etag(mut self, etag: String) -> Self {
        self.etag = Some(etag);
        self
    }

    /// Add metadata entry
    pub fn with_metadata(mut self, key: String, value: String) -> Self {
        self.metadata.insert(key, value);
        self
    }

    /// Check if event matches filter criteria
    pub fn matches_filter(
        &self,
        bucket_filter: &Option<String>,
        prefix_filter: &Option<String>,
    ) -> bool {
        // Check bucket filter
        if let Some(bucket) = bucket_filter {
            if &self.bucket != bucket {
                return false;
            }
        }

        // Check prefix filter
        if let Some(prefix) = prefix_filter {
            if let Some(key) = &self.key {
                if !key.starts_with(prefix) {
                    return false;
                }
            } else {
                // Event has no key, can't match prefix
                return false;
            }
        }

        true
    }
}

/// WebSocket event broadcaster
#[derive(Clone)]
pub struct EventBroadcaster {
    sender: broadcast::Sender<S3Event>,
}

impl EventBroadcaster {
    /// Create a new event broadcaster
    pub fn new() -> Self {
        let (sender, _) = broadcast::channel(MAX_EVENT_BUFFER);
        Self { sender }
    }

    /// Broadcast an event to all subscribers
    pub fn broadcast(&self, event: S3Event) {
        // Ignore send errors (happens when no subscribers)
        let _ = self.sender.send(event);
    }

    /// Subscribe to events
    pub fn subscribe(&self) -> broadcast::Receiver<S3Event> {
        self.sender.subscribe()
    }
}

impl Default for EventBroadcaster {
    fn default() -> Self {
        Self::new()
    }
}

/// WebSocket connection handler
pub async fn ws_handler(
    ws: WebSocketUpgrade,
    Query(params): Query<WebSocketQuery>,
    State(state): State<AppState>,
) -> impl IntoResponse {
    debug!(
        "WebSocket connection request - bucket: {:?}, prefix: {:?}, events: {:?}",
        params.bucket, params.prefix, params.events
    );

    ws.on_upgrade(move |socket| handle_socket(socket, params, state))
}

/// Handle a WebSocket connection
async fn handle_socket(socket: WebSocket, params: WebSocketQuery, state: AppState) {
    let (mut sender, mut receiver) = socket.split();

    // Parse event filter
    let event_filter = params
        .events
        .as_ref()
        .map(|e| S3EventType::parse_list(e))
        .unwrap_or_default();

    // Subscribe to event stream
    let mut event_rx = state.event_broadcaster.subscribe();

    // Send welcome message
    let welcome = serde_json::json!({
        "type": "welcome",
        "message": "Connected to rs3gw WebSocket event stream",
        "filters": {
            "bucket": params.bucket,
            "prefix": params.prefix,
            "events": event_filter,
        }
    });

    if let Ok(msg) = serde_json::to_string(&welcome) {
        if sender.send(Message::Text(msg.into())).await.is_err() {
            error!("Failed to send welcome message");
            return;
        }
    }

    info!("WebSocket connection established");

    // Spawn task to forward events to WebSocket
    let mut send_task = tokio::spawn(async move {
        while let Ok(event) = event_rx.recv().await {
            // Apply filters
            if !event.matches_filter(&params.bucket, &params.prefix) {
                continue;
            }

            if !event_filter.is_empty() && !event_filter.contains(&event.event_type) {
                continue;
            }

            // Serialize and send event
            match serde_json::to_string(&event) {
                Ok(json) => {
                    if sender.send(Message::Text(json.into())).await.is_err() {
                        warn!("WebSocket send failed, closing connection");
                        break;
                    }
                }
                Err(e) => {
                    error!("Failed to serialize event: {}", e);
                }
            }
        }
    });

    // Handle incoming messages (ping/pong, close, etc.)
    let mut recv_task = tokio::spawn(async move {
        while let Some(msg) = receiver.next().await {
            match msg {
                Ok(Message::Ping(_data)) => {
                    debug!("Received ping");
                    // Pong is handled automatically by axum
                }
                Ok(Message::Pong(_)) => {
                    debug!("Received pong");
                }
                Ok(Message::Close(_)) => {
                    debug!("WebSocket close received");
                    break;
                }
                Ok(Message::Text(text)) => {
                    debug!("Received text message: {}", text);
                    // Could handle client commands here
                }
                Err(e) => {
                    error!("WebSocket error: {}", e);
                    break;
                }
                _ => {}
            }
        }
    });

    // Wait for either task to finish
    tokio::select! {
        _ = &mut send_task => {
            recv_task.abort();
        },
        _ = &mut recv_task => {
            send_task.abort();
        },
    }

    info!("WebSocket connection closed");
}

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

    #[test]
    fn test_event_type_parsing() {
        let events = S3EventType::parse_list("object-created,object-removed,bucket-created");
        assert_eq!(events.len(), 3);
        assert!(events.contains(&S3EventType::ObjectCreated));
        assert!(events.contains(&S3EventType::ObjectRemoved));
        assert!(events.contains(&S3EventType::BucketCreated));
    }

    #[test]
    fn test_event_creation() {
        let event = S3Event::new(S3EventType::ObjectCreated, "test-bucket".to_string())
            .with_key("test/object.txt".to_string())
            .with_size(1024)
            .with_etag("abc123".to_string())
            .with_metadata("custom".to_string(), "value".to_string());

        assert_eq!(event.event_type, S3EventType::ObjectCreated);
        assert_eq!(event.bucket, "test-bucket");
        assert_eq!(event.key, Some("test/object.txt".to_string()));
        assert_eq!(event.size, Some(1024));
        assert_eq!(event.etag, Some("abc123".to_string()));
        assert_eq!(event.metadata.get("custom"), Some(&"value".to_string()));
    }

    #[test]
    fn test_event_filtering() {
        let event = S3Event::new(S3EventType::ObjectCreated, "my-bucket".to_string())
            .with_key("data/file.txt".to_string());

        // Test bucket filter
        assert!(event.matches_filter(&Some("my-bucket".to_string()), &None));
        assert!(!event.matches_filter(&Some("other-bucket".to_string()), &None));

        // Test prefix filter
        assert!(event.matches_filter(&None, &Some("data/".to_string())));
        assert!(!event.matches_filter(&None, &Some("logs/".to_string())));

        // Test combined filters
        assert!(event.matches_filter(&Some("my-bucket".to_string()), &Some("data/".to_string())));
        assert!(!event.matches_filter(&Some("my-bucket".to_string()), &Some("logs/".to_string())));
    }

    #[test]
    fn test_event_serialization() {
        let event = S3Event::new(S3EventType::ObjectCreated, "test-bucket".to_string())
            .with_key("test.txt".to_string())
            .with_size(100);

        let json = serde_json::to_string(&event).expect("Failed to serialize");
        assert!(json.contains("object-created"));
        assert!(json.contains("test-bucket"));
        assert!(json.contains("test.txt"));
    }

    #[tokio::test]
    async fn test_event_broadcaster() {
        let broadcaster = EventBroadcaster::new();
        let mut rx1 = broadcaster.subscribe();
        let mut rx2 = broadcaster.subscribe();

        let event = S3Event::new(S3EventType::ObjectCreated, "test-bucket".to_string());
        broadcaster.broadcast(event.clone());

        // Both subscribers should receive the event
        let received1 = rx1.recv().await.expect("Failed to receive");
        let received2 = rx2.recv().await.expect("Failed to receive");

        assert_eq!(received1.event_id, event.event_id);
        assert_eq!(received2.event_id, event.event_id);
    }
}