ordinary-storage 0.6.0

Storage for Ordinary
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
// Copyright (C) 2026 Ordinary Labs, LLC.
//
// SPDX-License-Identifier: AGPL-3.0-only

use crate::{add_field_to_doc_json, build_schema_for_fields, get_term};
use anyhow::bail;
use bytes::{BufMut, Bytes, BytesMut};
use ordinary_config::{ContentDefinition, ContentLimits};
use ordinary_types::{ContentObject, Kind, json_to_flexbuffer_vec};
use rustc_hash::{FxHashMap, FxHashSet};
use saferlmdb::{
    self as lmdb, Database, DatabaseOptions, Environment, ReadTransaction, WriteTransaction, put,
};

use std::path::Path;
use std::str::FromStr;
use std::sync::Arc;
use tantivy::collector::TopDocs;
use tantivy::directory::MmapDirectory;
use tantivy::query::FuzzyTermQuery;
use tantivy::schema::{Schema, Value};
use tantivy::{Index, IndexWriter, TantivyDocument};
use tracing::instrument;
use uuid::Uuid;

pub struct ContentStore {
    pub limits: ContentLimits,
    env: Arc<Environment>,

    /// stores the content to be piped into template renderers
    ///
    /// key([`definition_idx`][field_idx][`indexed_value`]) -> value([`flexbuffer_bytes`])
    ///
    /// in the '`flexbuffer_bytes`' references are stored as a vector of the internal `item_keys`.
    content_db: Arc<Database<'static>>,

    content_defs: Vec<ContentDefinition>,
    content_def_map: FxHashMap<String, ContentDefinition>,

    content_search_indexes: Vec<Option<(Schema, Index, tantivy::IndexReader)>>,

    log_size: bool,
}

impl ContentStore {
    pub fn new(
        limits: ContentLimits,
        mut content_defs: Vec<ContentDefinition>,
        env: &Arc<Environment>,
        search_dir: impl AsRef<Path>,
        log_size: bool,
    ) -> anyhow::Result<Self> {
        let content_db = Arc::new(Database::open(
            env.clone(),
            Some("content"),
            &DatabaseOptions::new(lmdb::db::Flags::CREATE),
        )?);

        content_defs.sort_by_key(|a| a.idx);
        for def in &mut content_defs {
            def.fields.sort_by_key(|a| a.idx);
        }

        let mut content_def_map = FxHashMap::default();
        let mut content_search_indexes = vec![];

        for def in &content_defs {
            content_def_map.insert(def.name.clone(), def.clone());

            if limits.search_enabled {
                let mut schema_builder = Schema::builder();

                let should_build = build_schema_for_fields(&mut schema_builder, &def.fields, false);

                if should_build {
                    let schema = schema_builder.build();

                    let index_dir = search_dir
                        .as_ref()
                        .join("content")
                        .join(def.idx.to_string());
                    std::fs::create_dir_all(&index_dir)?;

                    let dir = MmapDirectory::open(index_dir)?;
                    let index = Index::open_or_create(dir, schema.clone())?;

                    let reader = index
                        .reader_builder()
                        .reload_policy(tantivy::ReloadPolicy::OnCommitWithDelay);

                    content_search_indexes.push(Some((schema, index, reader.try_into()?)));
                } else {
                    content_search_indexes.push(None);
                    drop(schema_builder);
                }
            }
        }

        Ok(Self {
            limits,
            env: env.clone(),
            content_db,

            content_defs,
            content_def_map,

            content_search_indexes,

            log_size,
        })
    }

