kstone-client 0.1.0

gRPC client library for KeystoneDB remote access
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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
/// Integration tests for KeystoneDB client
///
/// These tests start a real server and connect with the client to test
/// end-to-end functionality.

use kstone_api::Database;
use kstone_client::{
    Client, RemoteQuery, RemoteScan, RemoteBatchGetRequest, RemoteBatchWriteRequest,
    RemoteTransactGetRequest, RemoteTransactWriteRequest, RemoteUpdate,
    RemoteExecuteStatementResponse
};
use kstone_core::Value;
use kstone_server::{KeystoneDbServer, KeystoneService};
use std::collections::HashMap;
use std::time::Duration;
use tempfile::TempDir;
use tokio::time::sleep;
use tonic::transport::Server;

/// Helper to start a test server in the background
async fn start_test_server() -> (TempDir, String, tokio::task::JoinHandle<()>) {
    use std::net::TcpListener;

    // Create database
    let dir = TempDir::new().unwrap();
    let db = Database::create(dir.path()).unwrap();
    let service = KeystoneService::new(db);

    // Find an available port by binding to port 0
    let listener = TcpListener::bind("127.0.0.1:0").unwrap();
    let port = listener.local_addr().unwrap().port();
    drop(listener); // Release the port for the server to use

    let addr_str = format!("127.0.0.1:{}", port);
    let client_addr = format!("http://{}", addr_str);

    // Spawn server in background
    let handle = tokio::spawn(async move {
        let addr = addr_str.parse().unwrap();
        Server::builder()
            .add_service(KeystoneDbServer::new(service))
            .serve(addr)
            .await
            .unwrap();
    });

    // Give server time to start
    sleep(Duration::from_millis(200)).await;

    (dir, client_addr, handle)
}

#[tokio::test]
async fn test_put_get_delete() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Create test item
    let mut item = HashMap::new();
    item.insert("name".to_string(), Value::S("Alice".to_string()));
    item.insert("age".to_string(), Value::N("30".to_string()));

    // Test put
    client.put(b"user#123", item.clone()).await.unwrap();

    // Test get
    let retrieved = client.get(b"user#123").await.unwrap();
    assert!(retrieved.is_some());
    let retrieved_item = retrieved.unwrap();
    assert_eq!(retrieved_item.get("name").unwrap(), &Value::S("Alice".to_string()));

    // Test delete
    client.delete(b"user#123").await.unwrap();

    // Verify deleted
    let after_delete = client.get(b"user#123").await.unwrap();
    assert!(after_delete.is_none());
}

#[tokio::test]
async fn test_put_get_with_sort_key() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    let mut item = HashMap::new();
    item.insert("name".to_string(), Value::S("Bob".to_string()));

    // Test put with sort key
    client.put_with_sk(b"org#1", b"user#456", item.clone()).await.unwrap();

    // Test get with sort key
    let retrieved = client.get_with_sk(b"org#1", b"user#456").await.unwrap();
    assert!(retrieved.is_some());

    // Test delete with sort key
    client.delete_with_sk(b"org#1", b"user#456").await.unwrap();

    let after_delete = client.get_with_sk(b"org#1", b"user#456").await.unwrap();
    assert!(after_delete.is_none());
}

#[tokio::test]
async fn test_query() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert test data
    for i in 1..=5 {
        let mut item = HashMap::new();
        item.insert("id".to_string(), Value::N(i.to_string()));
        client.put_with_sk(b"org#1", format!("user#{}", i).as_bytes(), item).await.unwrap();
    }

    // Query with begins_with
    let query = RemoteQuery::new(b"org#1")
        .sk_begins_with(b"user#")
        .limit(3);

    let response = client.query(query).await.unwrap();
    assert_eq!(response.count, 3);
    assert_eq!(response.items.len(), 3);
}

#[tokio::test]
async fn test_scan() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert test data
    for i in 1..=10 {
        let mut item = HashMap::new();
        item.insert("id".to_string(), Value::N(i.to_string()));
        client.put(format!("item#{}", i).as_bytes(), item).await.unwrap();
    }

    // Scan with limit
    let scan = RemoteScan::new()
        .limit(5);

    let response = client.scan(scan).await.unwrap();
    assert!(response.count <= 5);
}

