|
@@ -1,11 +1,11 @@
|
|
|
-use crate::{RevisionCache, RevisionRecord};
|
|
|
-use dashmap::DashMap;
|
|
|
+use crate::RevisionCache;
|
|
|
use flowy_collaboration::{
|
|
|
entities::revision::{RepeatedRevision, Revision, RevisionRange, RevisionState},
|
|
|
util::{pair_rev_id_from_revisions, RevIdCounter},
|
|
|
};
|
|
|
use flowy_error::{FlowyError, FlowyResult};
|
|
|
use lib_infra::future::FutureResult;
|
|
|
+
|
|
|
use std::{collections::VecDeque, sync::Arc};
|
|
|
use tokio::sync::RwLock;
|
|
|
|
|
@@ -18,12 +18,15 @@ pub trait RevisionObjectBuilder: Send + Sync {
|
|
|
fn build_with_revisions(object_id: &str, revisions: Vec<Revision>) -> FlowyResult<Self::Output>;
|
|
|
}
|
|
|
|
|
|
+pub trait RevisionCompact: Send + Sync {
|
|
|
+ fn compact_revisions(user_id: &str, object_id: &str, revisions: Vec<Revision>) -> FlowyResult<Revision>;
|
|
|
+}
|
|
|
+
|
|
|
pub struct RevisionManager {
|
|
|
pub object_id: String,
|
|
|
user_id: String,
|
|
|
rev_id_counter: RevIdCounter,
|
|
|
- revision_cache: Arc<RevisionCache>,
|
|
|
- revision_sync_seq: Arc<RevisionSyncSequence>,
|
|
|
+ cache: Arc<RwLock<RevisionCacheCompact>>,
|
|
|
|
|
|
#[cfg(feature = "flowy_unit_test")]
|
|
|
revision_ack_notifier: tokio::sync::broadcast::Sender<i64>,
|
|
@@ -32,7 +35,11 @@ pub struct RevisionManager {
|
|
|
impl RevisionManager {
|
|
|
pub fn new(user_id: &str, object_id: &str, revision_cache: Arc<RevisionCache>) -> Self {
|
|
|
let rev_id_counter = RevIdCounter::new(0);
|
|
|
- let revision_sync_seq = Arc::new(RevisionSyncSequence::new());
|
|
|
+ let cache = Arc::new(RwLock::new(RevisionCacheCompact::new(
|
|
|
+ object_id,
|
|
|
+ user_id,
|
|
|
+ revision_cache,
|
|
|
+ )));
|
|
|
#[cfg(feature = "flowy_unit_test")]
|
|
|
let (revision_ack_notifier, _) = tokio::sync::broadcast::channel(1);
|
|
|
|
|
@@ -40,38 +47,36 @@ impl RevisionManager {
|
|
|
object_id: object_id.to_string(),
|
|
|
user_id: user_id.to_owned(),
|
|
|
rev_id_counter,
|
|
|
- revision_cache,
|
|
|
- revision_sync_seq,
|
|
|
+ cache,
|
|
|
|
|
|
#[cfg(feature = "flowy_unit_test")]
|
|
|
revision_ack_notifier,
|
|
|
}
|
|
|
}
|
|
|
|
|
|
- pub async fn load<Builder>(&mut self, cloud: Arc<dyn RevisionCloudService>) -> FlowyResult<Builder::Output>
|
|
|
+ pub async fn load<B, C>(&mut self, cloud: Arc<dyn RevisionCloudService>) -> FlowyResult<B::Output>
|
|
|
where
|
|
|
- Builder: RevisionObjectBuilder,
|
|
|
+ B: RevisionObjectBuilder,
|
|
|
+ C: RevisionCompact,
|
|
|
{
|
|
|
let (revisions, rev_id) = RevisionLoader {
|
|
|
object_id: self.object_id.clone(),
|
|
|
user_id: self.user_id.clone(),
|
|
|
cloud,
|
|
|
- revision_cache: self.revision_cache.clone(),
|
|
|
- revision_sync_seq: self.revision_sync_seq.clone(),
|
|
|
+ cache: self.cache.clone(),
|
|
|
}
|
|
|
- .load()
|
|
|
+ .load::<C>()
|
|
|
.await?;
|
|
|
self.rev_id_counter.set(rev_id);
|
|
|
- Builder::build_with_revisions(&self.object_id, revisions)
|
|
|
+ B::build_with_revisions(&self.object_id, revisions)
|
|
|
}
|
|
|
|
|
|
#[tracing::instrument(level = "debug", skip(self, revisions), err)]
|
|
|
pub async fn reset_object(&self, revisions: RepeatedRevision) -> FlowyResult<()> {
|
|
|
let rev_id = pair_rev_id_from_revisions(&revisions).1;
|
|
|
- let _ = self
|
|
|
- .revision_cache
|
|
|
- .reset_with_revisions(&self.object_id, revisions.into_inner())
|
|
|
- .await?;
|
|
|
+
|
|
|
+ let write_guard = self.cache.write().await;
|
|
|
+ let _ = write_guard.reset(revisions.into_inner()).await?;
|
|
|
self.rev_id_counter.set(rev_id);
|
|
|
Ok(())
|
|
|
}
|
|
@@ -81,34 +86,31 @@ impl RevisionManager {
|
|
|
if revision.delta_data.is_empty() {
|
|
|
return Err(FlowyError::internal().context("Delta data should be empty"));
|
|
|
}
|
|
|
- let _ = self
|
|
|
- .revision_cache
|
|
|
- .add(revision.clone(), RevisionState::Ack, true)
|
|
|
- .await?;
|
|
|
+
|
|
|
+ let write_guard = self.cache.write().await;
|
|
|
+ let _ = write_guard.add_ack_revision(revision).await?;
|
|
|
self.rev_id_counter.set(revision.rev_id);
|
|
|
Ok(())
|
|
|
}
|
|
|
|
|
|
#[tracing::instrument(level = "debug", skip(self, revision))]
|
|
|
- pub async fn add_local_revision(&self, revision: &Revision) -> Result<(), FlowyError> {
|
|
|
+ pub async fn add_local_revision<C>(&self, revision: &Revision) -> Result<(), FlowyError>
|
|
|
+ where
|
|
|
+ C: RevisionCompact,
|
|
|
+ {
|
|
|
if revision.delta_data.is_empty() {
|
|
|
return Err(FlowyError::internal().context("Delta data should be empty"));
|
|
|
}
|
|
|
+ let mut write_guard = self.cache.write().await;
|
|
|
+ let rev_id = write_guard.write_sync_revision::<C>(revision).await?;
|
|
|
|
|
|
- let record = self
|
|
|
- .revision_cache
|
|
|
- .add(revision.clone(), RevisionState::Sync, true)
|
|
|
- .await?;
|
|
|
- self.revision_sync_seq.add_revision_record(record).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> {
|
|
|
- #[cfg(feature = "flowy_unit_test")]
|
|
|
- if self.revision_sync_seq.ack(&rev_id).await.is_ok() {
|
|
|
- self.revision_cache.ack(rev_id).await;
|
|
|
-
|
|
|
+ if self.cache.write().await.ack_revision(rev_id).await.is_ok() {
|
|
|
#[cfg(feature = "flowy_unit_test")]
|
|
|
let _ = self.revision_ack_notifier.send(rev_id);
|
|
|
}
|
|
@@ -126,75 +128,153 @@ impl RevisionManager {
|
|
|
}
|
|
|
|
|
|
pub async fn get_revisions_in_range(&self, range: RevisionRange) -> Result<Vec<Revision>, FlowyError> {
|
|
|
- debug_assert!(range.object_id == self.object_id);
|
|
|
- let revisions = self.revision_cache.revisions_in_range(range.clone()).await?;
|
|
|
+ let revisions = self.cache.read().await.revisions_in_range(&range).await?;
|
|
|
Ok(revisions)
|
|
|
}
|
|
|
|
|
|
- pub fn next_sync_revision(&self) -> FutureResult<Option<Revision>, FlowyError> {
|
|
|
- let revision_sync_seq = self.revision_sync_seq.clone();
|
|
|
- let revision_cache = self.revision_cache.clone();
|
|
|
- FutureResult::new(async move {
|
|
|
- match revision_sync_seq.next_sync_revision_record().await {
|
|
|
- None => match revision_sync_seq.next_sync_rev_id().await {
|
|
|
- None => Ok(None),
|
|
|
- Some(rev_id) => Ok(revision_cache.get(rev_id).await.map(|record| record.revision)),
|
|
|
- },
|
|
|
- Some((_, record)) => Ok(Some(record.revision)),
|
|
|
- }
|
|
|
- })
|
|
|
+ pub async fn next_sync_revision(&self) -> FlowyResult<Option<Revision>> {
|
|
|
+ Ok(self.cache.read().await.next_sync_revision().await?)
|
|
|
}
|
|
|
|
|
|
- pub async fn latest_revision(&self) -> Revision {
|
|
|
- self.revision_cache.latest_revision().await
|
|
|
+ pub async fn get_revision(&self, rev_id: i64) -> Option<Revision> {
|
|
|
+ self.cache.read().await.get(rev_id).await.map(|record| record.revision)
|
|
|
}
|
|
|
+}
|
|
|
|
|
|
- pub async fn get_revision(&self, rev_id: i64) -> Option<Revision> {
|
|
|
- self.revision_cache.get(rev_id).await.map(|record| record.revision)
|
|
|
+#[cfg(feature = "flowy_unit_test")]
|
|
|
+impl RevisionManager {
|
|
|
+ pub async fn revision_cache(&self) -> Arc<RevisionCache> {
|
|
|
+ self.cache.read().await.inner.clone()
|
|
|
+ }
|
|
|
+ pub fn revision_ack_receiver(&self) -> tokio::sync::broadcast::Receiver<i64> {
|
|
|
+ self.revision_ack_notifier.subscribe()
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-struct RevisionSyncSequence {
|
|
|
- revs_map: Arc<DashMap<i64, RevisionRecord>>,
|
|
|
- local_revs: Arc<RwLock<VecDeque<i64>>>,
|
|
|
+struct RevisionCacheCompact {
|
|
|
+ object_id: String,
|
|
|
+ user_id: String,
|
|
|
+ inner: Arc<RevisionCache>,
|
|
|
+ sync_seq: RevisionSyncSequence,
|
|
|
}
|
|
|
|
|
|
-impl std::default::Default for RevisionSyncSequence {
|
|
|
- fn default() -> Self {
|
|
|
- let local_revs = Arc::new(RwLock::new(VecDeque::new()));
|
|
|
- RevisionSyncSequence {
|
|
|
- revs_map: Arc::new(DashMap::new()),
|
|
|
- local_revs,
|
|
|
+impl RevisionCacheCompact {
|
|
|
+ fn new(object_id: &str, user_id: &str, inner: Arc<RevisionCache>) -> Self {
|
|
|
+ let sync_seq = RevisionSyncSequence::new();
|
|
|
+ let object_id = object_id.to_owned();
|
|
|
+ let user_id = user_id.to_owned();
|
|
|
+ Self {
|
|
|
+ object_id,
|
|
|
+ user_id,
|
|
|
+ inner,
|
|
|
+ sync_seq,
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ async fn add_ack_revision(&self, revision: &Revision) -> FlowyResult<()> {
|
|
|
+ self.inner.add(revision.clone(), RevisionState::Ack, true).await
|
|
|
+ }
|
|
|
+
|
|
|
+ async fn add_sync_revision(&mut self, revision: &Revision) -> FlowyResult<()> {
|
|
|
+ self.inner.add(revision.clone(), RevisionState::Sync, false).await?;
|
|
|
+ self.sync_seq.add(revision.rev_id)?;
|
|
|
+ Ok(())
|
|
|
+ }
|
|
|
+
|
|
|
+ #[tracing::instrument(level = "trace", skip(self, revision), fields(rev_id, compact_range), err)]
|
|
|
+ async fn write_sync_revision<C>(&mut self, revision: &Revision) -> FlowyResult<i64>
|
|
|
+ where
|
|
|
+ C: RevisionCompact,
|
|
|
+ {
|
|
|
+ match self.sync_seq.compact() {
|
|
|
+ None => {
|
|
|
+ tracing::Span::current().record("rev_id", &revision.rev_id);
|
|
|
+ self.inner.add(revision.clone(), RevisionState::Sync, true).await?;
|
|
|
+ self.sync_seq.add(revision.rev_id)?;
|
|
|
+ Ok(revision.rev_id)
|
|
|
+ }
|
|
|
+ Some((range, mut compact_seq)) => {
|
|
|
+ tracing::Span::current().record("compact_range", &format!("{}", range).as_str());
|
|
|
+ let mut revisions = self.inner.revisions_in_range(&range).await?;
|
|
|
+ if range.to_rev_ids().len() != revisions.len() {
|
|
|
+ debug_assert_eq!(range.to_rev_ids().len(), revisions.len());
|
|
|
+ }
|
|
|
+
|
|
|
+ // append the new revision
|
|
|
+ revisions.push(revision.clone());
|
|
|
+
|
|
|
+ // compact multiple revisions into one
|
|
|
+ let compact_revision = C::compact_revisions(&self.user_id, &self.object_id, revisions)?;
|
|
|
+ let rev_id = compact_revision.rev_id;
|
|
|
+ tracing::Span::current().record("rev_id", &rev_id);
|
|
|
+
|
|
|
+ // insert new revision
|
|
|
+ compact_seq.push_back(rev_id);
|
|
|
+
|
|
|
+ // replace the revisions in range with compact revision
|
|
|
+ self.inner.compact(&range, compact_revision).await?;
|
|
|
+ debug_assert_eq!(self.sync_seq.len(), compact_seq.len());
|
|
|
+ self.sync_seq.reset(compact_seq);
|
|
|
+ Ok(rev_id)
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ async fn ack_revision(&mut self, rev_id: i64) -> FlowyResult<()> {
|
|
|
+ if self.sync_seq.ack(&rev_id).is_ok() {
|
|
|
+ self.inner.ack(rev_id).await;
|
|
|
}
|
|
|
+ Ok(())
|
|
|
+ }
|
|
|
+
|
|
|
+ async fn next_sync_revision(&self) -> FlowyResult<Option<Revision>> {
|
|
|
+ if cfg!(feature = "flowy_unit_test") {
|
|
|
+ match self.sync_seq.next_rev_id() {
|
|
|
+ None => Ok(None),
|
|
|
+ Some(rev_id) => Ok(self.inner.get(rev_id).await.map(|record| record.revision)),
|
|
|
+ }
|
|
|
+ } else {
|
|
|
+ Ok(None)
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ async fn reset(&self, revisions: Vec<Revision>) -> FlowyResult<()> {
|
|
|
+ self.inner.reset_with_revisions(&self.object_id, revisions).await?;
|
|
|
+ Ok(())
|
|
|
}
|
|
|
}
|
|
|
|
|
|
+impl std::ops::Deref for RevisionCacheCompact {
|
|
|
+ type Target = Arc<RevisionCache>;
|
|
|
+
|
|
|
+ fn deref(&self) -> &Self::Target {
|
|
|
+ &self.inner
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+#[derive(Default)]
|
|
|
+struct RevisionSyncSequence(VecDeque<i64>);
|
|
|
impl RevisionSyncSequence {
|
|
|
fn new() -> Self {
|
|
|
RevisionSyncSequence::default()
|
|
|
}
|
|
|
|
|
|
- async fn add_revision_record(&self, record: RevisionRecord) -> FlowyResult<()> {
|
|
|
- if !record.state.is_need_sync() {
|
|
|
- return Ok(());
|
|
|
- }
|
|
|
-
|
|
|
+ fn add(&mut self, new_rev_id: i64) -> FlowyResult<()> {
|
|
|
// The last revision's rev_id must be greater than the new one.
|
|
|
- if let Some(rev_id) = self.local_revs.read().await.back() {
|
|
|
- if *rev_id >= record.revision.rev_id {
|
|
|
+ if let Some(rev_id) = self.0.back() {
|
|
|
+ if *rev_id >= new_rev_id {
|
|
|
return Err(
|
|
|
FlowyError::internal().context(format!("The new revision's id must be greater than {}", rev_id))
|
|
|
);
|
|
|
}
|
|
|
}
|
|
|
- self.local_revs.write().await.push_back(record.revision.rev_id);
|
|
|
- self.revs_map.insert(record.revision.rev_id, record);
|
|
|
+ self.0.push_back(new_rev_id);
|
|
|
Ok(())
|
|
|
}
|
|
|
|
|
|
- #[allow(dead_code)]
|
|
|
- async fn ack(&self, rev_id: &i64) -> FlowyResult<()> {
|
|
|
- if let Some(pop_rev_id) = self.next_sync_rev_id().await {
|
|
|
+ fn ack(&mut self, rev_id: &i64) -> FlowyResult<()> {
|
|
|
+ let cur_rev_id = self.0.front().cloned();
|
|
|
+ if let Some(pop_rev_id) = cur_rev_id {
|
|
|
if &pop_rev_id != rev_id {
|
|
|
let desc = format!(
|
|
|
"The ack rev_id:{} is not equal to the current rev_id:{}",
|
|
@@ -202,22 +282,33 @@ impl RevisionSyncSequence {
|
|
|
);
|
|
|
return Err(FlowyError::internal().context(desc));
|
|
|
}
|
|
|
-
|
|
|
- self.revs_map.remove(&pop_rev_id);
|
|
|
- let _ = self.local_revs.write().await.pop_front();
|
|
|
+ let _ = self.0.pop_front();
|
|
|
}
|
|
|
Ok(())
|
|
|
}
|
|
|
|
|
|
- async fn next_sync_revision_record(&self) -> Option<(i64, RevisionRecord)> {
|
|
|
- match self.local_revs.read().await.front() {
|
|
|
- None => None,
|
|
|
- Some(rev_id) => self.revs_map.get(rev_id).map(|r| (*r.key(), r.value().clone())),
|
|
|
- }
|
|
|
+ fn next_rev_id(&self) -> Option<i64> {
|
|
|
+ self.0.front().cloned()
|
|
|
+ }
|
|
|
+
|
|
|
+ fn reset(&mut self, new_seq: VecDeque<i64>) {
|
|
|
+ self.0 = new_seq;
|
|
|
}
|
|
|
|
|
|
- async fn next_sync_rev_id(&self) -> Option<i64> {
|
|
|
- self.local_revs.read().await.front().copied()
|
|
|
+ fn len(&self) -> usize {
|
|
|
+ self.0.len()
|
|
|
+ }
|
|
|
+
|
|
|
+ // Compact the rev_ids into one except the current synchronizing rev_id.
|
|
|
+ fn compact(&self) -> Option<(RevisionRange, VecDeque<i64>)> {
|
|
|
+ self.next_rev_id()?;
|
|
|
+
|
|
|
+ let mut new_seq = self.0.clone();
|
|
|
+ let mut drained = new_seq.drain(1..).collect::<VecDeque<_>>();
|
|
|
+
|
|
|
+ let start = drained.pop_front()?;
|
|
|
+ let end = drained.pop_back().unwrap_or(start);
|
|
|
+ Some((RevisionRange { start, end }, new_seq))
|
|
|
}
|
|
|
}
|
|
|
|
|
@@ -225,42 +316,32 @@ struct RevisionLoader {
|
|
|
object_id: String,
|
|
|
user_id: String,
|
|
|
cloud: Arc<dyn RevisionCloudService>,
|
|
|
- revision_cache: Arc<RevisionCache>,
|
|
|
- revision_sync_seq: Arc<RevisionSyncSequence>,
|
|
|
+ cache: Arc<RwLock<RevisionCacheCompact>>,
|
|
|
}
|
|
|
|
|
|
impl RevisionLoader {
|
|
|
- async fn load(&self) -> Result<(Vec<Revision>, i64), FlowyError> {
|
|
|
- let records = self.revision_cache.batch_get(&self.object_id)?;
|
|
|
+ async fn load<C>(&self) -> Result<(Vec<Revision>, i64), FlowyError>
|
|
|
+ where
|
|
|
+ C: RevisionCompact,
|
|
|
+ {
|
|
|
+ let records = self.cache.read().await.batch_get(&self.object_id)?;
|
|
|
let revisions: Vec<Revision>;
|
|
|
let mut rev_id = 0;
|
|
|
if records.is_empty() {
|
|
|
let remote_revisions = self.cloud.fetch_object(&self.user_id, &self.object_id).await?;
|
|
|
for revision in &remote_revisions {
|
|
|
rev_id = revision.rev_id;
|
|
|
- let _ = self
|
|
|
- .revision_cache
|
|
|
- .add(revision.clone(), RevisionState::Ack, true)
|
|
|
- .await?;
|
|
|
+ let _ = self.cache.read().await.add_ack_revision(revision).await?;
|
|
|
}
|
|
|
revisions = remote_revisions;
|
|
|
} else {
|
|
|
- for record in records.clone() {
|
|
|
- let f = || async {
|
|
|
- rev_id = record.revision.rev_id;
|
|
|
- if record.state == RevisionState::Sync {
|
|
|
- // Sync the records if their state is RevisionState::Sync.
|
|
|
- let _ = self.revision_sync_seq.add_revision_record(record.clone()).await?;
|
|
|
- let _ = self.revision_cache.add(record.revision, record.state, false).await?;
|
|
|
- }
|
|
|
- Ok::<(), FlowyError>(())
|
|
|
- };
|
|
|
- match f().await {
|
|
|
- Ok(_) => {}
|
|
|
- Err(e) => tracing::error!("[RevisionLoader]: {}", e),
|
|
|
+ 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.cache.write().await.add_sync_revision(&record.revision).await?;
|
|
|
}
|
|
|
}
|
|
|
-
|
|
|
revisions = records.into_iter().map(|record| record.revision).collect::<_>();
|
|
|
}
|
|
|
|
|
@@ -271,25 +352,3 @@ impl RevisionLoader {
|
|
|
Ok((revisions, rev_id))
|
|
|
}
|
|
|
}
|
|
|
-
|
|
|
-#[cfg(feature = "flowy_unit_test")]
|
|
|
-impl RevisionSyncSequence {
|
|
|
- #[allow(dead_code)]
|
|
|
- pub fn revs_map(&self) -> Arc<DashMap<i64, RevisionRecord>> {
|
|
|
- self.revs_map.clone()
|
|
|
- }
|
|
|
- #[allow(dead_code)]
|
|
|
- pub fn pending_revs(&self) -> Arc<RwLock<VecDeque<i64>>> {
|
|
|
- self.local_revs.clone()
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-#[cfg(feature = "flowy_unit_test")]
|
|
|
-impl RevisionManager {
|
|
|
- pub fn revision_cache(&self) -> Arc<RevisionCache> {
|
|
|
- self.revision_cache.clone()
|
|
|
- }
|
|
|
- pub fn revision_ack_receiver(&self) -> tokio::sync::broadcast::Receiver<i64> {
|
|
|
- self.revision_ack_notifier.subscribe()
|
|
|
- }
|
|
|
-}
|