Merge pull request #16 from rithik-dev/sendOtpOnInit

fixes

Author: rithik-dev

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.0.8] - 20/01/2023
+
+* Added sendOtpOnInitialize parameter to the handler
+* Fixed OTP resend issue if the OTP expiration timer is still active
+* Fixed #15
+* Added shouldAwaitCodeSend to the sendOTP fn to give more control over the function
+* Updated dependencies
+
 ## [1.0.7] - 24/10/2022
 
 * Stacktrace in onLoginFailed is now non-nullable

example/lib/screens/verify_phone_number_screen.dart

@@ -67,6 +67,7 @@ class _VerifyPhoneNumberScreenState extends State<VerifyPhoneNumberScreen>
       child: FirebasePhoneAuthHandler(
         phoneNumber: widget.phoneNumber,
         signOutOnSuccessfulVerification: false,
+        sendOtpOnInitialize: true,
         linkWithExistingUser: false,
         autoRetrievalTimeOutDuration: const Duration(seconds: 60),
         otpExpirationDuration: const Duration(seconds: 60),

example/pubspec.lock

@@ -7,14 +7,14 @@ packages:
       name: _flutterfire_internals
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.5"
+    version: "1.0.12"
   async:
     dependency: transitive
     description:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.8.2"
+    version: "2.9.0"
   boolean_selector:
     dependency: transitive
     description:
@@ -28,7 +28,7 @@ packages:
       name: characters
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.2.1"
   charcode:
     dependency: transitive
     description:
@@ -42,21 +42,7 @@ packages:
       name: clock
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0"
-  cloud_firestore_platform_interface:
-    dependency: transitive
-    description:
-      name: cloud_firestore_platform_interface
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "5.8.2"
-  cloud_firestore_web:
-    dependency: transitive
-    description:
-      name: cloud_firestore_web
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "3.0.2"
+    version: "1.1.1"
   collection:
     dependency: transitive
     description:
@@ -77,56 +63,56 @@ packages:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0"
+    version: "1.3.1"
   firebase_auth:
     dependency: transitive
     description:
       name: firebase_auth
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "4.0.2"
+    version: "4.2.5"
   firebase_auth_platform_interface:
     dependency: transitive
     description:
       name: firebase_auth_platform_interface
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "6.10.4"
+    version: "6.11.7"
   firebase_auth_web:
     dependency: transitive
     description:
       name: firebase_auth_web
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "5.0.2"
+    version: "5.2.4"
   firebase_core:
     dependency: "direct main"
     description:
       name: firebase_core
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.0"
+    version: "2.4.1"
   firebase_core_platform_interface:
     dependency: transitive
     description:
       name: firebase_core_platform_interface
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "4.5.1"
+    version: "4.5.2"
   firebase_core_web:
     dependency: transitive
     description:
       name: firebase_core_web
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.0.0"
+    version: "2.1.0"
   firebase_phone_auth_handler:
     dependency: "direct main"
     description:
       path: ".."
       relative: true
     source: path
-    version: "1.0.7"
+    version: "1.0.8"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -190,21 +176,21 @@ packages:
       name: matcher
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.12.11"
+    version: "0.12.12"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.1.4"
+    version: "0.1.5"
   meta:
     dependency: transitive
     description:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.7.0"
+    version: "1.8.0"
   nested:
     dependency: transitive
     description:
@@ -218,7 +204,7 @@ packages:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.1"
+    version: "1.8.2"
   pinput:
     dependency: "direct main"
     description:
@@ -232,14 +218,14 @@ packages:
       name: plugin_platform_interface
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.2"
+    version: "2.1.3"
   provider:
     dependency: transitive
     description:
       name: provider
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "6.0.4"
+    version: "6.0.5"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -258,7 +244,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.2"
+    version: "1.9.0"
   stack_trace:
     dependency: transitive
     description:
@@ -279,21 +265,21 @@ packages:
       name: string_scanner
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.2.1"
   test_api:
     dependency: transitive
     description:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.9"
+    version: "0.4.12"
   typed_data:
     dependency: transitive
     description:

lib/src/auth_controller.dart

@@ -171,7 +171,16 @@ class FirebasePhoneAuthController extends ChangeNotifier {
   /// If for any reason, the OTP is not send,
   /// [_onLoginFailed] is called with [FirebaseAuthException]
   /// object to handle the error.
-  Future<bool> sendOTP() async {
+  ///
+  /// [shouldAwaitCodeSend] can be used to await the OTP send.
+  /// The firebase method completes early, and if [shouldAwaitCodeSend] is false,
+  /// [sendOTP] will complete early, and the OTP will be sent in the background.
+  /// Whereas, if [shouldAwaitCodeSend] is true, [sendOTP] will wait for the
+  /// code send callback to be fired, and [sendOTP] will complete only after
+  /// that callback is fired. Not applicable on web.
+  Future<bool> sendOTP({bool shouldAwaitCodeSend = true}) async {
+    Completer? codeSendCompleter;
+
     codeSent = false;
     await Future.delayed(Duration.zero, notifyListeners);
 
@@ -180,7 +189,12 @@ class FirebasePhoneAuthController extends ChangeNotifier {
     }
 
     verificationFailedCallback(FirebaseAuthException authException) {
-      _onLoginFailed?.call(authException, StackTrace.current);
+      final stackTrace = authException.stackTrace ?? StackTrace.current;
+
+      if (codeSendCompleter != null && !codeSendCompleter.isCompleted) {
+        codeSendCompleter.completeError(authException, stackTrace);
+      }
+      _onLoginFailed?.call(authException, stackTrace);
     }
 
     codeSentCallback(
@@ -191,6 +205,9 @@ class FirebasePhoneAuthController extends ChangeNotifier {
       _forceResendingToken = forceResendingToken;
       codeSent = true;
       _onCodeSent?.call();
+      if (codeSendCompleter != null && !codeSendCompleter.isCompleted) {
+        codeSendCompleter.complete();
+      }
       _setTimer();
     }
 
@@ -208,6 +225,8 @@ class FirebasePhoneAuthController extends ChangeNotifier {
         _onCodeSent?.call();
         _setTimer();
       } else {
+        codeSendCompleter = Completer();
+
         await _auth.verifyPhoneNumber(
           phoneNumber: _phoneNumber!,
           verificationCompleted: verificationCompletedCallback,
@@ -217,13 +236,21 @@ class FirebasePhoneAuthController extends ChangeNotifier {
           timeout: _autoRetrievalTimeOutDuration,
           forceResendingToken: _forceResendingToken,
         );
+
+        if (shouldAwaitCodeSend) await codeSendCompleter.future;
       }
 
       return true;
     } on FirebaseAuthException catch (e, s) {
+      if (codeSendCompleter != null && !codeSendCompleter.isCompleted) {
+        codeSendCompleter.completeError(e, s);
+      }
       _onLoginFailed?.call(e, s);
       return false;
     } catch (e, s) {
+      if (codeSendCompleter != null && !codeSendCompleter.isCompleted) {
+        codeSendCompleter.completeError(e, s);
+      }
       _onError?.call(e, s);
       return false;
     }
@@ -322,9 +349,11 @@ class FirebasePhoneAuthController extends ChangeNotifier {
     _onError = null;
     _onCodeSent = null;
     _signOutOnSuccessfulVerification = false;
-    _forceResendingToken = null;
+    // _forceResendingToken = null;
     _otpExpirationTimer?.cancel();
     _otpExpirationTimer = null;
+    _otpAutoRetrievalTimer?.cancel();
+    _otpAutoRetrievalTimer = null;
     _phoneNumber = null;
     _linkWithExistingUser = false;
     _autoRetrievalTimeOutDuration = kAutoRetrievalTimeOutDuration;

lib/src/auth_handler.dart

@@ -19,6 +19,7 @@ class FirebasePhoneAuthHandler extends StatefulWidget {
     this.onError,
     this.onCodeSent,
     this.signOutOnSuccessfulVerification = false,
+    this.sendOtpOnInitialize = true,
     this.linkWithExistingUser = false,
     this.autoRetrievalTimeOutDuration =
         FirebasePhoneAuthController.kAutoRetrievalTimeOutDuration,
@@ -58,6 +59,11 @@ class FirebasePhoneAuthHandler extends StatefulWidget {
   /// {@endtemplate}
   final VoidCallback? onCodeSent;
 
+  /// {@template sendOtpOnInitialize}
+  /// Whether to send OTP as soon as the widget initializes or not
+  /// {@endtemplate}
+  final bool sendOtpOnInitialize;
+
   /// {@template linkWithExistingUser}
   ///
   /// If true, links the generated credentials to an existing signed in user,
@@ -198,17 +204,17 @@ class _FirebasePhoneAuthHandlerState extends State<FirebasePhoneAuthHandler> {
         recaptchaVerifierForWeb: captcha,
       );
 
-      await con.sendOTP();
+      if (widget.sendOtpOnInitialize) await con.sendOTP();
     })();
     super.initState();
   }
 
   @override
-  void dispose() {
+  void deactivate() {
     try {
       FirebasePhoneAuthController._of(context, listen: false).clear();
     } catch (_) {}
-    super.dispose();
+    super.deactivate();
   }
 
   @override