    #[allow(clippy::too_many_lines)]
    #[instrument(skip_all, err)]
    pub fn update(&self, objects: &Vec<ContentObject>) -> anyhow::Result<()> {
        // todo: write objects even if not indexed, queryable or searchable. "all" is still valid

        let mut size = 0;
        let mut inserts = 0;

        let txn = WriteTransaction::new(self.env.clone())?;

        {
            let mut access = txn.access();
            let mut object_cursor = txn.cursor(self.content_db.clone())?;

            let mut del_keys = vec![];

            loop {
                if let Ok((k, _)) = object_cursor.get_current::<[u8], [u8]>(&access) {
                    del_keys.push(Bytes::copy_from_slice(k));
                }

                if object_cursor.next::<[u8], [u8]>(&access).is_err() {
                    break;
                }
            }

            for del_key in del_keys {
                access.del_key(&self.content_db, &del_key[..])?;
            }

            let mut seen_instances = FxHashSet::default();

            for object in objects {
                let mut keys = FxHashSet::default();
                let mut real_fields_map = FxHashMap::default();

                for field in &object.fields {
                    real_fields_map.insert(field.name.clone(), &field.value);
                }

                let mut field_name_map = FxHashMap::default();

                let mut search = None;

                if let Some(content_def) = self.content_def_map.get(&object.instance_of) {
                    if let Some(searchable) =
                        self.content_search_indexes.get(content_def.idx as usize)
                        && let Some((schema, index, _reader)) = searchable
                    {
                        // todo: see if this is reusable so it doesn't have to be allocated on every write
                        let writer: IndexWriter = index.writer(15_000_000)?;

                        if !seen_instances.contains(&object.instance_of) {
                            writer.delete_all_documents()?;
                            seen_instances.insert(object.instance_of.clone());
                        }

                        if self.limits.search_enabled {
                            search = Some((TantivyDocument::default(), schema, index, writer));
                        } else {
                            tracing::warn!(
                                i = content_def.idx,
                                nm = content_def.name,
                                "search disabled"
                            );
                        }
                    }

                    let mut first_indexed = true;

                    for field in &content_def.fields {
                        field_name_map.insert(
                            &field.name,
                            (field.idx, field.kind.clone(), field.searchable),
                        );

                        if field.indexed == Some(true)
                            && let Some(real_field_value) = real_fields_map.get(&field.name)
                        {
                            match field.kind {
                                Kind::String | Kind::Url => {
                                    if let Some(value) = real_field_value.as_str() {
                                        let mut key = BytesMut::new();
                                        key.put_u8(content_def.idx);
                                        key.put_u8(field.idx);
                                        key.put(value.as_bytes());

                                        if keys.contains(&key) {
                                            bail!(
                                                "duplicate index value '{}' for definition '{}' on field '{}'",
                                                value,
                                                content_def.name,
                                                field.name
                                            );
                                        }

                                        if first_indexed {
                                            if let Some((doc, schema, _index, _writer)) =
                                                &mut search
                                            {
                                                let tantivy_field =
                                                    schema.get_field(&field.idx.to_string())?;
                                                doc.add_bytes(tantivy_field, &key);
                                            }

                                            first_indexed = false;
                                        }

                                        keys.insert(key);
                                    }
                                }
                                Kind::Uuid => {
                                    if let Some(value) = real_field_value.as_str() {
                                        let uuid = Uuid::from_str(value)?;

                                        let mut key = BytesMut::new();
                                        key.put_u8(content_def.idx);
                                        key.put_u8(field.idx);
                                        key.put(uuid.as_ref());

                                        if keys.contains(&key) {
                                            bail!(
                                                "duplicate index value '{}' for definition '{}' on field '{}'",
                                                value,
                                                content_def.name,
                                                field.name
                                            );
                                        }

                                        if first_indexed {
                                            if let Some((doc, schema, _index, _writer)) =
                                                &mut search
                                            {
                                                let tantivy_field =
                                                    schema.get_field(&field.idx.to_string())?;
                                                doc.add_bytes(tantivy_field, &key);
                                            }

                                            first_indexed = false;
                                        }

                                        keys.insert(key);
                                    }
                                }
                                _ => {
                                    bail!("cannot index on type non-uuid/string/url types");
                                }
                            }
                        }
                    }
                }

                let mut sorted_fields = object.fields.clone();

                sorted_fields.sort_by(|a, b| {
                    if let Some((idx1, _, _)) = field_name_map.get(&a.name) {
                        if let Some((idx2, _, _)) = field_name_map.get(&b.name) {
                            idx1.cmp(idx2)
                        } else {
                            0.cmp(&0)
                        }
                    } else {
                        0.cmp(&0)
                    }
                });

                let mut object_builder =
                    flexbuffers::Builder::new(&flexbuffers::BuilderOptions::SHARE_NONE);
                let mut object_vector = object_builder.start_vector();

                let mut field_too_large = false;

                for field in sorted_fields {
                    if let Some((field_idx, kind, searchable)) = field_name_map.get(&field.name) {
                        json_to_flexbuffer_vec(kind, &field.value, &mut object_vector)?;
                        let field_str = field.value.to_string();

                        if field_str.len() as u64 > self.limits.max_field_size {
                            field_too_large = true;

                            tracing::warn!(def = object.instance_of, object = ?object.fields,  field = field_str, "field too large");
                            break;
                        }

                        if searchable == &Some(true)
                            && let Some((doc, schema, _index, _writer)) = &mut search
                        {
                            let tantivy_field = schema.get_field(&field_idx.to_string())?;
                            add_field_to_doc_json(doc, kind, tantivy_field, &field.value)?;
                        }
                    }
                }

                object_vector.end_vector();

                if !field_too_large {
                    let mut object_too_large = false;
                    let object_bytes = object_builder.view();

                    for key in keys {
                        let object_size = (object_bytes.len() + key.len()) as u64;

                        if object_size > self.limits.max_object_size {
                            object_too_large = true;

                            tracing::warn!(def = object.instance_of, object = ?object.fields, "object exceeds size limit");
                            break;
                        }

                        if size + object_size > self.limits.max_store_size {
                            object_too_large = true;

                            tracing::warn!(def = object.instance_of, object = ?object.fields, "object store size limit exceeded");
                            break;
                        }

                        access.put(
                            &self.content_db,
                            key.as_ref(),
                            object_bytes,
                            &put::Flags::empty(),
                        )?;

                        inserts += 1;

                        if self.log_size {
                            size += object_size;
                        }
                    }

                    if !object_too_large && let Some((doc, _schema, _index, mut writer)) = search {
                        writer.add_document(doc)?;
                        writer.commit()?;
                        writer.wait_merging_threads()?;
                    }
                }
            }
        }

        if self.log_size {
            tracing::info!(inserts, size = %bytesize::ByteSize(size).display().si_short());
        } else {
            tracing::info!(inserts);
        }

        txn.commit()?;

        Ok(())
    }

