ydb 0.10.2

Crate contains generated low-level grpc code from YDB API protobuf, used as base for ydb crate
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
use super::*;
use super::{
    nearest_dc_balancer::{BalancerConfig, FallbackStrategy, NearestDCBalancer},
    random_balancer::RandomLoadBalancer,
    LoadBalancer, MockLoadBalancer, SharedLoadBalancer,
};
use crate::discovery::NodeInfo;
use crate::grpc_wrapper::raw_services::Service::Table;
use crate::waiter::WaiterImpl;
use crate::YdbResult;
use http::Uri;
use itertools::Itertools;
use mockall::predicate;
use nearest_dc_balancer::{BalancerState, NODES_PER_DC, PING_TIMEOUT_SECS};
use ntest::assert_true;
use num::One;
use std::borrow::Borrow;
use std::collections::HashMap;
use std::str::FromStr;
use std::sync::atomic::AtomicUsize;
use std::sync::atomic::Ordering::Relaxed;
use std::sync::{Arc, RwLock};
use std::time::Duration;
use tokio::net::TcpListener;
use tokio::sync::watch;
use tokio::time::timeout;
use tokio_util::sync::CancellationToken;
use tracing::trace;

#[test]
fn shared_load_balancer() -> YdbResult<()> {
    let endpoint_counter = Arc::new(AtomicUsize::new(0));
    let test_uri = Uri::from_str("http://test.com")?;

    let mut lb_mock = MockLoadBalancer::new();
    let endpoint_counter_mock = endpoint_counter.clone();
    let test_uri_mock = test_uri.clone();

    lb_mock.expect_endpoint().returning(move |_service| {
        endpoint_counter_mock.fetch_add(1, Relaxed);
        Ok(test_uri_mock.clone())
    });

    let s1 = SharedLoadBalancer::new_with_balancer(Box::new(lb_mock));

    #[allow(clippy::redundant_clone)]
    let s2 = s1.clone();

    assert_eq!(test_uri, s1.endpoint(Table)?);
    assert_eq!(test_uri, s2.endpoint(Table)?);
    assert_eq!(endpoint_counter.load(Relaxed), 2);
    Ok(())
}

#[tokio::test]
async fn update_load_balancer_test() -> YdbResult<()> {
    let original_discovery_state = Arc::new(DiscoveryState::default());
    let (sender, receiver) = tokio::sync::watch::channel(original_discovery_state.clone());

    let new_discovery_state = Arc::new(DiscoveryState::default().with_node_info(
        Table,
        NodeInfo::new(Uri::from_str("http://test.com").unwrap(), String::new()),
    ));

    let (first_update_sender, first_update_receiver) = tokio::sync::oneshot::channel();
    let (second_update_sender, second_update_receiver) = tokio::sync::oneshot::channel();
    let (updater_finished_sender, updater_finished_receiver) =
        tokio::sync::oneshot::channel::<()>();

    let mut first_update_sender = Some(first_update_sender);
    let mut second_update_sender = Some(second_update_sender);
    let mut lb_mock = MockLoadBalancer::new();
    lb_mock
        .expect_set_discovery_state()
        .with(predicate::eq(original_discovery_state.clone()))
        .times(1)
        .returning(move |_| {
            trace!("first set");
            first_update_sender.take().unwrap().send(()).unwrap();
            Ok(())
        });

    lb_mock
        .expect_set_discovery_state()
        .with(predicate::eq(new_discovery_state.clone()))
        .times(1)
        .returning(move |_| {
            trace!("second set");
            second_update_sender.take().unwrap().send(()).unwrap();
            Ok(())
        });

    let shared_lb = SharedLoadBalancer::new_with_balancer(Box::new(lb_mock));

    tokio::spawn(async move {
        trace!("updater start");
        update_load_balancer(shared_lb, receiver).await;
        trace!("updater finished");
        updater_finished_sender.send(()).unwrap();
    });

    tokio::spawn(async move {
        first_update_receiver.await.unwrap();
        sender.send(new_discovery_state).unwrap();
        second_update_receiver.await.unwrap();
        drop(sender);
    });

    tokio::select! {
        _ = updater_finished_receiver =>{}
        _ = tokio::time::sleep(Duration::from_secs(10)) => {
            panic!("test failed");
        }
    }
    // updater_finished_receiver.await.unwrap();
    Ok(())
}

