clayers-repo 0.2.0

Content-addressed Merkle DAG repository for XML documents
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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
//! WebSocket transport implementation.
//!
//! Uses internal channels so the transport can be used from any runtime/thread.
//! All actual WS IO happens on background tasks spawned during `connect()`.

use std::collections::HashSet;
use std::net::SocketAddr;
use std::sync::Arc;

use async_trait::async_trait;
use futures_util::{SinkExt, StreamExt};
use tokio::net::TcpListener;
use tokio::sync::{Mutex, mpsc};
use tokio::task::{AbortHandle, JoinHandle};
use tokio_tungstenite::tungstenite::Message;

use super::codec::Codec;
use super::server::{RepositoryProvider, Server};
use super::transport::Transport;
use super::{ClientMessage, ServerMessage};
use crate::error::{Error, Result};

/// WebSocket transport for the client side.
///
/// Internally uses channels to decouple from the runtime that created the socket.
/// Background tasks handle the actual WS reads and writes.
pub struct WsTransport<C: Codec = super::JsonCodec> {
    outgoing: mpsc::UnboundedSender<ClientMessage>,
    incoming: Mutex<mpsc::UnboundedReceiver<ServerMessage>>,
    #[allow(dead_code)]
    codec: C,
    _writer_abort: AbortHandle,
    _reader_abort: AbortHandle,
}

impl<C: Codec> WsTransport<C> {
    /// Connect to a WebSocket server.
    ///
    /// Spawns background reader and writer tasks on the current tokio runtime.
    /// The returned transport can be used from any thread or runtime.
    ///
    /// # Errors
    ///
    /// Returns an error if the connection or handshake fails.
    pub async fn connect(
        url: &str,
        codec: C,
        auth: Option<&dyn WsRequestTransformer>,
    ) -> Result<Self> {
        let (ws_stream, _) = if let Some(transformer) = auth {
            // Build a request with auth headers applied
            let req = http::Request::builder()
                .uri(url)
                .header("Host", url_host(url))
                .header("Connection", "Upgrade")
                .header("Upgrade", "websocket")
                .header("Sec-WebSocket-Version", "13")
                .header(
                    "Sec-WebSocket-Key",
                    tokio_tungstenite::tungstenite::handshake::client::generate_key(),
                )
                .body(())
                .map_err(|e| Error::Storage(e.to_string()))?;
            let req = transformer.transform(req);
            tokio_tungstenite::connect_async(req)
                .await
                .map_err(|e| Error::Storage(e.to_string()))?
        } else {
            tokio_tungstenite::connect_async(url)
                .await
                .map_err(|e| Error::Storage(e.to_string()))?
        };

        let (mut ws_write, mut ws_read) = ws_stream.split();

        // Outgoing channel: client sends ClientMessage -> writer task encodes and sends over WS
        let (out_tx, mut out_rx) = mpsc::unbounded_channel::<ClientMessage>();
        let codec_w = codec.clone();
        let writer = tokio::spawn(async move {
            while let Some(msg) = out_rx.recv().await {
                if let Ok(bytes) = codec_w.encode(&msg)
                    && ws_write.send(Message::Binary(bytes.into())).await.is_err()
                {
                    break;
                }
            }
        });

        // Incoming channel: reader task reads from WS, decodes, sends ServerMessage
        let (in_tx, in_rx) = mpsc::unbounded_channel::<ServerMessage>();
        let codec_r = codec.clone();
        let reader = tokio::spawn(async move {
            while let Some(Ok(msg)) = ws_read.next().await {
                let bytes = match &msg {
                    Message::Binary(b) => &b[..],
                    Message::Text(t) => t.as_bytes(),
                    Message::Close(_) => break,
                    _ => continue,
                };
                if let Ok(server_msg) = codec_r.decode::<ServerMessage>(bytes)
                    && in_tx.send(server_msg).is_err()
                {
                    break;
                }
            }
        });

        Ok(Self {
            outgoing: out_tx,
            incoming: Mutex::new(in_rx),
            codec,
            _writer_abort: writer.abort_handle(),
            _reader_abort: reader.abort_handle(),
        })
    }
}

#[async_trait]
impl<C: Codec> Transport for WsTransport<C> {
    async fn send(&self, msg: ClientMessage) -> Result<()> {
        self.outgoing
            .send(msg)
            .map_err(|_| Error::Storage("connection closed".into()))
    }

