util.dart 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. import 'package:app_flowy/plugins/grid/application/cell/cell_service/cell_service.dart';
  2. import 'package:app_flowy/plugins/grid/application/field/field_controller.dart';
  3. import 'package:app_flowy/plugins/grid/application/field/field_editor_bloc.dart';
  4. import 'package:app_flowy/plugins/grid/application/field/field_service.dart';
  5. import 'package:app_flowy/plugins/grid/application/field/type_option/type_option_context.dart';
  6. import 'package:app_flowy/plugins/grid/application/grid_data_controller.dart';
  7. import 'package:app_flowy/plugins/grid/application/row/row_bloc.dart';
  8. import 'package:app_flowy/plugins/grid/application/row/row_cache.dart';
  9. import 'package:app_flowy/plugins/grid/application/row/row_data_controller.dart';
  10. import 'package:app_flowy/plugins/grid/grid.dart';
  11. import 'package:app_flowy/workspace/application/app/app_service.dart';
  12. import 'package:appflowy_backend/protobuf/flowy-folder/view.pb.dart';
  13. import 'package:appflowy_backend/protobuf/flowy-grid/field_entities.pb.dart';
  14. import '../../util.dart';
  15. class GridTestContext {
  16. final ViewPB gridView;
  17. final GridController gridController;
  18. GridTestContext(this.gridView, this.gridController);
  19. List<RowInfo> get rowInfos {
  20. return gridController.rowInfos;
  21. }
  22. List<FieldInfo> get fieldContexts => fieldController.fieldInfos;
  23. GridFieldController get fieldController {
  24. return gridController.fieldController;
  25. }
  26. Future<void> createRow() async {
  27. return gridController.createRow();
  28. }
  29. FieldEditorBloc createFieldEditor({
  30. FieldInfo? fieldInfo,
  31. }) {
  32. IFieldTypeOptionLoader loader;
  33. if (fieldInfo == null) {
  34. loader = NewFieldTypeOptionLoader(gridId: gridView.id);
  35. } else {
  36. loader =
  37. FieldTypeOptionLoader(gridId: gridView.id, field: fieldInfo.field);
  38. }
  39. final editorBloc = FieldEditorBloc(
  40. fieldName: fieldInfo?.name ?? '',
  41. isGroupField: fieldInfo?.isGroupField ?? false,
  42. loader: loader,
  43. gridId: gridView.id,
  44. );
  45. return editorBloc;
  46. }
  47. Future<GridCellController> makeCellController(
  48. String fieldId, int rowIndex) async {
  49. final builder = await makeCellControllerBuilder(fieldId, rowIndex);
  50. return builder.build();
  51. }
  52. Future<GridCellControllerBuilder> makeCellControllerBuilder(
  53. String fieldId,
  54. int rowIndex,
  55. ) async {
  56. final RowInfo rowInfo = rowInfos[rowIndex];
  57. final rowCache = gridController.rowCache;
  58. final fieldController = gridController.fieldController;
  59. final rowDataController = RowDataController(
  60. rowInfo: rowInfo,
  61. fieldController: fieldController,
  62. rowCache: rowCache,
  63. );
  64. final rowBloc = RowBloc(
  65. rowInfo: rowInfo,
  66. dataController: rowDataController,
  67. )..add(const RowEvent.initial());
  68. await gridResponseFuture();
  69. return GridCellControllerBuilder(
  70. cellId: rowBloc.state.gridCellMap[fieldId]!,
  71. cellCache: rowCache.cellCache,
  72. delegate: rowDataController,
  73. );
  74. }
  75. Future<FieldEditorBloc> createField(FieldType fieldType) async {
  76. final editorBloc = createFieldEditor()
  77. ..add(const FieldEditorEvent.initial());
  78. await gridResponseFuture();
  79. editorBloc.add(FieldEditorEvent.switchToField(fieldType));
  80. await gridResponseFuture();
  81. return Future(() => editorBloc);
  82. }
  83. FieldInfo singleSelectFieldContext() {
  84. final fieldInfo = fieldContexts
  85. .firstWhere((element) => element.fieldType == FieldType.SingleSelect);
  86. return fieldInfo;
  87. }
  88. GridFieldCellContext singleSelectFieldCellContext() {
  89. final field = singleSelectFieldContext().field;
  90. return GridFieldCellContext(gridId: gridView.id, field: field);
  91. }
  92. FieldInfo textFieldContext() {
  93. final fieldInfo = fieldContexts
  94. .firstWhere((element) => element.fieldType == FieldType.RichText);
  95. return fieldInfo;
  96. }
  97. FieldInfo checkboxFieldContext() {
  98. final fieldInfo = fieldContexts
  99. .firstWhere((element) => element.fieldType == FieldType.Checkbox);
  100. return fieldInfo;
  101. }
  102. Future<GridSelectOptionCellController> makeSelectOptionCellController(
  103. FieldType fieldType, int rowIndex) async {
  104. assert(fieldType == FieldType.SingleSelect ||
  105. fieldType == FieldType.MultiSelect);
  106. final field =
  107. fieldContexts.firstWhere((element) => element.fieldType == fieldType);
  108. final cellController = await makeCellController(field.id, rowIndex)
  109. as GridSelectOptionCellController;
  110. return cellController;
  111. }
  112. Future<GridTextCellController> makeTextCellController(int rowIndex) async {
  113. final field = fieldContexts
  114. .firstWhere((element) => element.fieldType == FieldType.RichText);
  115. final cellController =
  116. await makeCellController(field.id, rowIndex) as GridTextCellController;
  117. return cellController;
  118. }
  119. Future<GridTextCellController> makeCheckboxCellController(
  120. int rowIndex) async {
  121. final field = fieldContexts
  122. .firstWhere((element) => element.fieldType == FieldType.Checkbox);
  123. final cellController =
  124. await makeCellController(field.id, rowIndex) as GridTextCellController;
  125. return cellController;
  126. }
  127. }
  128. /// Create a empty Grid for test
  129. class AppFlowyGridTest {
  130. final AppFlowyUnitTest unitTest;
  131. AppFlowyGridTest({required this.unitTest});
  132. static Future<AppFlowyGridTest> ensureInitialized() async {
  133. final inner = await AppFlowyUnitTest.ensureInitialized();
  134. return AppFlowyGridTest(unitTest: inner);
  135. }
  136. Future<GridTestContext> createTestGrid() async {
  137. final app = await unitTest.createTestApp();
  138. final builder = GridPluginBuilder();
  139. final context = await AppService()
  140. .createView(
  141. appId: app.id,
  142. name: "Test Grid",
  143. dataFormatType: builder.dataFormatType,
  144. pluginType: builder.pluginType,
  145. layoutType: builder.layoutType!,
  146. )
  147. .then((result) {
  148. return result.fold(
  149. (view) async {
  150. final context = GridTestContext(view, GridController(view: view));
  151. final result = await context.gridController.openGrid();
  152. result.fold((l) => null, (r) => throw Exception(r));
  153. return context;
  154. },
  155. (error) {
  156. throw Exception();
  157. },
  158. );
  159. });
  160. return context;
  161. }
  162. }
  163. /// Create a new Grid for cell test
  164. class AppFlowyGridCellTest {
  165. late GridTestContext context;
  166. final AppFlowyGridTest gridTest;
  167. AppFlowyGridCellTest({required this.gridTest});
  168. static Future<AppFlowyGridCellTest> ensureInitialized() async {
  169. final gridTest = await AppFlowyGridTest.ensureInitialized();
  170. return AppFlowyGridCellTest(gridTest: gridTest);
  171. }
  172. Future<void> createTestGrid() async {
  173. context = await gridTest.createTestGrid();
  174. }
  175. Future<void> createTestRow() async {
  176. await context.createRow();
  177. }
  178. Future<GridSelectOptionCellController> makeSelectOptionCellController(
  179. FieldType fieldType, int rowIndex) async {
  180. return context.makeSelectOptionCellController(fieldType, rowIndex);
  181. }
  182. }
  183. Future<void> gridResponseFuture({int milliseconds = 200}) {
  184. return Future.delayed(gridResponseDuration(milliseconds: milliseconds));
  185. }
  186. Duration gridResponseDuration({int milliseconds = 200}) {
  187. return Duration(milliseconds: milliseconds);
  188. }