#[test]
fn random_load_balancer() -> YdbResult<()> {
    let one = Uri::from_str("http://one:213")?;
    let two = Uri::from_str("http://two:213")?;
    let load_balancer = RandomLoadBalancer {
        discovery_state: Arc::new(
            DiscoveryState::default()
                .with_node_info(Table, NodeInfo::new(one.clone(), String::new()))
                .with_node_info(Table, NodeInfo::new(two.clone(), String::new())),
        ),
        waiter: Arc::new(WaiterImpl::new()),
    };

    let mut map = HashMap::new();
    map.insert(one.to_string(), 0);
    map.insert(two.to_string(), 0);

    for _ in 0..100 {
        let u = load_balancer.endpoint(Table)?;
        let val = *map.get_mut(u.to_string().as_str()).unwrap();
        map.insert(u.to_string(), val + 1);
    }

    assert_eq!(map.len(), 2);
    assert!(*map.get(one.to_string().as_str()).unwrap() > 30);
    assert!(*map.get(two.to_string().as_str()).unwrap() > 30);
    Ok(())
}

#[test]
fn split_by_location() -> YdbResult<()> {
    let (one, two, three, four, five) = (
        NodeInfo::new(Uri::from_str("http://one:213")?, "A".to_string()),
        NodeInfo::new(Uri::from_str("http://two:213")?, "A".to_string()),
        NodeInfo::new(Uri::from_str("http://three:213")?, "B".to_string()),
        NodeInfo::new(Uri::from_str("http://four:213")?, "B".to_string()),
        NodeInfo::new(Uri::from_str("http://five:213")?, "C".to_string()),
    );

    let nodes = vec![
        one.clone(),
        two.clone(),
        three.clone(),
        four.clone(),
        five.clone(),
    ];

    let splitted = NearestDCBalancer::split_endpoints_by_location(&nodes);
    assert_eq!(
        splitted,
        HashMap::from([
            ("A".to_string(), vec![&one, &two]),
            ("B".to_string(), vec![&three, &four]),
            ("C".to_string(), vec![&five]),
        ])
    );
    Ok(())
}

#[test]
fn choose_random_endpoints() -> YdbResult<()> {
    let (one, two, three, four, five, six, seven, eight, nine) = (
        NodeInfo::new(Uri::from_str("http://one:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://two:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://three:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://four:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://five:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://six:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://seven:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://eight:213")?, "C".to_string()),
        NodeInfo::new(Uri::from_str("http://nine:213")?, "C".to_string()),
    );

    let mut nodes_big = vec![
        &one, &two, &three, &four, &five, &six, &seven, &eight, &nine,
    ];

    let mut nodes_small = vec![&one, &two, &three];

    let random_subset_big = NearestDCBalancer::get_random_endpoints(&mut nodes_big);
    let random_subset_small = NearestDCBalancer::get_random_endpoints(&mut nodes_small);

    assert_eq!(random_subset_big.len(), NODES_PER_DC);
    assert_eq!(random_subset_small.len(), 3);

    Ok(())
}

#[test]
fn extract_addrs_and_map_them() -> YdbResult<()> {
    let one = NodeInfo::new(Uri::from_str("http://localhost:123")?, "C".to_string());
    let two = NodeInfo::new(Uri::from_str("http://localhost:321")?, "C".to_string());
    let nodes = vec![&one, &two];
    let map = NearestDCBalancer::addr_to_node(&nodes);

    assert_eq!(map.keys().len(), 4); // ipv4 + ipv6 on each
    assert_true!(map.keys().contains(&"127.0.0.1:123".to_string()));
    assert_true!(map.keys().contains(&"[::1]:123".to_string()));
    assert!(map["127.0.0.1:123"].eq(&one));
    assert!(map["127.0.0.1:123"].eq(map["[::1]:123"]));

    Ok(())
}

#[tokio::test]
async fn detect_fastest_addr_just_some() -> YdbResult<()> {
    let l1 = TcpListener::bind("127.0.0.1:0").await?;
    let l2 = TcpListener::bind("127.0.0.1:0").await?;
    let l3 = TcpListener::bind("127.0.0.1:0").await?;

    let l1_addr = l1.local_addr()?;
    let l2_addr = l2.local_addr()?;
    let l3_addr = l3.local_addr()?;

    println!("Listener №1 on: {l1_addr}");
    println!("Listener №2 on: {l2_addr}");
    println!("Listener №3 on: {l3_addr}");

    let nodes = [
        l1_addr.to_string(),
        l2_addr.to_string(),
        l3_addr.to_string(),
    ];

    for _ in 0..100 {
        let addr = NearestDCBalancer::find_fastest_address(
            nodes.iter().collect_vec(),
            Duration::from_secs(PING_TIMEOUT_SECS),
        )
        .await?;
        assert!(nodes.contains(&addr))
    }

    Ok(())
}

