libsql 0.9.18

The libSQL database library
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
use super::*;
use crate::util::Socket;
use std::pin::Pin;
use std::sync::atomic::{AtomicBool, AtomicU32, Ordering};
use std::sync::Arc;
use std::task::{Context, Poll};
use std::time::Duration;
use tempfile::tempdir;
use tokio::io::{duplex, AsyncRead, AsyncWrite, DuplexStream};
use tower::Service;

#[tokio::test]
async fn test_sync_context_push_frame() {
    let server = MockServer::start();
    let temp_dir = tempdir().unwrap();
    let db_path = temp_dir.path().join("test.db");

    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    let frame = Bytes::from("test frame data");
    let mut sync_ctx = sync_ctx;

    // Push a frame and verify the response
    let durable_frame = sync_ctx.push_frames(frame, 1, 0, 1, None).await.unwrap();
    sync_ctx.write_metadata().await.unwrap();
    assert_eq!(durable_frame.max_frame_no, 0); // First frame should return max_frame_no = 0

    // Verify internal state was updated
    assert_eq!(sync_ctx.durable_frame_num(), 0);
    assert_eq!(sync_ctx.durable_generation(), 1);
    assert_eq!(server.frame_count(), 1);
}

#[tokio::test]
async fn test_sync_context_with_auth() {
    let server = MockServer::start();
    let temp_dir = tempdir().unwrap();
    let db_path = temp_dir.path().join("test.db");

    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        Some("test_token".to_string()),
        None,
    )
    .await
    .unwrap();

    let frame = Bytes::from("test frame with auth");
    let mut sync_ctx = sync_ctx;

    let durable_frame = sync_ctx.push_frames(frame, 1, 0, 1, None).await.unwrap();
    sync_ctx.write_metadata().await.unwrap();
    assert_eq!(durable_frame.max_frame_no, 0);
    assert_eq!(server.frame_count(), 1);
}

#[tokio::test]
async fn test_sync_context_multiple_frames() {
    let server = MockServer::start();
    let temp_dir = tempdir().unwrap();
    let db_path = temp_dir.path().join("test.db");

    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    let mut sync_ctx = sync_ctx;

    // Push multiple frames and verify incrementing frame numbers
    for i in 0..3 {
        let frame = Bytes::from(format!("frame data {}", i));
        let durable_frame = sync_ctx.push_frames(frame, 1, i, 1, None).await.unwrap();
        sync_ctx.write_metadata().await.unwrap();
        assert_eq!(durable_frame.max_frame_no, i);
        assert_eq!(sync_ctx.durable_frame_num(), i);
        assert_eq!(server.frame_count(), i + 1);
    }
}

#[tokio::test]
async fn test_sync_context_corrupted_metadata() {
    let server = MockServer::start();
    let temp_dir = tempdir().unwrap();
    let db_path = temp_dir.path().join("test.db");

    // Create initial sync context and push a frame
    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    let mut sync_ctx = sync_ctx;
    let frame = Bytes::from("test frame data");
    let durable_frame = sync_ctx.push_frames(frame, 1, 0, 1, None).await.unwrap();
    sync_ctx.write_metadata().await.unwrap();
    assert_eq!(durable_frame.max_frame_no, 0);
    assert_eq!(server.frame_count(), 1);

    // Update metadata path to use -info instead of .meta
    let metadata_path = format!("{}-info", db_path.to_str().unwrap());
    std::fs::write(&metadata_path, b"invalid json data").unwrap();

    // Create new sync context with corrupted metadata
    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    // Verify that the context was reset to default values
    assert_eq!(sync_ctx.durable_frame_num(), 0);
    assert_eq!(sync_ctx.durable_generation(), 0);
}

