chore: automatically map uid to client id (#434)

* chore: automatically map uid to client id

* chore: add test to confirm that user data is not written automatically for readonly transactions

* chore: improved editors between implementation

Author: Horusiath

Cargo.lock

@@ -3,7 +3,7 @@ members = ["collab"]
 resolver = "2"
 
 [workspace.dependencies]
-yrs = { version = "0.24", features = ["sync"] }
+yrs = { version = "0.25", features = ["sync"] }
 anyhow = "1.0.94"
 thiserror = "1.0.39"
 serde = { version = "1.0.157", features = ["derive"] }

Cargo.toml

@@ -29,7 +29,7 @@ use yrs::{
 
 use crate::entity::{EncodedCollab, EncoderVersion};
 use crate::error::CollabError;
-use crate::preclude::JsonValue;
+use crate::preclude::{JsonValue, PermanentUserData};
 use uuid::Uuid;
 
 pub const DATA_SECTION: &str = "data";
@@ -87,17 +87,25 @@ pub struct CollabContext {
   /// The current transaction that is being executed.
   current_txn: Option<TransactionMut<'static>>,
   version: Option<CollabVersion>,
+  /// Structure managing list of editors.
+  editors: Option<PermanentUserData>,
 }
 
 unsafe impl Send for CollabContext {}
 unsafe impl Sync for CollabContext {}
 
 impl CollabContext {
-  fn new(origin: CollabOrigin, awareness: Awareness, version: Option<CollabVersion>) -> Self {
+  fn new(
+    origin: CollabOrigin,
+    awareness: Awareness,
+    version: Option<CollabVersion>,
+    user_data: Option<PermanentUserData>,
+  ) -> Self {
     CollabContext {
       origin,
       awareness,
       version,
+      editors: user_data,
       undo_manager: None,
       current_txn: None,
     }
@@ -111,6 +119,10 @@ impl CollabContext {
     &mut self.version
   }
 
+  pub fn user_data(&self) -> Option<&PermanentUserData> {
+    self.editors.as_ref()
+  }
+
   pub fn with_txn<F, T>(&mut self, f: F) -> Result<T, CollabError>
   where
     F: FnOnce(&mut TransactionMut) -> T,
@@ -304,6 +316,7 @@ pub struct CollabOptions {
   pub data_source: Option<DataSource>,
   pub client_id: ClientID,
   pub skip_gc: bool,
+  pub remember_user: bool,
 }
 
 impl Display for CollabOptions {
@@ -324,6 +337,7 @@ impl CollabOptions {
       data_source: None,
       client_id,
       skip_gc: false,
+      remember_user: false,
     }
   }
 
@@ -332,6 +346,11 @@ impl CollabOptions {
     self
   }
 
+  pub fn with_remember_user(mut self, remember_user: bool) -> Self {
+    self.remember_user = remember_user;
+    self
+  }
+
   pub fn with_gc(mut self, gc: bool) -> Self {
     self.skip_gc = !gc;
     self
@@ -356,12 +375,18 @@ impl Collab {
     let plugins = Plugins::new(vec![]);
     let state = Arc::new(State::new(&object_id.to_string()));
     let awareness = Awareness::new(doc);
+    let user_data = if options.remember_user {
+      Some(PermanentUserData::new(awareness.doc(), origin.clone()))
+    } else {
+      None
+    };
     let mut this = Self {
       object_id,
       context: CollabContext::new(
         origin,
         awareness,
         options.data_source.as_ref().and_then(DataSource::version),
+        user_data,
       ),
       state,
       data,
@@ -431,7 +456,7 @@ impl Collab {
       object_id,
       // if not the fact that we need origin here, it would be
       // not necessary either
-      context: CollabContext::new(origin, awareness, None),
+      context: CollabContext::new(origin, awareness, None, None),
       state,
       data,
       meta,