fix(cat-voices): handle duplicate email error (#2587)

dt-iohk · web-flow · commit 58425947c877 · 2025-05-23T09:00:16.000+02:00
* feat: handle resource conflict error

* fix: missing props

* feat: improve fallback error message

* feat: throw EmailAlreadyInUseException

* feat: add EmailAlreadyUsed exception

* feat: handle email already in use

* feat: handle error

* chore: reformat
diff --git a/catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/account/account_cubit.dart b/catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/account/account_cubit.dart
@@ -48,6 +48,9 @@ final class AccountCubit extends Cubit<AccountState>
       await _userService.resendActiveAccountVerificationEmail();
 
       emitSignal(const AccountVerificationEmailSendSignal());
+    } on EmailAlreadyUsedException catch (error, stackTrace) {
+      _logger.severe('Re-send verification email - already used', error, stackTrace);
+      emitError(const LocalizedEmailAlreadyUsedException());
     } catch (error, stackTrace) {
       _logger.severe('Re-send verification email', error, stackTrace);
       emitError(LocalizedException.create(error));
@@ -82,6 +85,10 @@ final class AccountCubit extends Cubit<AccountState>
       emitSignal(const AccountVerificationEmailSendSignal());
 
       return true;
+    } on EmailAlreadyUsedException {
+      _logger.info('Email already used');
+      emitError(const LocalizedEmailAlreadyUsedException());
+      return false;
     } catch (error, stackTrace) {
       _logger.severe('Update email', error, stackTrace);
       emitError(LocalizedException.create(error));
diff --git a/catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/registration/registration_cubit.dart b/catalyst_voices/packages/internal/catalyst_voices_blocs/lib/src/registration/registration_cubit.dart
@@ -184,6 +184,23 @@ final class RegistrationCubit extends Cubit<RegistrationState> with BlocErrorEmi
           isSubmittingTx: false,
         ),
       );
