use async_trait::async_trait; use std::marker::PhantomData; use std::sync::Arc; use collab_database::fields::{Field, TypeOptionData}; use collab_database::rows::{Cells, Row, RowId}; use flowy_error::{FlowyError, FlowyResult}; use serde::de::DeserializeOwned; use serde::Serialize; use tracing::trace; use crate::entities::{ FieldType, GroupChangesPB, GroupPB, GroupRowsNotificationPB, InsertedGroupPB, InsertedRowPB, RowMetaPB, }; use crate::services::cell::{get_cell_protobuf, CellProtobufBlobParser}; use crate::services::field::{default_type_option_data_from_type, TypeOption, TypeOptionCellData}; use crate::services::group::action::{ DidMoveGroupRowResult, DidUpdateGroupRowResult, GroupController, GroupCustomize, }; use crate::services::group::configuration::GroupControllerContext; use crate::services::group::entities::GroupData; use crate::services::group::{GroupChangeset, GroupsBuilder, MoveGroupRowContext}; #[async_trait] pub trait GroupControllerDelegate: Send + Sync + 'static { async fn get_field(&self, field_id: &str) -> Option; async fn get_all_rows(&self, view_id: &str) -> Vec>; } /// [BaseGroupController] is a generic group controller that provides customized implementations /// of the `GroupController` trait for different field types. /// /// - `C`: represents the group configuration that impl [GroupConfigurationSerde] /// - `G`: group generator, [GroupsBuilder] /// - `P`: parser that impl [CellProtobufBlobParser] for the CellBytes /// /// See also: [DefaultGroupController] which contains the most basic implementation of /// `GroupController` that only has one group. pub struct BaseGroupController { pub grouping_field_id: String, pub context: GroupControllerContext, group_builder_phantom: PhantomData, cell_parser_phantom: PhantomData