    #[instrument(skip_all, fields(i, nm), err)]
    pub fn get(&self, def_idx: u8, field_idx: u8, field_value: &[u8]) -> anyhow::Result<Bytes> {
        if let Some(content_def) = self.content_defs.get(def_idx as usize) {
            let curr_span = tracing::Span::current();
            curr_span.record("i", content_def.idx);
            curr_span.record("nm", tracing::field::display(&content_def.name));

            if let Some(field) = content_def.fields.get(field_idx as usize) {
                match field.kind {
                    Kind::String | Kind::Url => tracing::info!(
                        f = field.idx,
                        nm = %field.name,
                        v = %std::str::from_utf8(field_value)?
                    ),
                    Kind::Uuid => {
                        if field_value.len() == 16 {
                            let uuid: [u8; 16] = field_value[0..16].try_into()?;
                            tracing::info!(
                                f = field.idx,
                                nm = %field.name,
                                v = Uuid::from_bytes(uuid).to_string()
                            );
                        } else {
                            bail!("uuid is not 16 bytes");
                        }
                    }
                    _ => tracing::error!("kind {:?} not yet supported as indexable", field.kind),
                }

                let mut key = vec![def_idx, field_idx];
                key.extend_from_slice(field_value);

                let txn = ReadTransaction::new(self.env.clone())?;

                let access = txn.access();
                let result = access.get(&self.content_db, &key)?;

                Ok(Bytes::copy_from_slice(result))
            } else {
                bail!("no field idx {field_idx} for content definition {def_idx}")
            }
        } else {
            bail!("no content definition for idx {def_idx}")
        }
    }

