use crate::disk::RevisionState; use crate::{RevisionPersistence, RevisionSnapshotDiskCache, RevisionSnapshotManager, WSDataProviderDataSource}; use bytes::Bytes; use flowy_error::{FlowyError, FlowyResult}; use flowy_http_model::revision::{Revision, RevisionRange}; use flowy_http_model::util::md5; use lib_infra::future::FutureResult; use std::sync::atomic::AtomicI64; use std::sync::atomic::Ordering::SeqCst; use std::sync::Arc; pub trait RevisionCloudService: Send + Sync { /// Read the object's revision from remote /// Returns a list of revisions that used to build the object /// # Arguments /// /// * `user_id`: the id of the user /// * `object_id`: the id of the object /// fn fetch_object(&self, user_id: &str, object_id: &str) -> FutureResult, FlowyError>; } pub trait RevisionObjectDeserializer: Send + Sync { type Output; /// Deserialize the list of revisions into an concrete object type. /// /// # Arguments /// /// * `object_id`: the id of the object /// * `revisions`: a list of revisions that represent the object /// fn deserialize_revisions(object_id: &str, revisions: Vec) -> FlowyResult; } pub trait RevisionObjectSerializer: Send + Sync { /// Serialize a list of revisions into one in `Bytes` format /// /// * `revisions`: a list of revisions will be serialized to `Bytes` /// fn combine_revisions(revisions: Vec) -> FlowyResult; } /// `RevisionCompress` is used to compress multiple revisions into one revision /// pub trait RevisionMergeable: Send + Sync { fn merge_revisions(&self, _user_id: &str, object_id: &str, mut revisions: Vec) -> FlowyResult { if revisions.is_empty() { return Err(FlowyError::internal().context("Can't compact the empty revisions")); } if revisions.len() == 1 { return Ok(revisions.pop().unwrap()); } let first_revision = revisions.first().unwrap(); let last_revision = revisions.last().unwrap(); let (base_rev_id, rev_id) = first_revision.pair_rev_id(); let md5 = last_revision.md5.clone(); let bytes = self.combine_revisions(revisions)?; Ok(Revision::new(object_id, base_rev_id, rev_id, bytes, md5)) } fn combine_revisions(&self, revisions: Vec) -> FlowyResult; } pub struct RevisionManager { pub object_id: String, user_id: String, rev_id_counter: RevIdCounter, rev_persistence: Arc>, #[allow(dead_code)] rev_snapshot: Arc, rev_compress: Arc, #[cfg(feature = "flowy_unit_test")] rev_ack_notifier: tokio::sync::broadcast::Sender, } impl RevisionManager { pub fn new( user_id: &str, object_id: &str, rev_persistence: RevisionPersistence, rev_compress: C, snapshot_persistence: SP, ) -> Self where SP: 'static + RevisionSnapshotDiskCache, C: 'static + RevisionMergeable, { let rev_id_counter = RevIdCounter::new(0); let rev_compress = Arc::new(rev_compress); let rev_persistence = Arc::new(rev_persistence); let rev_snapshot = Arc::new(RevisionSnapshotManager::new(user_id, object_id, snapshot_persistence)); Self { object_id: object_id.to_string(), user_id: user_id.to_owned(), rev_id_counter, rev_persistence, rev_snapshot, rev_compress, #[cfg(feature = "flowy_unit_test")] rev_ack_notifier: tokio::sync::broadcast::channel(1).0, } } #[tracing::instrument(level = "debug", skip_all, fields(object_id) err)] pub async fn initialize(&mut self, cloud: Option>) -> FlowyResult where B: RevisionObjectDeserializer, { let (revisions, rev_id) = RevisionLoader { object_id: self.object_id.clone(), user_id: self.user_id.clone(), cloud, rev_persistence: self.rev_persistence.clone(), } .load() .await?; self.rev_id_counter.set(rev_id); tracing::Span::current().record("object_id", &self.object_id.as_str()); B::deserialize_revisions(&self.object_id, revisions) } pub async fn close(&self) { let _ = self.rev_persistence.compact_lagging_revisions(&self.rev_compress).await; } pub async fn load_revisions(&self) -> FlowyResult> { let revisions = RevisionLoader { object_id: self.object_id.clone(), user_id: self.user_id.clone(), cloud: None, rev_persistence: self.rev_persistence.clone(), } .load_revisions() .await?; Ok(revisions) } #[tracing::instrument(level = "debug", skip(self, revisions), err)] pub async fn reset_object(&self, revisions: Vec) -> FlowyResult<()> { let rev_id = pair_rev_id_from_revisions(&revisions).1; let _ = self.rev_persistence.reset(revisions).await?; self.rev_id_counter.set(rev_id); Ok(()) } #[tracing::instrument(level = "debug", skip(self, revision), err)] pub async fn add_remote_revision(&self, revision: &Revision) -> Result<(), FlowyError> { if revision.bytes.is_empty() { return Err(FlowyError::internal().context("Remote revisions is empty")); } let _ = self.rev_persistence.add_ack_revision(revision).await?; // self.rev_history.add_revision(revision).await; self.rev_id_counter.set(revision.rev_id); Ok(()) } // #[tracing::instrument(level = "trace", skip_all, err)] pub async fn add_local_revision(&self, revision: &Revision) -> Result<(), FlowyError> { if revision.bytes.is_empty() { return Err(FlowyError::internal().context("Local revisions is empty")); } let rev_id = self .rev_persistence .add_sync_revision(revision, &self.rev_compress) .await?; // self.rev_history.add_revision(revision).await; self.rev_id_counter.set(rev_id); Ok(()) } #[tracing::instrument(level = "debug", skip(self), err)] pub async fn ack_revision(&self, rev_id: i64) -> Result<(), FlowyError> { if self.rev_persistence.ack_revision(rev_id).await.is_ok() { #[cfg(feature = "flowy_unit_test")] let _ = self.rev_ack_notifier.send(rev_id); } Ok(()) } /// Returns the current revision id pub fn rev_id(&self) -> i64 { self.rev_id_counter.value() } pub async fn next_sync_rev_id(&self) -> Option { self.rev_persistence.next_sync_rev_id().await } pub fn next_rev_id_pair(&self) -> (i64, i64) { let cur = self.rev_id_counter.value(); let next = self.rev_id_counter.next_id(); (cur, next) } pub fn number_of_sync_revisions(&self) -> usize { self.rev_persistence.number_of_sync_records() } pub fn number_of_revisions_in_disk(&self) -> usize { self.rev_persistence.number_of_records_in_disk() } pub async fn get_revisions_in_range(&self, range: RevisionRange) -> Result, FlowyError> { let revisions = self.rev_persistence.revisions_in_range(&range).await?; Ok(revisions) } pub async fn next_sync_revision(&self) -> FlowyResult> { self.rev_persistence.next_sync_revision().await } pub async fn get_revision(&self, rev_id: i64) -> Option { self.rev_persistence.get(rev_id).await.map(|record| record.revision) } } impl WSDataProviderDataSource for Arc> { fn next_revision(&self) -> FutureResult, FlowyError> { let rev_manager = self.clone(); FutureResult::new(async move { rev_manager.next_sync_revision().await }) } fn ack_revision(&self, rev_id: i64) -> FutureResult<(), FlowyError> { let rev_manager = self.clone(); FutureResult::new(async move { (*rev_manager).ack_revision(rev_id).await }) } fn current_rev_id(&self) -> i64 { self.rev_id() } } #[cfg(feature = "flowy_unit_test")] impl RevisionManager { pub async fn revision_cache(&self) -> Arc> { self.rev_persistence.clone() } pub fn ack_notify(&self) -> tokio::sync::broadcast::Receiver { self.rev_ack_notifier.subscribe() } pub fn get_all_revision_records(&self) -> FlowyResult> { self.rev_persistence.load_all_records(&self.object_id) } } pub struct RevisionLoader { pub object_id: String, pub user_id: String, pub cloud: Option>, pub rev_persistence: Arc>, } impl RevisionLoader { pub async fn load(&self) -> Result<(Vec, i64), FlowyError> { let records = self.rev_persistence.load_all_records(&self.object_id)?; let revisions: Vec; let mut rev_id = 0; if records.is_empty() && self.cloud.is_some() { let remote_revisions = self .cloud .as_ref() .unwrap() .fetch_object(&self.user_id, &self.object_id) .await?; for revision in &remote_revisions { rev_id = revision.rev_id; let _ = self.rev_persistence.add_ack_revision(revision).await?; } revisions = remote_revisions; } else { for record in &records { rev_id = record.revision.rev_id; if record.state == RevisionState::Sync { // Sync the records if their state is RevisionState::Sync. let _ = self.rev_persistence.sync_revision(&record.revision).await?; } } revisions = records.into_iter().map(|record| record.revision).collect::<_>(); } if let Some(revision) = revisions.last() { debug_assert_eq!(rev_id, revision.rev_id); } Ok((revisions, rev_id)) } pub async fn load_revisions(&self) -> Result, FlowyError> { let records = self.rev_persistence.load_all_records(&self.object_id)?; let revisions = records.into_iter().map(|record| record.revision).collect::<_>(); Ok(revisions) } } /// Represents as the md5 of the revision object after applying the /// revision. For example, RevisionMD5 will be the md5 of the document /// content. #[derive(Debug, Clone)] pub struct RevisionMD5(String); impl RevisionMD5 { pub fn from_bytes>(bytes: T) -> Result { Ok(RevisionMD5(md5(bytes))) } pub fn into_inner(self) -> String { self.0 } pub fn is_equal(&self, s: &str) -> bool { self.0 == s } } impl std::convert::From for String { fn from(md5: RevisionMD5) -> Self { md5.0 } } impl std::convert::From<&str> for RevisionMD5 { fn from(s: &str) -> Self { Self(s.to_owned()) } } impl std::convert::From for RevisionMD5 { fn from(s: String) -> Self { Self(s) } } impl std::ops::Deref for RevisionMD5 { type Target = String; fn deref(&self) -> &Self::Target { &self.0 } } impl PartialEq for RevisionMD5 { fn eq(&self, other: &Self) -> bool { self.0 == other.0 } } impl std::cmp::Eq for RevisionMD5 {} fn pair_rev_id_from_revisions(revisions: &[Revision]) -> (i64, i64) { let mut rev_id = 0; revisions.iter().for_each(|revision| { if rev_id < revision.rev_id { rev_id = revision.rev_id; } }); if rev_id > 0 { (rev_id - 1, rev_id) } else { (0, rev_id) } } #[derive(Debug)] pub struct RevIdCounter(pub AtomicI64); impl RevIdCounter { pub fn new(n: i64) -> Self { Self(AtomicI64::new(n)) } pub fn next_id(&self) -> i64 { let _ = self.0.fetch_add(1, SeqCst); self.value() } pub fn value(&self) -> i64 { self.0.load(SeqCst) } pub fn set(&self, n: i64) { let _ = self.0.fetch_update(SeqCst, SeqCst, |_| Some(n)); } }