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
use std::collections::VecDeque;
use std::sync::atomic::{AtomicU64, Ordering};
use std::time::Duration;

use async_trait::async_trait;
use compact_str::CompactString;
use either::Either;
use etcd_client::{
    Client,
    Compare,
    CompareOp,
    Event,
    EventType,
    GetOptions,
    KvClient,
    PutOptions,
    Txn,
    TxnOp,
    TxnOpResponse,
    WatchClient,
    WatchOptions,
    WatchStream,
    Watcher,
};
use ignore_result::Ignore;
use uuid::Uuid;

use super::serde;
use super::types::{
    self,
    BookieRegistrationClient,
    BookieServiceInfo,
    BookieUpdate,
    LedgerIdStoreClient,
    LedgerMetadataStoreClient,
    MetaStore,
    MetaVersion,
    Versioned,
};
use crate::client::errors::{BkError, ErrorKind};
use crate::client::{LedgerId, LedgerMetadata};

pub struct BookieUpdateStream {
    bookie_path: String,
    stream: WatchStream,
    events: VecDeque<Event>,
}

#[async_trait]
impl types::BookieUpdateStream for BookieUpdateStream {
    async fn next(&mut self) -> Result<BookieUpdate, BkError> {
        loop {
            while let Some(event) = self.events.pop_front() {
                if let Some(kv) = event.kv() {
                    let result = if event.event_type() == EventType::Put {
                        let bookie_service_info =
                            serde::deserialize_bookie_service_info(&self.bookie_path, kv.key(), kv.value())?;
                        BookieUpdate::Add(bookie_service_info)
                    } else {
                        let bookie_id = serde::deserialize_bookie_id(&self.bookie_path, kv.key())?;
                        BookieUpdate::Remove(bookie_id)
                    };
                    return Ok(result);
                }
            }
            if let Some(response) = self.stream.message().await? {
                let events = response.events();
                events.iter().for_each(|e| self.events.push_back(e.clone()));
            }
        }
    }
}

impl BookieUpdateStream {
    fn new(bookie_path: String, stream: WatchStream) -> BookieUpdateStream {
        BookieUpdateStream { bookie_path, stream, events: VecDeque::new() }
    }
}

pub struct LedgerMetadataStream {
    ledger_id: LedgerId,
    watcher: Watcher,
    stream: WatchStream,
    events: VecDeque<Event>,
    cancelled: bool,
}

#[async_trait]
impl types::LedgerMetadataStream for LedgerMetadataStream {
    async fn cancel(&mut self) {
        if self.cancelled {
            return;
        }
        self.events.clear();
        self.cancelled = true;
        self.watcher.cancel().await.ignore();
    }

    async fn next(&mut self) -> Result<Versioned<LedgerMetadata>, BkError> {
        loop {
            while let Some(event) = self.events.pop_front() {
                if let Some(kv) = event.kv() {
                    if event.event_type() == EventType::Delete {
                        return Err(BkError::new(ErrorKind::LedgerNotExisted));
                    }
                    let version = kv.mod_revision();
                    let metadata = serde::deserialize_ledger_metadata(self.ledger_id, kv.value())?;
                    return Ok(Versioned::new(MetaVersion(version), metadata));
                }
            }
            if let Some(response) = self.stream.message().await? {
                let events = response.events();
                events.iter().for_each(|e| self.events.push_back(e.clone()));
            };
        }
    }
}

pub struct EtcdConfiguration {
    scope: CompactString,
    #[allow(dead_code)]
    user: Option<(String, String)>,
    #[allow(dead_code)]
    keep_alive: Option<(Duration, Duration)>,
}

impl EtcdConfiguration {
    pub fn new(scope: CompactString) -> EtcdConfiguration {
        EtcdConfiguration { scope, user: None, keep_alive: None }
    }

    #[allow(dead_code)]
    pub fn with_user(self, name: String, password: String) -> EtcdConfiguration {
        EtcdConfiguration { user: Some((name, password)), ..self }
    }

