send user connect message

This commit is contained in:
appflowy 2021-12-18 18:35:45 +08:00
parent 1744938a51
commit 987a246c80
20 changed files with 325 additions and 287 deletions

View File

@ -1,7 +1,8 @@
use crate::{ use crate::{
errors::FlowyError, errors::FlowyError,
services::{ services::{
doc::{controller::DocController, edit::ClientDocEditor, DocumentWsHandlers}, controller::DocController,
doc::{edit::ClientDocEditor, DocumentWsHandlers},
server::construct_doc_server, server::construct_doc_server,
}, },
}; };

View File

@ -2,7 +2,10 @@ use crate::{errors::FlowyError, module::DocumentUser, services::doc::*};
use bytes::Bytes; use bytes::Bytes;
use flowy_collaboration::{ use flowy_collaboration::{
core::document::history::UndoResult, core::document::history::UndoResult,
entities::{doc::DocDelta, ws::DocumentWSData}, entities::{
doc::DocDelta,
ws::{DocumentConnected, DocumentWSData, DocumentWSDataType, WsDocumentDataBuilder},
},
errors::CollaborateResult, errors::CollaborateResult,
}; };
use flowy_database::ConnectionPool; use flowy_database::ConnectionPool;
@ -13,15 +16,15 @@ use lib_ot::{
revision::{RevId, RevType, Revision, RevisionRange}, revision::{RevId, RevType, Revision, RevisionRange},
rich_text::{RichTextAttribute, RichTextDelta}, rich_text::{RichTextAttribute, RichTextDelta},
}; };
use lib_ws::WSConnectState;
use std::{collections::VecDeque, sync::Arc}; use std::{collections::VecDeque, sync::Arc};
use tokio::sync::{mpsc, mpsc::UnboundedSender, oneshot, RwLock}; use tokio::sync::{broadcast, mpsc, mpsc::UnboundedSender, oneshot, RwLock};
pub struct ClientDocEditor { pub struct ClientDocEditor {
pub doc_id: String, pub doc_id: String,
rev_manager: Arc<RevisionManager>, rev_manager: Arc<RevisionManager>,
ws_manager: Arc<WebSocketManager>, editor_ws: Arc<EditorWebSocket>,
edit_cmd_tx: UnboundedSender<EditCommand>, editor_cmd_sender: UnboundedSender<EditorCommand>,
sink_data_provider: SinkDataProvider,
user: Arc<dyn DocumentUser>, user: Arc<dyn DocumentUser>,
} }
@ -35,8 +38,9 @@ impl ClientDocEditor {
server: Arc<dyn RevisionServer>, server: Arc<dyn RevisionServer>,
) -> FlowyResult<Arc<Self>> { ) -> FlowyResult<Arc<Self>> {
let delta = rev_manager.load_document(server).await?; let delta = rev_manager.load_document(server).await?;
let edit_cmd_tx = spawn_edit_queue(doc_id, delta, pool.clone()); let editor_cmd_sender = spawn_edit_queue(doc_id, delta, pool.clone());
let doc_id = doc_id.to_string(); let doc_id = doc_id.to_string();
let user_id = user.user_id()?;
let rev_manager = Arc::new(rev_manager); let rev_manager = Arc::new(rev_manager);
let sink_data_provider = Arc::new(RwLock::new(VecDeque::new())); let sink_data_provider = Arc::new(RwLock::new(VecDeque::new()));
let data_provider = Arc::new(DocumentSinkDataProviderAdapter { let data_provider = Arc::new(DocumentSinkDataProviderAdapter {
@ -45,18 +49,27 @@ impl ClientDocEditor {
}); });
let stream_consumer = Arc::new(DocumentWebSocketSteamConsumerAdapter { let stream_consumer = Arc::new(DocumentWebSocketSteamConsumerAdapter {
doc_id: doc_id.clone(), doc_id: doc_id.clone(),
edit_cmd_tx: edit_cmd_tx.clone(), editor_cmd_sender: editor_cmd_sender.clone(),
rev_manager: rev_manager.clone(), rev_manager: rev_manager.clone(),
user: user.clone(), user: user.clone(),
sink_data_provider: sink_data_provider.clone(), sink_data_provider: sink_data_provider.clone(),
}); });
let ws_manager = Arc::new(WebSocketManager::new(&doc_id, ws, data_provider, stream_consumer)); let editor_ws = Arc::new(EditorWebSocket::new(&doc_id, ws, data_provider, stream_consumer));
notify_user_conn(&user_id, &doc_id, rev_manager.clone(), sink_data_provider.clone()).await;
listen_document_ws_state(
&user_id,
&doc_id,
editor_ws.scribe_state(),
rev_manager.clone(),
sink_data_provider,
);
let editor = Arc::new(Self { let editor = Arc::new(Self {
doc_id, doc_id,
rev_manager, rev_manager,
ws_manager, editor_ws,
edit_cmd_tx, editor_cmd_sender,
sink_data_provider,
user, user,
}); });
Ok(editor) Ok(editor)
@ -64,12 +77,12 @@ impl ClientDocEditor {
pub async fn insert<T: ToString>(&self, index: usize, data: T) -> Result<(), FlowyError> { pub async fn insert<T: ToString>(&self, index: usize, data: T) -> Result<(), FlowyError> {
let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>();
let msg = EditCommand::Insert { let msg = EditorCommand::Insert {
index, index,
data: data.to_string(), data: data.to_string(),
ret, ret,
}; };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let (delta, md5) = rx.await.map_err(internal_error)??; let (delta, md5) = rx.await.map_err(internal_error)??;
let _ = self.save_local_delta(delta, md5).await?; let _ = self.save_local_delta(delta, md5).await?;
Ok(()) Ok(())
@ -77,8 +90,8 @@ impl ClientDocEditor {
pub async fn delete(&self, interval: Interval) -> Result<(), FlowyError> { pub async fn delete(&self, interval: Interval) -> Result<(), FlowyError> {
let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>();
let msg = EditCommand::Delete { interval, ret }; let msg = EditorCommand::Delete { interval, ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let (delta, md5) = rx.await.map_err(internal_error)??; let (delta, md5) = rx.await.map_err(internal_error)??;
let _ = self.save_local_delta(delta, md5).await?; let _ = self.save_local_delta(delta, md5).await?;
Ok(()) Ok(())
@ -86,12 +99,12 @@ impl ClientDocEditor {
pub async fn format(&self, interval: Interval, attribute: RichTextAttribute) -> Result<(), FlowyError> { pub async fn format(&self, interval: Interval, attribute: RichTextAttribute) -> Result<(), FlowyError> {
let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>();
let msg = EditCommand::Format { let msg = EditorCommand::Format {
interval, interval,
attribute, attribute,
ret, ret,
}; };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let (delta, md5) = rx.await.map_err(internal_error)??; let (delta, md5) = rx.await.map_err(internal_error)??;
let _ = self.save_local_delta(delta, md5).await?; let _ = self.save_local_delta(delta, md5).await?;
Ok(()) Ok(())
@ -99,12 +112,12 @@ impl ClientDocEditor {
pub async fn replace<T: ToString>(&self, interval: Interval, data: T) -> Result<(), FlowyError> { pub async fn replace<T: ToString>(&self, interval: Interval, data: T) -> Result<(), FlowyError> {
let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<NewDelta>>();
let msg = EditCommand::Replace { let msg = EditorCommand::Replace {
interval, interval,
data: data.to_string(), data: data.to_string(),
ret, ret,
}; };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let (delta, md5) = rx.await.map_err(internal_error)??; let (delta, md5) = rx.await.map_err(internal_error)??;
let _ = self.save_local_delta(delta, md5).await?; let _ = self.save_local_delta(delta, md5).await?;
Ok(()) Ok(())
@ -112,38 +125,38 @@ impl ClientDocEditor {
pub async fn can_undo(&self) -> bool { pub async fn can_undo(&self) -> bool {
let (ret, rx) = oneshot::channel::<bool>(); let (ret, rx) = oneshot::channel::<bool>();
let msg = EditCommand::CanUndo { ret }; let msg = EditorCommand::CanUndo { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
rx.await.unwrap_or(false) rx.await.unwrap_or(false)
} }
pub async fn can_redo(&self) -> bool { pub async fn can_redo(&self) -> bool {
let (ret, rx) = oneshot::channel::<bool>(); let (ret, rx) = oneshot::channel::<bool>();
let msg = EditCommand::CanRedo { ret }; let msg = EditorCommand::CanRedo { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
rx.await.unwrap_or(false) rx.await.unwrap_or(false)
} }
pub async fn undo(&self) -> Result<UndoResult, FlowyError> { pub async fn undo(&self) -> Result<UndoResult, FlowyError> {
let (ret, rx) = oneshot::channel::<CollaborateResult<UndoResult>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<UndoResult>>();
let msg = EditCommand::Undo { ret }; let msg = EditorCommand::Undo { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let r = rx.await.map_err(internal_error)??; let r = rx.await.map_err(internal_error)??;
Ok(r) Ok(r)
} }
pub async fn redo(&self) -> Result<UndoResult, FlowyError> { pub async fn redo(&self) -> Result<UndoResult, FlowyError> {
let (ret, rx) = oneshot::channel::<CollaborateResult<UndoResult>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<UndoResult>>();
let msg = EditCommand::Redo { ret }; let msg = EditorCommand::Redo { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let r = rx.await.map_err(internal_error)??; let r = rx.await.map_err(internal_error)??;
Ok(r) Ok(r)
} }
pub async fn delta(&self) -> FlowyResult<DocDelta> { pub async fn delta(&self) -> FlowyResult<DocDelta> {
let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>();
let msg = EditCommand::ReadDoc { ret }; let msg = EditorCommand::ReadDoc { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let data = rx.await.map_err(internal_error)??; let data = rx.await.map_err(internal_error)??;
Ok(DocDelta { Ok(DocDelta {
@ -173,11 +186,11 @@ impl ClientDocEditor {
pub(crate) async fn composing_local_delta(&self, data: Bytes) -> Result<(), FlowyError> { pub(crate) async fn composing_local_delta(&self, data: Bytes) -> Result<(), FlowyError> {
let delta = RichTextDelta::from_bytes(&data)?; let delta = RichTextDelta::from_bytes(&data)?;
let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>();
let msg = EditCommand::ComposeDelta { let msg = EditorCommand::ComposeDelta {
delta: delta.clone(), delta: delta.clone(),
ret, ret,
}; };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let md5 = rx.await.map_err(internal_error)??; let md5 = rx.await.map_err(internal_error)??;
let _ = self.save_local_delta(delta, md5).await?; let _ = self.save_local_delta(delta, md5).await?;
@ -185,21 +198,21 @@ impl ClientDocEditor {
} }
#[tracing::instrument(level = "debug", skip(self))] #[tracing::instrument(level = "debug", skip(self))]
pub fn stop_sync(&self) { self.ws_manager.stop(); } pub fn stop_sync(&self) { self.editor_ws.stop(); }
pub(crate) fn ws_handler(&self) -> Arc<dyn DocumentWsHandler> { self.ws_manager.clone() } pub(crate) fn ws_handler(&self) -> Arc<dyn DocumentWsHandler> { self.editor_ws.clone() }
} }
fn spawn_edit_queue(doc_id: &str, delta: RichTextDelta, _pool: Arc<ConnectionPool>) -> UnboundedSender<EditCommand> { fn spawn_edit_queue(doc_id: &str, delta: RichTextDelta, _pool: Arc<ConnectionPool>) -> UnboundedSender<EditorCommand> {
let (sender, receiver) = mpsc::unbounded_channel::<EditCommand>(); let (sender, receiver) = mpsc::unbounded_channel::<EditorCommand>();
let actor = EditCommandQueue::new(doc_id, delta, receiver); let actor = EditorCommandQueue::new(doc_id, delta, receiver);
tokio::spawn(actor.run()); tokio::spawn(actor.run());
sender sender
} }
struct DocumentWebSocketSteamConsumerAdapter { struct DocumentWebSocketSteamConsumerAdapter {
doc_id: String, doc_id: String,
edit_cmd_tx: UnboundedSender<EditCommand>, editor_cmd_sender: UnboundedSender<EditorCommand>,
rev_manager: Arc<RevisionManager>, rev_manager: Arc<RevisionManager>,
user: Arc<dyn DocumentUser>, user: Arc<dyn DocumentUser>,
sink_data_provider: SinkDataProvider, sink_data_provider: SinkDataProvider,
@ -209,7 +222,7 @@ impl DocumentWebSocketSteamConsumer for DocumentWebSocketSteamConsumerAdapter {
fn receive_push_revision(&self, bytes: Bytes) -> FutureResult<(), FlowyError> { fn receive_push_revision(&self, bytes: Bytes) -> FutureResult<(), FlowyError> {
let user = self.user.clone(); let user = self.user.clone();
let rev_manager = self.rev_manager.clone(); let rev_manager = self.rev_manager.clone();
let edit_cmd_tx = self.edit_cmd_tx.clone(); let edit_cmd_tx = self.editor_cmd_sender.clone();
let sink_data_provider = self.sink_data_provider.clone(); let sink_data_provider = self.sink_data_provider.clone();
let doc_id = self.doc_id.clone(); let doc_id = self.doc_id.clone();
FutureResult::new(async move { FutureResult::new(async move {
@ -240,6 +253,54 @@ impl DocumentWebSocketSteamConsumer for DocumentWebSocketSteamConsumerAdapter {
} }
} }
async fn notify_user_conn(
user_id: &str,
doc_id: &str,
rev_manager: Arc<RevisionManager>,
sink_data_provider: SinkDataProvider,
) {
let need_notify = match sink_data_provider.read().await.front() {
None => true,
Some(data) => data.ty != DocumentWSDataType::UserConnect,
};
if need_notify {
let document_conn = DocumentConnected {
user_id: user_id.to_owned(),
doc_id: doc_id.to_owned(),
rev_id: rev_manager.latest_rev_id(),
};
let data = WsDocumentDataBuilder::build_document_conn_message(doc_id, document_conn);
sink_data_provider.write().await.push_front(data);
}
}
fn listen_document_ws_state(
user_id: &str,
doc_id: &str,
mut subscriber: broadcast::Receiver<WSConnectState>,
rev_manager: Arc<RevisionManager>,
sink_data_provider: SinkDataProvider,
) {
let user_id = user_id.to_owned();
let doc_id = doc_id.to_owned();
tokio::spawn(async move {
while let Ok(state) = subscriber.recv().await {
match state {
WSConnectState::Init => {},
WSConnectState::Connecting => {},
WSConnectState::Connected => {
// self.notify_user_conn()
notify_user_conn(&user_id, &doc_id, rev_manager.clone(), sink_data_provider.clone()).await;
},
WSConnectState::Disconnected => {},
}
}
});
}
type SinkDataProvider = Arc<RwLock<VecDeque<DocumentWSData>>>; type SinkDataProvider = Arc<RwLock<VecDeque<DocumentWSData>>>;
struct DocumentSinkDataProviderAdapter { struct DocumentSinkDataProviderAdapter {
@ -256,7 +317,7 @@ impl DocumentSinkDataProvider for DocumentSinkDataProviderAdapter {
if data_provider.read().await.is_empty() { if data_provider.read().await.is_empty() {
match rev_manager.next_sync_revision().await? { match rev_manager.next_sync_revision().await? {
Some(rev) => { Some(rev) => {
tracing::debug!("[DocumentSinkDataProvider]: revision: {}:{:?}", rev.doc_id, rev.rev_id); tracing::debug!("[DocumentSinkDataProvider]: {}:{:?}", rev.doc_id, rev.rev_id);
Ok(Some(rev.into())) Ok(Some(rev.into()))
}, },
None => Ok(None), None => Ok(None),
@ -278,13 +339,13 @@ impl DocumentSinkDataProvider for DocumentSinkDataProviderAdapter {
pub(crate) async fn handle_push_rev( pub(crate) async fn handle_push_rev(
doc_id: &str, doc_id: &str,
user_id: &str, user_id: &str,
edit_cmd_tx: UnboundedSender<EditCommand>, edit_cmd_tx: UnboundedSender<EditorCommand>,
rev_manager: Arc<RevisionManager>, rev_manager: Arc<RevisionManager>,
bytes: Bytes, bytes: Bytes,
) -> FlowyResult<Option<Revision>> { ) -> FlowyResult<Option<Revision>> {
// Transform the revision // Transform the revision
let (ret, rx) = oneshot::channel::<CollaborateResult<TransformDeltas>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<TransformDeltas>>();
let _ = edit_cmd_tx.send(EditCommand::ProcessRemoteRevision { bytes, ret }); let _ = edit_cmd_tx.send(EditorCommand::ProcessRemoteRevision { bytes, ret });
let TransformDeltas { let TransformDeltas {
client_prime, client_prime,
server_prime, server_prime,
@ -298,7 +359,7 @@ pub(crate) async fn handle_push_rev(
// compose delta // compose delta
let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>();
let msg = EditCommand::ComposeDelta { let msg = EditorCommand::ComposeDelta {
delta: client_prime.clone(), delta: client_prime.clone(),
ret, ret,
}; };
@ -339,16 +400,16 @@ pub(crate) async fn handle_push_rev(
impl ClientDocEditor { impl ClientDocEditor {
pub async fn doc_json(&self) -> FlowyResult<String> { pub async fn doc_json(&self) -> FlowyResult<String> {
let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<DocumentMD5>>();
let msg = EditCommand::ReadDoc { ret }; let msg = EditorCommand::ReadDoc { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let s = rx.await.map_err(internal_error)??; let s = rx.await.map_err(internal_error)??;
Ok(s) Ok(s)
} }
pub async fn doc_delta(&self) -> FlowyResult<RichTextDelta> { pub async fn doc_delta(&self) -> FlowyResult<RichTextDelta> {
let (ret, rx) = oneshot::channel::<CollaborateResult<RichTextDelta>>(); let (ret, rx) = oneshot::channel::<CollaborateResult<RichTextDelta>>();
let msg = EditCommand::ReadDocDelta { ret }; let msg = EditorCommand::ReadDocDelta { ret };
let _ = self.edit_cmd_tx.send(msg); let _ = self.editor_cmd_sender.send(msg);
let delta = rx.await.map_err(internal_error)??; let delta = rx.await.map_err(internal_error)??;
Ok(delta) Ok(delta)
} }

View File

@ -14,14 +14,14 @@ use lib_ot::{
use std::{convert::TryFrom, sync::Arc}; use std::{convert::TryFrom, sync::Arc};
use tokio::sync::{mpsc, oneshot, RwLock}; use tokio::sync::{mpsc, oneshot, RwLock};
pub(crate) struct EditCommandQueue { pub(crate) struct EditorCommandQueue {
doc_id: String, doc_id: String,
document: Arc<RwLock<Document>>, document: Arc<RwLock<Document>>,
receiver: Option<mpsc::UnboundedReceiver<EditCommand>>, receiver: Option<mpsc::UnboundedReceiver<EditorCommand>>,
} }
impl EditCommandQueue { impl EditorCommandQueue {
pub(crate) fn new(doc_id: &str, delta: RichTextDelta, receiver: mpsc::UnboundedReceiver<EditCommand>) -> Self { pub(crate) fn new(doc_id: &str, delta: RichTextDelta, receiver: mpsc::UnboundedReceiver<EditorCommand>) -> Self {
let document = Arc::new(RwLock::new(Document::from_delta(delta))); let document = Arc::new(RwLock::new(Document::from_delta(delta)));
Self { Self {
doc_id: doc_id.to_owned(), doc_id: doc_id.to_owned(),
@ -50,13 +50,13 @@ impl EditCommandQueue {
.await; .await;
} }
async fn handle_message(&self, msg: EditCommand) -> Result<(), FlowyError> { async fn handle_message(&self, msg: EditorCommand) -> Result<(), FlowyError> {
match msg { match msg {
EditCommand::ComposeDelta { delta, ret } => { EditorCommand::ComposeDelta { delta, ret } => {
let result = self.composed_delta(delta).await; let result = self.composed_delta(delta).await;
let _ = ret.send(result); let _ = ret.send(result);
}, },
EditCommand::ProcessRemoteRevision { bytes, ret } => { EditorCommand::ProcessRemoteRevision { bytes, ret } => {
let f = || async { let f = || async {
let revision = Revision::try_from(bytes)?; let revision = Revision::try_from(bytes)?;
let delta = RichTextDelta::from_bytes(&revision.delta_data)?; let delta = RichTextDelta::from_bytes(&revision.delta_data)?;
@ -75,19 +75,19 @@ impl EditCommandQueue {
}; };
let _ = ret.send(f().await); let _ = ret.send(f().await);
}, },
EditCommand::Insert { index, data, ret } => { EditorCommand::Insert { index, data, ret } => {
let mut write_guard = self.document.write().await; let mut write_guard = self.document.write().await;
let delta = write_guard.insert(index, data)?; let delta = write_guard.insert(index, data)?;
let md5 = write_guard.md5(); let md5 = write_guard.md5();
let _ = ret.send(Ok((delta, md5))); let _ = ret.send(Ok((delta, md5)));
}, },
EditCommand::Delete { interval, ret } => { EditorCommand::Delete { interval, ret } => {
let mut write_guard = self.document.write().await; let mut write_guard = self.document.write().await;
let delta = write_guard.delete(interval)?; let delta = write_guard.delete(interval)?;
let md5 = write_guard.md5(); let md5 = write_guard.md5();
let _ = ret.send(Ok((delta, md5))); let _ = ret.send(Ok((delta, md5)));
}, },
EditCommand::Format { EditorCommand::Format {
interval, interval,
attribute, attribute,
ret, ret,
@ -97,31 +97,31 @@ impl EditCommandQueue {
let md5 = write_guard.md5(); let md5 = write_guard.md5();
let _ = ret.send(Ok((delta, md5))); let _ = ret.send(Ok((delta, md5)));
}, },
EditCommand::Replace { interval, data, ret } => { EditorCommand::Replace { interval, data, ret } => {
let mut write_guard = self.document.write().await; let mut write_guard = self.document.write().await;
let delta = write_guard.replace(interval, data)?; let delta = write_guard.replace(interval, data)?;
let md5 = write_guard.md5(); let md5 = write_guard.md5();
let _ = ret.send(Ok((delta, md5))); let _ = ret.send(Ok((delta, md5)));
}, },
EditCommand::CanUndo { ret } => { EditorCommand::CanUndo { ret } => {
let _ = ret.send(self.document.read().await.can_undo()); let _ = ret.send(self.document.read().await.can_undo());
}, },
EditCommand::CanRedo { ret } => { EditorCommand::CanRedo { ret } => {
let _ = ret.send(self.document.read().await.can_redo()); let _ = ret.send(self.document.read().await.can_redo());
}, },
EditCommand::Undo { ret } => { EditorCommand::Undo { ret } => {
let result = self.document.write().await.undo(); let result = self.document.write().await.undo();
let _ = ret.send(result); let _ = ret.send(result);
}, },
EditCommand::Redo { ret } => { EditorCommand::Redo { ret } => {
let result = self.document.write().await.redo(); let result = self.document.write().await.redo();
let _ = ret.send(result); let _ = ret.send(result);
}, },
EditCommand::ReadDoc { ret } => { EditorCommand::ReadDoc { ret } => {
let data = self.document.read().await.to_json(); let data = self.document.read().await.to_json();
let _ = ret.send(Ok(data)); let _ = ret.send(Ok(data));
}, },
EditCommand::ReadDocDelta { ret } => { EditorCommand::ReadDocDelta { ret } => {
let delta = self.document.read().await.delta().clone(); let delta = self.document.read().await.delta().clone();
let _ = ret.send(Ok(delta)); let _ = ret.send(Ok(delta));
}, },
@ -151,7 +151,7 @@ pub(crate) type NewDelta = (RichTextDelta, String);
pub(crate) type DocumentMD5 = String; pub(crate) type DocumentMD5 = String;
#[allow(dead_code)] #[allow(dead_code)]
pub(crate) enum EditCommand { pub(crate) enum EditorCommand {
ComposeDelta { ComposeDelta {
delta: RichTextDelta, delta: RichTextDelta,
ret: Ret<DocumentMD5>, ret: Ret<DocumentMD5>,

View File

@ -18,7 +18,7 @@ use tokio::{
time::{interval, Duration}, time::{interval, Duration},
}; };
pub(crate) struct WebSocketManager { pub(crate) struct EditorWebSocket {
doc_id: String, doc_id: String,
data_provider: Arc<dyn DocumentSinkDataProvider>, data_provider: Arc<dyn DocumentSinkDataProvider>,
stream_consumer: Arc<dyn DocumentWebSocketSteamConsumer>, stream_consumer: Arc<dyn DocumentWebSocketSteamConsumer>,
@ -26,9 +26,10 @@ pub(crate) struct WebSocketManager {
ws_msg_tx: UnboundedSender<DocumentWSData>, ws_msg_tx: UnboundedSender<DocumentWSData>,
ws_msg_rx: Option<UnboundedReceiver<DocumentWSData>>, ws_msg_rx: Option<UnboundedReceiver<DocumentWSData>>,
stop_sync_tx: SinkStopTx, stop_sync_tx: SinkStopTx,
state: broadcast::Sender<WSConnectState>,
} }
impl WebSocketManager { impl EditorWebSocket {
pub(crate) fn new( pub(crate) fn new(
doc_id: &str, doc_id: &str,
ws: Arc<dyn DocumentWebSocket>, ws: Arc<dyn DocumentWebSocket>,
@ -38,7 +39,8 @@ impl WebSocketManager {
let (ws_msg_tx, ws_msg_rx) = mpsc::unbounded_channel(); let (ws_msg_tx, ws_msg_rx) = mpsc::unbounded_channel();
let (stop_sync_tx, _) = tokio::sync::broadcast::channel(2); let (stop_sync_tx, _) = tokio::sync::broadcast::channel(2);
let doc_id = doc_id.to_string(); let doc_id = doc_id.to_string();
let mut manager = WebSocketManager { let (state, _) = broadcast::channel(2);
let mut manager = EditorWebSocket {
doc_id, doc_id,
data_provider, data_provider,
stream_consumer, stream_consumer,
@ -46,6 +48,7 @@ impl WebSocketManager {
ws_msg_tx, ws_msg_tx,
ws_msg_rx: Some(ws_msg_rx), ws_msg_rx: Some(ws_msg_rx),
stop_sync_tx, stop_sync_tx,
state,
}; };
manager.start_sync(); manager.start_sync();
manager manager
@ -67,7 +70,6 @@ impl WebSocketManager {
); );
tokio::spawn(sink.run()); tokio::spawn(sink.run());
tokio::spawn(stream.run()); tokio::spawn(stream.run());
self.notify_user_conn();
} }
pub(crate) fn stop(&self) { pub(crate) fn stop(&self) {
@ -76,24 +78,10 @@ impl WebSocketManager {
} }
} }
#[tracing::instrument(level = "debug", skip(self))] pub(crate) fn scribe_state(&self) -> broadcast::Receiver<WSConnectState> { self.state.subscribe() }
fn notify_user_conn(&self) {
// let rev_id: RevId = self.rev_manager.rev_id().into();
// if let Ok(user_id) = self.user.user_id() {
// let action = OpenDocAction::new(&user_id, &self.doc_id, &rev_id,
// &self.ws_sender); let strategy =
// ExponentialBackoff::from_millis(50).take(3); let retry =
// Retry::spawn(strategy, action); tokio::spawn(async move {
// match retry.await {
// Ok(_) => log::debug!("Notify open doc success"),
// Err(e) => log::error!("Notify open doc failed: {}", e),
// }
// });
// }
}
} }
impl DocumentWsHandler for WebSocketManager { impl DocumentWsHandler for EditorWebSocket {
fn receive(&self, doc_data: DocumentWSData) { fn receive(&self, doc_data: DocumentWSData) {
match self.ws_msg_tx.send(doc_data) { match self.ws_msg_tx.send(doc_data) {
Ok(_) => {}, Ok(_) => {},
@ -102,11 +90,9 @@ impl DocumentWsHandler for WebSocketManager {
} }
fn connect_state_changed(&self, state: &WSConnectState) { fn connect_state_changed(&self, state: &WSConnectState) {
match state { match self.state.send(state.clone()) {
WSConnectState::Init => {}, Ok(_) => {},
WSConnectState::Connecting => {}, Err(e) => tracing::error!("{}", e),
WSConnectState::Connected => self.notify_user_conn(),
WSConnectState::Disconnected => {},
} }
} }
} }
@ -199,7 +185,9 @@ impl DocumentWebSocketStream {
let rev_id = RevId::try_from(bytes)?; let rev_id = RevId::try_from(bytes)?;
let _ = self.consumer.receive_ack_revision(rev_id.into()).await; let _ = self.consumer.receive_ack_revision(rev_id.into()).await;
}, },
DocumentWSDataType::UserConnect => {}, DocumentWSDataType::UserConnect => {
// Notify the user that someone has connected to this document
},
} }
Ok(()) Ok(())
@ -270,7 +258,7 @@ impl DocumentWebSocketSink {
async fn send_next_revision(&self) -> FlowyResult<()> { async fn send_next_revision(&self) -> FlowyResult<()> {
match self.provider.next().await? { match self.provider.next().await? {
None => { None => {
tracing::debug!("Finish synchronizing revisions"); tracing::trace!("Finish synchronizing revisions");
Ok(()) Ok(())
}, },
Some(data) => { Some(data) => {

View File

@ -1,8 +1,7 @@
mod edit_queue;
mod editor; mod editor;
mod model; mod editor_edit_cmd_queue;
mod web_socket; mod editor_web_socket;
pub(crate) use edit_queue::*;
pub use editor::*; pub use editor::*;
pub use web_socket::*; pub(crate) use editor_edit_cmd_queue::*;
pub use editor_web_socket::*;

View File

@ -1,48 +0,0 @@
#![allow(clippy::all)]
#![cfg_attr(rustfmt, rustfmt::skip)]
use crate::{errors::FlowyError};
use futures::future::BoxFuture;
use lib_infra::retry::Action;
use lib_ot::revision::RevId;
use std::{future, sync::Arc};
use crate::services::doc::DocumentWebSocket;
#[allow(dead_code)]
pub(crate) struct OpenDocAction {
user_id: String,
rev_id: RevId,
doc_id: String,
ws: Arc<dyn DocumentWebSocket>,
}
#[allow(dead_code)]
impl OpenDocAction {
pub(crate) fn new(user_id: &str, doc_id: &str, rev_id: &RevId, ws: &Arc<dyn DocumentWebSocket>) -> Self {
Self {
user_id: user_id.to_owned(),
rev_id: rev_id.clone(),
doc_id: doc_id.to_owned(),
ws: ws.clone(),
}
}
}
impl Action for OpenDocAction {
type Future = BoxFuture<'static, Result<Self::Item, Self::Error>>;
type Item = ();
type Error = FlowyError;
fn run(&mut self) -> Self::Future {
// let new_doc_user = NewDocUser {
// user_id: self.user_id.clone(),
// rev_id: self.rev_id.clone().into(),
// doc_id: self.doc_id.clone(),
// };
//
// match self.ws.send(new_doc_user.into()) {
// Ok(_) => Box::pin(future::ready(Ok::<(), DocError>(()))),
// Err(e) => Box::pin(future::ready(Err::<(), DocError>(e))),
// }
Box::pin(future::ready(Ok::<(), FlowyError>(())))
}
}

View File

@ -1,11 +1,8 @@
pub mod edit; pub mod edit;
pub mod revision; pub mod revision;
pub(crate) mod controller; pub use crate::services::ws_handlers::*;
mod ws_handlers;
pub use edit::*; pub use edit::*;
pub use revision::*; pub use revision::*;
pub use ws_handlers::*;
pub const SYNC_INTERVAL_IN_MILLIS: u64 = 500; pub const SYNC_INTERVAL_IN_MILLIS: u64 = 1000;

View File

@ -3,26 +3,22 @@ use crate::{
services::doc::revision::{ services::doc::revision::{
cache::{ cache::{
disk::{Persistence, RevisionDiskCache}, disk::{Persistence, RevisionDiskCache},
memory::{RevisionMemoryCache, RevisionMemoryCacheMissing}, memory::{RevisionMemoryCache, RevisionMemoryCacheDelegate},
sync::RevisionSyncSeq, sync::RevisionSyncSeq,
}, },
RevisionRecord, RevisionRecord,
}, },
sql_tables::{RevChangeset, RevTableState},
}; };
use flowy_database::ConnectionPool; use flowy_database::ConnectionPool;
use flowy_error::{internal_error, FlowyResult}; use flowy_error::{internal_error, FlowyResult};
use lib_infra::future::FutureResult; use lib_infra::future::FutureResult;
use lib_ot::{ use lib_ot::revision::{RevState, Revision, RevisionRange};
core::Operation, use std::sync::{
revision::{RevState, Revision, RevisionRange}, atomic::{AtomicI64, Ordering::SeqCst},
rich_text::RichTextDelta, Arc,
};
use std::sync::Arc;
use tokio::{
sync::RwLock,
task::{spawn_blocking, JoinHandle},
}; };
use tokio::task::spawn_blocking;
type DocRevisionDiskCache = dyn RevisionDiskCache<Error = FlowyError>; type DocRevisionDiskCache = dyn RevisionDiskCache<Error = FlowyError>;
@ -31,7 +27,7 @@ pub struct RevisionCache {
pub disk_cache: Arc<DocRevisionDiskCache>, pub disk_cache: Arc<DocRevisionDiskCache>,
memory_cache: Arc<RevisionMemoryCache>, memory_cache: Arc<RevisionMemoryCache>,
sync_seq: Arc<RevisionSyncSeq>, sync_seq: Arc<RevisionSyncSeq>,
defer_save: RwLock<Option<JoinHandle<()>>>, latest_rev_id: AtomicI64,
} }
impl RevisionCache { impl RevisionCache {
@ -45,7 +41,7 @@ impl RevisionCache {
disk_cache, disk_cache,
memory_cache, memory_cache,
sync_seq, sync_seq,
defer_save: RwLock::new(None), latest_rev_id: AtomicI64::new(0),
} }
} }
@ -54,13 +50,14 @@ impl RevisionCache {
if self.memory_cache.contains(&revision.rev_id) { if self.memory_cache.contains(&revision.rev_id) {
return Err(FlowyError::internal().context(format!("Duplicate revision id: {}", revision.rev_id))); return Err(FlowyError::internal().context(format!("Duplicate revision id: {}", revision.rev_id)));
} }
let rev_id = revision.rev_id;
let record = RevisionRecord { let record = RevisionRecord {
revision, revision,
state: RevState::StateLocal, state: RevState::StateLocal,
}; };
let _ = self.memory_cache.add_revision(&record).await; let _ = self.memory_cache.add_revision(&record).await;
self.sync_seq.add_revision(record).await?; self.sync_seq.add_revision(record).await?;
self.save_revisions().await; let _ = self.latest_rev_id.fetch_update(SeqCst, SeqCst, |_e| Some(rev_id));
Ok(()) Ok(())
} }
@ -69,58 +66,63 @@ impl RevisionCache {
if self.memory_cache.contains(&revision.rev_id) { if self.memory_cache.contains(&revision.rev_id) {
return Err(FlowyError::internal().context(format!("Duplicate revision id: {}", revision.rev_id))); return Err(FlowyError::internal().context(format!("Duplicate revision id: {}", revision.rev_id)));
} }
let rev_id = revision.rev_id;
let record = RevisionRecord { let record = RevisionRecord {
revision, revision,
state: RevState::StateLocal, state: RevState::Acked,
}; };
self.memory_cache.add_revision(&record).await; self.memory_cache.add_revision(&record).await;
self.save_revisions().await; let _ = self.latest_rev_id.fetch_update(SeqCst, SeqCst, |_e| Some(rev_id));
Ok(()) Ok(())
} }
#[tracing::instrument(level = "debug", skip(self, rev_id), fields(rev_id = %rev_id))] #[tracing::instrument(level = "debug", skip(self, rev_id), fields(rev_id = %rev_id))]
pub async fn ack_revision(&self, rev_id: i64) { pub async fn ack_revision(&self, rev_id: i64) {
self.sync_seq.ack_revision(&rev_id).await; if self.sync_seq.ack_revision(&rev_id).await.is_ok() {
self.save_revisions().await; self.memory_cache.ack_revision(&rev_id).await;
}
pub async fn get_revision(&self, _doc_id: &str, rev_id: i64) -> Option<RevisionRecord> {
self.memory_cache.get_revision(&rev_id).await
}
async fn save_revisions(&self) {
// https://github.com/async-graphql/async-graphql/blob/ed8449beec3d9c54b94da39bab33cec809903953/src/dataloader/mod.rs#L362
if let Some(handler) = self.defer_save.write().await.take() {
handler.abort();
} }
}
// if self.sync_seq.is_empty() { pub fn latest_rev_id(&self) -> i64 { self.latest_rev_id.load(SeqCst) }
// return;
// }
// let memory_cache = self.sync_seq.clone(); pub async fn get_revision(&self, doc_id: &str, rev_id: i64) -> Option<RevisionRecord> {
// let disk_cache = self.disk_cache.clone(); match self.memory_cache.get_revision(&rev_id).await {
// *self.defer_save.write().await = Some(tokio::spawn(async move { None => match self.disk_cache.read_revision(&self.doc_id, rev_id) {
// tokio::time::sleep(Duration::from_millis(300)).await; Ok(Some(revision)) => Some(revision),
// let (ids, records) = memory_cache.revisions(); Ok(None) => {
// match disk_cache.create_revisions(records) { tracing::warn!("Can't find revision in {} with rev_id: {}", doc_id, rev_id);
// Ok(_) => { None
// memory_cache.remove_revisions(ids); },
// }, Err(e) => {
// Err(e) => log::error!("Save revision failed: {:?}", e), tracing::error!("{}", e);
// } None
// })); },
},
Some(revision) => Some(revision),
}
} }
pub async fn revisions_in_range(&self, range: RevisionRange) -> FlowyResult<Vec<Revision>> { pub async fn revisions_in_range(&self, range: RevisionRange) -> FlowyResult<Vec<Revision>> {
let records = self.memory_cache.get_revisions_in_range(&range).await?; let mut records = self.memory_cache.get_revisions_in_range(&range).await?;
let range_len = range.len() as usize;
if records.len() != range_len {
let disk_cache = self.disk_cache.clone();
let doc_id = self.doc_id.clone();
records = spawn_blocking(move || disk_cache.revisions_in_range(&doc_id, &range))
.await
.map_err(internal_error)??;
if records.len() != range_len {
log::error!("Revisions len is not equal to range required");
}
}
Ok(records Ok(records
.into_iter() .into_iter()
.map(|record| record.revision) .map(|record| record.revision)
.collect::<Vec<Revision>>()) .collect::<Vec<Revision>>())
} }
pub(crate) fn next_revision(&self) -> FutureResult<Option<Revision>, FlowyError> { pub(crate) fn next_sync_revision(&self) -> FutureResult<Option<Revision>, FlowyError> {
let sync_seq = self.sync_seq.clone(); let sync_seq = self.sync_seq.clone();
let disk_cache = self.disk_cache.clone(); let disk_cache = self.disk_cache.clone();
let doc_id = self.doc_id.clone(); let doc_id = self.doc_id.clone();
@ -139,32 +141,20 @@ impl RevisionCache {
} }
} }
impl RevisionMemoryCacheMissing for Arc<Persistence> { impl RevisionMemoryCacheDelegate for Arc<Persistence> {
fn get_revision_record(&self, doc_id: &str, rev_id: i64) -> Result<Option<RevisionRecord>, FlowyError> { fn receive_checkpoint(&self, records: Vec<RevisionRecord>) -> FlowyResult<()> { self.create_revisions(records) }
match self.read_revision(&doc_id, rev_id)? {
None => { fn receive_ack(&self, doc_id: &str, rev_id: i64) {
tracing::warn!("Can't find revision in {} with rev_id: {}", doc_id, rev_id); let changeset = RevChangeset {
Ok(None) doc_id: doc_id.to_string(),
}, rev_id: rev_id.into(),
Some(record) => Ok(Some(record)), state: RevTableState::Acked,
};
match self.update_revisions(vec![changeset]) {
Ok(_) => {},
Err(e) => tracing::error!("{}", e),
} }
} }
fn get_revision_records_with_range(
&self,
doc_id: &str,
range: RevisionRange,
) -> FutureResult<Vec<RevisionRecord>, FlowyError> {
let disk_cache = self.clone();
let doc_id = doc_id.to_owned();
FutureResult::new(async move {
let records = spawn_blocking(move || disk_cache.revisions_in_range(&doc_id, &range))
.await
.map_err(internal_error)??;
Ok::<Vec<RevisionRecord>, FlowyError>(records)
})
}
} }
#[cfg(feature = "flowy_unit_test")] #[cfg(feature = "flowy_unit_test")]

View File

@ -1,8 +1,8 @@
use crate::services::doc::revision::RevisionRecord; use crate::services::doc::revision::RevisionRecord;
use crate::sql_tables::RevTableSql; use crate::sql_tables::{RevChangeset, RevTableSql};
use flowy_database::ConnectionPool; use flowy_database::ConnectionPool;
use flowy_error::{internal_error, FlowyError}; use flowy_error::{internal_error, FlowyError, FlowyResult};
use lib_ot::revision::RevisionRange; use lib_ot::revision::RevisionRange;
use std::{fmt::Debug, sync::Arc}; use std::{fmt::Debug, sync::Arc};
@ -12,6 +12,7 @@ pub trait RevisionDiskCache: Sync + Send {
fn revisions_in_range(&self, doc_id: &str, range: &RevisionRange) -> Result<Vec<RevisionRecord>, Self::Error>; fn revisions_in_range(&self, doc_id: &str, range: &RevisionRange) -> Result<Vec<RevisionRecord>, Self::Error>;
fn read_revision(&self, doc_id: &str, rev_id: i64) -> Result<Option<RevisionRecord>, Self::Error>; fn read_revision(&self, doc_id: &str, rev_id: i64) -> Result<Option<RevisionRecord>, Self::Error>;
fn read_revisions(&self, doc_id: &str) -> Result<Vec<RevisionRecord>, Self::Error>; fn read_revisions(&self, doc_id: &str) -> Result<Vec<RevisionRecord>, Self::Error>;
fn update_revisions(&self, changesets: Vec<RevChangeset>) -> FlowyResult<()>;
} }
pub(crate) struct Persistence { pub(crate) struct Persistence {
@ -47,6 +48,17 @@ impl RevisionDiskCache for Persistence {
let some = RevTableSql::read_rev_tables(&self.user_id, doc_id, &*conn)?; let some = RevTableSql::read_rev_tables(&self.user_id, doc_id, &*conn)?;
Ok(some) Ok(some)
} }
fn update_revisions(&self, changesets: Vec<RevChangeset>) -> FlowyResult<()> {
let conn = &*self.pool.get().map_err(internal_error)?;
let _ = conn.immediate_transaction::<_, FlowyError, _>(|| {
for changeset in changesets {
let _ = RevTableSql::update_rev_table(changeset, conn)?;
}
Ok(())
})?;
Ok(())
}
} }
impl Persistence { impl Persistence {

View File

@ -1,87 +1,116 @@
use crate::services::doc::RevisionRecord; use crate::services::doc::RevisionRecord;
use dashmap::DashMap; use dashmap::DashMap;
use flowy_error::FlowyError; use flowy_error::{FlowyError, FlowyResult};
use lib_infra::future::FutureResult;
use lib_ot::revision::RevisionRange;
use std::sync::Arc;
use tokio::sync::RwLock;
pub(crate) trait RevisionMemoryCacheMissing: Send + Sync { use lib_ot::revision::RevisionRange;
fn get_revision_record(&self, doc_id: &str, rev_id: i64) -> Result<Option<RevisionRecord>, FlowyError>; use std::{sync::Arc, time::Duration};
fn get_revision_records_with_range( use tokio::{sync::RwLock, task::JoinHandle};
&self,
doc_id: &str, pub(crate) trait RevisionMemoryCacheDelegate: Send + Sync {
range: RevisionRange, fn receive_checkpoint(&self, records: Vec<RevisionRecord>) -> FlowyResult<()>;
) -> FutureResult<Vec<RevisionRecord>, FlowyError>; fn receive_ack(&self, doc_id: &str, rev_id: i64);
} }
pub(crate) struct RevisionMemoryCache { pub(crate) struct RevisionMemoryCache {
doc_id: String, doc_id: String,
revs_map: Arc<DashMap<i64, RevisionRecord>>, revs_map: Arc<DashMap<i64, RevisionRecord>>,
rev_loader: Arc<dyn RevisionMemoryCacheMissing>, delegate: Arc<dyn RevisionMemoryCacheDelegate>,
revs_order: Arc<RwLock<Vec<i64>>>, pending_write_revs: Arc<RwLock<Vec<i64>>>,
defer_save: RwLock<Option<JoinHandle<()>>>,
} }
// TODO: remove outdated revisions to reduce memory usage
impl RevisionMemoryCache { impl RevisionMemoryCache {
pub(crate) fn new(doc_id: &str, rev_loader: Arc<dyn RevisionMemoryCacheMissing>) -> Self { pub(crate) fn new(doc_id: &str, delegate: Arc<dyn RevisionMemoryCacheDelegate>) -> Self {
RevisionMemoryCache { RevisionMemoryCache {
doc_id: doc_id.to_owned(), doc_id: doc_id.to_owned(),
revs_map: Arc::new(DashMap::new()), revs_map: Arc::new(DashMap::new()),
rev_loader, delegate,
revs_order: Arc::new(RwLock::new(vec![])), pending_write_revs: Arc::new(RwLock::new(vec![])),
defer_save: RwLock::new(None),
} }
} }
pub(crate) async fn is_empty(&self) -> bool { self.revs_order.read().await.is_empty() }
pub(crate) fn contains(&self, rev_id: &i64) -> bool { self.revs_map.contains_key(rev_id) } pub(crate) fn contains(&self, rev_id: &i64) -> bool { self.revs_map.contains_key(rev_id) }
pub(crate) async fn add_revision(&self, record: &RevisionRecord) { pub(crate) async fn add_revision(&self, record: &RevisionRecord) {
if let Some(rev_id) = self.revs_order.read().await.last() { if let Some(rev_id) = self.pending_write_revs.read().await.last() {
if *rev_id >= record.revision.rev_id { if *rev_id >= record.revision.rev_id {
tracing::error!("Duplicated revision added to memory_cache"); tracing::error!("Duplicated revision added to memory_cache");
return; return;
} }
} }
// FIXME: Remove outdated revisions to reduce memory usage
self.revs_map.insert(record.revision.rev_id, record.clone()); self.revs_map.insert(record.revision.rev_id, record.clone());
self.revs_order.write().await.push(record.revision.rev_id); self.pending_write_revs.write().await.push(record.revision.rev_id);
self.make_checkpoint().await;
}
pub(crate) async fn ack_revision(&self, rev_id: &i64) {
match self.revs_map.get_mut(rev_id) {
None => {},
Some(mut record) => record.ack(),
}
if !self.pending_write_revs.read().await.contains(rev_id) {
// The revision must be saved on disk if the pending_write_revs
// doesn't contains the rev_id.
self.delegate.receive_ack(&self.doc_id, *rev_id);
} else {
self.make_checkpoint().await;
}
} }
pub(crate) async fn get_revision(&self, rev_id: &i64) -> Option<RevisionRecord> { pub(crate) async fn get_revision(&self, rev_id: &i64) -> Option<RevisionRecord> {
match self.revs_map.get(&rev_id).map(|r| r.value().clone()) { self.revs_map.get(&rev_id).map(|r| r.value().clone())
None => match self.rev_loader.get_revision_record(&self.doc_id, *rev_id) {
Ok(revision) => revision,
Err(e) => {
tracing::error!("{}", e);
None
},
},
Some(revision) => Some(revision),
}
} }
pub(crate) async fn get_revisions_in_range( pub(crate) async fn get_revisions_in_range(
&self, &self,
range: &RevisionRange, range: &RevisionRange,
) -> Result<Vec<RevisionRecord>, FlowyError> { ) -> Result<Vec<RevisionRecord>, FlowyError> {
let range_len = range.len() as usize;
let revs = range let revs = range
.iter() .iter()
.flat_map(|rev_id| self.revs_map.get(&rev_id).map(|record| record.clone())) .flat_map(|rev_id| self.revs_map.get(&rev_id).map(|record| record.clone()))
.collect::<Vec<RevisionRecord>>(); .collect::<Vec<RevisionRecord>>();
Ok(revs)
}
if revs.len() == range_len { async fn make_checkpoint(&self) {
Ok(revs) // https://github.com/async-graphql/async-graphql/blob/ed8449beec3d9c54b94da39bab33cec809903953/src/dataloader/mod.rs#L362
} else { if let Some(handler) = self.defer_save.write().await.take() {
let revs = self handler.abort();
.rev_loader
.get_revision_records_with_range(&self.doc_id, range.clone())
.await?;
if revs.len() != range_len {
log::error!("Revisions len is not equal to range required");
}
Ok(revs)
} }
if self.pending_write_revs.read().await.is_empty() {
return;
}
let rev_map = self.revs_map.clone();
let pending_write_revs = self.pending_write_revs.clone();
let delegate = self.delegate.clone();
*self.defer_save.write().await = Some(tokio::spawn(async move {
tokio::time::sleep(Duration::from_millis(300)).await;
let mut revs_write_guard = pending_write_revs.write().await;
// FIXME:
// It may cause performance issues because we hold the write lock of the
// rev_order and the lock will be released after the checkpoint has been written
// to the disk.
//
// Use saturating_sub and split_off ?
// https://stackoverflow.com/questions/28952411/what-is-the-idiomatic-way-to-pop-the-last-n-elements-in-a-mutable-vec
let mut save_records: Vec<RevisionRecord> = vec![];
revs_write_guard.iter().for_each(|rev_id| match rev_map.get(rev_id) {
None => {},
Some(value) => {
save_records.push(value.value().clone());
},
});
if delegate.receive_checkpoint(save_records).is_ok() {
revs_write_guard.clear();
drop(revs_write_guard);
}
}));
} }
} }

View File

@ -1,5 +1,6 @@
use crate::services::doc::revision::RevisionRecord; use crate::services::doc::revision::RevisionRecord;
use dashmap::DashMap; use dashmap::DashMap;
use flowy_error::{FlowyError, FlowyResult};
use lib_ot::errors::OTError; use lib_ot::errors::OTError;
use std::{collections::VecDeque, sync::Arc}; use std::{collections::VecDeque, sync::Arc};
use tokio::sync::RwLock; use tokio::sync::RwLock;
@ -30,34 +31,33 @@ impl RevisionSyncSeq {
.context(format!("The new revision's id must be greater than {}", rev_id))); .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.revs_map.insert(record.revision.rev_id, record);
Ok(()) Ok(())
} }
pub async fn ack_revision(&self, rev_id: &i64) { pub async fn ack_revision(&self, rev_id: &i64) -> FlowyResult<()> {
if let Some(pop_rev_id) = self.next_sync_rev_id().await { if let Some(pop_rev_id) = self.next_sync_rev_id().await {
if &pop_rev_id != rev_id { if &pop_rev_id != rev_id {
tracing::error!("The next ack rev_id must be equal to the next rev_id"); let desc = format!(
assert_eq!(&pop_rev_id, rev_id); "The ack rev_id:{} is not equal to the current rev_id:{}",
return; rev_id, pop_rev_id
);
// tracing::error!("{}", desc);
return Err(FlowyError::internal().context(desc));
} }
tracing::debug!("pop revision {}", pop_rev_id); tracing::debug!("pop revision {}", pop_rev_id);
self.revs_map.remove(&pop_rev_id); self.revs_map.remove(&pop_rev_id);
let _ = self.local_revs.write().await.pop_front(); let _ = self.local_revs.write().await.pop_front();
} }
Ok(())
} }
pub async fn next_sync_revision(&self) -> Option<(i64, RevisionRecord)> { pub async fn next_sync_revision(&self) -> Option<(i64, RevisionRecord)> {
match self.local_revs.read().await.front() { match self.local_revs.read().await.front() {
None => None, None => None,
Some(rev_id) => match self.revs_map.get(rev_id).map(|r| (*r.key(), r.value().clone())) { Some(rev_id) => self.revs_map.get(rev_id).map(|r| (*r.key(), r.value().clone())),
None => None,
Some(val) => {
tracing::debug!("{}:try send revision {}", val.1.revision.doc_id, val.1.revision.rev_id);
Some(val)
},
},
} }
} }

View File

@ -102,7 +102,9 @@ impl RevisionManager {
Ok(revision) Ok(revision)
} }
pub fn next_sync_revision(&self) -> FutureResult<Option<Revision>, FlowyError> { self.cache.next_revision() } pub fn next_sync_revision(&self) -> FutureResult<Option<Revision>, FlowyError> { self.cache.next_sync_revision() }
pub fn latest_rev_id(&self) -> i64 { self.cache.latest_rev_id() }
} }
#[cfg(feature = "flowy_unit_test")] #[cfg(feature = "flowy_unit_test")]
@ -134,7 +136,7 @@ impl RevisionLoader {
&self.user_id, &self.user_id,
doc_md5, doc_md5,
); );
let _ = self.cache.add_remote_revision(revision.clone()).await?; let _ = self.cache.add_local_revision(revision.clone()).await?;
revisions = vec![revision]; revisions = vec![revision];
} else { } else {
for record in &records { for record in &records {

View File

@ -1,2 +1,4 @@
pub(crate) mod controller;
pub mod doc; pub mod doc;
pub mod server; pub mod server;
mod ws_handlers;

View File

@ -32,7 +32,6 @@ impl RevTableSql {
Ok(()) Ok(())
} }
#[allow(dead_code)]
pub(crate) fn update_rev_table(changeset: RevChangeset, conn: &SqliteConnection) -> Result<(), FlowyError> { pub(crate) fn update_rev_table(changeset: RevChangeset, conn: &SqliteConnection) -> Result<(), FlowyError> {
let filter = dsl::rev_table let filter = dsl::rev_table
.filter(dsl::rev_id.eq(changeset.rev_id.as_ref())) .filter(dsl::rev_id.eq(changeset.rev_id.as_ref()))

View File

@ -128,8 +128,7 @@ impl RevTableType {
} }
impl_sql_integer_expression!(RevTableType); impl_sql_integer_expression!(RevTableType);
#[allow(dead_code)] pub struct RevChangeset {
pub(crate) struct RevChangeset {
pub(crate) doc_id: String, pub(crate) doc_id: String,
pub(crate) rev_id: RevId, pub(crate) rev_id: RevId,
pub(crate) state: RevTableState, pub(crate) state: RevTableState,

View File

@ -81,12 +81,6 @@ impl ServerDocManager {
} }
pub async fn create_doc(&self, revision: Revision) -> Result<Arc<OpenDocHandle>, CollaborateError> { pub async fn create_doc(&self, revision: Revision) -> Result<Arc<OpenDocHandle>, CollaborateError> {
if !revision.is_initial() {
return Err(
CollaborateError::revision_conflict().context("Revision's rev_id should be 0 when creating the doc")
);
}
let doc = self.persistence.create_doc(revision).await?; let doc = self.persistence.create_doc(revision).await?;
let handler = self.cache(doc).await?; let handler = self.cache(doc).await?;
Ok(handler) Ok(handler)

View File

@ -95,6 +95,18 @@ impl WsDocumentDataBuilder {
id: Some(cloned_rev_id), id: Some(cloned_rev_id),
} }
} }
// DocumentWSDataType::UserConnect -> DocumentConnected
pub fn build_document_conn_message(doc_id: &str, document_conn: DocumentConnected) -> DocumentWSData {
let rev_id = document_conn.rev_id;
let bytes: Bytes = document_conn.try_into().unwrap();
DocumentWSData {
doc_id: doc_id.to_string(),
ty: DocumentWSDataType::UserConnect,
data: bytes.to_vec(),
id: Some(rev_id),
}
}
} }
#[derive(ProtoBuf, Default, Debug, Clone)] #[derive(ProtoBuf, Default, Debug, Clone)]

View File

@ -39,6 +39,7 @@ impl Revision {
pub fn pair_rev_id(&self) -> (i64, i64) { (self.base_rev_id, self.rev_id) } pub fn pair_rev_id(&self) -> (i64, i64) { (self.base_rev_id, self.rev_id) }
#[allow(dead_code)]
pub fn is_initial(&self) -> bool { self.rev_id == 0 } pub fn is_initial(&self) -> bool { self.rev_id == 0 }
} }