Changed saved views handling, changed repository structure with automatic persistence.

lib/features/documents/view/pages/documents_page.dart

@@ -1,8 +1,11 @@
+import 'dart:math';
+
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:infinite_scroll_pagination/infinite_scroll_pagination.dart';
 import 'package:paperless_api/paperless_api.dart';
 import 'package:paperless_mobile/core/bloc/connectivity_cubit.dart';
+import 'package:paperless_mobile/core/repository/impl/correspondent_repository_impl.dart';
 import 'package:paperless_mobile/core/repository/provider/label_repositories_provider.dart';
 import 'package:paperless_mobile/features/document_details/bloc/document_details_cubit.dart';
 import 'package:paperless_mobile/features/document_details/view/pages/document_details_page.dart';
@@ -23,6 +26,17 @@ import 'package:paperless_mobile/features/settings/bloc/application_settings_cub
 import 'package:paperless_mobile/features/settings/model/application_settings_state.dart';
 import 'package:paperless_mobile/features/settings/model/view_type.dart';
 import 'package:paperless_mobile/util.dart';
+import 'package:collection/collection.dart';
+
+class DocumentFilterIntent {
+  final DocumentFilter? filter;
+  final bool shouldReset;
+
+  DocumentFilterIntent({
+    this.filter,
+    this.shouldReset = false,
+  });
+}
 
 class DocumentsPage extends StatefulWidget {
   const DocumentsPage({Key? key}) : super(key: key);
@@ -35,13 +49,13 @@ class _DocumentsPageState extends State<DocumentsPage> {
   final _pagingController = PagingController<int, DocumentModel>(
     firstPageKey: 1,
   );
-  final _refreshIndicatorKey = GlobalKey<RefreshIndicatorState>();
 
   @override
   void initState() {
     super.initState();
     try {
-      context.read<DocumentsCubit>().load();
+      context.read<DocumentsCubit>().reload();
+      context.read<SavedViewCubit>().reload();
     } on PaperlessServerException catch (error, stackTrace) {
       showErrorMessage(context, error, stackTrace);
     }
@@ -62,7 +76,7 @@ class _DocumentsPageState extends State<DocumentsPage> {
           current == ConnectivityState.connected,
       listener: (context, state) {
         try {
-          context.read<DocumentsCubit>().load();
+          context.read<DocumentsCubit>().reload();
         } on PaperlessServerException catch (error, stackTrace) {
           showErrorMessage(context, error, stackTrace);
         }
@@ -101,7 +115,7 @@ class _DocumentsPageState extends State<DocumentsPage> {
 
   void _openDocumentFilter() async {
     final draggableSheetController = DraggableScrollableController();
-    final filter = await showModalBottomSheet<DocumentFilter>(
+    final filterIntent = await showModalBottomSheet<DocumentFilterIntent>(
       useSafeArea: true,
       context: context,
       shape: const RoundedRectangleBorder(
@@ -130,9 +144,23 @@ class _DocumentsPageState extends State<DocumentsPage> {
         ),
       ),
     );
-    if (filter != null) {
-      context.read<DocumentsCubit>().updateFilter(filter: filter);
-      context.read<SavedViewCubit>().resetSelection();
+    if (filterIntent != null) {
+      try {
+        if (filterIntent.shouldReset) {
+          await context.read<DocumentsCubit>().resetFilter();
+          context.read<DocumentsCubit>().unselectView();
+        } else {
+          if (filterIntent.filter !=
+              context.read<DocumentsCubit>().state.filter) {
+            context.read<DocumentsCubit>().unselectView();
+          }
+          await context
+              .read<DocumentsCubit>()
+              .updateFilter(filter: filterIntent.filter!);
+        }
+      } on PaperlessServerException catch (error, stackTrace) {
+        showErrorMessage(context, error, stackTrace);
+      }
     }
   }
 
@@ -141,6 +169,8 @@ class _DocumentsPageState extends State<DocumentsPage> {
     return BlocBuilder<ApplicationSettingsCubit, ApplicationSettingsState>(
       builder: (context, settings) {
         return BlocBuilder<DocumentsCubit, DocumentsState>(
+          buildWhen: (previous, current) => !const ListEquality()
+              .equals(previous.documents, current.documents),
           builder: (context, state) {
             // Some ugly tricks to make it work with bloc, update pageController
             _pagingController.value = PagingState(
@@ -184,59 +214,34 @@ class _DocumentsPageState extends State<DocumentsPage> {
                   state: state,
                   onReset: () {
                     context.read<DocumentsCubit>().resetFilter();
-                    context.read<SavedViewCubit>().resetSelection();
+                    context.read<DocumentsCubit>().unselectView();
                   },
                 ),
               );
             }
 
             return RefreshIndicator(
-              key: _refreshIndicatorKey,
               onRefresh: _onRefresh,
               notificationPredicate: (_) => isConnected,
               child: CustomScrollView(
                 slivers: [
-                  BlocListener<SavedViewCubit, SavedViewState>(
-                    listenWhen: (previous, current) =>
-                        previous.selectedSavedViewId !=
-                        current.selectedSavedViewId,
-                    listener: (context, state) {
-                      try {
-                        if (state.selectedSavedViewId == null) {
-                          context.read<DocumentsCubit>().resetFilter();
-                        } else {
-                          final newFilter = state
-                              .value[state.selectedSavedViewId]
-                              ?.toDocumentFilter();
-                          if (newFilter != null) {
-                            context
-                                .read<DocumentsCubit>()
-                                .updateFilter(filter: newFilter);
-                          }
-                        }
-                      } on PaperlessServerException catch (error, stackTrace) {
-                        showErrorMessage(context, error, stackTrace);
-                      }
-                    },
-                    child: DocumentsPageAppBar(
-                      isOffline:
-                          connectivityState != ConnectivityState.connected,
-                      actions: [
-                        const SortDocumentsButton(),
-                        IconButton(
-                          icon: Icon(
-                            settings.preferredViewType == ViewType.grid
-                                ? Icons.list
-                                : Icons.grid_view,
-                          ),
-                          onPressed: () => context
-                              .read<ApplicationSettingsCubit>()
-                              .setViewType(
-                                settings.preferredViewType.toggle(),
-                              ),
+                  DocumentsPageAppBar(
+                    isOffline: connectivityState != ConnectivityState.connected,
+                    actions: [
+                      const SortDocumentsButton(),
+                      IconButton(
+                        icon: Icon(
+                          settings.preferredViewType == ViewType.grid
+                              ? Icons.list
+                              : Icons.grid_view,
                         ),
-                      ],
-                    ),
+                        onPressed: () => context
+                            .read<ApplicationSettingsCubit>()
+                            .setViewType(
+                              settings.preferredViewType.toggle(),
+                            ),
+                      ),
+                    ],
                   ),
                   child,
                 ],
@@ -249,10 +254,13 @@ class _DocumentsPageState extends State<DocumentsPage> {
   }
 
   Future<void> _openDetails(DocumentModel document) async {
-    await Navigator.of(context).push<DocumentModel?>(
+    final potentiallyUpdatedModel =
+        await Navigator.of(context).push<DocumentModel?>(
       _buildDetailsPageRoute(document),
     );
-    context.read<DocumentsCubit>().reload();
+    if (potentiallyUpdatedModel != document) {
+      context.read<DocumentsCubit>().reload();
+    }
   }
 
   MaterialPageRoute<DocumentModel?> _buildDetailsPageRoute(
@@ -371,9 +379,8 @@ class _DocumentsPageState extends State<DocumentsPage> {
 
   Future<void> _onRefresh() async {
     try {
-      await context.read<DocumentsCubit>().updateCurrentFilter(
-            (filter) => filter.copyWith(page: 1),
-          );
+      // We do not await here on purpose so we can show a linear progress indicator below the app bar.
+      await context.read<DocumentsCubit>().reload();
       await context.read<SavedViewCubit>().reload();
     } on PaperlessServerException catch (error, stackTrace) {
       showErrorMessage(context, error, stackTrace);