ivoryvalley 0.3.0

A transparent deduplication proxy for Mastodon and the Fediverse
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
//! Integration tests for the WebSocket streaming functionality.
//!
//! These tests verify the end-to-end behavior of the WebSocket proxy.

mod common;

use axum::{
    extract::{
        ws::{Message, WebSocket, WebSocketUpgrade},
        State,
    },
    response::Response,
    routing::get,
    Router,
};
use common::create_temp_dir;
use futures_util::{SinkExt, StreamExt};
use ivoryvalley::{config::Config, db::SeenUriStore, proxy::create_proxy_router};
use std::net::SocketAddr;
use tokio::net::TcpListener;
use tokio_tungstenite::{connect_async, tungstenite};

/// Mock upstream WebSocket server state
#[derive(Clone)]
struct MockWsState {
    messages_to_send: std::sync::Arc<tokio::sync::Mutex<Vec<String>>>,
}

/// Mock upstream WebSocket server for testing
struct MockUpstreamWs {
    pub addr: SocketAddr,
    pub state: MockWsState,
    shutdown_tx: Option<tokio::sync::oneshot::Sender<()>>,
}

impl MockUpstreamWs {
    async fn start() -> Self {
        let state = MockWsState {
            messages_to_send: std::sync::Arc::new(tokio::sync::Mutex::new(Vec::new())),
        };

        let app = Router::new()
            .route("/api/v1/streaming", get(mock_ws_handler))
            .with_state(state.clone());

        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let addr = listener.local_addr().unwrap();

        let (shutdown_tx, shutdown_rx) = tokio::sync::oneshot::channel();

        tokio::spawn(async move {
            axum::serve(listener, app)
                .with_graceful_shutdown(async {
                    let _ = shutdown_rx.await;
                })
                .await
                .unwrap();
        });

        Self {
            addr,
            state,
            shutdown_tx: Some(shutdown_tx),
        }
    }

    fn url(&self) -> String {
        format!("http://{}", self.addr)
    }

    /// Queue a message to be sent to clients
    async fn queue_message(&self, msg: String) {
        self.state.messages_to_send.lock().await.push(msg);
    }
}

impl Drop for MockUpstreamWs {
    fn drop(&mut self) {
        if let Some(tx) = self.shutdown_tx.take() {
            let _ = tx.send(());
        }
    }
}

/// Mock WebSocket handler that echoes messages and sends queued messages
async fn mock_ws_handler(ws: WebSocketUpgrade, State(state): State<MockWsState>) -> Response {
    ws.on_upgrade(move |socket| handle_mock_ws(socket, state))
}

async fn handle_mock_ws(socket: WebSocket, state: MockWsState) {
    let (mut sender, mut receiver) = socket.split();

    // Send any queued messages, draining to avoid cloning
    let messages = {
        let mut locked = state.messages_to_send.lock().await;
        std::mem::take(&mut *locked)
    };
    for msg in messages {
        if sender.send(Message::Text(msg.into())).await.is_err() {
            return;
        }
    }

    // Echo received messages back
    while let Some(msg) = receiver.next().await {
        if let Ok(msg) = msg {
            match msg {
                Message::Text(text) => {
                    if sender
                        .send(Message::Text(format!("echo: {}", text).into()))
                        .await
                        .is_err()
                    {
                        break;
                    }
                }
                Message::Close(_) => break,
                _ => {}
            }
        } else {
            break;
        }
    }
}

/// Helper to create a WebSocket client connection to the proxy
async fn connect_to_proxy(
    proxy_url: &str,
) -> (
    futures_util::stream::SplitSink<
        tokio_tungstenite::WebSocketStream<
            tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>,
        >,
        tungstenite::Message,
    >,
    futures_util::stream::SplitStream<
        tokio_tungstenite::WebSocketStream<
            tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>,
        >,
    >,
) {
    let ws_url = format!(
        "{}/api/v1/streaming?access_token=test_token",
        proxy_url.replace("http://", "ws://")
    );
    let (ws_stream, _) = connect_async(&ws_url).await.expect("Failed to connect");
    ws_stream.split()
}

