איך לטפל בשגיאות ב-Phone Number Verification ב-Firebase ב-Android

כשקריאה לספרייה Firebase PNV נכשלת, הספרייה מדווחת על FirebasePhoneNumberVerificationException. בדף הזה מפורטים כל קודי השגיאה שהחריגה יכולה להכיל, מתי כל אחד מהם מתרחש ומה האפליקציה צריכה לעשות בקשר לזה.

ההנחה היא שכבר שילבתם את Firebase PNV כמו שמתואר במאמר תחילת העבודה עם Firebase Phone Number Verification ב-Android.

איך מתבצע הדיווח על שגיאות

• שיטות אסינכרוניות (getVerificationSupportInfo(), getVerifiedPhoneNumber() והשיטות של תהליך בהתאמה אישית) מחזירות Task. אם הן נכשלות, ה-Task נכשל עם FirebasePhoneNumberVerificationException, שמתקבל ב-addOnFailureListener.

• ‫enableTestSession() היא סינכרונית. היא מחזירה ישירות את השגיאה FirebasePhoneNumberVerificationException.

כדי להבין מה השתבש, קוראים את ה-errorCode של החריגה. הקודים של Firebase PNV הם קבועים במחלקה FirebasePnvStatusCodes. אם הכשל נובע מ-Google Play Services, הערך של errorCode יכול להיות גם ערך מסוג CommonStatusCodes, כמו NETWORK_ERROR.

מכשיר או כרטיס SIM לא נתמכים הם לא שגיאה. getVerificationSupportInfo() מצליח ומדווח על isSupported() בתור false עבור אותו כרטיס SIM, ו-getReason() מסביר למה. מידע נוסף על מכשירים וכרטיסי SIM שלא נתמכים

קודי שגיאה

הגדרת סשן בדיקה

השגיאות האלה נזרקות באופן סינכרוני על ידי enableTestSession().

אימות

השגיאות האלה גורמות לכך שה-Task שמוחזר על ידי getVerifiedPhoneNumber() נכשל.

בדיקת תמיכה

ה-Task שמוחזר על ידי getVerificationSupportInfo() נכשל רק אם לא ניתן להריץ את הבדיקה עצמה. במקרה כזה, הערך של errorCode הוא ערך של CommonStatusCodes ב-Google Play Services או CARRIER_NOT_SUPPORTED. להתייחס למכשיר כלא נתמך ולעבור לשיטת אימות אחרת, כמו SMS.

בזמן שסשן בדיקה מופעל, getVerificationSupportInfo() לא יוצר קשר עם הקצה העורפי של Firebase PNV ותמיד מדווח על כרטיס ה-SIM לבדיקה כנתמך, גם אם פג התוקף של אסימון הבדיקה.

תהליך בהתאמה אישית

אם משתמשים בתהליך בהתאמה אישית במקום ב-getVerifiedPhoneNumber():

• הפונקציה getDigitalCredentialPayload() נכשלת עם PREFLIGHT_CHECK_FAILED, או עם INVALID_TEST_NUMBER_ID אם הקצה העורפי דוחה את אסימון הבדיקה.
• הפונקציה exchangeCredentialResponseForPhoneNumber() נכשלת עם INVALID_DIGITAL_CREDENTIAL_RESPONSE, או עם INVALID_TEST_NUMBER_ID אם הקצה העורפי דוחה את טוקן הבדיקה.
• הקריאה שלכם ל-Credential Manager מחזירה GetCredentialException, שאתם מטפלים בה ישירות.

מכשירים וכרטיסי SIM לא נתמכים

כשהערך של isSupported() הוא false לכרטיס SIM, הפונקציה getReason() מחזירה אחד מהערכים הבאים של VerificationSupportStatus:

בכל אחד מהמקרים האלה, צריך להשתמש בשיטת אימות אחרת, כמו SMS, לאותו כרטיס SIM.

דוגמה

בדוגמה הבאה מטופלות השגיאות שאפליקציה טיפוסית צריכה להבחין ביניהן כשמפעילים את getVerifiedPhoneNumber():

import android.util.Log
// Credential Manager is included with the Firebase PNV library.
import androidx.credentials.exceptions.GetCredentialCancellationException
import com.google.firebase.pnv.FirebasePhoneNumberVerification
import com.google.firebase.pnv.FirebasePhoneNumberVerificationException
import com.google.firebase.pnv.FirebasePnvStatusCodes

private const val TAG = "PhoneVerification"

// In your Activity:
private fun verifyPhoneNumber() {
    FirebasePhoneNumberVerification.getInstance()
        .getVerifiedPhoneNumber(this)
        .addOnSuccessListener { result ->
            // Send result.getToken() to your backend.
        }
        .addOnFailureListener { e -> handleFpnvError(e) }
}

private fun handleFpnvError(e: Exception) {
    if (e !is FirebasePhoneNumberVerificationException) {
        Log.w(TAG, "Firebase PNV failed", e)
        showSmsVerification()
        return
    }
    when (e.errorCode) {
        FirebasePnvStatusCodes.CREDENTIAL_MANAGER_ERROR -> {
            if (e.cause is GetCredentialCancellationException) {
                // The user dismissed the consent screen.
            }
            showSmsVerification()
        }
        FirebasePnvStatusCodes.INVALID_TEST_NUMBER_ID -> {
            // Test mode only: generate a new test token.
            Log.e(TAG, "Firebase PNV test token rejected", e)
        }
        FirebasePnvStatusCodes.ACTIVITY_CONTEXT_REQUIRED -> {
            // App bug: pass an Activity to getVerifiedPhoneNumber().
            Log.e(TAG, "Firebase PNV needs an Activity context", e)
        }
        else -> {
            // Carrier not supported, network errors, and other failures.
            Log.w(TAG, "Firebase PNV failed with error code ${e.errorCode}", e)
            showSmsVerification()
        }
    }
}

בדוגמה הזו, showSmsVerification() הוא תהליך האימות הקיים של מספר הטלפון באפליקציה.

השלבים הבאים

• לפרטים על כל מחלקה וקבוע, עיינו במאמרי העזרה של ה-API של Firebase PNV.
• כדי לאמת את הטוקן בשרת, קראו את המאמר אימות טוקנים של Firebase PNV.