docs: update code documentation (#1804)

* docs: update code documentation

* chore: fix bloc test

* chore: reduce lock granularity

* chore: fix bloc test

Author: appflowy

frontend/.vscode/tasks.json

@@ -58,7 +58,7 @@
 			"label": "AF: Build Appflowy Core",
 			"type": "shell",
 			"windows": {
-				"command": "cargo make --profile development-windows appflowy-core-dev"
+				"command": "cargo make --profile development-windows-x86 appflowy-core-dev"
 			},
 			"linux": {
 				"command": "cargo make --profile \"development-linux-$(uname -m)\" appflowy-core-dev"

frontend/app_flowy/lib/plugins/document/document.dart

@@ -34,7 +34,7 @@ class DocumentPluginBuilder extends PluginBuilder {
   PluginType get pluginType => PluginType.editor;
 
   @override
-  ViewDataFormatPB get dataFormatType => ViewDataFormatPB.TreeFormat;
+  ViewDataFormatPB get dataFormatType => ViewDataFormatPB.NodeFormat;
 }
 
 class DocumentPlugin extends Plugin<int> {

frontend/app_flowy/lib/plugins/grid/application/cell/select_option_editor_bloc.dart

@@ -147,8 +147,10 @@ class SelectOptionCellEditorBloc
   }
 
   void _filterOption(String optionName, Emitter<SelectOptionEditorState> emit) {
-    final _MakeOptionResult result =
-        _makeOptions(Some(optionName), state.allOptions);
+    final _MakeOptionResult result = _makeOptions(
+      Some(optionName),
+      state.allOptions,
+    );
     emit(state.copyWith(
       filter: Some(optionName),
       options: result.options,
@@ -159,6 +161,7 @@ class SelectOptionCellEditorBloc
   Future<void> _loadOptions() async {
     final result = await _selectOptionService.getOptionContext();
     if (isClosed) {
+      Log.warn("Unexpected closing the bloc");
       return;
     }
 
@@ -177,7 +180,9 @@ class SelectOptionCellEditorBloc
   }
 
   _MakeOptionResult _makeOptions(
-      Option<String> filter, List<SelectOptionPB> allOptions) {
+    Option<String> filter,
+    List<SelectOptionPB> allOptions,
+  ) {
     final List<SelectOptionPB> options = List.from(allOptions);
     Option<String> createOption = filter;
 

frontend/app_flowy/lib/plugins/grid/application/field/type_option/type_option_data_controller.dart

@@ -12,7 +12,7 @@ import 'type_option_context.dart';
 class TypeOptionDataController {
   final String databaseId;
   final IFieldTypeOptionLoader loader;
-  late TypeOptionPB _data;
+  late TypeOptionPB _typeOptiondata;
   final PublishNotifier<FieldPB> _fieldNotifier = PublishNotifier();
 
   /// Returns a [TypeOptionDataController] used to modify the specified
@@ -27,7 +27,7 @@ class TypeOptionDataController {
     FieldInfo? fieldInfo,
   }) {
     if (fieldInfo != null) {
-      _data = TypeOptionPB.create()
+      _typeOptiondata = TypeOptionPB.create()
         ..databaseId = databaseId
         ..field_2 = fieldInfo.field;
     }
@@ -38,7 +38,7 @@ class TypeOptionDataController {
     return result.fold(
       (data) {
         data.freeze();
-        _data = data;
+        _typeOptiondata = data;
         _fieldNotifier.value = data.field_2;
         return left(data);
       },
@@ -50,28 +50,28 @@ class TypeOptionDataController {
   }
 
   FieldPB get field {
-    return _data.field_2;
+    return _typeOptiondata.field_2;
   }
 
   T getTypeOption<T>(TypeOptionDataParser<T> parser) {
-    return parser.fromBuffer(_data.typeOptionData);
+    return parser.fromBuffer(_typeOptiondata.typeOptionData);
   }
 
   set fieldName(String name) {
-    _data = _data.rebuild((rebuildData) {
+    _typeOptiondata = _typeOptiondata.rebuild((rebuildData) {
       rebuildData.field_2 = rebuildData.field_2.rebuild((rebuildField) {
         rebuildField.name = name;
       });
     });
 
-    _fieldNotifier.value = _data.field_2;
+    _fieldNotifier.value = _typeOptiondata.field_2;
 
     FieldService(databaseId: databaseId, fieldId: field.id)
         .updateField(name: name);
   }
 
   set typeOptionData(List<int> typeOptionData) {
-    _data = _data.rebuild((rebuildData) {
+    _typeOptiondata = _typeOptiondata.rebuild((rebuildData) {
       if (typeOptionData.isNotEmpty) {
         rebuildData.typeOptionData = typeOptionData;
       }

frontend/app_flowy/lib/startup/plugin/plugin.dart

@@ -52,7 +52,7 @@ abstract class PluginBuilder {
 
   PluginType get pluginType;
 
-  ViewDataFormatPB get dataFormatType => ViewDataFormatPB.TreeFormat;
+  ViewDataFormatPB get dataFormatType => ViewDataFormatPB.NodeFormat;
 
   ViewLayoutTypePB? get layoutType => ViewLayoutTypePB.Document;
 }

frontend/app_flowy/lib/workspace/application/app/app_service.dart

@@ -76,7 +76,7 @@ class AppService {
       ..to = toIndex
       ..ty = MoveFolderItemType.MoveView;
 
-    return FolderEventMoveFolderItem(payload).send();
+    return FolderEventMoveItem(payload).send();
   }
 
   Future<List<Tuple2<AppPB, List<ViewPB>>>> fetchViews(

frontend/app_flowy/lib/workspace/application/workspace/workspace_service.dart

@@ -65,6 +65,6 @@ class WorkspaceService {
       ..to = toIndex
       ..ty = MoveFolderItemType.MoveApp;
 
-    return FolderEventMoveFolderItem(payload).send();
+    return FolderEventMoveItem(payload).send();
   }
 }

frontend/app_flowy/test/bloc_test/board_test/group_by_checkbox_field_test.dart

@@ -33,7 +33,7 @@ void main() {
     final gridGroupBloc = GridGroupBloc(
       viewId: context.gridView.id,
       fieldController: context.fieldController,
-    );
+    )..add(const GridGroupEvent.initial());
     gridGroupBloc.add(GridGroupEvent.setGroupByField(
       checkboxField.id,
       checkboxField.fieldType,

frontend/app_flowy/test/bloc_test/board_test/group_by_multi_select_field_test.dart

@@ -14,7 +14,7 @@ void main() {
     boardTest = await AppFlowyBoardTest.ensureInitialized();
   });
 
-  test('group by multi select with no options test', () async {
+  test('no status group name test', () async {
     final context = await boardTest.createTestBoard();
 
     // create multi-select field
@@ -27,7 +27,9 @@ void main() {
     final gridGroupBloc = GridGroupBloc(
       viewId: context.gridView.id,
       fieldController: context.fieldController,
-    );
+    )..add(const GridGroupEvent.initial());
+    await boardResponseFuture();
+
     gridGroupBloc.add(GridGroupEvent.setGroupByField(
       multiSelectField.id,
       multiSelectField.fieldType,
@@ -72,7 +74,9 @@ void main() {
     final gridGroupBloc = GridGroupBloc(
       viewId: context.gridView.id,
       fieldController: context.fieldController,
-    );
+    )..add(const GridGroupEvent.initial());
+    await boardResponseFuture();
+
     gridGroupBloc.add(GridGroupEvent.setGroupByField(
       multiSelectField.id,
       multiSelectField.fieldType,

frontend/app_flowy/test/bloc_test/grid_test/cell/select_option_cell_test.dart

@@ -64,15 +64,24 @@ void main() {
 
       bloc.add(const SelectOptionEditorEvent.newOption("A"));
       await gridResponseFuture();
+      assert(bloc.state.options.length == 1,
+          "Expect 1 but receive ${bloc.state.options.length}, Options: ${bloc.state.options}");
+
       bloc.add(const SelectOptionEditorEvent.newOption("B"));
       await gridResponseFuture();
+      assert(bloc.state.options.length == 2,
+          "Expect 2 but receive ${bloc.state.options.length}, Options: ${bloc.state.options}");
+
       bloc.add(const SelectOptionEditorEvent.newOption("C"));
       await gridResponseFuture();
+      assert(bloc.state.options.length == 3,
+          "Expect 3 but receive ${bloc.state.options.length}. Options: ${bloc.state.options}");
 
       bloc.add(const SelectOptionEditorEvent.deleteAllOptions());
       await gridResponseFuture();
 
-      assert(bloc.state.options.isEmpty);
+      assert(bloc.state.options.isEmpty,
+          "Expect empty but receive ${bloc.state.options.length}");
     });
 
     test('select/unselect option', () async {
@@ -161,18 +170,41 @@ void main() {
 
       bloc.add(const SelectOptionEditorEvent.newOption("abcd"));
       await gridResponseFuture();
+      expect(
+        bloc.state.options.length,
+        1,
+        reason: "Options: ${bloc.state.options}",
+      );
 
       bloc.add(const SelectOptionEditorEvent.newOption("aaaa"));
       await gridResponseFuture();
+      expect(
+        bloc.state.options.length,
+        2,
+        reason: "Options: ${bloc.state.options}",
+      );
 
       bloc.add(const SelectOptionEditorEvent.newOption("defg"));
       await gridResponseFuture();
+      expect(
+        bloc.state.options.length,
+        3,
+        reason: "Options: ${bloc.state.options}",
+      );
 
       bloc.add(const SelectOptionEditorEvent.filterOption("a"));
       await gridResponseFuture();
 
-      expect(bloc.state.options.length, 2);
-      expect(bloc.state.allOptions.length, 3);
+      expect(
+        bloc.state.options.length,
+        2,
+        reason: "Options: ${bloc.state.options}",
+      );
+      expect(
+        bloc.state.allOptions.length,
+        3,
+        reason: "Options: ${bloc.state.options}",
+      );
       expect(bloc.state.createOption, const Some("a"));
       expect(bloc.state.filter, const Some("a"));
     });