feat(authenticator): Extend fromError in AuthException (#72)

* feat(authenticator): Extend fromError in AuthException to support non-FirebaseAuthException types * chore(authenticator): Translate authentication error class comments to English
altive · Mar 18, 2024 · 95f0f23 · 95f0f23
1 parent b9f174d
commit 95f0f23
Show file tree

Hide file tree

Showing 11 changed files with 247 additions and 118 deletions.
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -491,6 +491,30 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.8.1"
+  leak_tracker:
+    dependency: transitive
+    description:
+      name: leak_tracker
+      sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa"
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.0.0"
+  leak_tracker_flutter_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_flutter_testing
+      sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
+  leak_tracker_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_testing
+      sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
   logging:
     dependency: transitive
     description:
@@ -503,26 +527,26 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.16"
+    version: "0.12.16+1"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.8.0"
   meta:
     dependency: "direct main"
     description:
       name: meta
-      sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
+      sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.11.0"
   mocktail:
     dependency: "direct dev"
     description:
@@ -543,10 +567,10 @@ packages:
     dependency: transitive
     description:
       name: path
-      sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
       url: "https://pub.dev"
     source: hosted
-    version: "1.8.3"
+    version: "1.9.0"
   plugin_platform_interface:
     dependency: transitive
     description:

diff --git a/packages/altfire_authenticator/example/pubspec.lock b/packages/altfire_authenticator/example/pubspec.lock
@@ -207,38 +207,62 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.6.7"
+  leak_tracker:
+    dependency: transitive
+    description:
+      name: leak_tracker
+      sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa"
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.0.0"
+  leak_tracker_flutter_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_flutter_testing
+      sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
+  leak_tracker_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_testing
+      sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
   matcher:
     dependency: transitive
     description:
       name: matcher
-      sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.16"
+    version: "0.12.16+1"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.8.0"
   meta:
     dependency: transitive
     description:
       name: meta
-      sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
+      sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.11.0"
   path:
     dependency: transitive
     description:
       name: path
-      sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
       url: "https://pub.dev"
     source: hosted
-    version: "1.8.3"
+    version: "1.9.0"
   plugin_platform_interface:
     dependency: transitive
     description:
@@ -316,6 +340,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.4"
+  vm_service:
+    dependency: transitive
+    description:
+      name: vm_service
+      sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957
+      url: "https://pub.dev"
+    source: hosted
+    version: "13.0.0"
   web:
     dependency: transitive
     description:
@@ -325,5 +357,5 @@ packages:
     source: hosted
     version: "0.3.0"
 sdks:
-  dart: ">=3.2.1 <4.0.0"
+  dart: ">=3.2.0 <4.0.0"
   flutter: ">=3.16.0"
diff --git a/packages/altfire_authenticator/example/pubspec.yaml b/packages/altfire_authenticator/example/pubspec.yaml
@@ -4,7 +4,7 @@ publish_to: "none"
 version: 0.1.0
 
 environment:
-  sdk: ">=3.2.1 <4.0.0"
+  sdk: ^3.0.0
 
 dependencies:
   altfire_authenticator:

diff --git a/packages/altfire_authenticator/lib/src/auth_exception.dart b/packages/altfire_authenticator/lib/src/auth_exception.dart
@@ -1,12 +1,15 @@
 import 'package:firebase_auth/firebase_auth.dart';
 
-/// 認証で発生したエラーを判別するためのエラークラス。
-/// FirebaseAuthExceptionから生成する。
+/// Error class for identifying errors that occur during authentication.
+/// Generated from FirebaseAuthException.
 sealed class AuthException implements Exception {
-  factory AuthException.fromError(FirebaseAuthException e) {
+  factory AuthException.fromError(Object e) {
+    if (e is! FirebaseAuthException) {
+      return const AuthUndefinedError();
+    }
     return switch (e.code) {
-      // Google認証でキャンセルした場合は「cancel」が返ってくる
-      // Apple認証でキャンセルした場合は「canceled」が返ってくる
+      // When Google authentication is cancelled, 'cancel' is returned.
+      // When Apple authentication is cancelled, 'canceled' is returned.
       'cancel' || 'canceled' => const AuthCancelled(),
       'requires-recent-login' => const AuthRequiresRecentSignIn(),
       'invalid-phone-number' => const AuthInvalidPhoneNumber(),
@@ -21,58 +24,32 @@ sealed class AuthException implements Exception {
       _ => const AuthUndefinedError(),
     };
   }
-
-  @override
-  String toString() => message;
-
-  String get message;
 }
 
 class AuthCancelled implements AuthException {
   const AuthCancelled();
-
-  @override
-  String get message => '認証がキャンセルされました';
 }
 
 class AuthRequiresRecentSignIn implements AuthException {
   const AuthRequiresRecentSignIn();
-
-  @override
-  String get message => '再ログインが必要です';
 }
 
 class AuthInvalidPhoneNumber implements AuthException {
   const AuthInvalidPhoneNumber();
-
-  @override
-  String get message => '電話番号が不正です';
 }
 
 class AuthCredentialAlreadyInUse implements AuthException {
   const AuthCredentialAlreadyInUse();
-
-  @override
-  String get message => 'この認証情報はすでに使用されています';
 }
 
 class AuthFailedNetworkRequest implements AuthException {
   const AuthFailedNetworkRequest();
-
-  @override
-  String get message => 'ネットワークエラーが発生しました';
 }
 
 class AuthUndefinedError implements AuthException {
   const AuthUndefinedError();
-
-  @override
-  String get message => '予期せぬエラーが発生しました';
 }
 
 class AuthRequiresSignIn implements AuthException {
   const AuthRequiresSignIn();
-
-  @override
-  String get message => '予期せぬエラーが発生しました';
 }
diff --git a/packages/altfire_authenticator/test/src/auth_exception_test.dart b/packages/altfire_authenticator/test/src/auth_exception_test.dart
@@ -11,13 +11,14 @@ void main() {
     });
 
     test('AuthCancelled instance is created from the "canceled"', () {
-      final e = FirebaseAuthException(code: 'cancel');
+      final e = FirebaseAuthException(code: 'canceled');
       final sut = AuthException.fromError(e);
       expect(sut, isA<AuthCancelled>());
     });
 
     test(
-      'AuthCancelled instance is created from the "requires-recent-login"',
+      'AuthRequiresRecentSignIn instance is created '
+      'from the "requires-recent-login"',
       () {
         final e = FirebaseAuthException(code: 'requires-recent-login');
         final sut = AuthException.fromError(e);
@@ -26,7 +27,8 @@ void main() {
     );
 
     test(
-      'AuthCancelled instance is created from the "invalid-phone-number"',
+      'AuthInvalidPhoneNumber instance is created '
+      'from the "invalid-phone-number"',
       () {
         final e = FirebaseAuthException(code: 'invalid-phone-number');
         final sut = AuthException.fromError(e);
@@ -35,7 +37,8 @@ void main() {
     );
 
     test(
-      'AuthCancelled instance is created from the "credential-already-in-use"',
+      'AuthCredentialAlreadyInUse instance is created '
+      'from the "credential-already-in-use"',
       () {
         final e = FirebaseAuthException(code: 'credential-already-in-use');
         final sut = AuthException.fromError(e);
@@ -44,12 +47,25 @@ void main() {
     );
 
     test(
-      'AuthCancelled instance is created from the "network-request-failed"',
+      'AuthFailedNetworkRequest instance is created '
+      'from the "network-request-failed"',
       () {
         final e = FirebaseAuthException(code: 'network-request-failed');
         final sut = AuthException.fromError(e);
         expect(sut, isA<AuthFailedNetworkRequest>());
       },
     );
+
+    test('AuthUndefinedError instance is created from the other code', () {
+      final e = FirebaseAuthException(code: 'other');
+      final sut = AuthException.fromError(e);
+      expect(sut, isA<AuthUndefinedError>());
+    });
+
+    test('AuthUndefinedError instance is created from the other error', () {
+      final e = Exception();
+      final sut = AuthException.fromError(e);
+      expect(sut, isA<AuthUndefinedError>());
+    });
   });
 }