#[tokio::test]
async fn test_sync_restarts_with_lower_max_frame_no() {
    let _ = tracing_subscriber::fmt::try_init();

    let server = MockServer::start();
    let temp_dir = tempdir().unwrap();
    let db_path = temp_dir.path().join("test.db");

    // Create initial sync context and push a frame
    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    let mut sync_ctx = sync_ctx;
    let frame = Bytes::from("test frame data");
    let durable_frame = sync_ctx
        .push_frames(frame.clone(), 1, 0, 1, None)
        .await
        .unwrap();
    sync_ctx.write_metadata().await.unwrap();
    assert_eq!(durable_frame.max_frame_no, 0);
    assert_eq!(server.frame_count(), 1);

    // Bump the durable frame num so that the next time we call the
    // server we think we are further ahead than the database we are talking to is.
    sync_ctx.durable_frame_num += 3;
    sync_ctx.write_metadata().await.unwrap();

    // Create new sync context with corrupted metadata
    let mut sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    // Verify that the context was set to new fake values.
    assert_eq!(sync_ctx.durable_frame_num(), 3);
    assert_eq!(sync_ctx.durable_generation(), 1);

    let frame_no = sync_ctx.durable_frame_num() + 1;
    // This push should fail because we are ahead of the server and thus should get an invalid
    // frame no error.
    sync_ctx
        .push_frames(frame.clone(), 1, frame_no, 1, None)
        .await
        .unwrap_err();

    let frame_no = sync_ctx.durable_frame_num() + 1;
    // This then should work because when the last one failed it updated our state of the server
    // durable_frame_num and we should then start writing from there.
    sync_ctx
        .push_frames(frame, 1, frame_no, 1, None)
        .await
        .unwrap();
}

#[tokio::test]
async fn test_sync_context_retry_on_error() {
    // Pause time to control it manually
    tokio::time::pause();

    let server = MockServer::start();
    let temp_dir = tempdir().unwrap();
    let db_path = temp_dir.path().join("test.db");

    let sync_ctx = SyncContext::new(
        server.connector(),
        db_path.to_str().unwrap().to_string(),
        server.url(),
        None,
        None,
    )
    .await
    .unwrap();

    let mut sync_ctx = sync_ctx;
    let frame = Bytes::from("test frame data");

    // Set server to return errors
    server.return_error.store(true, Ordering::SeqCst);

    // First attempt should fail but retry
    let result = sync_ctx.push_frames(frame.clone(), 1, 0, 1, None).await;
    assert!(result.is_err());

    // Advance time to trigger retries faster
    tokio::time::advance(Duration::from_secs(2)).await;

    // Verify multiple requests were made (retries occurred)
    assert!(server.request_count() > 1);

    // Allow the server to succeed
    server.return_error.store(false, Ordering::SeqCst);

    // Next attempt should succeed
    let durable_frame = sync_ctx.push_frames(frame, 1, 0, 1, None).await.unwrap();
    sync_ctx.write_metadata().await.unwrap();
    assert_eq!(durable_frame.max_frame_no, 0);
    assert_eq!(server.frame_count(), 1);
}

#[test]
fn test_hash_verification() {
    let mut metadata = MetadataJson {
        hash: 0,
        version: 1,
        durable_frame_num: 100,
        generation: 5,
    };

    assert!(metadata.verify_hash().is_err());

    metadata.set_hash();

    assert!(metadata.verify_hash().is_ok());
}

#[test]
fn test_hash_tampering() {
    let mut metadata = MetadataJson {
        hash: 0,
        version: 1,
        durable_frame_num: 100,
        generation: 5,
    };

    // Create metadata with hash
    metadata.set_hash();

    // Tamper with a field
    metadata.version = 2;

    // Verify should fail
    assert!(metadata.verify_hash().is_err());

    metadata.version = 1;
    metadata.generation = 42;

    assert!(metadata.verify_hash().is_err());

    metadata.generation = 5;
    metadata.durable_frame_num = 42;

    assert!(metadata.verify_hash().is_err());

    metadata.durable_frame_num = 100;

    assert!(metadata.verify_hash().is_ok());
}

// Mock connector service that implements tower::Service
#[derive(Clone)]
struct MockConnector {
    tx: tokio::sync::mpsc::Sender<DuplexStream>,
}

impl Service<http::Uri> for MockConnector {
    type Response = Box<dyn Socket>;
    type Error = Box<dyn std::error::Error + Send + Sync>;
    type Future = Pin<
        Box<
            dyn std::future::Future<Output = std::result::Result<Self::Response, Self::Error>>
                + Send,
        >,
    >;

    fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<std::result::Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(&mut self, _: http::Uri) -> Self::Future {
        let (stream, server_stream) = duplex(1024);
        let _ = self.tx.try_send(server_stream);
        let conn = MockConnection { stream };
        Box::pin(std::future::ready(Ok(Box::new(conn) as Box<dyn Socket>)))
    }
}

