refactor: Added an UserError mixin for easier handling on Sentry.

Author: Skyost

lib/model/backend/authentication/providers/email.dart

@@ -17,7 +17,7 @@ class EmailAuthenticationProvider extends AuthenticationProvider {
     if ((uri as EmailSentAppLink).isValid) {
       if (uri.cancelCode == null) {
         return ResultError(
-          exception: uri.previously ? EmailAlreadySentException() : _NoCancelCodeException(),
+          exception: uri.previously ? _EmailAlreadySentException() : _NoCancelCodeException(),
         );
       }
       _ref.read(emailConfirmationStateProvider.notifier)._markNeedsConfirmation(uri.email, uri.cancelCode!);
@@ -219,9 +219,9 @@ class _NoEmailToConfirmException extends LocalizableException {
 }
 
 /// Triggered when the email has already been sent.
-class EmailAlreadySentException extends LocalizableException {
+class _EmailAlreadySentException extends LocalizableException with UserError {
   /// Creates a new email already sent exception instance.
-  EmailAlreadySentException()
+  _EmailAlreadySentException()
     : super(
         localizedErrorMessage: translations.error.backend.emailAlreadySent,
       );

lib/model/backend/authentication/providers/provider.dart

@@ -16,6 +16,7 @@ import 'package:open_authenticator/model/backend/user.dart';
 import 'package:open_authenticator/model/settings/backend_url.dart';
 import 'package:open_authenticator/model/settings/entry.dart';
 import 'package:open_authenticator/utils/platform.dart';
+import 'package:open_authenticator/utils/result/reporter.dart';
 import 'package:open_authenticator/utils/result/result.dart';
 import 'package:open_authenticator/utils/shared_preferences_with_prefix.dart';
 import 'package:open_authenticator/utils/uri_builder.dart';

lib/model/backend/request/error.dart

@@ -1,5 +1,6 @@
 import 'package:open_authenticator/i18n/localizable_exception.dart';
 import 'package:open_authenticator/i18n/translations.g.dart';
+import 'package:open_authenticator/utils/result/reporter.dart';
 
 /// Represents a backend request error.
 class BackendRequestError extends LocalizableException {
@@ -65,14 +66,14 @@ class BackendRequestError extends LocalizableException {
           statusCode: statusCode,
           message: message,
         );
-      case InvalidVerificationCodeError.kErrorCode:
-        return InvalidVerificationCodeError._(
+      case _InvalidVerificationCodeError.kErrorCode:
+        return _InvalidVerificationCodeError._(
           route: route,
           statusCode: statusCode,
           message: message,
         );
-      case InvalidAuthorizationCodeError.kErrorCode:
-        return InvalidAuthorizationCodeError._(
+      case _InvalidAuthorizationCodeError.kErrorCode:
+        return _InvalidAuthorizationCodeError._(
           route: route,
           statusCode: statusCode,
           message: message,
@@ -83,8 +84,8 @@ class BackendRequestError extends LocalizableException {
           statusCode: statusCode,
           message: message,
         );
-      case ProviderUserAlreadyExists.kErrorCode:
-        return ProviderUserAlreadyExists._(
+      case _ProviderUserAlreadyExistsError.kErrorCode:
+        return _ProviderUserAlreadyExistsError._(
           route: route,
           statusCode: statusCode,
           message: message,
@@ -171,7 +172,7 @@ class InvalidSessionError extends BackendRequestError {
 }
 
 /// Thrown when the verification code is expired.
-class ExpiredCodeError extends BackendRequestError {
+class ExpiredCodeError extends BackendRequestError with UserError {
   /// The expired code error code.
   static const String kErrorCode = 'expiredCode';
 
@@ -187,12 +188,12 @@ class ExpiredCodeError extends BackendRequestError {
 }
 
 /// Thrown when the verification code is invalid.
-class InvalidVerificationCodeError extends BackendRequestError {
+class _InvalidVerificationCodeError extends BackendRequestError with UserError {
   /// The invalid verification code error code.
   static const String kErrorCode = 'invalidVerificationCode';
 
   /// Creates a new invalid verification code error instance.
-  InvalidVerificationCodeError._({
+  _InvalidVerificationCodeError._({
     required super.route,
     required super.statusCode,
     super.message,
@@ -203,12 +204,12 @@ class InvalidVerificationCodeError extends BackendRequestError {
 }
 
 /// Thrown when the provider authorization code is invalid.
-class InvalidAuthorizationCodeError extends BackendRequestError {
+class _InvalidAuthorizationCodeError extends BackendRequestError with UserError {
   /// The invalid authorization code error code.
   static const String kErrorCode = 'invalidAuthorizationCode';
 
   /// Creates a new invalid authorization code error instance.
-  InvalidAuthorizationCodeError._({
+  _InvalidAuthorizationCodeError._({
     required super.route,
     required super.statusCode,
     super.message,
@@ -235,12 +236,12 @@ class InvalidAppVersionError extends BackendRequestError {
 }
 
 /// Thrown when the provider user already exists.
-class ProviderUserAlreadyExists extends BackendRequestError {
+class _ProviderUserAlreadyExistsError extends BackendRequestError with UserError {
   /// The provider user already exists error code.
   static const String kErrorCode = 'providerUserAlreadyExists';
 
   /// Creates a new expired session error instance.
-  ProviderUserAlreadyExists._({
+  _ProviderUserAlreadyExistsError._({
     required super.route,
     required super.statusCode,
     super.message,

lib/utils/result/reporter.dart

@@ -2,9 +2,6 @@ import 'dart:async';
 import 'dart:io';
 
 import 'package:flutter/foundation.dart';
-import 'package:open_authenticator/model/backend/authentication/providers/provider.dart';
-import 'package:open_authenticator/model/backend/request/error.dart';
-import 'package:open_authenticator/model/backup/backup.dart';
 import 'package:open_authenticator/utils/result/result.dart';
 import 'package:open_authenticator/utils/sentry.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
@@ -87,12 +84,7 @@ bool _sendToSentry(Object? ex) =>
     switch (ex) {
       SocketException(:final osError) => !{7, 8}.contains(osError?.errorCode),
       TimeoutException() => false,
-      ProviderUserAlreadyExists() => false,
-      ExpiredCodeError() => false,
-      EmailAlreadySentException() => false,
-      InvalidVerificationCodeError() => false,
-      InvalidAuthorizationCodeError() => false,
-      InvalidBackupPasswordException() => false,
+      UserError(:final reportToSentry) => reportToSentry,
       _ => true,
     };
 
@@ -144,3 +136,9 @@ class SentryResultReporter implements ResultReporter {
     );
   }
 }
+
+/// An user error, that may not be reported to Sentry.
+mixin UserError {
+  /// Whether the error should be reported to Sentry.
+  bool get reportToSentry => false;
+}