/// Test that WebSocket upgrade succeeds
#[tokio::test]
async fn test_websocket_upgrade_succeeds() {
    let upstream = MockUpstreamWs::start().await;
    let temp_dir = create_temp_dir();
    let db_path = temp_dir.path().join("test.db");
    let config = Config::new(&upstream.url(), "0.0.0.0", 0, db_path);
    let seen_store = SeenUriStore::open(":memory:").unwrap();
    let app = create_proxy_router(config, std::sync::Arc::new(seen_store));

    // Start the proxy server
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let proxy_addr = listener.local_addr().unwrap();
    let proxy_url = format!("http://{}", proxy_addr);

    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    // Give the server time to start
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Connect to the proxy
    let (mut _sink, mut stream) = connect_to_proxy(&proxy_url).await;

    // Connection should be established - try to receive a message or close gracefully
    tokio::select! {
        _ = tokio::time::sleep(tokio::time::Duration::from_secs(1)) => {
            // Connection stayed open for 1 second - success
        }
        msg = stream.next() => {
            // Received a message or close - also success
            assert!(msg.is_some());
        }
    }
}

/// Test bidirectional message relay
#[tokio::test]
async fn test_bidirectional_message_relay() {
    let upstream = MockUpstreamWs::start().await;
    let temp_dir = create_temp_dir();
    let db_path = temp_dir.path().join("test.db");
    let config = Config::new(&upstream.url(), "0.0.0.0", 0, db_path);
    let seen_store = SeenUriStore::open(":memory:").unwrap();
    let app = create_proxy_router(config, std::sync::Arc::new(seen_store));

    // Start the proxy server
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let proxy_addr = listener.local_addr().unwrap();
    let proxy_url = format!("http://{}", proxy_addr);

    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    // Give the server time to start
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Connect to the proxy
    let (mut sink, mut stream) = connect_to_proxy(&proxy_url).await;

    // Send a message to upstream (through proxy)
    sink.send(tungstenite::Message::Text("hello".into()))
        .await
        .expect("Failed to send message");

    // Receive echo response
    let response = tokio::time::timeout(tokio::time::Duration::from_secs(2), stream.next())
        .await
        .expect("Timeout waiting for response")
        .expect("Stream ended")
        .expect("Error receiving message");

    if let tungstenite::Message::Text(text) = response {
        assert_eq!(text, "echo: hello");
    } else {
        panic!("Expected text message, got {:?}", response);
    }
}

