ydb 0.12.0

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
use std::collections::HashSet;
use std::str::FromStr;
use std::sync::{Arc, RwLock, RwLockWriteGuard, Weak};

use async_trait::async_trait;
use http::uri::Authority;
use http::Uri;

use crate::errors::YdbResult;

use crate::waiter::Waiter;

use derivative::Derivative;
use itertools::Itertools;
use std::time::Duration;
use tokio::sync::watch::Receiver;
use tokio::sync::{watch, Mutex};

use crate::grpc_connection_manager::GrpcConnectionManager;

use crate::grpc_wrapper::raw_discovery_client::{EndpointInfo, GrpcDiscoveryClient};
use crate::grpc_wrapper::raw_services::Service;
use tracing::trace;

/// 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<&Vec<NodeInfo>> {
        Some(&self.nodes)
    }

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

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

    // pessimize return true if state was changed
    pub(crate) fn pessimize(&mut self, uri: &Uri) -> bool {
        if self.pessimized_nodes.contains(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 {
    /// Pessimize the endpoint
    fn pessimization(&self, uri: &Uri);

    /// Subscribe to discovery changes
    fn subscribe(&self) -> tokio::sync::watch::Receiver<Arc<DiscoveryState>>;

    /// Get current discovery state
    fn state(&self) -> Arc<DiscoveryState>;
}

/// Always discovery once static node
///
/// Not used in prod, but may be good for tests
pub struct StaticDiscovery {
    sender: tokio::sync::watch::Sender<Arc<DiscoveryState>>,
    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/?database=/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);
        let (sender, _) = tokio::sync::watch::channel(state.clone());
        Ok(StaticDiscovery {
            sender,
            discovery_state: state,
        })
    }
}

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

    fn subscribe(&self) -> Receiver<Arc<DiscoveryState>> {
        self.sender.subscribe()
    }

    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 {
    #[allow(dead_code)]
    pub(crate) fn new(
        connection_manager: GrpcConnectionManager,
        endpoint: &str,
        interval: Duration,
        token_waiter: Box<dyn Waiter>,
    ) -> YdbResult<Self> {
        let state = Arc::new(DiscoverySharedState::new(connection_manager, endpoint)?);
        let state_weak = Arc::downgrade(&state);
        tokio::spawn(async move {
            trace!("timer discovery wait token");
            let result = token_waiter.wait().await;
            trace!("timer discovery first token done with result: {:?}", result);
            drop(token_waiter);
            DiscoverySharedState::background_discovery(state_weak, interval).await;
        });
        Ok(TimerDiscovery { state })
    }

    #[allow(dead_code)]
    async fn discovery_now(&self) -> YdbResult<()> {
        self.state.discovery_now().await
    }
}

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

        // check if need force discovery
        let state = self.state();
        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) -> Receiver<Arc<DiscoveryState>> {
        self.state.subscribe()
    }

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

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

#[derive(Derivative)]
#[derivative(Debug)]
struct DiscoverySharedState {
    #[derivative(Debug = "ignore")]
    connection_manager: GrpcConnectionManager,
    discovery_uri: Uri,
    sender: tokio::sync::watch::Sender<Arc<DiscoveryState>>,

    discovery_process: Mutex<()>,
    discovery_state: RwLock<Arc<DiscoveryState>>,

    state_received: watch::Receiver<bool>,
    state_received_sender: watch::Sender<bool>,
}

impl DiscoverySharedState {
    fn new(connection_manager: GrpcConnectionManager, endpoint: &str) -> YdbResult<Self> {
        let state = Arc::new(DiscoveryState::new(std::time::Instant::now(), Vec::new()));
        let (sender, _) = watch::channel(state.clone());
        let (state_received_sender, state_received) = watch::channel(false);
        Ok(Self {
            connection_manager,
            discovery_uri: http::Uri::from_str(endpoint)?,
            sender,
            discovery_process: Mutex::new(()),
            discovery_state: RwLock::new(state),
            state_received,
            state_received_sender,
        })
    }

    #[tracing::instrument(skip(self))]
    async fn discovery_now(&self) -> YdbResult<()> {
        trace!("discovery locking");
        let discovery_lock = self.discovery_process.lock().await;

        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().clone())
            .await?;
        let new_endpoints = Self::list_endpoints_to_node_infos(res)?;
        self.set_discovery_state(
            self.discovery_state.write().unwrap(),
            Arc::new(DiscoveryState::new(start, new_endpoints)),
        );

        // lock until exit
        drop(discovery_lock);
        Ok(())
    }

    fn set_discovery_state(
        &self,
        mut locked_state: RwLockWriteGuard<Arc<DiscoveryState>>,
        new_state: Arc<DiscoveryState>,
    ) {
        *locked_state = new_state.clone();
        let _ = self.sender.send(new_state);
        let _ = self.state_received_sender.send(true);
    }

    #[tracing::instrument(skip(state))]
    async fn background_discovery(state: Weak<DiscoverySharedState>, interval: Duration) {
        while let Some(state) = state.upgrade() {
            trace!("rekby-discovery");
            let res = state.discovery_now().await;
            trace!("rekby-res: {:?}", res);
            // return;
            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) {
        // TODO: suppress force copy every time
        let lock = self.discovery_state.write().unwrap();
        let mut discovery_state = lock.as_ref().clone();
        if !discovery_state.pessimize(uri) {
            return;
        }
        let discovery_state = Arc::new(discovery_state);
        self.set_discovery_state(lock, discovery_state);
    }

    fn subscribe(&self) -> Receiver<Arc<DiscoveryState>> {
        self.sender.subscribe()
    }

    fn state(&self) -> Arc<DiscoveryState> {
        return self.discovery_state.read().unwrap().clone();
    }
}

#[async_trait::async_trait]
impl Waiter for DiscoverySharedState {
    async fn wait(&self) -> YdbResult<()> {
        trace!("start discovery shared state");
        let mut channel = self.state_received.clone();
        loop {
            trace!("loop");
            if *channel.borrow_and_update() {
                trace!("return ok");
                return Ok(());
            }
            channel.changed().await?
        }
    }
}

#[cfg(test)]
mod test {
    use crate::client_common::{DBCredentials, TokenCache};
    use crate::discovery::DiscoverySharedState;
    use crate::errors::YdbResult;
    use crate::grpc_connection_manager::GrpcConnectionManager;
    use crate::grpc_wrapper::auth::AuthGrpcInterceptor;
    use crate::grpc_wrapper::runtime_interceptors::MultiInterceptor;
    use crate::load_balancer::{SharedLoadBalancer, StaticLoadBalancer};
    use crate::test_helpers::test_client_builder;
    use http::Uri;
    use std::str::FromStr;
    use std::sync::Arc;
    use std::time::Duration;

    #[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 uri = Uri::from_str(test_client_builder().endpoint.as_str())?;
        let load_balancer =
            SharedLoadBalancer::new_with_balancer(Box::new(StaticLoadBalancer::new(uri)));

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

        let connection_manager =
            GrpcConnectionManager::new(load_balancer, cred.database, interceptor, None);

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

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

        let state_weak = Arc::downgrade(&state);
        tokio::spawn(async {
            DiscoverySharedState::background_discovery(state_weak, Duration::from_millis(50)).await;
        });

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

        Ok(())
    }
}