    async fn recv(&self) -> Result<ServerMessage> {
        let mut rx = self.incoming.lock().await;
        rx.recv()
            .await
            .ok_or_else(|| Error::Storage("connection closed".into()))
    }
}

/// Transforms an HTTP request before the WebSocket handshake (client-side).
pub trait WsRequestTransformer: Send + Sync {
    /// Transform the HTTP upgrade request (e.g., add auth headers).
    fn transform(&self, req: http::Request<()>) -> http::Request<()>;
}

/// Validates an HTTP request during the WebSocket handshake (server-side).
pub trait WsRequestValidator: Send + Sync {
    /// Validate the HTTP upgrade request. Return `Err(reason)` to reject.
    ///
    /// # Errors
    ///
    /// Returns an error string if the request is invalid.
    fn validate(&self, req: &http::Request<()>) -> std::result::Result<(), String>;
}

/// Bearer token authentication for WebSocket connections.
///
/// Implements both `WsRequestTransformer` (client) and `WsRequestValidator` (server).
pub struct BearerToken(pub String);

impl WsRequestTransformer for BearerToken {
    fn transform(&self, req: http::Request<()>) -> http::Request<()> {
        let (mut parts, body) = req.into_parts();
        parts.headers.insert(
            http::header::AUTHORIZATION,
            http::HeaderValue::from_str(&format!("Bearer {}", self.0))
                .expect("valid header value"),
        );
        http::Request::from_parts(parts, body)
    }
}

impl WsRequestValidator for BearerToken {
    fn validate(&self, req: &http::Request<()>) -> std::result::Result<(), String> {
        let auth = req
            .headers()
            .get(http::header::AUTHORIZATION)
            .and_then(|v| v.to_str().ok())
            .ok_or_else(|| "missing Authorization header".to_string())?;
        let expected = format!("Bearer {}", self.0);
        if auth == expected {
            Ok(())
        } else {
            Err("invalid bearer token".to_string())
        }
    }
}

/// Extract the host:port from a `ws://` or `wss://` URL.
fn url_host(url: &str) -> String {
    let without_scheme = url
        .strip_prefix("ws://")
        .or_else(|| url.strip_prefix("wss://"))
        .unwrap_or(url);
    without_scheme.split('/').next().unwrap_or(url).to_string()
}

/// Start a WebSocket server that dispatches to a [`RepositoryProvider`].
///
/// Returns a join handle for the server task and the bound address.
///
/// # Errors
///
/// Returns an error if binding the TCP listener fails.
pub async fn serve_ws<P: RepositoryProvider + 'static, C: Codec>(
    addr: &str,
    provider: P,
    validator: Option<Box<dyn WsRequestValidator>>,
    codec: C,
) -> Result<(JoinHandle<()>, SocketAddr)> {
    let listener = TcpListener::bind(addr)
        .await
        .map_err(|e| Error::Storage(e.to_string()))?;
    let local_addr = listener
        .local_addr()
        .map_err(|e| Error::Storage(e.to_string()))?;

    let server = Arc::new(Server::new(provider));
    let validator: Option<Arc<dyn WsRequestValidator>> = validator.map(Arc::from);

    let handle = tokio::spawn(async move {
        loop {
            let Ok((stream, _)) = listener.accept().await else {
                continue;
            };

            let server = Arc::clone(&server);
            let codec = codec.clone();
            let validator = validator.clone();

            tokio::spawn(async move {
                #[allow(clippy::result_large_err)]
                fn reject_connection(
                    req: &http::Request<()>,
                    resp: http::Response<()>,
                    validator: &dyn WsRequestValidator,
                ) -> std::result::Result<http::Response<()>, http::Response<Option<String>>> {
                    match validator.validate(req) {
                        Ok(()) => Ok(resp),
                        Err(reason) => Err(http::Response::builder()
                            .status(http::StatusCode::UNAUTHORIZED)
                            .body(Some(reason))
                            .expect("building reject response")),
                    }
                }

                let ws_stream = if let Some(ref v) = validator {
                    let v = Arc::clone(v);
                    #[allow(clippy::result_large_err)]
                    let cb = move |req: &http::Request<()>, resp: http::Response<()>| {
                        reject_connection(req, resp, v.as_ref())
                    };
                    match tokio_tungstenite::accept_hdr_async(stream, cb)
                    .await
                    {
                        Ok(ws) => ws,
                        Err(_) => return,
                    }
                } else {
                    let Ok(ws) = tokio_tungstenite::accept_async(stream).await else {
                        return;
                    };
                    ws
                };

                let (conn_id, mut notify_rx) = server.register_connection().await;
                let (mut write, mut read) = ws_stream.split();

                let (out_tx, mut out_rx) = mpsc::unbounded_channel::<ServerMessage>();
                let codec_write = codec.clone();

                // Writer task: merge handler responses and notifications
                let write_handle = tokio::spawn(async move {
                    loop {
                        tokio::select! {
                            Some(msg) = out_rx.recv() => {
                                if let Ok(bytes) = codec_write.encode(&msg)
                                    && write.send(Message::Binary(bytes.into())).await.is_err()
                                {
                                    break;
                                }
                            }
                            Some(notif) = notify_rx.recv() => {
                                if let Ok(bytes) = codec_write.encode(&notif)
                                    && write.send(Message::Binary(bytes.into())).await.is_err()
                                {
                                    break;
                                }
                            }
                            else => break,
                        }
                    }
                });

                // Reader loop: dispatch messages to the server handler
                while let Some(Ok(msg)) = read.next().await {
                    let bytes = match &msg {
                        Message::Binary(b) => &b[..],
                        Message::Text(t) => t.as_bytes(),
                        Message::Close(_) => break,
                        _ => continue,
                    };

                    let Ok(client_msg) = codec.decode::<ClientMessage>(bytes) else {
                        continue;
                    };

                    let responses = server.handle(conn_id, client_msg).await;
                    for resp in responses {
                        if out_tx.send(resp).is_err() {
                            break;
                        }
                    }
                }

                // Cleanup
                write_handle.abort();
                server.disconnect(conn_id).await;
            });
        }
    });

    Ok((handle, local_addr))
}