/// Test that upstream messages are relayed to client
#[tokio::test]
async fn test_upstream_to_client_relay() {
    let upstream = MockUpstreamWs::start().await;

    // Queue a message to be sent from upstream
    upstream
        .queue_message(r#"{"event":"notification","payload":"test"}"#.to_string())
        .await;

    let temp_dir = create_temp_dir();
    let db_path = temp_dir.path().join("test.db");
    let config = Config::new(&upstream.url(), "0.0.0.0", 0, db_path);
    let seen_store = SeenUriStore::open(":memory:").unwrap();
    let app = create_proxy_router(config, std::sync::Arc::new(seen_store));

    // Start the proxy server
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let proxy_addr = listener.local_addr().unwrap();
    let proxy_url = format!("http://{}", proxy_addr);

    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    // Give the server time to start
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Connect to the proxy
    let (_sink, mut stream) = connect_to_proxy(&proxy_url).await;

    // Receive the queued message
    let response = tokio::time::timeout(tokio::time::Duration::from_secs(2), stream.next())
        .await
        .expect("Timeout waiting for response")
        .expect("Stream ended")
        .expect("Error receiving message");

    if let tungstenite::Message::Text(text) = response {
        assert!(text.contains("notification"));
        assert!(text.contains("test"));
    } else {
        panic!("Expected text message, got {:?}", response);
    }
}

/// Test that deduplication works through WebSocket connection
#[tokio::test]
async fn test_websocket_deduplication() {
    let upstream = MockUpstreamWs::start().await;

    // Queue two identical update events
    // Using a helper to create the event JSON for better readability
    let create_status_event = || {
        let payload = serde_json::json!({
            "id": "123",
            "uri": "https://example.com/status/123"
        })
        .to_string();
        serde_json::json!({
            "event": "update",
            "payload": payload
        })
        .to_string()
    };

    upstream.queue_message(create_status_event()).await;
    upstream.queue_message(create_status_event()).await;

    let temp_dir = create_temp_dir();
    let db_path = temp_dir.path().join("test.db");
    let config = Config::new(&upstream.url(), "0.0.0.0", 0, db_path);
    let seen_store = SeenUriStore::open(":memory:").unwrap();
    let app = create_proxy_router(config, std::sync::Arc::new(seen_store));

    // Start the proxy server
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let proxy_addr = listener.local_addr().unwrap();
    let proxy_url = format!("http://{}", proxy_addr);

    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    // Give the server time to start
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Connect to the proxy
    let (_sink, mut stream) = connect_to_proxy(&proxy_url).await;

    // Receive the first message (should pass through)
    let first_msg = tokio::time::timeout(tokio::time::Duration::from_secs(2), stream.next())
        .await
        .expect("Timeout waiting for first message")
        .expect("Stream ended")
        .expect("Error receiving first message");

    assert!(
        matches!(first_msg, tungstenite::Message::Text(_)),
        "Expected text message"
    );

    // Try to receive second message - should timeout because it was filtered
    let second_msg =
        tokio::time::timeout(tokio::time::Duration::from_millis(500), stream.next()).await;

    // The second message should have been filtered, so we expect a timeout
    assert!(
        second_msg.is_err(),
        "Second duplicate message should have been filtered out"
    );
}

/// Test connection close handling
#[tokio::test]
async fn test_websocket_close_handling() {
    let upstream = MockUpstreamWs::start().await;
    let temp_dir = create_temp_dir();
    let db_path = temp_dir.path().join("test.db");
    let config = Config::new(&upstream.url(), "0.0.0.0", 0, db_path);
    let seen_store = SeenUriStore::open(":memory:").unwrap();
    let app = create_proxy_router(config, std::sync::Arc::new(seen_store));

    // Start the proxy server
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let proxy_addr = listener.local_addr().unwrap();
    let proxy_url = format!("http://{}", proxy_addr);

    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    // Give the server time to start
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Connect to the proxy
    let (mut sink, mut stream) = connect_to_proxy(&proxy_url).await;

    // Send close message
    sink.send(tungstenite::Message::Close(None))
        .await
        .expect("Failed to send close");

    // Should receive close confirmation or stream should end
    let response = tokio::time::timeout(tokio::time::Duration::from_secs(2), stream.next()).await;

    match response {
        Ok(Some(Ok(tungstenite::Message::Close(_)))) => {
            // Received close frame - success
        }
        Ok(None) => {
            // Stream ended - also success
        }
        _ => panic!("Expected close frame or stream end, got {:?}", response),
    }
}

// =============================================================================
// Legitimate message tests (Issue #20)
// These tests verify that deduplication doesn't drop valid content.
// =============================================================================

/// Test that different statuses via WebSocket are NOT deduplicated.
/// Each status has a unique URI, so both should pass through.
#[tokio::test]
async fn test_websocket_different_statuses_not_deduplicated() {
    let upstream = MockUpstreamWs::start().await;

    // Queue two different update events with unique URIs
    let status1 = serde_json::json!({
        "id": "1",
        "uri": "https://example.com/status/1",
        "content": "<p>First post</p>"
    })
    .to_string();
    let event1 = serde_json::json!({
        "event": "update",
        "payload": status1
    })
    .to_string();

    let status2 = serde_json::json!({
        "id": "2",
        "uri": "https://example.com/status/2",
        "content": "<p>Second post</p>"
    })
    .to_string();
    let event2 = serde_json::json!({
        "event": "update",
        "payload": status2
    })
    .to_string();

    upstream.queue_message(event1).await;
    upstream.queue_message(event2).await;

    let temp_dir = create_temp_dir();
    let db_path = temp_dir.path().join("test.db");
    let config = Config::new(&upstream.url(), "0.0.0.0", 0, db_path);
    let seen_store = SeenUriStore::open(":memory:").unwrap();
    let app = create_proxy_router(config, std::sync::Arc::new(seen_store));

    // Start the proxy server
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let proxy_addr = listener.local_addr().unwrap();
    let proxy_url = format!("http://{}", proxy_addr);

    tokio::spawn(async move {
        axum::serve(listener, app).await.unwrap();
    });

    // Give the server time to start
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

    // Connect to the proxy
    let (_sink, mut stream) = connect_to_proxy(&proxy_url).await;

    // Receive the first message (should pass through)
    let first_msg = tokio::time::timeout(tokio::time::Duration::from_secs(2), stream.next())
        .await
        .expect("Timeout waiting for first message")
        .expect("Stream ended")
        .expect("Error receiving first message");

    assert!(
        matches!(first_msg, tungstenite::Message::Text(_)),
        "Expected text message for first status"
    );

    // Receive the second message (should also pass through - different URI)
    let second_msg = tokio::time::timeout(tokio::time::Duration::from_secs(2), stream.next())
        .await
        .expect("Timeout waiting for second message")
        .expect("Stream ended")
        .expect("Error receiving second message");

    assert!(
        matches!(second_msg, tungstenite::Message::Text(_)),
        "Expected text message for second status - both unique statuses should pass through"
    );
}