//! ```text //! . //! ├── indexes //! │   ├── index-40d14c5f-37ae-4873-9d51-b69e014a0d30 //! │   │   ├── documents.jsonl //! │   │   └── meta.json //! │   ├── index-88202369-4524-4410-9b3d-3e924c867fec //! │   │   ├── documents.jsonl //! │   │   └── meta.json //! │   ├── index-b7f2d03b-bf9b-40d9-a25b-94dc5ec60c32 //! │   │   ├── documents.jsonl //! │   │   └── meta.json //! │   └── index-dc9070b3-572d-4f30-ab45-d4903ab71708 //! │   ├── documents.jsonl //! │   └── meta.json //! ├── index_uuids //! │   └── data.jsonl //! ├── metadata.json //! └── updates //! ├── data.jsonl //! └── update_files //! └── update_202573df-718b-4d80-9a65-2ee397c23dc3 //! ``` use std::{ fs::{self, File}, io::{BufRead, BufReader}, 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 crate::{IndexMetadata, Result, Version}; use self::meta::{DumpMeta, IndexUuid}; use super::{compat::v2_to_v3::CompatV2ToV3, Document}; pub type Settings = settings::Settings; pub type Checked = settings::Checked; pub type Unchecked = settings::Unchecked; pub type Task = updates::UpdateEntry; // everything related to the errors pub type ResponseError = errors::ResponseError; #[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 V2Reader { dump: TempDir, metadata: Metadata, tasks: BufReader, pub index_uuid: Vec, } impl V2Reader { pub fn open(dump: TempDir) -> Result { 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::>>()?; Ok(V2Reader { metadata, tasks: BufReader::new( File::open(dump.path().join("updates").join("data.jsonl")).unwrap(), ), index_uuid, dump, }) } pub fn to_v3(self) -> CompatV2ToV3 { CompatV2ToV3::new(self) } pub fn index_uuid(&self) -> Vec { self.index_uuid.clone() } pub fn version(&self) -> Version { Version::V2 } pub fn date(&self) -> Option { Some(self.metadata.dump_date) } pub fn indexes(&self) -> Result> + '_> { Ok(self.index_uuid.iter().map(|index| -> Result<_> { Ok(V2IndexReader::new( index.uid.clone(), &self .dump .path() .join("indexes") .join(format!("index-{}", index.uuid.to_string())), )?) })) } pub fn tasks(&mut self) -> Box)>> + '_> { 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("update_files") .join(format!("update_{}", uuid.to_string())); Ok((task, Some(UpdateFile::new(&update_file_path)?))) } else { Ok((task, None)) } } else { Ok((task, None)) } })) } } pub struct V2IndexReader { metadata: IndexMetadata, settings: Settings, documents: BufReader, } impl V2IndexReader { pub fn new(name: String, path: &Path) -> Result { 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 = V2IndexReader { 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> + '_> { Ok((&mut self.documents) .lines() .map(|line| -> Result<_> { Ok(serde_json::from_str(&line?)?) })) } pub fn settings(&mut self) -> Result> { Ok(self.settings.clone()) } } pub struct UpdateFile { documents: Vec, index: usize, } impl UpdateFile { fn new(path: &Path) -> Result { let reader = BufReader::new(File::open(path)?); Ok(UpdateFile { documents: serde_json::from_reader(reader)?, index: 0, }) } } impl Iterator for UpdateFile { type Item = Result; fn next(&mut self) -> Option { self.index += 1; self.documents.get(self.index - 1).cloned().map(Ok) } } #[cfg(test)] pub(crate) mod test { use std::{fs::File, io::BufReader}; use flate2::bufread::GzDecoder; use tempfile::TempDir; use super::*; #[test] fn read_dump_v2() { let dump = File::open("tests/assets/v2.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 = V2Reader::open(dir).unwrap(); // top level infos insta::assert_display_snapshot!(dump.date().unwrap(), @"2022-10-09 20:27:59.904096267 +00:00:00"); // tasks let tasks = dump.tasks().collect::>>().unwrap(); let (tasks, mut update_files): (Vec<_>, Vec<_>) = tasks.into_iter().unzip(); insta::assert_json_snapshot!(tasks); assert_eq!(update_files.len(), 9); 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::>>() .unwrap(); insta::assert_json_snapshot!(update_file); // indexes let mut indexes = dump.indexes().unwrap().collect::>>().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]" } "###); insta::assert_debug_snapshot!(products.settings()); let documents = products .documents() .unwrap() .collect::>>() .unwrap(); assert_eq!(documents.len(), 10); insta::assert_json_snapshot!(documents); // movies insta::assert_json_snapshot!(movies.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###" { "uid": "movies", "primaryKey": "id", "createdAt": "[now]", "updatedAt": "[now]" } "###); insta::assert_debug_snapshot!(movies.settings()); let documents = movies .documents() .unwrap() .collect::>>() .unwrap(); assert_eq!(documents.len(), 110); insta::assert_debug_snapshot!(documents); // movies2 insta::assert_json_snapshot!(movies2.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###" { "uid": "movies_2", "primaryKey": null, "createdAt": "[now]", "updatedAt": "[now]" } "###); insta::assert_debug_snapshot!(movies2.settings()); let documents = movies2 .documents() .unwrap() .collect::>>() .unwrap(); assert_eq!(documents.len(), 0); insta::assert_debug_snapshot!(documents); // spells insta::assert_json_snapshot!(spells.metadata(), { ".createdAt" => "[now]", ".updatedAt" => "[now]" }, @r###" { "uid": "dnd_spells", "primaryKey": "index", "createdAt": "[now]", "updatedAt": "[now]" } "###); insta::assert_debug_snapshot!(spells.settings()); let documents = spells .documents() .unwrap() .collect::>>() .unwrap(); assert_eq!(documents.len(), 10); insta::assert_json_snapshot!(documents); } }