    #[instrument(skip_all, fields(i, nm), err)]
    pub fn list(&self, def_idx: u8) -> anyhow::Result<Bytes> {
        if let Some(content_def) = self.content_defs.get(def_idx as usize) {
            let curr_span = tracing::Span::current();
            curr_span.record("i", content_def.idx);
            curr_span.record("nm", tracing::field::display(&content_def.name));

            let mut count = 0;

            let mut objects_builder =
                flexbuffers::Builder::new(&flexbuffers::BuilderOptions::SHARE_NONE);
            let mut objects_vec = objects_builder.start_vector();

            let txn = ReadTransaction::new(self.env.clone())?;
            let access = txn.access();

            let mut object_cursor = txn.cursor(self.content_db.clone())?;

            let (k, v) = object_cursor.seek_range_k::<[u8], [u8]>(&access, &[def_idx])?;

            count += 1;
            objects_vec.push(flexbuffers::Blob(v));

            let initial_field = k[1];

            while let Ok((k, v)) = object_cursor.next::<[u8], [u8]>(&access) {
                if k[1] != initial_field {
                    break;
                }

                if k[0] == def_idx {
                    count += 1;
                    objects_vec.push(flexbuffers::Blob(v));
                } else {
                    break;
                }
            }

            objects_vec.end_vector();
            tracing::info!(ct = count);

            return Ok(Bytes::copy_from_slice(objects_builder.view()));
        }

        bail!("no content definition for idx {def_idx}")
    }

    #[instrument(skip_all, fields(i, nm), err)]
    pub fn search_content(
        &self,
        def_idx: u8,
        field_idx: u8,
        value: &[u8],
    ) -> anyhow::Result<Bytes> {
        if let Some(content_def) = self.content_defs.get(def_idx as usize) {
            let curr_span = tracing::Span::current();
            curr_span.record("i", content_def.idx);
            curr_span.record("nm", tracing::field::display(&content_def.name));

            if let Some(first_indexed_field) =
                content_def.fields.iter().find(|v| v.indexed == Some(true))
            {
                if let Some(searchable) = self.content_search_indexes.get(def_idx as usize) {
                    #[allow(clippy::collapsible_match)]
                    if let Some((schema, _index, reader)) = searchable {
                        if let Some(content_field) = content_def.fields.get(field_idx as usize) {
                            let field = schema.get_field(&field_idx.to_string())?;

                            let term = get_term(&content_field.kind, field, value)?;
                            let query = FuzzyTermQuery::new(term, 2, true);

                            let searcher = reader.searcher();
                            let docs = searcher
                                .search(&query, &TopDocs::with_limit(255).order_by_score())?;

                            let mut objects_builder =
                                flexbuffers::Builder::new(&flexbuffers::BuilderOptions::SHARE_NONE);
                            let mut objects_vec = objects_builder.start_vector();

                            let txn = ReadTransaction::new(self.env.clone())?;
                            let access = txn.access();

                            tracing::info!(ct = docs.len());

                            for (_score, doc_addr) in docs {
                                let doc: TantivyDocument = searcher.doc(doc_addr)?;
                                if let Some(indexed_val) = doc.get_first(
                                    schema.get_field(&first_indexed_field.idx.to_string())?,
                                ) && let Some(indexed_val) = indexed_val.as_bytes()
                                {
                                    let v =
                                        access.get::<[u8], [u8]>(&self.content_db, indexed_val)?;

                                    objects_vec.push(flexbuffers::Blob(v));
                                }
                            }

                            objects_vec.end_vector();

                            Ok(Bytes::copy_from_slice(objects_builder.view()))
                        } else {
                            bail!("no field idx {field_idx} for content {def_idx}")
                        }
                    } else {
                        bail!("content {def_idx} has no searchable fields")
                    }
                } else {
                    bail!("content {def_idx} has no searchable fields")
                }
            } else {
                bail!("content {def_idx} has no indexed fields")
            }
        } else {
            bail!("no content definition at idx {def_idx}")
        }
    }
}