, pub delegate: Arc, } impl BaseGroupController where C: Serialize + DeserializeOwned, T: TypeOption + Send + Sync, G: GroupsBuilder, GroupTypeOption = T>, { pub async fn new( grouping_field: &Field, mut configuration: GroupControllerContext, delegate: Arc, ) -> FlowyResult { let field_type = FieldType::from(grouping_field.field_type); let type_option = grouping_field .get_type_option::(&field_type) .unwrap_or_else(|| T::from(default_type_option_data_from_type(field_type))); let generated_groups = G::build(grouping_field, &configuration, &type_option).await; let _ = configuration.init_groups(generated_groups)?; Ok(Self { grouping_field_id: grouping_field.id.clone(), context: configuration, group_builder_phantom: PhantomData, cell_parser_phantom: PhantomData, delegate, }) } pub async fn get_grouping_field_type_option(&self) -> Option { self .delegate .get_field(&self.grouping_field_id) .await .and_then(|field| field.get_type_option::(FieldType::from(field.field_type))) } fn update_no_status_group( &mut self, row: &Row, other_group_changesets: &[GroupRowsNotificationPB], ) -> Option { let no_status_group = self.context.get_mut_no_status_group()?; // [other_group_inserted_row] contains all the inserted rows except the default group. let other_group_inserted_row = other_group_changesets .iter() .flat_map(|changeset| &changeset.inserted_rows) .collect::>(); // Calculate the inserted_rows of the default_group let no_status_group_rows = other_group_changesets .iter() .flat_map(|changeset| &changeset.deleted_rows) .filter(|&row_id| { // if the [other_group_inserted_row] contains the row_id of the row // which means the row should not move to the default group. !other_group_inserted_row .iter() .any(|inserted_row| &inserted_row.row_meta.id == row_id) }) .cloned() .collect::>(); let mut changeset = GroupRowsNotificationPB::new(no_status_group.id.clone()); if !no_status_group_rows.is_empty() { changeset .inserted_rows .push(InsertedRowPB::new(RowMetaPB::from(row))); no_status_group.add_row(row.clone()); } // [other_group_delete_rows] contains all the deleted rows except the default group. let other_group_delete_rows: Vec = other_group_changesets .iter() .flat_map(|changeset| &changeset.deleted_rows) .cloned() .collect(); let default_group_deleted_rows = other_group_changesets .iter() .flat_map(|changeset| &changeset.inserted_rows) .filter(|inserted_row| { // if the [other_group_delete_rows] contain the inserted_row, which means this row should move // out from the default_group. !other_group_delete_rows .iter() .any(|row_id| &inserted_row.row_meta.id == row_id) }) .collect::>(); let mut deleted_row_ids = vec![]; for row in &no_status_group.rows { let row_id = row.id.to_string(); if default_group_deleted_rows .iter() .any(|deleted_row| deleted_row.row_meta.id == row_id) { deleted_row_ids.push(row_id); } } no_status_group .rows .retain(|row| !deleted_row_ids.contains(&row.id)); changeset.deleted_rows.extend(deleted_row_ids); Some(changeset) } } #[async_trait] impl GroupController for BaseGroupController where P: CellProtobufBlobParser::CellProtobufType>, C: Serialize + DeserializeOwned + Sync + Send, T: TypeOption + Send + Sync, G: GroupsBuilder, GroupTypeOption = T>, Self: GroupCustomize, { fn get_grouping_field_id(&self) -> &str { &self.grouping_field_id } fn get_all_groups(&self) -> Vec<&GroupData> { self.context.groups() } fn get_group(&self, group_id: &str) -> Option<(usize, GroupData)> { let group = self.context.get_group(group_id)?; Some((group.0, group.1.clone())) } #[tracing::instrument(level = "trace", skip_all, fields(row_count=%rows.len(), group_result))] fn fill_groups(&mut self, rows: &[&Row], _field: &Field) -> FlowyResult<()> { for row in rows { let cell = match row.cells.get(&self.grouping_field_id) { None => self.placeholder_cell(), Some(cell) => Some(cell.clone()), }; if let Some(cell) = cell { let mut grouped_rows: Vec = vec![]; let cell_data = ::CellData::from(&cell); for group in self.context.groups() { if self.can_group(&group.id, &cell_data) { grouped_rows.push(GroupedRow { row: (*row).clone(), group_id: group.id.clone(), }); } } if !grouped_rows.is_empty() { for group_row in grouped_rows { if let Some(group) = self.context.get_mut_group(&group_row.group_id) { group.add_row(group_row.row); } } continue; } } match self.context.get_mut_no_status_group() { None => {}, Some(no_status_group) => no_status_group.add_row((*row).clone()), } } tracing::Span::current().record("group_result", format!("{},", self.context,).as_str()); Ok(()) } async fn create_group( &mut self, name: String, ) -> FlowyResult<(Option, Option)> { ::create_group(self, name).await } fn move_group(&mut self, from_group_id: &str, to_group_id: &str) -> FlowyResult<()> { self.context.move_group(from_group_id, to_group_id) } fn did_create_row(&mut self, row: &Row, index: usize) -> Vec { let mut changesets: Vec = vec![]; let cell = match row.cells.get(&self.grouping_field_id) { None => self.placeholder_cell(), Some(cell) => Some(cell.clone()), }; if let Some(cell) = cell { let cell_data = ::CellData::from(&cell); let mut suitable_group_ids = vec![]; for group in self.get_all_groups() { if self.can_group(&group.id, &cell_data) { suitable_group_ids.push(group.id.clone()); let changeset = GroupRowsNotificationPB::insert( group.id.clone(), vec![InsertedRowPB { row_meta: row.into(), index: Some(index as i32), is_new: true, }], ); changesets.push(changeset); } } if !suitable_group_ids.is_empty() { for group_id in suitable_group_ids.iter() { if let Some(group) = self.context.get_mut_group(group_id) { group.add_row((*row).clone()); } } } else if let Some(no_status_group) = self.context.get_mut_no_status_group() { no_status_group.add_row((*row).clone()); let changeset = GroupRowsNotificationPB::insert( no_status_group.id.clone(), vec![InsertedRowPB { row_meta: row.into(), index: Some(index as i32), is_new: true, }], ); changesets.push(changeset); } } changesets } fn did_update_group_row( &mut self, old_row: &Option, new_row: &Row, field: &Field, ) -> FlowyResult { let mut result = DidUpdateGroupRowResult { inserted_group: None, deleted_group: None, row_changesets: vec![], }; if let Some(cell_data) = get_cell_data_from_row::

(Some(new_row), field) { let old_cell_data = get_cell_data_from_row::

(old_row.as_ref(), field); if let Ok((insert, delete)) = self.create_or_delete_group_when_cell_changed(new_row, old_cell_data.as_ref(), &cell_data) { result.inserted_group = insert; result.deleted_group = delete; } let mut changesets = self.add_or_remove_row_when_cell_changed(new_row, &cell_data); if let Some(changeset) = self.update_no_status_group(new_row, &changesets) { if !changeset.is_empty() { changesets.push(changeset); } } result.row_changesets = changesets; } Ok(result) } fn did_delete_row(&mut self, row: &Row) -> FlowyResult { trace!("[RowOrder]: group did_delete_row: {:?}", row.id); let mut result = DidMoveGroupRowResult { deleted_group: None, row_changesets: vec![], }; // remove row from its group if it is in a group if let Some(cell) = row.cells.get(&self.grouping_field_id) { let cell_data = ::CellData::from(cell); if !cell_data.is_cell_empty() { (result.deleted_group, result.row_changesets) = self.delete_row(row, &cell_data); return Ok(result); } } // when the deleted row is not in current group. It should be in the no status group match self.context.get_mut_no_status_group() { None => { tracing::error!("Unexpected None value. It should have the no status group"); }, Some(no_status_group) => { if !no_status_group.contains_row(&row.id) { tracing::error!("The row: {:?} should be in the no status group", row.id); } no_status_group.remove_row(&row.id); result.row_changesets = vec![GroupRowsNotificationPB::delete( no_status_group.id.clone(), vec![row.id.clone().into_inner()], )]; }, } Ok(result) } #[tracing::instrument(level = "trace", skip_all, err)] fn move_group_row(&mut self, context: MoveGroupRowContext) -> FlowyResult { let mut result = DidMoveGroupRowResult { deleted_group: None, row_changesets: vec![], }; let cell = match context.row.cells.get(&self.grouping_field_id) { Some(cell) => Some(cell.clone()), None => self.placeholder_cell(), }; if let Some(cell) = cell { let cell_bytes = get_cell_protobuf(&cell, context.field, None); let cell_data = cell_bytes.parser::

()?; result.deleted_group = self.delete_group_after_moving_row(context.row, &cell_data); result.row_changesets = self.move_row(context); } else { tracing::warn!("Unexpected moving group row, changes should not be empty"); } Ok(result) } fn did_update_group_field(&mut self, _field: &Field) -> FlowyResult> { Ok(None) } async fn delete_group( &mut self, group_id: &str, ) -> FlowyResult<(Vec, Option)> { let group = if group_id != self.get_grouping_field_id() { self.get_group(group_id) } else { None }; match group { Some((_index, group_data)) => { let row_ids = group_data.rows.iter().map(|row| row.id.clone()).collect(); let type_option_data = ::delete_group(self, group_id).await?; Ok((row_ids, type_option_data)) }, None => Ok((vec![], None)), } } async fn apply_group_changeset( &mut self, changeset: &[GroupChangeset], ) -> FlowyResult<(Vec, Option)> { // update group visibility for group_changeset in changeset.iter() { self.context.update_group(group_changeset)?; } // update group name let type_option = self.get_grouping_field_type_option().await.ok_or_else(|| { FlowyError::internal().with_context("Failed to get grouping field type option") })?; let mut updated_type_option = None; for group_changeset in changeset.iter() { if let Some(type_option) = self.update_type_option_when_update_group(group_changeset, &type_option) { updated_type_option = Some(type_option); break; } } let updated_groups = changeset .iter() .filter_map(|changeset| { self .get_group(&changeset.group_id) .map(|(_, group)| GroupPB::from(group)) }) .collect::>(); Ok(( updated_groups, updated_type_option.map(|type_option| type_option.into()), )) } fn will_create_row(&self, cells: &mut Cells, field: &Field, group_id: &str) { ::will_create_row(self, cells, field, group_id); } } struct GroupedRow { row: Row, group_id: String, } fn get_cell_data_from_row( row: Option<&Row>, field: &Field, ) -> Option { let cell = row.and_then(|row| row.cells.get(&field.id))?; let cell_bytes = get_cell_protobuf(cell, field, None); cell_bytes.parser::

().ok() }