#[tokio::test]
async fn test_batch_get() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert test data
    for i in 1..=3 {
        let mut item = HashMap::new();
        item.insert("id".to_string(), Value::N(i.to_string()));
        client.put(format!("batch#{}", i).as_bytes(), item).await.unwrap();
    }

    // Batch get
    let batch = RemoteBatchGetRequest::new()
        .add_key(b"batch#1")
        .add_key(b"batch#2")
        .add_key(b"batch#3");

    let response = client.batch_get(batch).await.unwrap();
    assert_eq!(response.count, 3);
}

#[tokio::test]
async fn test_batch_write() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Prepare items
    let mut item1 = HashMap::new();
    item1.insert("name".to_string(), Value::S("Item1".to_string()));

    let mut item2 = HashMap::new();
    item2.insert("name".to_string(), Value::S("Item2".to_string()));

    // Batch write
    let batch = RemoteBatchWriteRequest::new()
        .put(b"bw#1", item1)
        .put(b"bw#2", item2);

    let response = client.batch_write(batch).await.unwrap();
    assert!(response.success);

    // Verify items were written
    let item1_check = client.get(b"bw#1").await.unwrap();
    assert!(item1_check.is_some());
}

#[tokio::test]
async fn test_transact_get() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert test data
    let mut item1 = HashMap::new();
    item1.insert("name".to_string(), Value::S("Alice".to_string()));
    client.put(b"user#1", item1).await.unwrap();

    let mut item2 = HashMap::new();
    item2.insert("name".to_string(), Value::S("Bob".to_string()));
    client.put(b"user#2", item2).await.unwrap();

    // Transact get
    let request = RemoteTransactGetRequest::new()
        .get(b"user#1")
        .get(b"user#2")
        .get(b"user#999"); // Non-existent

    let response = client.transact_get(request).await.unwrap();

    // Verify results
    assert_eq!(response.items.len(), 3);
    assert!(response.items[0].is_some());
    assert!(response.items[1].is_some());
    assert!(response.items[2].is_none());
}

#[tokio::test]
async fn test_transact_write() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Prepare items
    let mut item1 = HashMap::new();
    item1.insert("balance".to_string(), Value::N("100".to_string()));

    let mut item2 = HashMap::new();
    item2.insert("balance".to_string(), Value::N("50".to_string()));

    // Transact write - transfer money between accounts
    let request = RemoteTransactWriteRequest::new()
        .put(b"account#1", item1)
        .put(b"account#2", item2);

    client.transact_write(request).await.unwrap();

    // Verify both items were written
    let acc1 = client.get(b"account#1").await.unwrap();
    assert!(acc1.is_some());

    let acc2 = client.get(b"account#2").await.unwrap();
    assert!(acc2.is_some());
}

#[tokio::test]
async fn test_update_operation() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert initial item
    let mut item = HashMap::new();
    item.insert("counter".to_string(), Value::N("0".to_string()));
    item.insert("name".to_string(), Value::S("Test".to_string()));
    client.put(b"item#1", item).await.unwrap();

    // Update - increment counter
    let update = RemoteUpdate::new(b"item#1")
        .expression("SET counter = counter + :inc")
        .value(":inc", Value::N("5".to_string()));

    let response = client.update(update).await.unwrap();

    // Verify update
    match response.item.get("counter").unwrap() {
        Value::N(n) => assert_eq!(n, "5"),
        _ => panic!("Expected number"),
    }
}

#[tokio::test]
async fn test_execute_statement_select() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert test data
    let mut item = HashMap::new();
    item.insert("name".to_string(), Value::S("Alice".to_string()));
    item.insert("age".to_string(), Value::N("30".to_string()));
    client.put(b"user#123", item).await.unwrap();

    // Execute SELECT statement
    let response = client
        .execute_statement("SELECT * FROM users WHERE pk = 'user#123'")
        .await
        .unwrap();

    // Verify response
    match response {
        RemoteExecuteStatementResponse::Select { items, count, .. } => {
            assert_eq!(count, 1);
            assert_eq!(items.len(), 1);
            assert_eq!(
                items[0].get("name").unwrap(),
                &Value::S("Alice".to_string())
            );
        }
        _ => panic!("Expected SELECT response"),
    }
}