/// Validates bearer tokens against a mutable set (supports hot-reload).
///
/// Wraps `Arc<RwLock<HashSet<String>>>` so cloning shares the same token set.
/// Use `update_tokens` to swap the set during config hot-reload.
#[derive(Clone)]
pub struct MultiTokenValidator {
    /// Exposed for the server to clone into `serve_ws`.
    pub tokens: Arc<tokio::sync::RwLock<HashSet<String>>>,
}

impl MultiTokenValidator {
    /// Create a new validator from an initial set of tokens.
    #[must_use]
    pub fn new(tokens: HashSet<String>) -> Self {
        Self {
            tokens: Arc::new(tokio::sync::RwLock::new(tokens)),
        }
    }

    /// Replace the token set (called during hot-reload).
    pub async fn update_tokens(&self, tokens: HashSet<String>) {
        *self.tokens.write().await = tokens;
    }
}

impl WsRequestValidator for MultiTokenValidator {
    fn validate(&self, req: &http::Request<()>) -> std::result::Result<(), String> {
        let auth = req
            .headers()
            .get(http::header::AUTHORIZATION)
            .and_then(|v| v.to_str().ok())
            .ok_or_else(|| "missing Authorization header".to_string())?;
        let token = auth
            .strip_prefix("Bearer ")
            .ok_or_else(|| "invalid Authorization format".to_string())?;
        // Use try_read to avoid async in a sync trait method.
        // If the lock is held by a writer (hot-reload), reject transiently.
        let guard = self
            .tokens
            .try_read()
            .map_err(|_| "server reloading, retry".to_string())?;
        if guard.contains(token) {
            Ok(())
        } else {
            Err("invalid token".to_string())
        }
    }
}

#[cfg(test)]
mod tests {
    use std::net::SocketAddr;
    use std::sync::OnceLock;
    use std::sync::atomic::{AtomicU64, Ordering};

    use async_trait::async_trait;
    use tokio::sync::Mutex;

    use super::super::codec::JsonCodec;
    use super::super::server::RepositoryProvider;
    use super::super::transport::Store;
    use super::*;
    use crate::store::memory::MemoryStore;

    /// Repository provider that creates a fresh `MemoryStore` per repo name.
    struct DynamicTestProvider {
        repos: Arc<Mutex<std::collections::HashMap<String, Arc<MemoryStore>>>>,
    }

    impl Default for DynamicTestProvider {
        fn default() -> Self {
            Self {
                repos: Arc::new(Mutex::new(std::collections::HashMap::new())),
            }
        }
    }

    #[async_trait]
    impl RepositoryProvider for DynamicTestProvider {
        async fn list(&self) -> crate::error::Result<Vec<String>> {
            Ok(self.repos.lock().await.keys().cloned().collect())
        }