+    } on EmailAlreadyUsedException {
+      _logger.info('Email already in use');
+
+      emitError(const LocalizedRegistrationEmailAlreadyUsedException());
+
+      _onRegistrationStateDataChanged(
+        _registrationState.copyWith(
+          isSubmittingTx: false,
+        ),
+      );
+
+      _progressNotifier.clear();
+
+      // Since the RBAC registration is done at this point email error
+      // doesn't prevent the registration from finishing, later the user will
+      // have to update their email in the account page.
+      nextStep();
     } catch (error, stack) {
       _logger.severe('Submit registration failed', error, stack);
 
diff --git a/catalyst_voices/packages/internal/catalyst_voices_localization/lib/l10n/intl_en.arb b/catalyst_voices/packages/internal/catalyst_voices_localization/lib/l10n/intl_en.arb
@@ -786,6 +786,10 @@
   "@somethingWentWrong": {
     "description": "Error description when something goes wrong."
   },
+  "resourceConflictError": "Provided data is not unique.",
+  "@resourceConflictError": {
+    "description": "Error description when there's duplicate data (i.e. email or username already taken)."
+  },
   "noWalletFound": "No wallet found.",
   "@noWalletFound": {
     "description": "A description when no wallet extension was found."
@@ -1462,6 +1466,14 @@
   },
   "errorEmailValidationPattern": "Incorrect email pattern",
   "errorEmailValidationOutOfRange": "Invalid length",
+  "errorEmailAlreadyInUseUpdateLater": "This email address is already in use. You can update your email later from your account settings.",
+  "@errorEmailAlreadyInUseUpdateLater": {
+    "description": "Error when trying to register with email that is taken already (in registration)."
+  },
+  "errorEmailAlreadyInUse": "This email address is already in use.",
+  "@errorEmailAlreadyInUse": {
+    "description": "Error when trying to update email that is taken already."
+  },
   "categoryDetails": "Category Details",
   "fundsAvailable": "Funds Available",
   "minBudgetRequest": "Min budget request",
diff --git a/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/api/exception/api_error_response_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/api/exception/api_error_response_exception.dart
@@ -16,6 +16,10 @@ final class ApiErrorResponseException extends ApiException {
   /// In context of request.
   static const int notFound = 404;
 
+  /// A request could not be completed due to a conflict
+  /// with the current state of the target resource.
+  static const int conflict = 409;
+
   /// The client has not sent valid data in its request, headers, parameters
   /// or body.
   static const int preconditionFailed = 412;
diff --git a/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/email_already_used_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/email_already_used_exception.dart
@@ -0,0 +1,11 @@
+import 'package:equatable/equatable.dart';
+
+final class EmailAlreadyUsedException extends Equatable implements Exception {
+  const EmailAlreadyUsedException();
+
+  @override
+  List<Object?> get props => [];
+
+  @override
+  String toString() => 'EmailAlreadyUsedException';
+}
diff --git a/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/errors.dart b/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/errors.dart
@@ -1,5 +1,7 @@
 export 'crypto_exception.dart';
+export 'email_already_used_exception.dart';
 export 'network_error.dart';
 export 'not_found_exception.dart';
+export 'resource_conflict_exception.dart';
 export 'secure_storage_error.dart';
 export 'vault_exception.dart';
diff --git a/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/resource_conflict_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_models/lib/src/errors/resource_conflict_exception.dart
@@ -0,0 +1,18 @@
+import 'package:equatable/equatable.dart';
+
+final class ResourceConflictException extends Equatable implements Exception {
+  final String? message;
+
+  const ResourceConflictException({this.message});
+
+  @override
+  List<Object?> get props => [message];
+
+  @override
+  String toString() {
+    if (message != null) {
+      return 'ResourceConflictException: $message';
+    }
+    return 'ResourceConflictException';
+  }
+}
diff --git a/catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/common/response_mapper.dart b/catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/common/response_mapper.dart
@@ -23,6 +23,8 @@ extension ResponseMapper<T> on chopper.Response<T> {
       return bodyBytes;
     } else if (statusCode == ApiErrorResponseException.notFound) {
       throw NotFoundException(message: error.toString());
+    } else if (statusCode == ApiErrorResponseException.conflict) {
+      throw ResourceConflictException(message: _extractErrorMessage(error));
     } else {
       throw toApiException();
     }
@@ -32,7 +34,9 @@ extension ResponseMapper<T> on chopper.Response<T> {
     if (isSuccessful) {
       return bodyOrThrow;
     } else if (statusCode == ApiErrorResponseException.notFound) {
-      throw NotFoundException(message: error.toString());
+      throw NotFoundException(message: _extractErrorMessage(error));
+    } else if (statusCode == ApiErrorResponseException.conflict) {
+      throw ResourceConflictException(message: _extractErrorMessage(error));
     } else {
       throw toApiException();
     }
@@ -44,4 +48,8 @@ extension ResponseMapper<T> on chopper.Response<T> {
       error: error,
     );
   }
+
+  String? _extractErrorMessage(Object? error) {
+    return error?.toString();
+  }
 }
diff --git a/catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/user/user_repository.dart b/catalyst_voices/packages/internal/catalyst_voices_repositories/lib/src/user/user_repository.dart
@@ -28,6 +28,7 @@ abstract interface class UserRepository {
 
   Future<User> getUser();
 
+  /// Throws [EmailAlreadyUsedException] if [email] already taken.
   Future<void> publishUserProfile({
     required CatalystId catalystId,
     required String email,
@@ -91,14 +92,18 @@ final class UserRepositoryImpl implements UserRepository {
     required CatalystId catalystId,
     required String email,
   }) async {
-    await _apiServices.reviews
-        .apiCatalystIdsMePost(
-          body: CatalystIDCreate(
-            catalystIdUri: catalystId.toUri().toStringWithoutScheme(),
-            email: email,
-          ),
-        )
-        .successBodyOrThrow();
+    try {
+      await _apiServices.reviews
+          .apiCatalystIdsMePost(
+            body: CatalystIDCreate(
+              catalystIdUri: catalystId.toUri().toStringWithoutScheme(),
+              email: email,
+            ),
+          )
+          .successBodyOrThrow();
+    } on ResourceConflictException {
+      throw const EmailAlreadyUsedException();
+    }
   }
 
   @override
diff --git a/catalyst_voices/packages/internal/catalyst_voices_repositories/test/src/common/response_mapper_test.dart b/catalyst_voices/packages/internal/catalyst_voices_repositories/test/src/common/response_mapper_test.dart
@@ -53,6 +53,17 @@ void main() {
       );
     });
 
+    test('successBodyBytesOrThrow throws $ResourceConflictException for 409', () {
+      final response = mockBinaryResponse(
+        statusCode: HttpStatus.conflict,
+      );
+
+      expect(
+        response.successBodyBytesOrThrow,
+        throwsA(const ResourceConflictException()),
+      );
+    });
+
     test('successBodyBytesOrThrow throws $ApiErrorResponseException otherwise', () {
       final response = mockBinaryResponse(
         statusCode: HttpStatus.internalServerError,
@@ -82,6 +93,17 @@ void main() {
       );
     });
 
+    test('successBodyOrThrow throws $ResourceConflictException for 409', () {
+      final response = mockResponse(
+        statusCode: HttpStatus.conflict,
+      );
+
+      expect(
+        response.successBodyOrThrow,
+        throwsA(const ResourceConflictException()),
+      );
+    });
+
     test('successBodyOrThrow throws $ApiErrorResponseException otherwise', () {
       final response = mockResponse(
         statusCode: HttpStatus.internalServerError,
diff --git a/catalyst_voices/packages/internal/catalyst_voices_services/lib/src/user/user_service.dart b/catalyst_voices/packages/internal/catalyst_voices_services/lib/src/user/user_service.dart
@@ -40,12 +40,20 @@ abstract interface class UserService implements ActiveAware {
   ///
   /// It can invoke some one-time registration logic,
   /// contrary to [useAccount] which doesn't have such logic.
+  ///
+  /// Throws [EmailAlreadyUsedException] if [Account.email] already taken.
+  ///
+  /// Due to impossibility to validate the email before registering
+  /// the account will be still registered and afterwards
+  /// the [EmailAlreadyUsedException] thrown in case of non-unique email.
   Future<void> registerAccount(Account account);
 
   Future<void> removeAccount(Account account);
 
+  /// Throws [EmailAlreadyUsedException] if email already taken.
   Future<void> resendActiveAccountVerificationEmail();
 
+  /// Throws [EmailAlreadyUsedException] if [email] already taken.
   Future<void> updateAccount({
     required CatalystId id,
     Optional<String>? username,
@@ -157,11 +165,9 @@ final class UserServiceImpl implements UserService {
     if (email != null) {
       // updating user profile must be after updating user so that
       // the request is sent with correct access token
-      unawaited(
-        _userRepository.publishUserProfile(
-          catalystId: account.catalystId,
-          email: email,
-        ),
+      await _userRepository.publishUserProfile(
+        catalystId: account.catalystId,
+        email: email,
       );
     }
   }
diff --git a/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/account/exception/localized_email_already_use_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/account/exception/localized_email_already_use_exception.dart
@@ -0,0 +1,12 @@
+import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
+import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+import 'package:catalyst_voices_view_models/src/exception/localized_exception.dart';
+import 'package:flutter/widgets.dart';
+
+/// A localized version of [EmailAlreadyUsedException].
+final class LocalizedEmailAlreadyUsedException extends LocalizedException {
+  const LocalizedEmailAlreadyUsedException();
+
+  @override
+  String message(BuildContext context) => context.l10n.errorEmailAlreadyInUse;
+}
diff --git a/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/catalyst_voices_view_models.dart b/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/catalyst_voices_view_models.dart
@@ -1,3 +1,4 @@
+export 'account/exception/localized_email_already_use_exception.dart';
 export 'account/my_account_role_item.dart';
 export 'account/my_account_status_notification.dart';
 export 'api/exception/localized_api_exception.dart';
@@ -18,11 +19,11 @@ export 'document/document_version.dart';
 export 'document/validation/localized_document_validation_result.dart';
 export 'exception/localized_exception.dart';
 export 'exception/localized_not_found_exception.dart';
-export 'exception/localized_proposal_deletion_exception.dart';
 export 'exception/localized_unknown_exception.dart';
 export 'managers/video_manager_assets.dart';
 export 'menu/menu_item.dart';
 export 'menu/popup_menu_item.dart';
+export 'proposal/exception/localized_proposal_deletion_exception.dart';
 export 'proposal/exception/localized_unknown_publish_comment_exception.dart';
 export 'proposal/proposal_overview_segment.dart';
 export 'proposal/proposal_title.dart';
@@ -38,6 +39,7 @@ export 'proposal_comments/proposal_comments_sort.dart';
 export 'proposals/proposals_category_filter.dart';
 export 'proposals/proposals_category_selector_item.dart';
 export 'proposals/proposals_filter_type_ext.dart';
+export 'registration/exception/localized_registration_email_already_used_exception.dart';
 export 'registration/exception/localized_registration_exception.dart';
 export 'registration/network_id_ext.dart';
 export 'registration/registration.dart';
diff --git a/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/exception/localized_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/exception/localized_exception.dart
@@ -1,6 +1,7 @@
 import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
 import 'package:catalyst_voices_models/catalyst_voices_models.dart';
 import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
+import 'package:catalyst_voices_view_models/src/exception/localized_resource_conflict_exception.dart';
 import 'package:equatable/equatable.dart';
 import 'package:flutter/material.dart';
 
@@ -15,6 +16,9 @@ abstract base class LocalizedException with EquatableMixin implements Exception
     if (error is LocalizedException) return error;
     if (error is ApiException) return LocalizedApiException.from(error);
     if (error is NotFoundException) return const LocalizedNotFoundException();
+    if (error is ResourceConflictException) {
+      return LocalizedResourceConflictException(error.message);
+    }
 
     return fallback();
   }
diff --git a/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/exception/localized_resource_conflict_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/exception/localized_resource_conflict_exception.dart
@@ -0,0 +1,15 @@
+import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
+import 'package:catalyst_voices_view_models/catalyst_voices_view_models.dart';
+import 'package:flutter/widgets.dart';
+
+final class LocalizedResourceConflictException extends LocalizedException {
+  final String? customMessage;
+
+  const LocalizedResourceConflictException(this.customMessage);
+
+  @override
+  List<Object?> get props => [customMessage];
+
+  @override
+  String message(BuildContext context) => customMessage ?? context.l10n.resourceConflictError;
+}
diff --git a/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/proposal/exception/localized_proposal_deletion_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/proposal/exception/localized_proposal_deletion_exception.dart
diff --git a/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/registration/exception/localized_registration_email_already_used_exception.dart b/catalyst_voices/packages/internal/catalyst_voices_view_models/lib/src/registration/exception/localized_registration_email_already_used_exception.dart
@@ -0,0 +1,12 @@
+import 'package:catalyst_voices_localization/catalyst_voices_localization.dart';
+import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+import 'package:catalyst_voices_view_models/src/exception/localized_exception.dart';
+import 'package:flutter/widgets.dart';
+
+/// A localized version of [EmailAlreadyUsedException].
+final class LocalizedRegistrationEmailAlreadyUsedException extends LocalizedException {
+  const LocalizedRegistrationEmailAlreadyUsedException();
+
+  @override
+  String message(BuildContext context) => context.l10n.errorEmailAlreadyInUseUpdateLater;
+}
