ydb 0.17.1

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
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
use std::collections::HashSet;
use std::future;
use std::str::FromStr;
use std::sync::{Arc, Weak};
use std::time::{Duration, Instant};

use async_trait::async_trait;
use futures_util::StreamExt;
use futures_util::stream::{self, BoxStream};
use http::Uri;
use http::uri::Authority;
use itertools::Itertools;
use tokio::sync::watch;
use tokio_stream::wrappers::WatchStream;
use tracing::{instrument, trace, warn};

use crate::YdbError;
use crate::errors::{NeedRetry, YdbResult};
use crate::grpc_connection_manager::DiscoveryConnectionManager;
use crate::grpc_wrapper::{
    raw_discovery_client::{EndpointInfo, GrpcDiscoveryClient},
    raw_services::Service,
};
use crate::retry::{IndefiniteRetrier, Retry, RetryParams};
use crate::waiter::Waiter;

/// Current discovery state
#[derive(Clone, Debug, PartialEq)]
pub struct DiscoveryState {
    pub(crate) timestamp: std::time::Instant,
    nodes: Vec<NodeInfo>,

    pessimized_nodes: HashSet<Uri>,
    original_nodes: Vec<NodeInfo>,
}

impl DiscoveryState {
    pub(crate) fn new(timestamp: std::time::Instant, nodes: Vec<NodeInfo>) -> Self {
        let mut state = DiscoveryState {
            timestamp,
            nodes: Vec::new(),
            pessimized_nodes: HashSet::new(),
            original_nodes: nodes,
        };
        state.build_services();
        state
    }

    fn build_services(&mut self) {
        self.nodes.clear();

        for origin_node in self.original_nodes.iter() {
            if !self.pessimized_nodes.contains(&origin_node.uri) {
                self.nodes.push(origin_node.clone())
            }
        }

        // if all nodes pessimized - use full nodes set
        if self.nodes.is_empty() {
            self.nodes.clone_from(&self.original_nodes)
        }
    }

    pub(crate) fn get_nodes(&self, _service: &Service) -> Option<&[NodeInfo]> {
        Some(&self.nodes)
    }

    pub(crate) fn get_all_nodes(&self) -> Option<&[NodeInfo]> {
        Some(&self.nodes)
    }

    pub(crate) fn is_empty(&self) -> bool {
        self.nodes.len() == 0
    }

    fn is_pessimized(&self, uri: &Uri) -> bool {
        self.pessimized_nodes.contains(uri)
    }

    // pessimize return true if state was changed
    pub(crate) fn pessimize(&mut self, uri: &Uri) -> bool {
        if self.is_pessimized(uri) {
            return false;
        };

        self.pessimized_nodes.insert(uri.clone());
        self.build_services();
        true
    }

    // TODO: uncomment if need in read code or remove test
    #[cfg(test)]
    pub(crate) fn with_node_info(mut self, _service: Service, node_info: NodeInfo) -> Self {
        if !self.nodes.contains(&node_info) {
            self.nodes.push(node_info);
        }
        self
    }
}

impl Default for DiscoveryState {
    fn default() -> Self {
        DiscoveryState::new(std::time::Instant::now(), Vec::default())
    }
}

#[derive(Clone, Debug, PartialEq)]
pub(crate) struct NodeInfo {
    pub(crate) uri: Uri,
    pub(crate) location: String,
}

impl NodeInfo {
    pub(crate) fn new(uri: Uri, location: String) -> Self {
        Self { uri, location }
    }
}

/// Discovery YDB endpoints
#[async_trait]
pub trait Discovery: Send + Sync + Waiter {
    /// Pessimizes an endpoint.
    ///
    /// Pessimizations are reset after rediscovery.
    fn pessimization(&self, uri: &Uri);

    /// Subscribes to discovery changes.
    fn subscribe(&self) -> BoxStream<'static, Arc<DiscoveryState>>;

    /// Tries to get the current discovery state.
    ///
    /// Return `None` if the discovery state is not initialized yet.
    ///
    /// Guaranteed to always return `Some(_)` from the moment
    /// `Self::wait` has been called successfully.
    fn try_state(&self) -> Option<Arc<DiscoveryState>>;

    /// Returns the current discovery state.
    async fn state(&self) -> Arc<DiscoveryState>;
}

/// Always discovery once static node
///
/// Not used in prod, but may be good for tests
pub struct StaticDiscovery {
    discovery_state: Arc<DiscoveryState>,
}