        async fn get(&self, name: &str) -> crate::error::Result<Arc<dyn Store>> {
            let mut repos = self.repos.lock().await;
            Ok(repos
                .entry(name.to_string())
                .or_insert_with(|| Arc::new(MemoryStore::new()))
                .clone())
        }
    }

    // Shared multi-thread runtime for all WS IO (server + client connections).
    // Using a single runtime avoids spawning thousands of threads for proptests.
    static TEST_RT: OnceLock<tokio::runtime::Runtime> = OnceLock::new();
    static SERVER_ADDR: OnceLock<SocketAddr> = OnceLock::new();
    static REPO_COUNTER: AtomicU64 = AtomicU64::new(0);

    fn test_runtime() -> &'static tokio::runtime::Runtime {
        TEST_RT.get_or_init(|| {
            tokio::runtime::Builder::new_multi_thread()
                .worker_threads(2)
                .enable_all()
                .build()
                .unwrap()
        })
    }

    fn shared_server_addr() -> SocketAddr {
        *SERVER_ADDR.get_or_init(|| {
            let rt = test_runtime();
            let (addr_tx, addr_rx) = std::sync::mpsc::channel();
            rt.spawn(async move {
                let provider = DynamicTestProvider::default();
                let (_, addr) = serve_ws("127.0.0.1:0", provider, None, JsonCodec)
                    .await
                    .unwrap();
                let _ = addr_tx.send(addr);
            });
            addr_rx.recv().unwrap()
        })
    }

    fn create_remote_store() -> super::super::RemoteStore<WsTransport<JsonCodec>> {
        let addr = shared_server_addr();
        let repo = format!("test-{}", REPO_COUNTER.fetch_add(1, Ordering::Relaxed));

        // Create the WS connection on the shared runtime (where the IO driver lives).
        // The returned WsTransport uses channels internally, so it can be used from
        // any thread/runtime.
        let (store_tx, store_rx) = std::sync::mpsc::channel();
        test_runtime().spawn(async move {
            let transport = WsTransport::connect(&format!("ws://{addr}"), JsonCodec, None)
                .await
                .unwrap();
            // RemoteStore::new spawns a reader task on the current runtime (shared).
            let store = super::super::RemoteStore::new(transport, &repo);
            let _ = store_tx.send(store);
        });
        store_rx.recv().unwrap()
    }

    #[tokio::test]
    async fn ref_updated_broadcast_to_other_client() {
        use crate::store::RefStore;
        let addr = shared_server_addr();
        let repo_name = format!(
            "notify-{}",
            REPO_COUNTER.fetch_add(1, Ordering::Relaxed)
        );

        // Client A and Client B connect to the same repo.
        let (store_a_tx, store_a_rx) = std::sync::mpsc::channel();
        let (store_b_tx, store_b_rx) = std::sync::mpsc::channel();
        let repo_a = repo_name.clone();
        let repo_b = repo_name.clone();

        test_runtime().spawn(async move {
            let t = WsTransport::connect(&format!("ws://{addr}"), JsonCodec, None)
                .await
                .unwrap();
            let s = super::super::RemoteStore::new(t, &repo_a);
            let _ = store_a_tx.send(s);
        });
        test_runtime().spawn(async move {
            let t = WsTransport::connect(&format!("ws://{addr}"), JsonCodec, None)
                .await
                .unwrap();
            let s = super::super::RemoteStore::new(t, &repo_b);
            let _ = store_b_tx.send(s);
        });

        let client_a = store_a_rx.recv().unwrap();
        let client_b = store_b_rx.recv().unwrap();

        // Client A sets a ref.
        let hash = clayers_xml::ContentHash::from_canonical(b"test-ref-updated");
        client_a.set_ref("refs/heads/main", hash).await.unwrap();

        // Client B should receive a RefUpdated notification.
        let notification = tokio::time::timeout(
            std::time::Duration::from_secs(2),
            client_b.recv_notification(),
        )
        .await
        .expect("timed out waiting for RefUpdated")
        .expect("connection closed");

        match notification {
            super::super::ServerMessage::RefUpdated {
                name, new, ..
            } => {
                assert_eq!(name, "refs/heads/main");
                assert_eq!(new, Some(hash));
            }
            other => panic!("expected RefUpdated, got {other:?}"),
        }
    }

    mod remote_tests {
        use super::create_remote_store;
        crate::store::tests::store_tests!(create_remote_store());
    }

    mod remote_prop_tests {
        use super::create_remote_store;
        crate::store::prop_tests::prop_store_tests!(create_remote_store());
    }
}