feat(cat-voices): Proposal builder localized errors (#3843)

* feat: handle more errors in proposal builder

* feat: handle more errors

* feat: add more exceptions

* fix: restore error

* chore: cleanup

* chore: refine error message

* chore: refine log message

Author: dt-iohk

catalyst_voices/apps/voices/lib/pages/proposal_builder/proposal_builder_page.dart

@@ -15,10 +15,9 @@ import 'package:catalyst_voices/pages/workspace/submission_closing_warning_dialo
 import 'package:catalyst_voices/routes/routes.dart';
 import 'package:catalyst_voices/routes/routing/proposal_builder_route.dart';
 import 'package:catalyst_voices/widgets/modals/comment/submit_comment_error_dialog.dart';
+import 'package:catalyst_voices/widgets/modals/proposals/proposal_error_dialog.dart';
 import 'package:catalyst_voices/widgets/modals/proposals/proposal_limit_reached_dialog.dart';
-import 'package:catalyst_voices/widgets/modals/proposals/publish_proposal_error_dialog.dart';
 import 'package:catalyst_voices/widgets/modals/proposals/publish_proposal_iteration_dialog.dart';
-import 'package:catalyst_voices/widgets/modals/proposals/submit_proposal_error_dialog.dart';
 import 'package:catalyst_voices/widgets/modals/proposals/submit_proposal_for_review_dialog.dart';
 import 'package:catalyst_voices/widgets/modals/proposals/unlock_edit_proposal.dart';
 import 'package:catalyst_voices/widgets/snackbar/common_snackbars.dart';
@@ -142,8 +141,14 @@ class _ProposalBuilderBodyState extends State<_ProposalBuilderBody>
         unawaited(_showPublishException(error));
       case ProposalBuilderSubmitException():
         unawaited(_showSubmitException(error));
+      case ProposalBuilderLimitReachedException():
+        unawaited(_showLimitReachedException(error));
+      case ProposalBuilderDocumentSignException():
+        unawaited(_showDocumentSignException(error));
       case LocalizedUnknownPublishCommentException():
         unawaited(_showCommentException(error));
+      case LocalizedException():
+        unawaited(_showGenericException(error));
       default:
         super.handleError(error);
     }
@@ -277,6 +282,14 @@ class _ProposalBuilderBodyState extends State<_ProposalBuilderBody>
     );
   }
 
+  Future<void> _showDocumentSignException(ProposalBuilderDocumentSignException error) {
+    return ProposalErrorDialog.show(
+      context: context,
+      title: error.title(context),
+      message: error.message(context),
+    );
+  }
+
   Future<void> _showEmailNotVerifiedDialog() async {
     final openAccount = await EmailNotVerifiedDialog.show(context);
 
@@ -317,6 +330,22 @@ class _ProposalBuilderBodyState extends State<_ProposalBuilderBody>
     });
   }
 