    #[allow(dead_code)]
    pub fn with_keep_alive(self, interval: Duration, timeout: Duration) -> EtcdConfiguration {
        EtcdConfiguration { keep_alive: Some((interval, timeout)), ..self }
    }
}

pub struct EtcdMetaStore {
    scope: CompactString,
    client: KvClient,
    watcher: WatchClient,
    bucket_counter: AtomicU64,
}

impl Clone for EtcdMetaStore {
    fn clone(&self) -> EtcdMetaStore {
        EtcdMetaStore {
            scope: self.scope.clone(),
            client: self.client.clone(),
            watcher: self.watcher.clone(),
            bucket_counter: AtomicU64::new(0),
        }
    }
}

unsafe impl Send for EtcdMetaStore {}
unsafe impl Sync for EtcdMetaStore {}

const NUM_BUCKETS: u64 = 0x80;
const BUCKET_SHIFT: i32 = 56;
const MAX_ID_PER_BUCKET: u64 = 0x00ffffffffffffff;

impl EtcdMetaStore {
    pub async fn connect<E: AsRef<str>, S: AsRef<[E]>>(
        endpoints: S,
        configuration: EtcdConfiguration,
    ) -> Result<EtcdMetaStore, BkError> {
        let client = Client::connect(endpoints, None).await?;
        Ok(EtcdMetaStore {
            scope: configuration.scope,
            client: client.kv_client(),
            watcher: client.watch_client(),
            bucket_counter: AtomicU64::new(0),
        })
    }

    fn next_bucket(&self) -> u64 {
        let u = self.bucket_counter.fetch_add(1, Ordering::Relaxed);
        u % NUM_BUCKETS
    }

    fn bucket_path(&self, bucket: u64) -> String {
        format!("{}/buckets/{:03}", self.scope, bucket)
    }

    fn ledger_path(&self, ledger_id: LedgerId) -> String {
        let least64: i64 = ledger_id.into();
        let combined_id = least64 as u64 as u128;
        let uuid = Uuid::from_u128(combined_id);
        format!("{}/ledgers/{}", self.scope, uuid)
    }

    fn writable_bookie_directory_path(&self) -> String {
        format!("{}/bookies/writable/", self.scope)
    }

    fn readable_bookie_directory_path(&self) -> String {
        format!("{}/bookies/readable/", self.scope)
    }

    async fn watch_bookies_update(
        &self,
        bookie_path: String,
        start_revision: i64,
    ) -> Result<BookieUpdateStream, BkError> {
        let mut bookie_path_end: Vec<u8> = bookie_path.clone().into();
        bookie_path_end.push(0xff);
        let options = WatchOptions::new().with_range(bookie_path_end).with_start_revision(start_revision);
        let (_watcher, stream) = self.watcher.clone().watch(bookie_path.clone(), Some(options)).await?;
        Ok(BookieUpdateStream::new(bookie_path, stream))
    }

    async fn watch_bookies(
        &self,
        bookie_path: String,
    ) -> Result<(Vec<BookieServiceInfo>, Box<dyn types::BookieUpdateStream>), BkError> {
        let mut bookie_path_end: Vec<u8> = bookie_path.clone().into();
        bookie_path_end.push(0xff);
        let options = GetOptions::new().with_range(bookie_path_end).with_serializable();
        let mut client = self.client.clone();
        let response = client.get(bookie_path.clone(), Some(options)).await?;
        let Some(header) = response.header() else {
            let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"no header");
            return Err(err);
        };
        let start_revision = header.revision();
        let mut err: Option<BkError> = None;
        let bookies: Vec<BookieServiceInfo> = response
            .kvs()
            .iter()
            .filter_map(|kv| match serde::deserialize_bookie_service_info(&bookie_path, kv.key(), kv.value()) {
                Err(e) => {
                    err = Some(e);
                    None
                },
                Ok(bookie) => Some(bookie),
            })
            .collect();
        if let Some(err) = err {
            return Err(err);
        }
        let update_stream = self.watch_bookies_update(bookie_path, start_revision + 1).await?;
        Ok((bookies, Box::new(update_stream)))
    }
}