#[tokio::test]
async fn test_execute_statement_insert() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Execute INSERT statement
    let response = client
        .execute_statement(
            "INSERT INTO users VALUE {'pk': 'user#456', 'name': 'Bob', 'age': 25}"
        )
        .await
        .unwrap();

    // Verify response
    match response {
        RemoteExecuteStatementResponse::Insert { success } => {
            assert!(success);
        }
        _ => panic!("Expected INSERT response"),
    }

    // Verify item was inserted
    let item = client.get(b"user#456").await.unwrap();
    assert!(item.is_some());
}

#[tokio::test]
async fn test_execute_statement_update() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert initial item
    let mut item = HashMap::new();
    item.insert("score".to_string(), Value::N("100".to_string()));
    client.put(b"game#1", item).await.unwrap();

    // Execute UPDATE statement
    let response = client
        .execute_statement("UPDATE games SET score = score + 50 WHERE pk = 'game#1'")
        .await
        .unwrap();

    // Verify response
    match response {
        RemoteExecuteStatementResponse::Update { item } => {
            match item.get("score").unwrap() {
                Value::N(n) => assert_eq!(n, "150"),
                _ => panic!("Expected number"),
            }
        }
        _ => panic!("Expected UPDATE response"),
    }
}

#[tokio::test]
async fn test_execute_statement_delete() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert item
    let mut item = HashMap::new();
    item.insert("temp".to_string(), Value::S("data".to_string()));
    client.put(b"temp#1", item).await.unwrap();

    // Execute DELETE statement
    let response = client
        .execute_statement("DELETE FROM items WHERE pk = 'temp#1'")
        .await
        .unwrap();

    // Verify response
    match response {
        RemoteExecuteStatementResponse::Delete { success } => {
            assert!(success);
        }
        _ => panic!("Expected DELETE response"),
    }

    // Verify item was deleted
    let item = client.get(b"temp#1").await.unwrap();
    assert!(item.is_none());
}

#[tokio::test]
async fn test_conditional_put_success() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // First put should succeed (name attribute doesn't exist yet)
    let mut item = HashMap::new();
    item.insert("name".to_string(), Value::S("Alice".to_string()));

    client
        .put_conditional(
            b"user#1",
            item.clone(),
            "attribute_not_exists(name)",
            HashMap::new(),
        )
        .await
        .unwrap();

    // Verify item was created
    let retrieved = client.get(b"user#1").await.unwrap();
    assert!(retrieved.is_some());
}

#[tokio::test]
async fn test_conditional_put_failure() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert initial item
    let mut item = HashMap::new();
    item.insert("name".to_string(), Value::S("Alice".to_string()));
    client.put(b"user#1", item.clone()).await.unwrap();

    // Second put should fail (name attribute already exists)
    let result = client
        .put_conditional(
            b"user#1",
            item,
            "attribute_not_exists(name)",
            HashMap::new(),
        )
        .await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_conditional_delete_success() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert item
    let mut item = HashMap::new();
    item.insert("status".to_string(), Value::S("active".to_string()));
    client.put(b"user#1", item).await.unwrap();

    // Delete with condition (should succeed)
    let mut values = HashMap::new();
    values.insert(":status".to_string(), Value::S("active".to_string()));

    client
        .delete_conditional(b"user#1", "status = :status", values)
        .await
        .unwrap();

    // Verify item was deleted
    let result = client.get(b"user#1").await.unwrap();
    assert!(result.is_none());
}

#[tokio::test]
async fn test_conditional_delete_failure() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert item
    let mut item = HashMap::new();
    item.insert("status".to_string(), Value::S("active".to_string()));
    client.put(b"user#1", item).await.unwrap();

    // Delete with wrong condition (should fail)
    let mut values = HashMap::new();
    values.insert(":status".to_string(), Value::S("inactive".to_string()));

    let result = client
        .delete_conditional(b"user#1", "status = :status", values)
        .await;

    assert!(result.is_err());

    // Verify item was NOT deleted
    let retrieved = client.get(b"user#1").await.unwrap();
    assert!(retrieved.is_some());
}