#[tokio::test]
async fn detect_fastest_addr_with_fault() -> YdbResult<()> {
    let l1 = TcpListener::bind("127.0.0.1:0").await?;
    let l2 = TcpListener::bind("127.0.0.1:0").await?;
    let l3 = TcpListener::bind("127.0.0.1:0").await?;

    let l1_addr = l1.local_addr()?;
    let l2_addr = l2.local_addr()?;
    let l3_addr = l3.local_addr()?;

    println!("Listener №1 on: {l1_addr}");
    println!("Listener №2 on: {l2_addr}");
    println!("Listener №3 on: {l3_addr}");

    let nodes = [
        l1_addr.to_string(),
        l2_addr.to_string(),
        l3_addr.to_string(),
    ];

    drop(l1);

    for _ in 0..100 {
        let addr = NearestDCBalancer::find_fastest_address(
            nodes.iter().collect_vec(),
            Duration::from_secs(PING_TIMEOUT_SECS),
        )
        .await?;
        assert!(nodes.contains(&addr) && addr != l1_addr.to_string())
    }

    Ok(())
}

#[tokio::test]
async fn detect_fastest_addr_one_alive() -> YdbResult<()> {
    let l1 = TcpListener::bind("127.0.0.1:0").await?;
    let l2 = TcpListener::bind("127.0.0.1:0").await?;
    let l3 = TcpListener::bind("127.0.0.1:0").await?;

    let l1_addr = l1.local_addr()?;
    let l2_addr = l2.local_addr()?;
    let l3_addr = l3.local_addr()?;

    println!("Listener №1 on: {l1_addr}");
    println!("Listener №2 on: {l2_addr}");
    println!("Listener №3 on: {l3_addr}");

    let nodes = [
        l1_addr.to_string(),
        l2_addr.to_string(),
        l3_addr.to_string(),
    ];

    drop(l1);
    drop(l2);

    for _ in 0..100 {
        let addr = NearestDCBalancer::find_fastest_address(
            nodes.iter().collect_vec(),
            Duration::from_secs(PING_TIMEOUT_SECS),
        )
        .await?;
        assert!(addr == l3_addr.to_string())
    }

    Ok(())
}

#[tokio::test]
async fn detect_fastest_addr_timeout() -> YdbResult<()> {
    let l1 = TcpListener::bind("127.0.0.1:0").await?;
    let l2 = TcpListener::bind("127.0.0.1:0").await?;
    let l3 = TcpListener::bind("127.0.0.1:0").await?;

    let l1_addr = l1.local_addr()?;
    let l2_addr = l2.local_addr()?;
    let l3_addr = l3.local_addr()?;

    println!("Listener №1 on: {l1_addr}");
    println!("Listener №2 on: {l2_addr}");
    println!("Listener №3 on: {l3_addr}");

    let nodes = [
        l1_addr.to_string(),
        l2_addr.to_string(),
        l3_addr.to_string(),
    ];

    drop(l1);
    drop(l2);
    drop(l3);

    let result =
        NearestDCBalancer::find_fastest_address(nodes.iter().collect_vec(), Duration::from_secs(3))
            .await;
    match result {
        Ok(_) => unreachable!(),
        Err(err) => {
            assert_eq!(
                err.to_string(),
                "Custom(\"timeout while detecting fastest address\")"
            );
        }
    }
    Ok(())
}

#[tokio::test]
async fn no_addr_timeout() -> YdbResult<()> {
    let result = NearestDCBalancer::find_fastest_address(Vec::new(), Duration::from_secs(3)).await;
    match result {
        Ok(_) => unreachable!(),
        Err(err) => {
            assert_eq!(
                err.to_string(),
                "Custom(\"timeout while detecting fastest address\")"
            );
        }
    }
    Ok(())
}

