dbeel 0.1.0

dbeel is a fast and minimal distributed thread-per-core document database.
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
use std::{cmp::min, rc::Rc, time::Duration};

use futures::{
    future::try_join, AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt,
};
use glommio::{
    enclose, executor, net::TcpListener, spawn_local, spawn_local_into,
    Latency, Shares, Task,
};
use log::{error, trace};
use rmp_serde::Serializer;
use rmpv::{
    decode::read_value_ref,
    encode::{write_value, write_value_ref},
    Value, ValueRef,
};
use serde::{Deserialize, Serialize};
use stupid_from_num::FromNum;
use time::OffsetDateTime;

use crate::{
    error::{Error, Result},
    gossip::GossipEvent,
    messages::{ShardRequest, ShardResponse},
    response_to_empty_result, response_to_result,
    shards::{hash_bytes, MyShard},
    storage_engine::TOMBSTONE,
    utils::timeout::timeout,
};

const DEFAULT_SET_TIMEOUT_MS: u64 = 15000;
const DEFAULT_GET_TIMEOUT_MS: u64 = 15000;

#[derive(Serialize, Deserialize)]
pub struct ResponseError {
    pub message: String,
    pub name: String,
}

impl ResponseError {
    #[must_use]
    pub fn new(e: &Error) -> Self {
        Self {
            message: format!("{e}"),
            name: e.kind().to_string(),
        }
    }
}

#[derive(FromNum)]
pub enum ResponseType {
    Err,
    Ok,
    Bytes,
}

fn extract_field<'a>(map: &'a Value, field_name: &str) -> Result<&'a Value> {
    let field = &map[field_name];

    if field.is_nil() {
        return Err(Error::MissingField(field_name.to_string()));
    }

    Ok(field)
}

fn extract_field_as_str(map: &Value, field_name: &str) -> Result<String> {
    Ok(extract_field(map, field_name)?
        .as_str()
        .ok_or_else(|| Error::MissingField(field_name.to_string()))?
        .to_string())
}

fn extract_field_as_u64(map: &Value, field_name: &str) -> Result<u64> {
    extract_field(map, field_name)?
        .as_u64()
        .ok_or_else(|| Error::MissingField(field_name.to_string()))
}

fn extract_field_as_u32(map: &Value, field_name: &str) -> Result<u32> {
    let number = extract_field_as_u64(map, field_name)?;
    if (0..u64::from(u32::MAX)).contains(&number) {
        Ok(number as u32)
    } else {
        Err(Error::FieldNotU16(field_name.to_string()))
    }
}

fn extract_field_as_u16(map: &Value, field_name: &str) -> Result<u16> {
    let number = extract_field_as_u64(map, field_name)?;
    if (0..u64::from(u16::MAX)).contains(&number) {
        Ok(number as u16)
    } else {
        Err(Error::FieldNotU16(field_name.to_string()))
    }
}

fn extract_field_encoded(map: &Value, field_name: &str) -> Result<Vec<u8>> {
    let field = extract_field(map, field_name)?;

    let mut field_encoded: Vec<u8> = Vec::new();
    write_value(&mut field_encoded, field)?;

    Ok(field_encoded)
}

/// Extract a field named "key", returns an error if the current shard doesn't own the key.
fn extract_key(
    my_shard: &MyShard,
    map: &Value,
    replica_index: usize,
) -> Result<Vec<u8>> {
    let key = extract_field_encoded(map, "key")?;
    let maybe_key_hash = extract_field_as_u32(map, "hash");

    let key_hash = if let Ok(hash) = maybe_key_hash {
        hash
    } else {
        hash_bytes(&key)?
    };

    if !my_shard.owns_key(key_hash, replica_index)? {
        return Err(Error::KeyNotOwnedByShard);
    }

    Ok(key)
}