#[async_trait]
impl BookieRegistrationClient for EtcdMetaStore {
    async fn watch_readable_bookies(
        &mut self,
    ) -> Result<(Vec<BookieServiceInfo>, Box<dyn types::BookieUpdateStream>), BkError> {
        let bookie_path = self.writable_bookie_directory_path();
        self.watch_bookies(bookie_path).await
    }

    async fn watch_writable_bookies(
        &mut self,
    ) -> Result<(Vec<BookieServiceInfo>, Box<dyn types::BookieUpdateStream>), BkError> {
        let bookie_path = self.readable_bookie_directory_path();
        self.watch_bookies(bookie_path).await
    }
}

#[async_trait]
impl LedgerIdStoreClient for EtcdMetaStore {
    async fn generate_ledger_id(&self) -> Result<LedgerId, BkError> {
        let bucket_id = self.next_bucket();
        let bucket_path = self.bucket_path(bucket_id);
        let options = PutOptions::new().with_prev_key();
        let mut client = self.client.clone();
        let response = client.put(bucket_path, Vec::new(), Some(options)).await?;
        let previous_version = response.prev_key().map_or(0, |kv| kv.version()) as u64;
        let version = previous_version + 1;
        assert!(version <= MAX_ID_PER_BUCKET);
        let id = (bucket_id << BUCKET_SHIFT) | version;
        return Ok(LedgerId(id as i64));
    }
}

impl From<etcd_client::Error> for BkError {
    fn from(e: etcd_client::Error) -> BkError {
        BkError::new(ErrorKind::MetaClientError).cause_by(e)
    }
}

impl From<prost::DecodeError> for BkError {
    fn from(e: prost::DecodeError) -> BkError {
        BkError::new(ErrorKind::MetaInvalidData).cause_by(e)
    }
}