#[tokio::test]
async fn test_concurrent_clients() {
    let (_dir, addr, _handle) = start_test_server().await;

    // Spawn multiple clients concurrently
    let mut handles = vec![];

    for i in 0..5 {
        let addr_clone = addr.clone();
        let handle = tokio::spawn(async move {
            let mut client = Client::connect(addr_clone).await.unwrap();

            // Each client writes its own items
            for j in 0..10 {
                let key = format!("client{}#item{}", i, j);
                let mut item = HashMap::new();
                item.insert("client_id".to_string(), Value::N(i.to_string()));
                item.insert("item_id".to_string(), Value::N(j.to_string()));

                client.put(key.as_bytes(), item).await.unwrap();
            }

            // Read back and verify
            for j in 0..10 {
                let key = format!("client{}#item{}", i, j);
                let retrieved = client.get(key.as_bytes()).await.unwrap();
                assert!(retrieved.is_some());
            }
        });

        handles.push(handle);
    }

    // Wait for all clients to complete
    for handle in handles {
        handle.await.unwrap();
    }
}

#[tokio::test]
async fn test_concurrent_writes_same_key() {
    let (_dir, addr, _handle) = start_test_server().await;

    // Multiple clients writing to the same key
    let mut handles = vec![];

    for i in 0..10 {
        let addr_clone = addr.clone();
        let handle = tokio::spawn(async move {
            let mut client = Client::connect(addr_clone).await.unwrap();

            let mut item = HashMap::new();
            item.insert("counter".to_string(), Value::N(i.to_string()));

            client.put(b"shared#key", item).await.unwrap();
        });

        handles.push(handle);
    }

    // Wait for all writes
    for handle in handles {
        handle.await.unwrap();
    }

    // Verify the key exists (one of the writes succeeded)
    let mut client = Client::connect(addr).await.unwrap();
    let result = client.get(b"shared#key").await.unwrap();
    assert!(result.is_some());
}

#[tokio::test]
async fn test_connection_refused() {
    // Try to connect to non-existent server
    let result = Client::connect("http://127.0.0.1:9999").await;
    assert!(result.is_err());
}

#[tokio::test]
async fn test_get_nonexistent_item() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Get item that doesn't exist
    let result = client.get(b"nonexistent#key").await.unwrap();
    assert!(result.is_none());
}

#[tokio::test]
async fn test_query_nonexistent_partition() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Query partition that has no items
    let query = RemoteQuery::new(b"nonexistent#partition");
    let response = client.query(query).await.unwrap();

    assert_eq!(response.count, 0);
    assert_eq!(response.items.len(), 0);
}

#[tokio::test]
async fn test_invalid_partiql_statement() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Execute invalid SQL
    let result = client
        .execute_statement("INVALID SQL STATEMENT")
        .await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_update_nonexistent_item() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Try to update item that doesn't exist
    let update = RemoteUpdate::new(b"nonexistent#item")
        .expression("SET counter = counter + :inc")
        .value(":inc", Value::N("1".to_string()));

    let result = client.update(update).await;

    // Should fail because item doesn't exist
    assert!(result.is_err());
}

#[tokio::test]
async fn test_transact_get_with_missing_items() {
    let (_dir, addr, _handle) = start_test_server().await;
    let mut client = Client::connect(addr).await.unwrap();

    // Insert only one item
    let mut item = HashMap::new();
    item.insert("name".to_string(), Value::S("Alice".to_string()));
    client.put(b"user#1", item).await.unwrap();

    // Transact get with mix of existing and non-existing
    let request = RemoteTransactGetRequest::new()
        .get(b"user#1")
        .get(b"user#2")
        .get(b"user#3");

    let response = client.transact_get(request).await.unwrap();

    // Should get back 3 results, with 2 being None
    assert_eq!(response.items.len(), 3);
    assert!(response.items[0].is_some());
    assert!(response.items[1].is_none());
    assert!(response.items[2].is_none());
}