mirror of
https://github.com/meilisearch/MeiliSearch
synced 2024-06-07 21:37:48 +02:00
325 lines
10 KiB
Rust
325 lines
10 KiB
Rust
//! ```text
|
||
//! .
|
||
//! ├── indexes
|
||
//! │ ├── 01d7dd17-8241-4f1f-a7d1-2d1cb255f5b0
|
||
//! │ │ ├── documents.jsonl
|
||
//! │ │ └── meta.json
|
||
//! │ ├── 78be64a3-cae1-449e-b7ed-13e77c9a8a0c
|
||
//! │ │ ├── documents.jsonl
|
||
//! │ │ └── meta.json
|
||
//! │ ├── ba553439-18fe-4733-ba53-44eed898280c
|
||
//! │ │ ├── documents.jsonl
|
||
//! │ │ └── meta.json
|
||
//! │ └── c408bc22-5859-49d1-8e9f-c88e2fa95cb0
|
||
//! │ ├── documents.jsonl
|
||
//! │ └── meta.json
|
||
//! ├── index_uuids
|
||
//! │ └── data.jsonl
|
||
//! ├── metadata.json
|
||
//! └── updates
|
||
//! ├── data.jsonl
|
||
//! └── updates_files
|
||
//! └── 66d3f12d-fcf3-4b53-88cb-407017373de7
|
||
//! ```
|
||
|
||
use std::fs::{self, File};
|
||
use std::io::{BufRead, BufReader};
|
||
use std::path::Path;
|
||
|
||
use serde::{Deserialize, Serialize};
|
||
use tempfile::TempDir;
|
||
use time::OffsetDateTime;
|
||
|
||
pub mod errors;
|
||
pub mod meta;
|
||
pub mod settings;
|
||
pub mod updates;
|
||
|
||
use self::meta::{DumpMeta, IndexUuid};
|
||
use super::compat::v3_to_v4::CompatV3ToV4;
|
||
use super::Document;
|
||
use crate::{Error, IndexMetadata, Result, Version};
|
||
|
||
pub type Settings<T> = settings::Settings<T>;
|
||
pub type Checked = settings::Checked;
|
||
pub type Unchecked = settings::Unchecked;
|
||
|
||
pub type Task = updates::UpdateEntry;
|
||
|
||
// ===== Other types to clarify the code of the compat module
|
||
// everything related to the tasks
|
||
pub type Status = updates::UpdateStatus;
|
||
pub type Kind = updates::Update;
|
||
|
||
// everything related to the settings
|
||
pub type Setting<T> = settings::Setting<T>;
|
||
|
||
// everything related to the errors
|
||
pub type Code = errors::Code;
|
||
|
||
#[derive(Serialize, Deserialize, Debug)]
|
||
#[serde(rename_all = "camelCase")]
|
||
pub struct Metadata {
|
||
db_version: String,
|
||
index_db_size: usize,
|
||
update_db_size: usize,
|
||
#[serde(with = "time::serde::rfc3339")]
|
||
dump_date: OffsetDateTime,
|
||
}
|
||
|
||
pub struct V3Reader {
|
||
dump: TempDir,
|
||
metadata: Metadata,
|
||
tasks: BufReader<File>,
|
||
index_uuid: Vec<IndexUuid>,
|
||
}
|
||
|
||
impl V3Reader {
|
||
pub fn open(dump: TempDir) -> Result<Self> {
|
||
let meta_file = fs::read(dump.path().join("metadata.json"))?;
|
||
let metadata = serde_json::from_reader(&*meta_file)?;
|
||
let index_uuid = File::open(dump.path().join("index_uuids/data.jsonl"))?;
|
||
let index_uuid = BufReader::new(index_uuid);
|
||
let index_uuid = index_uuid
|
||
.lines()
|
||
.map(|line| -> Result<_> { Ok(serde_json::from_str(&line?)?) })
|
||
.collect::<Result<Vec<_>>>()?;
|
||
|
||
Ok(V3Reader {
|
||
metadata,
|
||
tasks: BufReader::new(File::open(dump.path().join("updates").join("data.jsonl"))?),
|
||
index_uuid,
|
||
dump,
|
||
})
|
||
}
|
||
|
||
pub fn index_uuid(&self) -> Vec<IndexUuid> {
|
||
self.index_uuid.clone()
|
||
}
|
||
|
||
pub fn to_v4(self) -> CompatV3ToV4 {
|
||
CompatV3ToV4::new(self)
|
||
}
|
||
|
||
pub fn version(&self) -> Version {
|
||
Version::V3
|
||
}
|
||
|
||
pub fn date(&self) -> Option<OffsetDateTime> {
|
||
Some(self.metadata.dump_date)
|
||
}
|
||
|
||
pub fn indexes(&self) -> Result<impl Iterator<Item = Result<V3IndexReader>> + '_> {
|
||
Ok(self.index_uuid.iter().map(|index| -> Result<_> {
|
||
V3IndexReader::new(
|
||
index.uid.clone(),
|
||
&self.dump.path().join("indexes").join(index.uuid.to_string()),
|
||
)
|
||
}))
|
||
}
|
||
|
||
pub fn tasks(
|
||
&mut self,
|
||
) -> Box<dyn Iterator<Item = Result<(Task, Option<Box<super::UpdateFile>>)>> + '_> {
|
||
Box::new((&mut self.tasks).lines().map(|line| -> Result<_> {
|
||
let task: Task = serde_json::from_str(&line?)?;
|
||
if !task.is_finished() {
|
||
if let Some(uuid) = task.get_content_uuid() {
|
||
let update_file_path = self
|
||
.dump
|
||
.path()
|
||
.join("updates")
|
||
.join("updates_files")
|
||
.join(uuid.to_string());
|
||
Ok((
|
||
task,
|
||
Some(
|
||
Box::new(UpdateFile::new(&update_file_path)?) as Box<super::UpdateFile>
|
||
),
|
||
))
|
||
} else {
|
||
Ok((task, None))
|
||
}
|
||
} else {
|
||
Ok((task, None))
|
||
}
|
||
}))
|
||
}
|
||
}
|
||
|
||
pub struct V3IndexReader {
|
||
metadata: IndexMetadata,
|
||
settings: Settings<Checked>,
|
||
|
||
documents: BufReader<File>,
|
||
}
|
||
|
||
impl V3IndexReader {
|
||
pub fn new(name: String, path: &Path) -> Result<Self> {
|
||
let meta = File::open(path.join("meta.json"))?;
|
||
let meta: DumpMeta = serde_json::from_reader(meta)?;
|
||
|
||
let metadata = IndexMetadata {
|
||
uid: name,
|
||
primary_key: meta.primary_key,
|
||
// FIXME: Iterate over the whole task queue to find the creation and last update date.
|
||
created_at: OffsetDateTime::now_utc(),
|
||
updated_at: OffsetDateTime::now_utc(),
|
||
};
|
||
|
||
let ret = V3IndexReader {
|
||
metadata,
|
||
settings: meta.settings.check(),
|
||
documents: BufReader::new(File::open(path.join("documents.jsonl"))?),
|
||
};
|
||
|
||
Ok(ret)
|
||
}
|
||
|
||
pub fn metadata(&self) -> &IndexMetadata {
|
||
&self.metadata
|
||
}
|
||
|
||
pub fn documents(&mut self) -> Result<impl Iterator<Item = Result<Document>> + '_> {
|
||
Ok((&mut self.documents)
|
||
.lines()
|
||
.map(|line| -> Result<_> { Ok(serde_json::from_str(&line?)?) }))
|
||
}
|
||
|
||
pub fn settings(&mut self) -> Result<Settings<Checked>> {
|
||
Ok(self.settings.clone())
|
||
}
|
||
}
|
||
|
||
pub struct UpdateFile {
|
||
reader: BufReader<File>,
|
||
}
|
||
|
||
impl UpdateFile {
|
||
fn new(path: &Path) -> Result<Self> {
|
||
Ok(UpdateFile { reader: BufReader::new(File::open(path)?) })
|
||
}
|
||
}
|
||
|
||
impl Iterator for UpdateFile {
|
||
type Item = Result<Document>;
|
||
|
||
fn next(&mut self) -> Option<Self::Item> {
|
||
(&mut self.reader)
|
||
.lines()
|
||
.map(|line| {
|
||
line.map_err(Error::from)
|
||
.and_then(|line| serde_json::from_str(&line).map_err(Error::from))
|
||
})
|
||
.next()
|
||
}
|
||
}
|
||
|
||
#[cfg(test)]
|
||
pub(crate) mod test {
|
||
use std::fs::File;
|
||
use std::io::BufReader;
|
||
|
||
use flate2::bufread::GzDecoder;
|
||
use tempfile::TempDir;
|
||
|
||
use super::*;
|
||
|
||
#[test]
|
||
fn read_dump_v3() {
|
||
let dump = File::open("tests/assets/v3.dump").unwrap();
|
||
let dir = TempDir::new().unwrap();
|
||
let mut dump = BufReader::new(dump);
|
||
let gz = GzDecoder::new(&mut dump);
|
||
let mut archive = tar::Archive::new(gz);
|
||
archive.unpack(dir.path()).unwrap();
|
||
|
||
let mut dump = V3Reader::open(dir).unwrap();
|
||
|
||
// top level infos
|
||
insta::assert_display_snapshot!(dump.date().unwrap(), @"2022-10-07 11:39:03.709153554 +00:00:00");
|
||
|
||
// tasks
|
||
let tasks = dump.tasks().collect::<Result<Vec<_>>>().unwrap();
|
||
let (tasks, mut update_files): (Vec<_>, Vec<_>) = tasks.into_iter().unzip();
|
||
meili_snap::snapshot_hash!(meili_snap::json_string!(tasks), @"63086d59c3f2074e4ab3fff7e8cc36c1");
|
||
assert_eq!(update_files.len(), 10);
|
||
assert!(update_files[0].is_some()); // the enqueued document addition
|
||
assert!(update_files[1..].iter().all(|u| u.is_none())); // everything already processed
|
||
|
||
let update_file = update_files.remove(0).unwrap().collect::<Result<Vec<_>>>().unwrap();
|
||
meili_snap::snapshot_hash!(meili_snap::json_string!(update_file), @"7b8889539b669c7b9ddba448bafa385d");
|
||
|
||
// indexes
|
||
let mut indexes = dump.indexes().unwrap().collect::<Result<Vec<_>>>().unwrap();
|
||
// the index are not ordered in any way by default
|
||
indexes.sort_by_key(|index| index.metadata().uid.to_string());
|
||
|
||
let mut products = indexes.pop().unwrap();
|
||
let mut movies2 = indexes.pop().unwrap();
|
||
let mut movies = indexes.pop().unwrap();
|
||
let mut spells = indexes.pop().unwrap();
|
||
assert!(indexes.is_empty());
|
||
|
||
// products
|
||
insta::assert_json_snapshot!(products.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###"
|
||
{
|
||
"uid": "products",
|
||
"primaryKey": "sku",
|
||
"createdAt": "[now]",
|
||
"updatedAt": "[now]"
|
||
}
|
||
"###);
|
||
|
||
meili_snap::snapshot_hash!(format!("{:#?}", products.settings()), @"f309b009608cc0b770b2f74516f92647");
|
||
let documents = products.documents().unwrap().collect::<Result<Vec<_>>>().unwrap();
|
||
assert_eq!(documents.len(), 10);
|
||
meili_snap::snapshot_hash!(format!("{:#?}", documents), @"548284a84de510f71e88e6cdea495cf5");
|
||
|
||
// movies
|
||
insta::assert_json_snapshot!(movies.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###"
|
||
{
|
||
"uid": "movies",
|
||
"primaryKey": "id",
|
||
"createdAt": "[now]",
|
||
"updatedAt": "[now]"
|
||
}
|
||
"###);
|
||
|
||
meili_snap::snapshot_hash!(format!("{:#?}", movies.settings()), @"95dff22ba3a7019616c12df9daa35e1e");
|
||
let documents = movies.documents().unwrap().collect::<Result<Vec<_>>>().unwrap();
|
||
assert_eq!(documents.len(), 110);
|
||
meili_snap::snapshot_hash!(format!("{:#?}", documents), @"d153b5a81d8b3cdcbe1dec270b574022");
|
||
|
||
// movies2
|
||
insta::assert_json_snapshot!(movies2.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###"
|
||
{
|
||
"uid": "movies_2",
|
||
"primaryKey": null,
|
||
"createdAt": "[now]",
|
||
"updatedAt": "[now]"
|
||
}
|
||
"###);
|
||
|
||
meili_snap::snapshot_hash!(format!("{:#?}", movies2.settings()), @"1dafc4b123e3a8e14a889719cc01f6e5");
|
||
let documents = movies2.documents().unwrap().collect::<Result<Vec<_>>>().unwrap();
|
||
assert_eq!(documents.len(), 0);
|
||
meili_snap::snapshot_hash!(format!("{:#?}", documents), @"d751713988987e9331980363e24189ce");
|
||
|
||
// spells
|
||
insta::assert_json_snapshot!(spells.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###"
|
||
{
|
||
"uid": "dnd_spells",
|
||
"primaryKey": "index",
|
||
"createdAt": "[now]",
|
||
"updatedAt": "[now]"
|
||
}
|
||
"###);
|
||
|
||
meili_snap::snapshot_hash!(format!("{:#?}", spells.settings()), @"1dafc4b123e3a8e14a889719cc01f6e5");
|
||
let documents = spells.documents().unwrap().collect::<Result<Vec<_>>>().unwrap();
|
||
assert_eq!(documents.len(), 10);
|
||
meili_snap::snapshot_hash!(format!("{:#?}", documents), @"235016433dd04262c7f2da01d1e808ce");
|
||
}
|
||
}
|