/// Stub discovery pointed to one endpoint for all services.
///
/// Example:
/// ```no_run
/// # use ydb::{ClientBuilder, StaticDiscovery, YdbResult};
///
/// # fn main()->YdbResult<()>{
/// let discovery = StaticDiscovery::new_from_str("grpc://localhost:2136")?;
/// let client = ClientBuilder::new_from_connection_string("grpc://localhost:2136/local")?.with_discovery(discovery).client()?;
/// # return Ok(());
/// # }
/// ```
impl StaticDiscovery {
    pub fn new_from_str<'a, T: Into<&'a str>>(endpoint: T) -> YdbResult<Self> {
        let endpoint = Uri::from_str(endpoint.into())?;
        let nodes = vec![NodeInfo::new(endpoint, String::new())];

        let state = DiscoveryState::new(std::time::Instant::now(), nodes);
        let state = Arc::new(state);
        Ok(StaticDiscovery {
            discovery_state: state,
        })
    }
}

#[async_trait]
impl Discovery for StaticDiscovery {
    fn pessimization(&self, _uri: &Uri) {
        // pass
    }

    fn subscribe(&self) -> BoxStream<'static, Arc<DiscoveryState>> {
        stream::empty().boxed()
    }

    fn try_state(&self) -> Option<Arc<DiscoveryState>> {
        Some(self.discovery_state.clone())
    }

    async fn state(&self) -> Arc<DiscoveryState> {
        self.discovery_state.clone()
    }
}

#[async_trait]
impl Waiter for StaticDiscovery {
    async fn wait(&self) -> YdbResult<()> {
        Ok(())
    }
}

#[derive(Clone)]
pub(crate) struct TimerDiscovery {
    state: Arc<DiscoverySharedState>,
}

impl TimerDiscovery {
    pub(crate) fn new(
        connection_manager: DiscoveryConnectionManager,
        endpoint: &str,
        interval: Duration,
        token_waiter: impl Waiter + 'static,
    ) -> YdbResult<Self> {
        let state = Arc::new(DiscoverySharedState::new(connection_manager, endpoint)?);

        let state_weak = Arc::downgrade(&state);
        tokio::spawn(DiscoverySharedState::background_discovery(
            state_weak,
            interval,
            token_waiter,
        ));

        Ok(TimerDiscovery { state })
    }
}

#[async_trait]
impl Discovery for TimerDiscovery {
    fn pessimization(&self, uri: &Uri) {
        self.state.pessimization(uri);

        // check if need force discovery
        let Some(Ok(state)) = &*self.state.state_sender.borrow() else {
            return;
        };

        let pessimized_nodes_count = state
            .original_nodes
            .iter()
            .filter(|node| state.pessimized_nodes.contains(&node.uri))
            .count();
        if pessimized_nodes_count > 0 && pessimized_nodes_count >= state.original_nodes.len() / 2 {
            let shared_state_for_discovery = Arc::downgrade(&self.state);
            tokio::spawn(async move {
                if let Some(state) = shared_state_for_discovery.upgrade() {
                    let _ = state.discovery_now().await;
                }
            });
        }
    }

    fn subscribe(&self) -> BoxStream<'static, Arc<DiscoveryState>> {
        self.state.subscribe()
    }

    fn try_state(&self) -> Option<Arc<DiscoveryState>> {
        self.state.try_state()
    }

    async fn state(&self) -> Arc<DiscoveryState> {
        self.state.state().await
    }
}

#[async_trait::async_trait]
impl Waiter for TimerDiscovery {
    async fn wait(&self) -> YdbResult<()> {
        self.state.wait().await
    }
}

#[derive(Debug)]
struct DiscoverySharedState {
    connection_manager: DiscoveryConnectionManager,
    discovery_uri: Uri,

    discovery_lock: tokio::sync::Mutex<()>,

    /// Watch sender for the discovery state changes.
    ///
    /// Initially contains `None`. Contains `Some(Err(err))` if
    /// the first discovery has failed with a non-retriable
    /// error and has not been successfully
    /// retried yet, where `err` is the last non-retriable error
    /// received from the first discovery retries.
    ///
    /// After the first discovery successfully finishes,
    /// the value is always `Some(Ok(state))`, where `state`
    /// is the last successfully received discovery state.
    ///
    /// The discovery will always be retried, regardless of whether
    /// the received error was retriable.
    state_sender: watch::Sender<Option<YdbResult<Arc<DiscoveryState>>>>,
}

impl DiscoverySharedState {
    fn new(connection_manager: DiscoveryConnectionManager, endpoint: &str) -> YdbResult<Self> {
        let (state_sender, _) = watch::channel(None);
        Ok(Self {
            connection_manager,
            discovery_uri: http::Uri::from_str(endpoint)?,
            state_sender,
            discovery_lock: tokio::sync::Mutex::new(()),
        })
    }