#[tokio::test]
async fn adjusting_dc() -> YdbResult<()> {
    let l1 = TcpListener::bind("127.0.0.1:0").await?;
    let l2 = TcpListener::bind("127.0.0.1:0").await?;
    let l3 = TcpListener::bind("127.0.0.1:0").await?;

    let l1_addr = l1.local_addr()?;
    let l2_addr = l2.local_addr()?;
    let l3_addr = l3.local_addr()?;

    println!("Listener №1 on: {l1_addr}");
    println!("Listener №2 on: {l2_addr}");
    println!("Listener №3 on: {l3_addr}");

    let discovery_state = Arc::new(DiscoveryState::default());
    let balancer_state = Arc::new(RwLock::new(BalancerState::default()));
    let balancer_state_updater = balancer_state.clone();
    let (state_sender, state_reciever) = watch::channel(discovery_state.clone());

    let ping_token = CancellationToken::new();
    let ping_token_clone = ping_token.clone();

    let waiter = Arc::new(WaiterImpl::new());
    let waiter_clone = waiter.clone();

    let updater = tokio::spawn(async move {
        NearestDCBalancer::adjust_local_dc(
            balancer_state_updater,
            state_reciever,
            ping_token_clone,
            waiter_clone,
        )
        .await
    });

    let updated_state = Arc::new(
        DiscoveryState::default()
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l1_addr.to_string().as_str()).unwrap(),
                    "A".to_string(),
                ),
            )
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l2_addr.to_string().as_str()).unwrap(),
                    "B".to_string(),
                ),
            )
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l2_addr.to_string().as_str()).unwrap(),
                    "C".to_string(),
                ),
            ),
    );
    assert!(balancer_state
        .read()
        .unwrap()
        .borrow()
        .preferred_endpoints
        .is_empty());
    let _ = state_sender.send(updated_state);
    tokio::time::sleep(Duration::from_secs(2)).await;
    assert_true!(timeout(Duration::from_secs(3), waiter.wait()).await.is_ok()); // should not wait
    assert!(
        balancer_state
            .read()
            .unwrap()
            .borrow()
            .preferred_endpoints
            .len()
            .is_one() // only one endpoint in each dc
    );
    let updated_state_next = Arc::new(
        DiscoveryState::default()
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l1_addr.to_string().as_str()).unwrap(),
                    "A".to_string(),
                ),
            )
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l2_addr.to_string().as_str()).unwrap(),
                    "A".to_string(),
                ),
            ),
    );
    let _ = state_sender.send(updated_state_next);
    tokio::time::sleep(Duration::from_secs(2)).await;
    assert_true!(timeout(Duration::from_secs(3), waiter.wait()).await.is_ok()); // should not wait
    assert!(
        balancer_state
            .read()
            .unwrap()
            .borrow()
            .preferred_endpoints
            .len()
            == 2 // both endpoints in same dc
    );
    ping_token.cancel(); // reciever stops wait for state change
    let _ = tokio::join!(updater); // should join
    Ok(())
}

#[tokio::test]
async fn nearest_dc_balancer_integration_with_error_fallback() -> YdbResult<()> {
    let balancer = NearestDCBalancer::new(BalancerConfig {
        fallback_strategy: FallbackStrategy::Error,
    })
    .unwrap();

    let sh = SharedLoadBalancer::new_with_balancer(Box::new(balancer));

    match sh.endpoint(Table) {
        Ok(_) => unreachable!(),
        Err(err) => assert_eq!(
            err.to_string(),
            "Custom(\"no available endpoints for service:table_service\")".to_string()
        ),
    }
    Ok(())
}

#[tokio::test]
async fn nearest_dc_balancer_integration_with_other_fallback_error() -> YdbResult<()> {
    let balancer = NearestDCBalancer::new(BalancerConfig::default()).unwrap();

    let sh = SharedLoadBalancer::new_with_balancer(Box::new(balancer));

    match sh.endpoint(Table) {
        Ok(_) => unreachable!(),
        Err(err) => assert_eq!(
            err.to_string(),
            "Custom(\"empty endpoint list for service: table_service\")".to_string()
        ),
    }
    Ok(())
}

#[tokio::test]
async fn nearest_dc_balancer_integration() -> YdbResult<()> {
    let l1 = TcpListener::bind("127.0.0.1:0").await?;
    let l2 = TcpListener::bind("127.0.0.1:0").await?;

    let l1_addr = l1.local_addr()?;
    let l2_addr = l2.local_addr()?;

    println!("Listener №1 on: {l1_addr}");
    println!("Listener №2 on: {l2_addr}");

    let balancer = NearestDCBalancer::new(BalancerConfig {
        fallback_strategy: FallbackStrategy::Error,
    })
    .unwrap();

    let sh = SharedLoadBalancer::new_with_balancer(Box::new(balancer));
    let self_updater = sh.clone();
    let (state_sender, state_reciever) =
        watch::channel::<Arc<DiscoveryState>>(Arc::new(DiscoveryState::default()));

    tokio::spawn(async move { update_load_balancer(self_updater, state_reciever).await });

    match sh.endpoint(Table) {
        Ok(_) => unreachable!(),
        Err(err) => assert_eq!(
            err.to_string(),
            "Custom(\"no available endpoints for service:table_service\")".to_string()
        ),
    }
    let updated_state = Arc::new(
        DiscoveryState::default()
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l1_addr.to_string().as_str()).unwrap(),
                    "A".to_string(),
                ),
            )
            .with_node_info(
                Table,
                NodeInfo::new(
                    Uri::from_str(l2_addr.to_string().as_str()).unwrap(),
                    "A".to_string(),
                ),
            ),
    );

    let _ = state_sender.send(updated_state);

    sh.wait().await?;

    match sh.endpoint(Table) {
        Ok(uri) => {
            let addr = uri.host().unwrap();
            assert!(addr == "127.0.0.1" || addr == "[::1]")
        }
        Err(err) => unreachable!("{}", err.to_string()),
    }
    Ok(())
}