Prevent back-button state loss bug with phone verification (#1260)

Author: samtstern

auth/src/main/java/com/firebase/ui/auth/data/model/CountryInfo.java

@@ -18,13 +18,28 @@
  */
 package com.firebase.ui.auth.data.model;
 
+import android.os.Parcel;
+import android.os.Parcelable;
 import android.support.annotation.RestrictTo;
 
 import java.text.Collator;
 import java.util.Locale;
 
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-public final class CountryInfo implements Comparable<CountryInfo> {
+public final class CountryInfo implements Comparable<CountryInfo>, Parcelable {
+
+    public static final Parcelable.Creator<CountryInfo> CREATOR = new Parcelable.Creator<CountryInfo>() {
+        @Override
+        public CountryInfo createFromParcel(Parcel source) {
+            return new CountryInfo(source);
+        }
+
+        @Override
+        public CountryInfo[] newArray(int size) {
+            return new CountryInfo[size];
+        }
+    };
+
     private final Collator mCollator;
     private final Locale mLocale;
     private final int mCountryCode;
@@ -36,6 +51,14 @@ public CountryInfo(Locale locale, int countryCode) {
         mCountryCode = countryCode;
     }
 
+    protected CountryInfo(Parcel in) {
+        mCollator = Collator.getInstance(Locale.getDefault());
+        mCollator.setStrength(Collator.PRIMARY);
+
+        mLocale = (Locale) in.readSerializable();
+        mCountryCode = in.readInt();
+    }
+
     public static String localeToEmoji(Locale locale) {
         String countryCode = locale.getCountry();
         // 0x41 is Letter A
@@ -85,4 +108,15 @@ public String toString() {
     public int compareTo(CountryInfo info) {
         return mCollator.compare(mLocale.getDisplayCountry(), info.mLocale.getDisplayCountry());
     }
+
+    @Override
+    public int describeContents() {
+        return 0;
+    }
+
+    @Override
+    public void writeToParcel(Parcel dest, int flags) {
+        dest.writeSerializable(mLocale);
+        dest.writeInt(mCountryCode);
+    }
 }

auth/src/main/java/com/firebase/ui/auth/ui/phone/CountryListSpinner.java

@@ -21,6 +21,8 @@
 import android.content.Context;
 import android.content.DialogInterface;
 import android.os.AsyncTask;
+import android.os.Bundle;
+import android.os.Parcelable;
 import android.support.v7.widget.AppCompatEditText;
 import android.text.TextUtils;
 import android.util.AttributeSet;
@@ -37,11 +39,16 @@
 
 public final class CountryListSpinner extends AppCompatEditText implements
         View.OnClickListener, CountryListLoadTask.Listener {
+
+    private static final String KEY_SUPER_STATE = "KEY_SUPER_STATE";
+    private static final String KEY_COUNTRY_INFO = "KEY_COUNTRY_INFO";
+
     private final String mTextFormat;
     private final DialogPopup mDialogPopup;
     private final CountryListAdapter mCountryListAdapter;
     private OnClickListener mListener;
     private String mSelectedCountryName;
+    private CountryInfo mSelectedCountryInfo;
 
     public CountryListSpinner(Context context) {
         this(context, null, android.R.attr.spinnerStyle);
@@ -60,7 +67,32 @@ public CountryListSpinner(Context context, AttributeSet attrs, int defStyle) {
         mTextFormat = "%1$s  +%2$d";
         mSelectedCountryName = "";
         CountryInfo countryInfo = PhoneNumberUtils.getCurrentCountryInfo(getContext());
-        setSpinnerText(countryInfo.getCountryCode(), countryInfo.getLocale());
+        setSelectedForCountry(countryInfo.getCountryCode(), countryInfo.getLocale());
+    }
+
+    @Override
+    public Parcelable onSaveInstanceState() {
+        Parcelable superState = super.onSaveInstanceState();
+
+        Bundle bundle = new Bundle();
+        bundle.putParcelable(KEY_SUPER_STATE, superState);
+        bundle.putParcelable(KEY_COUNTRY_INFO, mSelectedCountryInfo);
+
+        return bundle;
+    }
+
+    @Override
+    public void onRestoreInstanceState(Parcelable state) {
+        if (!(state instanceof Bundle)) {
+            super.onRestoreInstanceState(state);
+            return;
+        }
+
+        Bundle bundle = (Bundle) state;
+        Parcelable superState = bundle.getParcelable(KEY_SUPER_STATE);
+        mSelectedCountryInfo = bundle.getParcelable(KEY_COUNTRY_INFO);
+
+        super.onRestoreInstanceState(superState);
     }
 
     private static void hideKeyboard(Context context, View view) {
@@ -70,19 +102,23 @@ private static void hideKeyboard(Context context, View view) {
         }
     }
 
-    private void setSpinnerText(int countryCode, Locale locale) {
+    private void setSelectedForCountry(int countryCode, Locale locale) {
         setText(String.format(mTextFormat, CountryInfo.localeToEmoji(locale), countryCode));
-        setTag(new CountryInfo(locale, countryCode));
+        mSelectedCountryInfo = new CountryInfo(locale, countryCode);
     }
 
     public void setSelectedForCountry(final Locale locale, String countryCode) {
         final String countryName = locale.getDisplayName();
         if (!TextUtils.isEmpty(countryName) && !TextUtils.isEmpty(countryCode)) {
             mSelectedCountryName = countryName;
-            setSpinnerText(Integer.parseInt(countryCode), locale);
+            setSelectedForCountry(Integer.parseInt(countryCode), locale);
         }
     }
 
+    public CountryInfo getSelectedCountryInfo() {
+         return mSelectedCountryInfo;
+    }
+
     @Override
     protected void onDetachedFromWindow() {
         super.onDetachedFromWindow();
@@ -169,7 +205,7 @@ public void run() {
         public void onClick(DialogInterface dialog, int which) {
             final CountryInfo countryInfo = listAdapter.getItem(which);
             mSelectedCountryName = countryInfo.getLocale().getDisplayCountry();
-            setSpinnerText(countryInfo.getCountryCode(), countryInfo.getLocale());
+            setSelectedForCountry(countryInfo.getCountryCode(), countryInfo.getLocale());
             dismiss();
         }
     }

auth/src/main/java/com/firebase/ui/auth/ui/phone/VerifyPhoneNumberFragment.java

@@ -202,13 +202,14 @@ private void onNext() {
         if (phoneNumber == null) {
             mPhoneInputLayout.setError(getString(R.string.fui_invalid_phone_number));
         } else {
+            mPhoneInputLayout.setError(null);
             mVerifier.verifyPhoneNumber(phoneNumber, false);
         }
     }
 
     @Nullable
     private String getPseudoValidPhoneNumber() {
-        final CountryInfo countryInfo = (CountryInfo) mCountryListSpinner.getTag();
+        final CountryInfo countryInfo = mCountryListSpinner.getSelectedCountryInfo();
         final String everythingElse = mPhoneEditText.getText().toString();
 
         if (TextUtils.isEmpty(everythingElse)) {

auth/src/test/java/com/firebase/ui/auth/ui/phone/PhoneActivityTest.java

@@ -131,7 +131,7 @@ public void testDefaultFullPhoneNumber_prePopulatesPhoneNumberInBundle() {
 
         assertEquals(PHONE_NO_COUNTRY_CODE, mPhoneEditText.getText().toString());
         assertEquals(YE_COUNTRY_CODE,
-                String.valueOf(((CountryInfo) mCountryListSpinner.getTag()).getCountryCode()));
+                String.valueOf((mCountryListSpinner.getSelectedCountryInfo()).getCountryCode()));
     }
 
     @Test
@@ -157,9 +157,9 @@ public void testDefaultCountryCodeAndNationalNumber_prePopulatesPhoneNumberInBun
 
         assertEquals(PHONE_NO_COUNTRY_CODE, mPhoneEditText.getText().toString());
         assertEquals(CA_COUNTRY_CODE,
-                String.valueOf(((CountryInfo) mCountryListSpinner.getTag()).getCountryCode()));
+                String.valueOf((mCountryListSpinner.getSelectedCountryInfo()).getCountryCode()));
         assertEquals(new Locale("", CA_ISO2),
-                ((CountryInfo) mCountryListSpinner.getTag()).getLocale());
+                ((CountryInfo) mCountryListSpinner.getSelectedCountryInfo()).getLocale());
     }
 
     @Test