    #[tracing::instrument(name = "ydb.Discovery.DiscoveryNow", skip_all, err)]
    async fn discovery_now(&self) -> YdbResult<()> {
        let lock = self.discovery_lock.lock().await;

        let discovery_result = self.discovery_now_impl().await.map(Arc::new);

        let result = discovery_result
            .as_ref()
            .map(|_| ())
            .map_err(YdbError::clone);

        self.state_sender
            .send_if_modified(move |state| match (&state, &discovery_result) {
                (_, Err(err)) if err.need_retry() != NeedRetry::False => false,
                (Some(_), Err(_)) => false,
                (None, _) | (Some(_), Ok(_)) => {
                    *state = Some(discovery_result);
                    true
                }
            });

        drop(lock);

        result
    }

    #[tracing::instrument(skip(self))]
    async fn discovery_now_impl(&self) -> YdbResult<DiscoveryState> {
        trace!("creating grpc client");
        let start = std::time::Instant::now();
        let mut discovery_client = self
            .connection_manager
            .get_auth_service_to_node(GrpcDiscoveryClient::new, &self.discovery_uri)
            .await?;

        let res = discovery_client
            .list_endpoints(self.connection_manager.database().to_owned())
            .await?;
        let new_endpoints = Self::list_endpoints_to_node_infos(res)?;

        Ok(DiscoveryState::new(start, new_endpoints))
    }

    #[tracing::instrument(skip(state, token_waiter))]
    async fn background_discovery(
        state: Weak<DiscoverySharedState>,
        interval: Duration,
        token_waiter: impl Waiter,
    ) {
        #[instrument(name = "ydb.Discovery.Timer", skip_all, fields(db.system.name = "ydb", discovery_uri = %state.discovery_uri), err)]
        async fn discovery_once(
            state: Arc<DiscoverySharedState>,
            attempt: usize,
        ) -> Result<(), YdbError> {
            trace!("discovery attempt {attempt}");
            let res = state.discovery_now().await;
            trace!("discovery result: {:?}", res);
            res
        }

        trace!("start background_discovery. Waiting for token renew...");
        // Wait for the token to be available before the first discovery
        // attempt. This ensures that the first `ListEndpoints` gRPC call
        // carries a valid `x-ydb-auth-ticket` header.
        token_waiter.wait().await.unwrap_or_else(|err| {
            warn!("token waiter returned error (ignored): {err}");
        });

        'worker: loop {
            let mut attempt = 0;
            let retrier = IndefiniteRetrier;
            let discovery_start = Instant::now();

            'attempt: loop {
                let Some(state) = state.upgrade() else {
                    break 'worker;
                };

                let res = discovery_once(state, attempt).await;
                attempt += 1;

                if res.is_ok() {
                    break 'attempt;
                }

                let decision = retrier.retry_decision(RetryParams {
                    attempt,
                    time_from_start: discovery_start.elapsed(),
                });

                if !decision.wait().await {
                    break 'attempt;
                }
            }

            tokio::time::sleep(interval).await;
        }
        trace!("stop background_discovery");
    }

    fn list_endpoints_to_node_infos(list: Vec<EndpointInfo>) -> YdbResult<Vec<NodeInfo>> {
        list.into_iter()
            .map(|item| match Self::endpoint_info_to_uri(&item) {
                Ok(uri) => YdbResult::<NodeInfo>::Ok(NodeInfo::new(uri, item.location.clone())),
                Err(err) => YdbResult::<NodeInfo>::Err(err),
            })
            .try_collect()
    }

    fn endpoint_info_to_uri(endpoint_info: &EndpointInfo) -> YdbResult<Uri> {
        let authority: Authority =
            Authority::from_str(format!("{}:{}", endpoint_info.fqdn, endpoint_info.port).as_str())?;

        Ok(Uri::builder()
            .scheme(if endpoint_info.ssl { "https" } else { "http" })
            .authority(authority)
            .path_and_query("/")
            .build()?)
    }
}

#[async_trait]
impl Discovery for DiscoverySharedState {
    fn pessimization(&self, uri: &Uri) {
        self.state_sender.send_if_modified(|current| {
            let Some(Ok(state)) = current.as_mut() else {
                // Node pessimization is reset after discovery,
                // so it makes no sense to pessimize a node before
                // the first discovery.
                return false;
            };

            if state.is_pessimized(uri) {
                return false;
            }

            Arc::make_mut(state).pessimize(uri)
        });
    }

    fn subscribe(&self) -> BoxStream<'static, Arc<DiscoveryState>> {
        WatchStream::new(self.state_sender.subscribe())
            .filter_map(|opt_res| future::ready(opt_res.and_then(|res| res.ok())))
            .boxed()
    }

    fn try_state(&self) -> Option<Arc<DiscoveryState>> {
        if let Some(Ok(state)) = &*self.state_sender.borrow() {
            Some(state.clone())
        } else {
            None
        }
    }

    async fn state(&self) -> Arc<DiscoveryState> {
        let mut receiver = self.state_sender.subscribe();

        loop {
            if let Some(Ok(state)) = &*receiver.borrow_and_update() {
                return state.clone();
            }

            receiver
                .changed()
                .await
                .expect("at least one sender is stored in `self` so it cannot be dropped");
        }
    }
}

