chore: use option uid

Author: appflowy

collab/src/folder/folder.rs

@@ -52,7 +52,7 @@ pub(crate) fn subscribe_view_change(
                           txn,
                           &view_relations,
                           &section_map,
-                          uid,
+                          Some(uid),
                           mappings,
                         ) {
                           deletion_cache.insert(view.id, Arc::new(view.clone()));
@@ -78,7 +78,7 @@ pub(crate) fn subscribe_view_change(
                         txn,
                         &view_relations,
                         &section_map,
-                        uid,
+                        Some(uid),
                         mappings,
                       ) {
                         // Update deletion cache with the updated view

collab/src/folder/folder_observe.rs

@@ -45,11 +45,11 @@ impl SectionMap {
     &self,
     txn: &T,
     section: Section,
-    uid: i64,
+    uid: Option<i64>,
   ) -> Option<SectionOperation> {
     let container = self.get_section(txn, section.as_ref())?;
     Some(SectionOperation {
-      uid: UserId::from(uid),
+      uid: uid.map(UserId::from),
       container,
       section,
       change_tx: self.change_tx.clone(),
@@ -119,7 +119,7 @@ pub enum TrashSectionChange {
 pub type SectionsByUid = HashMap<UserId, Vec<SectionItem>>;
 
 pub struct SectionOperation {
-  uid: UserId,
+  uid: Option<UserId>,
   container: MapRef,
   section: Section,
   change_tx: Option<SectionChangeSender>,
@@ -130,8 +130,8 @@ impl SectionOperation {
     &self.container
   }
 
-  fn uid(&self) -> &UserId {
-    &self.uid
+  fn uid(&self) -> Option<&UserId> {
+    self.uid.as_ref()
   }
 
   pub fn get_sections<T: ReadTxn>(&self, txn: &T) -> SectionsByUid {
@@ -154,9 +154,12 @@ impl SectionOperation {
   }
 
   pub fn contains_with_txn<T: ReadTxn>(&self, txn: &T, view_id: &ViewId) -> bool {
+    let Some(uid) = self.uid() else {
+      return false;
+    };
     match self
       .container()
-      .get_with_txn::<_, ArrayRef>(txn, self.uid().as_ref())
+      .get_with_txn::<_, ArrayRef>(txn, uid.as_ref())
     {
       None => false,
       Some(array) => {
@@ -173,9 +176,12 @@ impl SectionOperation {
   }
 
   pub fn get_all_section_item<T: ReadTxn>(&self, txn: &T) -> Vec<SectionItem> {
+    let Some(uid) = self.uid() else {
+      return vec![];
+    };
     match self
       .container()
-      .get_with_txn::<_, ArrayRef>(txn, self.uid().as_ref())
+      .get_with_txn::<_, ArrayRef>(txn, uid.as_ref())
     {
       None => vec![],
       Some(array) => {
@@ -201,6 +207,9 @@ impl SectionOperation {
     id: T,
     prev_id: Option<T>,
   ) {
+    let Some(uid) = self.uid() else {
+      return;
+    };
     let section_items = self.get_all_section_item(txn);
     let id = id.as_ref();
     let old_pos = section_items
@@ -217,7 +226,7 @@ impl SectionOperation {
       .unwrap_or(0);
     let section_array = self
       .container()
-      .get_with_txn::<_, ArrayRef>(txn, self.uid().as_ref());
+      .get_with_txn::<_, ArrayRef>(txn, uid.as_ref());
     // If the new position index is greater than the length of the section, yrs will panic
     if new_pos > section_items.len() as u32 {
       return;
@@ -233,9 +242,12 @@ impl SectionOperation {
     txn: &mut TransactionMut,
     ids: Vec<T>,
   ) {
+    let Some(uid) = self.uid() else {
+      return;
+    };
     if let Some(fav_array) = self
       .container()
-      .get_with_txn::<_, ArrayRef>(txn, self.uid().as_ref())
+      .get_with_txn::<_, ArrayRef>(txn, uid.as_ref())
     {
       for id in &ids {
         if let Some(pos) = self
@@ -267,8 +279,11 @@ impl SectionOperation {
   }
 
   pub fn add_sections_item(&self, txn: &mut TransactionMut, items: Vec<SectionItem>) {
+    let Some(uid) = self.uid() else {
+      return;
+    };
     let item_ids = items.iter().map(|item| item.id).collect::<Vec<_>>();
-    self.add_sections_for_user_with_txn(txn, self.uid(), items);
+    self.add_sections_for_user_with_txn(txn, uid, items);
     if let Some(change_tx) = self.change_tx.as_ref() {
       match self.section {
         Section::Favorite => {},
@@ -298,9 +313,12 @@ impl SectionOperation {
   }
 
   pub fn clear(&self, txn: &mut TransactionMut) {
+    let Some(uid) = self.uid() else {
+      return;
+    };
     if let Some(array) = self
       .container()
-      .get_with_txn::<_, ArrayRef>(txn, self.uid().as_ref())
+      .get_with_txn::<_, ArrayRef>(txn, uid.as_ref())
     {
       let len = array.iter(txn).count();
       array.remove_range(txn, 0, len as u32);

collab/src/folder/section.rs

@@ -72,7 +72,11 @@ impl ViewsMap {
     }
   }
 
-  pub async fn observe_view_change(&self, uid: i64, views: HashMap<ViewId, Arc<View>>) {
+  /// Observe view changes for a specific user. Requires uid to properly track user-specific changes.
+  pub async fn observe_view_change(&self, uid: Option<i64>, views: HashMap<ViewId, Arc<View>>) {
+    let Some(uid) = uid else {
+      return; // Cannot observe changes without uid
+    };
     for (k, v) in views {
       self.deletion_cache.insert(k, v);
     }
@@ -157,11 +161,12 @@ impl ViewsMap {
     }
   }
 
+  /// Get views belonging to a parent. When uid is provided, includes user-specific enrichment.
   pub fn get_views_belong_to<T: ReadTxn>(
     &self,
     txn: &T,
     parent_view_id: &ViewId,
-    uid: i64,
+    uid: Option<i64>,
   ) -> Vec<Arc<View>> {
     match self.get_view_with_txn(txn, parent_view_id, uid) {
       Some(root_view) => root_view
@@ -205,14 +210,16 @@ impl ViewsMap {
     }
   }
 
-  pub fn get_views<T: ReadTxn>(&self, txn: &T, view_ids: &[ViewId], uid: i64) -> Vec<Arc<View>> {
+  /// Get multiple views by ids. When uid is provided, includes user-specific enrichment.
+  pub fn get_views<T: ReadTxn>(&self, txn: &T, view_ids: &[ViewId], uid: Option<i64>) -> Vec<Arc<View>> {
     view_ids
       .iter()
       .flat_map(|view_id| self.get_view_with_txn(txn, view_id, uid))
       .collect::<Vec<_>>()
   }
 
-  pub fn get_all_views<T: ReadTxn>(&self, txn: &T, uid: i64) -> Vec<Arc<View>> {
+  /// Get all views. When uid is provided, includes user-specific enrichment like is_favorite.
+  pub fn get_all_views<T: ReadTxn>(&self, txn: &T, uid: Option<i64>) -> Vec<Arc<View>> {
     // since views can be mapped through revisions, we need a map of final_view_id and its predecessors
 
     // first split the keys into ones that have existing mappings (roots) and ones that have not more mapping (leafs)
@@ -252,14 +259,16 @@ impl ViewsMap {
       .collect()
   }
 
+  /// Get a view by id. When uid is provided, includes user-specific enrichment like is_favorite.
   #[instrument(level = "trace", skip_all)]
-  pub fn get_view<T: ReadTxn>(&self, txn: &T, view_id: &ViewId, uid: i64) -> Option<Arc<View>> {
+  pub fn get_view<T: ReadTxn>(&self, txn: &T, view_id: &ViewId, uid: Option<i64>) -> Option<Arc<View>> {
     self.get_view_with_txn(txn, view_id, uid)
   }
 
-  /// Return the orphan views.d
+  /// Return the orphan views.
   /// The orphan views are the views that its parent_view_id equal to its view_id.
-  pub fn get_orphan_views_with_txn<T: ReadTxn>(&self, txn: &T, uid: i64) -> Vec<Arc<View>> {
+  /// When uid is provided, includes user-specific enrichment.
+  pub fn get_orphan_views_with_txn<T: ReadTxn>(&self, txn: &T, uid: Option<i64>) -> Vec<Arc<View>> {
     self
       .container
       .keys(txn)
@@ -279,7 +288,7 @@ impl ViewsMap {
     &self,
     txn: &T,
     view_id: &ViewId,
-    uid: i64,
+    uid: Option<i64>,
   ) -> Option<Arc<View>> {
     let (view_id, mappings) = self.revision_map.mappings(txn, *view_id);
     let map_ref = self.container.get_with_txn(txn, &view_id.to_string())?;
@@ -297,11 +306,12 @@ impl ViewsMap {
   /// Gets a view with stronger consistency guarantees, bypassing cache when needed
   /// Use this during transactions that might have uncommitted changes
   /// Note: Since we removed the cache, this is now identical to get_view_with_txn
+  /// When uid is provided, includes user-specific enrichment like is_favorite.
   pub fn get_view_with_strong_consistency<T: ReadTxn>(
     &self,
     txn: &T,
     view_id: &ViewId,
-    uid: i64,
+    uid: Option<i64>,
   ) -> Option<Arc<View>> {
     self.get_view_with_txn(txn, view_id, uid)
   }
@@ -493,7 +503,7 @@ impl ViewsMap {
     new_view_id: &ViewId,
     uid: i64,
   ) -> bool {
-    if let Some(old_view) = self.get_view(txn, old_view_id, uid) {
+    if let Some(old_view) = self.get_view(txn, old_view_id, Some(uid)) {
       let mut new_view = (*old_view).clone();
       new_view.id = *new_view_id;
       new_view.last_edited_by = Some(uid);
@@ -517,7 +527,7 @@ pub(crate) fn view_from_map_ref<T: ReadTxn>(
   txn: &T,
   view_relations: &Arc<ParentChildRelations>,
   section_map: &SectionMap,
-  uid: i64,
+  uid: Option<i64>,
   mappings: impl IntoIterator<Item = ViewId>,
 ) -> Option<View> {
   let parent_view_id: String = map_ref.get_with_txn(txn, VIEW_PARENT_ID)?;
@@ -556,9 +566,12 @@ pub(crate) fn view_from_map_ref<T: ReadTxn>(
   }
 
   let icon = get_icon_from_view_map(map_ref, txn);
-  let is_favorite = section_map
-    .section_op(txn, Section::Favorite, uid)
-    .map(|op| op.contains_with_txn(txn, &id))
+  let is_favorite = uid
+    .and_then(|uid| {
+      section_map
+        .section_op(txn, Section::Favorite, Some(uid))
+        .map(|op| op.contains_with_txn(txn, &id))
+    })
     .unwrap_or(false);
 
   let created_by = map_ref.get_with_txn(txn, VIEW_CREATED_BY);
@@ -821,7 +834,7 @@ impl<'a, 'b, 'c> ViewUpdate<'a, 'b, 'c> {
     if let Some(private_section) =
       self
         .section_map
-        .section_op(self.txn, Section::Private, self.uid.as_i64())
+        .section_op(self.txn, Section::Private, Some(self.uid.as_i64()))
     {
       if is_private {
         private_section.add_sections_item(self.txn, vec![SectionItem::new(*self.view_id)]);
@@ -837,7 +850,7 @@ impl<'a, 'b, 'c> ViewUpdate<'a, 'b, 'c> {
     if let Some(fav_section) =
       self
         .section_map
-        .section_op(self.txn, Section::Favorite, self.uid.as_i64())
+        .section_op(self.txn, Section::Favorite, Some(self.uid.as_i64()))
     {
       if is_favorite {
         fav_section.add_sections_item(self.txn, vec![SectionItem::new(*self.view_id)]);
@@ -861,7 +874,7 @@ impl<'a, 'b, 'c> ViewUpdate<'a, 'b, 'c> {
     if let Some(trash_section) =
       self
         .section_map
-        .section_op(self.txn, Section::Trash, self.uid.as_i64())
+        .section_op(self.txn, Section::Trash, Some(self.uid.as_i64()))
     {
       if is_trash {
         trash_section.add_sections_item(self.txn, vec![SectionItem::new(*self.view_id)]);
@@ -891,7 +904,7 @@ impl<'a, 'b, 'c> ViewUpdate<'a, 'b, 'c> {
       self.txn,
       &self.children_map,
       self.section_map,
-      self.uid.as_i64(),
+      Some(self.uid.as_i64()),
       [],
     )
   }

collab/src/folder/view.rs

@@ -139,7 +139,7 @@ fn plain_text_mentions_custom_resolver() {
   let options = PlainTextExportOptions::from_default_resolver(resolver);
 
   let plain = document
-    .to_plain_text_with_options(options)
+    .to_plain_text_with_options(&options)
     .into_iter()
     .filter(|line| !line.trim().is_empty())
     .collect::<Vec<_>>();

collab/tests/document/conversions/plain_text_test.rs

@@ -48,19 +48,19 @@ fn create_child_views_test() {
   let v_1_child_views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &v_1.id, uid.as_i64());
+    .get_views_belong_to(&txn, &v_1.id, Some(uid.as_i64()));
   assert_eq!(v_1_child_views.len(), 3);
 
   let v_1_2_child_views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &v_1_2.id, uid.as_i64());
+    .get_views_belong_to(&txn, &v_1_2.id, Some(uid.as_i64()));
   assert_eq!(v_1_2_child_views.len(), 2);
 
   let workspace_uuid_str = workspace_id.to_string();
   let folder_data = folder
     .body
-    .get_folder_data(&txn, &workspace_uuid_str, uid.as_i64())
+    .get_folder_data(&txn, &workspace_uuid_str, Some(uid.as_i64()))
     .unwrap();
   let value = serde_json::to_value(folder_data).unwrap();
   let fake_w_1_uuid = workspace_uuid_str.clone();
@@ -217,7 +217,7 @@ fn move_child_views_test() {
   let v_1_child_views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &v_1.id, uid.as_i64());
+    .get_views_belong_to(&txn, &v_1.id, Some(uid.as_i64()));
   assert_eq!(
     v_1_child_views[0].id.to_string(),
     uuid::Uuid::new_v5(&uuid::Uuid::NAMESPACE_OID, "1_1".as_bytes()).to_string()
@@ -237,7 +237,7 @@ fn move_child_views_test() {
   let v_1_child_views = folder
     .body
     .views
-    .get_view(&txn, &v_1.id, uid.as_i64())
+    .get_view(&txn, &v_1.id, Some(uid.as_i64()))
     .unwrap();
   assert_eq!(
     v_1_child_views.children[0].id.to_string(),
@@ -283,7 +283,7 @@ fn delete_view_test() {
   let w_1_child_views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &workspace_id, uid.as_i64());
+    .get_views_belong_to(&txn, &workspace_id, Some(uid.as_i64()));
   assert_eq!(
     w_1_child_views[0].id.to_string(),
     uuid::Uuid::new_v5(&uuid::Uuid::NAMESPACE_OID, "1_1".as_bytes()).to_string()
@@ -324,14 +324,14 @@ fn delete_child_view_test() {
   let views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &parse_view_id(&view_1_id), uid.as_i64());
+    .get_views_belong_to(&txn, &parse_view_id(&view_1_id), Some(uid.as_i64()));
   assert_eq!(views.len(), 1);
 
   folder.body.views.delete_views(&mut txn, vec![view_1_1_id]);
   let views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &parse_view_id(&view_1_id), uid.as_i64());
+    .get_views_belong_to(&txn, &parse_view_id(&view_1_id), Some(uid.as_i64()));
   assert!(views.is_empty());
 }
 
@@ -361,19 +361,19 @@ fn create_orphan_child_views_test() {
   let child_views = folder
     .body
     .views
-    .get_views_belong_to(&txn, &workspace_id, uid.as_i64());
+    .get_views_belong_to(&txn, &workspace_id, Some(uid.as_i64()));
   assert_eq!(child_views.len(), 1);
 
   let orphan_views = folder
     .body
     .views
-    .get_orphan_views_with_txn(&txn, uid.as_i64());
+    .get_orphan_views_with_txn(&txn, Some(uid.as_i64()));
   assert_eq!(orphan_views.len(), 1);
 
   // The folder data should contains the orphan view
   let folder_data = folder
     .body
-    .get_folder_data(&txn, &workspace_uuid_str, uid.as_i64())
+    .get_folder_data(&txn, &workspace_uuid_str, Some(uid.as_i64()))
     .unwrap();
   let fake_w_1_uuid = workspace_uuid_str.clone();
   let id_1_uuid = uuid::Uuid::new_v5(&uuid::Uuid::NAMESPACE_OID, "1".as_bytes()).to_string();