struct MockServer {
    url: String,
    frame_count: Arc<AtomicU32>,
    connector: ConnectorService,
    return_error: Arc<AtomicBool>,
    request_count: Arc<AtomicU32>,
}

impl MockServer {
    fn start() -> Self {
        let frame_count = Arc::new(AtomicU32::new(0));
        let return_error = Arc::new(AtomicBool::new(false));
        let request_count = Arc::new(AtomicU32::new(0));

        // Create the mock connector with Some(client_stream)
        let (tx, mut rx) = tokio::sync::mpsc::channel(1);
        let mock_connector = MockConnector { tx };
        let connector = ConnectorService::new(mock_connector);

        let server = Self {
            url: "http://mock.server".to_string(),
            frame_count: frame_count.clone(),
            connector,
            return_error: return_error.clone(),
            request_count: request_count.clone(),
        };

        // Spawn the server handler
        let frame_count_clone = frame_count.clone();
        let return_error_clone = return_error.clone();
        let request_count_clone = request_count.clone();

        tokio::spawn(async move {
            while let Some(server_stream) = rx.recv().await {
                let frame_count_clone = frame_count_clone.clone();
                let return_error_clone = return_error_clone.clone();
                let request_count_clone = request_count_clone.clone();

                tokio::spawn(async move {
                    use hyper::server::conn::Http;
                    use hyper::service::service_fn;

                    let frame_count_clone = frame_count_clone.clone();
                    let return_error_clone = return_error_clone.clone();
                    let request_count_clone = request_count_clone.clone();
                    let service = service_fn(move |req: http::Request<Body>| {
                        let frame_count = frame_count_clone.clone();
                        let return_error = return_error_clone.clone();
                        let request_count = request_count_clone.clone();
                        async move {
                            request_count.fetch_add(1, Ordering::SeqCst);
                            if return_error.load(Ordering::SeqCst) {
                                return Ok::<_, hyper::Error>(
                                    http::Response::builder()
                                        .status(500)
                                        .body(Body::from("Internal Server Error"))
                                        .unwrap(),
                                );
                            }

                            let current_count = frame_count.fetch_add(1, Ordering::SeqCst);

                            if req.uri().path().contains("/sync/") {
                                // Return the max_frame_no that has been accepted
                                let response = serde_json::json!({
                                    "status": "ok",
                                    "generation": 1,
                                    "max_frame_no": current_count
                                });

                                Ok::<_, hyper::Error>(
                                    http::Response::builder()
                                        .status(200)
                                        .body(Body::from(response.to_string()))
                                        .unwrap(),
                                )
                            } else {
                                Ok(http::Response::builder()
                                    .status(404)
                                    .body(Body::empty())
                                    .unwrap())
                            }
                        }
                    });

                    if let Err(e) = Http::new().serve_connection(server_stream, service).await {
                        eprintln!("Error serving connection: {}", e);
                    }
                });
            }
        });

        server
    }

    fn connector(&self) -> ConnectorService {
        self.connector.clone()
    }

    fn url(&self) -> String {
        self.url.clone()
    }

    fn frame_count(&self) -> u32 {
        self.frame_count.load(Ordering::SeqCst)
    }

    fn request_count(&self) -> u32 {
        self.request_count.load(Ordering::SeqCst)
    }
}

// Mock connection that implements the Socket trait
struct MockConnection {
    stream: DuplexStream,
}

impl AsyncRead for MockConnection {
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut tokio::io::ReadBuf<'_>,
    ) -> Poll<std::io::Result<()>> {
        Pin::new(&mut self.stream).poll_read(cx, buf)
    }
}

impl AsyncWrite for MockConnection {
    fn poll_write(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<std::io::Result<usize>> {
        Pin::new(&mut self.stream).poll_write(cx, buf)
    }

    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<std::io::Result<()>> {
        Pin::new(&mut self.stream).poll_flush(cx)
    }

    fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<std::io::Result<()>> {
        Pin::new(&mut self.stream).poll_shutdown(cx)
    }
}

impl hyper::client::connect::Connection for MockConnection {
    fn connected(&self) -> hyper::client::connect::Connected {
        hyper::client::connect::Connected::new()
    }
}