+  Future<void> _showGenericException(LocalizedException error) {
+    return ProposalErrorDialog.show(
+      context: context,
+      title: context.l10n.somethingWentWrong,
+      message: error.message(context),
+    );
+  }
+
+  Future<void> _showLimitReachedException(ProposalBuilderLimitReachedException error) {
+    return ProposalErrorDialog.show(
+      context: context,
+      title: error.title(context),
+      message: error.message(context),
+    );
+  }
+
   Future<void> _showProposalLimitReachedDialog(
     MaxProposalsLimitReachedSignal signal,
   ) {
@@ -344,9 +373,10 @@ class _ProposalBuilderBodyState extends State<_ProposalBuilderBody>
   }
 
   Future<void> _showPublishException(ProposalBuilderPublishException error) {
-    return PublishProposalErrorDialog.show(
+    return ProposalErrorDialog.show(
       context: context,
-      exception: error,
+      title: error.title(context),
+      message: error.message(context),
     );
   }
 
@@ -380,9 +410,10 @@ class _ProposalBuilderBodyState extends State<_ProposalBuilderBody>
   }
 
   Future<void> _showSubmitException(ProposalBuilderSubmitException error) {
-    return SubmitProposalErrorDialog.show(
+    return ProposalErrorDialog.show(
       context: context,
-      exception: error,
+      title: error.title(context),
+      message: error.message(context),
     );
   }
 

…posals/submit_proposal_error_dialog.dart …als/proposals/proposal_error_dialog.dartcatalyst_voices/apps/voices/lib/widgets/modals/proposals/submit_proposal_error_dialog.dart renamed to catalyst_voices/apps/voices/lib/widgets/modals/proposals/proposal_error_dialog.dart catalyst_voices/apps/voices/lib/widgets/modals/proposals/submit_proposal_error_dialog.dart renamed to catalyst_voices/apps/voices/lib/widgets/modals/proposals/proposal_error_dialog.dart

@@ -4,27 +4,27 @@ import 'package:catalyst_voices/widgets/modals/voices_info_dialog.dart';
 import 'package:catalyst_voices_assets/catalyst_voices_assets.dart';
 import 'package:catalyst_voices_brands/catalyst_voices_brands.dart';
 import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
-import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
 import 'package:flutter/material.dart';
 
-/// Error dialog when submitting proposal for review fails.
-class SubmitProposalErrorDialog {
+/// Generic error dialog related to proposal errors.
+class ProposalErrorDialog {
   static Future<void> show({
     required BuildContext context,
-    required ProposalBuilderSubmitException exception,
+    required String title,
+    required String message,
   }) {
     return VoicesDialog.show(
       context: context,
       routeSettings: const RouteSettings(
-        name: '/proposal-builder/submit-error',
+        name: '/proposal-builder/error',
       ),
       builder: (context) {
         return VoicesInfoDialog(
           icon: VoicesAssets.icons.exclamation.buildIcon(
             color: Theme.of(context).colors.iconsWarning,
           ),
-          title: Text(exception.title(context)),
-          message: Text(exception.message(context)),
+          title: Text(title),
+          message: Text(message),
           action: VoicesFilledButton(
             onTap: () => Navigator.of(context).pop(),
             child: Text(context.l10n.okay),

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

@@ -790,9 +790,21 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
         versions: updatedVersions,
       );
       emitSignal(const PublishedProposalBuilderSignal());
+    } on ProposalLimitReachedException {
+      _logger.info('publishProposal: limit reached');
+      emitError(const ProposalBuilderLimitReachedException());
+    } on DocumentSignException catch (error, stackTrace) {
+      _logger.severe('publishProposal: failed to sign the document', error, stackTrace);
+      emitError(const ProposalBuilderDocumentSignException());
     } catch (error, stackTrace) {
-      _logger.severe('PublishProposal', error, stackTrace);
-      emitError(const ProposalBuilderPublishException());
+      _logger.severe('publishProposal', error, stackTrace);
+
+      emitError(
+        LocalizedException.create(
+          error,
+          fallback: () => const ProposalBuilderPublishException(),
+        ),
+      );
     } finally {
       emit(state.copyWith(isChanging: false));
     }
@@ -1092,9 +1104,21 @@ final class ProposalBuilderBloc extends Bloc<ProposalBuilderEvent, ProposalBuild
           // already submitted, do nothing
           break;
       }
+    } on ProposalLimitReachedException {
+      _logger.info('SubmitProposalForReview: limit reached');
+      emitError(const ProposalBuilderLimitReachedException());
+    } on DocumentSignException catch (error, stackTrace) {
+      _logger.severe('publishProposal: failed to sign the document', error, stackTrace);
+      emitError(const ProposalBuilderDocumentSignException());
     } catch (error, stackTrace) {
       _logger.severe('SubmitProposalForReview', error, stackTrace);
-      emitError(const ProposalBuilderSubmitException());
+
+      emitError(
+        LocalizedException.create(
+          error,
+          fallback: () => const ProposalBuilderSubmitException(),
+        ),
+      );
     } finally {
       emit(state.copyWith(isChanging: false));
     }

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

@@ -2194,6 +2194,22 @@
   "@proposalEditorDeleteDialogTitle": {
     "description": "A title for the dialog to confirm proposal deletion."
   },
+  "proposalEditorDocumentSignErrorMessage": "We couldn't sign the proposal, please try again later.",
+  "@proposalEditorDocumentSignErrorMessage": {
+    "description": "Dialog message in proposal editor when user couldn't sign the proposal."
+  },
+  "proposalEditorDocumentSignErrorTitle": "Unable to Sign the Proposal",
+  "@proposalEditorDocumentSignErrorTitle": {
+    "description": "Dialog title in proposal editor when user couldn't sign the proposal."
+  },
+  "proposalEditorLimitReachedErrorMessage": "You have reached the maximum number of proposals allowed.",
+  "@proposalEditorLimitReachedErrorMessage": {
+    "description": "Dialog message in proposal editor when user has reached the max proposals limit."
+  },
+  "proposalEditorLimitReachedErrorTitle": "Unable to Publish Proposal",
+  "@proposalEditorLimitReachedErrorTitle": {
+    "description": "Dialog title in proposal editor when user has reached the max proposals limit."
+  },
   "proposalEditorNotAnswered": "Not Answered",
   "@proposalEditorNotAnswered": {
     "description": "Placeholder text when a property has been not filled."

catalyst_voices/packages/internal/catalyst_voices_localization/lib/l10n/intl_en.arb

@@ -51,6 +51,7 @@ export 'document/enums/document_content_media_type.dart';
 export 'document/enums/document_property_format.dart';
 export 'document/enums/document_property_type.dart';
 export 'document/exception/document_import_invalid_data_exception.dart';
+export 'document/exception/document_sign_exception.dart';
 export 'document/schema/document_schema.dart';
 export 'document/schema/property/document_property_schema.dart';
 export 'document/specialized/comment_document.dart';

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/catalyst_voices_models.dart

@@ -0,0 +1,11 @@
+import 'package:equatable/equatable.dart';
+
+/// An exception denoting a problem with signed document creation.
+class DocumentSignException extends Equatable implements Exception {
+  final String message;
+
+  const DocumentSignException(this.message);
+
+  @override
+  List<Object?> get props => [message];
+}

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/document/exception/document_sign_exception.dart

@@ -48,21 +48,25 @@ final class SignedDocumentManagerImpl implements SignedDocumentManager {
     required CatalystId catalystId,
     required CatalystPrivateKey privateKey,
   }) async {
-    final compressedPayload = await _brotliCompressPayload(document.toBytes());
-
-    final coseSign = await CoseSign.sign(
-      protectedHeaders: metadata.asCoseProtectedHeaders,
-      unprotectedHeaders: metadata.asCoseUnprotectedHeaders,
-      payload: compressedPayload,
-      signers: [_CatalystSigner(catalystId, privateKey)],
-    );
-
-    return _CoseSignedDocument(
-      coseSign: coseSign,
-      payload: document,
-      metadata: metadata,
-      signers: [catalystId],
-    );
+    try {
+      final compressedPayload = await _brotliCompressPayload(document.toBytes());
+
+      final coseSign = await CoseSign.sign(
+        protectedHeaders: metadata.asCoseProtectedHeaders,
+        unprotectedHeaders: metadata.asCoseUnprotectedHeaders,
+        payload: compressedPayload,
+        signers: [_CatalystSigner(catalystId, privateKey)],
+      );
+
+      return _CoseSignedDocument(
+        coseSign: coseSign,
+        payload: document,
+        metadata: metadata,
+        signers: [catalystId],
+      );
+    } on CoseSignException catch (error) {
+      throw DocumentSignException('Failed to create a signed document!\nSource: ${error.source}');
+    }
   }
 
   Future<Uint8List> _brotliCompressPayload(Uint8List payload) async {

catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/signed_document/signed_document_manager_impl.dart

@@ -2,6 +2,35 @@ import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
 import 'package:catalyst_voices_view_models/src/exception/localized_exception.dart';
 import 'package:flutter/material.dart';
 
+/// An exception thrown when the app cannot sign the document on the user's behalf.
+final class ProposalBuilderDocumentSignException extends LocalizedException {
+  const ProposalBuilderDocumentSignException();
+
+  @override
+  String message(BuildContext context) {
+    return context.l10n.proposalEditorDocumentSignErrorMessage;
+  }
+
+  String title(BuildContext context) {
+    return context.l10n.proposalEditorDocumentSignErrorTitle;
+  }
+}
+
+/// An exception thrown attempting to create / import a new
+/// proposal when the user has reached the limit.
+final class ProposalBuilderLimitReachedException extends LocalizedException {
+  const ProposalBuilderLimitReachedException();
+
+  @override
+  String message(BuildContext context) {
+    return context.l10n.proposalEditorLimitReachedErrorMessage;
+  }
+
+  String title(BuildContext context) {
+    return context.l10n.proposalEditorLimitReachedErrorTitle;
+  }
+}
+
 /// Localized exception thrown when a proposal builder fails to publish a proposal.
 final class ProposalBuilderPublishException extends LocalizedException {
   const ProposalBuilderPublishException();

catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/proposal_builder/exception/proposal_builder_exception.dart

@@ -1,6 +1,7 @@
 export 'src/cose_constants.dart';
 export 'src/cose_sign.dart';
 export 'src/cose_sign1.dart';
+export 'src/exception/cose_exception.dart';
 export 'src/types/cose_headers.dart';
 export 'src/types/string_or_int.dart';
 export 'src/types/uuid.dart';