feat(cat-voices): voting space (#3648)

* docs: capture initial times

* chore: remove cacheDocument

* turn off logging

* chore: use debugPrint instead of logger

* feat: bulk documents save

* batching sync

* chore: move exact ref resoling to getDocumentData instead of index

* fix: DocumentRepository

* chore: simplify getting documents data

* remove getAllDocumentsRefs and getCachedDocumentsRefs from DocumentRepository. Index is only available in DocumentDataRemoteSource

* chore: update docs

* simplified document index endpoint

* remove randomness from LocalCatGateway

* indexing by batch size

* wip: filtering by types

* Rework filtering refs + checking all refs if already cached in parallel

* docs

* update indexing.csv

* update indexing csv

* chore: cleanup

* trailing new line

* chore

* move performance tab to docs

* bulk saving typed docs in parallel

* chore: revert hardcoded timestamp

* chore: typos

* split _sync into smaller functions + add documentation

* little refactor

* fix: analyzer

* initial v2 tables

* wip

* wip

* feat: database migration

* chore: cleanup

* bump batch size

* cleanup

* chore: remove defensive content decoding

* chore: daos

* spelling

* saveAll

* test on platform

* chore: update build scripts

* feat: DocumentsV2Dao methods

* simple proposals pagination query

* chore: create a JoinedProposalBriefEntity

* rename method

* feat: exclude hidden proposals

* more tests

* renaming and splitting logic into smaller parts

* feat: per language strategy

* remove CatalystDatabaseLanguage in favor of raw queries as they are easier to mange

* remove Index Strategy Documentation

* handle case where ref is empty

* migration now includes indexes

* use v2 documents table for saveAll and isCachedBulk

* adds ActionType to JoinedProposalBriefEntity

* adds versionIds to JoinedProposalBriefEntity

* comments count

* adds isFavorite to JoinedProposalBriefEntity

* add template to JoinedProposalBriefEntity

* adds documentsLocalMetadata table for auto updates

* Update docs

* use v2 proposals query for discovery most recent section

* feat: simplify most recent proposals section

* add proposal fav status for v2 tables

* local proposal fav status update

* update fav state locally for faster feedback

* self review

* fix tests

* update times

* fix: analyzer

* more migration test data

* clean up constructors

* cleanup

* fix: template tests

* spelling

* fix: spelling

* chore: PR review adjustments

* add order parameter

* ProposalsOrder docs

* GetProposalsBriefPage supports order

* add filters object

* proposalsBriefPage filtering

* fix: status filtering

* more draft proposals filtering tests

* Campaign proposals filter

* update docs

* expose getVisibleProposalsCount and tests

* expose filters parameter

* integrate proposals page with v2 queries

* chore: increase time diff between proposals

* chore: reduce count query tables watched when not needed

* local proposals cubit

* local proposal fav staus update

* docs

* fix: add discovery specific colors (#3637)

* fix code-generator earthly target

* use logger in migration + wrap in transaction

* spelling

* wip

* rename category to categoryId for better consistency

* adding vote data to ProposalBriefData

* fix: dependencies

* voting page + cubit integration - wip

* proposals per tab selector

* release completed in close

* extract early return logic into function

* Voting tabs selector + releasing completer on close

* move spaces blocs to shell page level

* fix: voting in grid view

* dummy voting integration

* chore: remove showComments

* docs: ProposalOrDocument

---------

Co-authored-by: Ryszard Schossler <[email protected]>

Author: damian-molinski

catalyst_voices/apps/voices/lib/app/view/app.dart

@@ -47,18 +47,9 @@ class _AppState extends State<App> {
       BlocProvider<SessionCubit>(
         create: (_) => Dependencies.instance.get<SessionCubit>(),
       ),
-      BlocProvider<VotingCubit>(
-        create: (_) => Dependencies.instance.get<VotingCubit>(),
-      ),
       BlocProvider<CampaignBuilderCubit>(
         create: (_) => Dependencies.instance.get<CampaignBuilderCubit>(),
       ),
-      BlocProvider<WorkspaceBloc>(
-        create: (context) => Dependencies.instance.get<WorkspaceBloc>(),
-      ),
-      BlocProvider<DiscoveryCubit>(
-        create: (context) => Dependencies.instance.get<DiscoveryCubit>(),
-      ),
       BlocProvider<CategoryDetailCubit>(
         create: (_) => Dependencies.instance.get<CategoryDetailCubit>(),
       ),

catalyst_voices/apps/voices/lib/dependency/dependencies.dart

@@ -120,13 +120,11 @@ final class Dependencies extends DependencyProvider {
           get<ProposalService>(),
         ),
       )
-      ..registerLazySingleton<VotingCubit>(
+      ..registerFactory<VotingCubit>(
         () => VotingCubit(
           get<UserService>(),
           get<CampaignService>(),
           get<ProposalService>(),
-          get<VotingBallotBuilder>(),
-          get<VotingService>(),
         ),
       )
       // TODO(LynxLynxx): add repository for campaign management
@@ -400,6 +398,7 @@ final class Dependencies extends DependencyProvider {
         get<SignerService>(),
         get<ActiveCampaignObserver>(),
         get<CastedVotesObserver>(),
+        get<VotingBallotBuilder>(),
       );
     });
     registerLazySingleton<CommentService>(() {
@@ -536,7 +535,10 @@ final class Dependencies extends DependencyProvider {
       dispose: (observer) async => observer.dispose(),
     );
     registerLazySingleton<CastedVotesObserver>(CastedVotesObserverImpl.new);
-    registerLazySingleton<VotingBallotBuilder>(VotingBallotLocalBuilder.new);
+    registerLazySingleton<VotingBallotBuilder>(
+      VotingBallotLocalBuilder.new,
+      dispose: (builder) => builder.dispose(),
+    );
 
     // Not a singleton
     registerFactory<RegistrationStatusPoller>(

catalyst_voices/apps/voices/lib/pages/discovery/sections/most_recent_proposals/widgets/most_recent_proposals_list.dart

@@ -23,7 +23,6 @@ class MostRecentProposalsList extends StatelessWidget {
         return _MostRecentProposalsList(
           scrollController: scrollController,
           proposals: state.proposals,
-          showComments: state.showComments,
         );
       },
     );
@@ -32,12 +31,10 @@ class MostRecentProposalsList extends StatelessWidget {
 
 class _MostRecentProposalsList extends StatelessWidget {
   final List<ProposalBrief> proposals;
-  final bool showComments;
   final ScrollController? scrollController;
 
   const _MostRecentProposalsList({
     required this.proposals,
-    required this.showComments,
     this.scrollController,
   });
 
@@ -58,7 +55,6 @@ class _MostRecentProposalsList extends StatelessWidget {
             proposal: proposal,
             onTap: () => _onCardTap(context, ref),
             onFavoriteChanged: (value) => _onCardFavoriteChanged(context, ref, value),
-            showComments: showComments,
           ),
         );
       },

catalyst_voices/apps/voices/lib/pages/spaces/spaces_shell_bloc_provider.dart

@@ -0,0 +1,30 @@
+import 'package:catalyst_voices/dependency/dependencies.dart';
+import 'package:catalyst_voices_blocs/catalyst_voices_blocs.dart';
+import 'package:flutter/material.dart';
+
+class SpacesShellBlocProvider extends StatelessWidget {
+  final Widget child;
+
+  const SpacesShellBlocProvider({
+    super.key,
+    required this.child,
+  });
+
+  @override
+  Widget build(BuildContext context) {
+    return MultiBlocProvider(
+      providers: [
+        BlocProvider<VotingCubit>(
+          create: (_) => Dependencies.instance.get<VotingCubit>(),
+        ),
+        BlocProvider<WorkspaceBloc>(
+          create: (context) => Dependencies.instance.get<WorkspaceBloc>(),
+        ),
+        BlocProvider<DiscoveryCubit>(
+          create: (context) => Dependencies.instance.get<DiscoveryCubit>(),
+        ),
+      ],
+      child: child,
+    );
+  }
+}

catalyst_voices/apps/voices/lib/pages/spaces/spaces_shell_page.dart

@@ -5,6 +5,7 @@ import 'package:catalyst_voices/pages/campaign/admin_tools/campaign_admin_tools_
 import 'package:catalyst_voices/pages/spaces/appbar/spaces_appbar.dart';
 import 'package:catalyst_voices/pages/spaces/drawer/spaces_drawer.dart';
 import 'package:catalyst_voices/pages/spaces/drawer/spaces_end_drawer.dart';
+import 'package:catalyst_voices/pages/spaces/spaces_shell_bloc_provider.dart';
 import 'package:catalyst_voices_blocs/catalyst_voices_blocs.dart';
 import 'package:catalyst_voices_models/catalyst_voices_models.dart';
 import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
@@ -65,40 +66,42 @@ class _SpacesShellPageState extends State<SpacesShellPage> {
 
   @override
   Widget build(BuildContext context) {
-    return BlocListener<AdminToolsCubit, AdminToolsState>(
-      listenWhen: (previous, current) => previous.enabled != current.enabled,
-      listener: (context, state) {
-        if (state.enabled) {
-          _insertAdminToolsOverlay();
-        } else {
-          _removeAdminToolsOverlay();
-        }
-      },
-      child: _Shortcuts(
-        onToggleAdminTools: _toggleAdminTools,
-        child: BlocSelector<SessionCubit, SessionState, _SessionStateData>(
-          selector: (state) => (
-            isActive: state.isActive,
-            isProposer: state.account?.isProposer ?? false,
+    return SpacesShellBlocProvider(
+      child: BlocListener<AdminToolsCubit, AdminToolsState>(
+        listenWhen: (previous, current) => previous.enabled != current.enabled,
+        listener: (context, state) {
+          if (state.enabled) {
+            _insertAdminToolsOverlay();
+          } else {
+            _removeAdminToolsOverlay();
+          }
+        },
+        child: _Shortcuts(
+          onToggleAdminTools: _toggleAdminTools,
+          child: BlocSelector<SessionCubit, SessionState, _SessionStateData>(
+            selector: (state) => (
+              isActive: state.isActive,
+              isProposer: state.account?.isProposer ?? false,
+            ),
+            builder: (context, state) {
+              return Scaffold(
+                appBar: SpacesAppbar(
+                  space: widget.space,
+                  isAppUnlock: state.isActive,
+                  isProposer: state.isProposer,
+                ),
+                drawer: state.isActive
+                    ? SpacesDrawer(
+                        space: widget.space,
+                        spacesShortcutsActivators: AccessControl.allSpacesShortcutsActivators,
+                        isUnlocked: state.isActive,
+                      )
+                    : null,
+                endDrawer: SpacesEndDrawer(space: widget.space),
+                body: widget.child,
+              );
+            },
           ),
-          builder: (context, state) {
-            return Scaffold(
-              appBar: SpacesAppbar(
-                space: widget.space,
-                isAppUnlock: state.isActive,
-                isProposer: state.isProposer,
-              ),
-              drawer: state.isActive
-                  ? SpacesDrawer(
-                      space: widget.space,
-                      spacesShortcutsActivators: AccessControl.allSpacesShortcutsActivators,
-                      isUnlocked: state.isActive,
-                    )
-                  : null,
-              endDrawer: SpacesEndDrawer(space: widget.space),
-              body: widget.child,
-            );
-          },
         ),
       ),
     );
@@ -120,12 +123,6 @@ class _SpacesShellPageState extends State<SpacesShellPage> {
     super.dispose();
   }
 
-  @override
-  void initState() {
-    super.initState();
-    context.read<WorkspaceBloc>().add(const WatchUserProposalsEvent());
-  }
-
   OverlayEntry _createAdminToolsOverlay() {
     return OverlayEntry(
       builder: (BuildContext context) {

catalyst_voices/apps/voices/lib/pages/voting/voting_page.dart

@@ -19,7 +19,7 @@ import 'package:flutter/material.dart';
 import 'package:rxdart/rxdart.dart';
 
 class VotingPage extends StatefulWidget {
-  final SignedDocumentRef? categoryId;
+  final String? categoryId;
   final VotingPageTab? tab;
 
   const VotingPage({
@@ -38,7 +38,7 @@ class _VotingPageState extends State<VotingPage>
         ErrorHandlerStateMixin<VotingCubit, VotingPage>,
         SignalHandlerStateMixin<VotingCubit, VotingSignal, VotingPage> {
   late VoicesTabController<VotingPageTab> _tabController;
-  late final PagingController<ProposalBriefVoting> _pagingController;
+  late final PagingController<ProposalBrief> _pagingController;
   late final StreamSubscription<List<VotingPageTab>> _tabsSubscription;
 
   @override
@@ -78,9 +78,8 @@ class _VotingPageState extends State<VotingPage>
 
     if (widget.categoryId != oldWidget.categoryId || widget.tab != oldWidget.tab) {
       context.read<VotingCubit>().changeFilters(
-        onlyMy: Optional(tab == VotingPageTab.my),
-        category: Optional(widget.categoryId),
-        type: tab.filter,
+        categoryId: Optional(widget.categoryId),
+        tab: Optional(tab),
       );
 
       _doResetPagination();
@@ -103,7 +102,7 @@ class _VotingPageState extends State<VotingPage>
   void handleSignal(VotingSignal signal) {
     switch (signal) {
       case ChangeCategoryVotingSignal(:final to):
-        _updateRoute(categoryId: Optional(to?.id));
+        _updateRoute(categoryId: Optional(to));
       case ChangeTabVotingSignal(:final tab):
         _updateRoute(tab: tab);
       case ResetPaginationVotingSignal():
@@ -146,9 +145,8 @@ class _VotingPageState extends State<VotingPage>
     ).distinct().listen(_updateTabsIfNeeded);
 
     votingCubit.init(
-      onlyMyProposals: selectedTab == VotingPageTab.my,
-      category: widget.categoryId,
-      type: selectedTab.filter,
+      categoryId: widget.categoryId,
+      tab: selectedTab,
     );
 
     _pagingController
@@ -181,7 +179,7 @@ class _VotingPageState extends State<VotingPage>
   Future<void> _handleProposalsPageRequest(
     int pageKey,
     int pageSize,
-    ProposalBriefVoting? lastProposalId,
+    ProposalBrief? lastProposalId,
   ) async {
     final request = PageRequest(page: pageKey, size: pageSize);
     await context.read<VotingCubit>().getProposals(request);
@@ -192,7 +190,7 @@ class _VotingPageState extends State<VotingPage>
     VotingPageTab? tab,
   }) {
     Router.neglect(context, () {
-      final effectiveCategoryId = categoryId.dataOr(widget.categoryId?.id);
+      final effectiveCategoryId = categoryId.dataOr(widget.categoryId);
       final effectiveTab = tab?.name ?? widget.tab?.name;
 
       VotingRoute(

catalyst_voices/apps/voices/lib/pages/voting/widgets/content/voting_content.dart

@@ -10,7 +10,7 @@ import 'package:flutter/material.dart';
 
 class VotingContent extends StatelessWidget {
   final VoicesTabController<VotingPageTab> tabController;
-  final PagingController<ProposalBriefVoting> pagingController;
+  final PagingController<ProposalBrief> pagingController;
 
   const VotingContent({
     super.key,

catalyst_voices/apps/voices/lib/pages/voting/widgets/grid/voting_proposals_pagination.dart

@@ -7,7 +7,7 @@ import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
 import 'package:flutter/material.dart';
 
 class VotingProposalsPagination extends StatelessWidget {
-  final PagingController<ProposalBriefVoting> controller;
+  final PagingController<ProposalBrief> controller;
 
   const VotingProposalsPagination({
     super.key,
@@ -16,9 +16,9 @@ class VotingProposalsPagination extends StatelessWidget {
 
   @override
   Widget build(BuildContext context) {
-    return PaginatedGridView<ProposalBriefVoting>(
+    return PaginatedGridView<ProposalBrief>(
       pagingController: controller,
-      builderDelegate: PagedWrapChildBuilder<ProposalBriefVoting>(
+      builderDelegate: PagedWrapChildBuilder<ProposalBrief>(
         builder: (context, item) {
           return VotingProposalsPaginationTile(
             key: ValueKey(item.selfRef),

catalyst_voices/apps/voices/lib/pages/voting/widgets/grid/voting_proposals_pagination_tile.dart

@@ -7,7 +7,7 @@ import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
 import 'package:flutter/material.dart';
 
 class VotingProposalsPaginationTile extends StatelessWidget {
-  final ProposalBriefVoting proposal;
+  final ProposalBrief proposal;
 
   const VotingProposalsPaginationTile({
     super.key,
@@ -24,9 +24,11 @@ class VotingProposalsPaginationTile extends StatelessWidget {
         unawaited(route.push(context));
       },
       onFavoriteChanged: (isFavorite) {
-        context.read<VotingCubit>().onChangeFavoriteProposal(
-          proposal.selfRef,
-          isFavorite: isFavorite,
+        unawaited(
+          context.read<VotingCubit>().onChangeFavoriteProposal(
+            proposal.selfRef,
+            isFavorite: isFavorite,
+          ),
         );
       },
       onVoteAction: (action) {
@@ -38,7 +40,6 @@ class VotingProposalsPaginationTile extends StatelessWidget {
 
         context.read<VotingBallotBloc>().add(event);
       },
-      readOnly: true,
     );
   }
 }