#[async_trait::async_trait]
impl Waiter for DiscoverySharedState {
    async fn wait(&self) -> YdbResult<()> {
        let mut receiver = self.state_sender.subscribe();

        loop {
            match &*receiver.borrow_and_update() {
                Some(Err(err)) => return Err(err.clone()),
                Some(Ok(_)) => return Ok(()),
                None => (),
            }

            receiver
                .changed()
                .await
                .expect("`self.state_sender` is alive")
        }
    }
}

#[cfg(test)]
mod test {
    use http::Uri;

    use crate::GrpcOptions;
    use crate::client_common::{DBCredentials, TokenCache};
    use crate::discovery::{Discovery, DiscoverySharedState, DiscoveryState, NodeInfo};
    use crate::errors::YdbResult;
    use crate::grpc_connection_manager::{DiscoveryConnectionManager, NoBalancer};
    use crate::grpc_wrapper::auth::AuthGrpcInterceptor;
    use crate::grpc_wrapper::runtime_interceptors::MultiInterceptor;
    use crate::test_helpers::test_client_builder;
    use std::sync::Arc;
    use std::time::{Duration, Instant};

    fn discovery_shared_state() -> YdbResult<DiscoverySharedState> {
        const DATABASE: &str = "/local";
        const ENDPOINT: &str = "grpc://localhost:2136";

        let connection_manager = DiscoveryConnectionManager::new(
            NoBalancer,
            DATABASE.to_string(),
            MultiInterceptor::new(),
            GrpcOptions::default(),
        );

        DiscoverySharedState::new(connection_manager, ENDPOINT)
    }

    #[test]
    fn pessimization_completes_after_discovery() -> YdbResult<()> {
        let state = Arc::new(discovery_shared_state()?);
        let endpoint = Uri::from_static("http://localhost:2136");
        state
            .state_sender
            .send_replace(Some(Ok(Arc::new(DiscoveryState::new(
                Instant::now(),
                vec![NodeInfo::new(endpoint.clone(), String::new())],
            )))));

        let state_for_thread = state.clone();
        let (done_tx, done_rx) = std::sync::mpsc::channel();
        std::thread::spawn(move || {
            state_for_thread.pessimization(&endpoint);
            let _ = done_tx.send(());
        });

        assert!(
            done_rx.recv_timeout(Duration::from_secs(1)).is_ok(),
            "endpoint pessimization deadlocked"
        );

        Ok(())
    }

    #[tokio::test]
    #[ignore] // need YDB access
    async fn test_background_discovery() -> YdbResult<()> {
        let cred = DBCredentials {
            database: test_client_builder().database.clone(),
            token_cache: tokio::task::spawn_blocking(|| {
                TokenCache::new(test_client_builder().credentials.clone())
            })
            .await??,
        };

        let interceptor =
            MultiInterceptor::new().with_interceptor(AuthGrpcInterceptor::new(cred.clone())?);

        let connection_manager = DiscoveryConnectionManager::new(
            NoBalancer,
            cred.database,
            interceptor,
            GrpcOptions::default(),
        );

        let discovery_shared =
            DiscoverySharedState::new(connection_manager, test_client_builder().endpoint.as_str())?;

        let state = Arc::new(discovery_shared);
        let mut rx = state.state_sender.subscribe();
        // skip initial value
        rx.borrow_and_update();

        let state_weak = Arc::downgrade(&state);

        tokio::spawn(DiscoverySharedState::background_discovery(
            state_weak,
            Duration::from_millis(50),
            cred.token_cache.clone(),
        ));

        // wait two updates
        for _ in 0..2 {
            rx.changed().await.unwrap();
            assert!(
                !rx.borrow()
                    .as_ref()
                    .unwrap()
                    .as_ref()
                    .unwrap()
                    .nodes
                    .is_empty()
            );
        }

        Ok(())
    }

    #[tokio::test]
    #[ignore]
    async fn test_wrong_db_name() {
        let good_client = test_client_builder().client().unwrap();

        tokio::time::timeout(Duration::from_secs(5), good_client.wait())
            .await
            .unwrap()
            .unwrap();

        let bad_client = test_client_builder()
            .with_database("/some-amogus-db")
            .client()
            .unwrap();

        tokio::time::timeout(Duration::from_secs(5), bad_client.wait())
            .await
            .unwrap()
            .unwrap_err();
    }
}