fix: handle new versions created by the proposal builder (#2179)

Author: dt-iohk

catalyst_voices/apps/voices/lib/widgets/modals/proposals/create_new_proposal_dialog.dart

@@ -1,3 +1,4 @@
+import 'package:catalyst_voices/common/error_handler.dart';
 import 'package:catalyst_voices/common/ext/build_context_ext.dart';
 import 'package:catalyst_voices/routes/routes.dart';
 import 'package:catalyst_voices/routes/routing/proposal_builder_route.dart';
@@ -120,7 +121,8 @@ class _CategorySelection extends StatelessWidget {
   }
 }
 
-class _CreateNewProposalDialogState extends State<CreateNewProposalDialog> {
+class _CreateNewProposalDialogState extends State<CreateNewProposalDialog>
+    with ErrorHandlerStateMixin<NewProposalCubit, CreateNewProposalDialog> {
   final FocusNode _categoryFocusNode = FocusNode();
 
   @override
@@ -183,16 +185,16 @@ class _CreateNewProposalDialogState extends State<CreateNewProposalDialog> {
   Future<void> _onOpenInEditor() async {
     final cubit = context.read<NewProposalCubit>();
     final draftRef = await cubit.createDraft();
-    if (mounted) {
+    if (draftRef != null && mounted) {
       ProposalBuilderRoute.fromRef(ref: draftRef).go(context);
     }
   }
 
   Future<void> _onSave() async {
     final cubit = context.read<NewProposalCubit>();
-    await cubit.createDraft();
+    final draftRef = await cubit.createDraft();
 
-    if (mounted) {
+    if (draftRef != null && mounted) {
       Navigator.of(context).pop();
     }
   }

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal_builder/new_proposal/new_proposal_cubit.dart

@@ -1,12 +1,17 @@
 import 'dart:async';
 
+import 'package:catalyst_voices_blocs/src/common/bloc_error_emitter_mixin.dart';
 import 'package:catalyst_voices_blocs/src/proposal_builder/new_proposal/new_proposal_state.dart';
 import 'package:catalyst_voices_models/catalyst_voices_models.dart';
 import 'package:catalyst_voices_services/catalyst_voices_services.dart';
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
 import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 
-class NewProposalCubit extends Cubit<NewProposalState> {
+final _logger = Logger('NewProposalCubit');
+
+class NewProposalCubit extends Cubit<NewProposalState>
+    with BlocErrorEmitterMixin<NewProposalState> {
   final CampaignService _campaignService;
   final ProposalService _proposalService;
   final DocumentMapper _documentMapper;
@@ -23,36 +28,43 @@ class NewProposalCubit extends Cubit<NewProposalState> {
     unawaited(getCampaignCategories());
   }
 
-  Future<DraftRef> createDraft() async {
-    final title = state.title.value;
-    final categoryId = state.categoryId;
-
-    if (categoryId == null) {
-      throw StateError('Cannot create draft, category not selected');
-    }
+  Future<DraftRef?> createDraft() async {
+    try {
+      final title = state.title.value;
+      final categoryId = state.categoryId;
 
-    final category = await _campaignService.getCategory(categoryId);
-    final templateRef = category.proposalTemplateRef;
-    final template = await _proposalService.getProposalTemplate(
-      ref: templateRef,
-    );
+      if (categoryId == null) {
+        throw StateError('Cannot create draft, category not selected');
+      }
 
-    final documentBuilder = DocumentBuilder.fromSchema(schema: template.schema)
-      ..addChange(
-        DocumentValueChange(
-          nodeId: ProposalDocument.titleNodeId,
-          value: title,
-        ),
+      final category = await _campaignService.getCategory(categoryId);
+      final templateRef = category.proposalTemplateRef;
+      final template = await _proposalService.getProposalTemplate(
+        ref: templateRef,
       );
 
-    final document = documentBuilder.build();
-    final documentContent = _documentMapper.toContent(document);
+      final documentBuilder =
+          DocumentBuilder.fromSchema(schema: template.schema)
+            ..addChange(
+              DocumentValueChange(
+                nodeId: ProposalDocument.titleNodeId,
+                value: title,
+              ),
+            );
 
-    return _proposalService.createDraftProposal(
-      content: documentContent,
-      template: templateRef,
-      categoryId: categoryId,
-    );
+      final document = documentBuilder.build();
+      final documentContent = _documentMapper.toContent(document);
+
+      return await _proposalService.createDraftProposal(
+        content: documentContent,
+        template: templateRef,
+        categoryId: categoryId,
+      );
+    } catch (error, stackTrace) {
+      _logger.severe('Create draft', error, stackTrace);
+      emitError(LocalizedException.create(error));
+      return null;
+    }
   }
 
   Future<void> getCampaignCategories() async {

catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/proposal_builder/proposal_builder_bloc.dart

@@ -654,19 +654,49 @@ final class ProposalBuilderBloc
     );
   }
 
+  List<DocumentVersion> _recreateDocumentVersionsWithNewRef(
+    DocumentRef newRef,
+  ) {
+    final current = state.metadata.versions;
+
+    return [
+      ...current.map(
+        (e) => e.copyWith(
+          isCurrent: false,
+          isLatest: false,
+        ),
+      ),
+      DocumentVersion(
+        id: newRef.version!,
+        number: current.length + 1,
+        isCurrent: true,
+        isLatest: true,
+      ),
+    ];
+  }
+
   Future<void> _saveDocumentLocally(
     Emitter<ProposalBuilderState> emit,
     Document document,
   ) async {
+    final currentRef = state.metadata.documentRef!;
     final updatedRef = await _upsertDraftProposal(
       _documentMapper.toContent(document),
     );
 
+    List<DocumentVersion>? updatedVersions;
+    if (updatedRef != currentRef) {
+      // if a new ref has been created we need to recreate
+      // the version history to reflect it
+      updatedVersions = _recreateDocumentVersionsWithNewRef(updatedRef);
+    }
+
     _updateMetadata(
       emit,
       documentRef: updatedRef,
       originalDocumentRef: state.metadata.originalDocumentRef ?? updatedRef,
       publish: ProposalPublish.localDraft,
+      versions: updatedVersions,
     );
   }
 
@@ -801,12 +831,14 @@ final class ProposalBuilderBloc
     DocumentRef? documentRef,
     DocumentRef? originalDocumentRef,
     ProposalPublish? publish,
+    List<DocumentVersion>? versions,
   }) {
     final updatedMetadata = state.metadata.copyWith(
       documentRef: documentRef != null ? Optional(documentRef) : null,
       originalDocumentRef:
           originalDocumentRef != null ? Optional(originalDocumentRef) : null,
       publish: publish,
+      versions: versions,
     );
 
     final updatedState = state.copyWith(