feat(cat-voices): adding read view for proposal page (#2537)

* feat: adding read view for proposal page

* feat: range status

* feat: read Only mode

* feat: update campaign stage cubit to new implemantation

* test: adding test

* feat: self review

* fix: spelling

* feat: adding appbar

* fix: format

Author: LynxLynxx

catalyst_voices/apps/voices/lib/pages/proposal/proposal_page.dart

@@ -36,6 +36,32 @@ class ProposalPage extends StatefulWidget {
   State<ProposalPage> createState() => _ProposalPageState();
 }
 
+class _AppBar extends StatelessWidget implements PreferredSizeWidget {
+  const _AppBar();
+
+  @override
+  Size get preferredSize => const VoicesAppBar().preferredSize;
+
+  @override
+  Widget build(BuildContext context) {
+    final readOnlyMode = context.select<ProposalCubit, bool>((cubit) => cubit.state.readOnlyMode);
+
+    return VoicesAppBar(
+      automaticallyImplyLeading: false,
+      actions: [
+        Offstage(
+          offstage: readOnlyMode,
+          child: const SessionActionHeader(),
+        ),
+        Offstage(
+          offstage: readOnlyMode,
+          child: const SessionStateHeader(),
+        ),
+      ],
+    );
+  }
+}
+
 class _ProposalPageState extends State<ProposalPage>
     with
         ErrorHandlerStateMixin<ProposalCubit, ProposalPage>,
@@ -50,13 +76,7 @@ class _ProposalPageState extends State<ProposalPage>
     return SegmentsControllerScope(
       controller: _segmentsController,
       child: Scaffold(
-        appBar: const VoicesAppBar(
-          automaticallyImplyLeading: false,
-          actions: [
-            SessionActionHeader(),
-            SessionStateHeader(),
-          ],
-        ),
+        appBar: const _AppBar(),
         endDrawer: const OpportunitiesDrawer(),
         body: ProposalHeaderWrapper(
           child: ProposalSidebars(

catalyst_voices/apps/voices/lib/routes/guards/proposal_submission_guard.dart

@@ -12,14 +12,17 @@ final class ProposalSubmissionGuard implements RouteGuard {
 
   @override
   FutureOr<String?> redirect(BuildContext context, GoRouterState state) {
+    final path = state.path;
     final campaignState = context.read<CampaignStageCubit>().state;
-    if (campaignState is ProposalSubmissionStage) {
-      if (state.path == const CampaignStageRoute().location) {
-        return const DiscoveryRoute().location;
-      }
-      return null;
-    } else {
-      return const CampaignStageRoute().location;
-    }
+
+    return switch (campaignState) {
+      AfterProposalSubmissionStage() when path != null && ProposalRoute.isPath(path) => null,
+      AfterProposalSubmissionStage() => const CampaignStageRoute().location,
+      PreProposalSubmissionStage() when path != null && ProposalRoute.isPath(path) =>
+        const CampaignStageRoute().location,
+      ProposalSubmissionStage() when state.matchedLocation == const CampaignStageRoute().location =>
+        const DiscoveryRoute().location,
+      _ => null,
+    };
   }
 }

catalyst_voices/apps/voices/lib/routes/routing/proposal_route.dart

@@ -39,7 +39,10 @@ final class ProposalRoute extends GoRouteData
       version: version,
       isDraft: local,
     );
-
     return ProposalPage(ref: ref);
   }
+
+  static bool isPath(String path) {
+    return ($proposalRoute as GoRoute).path == path;
+  }
 }

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/campaign/campaign_stage/campaign_stage_cubit.dart

@@ -27,29 +27,20 @@ class CampaignStageCubit extends Cubit<CampaignStageState> {
   Future<void> getCampaignStage() async {
     try {
       emit(const LoadingCampaignStage());
-      final campaignTimeline = await _campaignService.getCampaignTimeline();
-
-      final now = DateTime.now();
-      final proposalSubmissionStage = campaignTimeline.firstWhere(
-        (e) => e.stage == CampaignTimelineStage.proposalSubmission,
-        orElse: () => throw const NotFoundException(
-          message: 'Proposal submission stage not found',
-        ),
+      final campaignTimeline = await _campaignService.getCampaignTimelineByStage(
+        CampaignTimelineStage.proposalSubmission,
       );
+      final dateRangeStatus = campaignTimeline.timeline.rangeStatusNow();
+      final startDate = campaignTimeline.timeline.from;
 
-      if (proposalSubmissionStage.timeline.isInRange(now)) {
-        emit(const ProposalSubmissionStage());
-        _startCountdownTimer(proposalSubmissionStage.timeline.to);
-      } else if (proposalSubmissionStage.timeline.isBeforeRange(now)) {
-        emit(
-          PreProposalSubmissionStage(
-            startDate: proposalSubmissionStage.timeline.from,
-          ),
-        );
-      } else {
-        emit(const AfterProposalSubmissionStage());
-      }
-      _logger.info(state.toString());
+      return switch (dateRangeStatus) {
+        DateRangeStatus.after => emit(const AfterProposalSubmissionStage()),
+        DateRangeStatus.before => emit(PreProposalSubmissionStage(startDate: startDate)),
+        DateRangeStatus.inRange => {
+            _startCountdownTimer(startDate),
+            emit(const ProposalSubmissionStage()),
+          }
+      };
     } catch (error, stackTrace) {
       _logger.severe('getCampaignStage error', error, stackTrace);
       emit(const ErrorSubmissionStage(LocalizedUnknownException()));

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal/proposal_cubit.dart

@@ -35,9 +35,8 @@ final class ProposalCubit extends Cubit<ProposalState>
     this._campaignService,
     this._documentMapper,
   ) : super(const ProposalState()) {
-    _cache = _cache.copyWith(
-      activeAccountId: Optional(_userService.user.activeAccount?.catalystId),
-    );
+    _cache =
+        _cache.copyWith(activeAccountId: Optional(_userService.user.activeAccount?.catalystId));
     _activeAccountIdSub = _userService.watchUser
         .map((event) => event.activeAccount?.catalystId)
         .distinct()
@@ -57,6 +56,7 @@ final class ProposalCubit extends Cubit<ProposalState>
 
   Future<void> load({required DocumentRef ref}) async {
     try {
+      final isReadOnlyMode = await _isReadOnlyMode();
       _logger.info('Loading $ref');
 
       _cache = _cache.copyWith(ref: Optional.of(ref));
@@ -88,7 +88,7 @@ final class ProposalCubit extends Cubit<ProposalState>
       if (!isClosed) {
         final proposalState = _rebuildProposalState();
 
-        emit(ProposalState(data: proposalState));
+        emit(ProposalState(data: proposalState, readOnlyMode: isReadOnlyMode));
 
         if (proposalState.isCurrentVersionLatest == false) {
           emitSignal(const ViewingOlderVersionSignal());
@@ -379,6 +379,18 @@ final class ProposalCubit extends Cubit<ProposalState>
     emit(state.copyWith(data: _rebuildProposalState()));
   }
 
+  Future<bool> _isReadOnlyMode() async {
+    final campaignTimeline = await _campaignService.getCampaignTimelineByStage(
+      CampaignTimelineStage.proposalSubmission,
+    );
+    final dateRangeStatus = campaignTimeline.timeline.rangeStatusNow();
+
+    return switch (dateRangeStatus) {
+      DateRangeStatus.after => true,
+      _ => false,
+    };
+  }
+
   ProposalViewData _rebuildProposalState() {
     final proposal = _cache.proposal;
     final category = _cache.category;

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal/proposal_state.dart

@@ -8,12 +8,14 @@ final class ProposalState extends Equatable {
   final ProposalViewData data;
   final CommentsState comments;
   final LocalizedException? error;
+  final bool readOnlyMode;
 
   const ProposalState({
     this.isLoading = false,
     this.data = const ProposalViewData(),
     this.comments = const CommentsState(),
     this.error,
+    this.readOnlyMode = false,
   });
 
   @override
@@ -22,6 +24,7 @@ final class ProposalState extends Equatable {
         data,
         comments,
         error,
+        readOnlyMode,
       ];
 
   bool get showData => !showError;
@@ -33,12 +36,14 @@ final class ProposalState extends Equatable {
     ProposalViewData? data,
     CommentsState? comments,
     Optional<LocalizedException>? error,
+    bool? readOnlyMode,
   }) {
     return ProposalState(
       isLoading: isLoading ?? this.isLoading,
       data: data ?? this.data,
       comments: comments ?? this.comments,
       error: error.dataOr(this.error),
+      readOnlyMode: readOnlyMode ?? this.readOnlyMode,
     );
   }
 

catalyst_voices/packages/internal/catalyst_voices_services/lib/src/campaign/campaign_service.dart

@@ -18,6 +18,8 @@ abstract interface class CampaignService {
 
   Future<List<CampaignTimeline>> getCampaignTimeline();
 
+  Future<CampaignTimeline> getCampaignTimelineByStage(CampaignTimelineStage stage);
+
   Future<CampaignCategory> getCategory(SignedDocumentRef ref);
 
   Future<CurrentCampaign> getCurrentCampaign();
@@ -74,6 +76,16 @@ final class CampaignServiceImpl implements CampaignService {
     return _campaignRepository.getCampaignTimeline();
   }
 
+  @override
+  Future<CampaignTimeline> getCampaignTimelineByStage(CampaignTimelineStage stage) async {
+    final timeline = await getCampaignTimeline();
+    final timelineStage = timeline.firstWhere(
+      (element) => element.stage == stage,
+      orElse: () => throw (StateError('Stage $stage not found')),
+    );
+    return timelineStage;
+  }
+
   @override
   Future<CampaignCategory> getCategory(SignedDocumentRef ref) async {
     final category = await _campaignRepository.getCategory(ref);

catalyst_voices/packages/internal/catalyst_voices_shared/lib/src/range/date_range.dart

@@ -64,4 +64,21 @@ class DateRange extends Equatable {
   bool isTodayInRange() {
     return isInRange(DateTime.now());
   }
+
+  DateRangeStatus rangeStatusNow() {
+    final now = DateTime.now();
+    if (isInRange(now)) {
+      return DateRangeStatus.inRange;
+    } else if (isBeforeRange(now)) {
+      return DateRangeStatus.before;
+    } else {
+      return DateRangeStatus.after;
+    }
+  }
+}
+
+enum DateRangeStatus {
+  before,
+  inRange,
+  after,
 }

catalyst_voices/packages/internal/catalyst_voices_shared/test/src/range/date_range_test.dart

@@ -3,6 +3,12 @@ import 'package:test/test.dart';
 
 void main() {
   group(DateRange, () {
+    late final DateTime now;
+
+    setUpAll(() {
+      now = DateTimeExt.now();
+    });
+
     test('is not in range', () {
       // Given
       final range = DateRange(from: DateTime(2025, 1, 20), to: DateTime(2025, 1, 22));
@@ -120,5 +126,103 @@ void main() {
       // Then
       expect(isInRange, isTrue);
     });
+
+    test('rangeStatusNow returns inRange when current date is within range', () {
+      // Given
+      final range = DateRange(
+        from: now.subtract(const Duration(days: 1)),
+        to: now.add(const Duration(days: 1)),
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.inRange));
+    });
+
+    test('rangeStatusNow returns before when current date is before range', () {
+      // Given
+      final range = DateRange(
+        from: now.add(const Duration(days: 1)),
+        to: now.add(const Duration(days: 3)),
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.before));
+    });
+
+    test('rangeStatusNow returns after when current date is after range', () {
+      // Given
+      final range = DateRange(
+        from: now.subtract(const Duration(days: 3)),
+        to: now.subtract(const Duration(days: 1)),
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.after));
+    });
+
+    test('rangeStatusNow returns inRange when current date equals from date', () {
+      // Given
+      final range = DateRange(
+        from: now,
+        to: now.add(const Duration(days: 1)),
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.inRange));
+    });
+
+    test('rangeStatusNow returns inRange when from is null and current date is before to', () {
+      // Given
+      final range = DateRange(
+        from: null,
+        to: now.add(const Duration(days: 1)),
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.inRange));
+    });
+
+    test('rangeStatusNow returns inRange when to is null and current date is after from', () {
+      // Given
+      final range = DateRange(
+        from: DateTime(2025, 1, 20),
+        to: null,
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.inRange));
+    });
+
+    test('rangeStatusNow returns inRange when both from and to are null', () {
+      // Given
+      const range = DateRange(
+        from: null,
+        to: null,
+      );
+
+      // When
+      final status = range.rangeStatusNow();
+
+      // Then
+      expect(status, equals(DateRangeStatus.inRange));
+    });
   });
 }