#[async_trait]
impl LedgerMetadataStoreClient for EtcdMetaStore {
    async fn create_ledger_metadata(&self, metadata: &LedgerMetadata) -> Result<MetaVersion, BkError> {
        let ledger_path = self.ledger_path(metadata.ledger_id);
        let serialized_metadata = serde::serialize_ledger_metadata(metadata)?;
        let compare = Compare::create_revision(ledger_path.clone(), CompareOp::Greater, 0);
        let create = TxnOp::put(ledger_path, serialized_metadata, None);
        let txn = Txn::new().when(vec![compare]).or_else(vec![create]);
        let mut client = self.client.clone();
        let response = client.txn(txn).await?;
        if response.succeeded() {
            return Err(BkError::new(ErrorKind::LedgerExisted));
        }
        let Some(TxnOpResponse::Put(put_response)) = response.op_responses().into_iter().next() else {
            let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"put succeed with no put response");
            return Err(err);
        };
        let Some(revision) = put_response.header().map(|h| h.revision()) else {
            let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"no header in put response");
            return Err(err);
        };
        return Ok(MetaVersion::from(revision));
    }

    async fn remove_ledger_metadata(
        &self,
        ledger_id: LedgerId,
        expected_version: Option<MetaVersion>,
    ) -> Result<(), BkError> {
        let ledger_path = self.ledger_path(ledger_id);
        let mut client = self.client.clone();
        let Some(version) = expected_version else {
            let response = client.delete(ledger_path, None).await?;
            if response.deleted() <= 0 {
                return Err(BkError::new(ErrorKind::LedgerNotExisted));
            }
            return Ok(());
        };
        let compare = Compare::mod_revision(ledger_path.clone(), CompareOp::Equal, version.into());
        let delete = TxnOp::delete(ledger_path.clone(), None);
        let get_op = TxnOp::get(ledger_path, Some(GetOptions::new().with_count_only()));
        let txn = Txn::new().when(vec![compare]).and_then(vec![delete]).or_else(vec![get_op]);
        let response = client.txn(txn).await?;
        if response.succeeded() {
            return Ok(());
        }
        let Some(TxnOpResponse::Get(get_response)) = response.op_responses().into_iter().next() else {
            let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"get succeed with no get response");
            return Err(err);
        };
        if get_response.count() != 0 {
            return Err(BkError::new(ErrorKind::MetaVersionMismatch));
        }
        return Err(BkError::new(ErrorKind::LedgerNotExisted));
    }

    async fn read_ledger_metadata(&self, ledger_id: LedgerId) -> Result<Versioned<LedgerMetadata>, BkError> {
        let ledger_path = self.ledger_path(ledger_id);
        let mut client = self.client.clone();
        let response = client.get(ledger_path, None).await?;
        let Some(kv) = response.kvs().first() else {
            return Err(BkError::new(ErrorKind::LedgerNotExisted));
        };
        let metadata = serde::deserialize_ledger_metadata(ledger_id, kv.value())?;
        let version = MetaVersion::from(kv.mod_revision());
        return Ok(Versioned::new(version, metadata));
    }

    async fn watch_ledger_metadata(
        &self,
        ledger_id: LedgerId,
        start_version: MetaVersion,
    ) -> Result<Box<dyn types::LedgerMetadataStream>, BkError> {
        let ledger_path = self.ledger_path(ledger_id);
        let options = WatchOptions::new().with_start_revision(start_version.into());
        let mut client = self.watcher.clone();
        let (watcher, stream) = client.watch(ledger_path, Some(options)).await?;
        let stream = LedgerMetadataStream { ledger_id, watcher, stream, events: VecDeque::new(), cancelled: false };
        return Ok(Box::new(stream));
    }

    async fn write_ledger_metadata(
        &self,
        metadata: &LedgerMetadata,
        expected_version: MetaVersion,
    ) -> Result<Either<Versioned<LedgerMetadata>, MetaVersion>, BkError> {
        let serialized_metadata = serde::serialize_ledger_metadata(metadata)?;
        let ledger_path = self.ledger_path(metadata.ledger_id);
        let compare = Compare::mod_revision(ledger_path.clone(), CompareOp::Equal, expected_version.into());
        let put_op = TxnOp::put(ledger_path.clone(), serialized_metadata, None);
        let get_op = TxnOp::get(ledger_path, Some(GetOptions::new().with_count_only()));
        let txn = Txn::new().when(vec![compare]).and_then(vec![put_op]).or_else(vec![get_op]);
        let mut client = self.client.clone();
        let response = client.txn(txn).await?;
        if response.succeeded() {
            let Some(TxnOpResponse::Put(put_response)) = response.op_responses().into_iter().next() else {
                let err =
                    BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"put succeed with no put response");
                return Err(err);
            };
            let Some(revision) = put_response.header().map(|h| h.revision()) else {
                let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"no header in put response");
                return Err(err);
            };
            return Ok(either::Right(MetaVersion::from(revision)));
        }
        let Some(TxnOpResponse::Get(get_response)) = response.op_responses().into_iter().next() else {
            let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"get succeed with no get response");
            return Err(err);
        };
        let Some(kv) = get_response.kvs().first() else {
            return Err(BkError::new(ErrorKind::LedgerNotExisted));
        };
        let Some(conflicting_revision) = get_response.header().map(|h| h.revision()) else {
            let err = BkError::with_description(ErrorKind::MetaUnexpectedResponse, &"no header in get response");
            return Err(err);
        };
        let conflicting_metadata = serde::deserialize_ledger_metadata(metadata.ledger_id, kv.value())?;
        Ok(either::Left(Versioned::new(conflicting_revision, conflicting_metadata)))
    }
}

impl MetaStore for EtcdMetaStore {}