refactor: failures (fireship-io#14)

narcodico · web-flow · commit cd6a3d55f259 · 2021-08-17T17:34:29.000+03:00
* feat: add base failure

* refactor: rename failure widget

* refactor: make `handleFailure` generic

* refactor: move user failures to user repository

* refactor: move topic failures to topics repository

* refactor: move quiz failures to quizzes repository
diff --git a/lib/app/cubit/app_cubit.dart b/lib/app/cubit/app_cubit.dart
@@ -28,7 +28,7 @@ class AppCubit extends Cubit<AppState> {
   Future<void> logOut() async {
     try {
       await _userRepository.signOut();
-    } on AppFailure catch (failure) {
+    } on UserFailure catch (failure) {
       _onAppFailed(failure);
     }
   }
@@ -43,7 +43,7 @@ class AppCubit extends Cubit<AppState> {
     }
   }
 
-  void _onAppFailed(AppFailure failure) {
+  void _onAppFailed(UserFailure failure) {
     final _state = state;
     emit(AppState.failure(failure: failure, user: _state.user));
     if (failure.requiresReauthentication) {
diff --git a/lib/app/cubit/app_state.dart b/lib/app/cubit/app_state.dart
@@ -18,7 +18,7 @@ class AppState extends Equatable {
   const AppState._({
     required this.status,
     this.user = User.none,
-    this.failure = AppFailure.none,
+    this.failure = UserFailure.none,
   });
 
   const AppState.unauthenticated() : this._(status: AppStatus.unauthenticated);
@@ -36,7 +36,7 @@ class AppState extends Equatable {
         );
 
   const AppState.failure({
-    required AppFailure failure,
+    required UserFailure failure,
     required User user,
   }) : this._(
           status: AppStatus.failure,
@@ -46,7 +46,7 @@ class AppState extends Equatable {
 
   final AppStatus status;
   final User user;
-  final AppFailure failure;
+  final UserFailure failure;
 
   @override
   List<Object?> get props => [status, user, failure];
diff --git a/lib/app/view/app.dart b/lib/app/view/app.dart
@@ -61,15 +61,13 @@ class _AppView extends StatelessWidget {
           if (state.isFailure) {
             final failure = state.failure;
             final l10n = context.l10n;
-            if (failure is AuthFailure) {
+            if (failure is AuthUserChangesFailure) {
               context.showSnackBar(l10n.authFailureMessage);
-              return;
-            }
-            if (failure is SignOutFailure) {
+            } else if (failure is SignOutFailure) {
               context.showSnackBar(l10n.signOutFailureMessage);
-              return;
+            } else {
+              context.showSnackBar(l10n.unknownFailureMessage);
             }
-            context.showSnackBar(l10n.unknownFailureMessage);
           }
         },
         child: FlowBuilder(
diff --git a/lib/login/cubit/login_cubit.dart b/lib/login/cubit/login_cubit.dart
@@ -16,7 +16,7 @@ class LoginCubit extends Cubit<LoginState> {
     try {
       emit(const LoginState.signingInAnonymously());
       await _userRepository.signInAnonymously();
-    } on AppFailure catch (failure) {
+    } on UserFailure catch (failure) {
       _onLoginFailed(failure);
     }
   }
@@ -27,7 +27,7 @@ class LoginCubit extends Cubit<LoginState> {
       await _userRepository.signInWithGoogle();
     } on GoogleSignInCancelledFailure {
       emit(const LoginState.initial());
-    } on AppFailure catch (failure) {
+    } on UserFailure catch (failure) {
       _onLoginFailed(failure);
     }
   }
@@ -36,12 +36,12 @@ class LoginCubit extends Cubit<LoginState> {
     try {
       emit(const LoginState.signingInWithApple());
       await _userRepository.signInWithApple();
-    } on AppFailure catch (failure) {
+    } on UserFailure catch (failure) {
       _onLoginFailed(failure);
     }
   }
 
-  void _onLoginFailed(AppFailure failure) {
+  void _onLoginFailed(UserFailure failure) {
     emit(LoginState.failure(failure));
     emit(const LoginState.initial());
   }
diff --git a/lib/login/cubit/login_state.dart b/lib/login/cubit/login_state.dart
@@ -18,7 +18,7 @@ class LoginState extends Equatable {
   const LoginState._({
     this.status = LoginStatus.initial,
     this.signInMethod = SignInMethod.none,
-    this.failure = AppFailure.none,
+    this.failure = UserFailure.none,
   });
 
   const LoginState.initial() : this._();
@@ -41,15 +41,15 @@ class LoginState extends Equatable {
           signInMethod: SignInMethod.apple,
         );
 
-  const LoginState.failure(AppFailure failure)
+  const LoginState.failure(UserFailure failure)
       : this._(
           status: LoginStatus.failure,
           failure: failure,
         );
 
   final LoginStatus status;
   final SignInMethod signInMethod;
-  final AppFailure failure;
+  final UserFailure failure;
 
   @override
   List<Object> get props => [status, signInMethod, failure];
diff --git a/lib/quiz/view/start_view.dart b/lib/quiz/view/start_view.dart
@@ -30,7 +30,7 @@ class StartView extends StatelessWidget {
           return NoContent(context.l10n.noQuizDataMessage);
         }
         if (state.isFailure) {
-          return Failure(context.l10n.getQuizFailureMessage);
+          return FailureText(context.l10n.getQuizFailureMessage);
         }
         return const Loader();
       },
diff --git a/lib/topics/view/topics_page.dart b/lib/topics/view/topics_page.dart
@@ -52,7 +52,7 @@ class TopicsGrid extends StatelessWidget {
           return NoContent(context.l10n.noTopicsMessage);
         }
         if (state.isFailure) {
-          return Failure(context.l10n.getTopicsFailureMessage);
+          return FailureText(context.l10n.getTopicsFailureMessage);
         }
         return const Loader();
       },
diff --git a/packages/quizzes_repository/lib/quizzes_repository.dart b/packages/quizzes_repository/lib/quizzes_repository.dart
@@ -1,4 +1,5 @@
 library quizzes_repository;
 
+export 'src/failures.dart';
 export 'src/models/models.dart';
 export 'src/quizzes_repository.dart';
diff --git a/packages/quizzes_repository/lib/src/failures.dart b/packages/quizzes_repository/lib/src/failures.dart
@@ -0,0 +1,17 @@
+import 'package:shared/shared.dart';
+
+class QuizzesFailure extends Failure {
+  const QuizzesFailure._();
+
+  factory QuizzesFailure.fromGetQuiz() => const GetQuizFailure();
+
+  static const none = QuizzesNoFailure();
+}
+
+class QuizzesNoFailure extends QuizzesFailure {
+  const QuizzesNoFailure() : super._();
+}
+
+class GetQuizFailure extends QuizzesFailure {
+  const GetQuizFailure() : super._();
+}
diff --git a/packages/quizzes_repository/lib/src/quizzes_repository.dart b/packages/quizzes_repository/lib/src/quizzes_repository.dart
@@ -1,5 +1,5 @@
 import 'package:data_providers/data_providers.dart';
-import 'package:shared/shared.dart';
+import 'package:quizzes_repository/src/failures.dart';
 
 import 'package:quizzes_repository/src/models/models.dart';
 
diff --git a/packages/shared/lib/src/extensions.dart b/packages/shared/lib/src/extensions.dart
@@ -2,7 +2,7 @@ import 'dart:async';
 import 'dart:developer';
 
 import 'package:rxdart/rxdart.dart';
-import 'package:shared/src/failures.dart';
+import 'package:shared/src/failure.dart';
 
 extension StreamExtensions<T> on Stream<T> {
   Stream<T> logOnEach([String prefix = '']) {
@@ -32,10 +32,12 @@ extension StreamExtensions<T> on Stream<T> {
     );
   }
 
-  Stream<T> handleFailure([void Function(AppFailure failure)? onFailure]) {
+  Stream<T> handleFailure<F extends Failure>([
+    void Function(F failure)? onFailure,
+  ]) {
     return handleError(
       (Object error) {
-        if (error is AppFailure) {
+        if (error is F) {
           onFailure?.call(error);
         }
       },
diff --git a/packages/shared/lib/src/failure.dart b/packages/shared/lib/src/failure.dart
@@ -0,0 +1,3 @@
+abstract class Failure implements Exception {
+  const Failure();
+}
diff --git a/packages/shared/lib/src/failures.dart b/packages/shared/lib/src/failures.dart
diff --git a/packages/shared/lib/src/shared.dart b/packages/shared/lib/src/shared.dart
@@ -1,4 +1,4 @@
 export 'crypto_utils.dart';
 export 'extensions.dart';
-export 'failures.dart';
+export 'failure.dart';
 export 'json_converters.dart';
diff --git a/packages/topics_repository/lib/src/failures.dart b/packages/topics_repository/lib/src/failures.dart
@@ -0,0 +1,17 @@
+import 'package:shared/shared.dart';
+
+class TopicsFailure extends Failure {
+  const TopicsFailure._();
+
+  factory TopicsFailure.fromGetTopics() => const GetTopicsFailure();
+
+  static const none = TopicsNoFailure();
+}
+
+class TopicsNoFailure extends TopicsFailure {
+  const TopicsNoFailure() : super._();
+}
+
+class GetTopicsFailure extends TopicsFailure {
+  const GetTopicsFailure() : super._();
+}
diff --git a/packages/topics_repository/lib/src/topics_repository.dart b/packages/topics_repository/lib/src/topics_repository.dart
@@ -1,5 +1,5 @@
 import 'package:data_providers/data_providers.dart';
-import 'package:shared/shared.dart';
+import 'package:topics_repository/src/failures.dart';
 import 'package:topics_repository/src/models/models.dart';
 
 part 'firebase_topics_repository.dart';
diff --git a/packages/topics_repository/lib/topics_repository.dart b/packages/topics_repository/lib/topics_repository.dart
@@ -1,4 +1,5 @@
 library topics_repository;
 
+export 'src/failures.dart';
 export 'src/models/models.dart';
 export 'src/topics_repository.dart';
diff --git a/packages/ui_toolkit/lib/src/widgets.dart b/packages/ui_toolkit/lib/src/widgets.dart
@@ -30,8 +30,8 @@ class Empty extends StatelessWidget {
   }
 }
 
-class Failure extends StatelessWidget {
-  const Failure(String message, {Key? key})
+class FailureText extends StatelessWidget {
+  const FailureText(String message, {Key? key})
       : _message = message,
         super(key: key);
 
@@ -44,6 +44,7 @@ class Failure extends StatelessWidget {
       padding: kInsets,
       child: Text(
         _message,
+        textAlign: TextAlign.center,
         style: const TextStyle(
           color: QuizColors.red,
           fontWeight: FontWeight.bold,
diff --git a/packages/user_repository/lib/src/failures.dart b/packages/user_repository/lib/src/failures.dart
@@ -0,0 +1,53 @@
+import 'package:shared/shared.dart';
+
+class UserFailure extends Failure {
+  const UserFailure._();
+
+  factory UserFailure.fromAuthUserChanges() => const AuthUserChangesFailure();
+  factory UserFailure.fromSignOut() => const SignOutFailure();
+  factory UserFailure.fromAnonymousSignIn() => const AnonymousSignInFailure();
+  factory UserFailure.fromGoogleSignIn() => const GoogleSignInFailure();
+  factory UserFailure.fromGoogleSignInCancelled() =>
+      const GoogleSignInCancelledFailure();
+  factory UserFailure.fromAppleSignIn() => const AppleSignInFailure();
+  factory UserFailure.fromSignInWithAppleNotSupported() =>
+      const AppleSignInNotSupportedFailure();
+
+  static const none = UserNoFailure();
+
+  bool get requiresReauthentication {
+    return this is AuthUserChangesFailure;
+  }
+}
+
+class UserNoFailure extends UserFailure {
+  const UserNoFailure() : super._();
+}
+
+class AuthUserChangesFailure extends UserFailure {
+  const AuthUserChangesFailure() : super._();
+}
+
+class SignOutFailure extends UserFailure {
+  const SignOutFailure() : super._();
+}
+
+class AnonymousSignInFailure extends UserFailure {
+  const AnonymousSignInFailure() : super._();
+}
+
+class GoogleSignInFailure extends UserFailure {
+  const GoogleSignInFailure() : super._();
+}
+
+class GoogleSignInCancelledFailure extends UserFailure {
+  const GoogleSignInCancelledFailure() : super._();
+}
+
+class AppleSignInFailure extends UserFailure {
+  const AppleSignInFailure() : super._();
+}
+
+class AppleSignInNotSupportedFailure extends UserFailure {
+  const AppleSignInNotSupportedFailure() : super._();
+}
diff --git a/packages/user_repository/lib/src/firebase_user_repository.dart b/packages/user_repository/lib/src/firebase_user_repository.dart
diff --git a/packages/user_repository/lib/src/user_repository.dart b/packages/user_repository/lib/src/user_repository.dart
diff --git a/packages/user_repository/lib/user_repository.dart b/packages/user_repository/lib/user_repository.dart

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class AppCubit extends Cubit<AppState> {`
`28`	`28`	`Future<void> logOut() async {`
`29`	`29`	`try {`
`30`	`30`	`await _userRepository.signOut();`
`31`		`- } on AppFailure catch (failure) {`
	`31`	`+ } on UserFailure catch (failure) {`
`32`	`32`	`_onAppFailed(failure);`
`33`	`33`	`}`
`34`	`34`	`}`
`@@ -43,7 +43,7 @@ class AppCubit extends Cubit<AppState> {`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
`46`		`- void _onAppFailed(AppFailure failure) {`
	`46`	`+ void _onAppFailed(UserFailure failure) {`
`47`	`47`	`final _state = state;`
`48`	`48`	`emit(AppState.failure(failure: failure, user: _state.user));`
`49`	`49`	`if (failure.requiresReauthentication) {`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class LoginCubit extends Cubit<LoginState> {`
`16`	`16`	`try {`
`17`	`17`	`emit(const LoginState.signingInAnonymously());`
`18`	`18`	`await _userRepository.signInAnonymously();`
`19`		`- } on AppFailure catch (failure) {`
	`19`	`+ } on UserFailure catch (failure) {`
`20`	`20`	`_onLoginFailed(failure);`
`21`	`21`	`}`
`22`	`22`	`}`
`@@ -27,7 +27,7 @@ class LoginCubit extends Cubit<LoginState> {`
`27`	`27`	`await _userRepository.signInWithGoogle();`
`28`	`28`	`} on GoogleSignInCancelledFailure {`
`29`	`29`	`emit(const LoginState.initial());`
`30`		`- } on AppFailure catch (failure) {`
	`30`	`+ } on UserFailure catch (failure) {`
`31`	`31`	`_onLoginFailed(failure);`
`32`	`32`	`}`
`33`	`33`	`}`
`@@ -36,12 +36,12 @@ class LoginCubit extends Cubit<LoginState> {`
`36`	`36`	`try {`
`37`	`37`	`emit(const LoginState.signingInWithApple());`
`38`	`38`	`await _userRepository.signInWithApple();`
`39`		`- } on AppFailure catch (failure) {`
	`39`	`+ } on UserFailure catch (failure) {`
`40`	`40`	`_onLoginFailed(failure);`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`- void _onLoginFailed(AppFailure failure) {`
	`44`	`+ void _onLoginFailed(UserFailure failure) {`
`45`	`45`	`emit(LoginState.failure(failure));`
`46`	`46`	`emit(const LoginState.initial());`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class StartView extends StatelessWidget {`
`30`	`30`	`return NoContent(context.l10n.noQuizDataMessage);`
`31`	`31`	`}`
`32`	`32`	`if (state.isFailure) {`
`33`		`- return Failure(context.l10n.getQuizFailureMessage);`
	`33`	`+ return FailureText(context.l10n.getQuizFailureMessage);`
`34`	`34`	`}`
`35`	`35`	`return const Loader();`
`36`	`36`	`},`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ class TopicsGrid extends StatelessWidget {`
`52`	`52`	`return NoContent(context.l10n.noTopicsMessage);`
`53`	`53`	`}`
`54`	`54`	`if (state.isFailure) {`
`55`		`- return Failure(context.l10n.getTopicsFailureMessage);`
	`55`	`+ return FailureText(context.l10n.getTopicsFailureMessage);`
`56`	`56`	`}`
`57`	`57`	`return const Loader();`
`58`	`58`	`},`