async fn handle_request(
    my_shard: Rc<MyShard>,
    buffer: Vec<u8>,
) -> Result<Option<Vec<u8>>> {
    let msgpack_request = read_value_ref(&mut &buffer[..])?.to_owned();
    if let Some(map_vec) = msgpack_request.as_map() {
        let timestamp = OffsetDateTime::now_utc();
        let map = Value::Map(map_vec.clone());
        match map["type"].as_str() {
            Some("get_cluster_metadata") => {
                let mut response = Vec::new();
                my_shard
                    .get_cluster_metadata()
                    .serialize(&mut Serializer::new(&mut response))?;
                return Ok(Some(response));
            }
            Some("create_collection") => {
                let name = extract_field_as_str(&map, "name")?;
                let replication_factor =
                    extract_field_as_u16(&map, "replication_factor")
                        .unwrap_or(my_shard.args.default_replication_factor);

                if my_shard.collections.borrow().contains_key(&name) {
                    return Err(Error::CollectionAlreadyExists(name));
                }

                my_shard
                    .create_collection(name.clone(), replication_factor)
                    .await?;

                let _ = my_shard
                    .send_request_to_local_shards(
                        ShardRequest::CreateCollection(
                            name.clone(),
                            replication_factor,
                        ),
                        |res| {
                            response_to_empty_result!(
                                res,
                                ShardResponse::CreateCollection
                            )
                        },
                    )
                    .await?;

                my_shard
                    .gossip(GossipEvent::CreateCollection(
                        name,
                        replication_factor,
                    ))
                    .await?;
            }
            Some("get_collection") => {
                let name = extract_field_as_str(&map, "name")?;
                let mut buf: Vec<u8> = Vec::new();
                my_shard
                    .get_collection(&name)?
                    .metadata
                    .serialize(&mut Serializer::new(&mut buf))?;
                return Ok(Some(buf));
            }
            Some("drop_collection") => {
                let name = extract_field_as_str(&map, "name")?;

                my_shard.drop_collection(&name).await?;

                let _ = my_shard
                    .send_request_to_local_shards(
                        ShardRequest::DropCollection(name.clone()),
                        |res| {
                            response_to_empty_result!(
                                res,
                                ShardResponse::DropCollection
                            )
                        },
                    )
                    .await?;

                my_shard.gossip(GossipEvent::DropCollection(name)).await?;
            }
            Some("set") => {
                let collection_name = extract_field_as_str(&map, "collection")?;
                let value = extract_field_encoded(&map, "value")?;
                let write_timeout = Duration::from_millis(
                    extract_field_as_u64(&map, "timeout")
                        .unwrap_or(DEFAULT_SET_TIMEOUT_MS),
                );
                let replica_index =
                    extract_field_as_u16(&map, "replica_index").unwrap_or(0);
                let key = extract_key(&my_shard, &map, replica_index.into())?;

                let collection = my_shard.get_collection(&collection_name)?;
                let tree = collection.tree;
                let replications = collection.metadata.replication_factor;

                let write_consistency = min(
                    extract_field_as_u16(&map, "consistency")
                        .unwrap_or(replications),
                    replications,
                );

                if replications > 1 {
                    let local_future = tree.set_with_timestamp(
                        key.clone(),
                        value.clone(),
                        timestamp,
                    );
                    let remote_future =
                        my_shard.clone().send_request_to_replicas(
                            ShardRequest::Set(
                                collection_name,
                                key,
                                value,
                                timestamp,
                            ),
                            write_consistency as usize - 1,
                            (replications - replica_index) as usize - 1,
                            |res| {
                                response_to_empty_result!(
                                    res,
                                    ShardResponse::Set
                                )
                            },
                        );
                    timeout(
                        write_timeout,
                        try_join(local_future, remote_future),
                    )
                    .await?;
                } else {
                    timeout(
                        write_timeout,
                        tree.set_with_timestamp(key, value, timestamp),
                    )
                    .await?;
                }
            }
            Some("delete") => {
                let collection_name = extract_field_as_str(&map, "collection")?;
                let delete_timeout = Duration::from_millis(
                    extract_field_as_u64(&map, "timeout")
                        .unwrap_or(DEFAULT_SET_TIMEOUT_MS),
                );
                let replica_index =
                    extract_field_as_u16(&map, "replica_index").unwrap_or(0);

                let collection = my_shard.get_collection(&collection_name)?;
                let tree = collection.tree;
                let replications = collection.metadata.replication_factor;
                let key = extract_key(&my_shard, &map, replica_index.into())?;

                let delete_consistency = min(
                    extract_field_as_u16(&map, "consistency")
                        .unwrap_or(replications),
                    replications,
                );

                if replications > 1 {
                    let local_future =
                        tree.delete_with_timestamp(key.clone(), timestamp);
                    let remote_future =
                        my_shard.clone().send_request_to_replicas(
                            ShardRequest::Delete(
                                collection_name,
                                key,
                                timestamp,
                            ),
                            delete_consistency as usize - 1,
                            (replications - replica_index) as usize - 1,
                            |res| {
                                response_to_empty_result!(
                                    res,
                                    ShardResponse::Delete
                                )
                            },
                        );
                    timeout(
                        delete_timeout,
                        try_join(local_future, remote_future),
                    )
                    .await?;
                } else {
                    timeout(
                        delete_timeout,
                        tree.delete_with_timestamp(key, timestamp),
                    )
                    .await?;
                }
            }
            Some("get") => {
                let collection_name = extract_field_as_str(&map, "collection")?;
                let read_timeout = Duration::from_millis(
                    extract_field_as_u64(&map, "timeout")
                        .unwrap_or(DEFAULT_GET_TIMEOUT_MS),
                );
                let replica_index =
                    extract_field_as_u16(&map, "replica_index").unwrap_or(0);

                let collection = my_shard.get_collection(&collection_name)?;
                let tree = collection.tree;
                let replications = collection.metadata.replication_factor;
                let key = extract_key(&my_shard, &map, replica_index.into())?;

                let read_consistency = min(
                    extract_field_as_u16(&map, "consistency")
                        .unwrap_or(replications),
                    replications,
                );

                return if replications > 1 {
                    let local_future = tree.get_entry(&key);
                    let remote_future =
                        my_shard.clone().send_request_to_replicas(
                            ShardRequest::Get(collection_name, key.clone()),
                            read_consistency as usize - 1,
                            (replications - replica_index) as usize - 1,
                            |res| response_to_result!(res, ShardResponse::Get),
                        );
                    let (local_value, mut values) = timeout(
                        read_timeout,
                        try_join(local_future, remote_future),
                    )
                    .await?;

                    values.push(local_value);

                    match values
                        .into_iter()
                        .flatten()
                        .max_by_key(|v| v.timestamp)
                        .map(|v| v.data)
                    {
                        Some(value) if value != TOMBSTONE => Ok(Some(value)),
                        _ => Err(Error::KeyNotFound),
                    }
                } else {
                    match timeout(read_timeout, tree.get(&key)).await? {
                        Some(value) if value != TOMBSTONE => Ok(Some(value)),
                        _ => Err(Error::KeyNotFound),
                    }
                };
            }
            Some(name) => {
                return Err(Error::UnsupportedField(name.to_string()));
            }
            _ => {
                return Err(Error::BadFieldType("type".to_string()));
            }
        }
    } else {
        return Err(Error::BadFieldType("document".to_string()));
    }

    Ok(None)
}

