Deprecating PhoneAuthProvider::kMaxTimeoutMs (#1084)

* Deprecate `PhoneAuthProvider::kMaxTimeoutMs`

This is a read-only valued used to set the upper bound for
`auto_verify_time_out_ms`.  However, the value was set too low and
Android SDK has increase the range to 30 to 120 seconds, while iOS
SDK does not have a way to override timeout.

This is a change to deprecate this public property so that
the underlying SDK can govern the range for timeout. The property is
still accessible but has no effect at all.

Author: chkuang-g

auth/src/android/credential_android.cc

@@ -814,8 +814,7 @@ void PhoneAuthProvider::VerifyPhoneNumber(
   jstring j_phone_number = env->NewStringUTF(phone_number);
   jobject j_milliseconds = env->GetStaticObjectField(
       timeunit::GetClass(), timeunit::GetFieldId(timeunit::kMilliseconds));
-  jlong j_time_out =
-      static_cast<jlong>(std::min(auto_verify_time_out_ms, kMaxTimeoutMs));
+  jlong j_time_out = static_cast<jlong>(auto_verify_time_out_ms);
   jobject j_token = force_resending_token == nullptr
                         ? nullptr
                         : force_resending_token->data_->token_global_ref();

auth/src/include/firebase/auth/credential.h

@@ -524,6 +524,12 @@ class PhoneAuthProvider {
 
   /// Maximum value of `auto_verify_time_out_ms` in @ref VerifyPhoneNumber.
   /// Larger values will be clamped.
+  ///
+  /// @deprecated This value is no longer used to clamp
+  /// `auto_verify_time_out_ms` in @ref VerifyPhoneNumber. The range is
+  /// determined by the underlying SDK, ex. <a
+  /// href="/docs/reference/android/com/google/firebase/auth/PhoneAuthOptions.Builder"><code>PhoneAuthOptions.Build</code>
+  /// in Android SDK</a>
   static const uint32_t kMaxTimeoutMs;
 
   /// Start the phone number authentication operation.
@@ -535,7 +541,6 @@ class PhoneAuthProvider {
   ///    miliseconds. Currently SMS auto retrieval is only supported on Android.
   ///    If 0, do not do SMS auto retrieval.
   ///    If positive, try to auto-retrieve the SMS verification code.
-  ///    If larger than kMaxTimeoutMs, clamped to kMaxTimeoutMs.
   ///    When the time out is exceeded, listener->OnCodeAutoRetrievalTimeOut()
   ///    is called.
   /// @param[in] force_resending_token If NULL, assume this is a new phone

release_build_files/readme.md

@@ -634,10 +634,13 @@ workflow use only during the development of your app, not for publicly shipping
 code.
 
 ## Release Notes
-### Upcoming Release
+### Upcoming
 -   Changes
     - General: Remove unused headers for performance and test lab from the
       package.
+    - Auth (Android/iOS): Deprecating `PhoneAuthProvider::kMaxTimeoutMs`. The
+      actual range is determined by the underlying SDK, ex.
+      [PhoneAuthOptions.Builder from Android SDK](https://firebase.google.com/docs/reference/android/com/google/firebase/auth/PhoneAuthOptions.Builder).
 
 ### 9.6.0
 -   Changes