grid_editor.rs 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. use crate::entities::CellPathParams;
  2. use crate::entities::*;
  3. use crate::manager::GridUser;
  4. use crate::notification::{send_dart_notification, GridDartNotification};
  5. use crate::services::block_manager::GridBlockManager;
  6. use crate::services::cell::{
  7. apply_cell_data_changeset, decode_type_cell_data, stringify_cell_data, AnyTypeCache, AtomicCellDataCache,
  8. CellProtobufBlob, ToCellChangesetString, TypeCellData,
  9. };
  10. use crate::services::field::{
  11. default_type_option_builder_from_type, transform_type_option, type_option_builder_from_bytes, FieldBuilder,
  12. RowSingleCellData,
  13. };
  14. use crate::services::filter::FilterType;
  15. use crate::services::grid_editor_trait_impl::GridViewEditorDelegateImpl;
  16. use crate::services::persistence::block_index::BlockIndexCache;
  17. use crate::services::row::{GridBlockRow, GridBlockRowRevision, RowRevisionBuilder};
  18. use crate::services::view_editor::{GridViewChanged, GridViewManager};
  19. use bytes::Bytes;
  20. use flowy_database::ConnectionPool;
  21. use flowy_error::{FlowyError, FlowyResult};
  22. use flowy_http_model::revision::Revision;
  23. use flowy_revision::{
  24. RevisionCloudService, RevisionManager, RevisionMergeable, RevisionObjectDeserializer, RevisionObjectSerializer,
  25. };
  26. use flowy_sync::client_grid::{GridRevisionChangeset, GridRevisionPad, JsonDeserializer};
  27. use flowy_sync::errors::{CollaborateError, CollaborateResult};
  28. use flowy_sync::util::make_operations_from_revisions;
  29. use flowy_task::TaskDispatcher;
  30. use grid_rev_model::*;
  31. use lib_infra::future::{to_fut, FutureResult};
  32. use lib_ot::core::EmptyAttributes;
  33. use std::collections::HashMap;
  34. use std::sync::Arc;
  35. use tokio::sync::{broadcast, RwLock};
  36. pub struct GridRevisionEditor {
  37. pub grid_id: String,
  38. #[allow(dead_code)]
  39. user: Arc<dyn GridUser>,
  40. grid_pad: Arc<RwLock<GridRevisionPad>>,
  41. view_manager: Arc<GridViewManager>,
  42. rev_manager: Arc<RevisionManager<Arc<ConnectionPool>>>,
  43. block_manager: Arc<GridBlockManager>,
  44. cell_data_cache: AtomicCellDataCache,
  45. }
  46. impl Drop for GridRevisionEditor {
  47. fn drop(&mut self) {
  48. tracing::trace!("Drop GridRevisionEditor");
  49. }
  50. }
  51. impl GridRevisionEditor {
  52. pub async fn new(
  53. grid_id: &str,
  54. user: Arc<dyn GridUser>,
  55. mut rev_manager: RevisionManager<Arc<ConnectionPool>>,
  56. persistence: Arc<BlockIndexCache>,
  57. task_scheduler: Arc<RwLock<TaskDispatcher>>,
  58. ) -> FlowyResult<Arc<Self>> {
  59. let token = user.token()?;
  60. let cloud = Arc::new(GridRevisionCloudService { token });
  61. let grid_pad = rev_manager.initialize::<GridRevisionSerde>(Some(cloud)).await?;
  62. let rev_manager = Arc::new(rev_manager);
  63. let grid_pad = Arc::new(RwLock::new(grid_pad));
  64. let cell_data_cache = AnyTypeCache::<u64>::new();
  65. // Block manager
  66. let (block_event_tx, block_event_rx) = broadcast::channel(100);
  67. let block_meta_revs = grid_pad.read().await.get_block_meta_revs();
  68. let block_manager = Arc::new(GridBlockManager::new(&user, block_meta_revs, persistence, block_event_tx).await?);
  69. let delegate = Arc::new(GridViewEditorDelegateImpl {
  70. pad: grid_pad.clone(),
  71. block_manager: block_manager.clone(),
  72. task_scheduler,
  73. cell_data_cache: cell_data_cache.clone(),
  74. });
  75. // View manager
  76. let view_manager = Arc::new(
  77. GridViewManager::new(
  78. grid_id.to_owned(),
  79. user.clone(),
  80. delegate,
  81. cell_data_cache.clone(),
  82. block_event_rx,
  83. )
  84. .await?,
  85. );
  86. let editor = Arc::new(Self {
  87. grid_id: grid_id.to_owned(),
  88. user,
  89. grid_pad,
  90. rev_manager,
  91. block_manager,
  92. view_manager,
  93. cell_data_cache,
  94. });
  95. Ok(editor)
  96. }
  97. #[tracing::instrument(name = "close grid editor", level = "trace", skip_all)]
  98. pub async fn close(&self) {
  99. self.block_manager.close().await;
  100. self.rev_manager.generate_snapshot().await;
  101. self.rev_manager.close().await;
  102. self.view_manager.close(&self.grid_id).await;
  103. }
  104. /// Save the type-option data to disk and send a `GridDartNotification::DidUpdateField` notification
  105. /// to dart side.
  106. ///
  107. /// It will do nothing if the passed-in type_option_data is empty
  108. /// # Arguments
  109. ///
  110. /// * `grid_id`: the id of the grid
  111. /// * `field_id`: the id of the field
  112. /// * `type_option_data`: the updated type-option data. The `type-option` data might be empty
  113. /// if there is no type-option config for that field. For example, the `RichTextTypeOptionPB`.
  114. ///
  115. pub async fn update_field_type_option(
  116. &self,
  117. _grid_id: &str,
  118. field_id: &str,
  119. type_option_data: Vec<u8>,
  120. old_field_rev: Option<Arc<FieldRevision>>,
  121. ) -> FlowyResult<()> {
  122. let result = self.get_field_rev(field_id).await;
  123. if result.is_none() {
  124. tracing::warn!("Can't find the field with id: {}", field_id);
  125. return Ok(());
  126. }
  127. let field_rev = result.unwrap();
  128. self.modify(|grid| {
  129. let changeset = grid.modify_field(field_id, |field| {
  130. let deserializer = TypeOptionJsonDeserializer(field_rev.ty.into());
  131. match deserializer.deserialize(type_option_data) {
  132. Ok(json_str) => {
  133. let field_type = field.ty;
  134. field.insert_type_option_str(&field_type, json_str);
  135. }
  136. Err(err) => {
  137. tracing::error!("Deserialize data to type option json failed: {}", err);
  138. }
  139. }
  140. Ok(Some(()))
  141. })?;
  142. Ok(changeset)
  143. })
  144. .await?;
  145. self.view_manager
  146. .did_update_view_field_type_option(field_id, old_field_rev)
  147. .await?;
  148. self.notify_did_update_grid_field(field_id).await?;
  149. Ok(())
  150. }
  151. pub async fn next_field_rev(&self, field_type: &FieldType) -> FlowyResult<FieldRevision> {
  152. let name = format!("Property {}", self.grid_pad.read().await.get_fields().len() + 1);
  153. let field_rev = FieldBuilder::from_field_type(field_type).name(&name).build();
  154. Ok(field_rev)
  155. }
  156. pub async fn create_new_field_rev(&self, field_rev: FieldRevision) -> FlowyResult<()> {
  157. let field_id = field_rev.id.clone();
  158. self.modify(|grid| Ok(grid.create_field_rev(field_rev, None)?)).await?;
  159. self.notify_did_insert_grid_field(&field_id).await?;
  160. Ok(())
  161. }
  162. pub async fn create_new_field_rev_with_type_option(
  163. &self,
  164. field_type: &FieldType,
  165. type_option_data: Option<Vec<u8>>,
  166. ) -> FlowyResult<FieldRevision> {
  167. let mut field_rev = self.next_field_rev(field_type).await?;
  168. if let Some(type_option_data) = type_option_data {
  169. let type_option_builder = type_option_builder_from_bytes(type_option_data, field_type);
  170. field_rev.insert_type_option(type_option_builder.serializer());
  171. }
  172. self.modify(|grid| Ok(grid.create_field_rev(field_rev.clone(), None)?))
  173. .await?;
  174. self.notify_did_insert_grid_field(&field_rev.id).await?;
  175. Ok(field_rev)
  176. }
  177. pub async fn contain_field(&self, field_id: &str) -> bool {
  178. self.grid_pad.read().await.contain_field(field_id)
  179. }
  180. pub async fn update_field(&self, params: FieldChangesetParams) -> FlowyResult<()> {
  181. let field_id = params.field_id.clone();
  182. self.modify(|grid| {
  183. let changeset = grid.modify_field(&params.field_id, |field| {
  184. if let Some(name) = params.name {
  185. field.name = name;
  186. }
  187. if let Some(desc) = params.desc {
  188. field.desc = desc;
  189. }
  190. if let Some(field_type) = params.field_type {
  191. field.ty = field_type;
  192. }
  193. if let Some(frozen) = params.frozen {
  194. field.frozen = frozen;
  195. }
  196. if let Some(visibility) = params.visibility {
  197. field.visibility = visibility;
  198. }
  199. if let Some(width) = params.width {
  200. field.width = width;
  201. }
  202. Ok(Some(()))
  203. })?;
  204. Ok(changeset)
  205. })
  206. .await?;
  207. self.notify_did_update_grid_field(&field_id).await?;
  208. Ok(())
  209. }
  210. pub async fn modify_field_rev<F>(&self, field_id: &str, f: F) -> FlowyResult<()>
  211. where
  212. F: for<'a> FnOnce(&'a mut FieldRevision) -> FlowyResult<Option<()>>,
  213. {
  214. let mut is_changed = false;
  215. let old_field_rev = self.get_field_rev(field_id).await;
  216. self.modify(|grid| {
  217. let changeset = grid.modify_field(field_id, |field_rev| {
  218. f(field_rev).map_err(|e| CollaborateError::internal().context(e))
  219. })?;
  220. is_changed = changeset.is_some();
  221. Ok(changeset)
  222. })
  223. .await?;
  224. if is_changed {
  225. match self
  226. .view_manager
  227. .did_update_view_field_type_option(field_id, old_field_rev)
  228. .await
  229. {
  230. Ok(_) => {}
  231. Err(e) => tracing::error!("View manager update field failed: {:?}", e),
  232. }
  233. self.notify_did_update_grid_field(field_id).await?;
  234. }
  235. Ok(())
  236. }
  237. pub async fn delete_field(&self, field_id: &str) -> FlowyResult<()> {
  238. self.modify(|grid_pad| Ok(grid_pad.delete_field_rev(field_id)?)).await?;
  239. let field_order = FieldIdPB::from(field_id);
  240. let notified_changeset = GridFieldChangesetPB::delete(&self.grid_id, vec![field_order]);
  241. self.notify_did_update_grid(notified_changeset).await?;
  242. Ok(())
  243. }
  244. pub async fn group_by_field(&self, field_id: &str) -> FlowyResult<()> {
  245. self.view_manager.group_by_field(field_id).await?;
  246. Ok(())
  247. }
  248. /// Switch the field with id to a new field type.
  249. ///
  250. /// If the field type is not exist before, the default type-option data will be created.
  251. /// Each field type has its corresponding data, aka, the type-option data. Check out [this](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/architecture/frontend/grid#fieldtype)
  252. /// for more information
  253. ///
  254. /// # Arguments
  255. ///
  256. /// * `field_id`: the id of the field
  257. /// * `new_field_type`: the new field type of the field
  258. ///
  259. pub async fn switch_to_field_type(&self, field_id: &str, new_field_type: &FieldType) -> FlowyResult<()> {
  260. //
  261. let make_default_type_option = || -> String {
  262. return default_type_option_builder_from_type(new_field_type)
  263. .serializer()
  264. .json_str();
  265. };
  266. let type_option_transform =
  267. |old_field_type: FieldTypeRevision, old_type_option: Option<String>, new_type_option: String| {
  268. let old_field_type: FieldType = old_field_type.into();
  269. transform_type_option(&new_type_option, new_field_type, old_type_option, old_field_type)
  270. };
  271. self.modify(|grid| {
  272. Ok(grid.switch_to_field(
  273. field_id,
  274. new_field_type.clone(),
  275. make_default_type_option,
  276. type_option_transform,
  277. )?)
  278. })
  279. .await?;
  280. self.notify_did_update_grid_field(field_id).await?;
  281. Ok(())
  282. }
  283. pub async fn duplicate_field(&self, field_id: &str) -> FlowyResult<()> {
  284. let duplicated_field_id = gen_field_id();
  285. self.modify(|grid| Ok(grid.duplicate_field_rev(field_id, &duplicated_field_id)?))
  286. .await?;
  287. self.notify_did_insert_grid_field(&duplicated_field_id).await?;
  288. Ok(())
  289. }
  290. pub async fn get_field_rev(&self, field_id: &str) -> Option<Arc<FieldRevision>> {
  291. let field_rev = self.grid_pad.read().await.get_field_rev(field_id)?.1.clone();
  292. Some(field_rev)
  293. }
  294. pub async fn get_field_revs(&self, field_ids: Option<Vec<String>>) -> FlowyResult<Vec<Arc<FieldRevision>>> {
  295. if field_ids.is_none() {
  296. let field_revs = self.grid_pad.read().await.get_field_revs(None)?;
  297. return Ok(field_revs);
  298. }
  299. let field_ids = field_ids.unwrap_or_default();
  300. let expected_len = field_ids.len();
  301. let field_revs = self.grid_pad.read().await.get_field_revs(Some(field_ids))?;
  302. if expected_len != 0 && field_revs.len() != expected_len {
  303. tracing::error!(
  304. "This is a bug. The len of the field_revs should equal to {}",
  305. expected_len
  306. );
  307. debug_assert!(field_revs.len() == expected_len);
  308. }
  309. Ok(field_revs)
  310. }
  311. pub async fn create_block(&self, block_meta_rev: GridBlockMetaRevision) -> FlowyResult<()> {
  312. self.modify(|grid_pad| Ok(grid_pad.create_block_meta_rev(block_meta_rev)?))
  313. .await?;
  314. Ok(())
  315. }
  316. pub async fn update_block(&self, changeset: GridBlockMetaRevisionChangeset) -> FlowyResult<()> {
  317. self.modify(|grid_pad| Ok(grid_pad.update_block_rev(changeset)?))
  318. .await?;
  319. Ok(())
  320. }
  321. pub async fn create_row(&self, params: CreateRowParams) -> FlowyResult<RowPB> {
  322. let mut row_rev = self.create_row_rev().await?;
  323. self.view_manager.will_create_row(&mut row_rev, &params).await;
  324. let row_pb = self.create_row_pb(row_rev, params.start_row_id.clone()).await?;
  325. self.view_manager.did_create_row(&row_pb, &params).await;
  326. Ok(row_pb)
  327. }
  328. #[tracing::instrument(level = "trace", skip_all, err)]
  329. pub async fn move_group(&self, params: MoveGroupParams) -> FlowyResult<()> {
  330. self.view_manager.move_group(params).await?;
  331. Ok(())
  332. }
  333. pub async fn insert_rows(&self, row_revs: Vec<RowRevision>) -> FlowyResult<Vec<RowPB>> {
  334. let block_id = self.block_id().await?;
  335. let mut rows_by_block_id: HashMap<String, Vec<RowRevision>> = HashMap::new();
  336. let mut row_orders = vec![];
  337. for row_rev in row_revs {
  338. row_orders.push(RowPB::from(&row_rev));
  339. rows_by_block_id
  340. .entry(block_id.clone())
  341. .or_insert_with(Vec::new)
  342. .push(row_rev);
  343. }
  344. let changesets = self.block_manager.insert_row(rows_by_block_id).await?;
  345. for changeset in changesets {
  346. self.update_block(changeset).await?;
  347. }
  348. Ok(row_orders)
  349. }
  350. pub async fn update_row(&self, changeset: RowChangeset) -> FlowyResult<()> {
  351. let row_id = changeset.row_id.clone();
  352. self.block_manager.update_row(changeset).await?;
  353. self.view_manager.did_update_cell(&row_id).await;
  354. Ok(())
  355. }
  356. /// Returns all the rows in this block.
  357. pub async fn get_row_pbs(&self, view_id: &str, block_id: &str) -> FlowyResult<Vec<RowPB>> {
  358. let rows = self.view_manager.get_row_revs(view_id, block_id).await?;
  359. let rows = rows.into_iter().map(|row_rev| RowPB::from(&row_rev)).collect();
  360. Ok(rows)
  361. }
  362. pub async fn get_all_row_revs(&self, view_id: &str) -> FlowyResult<Vec<Arc<RowRevision>>> {
  363. let mut all_rows = vec![];
  364. let blocks = self.block_manager.get_blocks(None).await?;
  365. for block in blocks {
  366. let rows = self.view_manager.get_row_revs(view_id, &block.block_id).await?;
  367. all_rows.extend(rows);
  368. }
  369. Ok(all_rows)
  370. }
  371. pub async fn get_row_rev(&self, row_id: &str) -> FlowyResult<Option<Arc<RowRevision>>> {
  372. match self.block_manager.get_row_rev(row_id).await? {
  373. None => Ok(None),
  374. Some((_, row_rev)) => Ok(Some(row_rev)),
  375. }
  376. }
  377. pub async fn delete_row(&self, row_id: &str) -> FlowyResult<()> {
  378. let row_rev = self.block_manager.delete_row(row_id).await?;
  379. tracing::trace!("Did delete row:{:?}", row_rev);
  380. if let Some(row_rev) = row_rev {
  381. self.view_manager.did_delete_row(row_rev).await;
  382. }
  383. Ok(())
  384. }
  385. pub async fn subscribe_view_changed(&self, view_id: &str) -> FlowyResult<broadcast::Receiver<GridViewChanged>> {
  386. self.view_manager.subscribe_view_changed(view_id).await
  387. }
  388. pub async fn duplicate_row(&self, _row_id: &str) -> FlowyResult<()> {
  389. Ok(())
  390. }
  391. /// Returns the cell data that encoded in protobuf.
  392. pub async fn get_cell(&self, params: &CellPathParams) -> Option<CellPB> {
  393. let (field_type, cell_bytes) = self.decode_cell_data_from(params).await?;
  394. Some(CellPB::new(
  395. &params.field_id,
  396. &params.row_id,
  397. field_type,
  398. cell_bytes.to_vec(),
  399. ))
  400. }
  401. /// Returns a string that represents the current field_type's cell data.
  402. /// For example:
  403. /// Multi-Select: list of the option's name separated by a comma.
  404. /// Number: 123 => $123 if the currency set.
  405. /// Date: 1653609600 => May 27,2022
  406. ///
  407. pub async fn get_cell_display_str(&self, params: &CellPathParams) -> String {
  408. let display_str = || async {
  409. let field_rev = self.get_field_rev(&params.field_id).await?;
  410. let field_type: FieldType = field_rev.ty.into();
  411. let cell_rev = self.get_cell_rev(&params.row_id, &params.field_id).await.ok()??;
  412. let type_cell_data: TypeCellData = cell_rev.try_into().ok()?;
  413. Some(stringify_cell_data(
  414. type_cell_data.cell_str,
  415. &field_type,
  416. &field_type,
  417. &field_rev,
  418. ))
  419. };
  420. display_str().await.unwrap_or_default()
  421. }
  422. pub async fn get_cell_protobuf(&self, params: &CellPathParams) -> Option<CellProtobufBlob> {
  423. let (_, cell_data) = self.decode_cell_data_from(params).await?;
  424. Some(cell_data)
  425. }
  426. async fn decode_cell_data_from(&self, params: &CellPathParams) -> Option<(FieldType, CellProtobufBlob)> {
  427. let field_rev = self.get_field_rev(&params.field_id).await?;
  428. let (_, row_rev) = self.block_manager.get_row_rev(&params.row_id).await.ok()??;
  429. let cell_rev = row_rev.cells.get(&params.field_id)?.clone();
  430. Some(decode_type_cell_data(
  431. cell_rev.type_cell_data,
  432. &field_rev,
  433. Some(self.cell_data_cache.clone()),
  434. ))
  435. }
  436. pub async fn get_cell_rev(&self, row_id: &str, field_id: &str) -> FlowyResult<Option<CellRevision>> {
  437. match self.block_manager.get_row_rev(row_id).await? {
  438. None => Ok(None),
  439. Some((_, row_rev)) => {
  440. let cell_rev = row_rev.cells.get(field_id).cloned();
  441. Ok(cell_rev)
  442. }
  443. }
  444. }
  445. /// Returns the list of cells corresponding to the given field.
  446. pub async fn get_cells_for_field(&self, view_id: &str, field_id: &str) -> FlowyResult<Vec<RowSingleCellData>> {
  447. let view_editor = self.view_manager.get_view_editor(view_id).await?;
  448. view_editor.get_cells_for_field(field_id).await
  449. }
  450. #[tracing::instrument(level = "trace", skip_all, err)]
  451. pub async fn update_cell_with_changeset<T: ToCellChangesetString>(
  452. &self,
  453. row_id: &str,
  454. field_id: &str,
  455. cell_changeset: T,
  456. ) -> FlowyResult<()> {
  457. match self.grid_pad.read().await.get_field_rev(field_id) {
  458. None => {
  459. let msg = format!("Field:{} not found", &field_id);
  460. Err(FlowyError::internal().context(msg))
  461. }
  462. Some((_, field_rev)) => {
  463. tracing::trace!("Cell changeset: id:{} / value:{:?}", &field_id, cell_changeset);
  464. let cell_rev = self.get_cell_rev(row_id, field_id).await?;
  465. // Update the changeset.data property with the return value.
  466. let type_cell_data =
  467. apply_cell_data_changeset(cell_changeset, cell_rev, field_rev, Some(self.cell_data_cache.clone()))?;
  468. let cell_changeset = CellChangesetPB {
  469. grid_id: self.grid_id.clone(),
  470. row_id: row_id.to_owned(),
  471. field_id: field_id.to_owned(),
  472. type_cell_data,
  473. };
  474. self.block_manager.update_cell(cell_changeset).await?;
  475. self.view_manager.did_update_cell(row_id).await;
  476. Ok(())
  477. }
  478. }
  479. }
  480. #[tracing::instrument(level = "trace", skip_all, err)]
  481. pub async fn update_cell<T: ToCellChangesetString>(
  482. &self,
  483. row_id: String,
  484. field_id: String,
  485. cell_changeset: T,
  486. ) -> FlowyResult<()> {
  487. self.update_cell_with_changeset(&row_id, &field_id, cell_changeset)
  488. .await
  489. }
  490. pub async fn get_block_meta_revs(&self) -> FlowyResult<Vec<Arc<GridBlockMetaRevision>>> {
  491. let block_meta_revs = self.grid_pad.read().await.get_block_meta_revs();
  492. Ok(block_meta_revs)
  493. }
  494. pub async fn get_blocks(&self, block_ids: Option<Vec<String>>) -> FlowyResult<Vec<GridBlockRowRevision>> {
  495. let block_ids = match block_ids {
  496. None => self
  497. .grid_pad
  498. .read()
  499. .await
  500. .get_block_meta_revs()
  501. .iter()
  502. .map(|block_rev| block_rev.block_id.clone())
  503. .collect::<Vec<String>>(),
  504. Some(block_ids) => block_ids,
  505. };
  506. let blocks = self.block_manager.get_blocks(Some(block_ids)).await?;
  507. Ok(blocks)
  508. }
  509. pub async fn delete_rows(&self, block_rows: Vec<GridBlockRow>) -> FlowyResult<()> {
  510. let changesets = self.block_manager.delete_rows(block_rows).await?;
  511. for changeset in changesets {
  512. self.update_block(changeset).await?;
  513. }
  514. Ok(())
  515. }
  516. pub async fn get_grid(&self, view_id: &str) -> FlowyResult<GridPB> {
  517. let pad = self.grid_pad.read().await;
  518. let fields = pad.get_field_revs(None)?.iter().map(FieldIdPB::from).collect();
  519. let mut all_rows = vec![];
  520. for block_rev in pad.get_block_meta_revs() {
  521. if let Ok(rows) = self.get_row_pbs(view_id, &block_rev.block_id).await {
  522. all_rows.extend(rows);
  523. }
  524. }
  525. Ok(GridPB {
  526. id: self.grid_id.clone(),
  527. fields,
  528. rows: all_rows,
  529. })
  530. }
  531. pub async fn get_setting(&self) -> FlowyResult<GridSettingPB> {
  532. self.view_manager.get_setting().await
  533. }
  534. pub async fn get_all_filters(&self) -> FlowyResult<Vec<FilterPB>> {
  535. Ok(self
  536. .view_manager
  537. .get_all_filters()
  538. .await?
  539. .into_iter()
  540. .map(|filter| FilterPB::from(filter.as_ref()))
  541. .collect())
  542. }
  543. pub async fn get_filters(&self, filter_id: FilterType) -> FlowyResult<Vec<Arc<FilterRevision>>> {
  544. self.view_manager.get_filters(&filter_id).await
  545. }
  546. pub async fn create_or_update_filter(&self, params: AlterFilterParams) -> FlowyResult<()> {
  547. self.view_manager.create_or_update_filter(params).await?;
  548. Ok(())
  549. }
  550. pub async fn delete_filter(&self, params: DeleteFilterParams) -> FlowyResult<()> {
  551. self.view_manager.delete_filter(params).await?;
  552. Ok(())
  553. }
  554. pub async fn get_all_sorts(&self, view_id: &str) -> FlowyResult<Vec<SortPB>> {
  555. Ok(self
  556. .view_manager
  557. .get_all_sorts(view_id)
  558. .await?
  559. .into_iter()
  560. .map(|sort| SortPB::from(sort.as_ref()))
  561. .collect())
  562. }
  563. pub async fn delete_all_sorts(&self, view_id: &str) -> FlowyResult<()> {
  564. self.view_manager.delete_all_sorts(view_id).await
  565. }
  566. pub async fn delete_sort(&self, params: DeleteSortParams) -> FlowyResult<()> {
  567. self.view_manager.delete_sort(params).await?;
  568. Ok(())
  569. }
  570. pub async fn create_or_update_sort(&self, params: AlterSortParams) -> FlowyResult<SortRevision> {
  571. let sort_rev = self.view_manager.create_or_update_sort(params).await?;
  572. Ok(sort_rev)
  573. }
  574. pub async fn insert_group(&self, params: InsertGroupParams) -> FlowyResult<()> {
  575. self.view_manager.insert_or_update_group(params).await
  576. }
  577. pub async fn delete_group(&self, params: DeleteGroupParams) -> FlowyResult<()> {
  578. self.view_manager.delete_group(params).await
  579. }
  580. pub async fn move_row(&self, params: MoveRowParams) -> FlowyResult<()> {
  581. let MoveRowParams {
  582. view_id: _,
  583. from_row_id,
  584. to_row_id,
  585. } = params;
  586. match self.block_manager.get_row_rev(&from_row_id).await? {
  587. None => tracing::warn!("Move row failed, can not find the row:{}", from_row_id),
  588. Some((_, row_rev)) => {
  589. match (
  590. self.block_manager.index_of_row(&from_row_id).await,
  591. self.block_manager.index_of_row(&to_row_id).await,
  592. ) {
  593. (Some(from_index), Some(to_index)) => {
  594. tracing::trace!("Move row from {} to {}", from_index, to_index);
  595. self.block_manager
  596. .move_row(row_rev.clone(), from_index, to_index)
  597. .await?;
  598. }
  599. (_, None) => tracing::warn!("Can not find the from row id: {}", from_row_id),
  600. (None, _) => tracing::warn!("Can not find the to row id: {}", to_row_id),
  601. }
  602. }
  603. }
  604. Ok(())
  605. }
  606. pub async fn move_group_row(&self, params: MoveGroupRowParams) -> FlowyResult<()> {
  607. let MoveGroupRowParams {
  608. view_id,
  609. from_row_id,
  610. to_group_id,
  611. to_row_id,
  612. } = params;
  613. match self.block_manager.get_row_rev(&from_row_id).await? {
  614. None => tracing::warn!("Move row failed, can not find the row:{}", from_row_id),
  615. Some((_, row_rev)) => {
  616. let block_manager = self.block_manager.clone();
  617. self.view_manager
  618. .move_group_row(row_rev, to_group_id, to_row_id.clone(), |row_changeset| {
  619. to_fut(async move {
  620. tracing::trace!("Row data changed: {:?}", row_changeset);
  621. let cell_changesets = row_changeset
  622. .cell_by_field_id
  623. .into_iter()
  624. .map(|(field_id, cell_rev)| CellChangesetPB {
  625. grid_id: view_id.clone(),
  626. row_id: row_changeset.row_id.clone(),
  627. field_id,
  628. type_cell_data: cell_rev.type_cell_data,
  629. })
  630. .collect::<Vec<CellChangesetPB>>();
  631. for cell_changeset in cell_changesets {
  632. match block_manager.update_cell(cell_changeset).await {
  633. Ok(_) => {}
  634. Err(e) => tracing::error!("Apply cell changeset error:{:?}", e),
  635. }
  636. }
  637. })
  638. })
  639. .await?;
  640. }
  641. }
  642. Ok(())
  643. }
  644. pub async fn move_field(&self, params: MoveFieldParams) -> FlowyResult<()> {
  645. let MoveFieldParams {
  646. grid_id: _,
  647. field_id,
  648. from_index,
  649. to_index,
  650. } = params;
  651. self.modify(|grid_pad| Ok(grid_pad.move_field(&field_id, from_index as usize, to_index as usize)?))
  652. .await?;
  653. if let Some((index, field_rev)) = self.grid_pad.read().await.get_field_rev(&field_id) {
  654. let delete_field_order = FieldIdPB::from(field_id);
  655. let insert_field = IndexFieldPB::from_field_rev(field_rev, index);
  656. let notified_changeset = GridFieldChangesetPB {
  657. grid_id: self.grid_id.clone(),
  658. inserted_fields: vec![insert_field],
  659. deleted_fields: vec![delete_field_order],
  660. updated_fields: vec![],
  661. };
  662. self.notify_did_update_grid(notified_changeset).await?;
  663. }
  664. Ok(())
  665. }
  666. pub async fn duplicate_grid(&self) -> FlowyResult<BuildGridContext> {
  667. let grid_pad = self.grid_pad.read().await;
  668. let grid_view_revision_data = self.view_manager.duplicate_grid_view().await?;
  669. let original_blocks = grid_pad.get_block_meta_revs();
  670. let (duplicated_fields, duplicated_blocks) = grid_pad.duplicate_grid_block_meta().await;
  671. let mut blocks_meta_data = vec![];
  672. if original_blocks.len() == duplicated_blocks.len() {
  673. for (index, original_block_meta) in original_blocks.iter().enumerate() {
  674. let grid_block_meta_editor = self
  675. .block_manager
  676. .get_block_editor(&original_block_meta.block_id)
  677. .await?;
  678. let duplicated_block_id = &duplicated_blocks[index].block_id;
  679. tracing::trace!("Duplicate block:{} meta data", duplicated_block_id);
  680. let duplicated_block_meta_data = grid_block_meta_editor.duplicate_block(duplicated_block_id).await;
  681. blocks_meta_data.push(duplicated_block_meta_data);
  682. }
  683. } else {
  684. debug_assert_eq!(original_blocks.len(), duplicated_blocks.len());
  685. }
  686. drop(grid_pad);
  687. Ok(BuildGridContext {
  688. field_revs: duplicated_fields.into_iter().map(Arc::new).collect(),
  689. block_metas: duplicated_blocks,
  690. blocks: blocks_meta_data,
  691. grid_view_revision_data,
  692. })
  693. }
  694. #[tracing::instrument(level = "trace", skip_all, err)]
  695. pub async fn load_groups(&self) -> FlowyResult<RepeatedGroupPB> {
  696. self.view_manager.load_groups().await
  697. }
  698. async fn create_row_rev(&self) -> FlowyResult<RowRevision> {
  699. let field_revs = self.grid_pad.read().await.get_field_revs(None)?;
  700. let block_id = self.block_id().await?;
  701. // insert empty row below the row whose id is upper_row_id
  702. let row_rev = RowRevisionBuilder::new(&block_id, &field_revs).build();
  703. Ok(row_rev)
  704. }
  705. async fn create_row_pb(&self, row_rev: RowRevision, start_row_id: Option<String>) -> FlowyResult<RowPB> {
  706. let row_pb = RowPB::from(&row_rev);
  707. let block_id = row_rev.block_id.clone();
  708. // insert the row
  709. let row_count = self.block_manager.create_row(row_rev, start_row_id).await?;
  710. // update block row count
  711. let changeset = GridBlockMetaRevisionChangeset::from_row_count(block_id, row_count);
  712. self.update_block(changeset).await?;
  713. Ok(row_pb)
  714. }
  715. async fn modify<F>(&self, f: F) -> FlowyResult<()>
  716. where
  717. F: for<'a> FnOnce(&'a mut GridRevisionPad) -> FlowyResult<Option<GridRevisionChangeset>>,
  718. {
  719. let mut write_guard = self.grid_pad.write().await;
  720. if let Some(changeset) = f(&mut write_guard)? {
  721. self.apply_change(changeset).await?;
  722. }
  723. Ok(())
  724. }
  725. async fn apply_change(&self, change: GridRevisionChangeset) -> FlowyResult<()> {
  726. let GridRevisionChangeset { operations: delta, md5 } = change;
  727. let data = delta.json_bytes();
  728. let _ = self.rev_manager.add_local_revision(data, md5).await?;
  729. Ok(())
  730. }
  731. async fn block_id(&self) -> FlowyResult<String> {
  732. match self.grid_pad.read().await.get_block_meta_revs().last() {
  733. None => Err(FlowyError::internal().context("There is no grid block in this grid")),
  734. Some(grid_block) => Ok(grid_block.block_id.clone()),
  735. }
  736. }
  737. #[tracing::instrument(level = "trace", skip_all, err)]
  738. async fn notify_did_insert_grid_field(&self, field_id: &str) -> FlowyResult<()> {
  739. if let Some((index, field_rev)) = self.grid_pad.read().await.get_field_rev(field_id) {
  740. let index_field = IndexFieldPB::from_field_rev(field_rev, index);
  741. let notified_changeset = GridFieldChangesetPB::insert(&self.grid_id, vec![index_field]);
  742. self.notify_did_update_grid(notified_changeset).await?;
  743. }
  744. Ok(())
  745. }
  746. #[tracing::instrument(level = "trace", skip_all, err)]
  747. async fn notify_did_update_grid_field(&self, field_id: &str) -> FlowyResult<()> {
  748. if let Some((_, field_rev)) = self
  749. .grid_pad
  750. .read()
  751. .await
  752. .get_field_rev(field_id)
  753. .map(|(index, field)| (index, field.clone()))
  754. {
  755. let updated_field = FieldPB::from(field_rev);
  756. let notified_changeset = GridFieldChangesetPB::update(&self.grid_id, vec![updated_field.clone()]);
  757. self.notify_did_update_grid(notified_changeset).await?;
  758. send_dart_notification(field_id, GridDartNotification::DidUpdateField)
  759. .payload(updated_field)
  760. .send();
  761. }
  762. Ok(())
  763. }
  764. async fn notify_did_update_grid(&self, changeset: GridFieldChangesetPB) -> FlowyResult<()> {
  765. send_dart_notification(&self.grid_id, GridDartNotification::DidUpdateGridFields)
  766. .payload(changeset)
  767. .send();
  768. Ok(())
  769. }
  770. }
  771. #[cfg(feature = "flowy_unit_test")]
  772. impl GridRevisionEditor {
  773. pub fn rev_manager(&self) -> Arc<RevisionManager<Arc<ConnectionPool>>> {
  774. self.rev_manager.clone()
  775. }
  776. pub fn grid_pad(&self) -> Arc<RwLock<GridRevisionPad>> {
  777. self.grid_pad.clone()
  778. }
  779. }
  780. pub struct GridRevisionSerde();
  781. impl RevisionObjectDeserializer for GridRevisionSerde {
  782. type Output = GridRevisionPad;
  783. fn deserialize_revisions(_object_id: &str, revisions: Vec<Revision>) -> FlowyResult<Self::Output> {
  784. let pad = GridRevisionPad::from_revisions(revisions)?;
  785. Ok(pad)
  786. }
  787. fn recover_operations_from_revisions(_revisions: Vec<Revision>) -> Option<Self::Output> {
  788. None
  789. }
  790. }
  791. impl RevisionObjectSerializer for GridRevisionSerde {
  792. fn combine_revisions(revisions: Vec<Revision>) -> FlowyResult<Bytes> {
  793. let operations = make_operations_from_revisions::<EmptyAttributes>(revisions)?;
  794. Ok(operations.json_bytes())
  795. }
  796. }
  797. struct GridRevisionCloudService {
  798. #[allow(dead_code)]
  799. token: String,
  800. }
  801. impl RevisionCloudService for GridRevisionCloudService {
  802. #[tracing::instrument(level = "trace", skip(self))]
  803. fn fetch_object(&self, _user_id: &str, _object_id: &str) -> FutureResult<Vec<Revision>, FlowyError> {
  804. FutureResult::new(async move { Ok(vec![]) })
  805. }
  806. }
  807. pub struct GridRevisionMergeable();
  808. impl RevisionMergeable for GridRevisionMergeable {
  809. fn combine_revisions(&self, revisions: Vec<Revision>) -> FlowyResult<Bytes> {
  810. GridRevisionSerde::combine_revisions(revisions)
  811. }
  812. }
  813. struct TypeOptionJsonDeserializer(FieldType);
  814. impl JsonDeserializer for TypeOptionJsonDeserializer {
  815. fn deserialize(&self, type_option_data: Vec<u8>) -> CollaborateResult<String> {
  816. // The type_option_data sent from Dart is serialized by protobuf.
  817. let builder = type_option_builder_from_bytes(type_option_data, &self.0);
  818. let json = builder.serializer().json_str();
  819. tracing::trace!("Deserialize type-option data to: {}", json);
  820. Ok(json)
  821. }
  822. }