async fn send_buffer(
    stream: &mut (impl AsyncRead + AsyncWrite + Unpin),
    buf: &[u8],
) -> Result<()> {
    let size_buffer = (buf.len() as u32).to_le_bytes();
    stream.write_all(&size_buffer).await?;
    stream.write_all(buf).await?;
    Ok(())
}

async fn handle_client(
    my_shard: Rc<MyShard>,
    client: &mut (impl AsyncRead + AsyncWrite + Unpin),
) -> Result<()> {
    let mut size_buf = [0; 2];
    client.read_exact(&mut size_buf).await?;
    let size = u16::from_le_bytes(size_buf);
    let mut request_buf = vec![0; size as usize];
    client.read_exact(&mut request_buf).await?;

    match handle_request(my_shard, request_buf).await {
        Ok(None) => {
            let mut buf: Vec<u8> = Vec::new();
            write_value_ref(&mut buf, &ValueRef::String("OK".into()))?;
            buf.push(ResponseType::Bytes.into());
            send_buffer(client, &buf).await?;
        }
        Ok(Some(mut buf)) => {
            buf.push(ResponseType::Ok.into());
            send_buffer(client, &buf).await?;
        }
        Err(e) => {
            if !matches!(e, Error::KeyNotFound) {
                error!("Error while handling request: {0:?}, '{0}'", e);
            }

            let mut buf: Vec<u8> = Vec::new();
            ResponseError::new(&e).serialize(&mut Serializer::new(&mut buf))?;
            buf.push(ResponseType::Err.into());
            send_buffer(client, &buf).await?;
        }
    }

    client.close().await?;

    Ok(())
}

async fn run_server(my_shard: Rc<MyShard>) -> Result<()> {
    let port = my_shard.args.port + my_shard.id;
    let address = format!("{}:{}", my_shard.args.ip, port);
    let server = TcpListener::bind(address.as_str())?;
    trace!("Listening for clients on: {}", address);

    loop {
        match server.accept().await {
            Ok(mut client) => {
                spawn_local(enclose!((my_shard.clone() => my_shard) async move {
                    if let Err(e) = handle_client(my_shard, &mut client).await {
                        error!("Failed to handle client: {}", e);
                    }
                }))
                .detach();
            }
            Err(e) => {
                error!("Failed to accept client: {}", e);
            }
        }
    }
}

pub fn spawn_db_server_task(my_shard: Rc<MyShard>) -> Task<Result<()>> {
    let shares = my_shard.args.foreground_tasks_shares.into();
    spawn_local_into(
        async move {
            let result = run_server(my_shard).await;
            if let Err(e) = &result {
                error!("Error running server: {}", e);
            }
            result
        },
        executor().create_task_queue(
            Shares::Static(shares),
            Latency::Matters(Duration::from_millis(20)),
            "db-server",
        ),
    )
    .unwrap()
}