Country selector fixes (#1345)

Author: lsirac

auth/README.md

@@ -357,6 +357,11 @@ The country code selector will exclude all countries with a country code of +1 a
 Note: You can't provide both a list of countries to whitelist and blacklist. If you do, a runtime
 exception will be thrown. 
 
+This change is purely UI based. We do not restrict users from signing in with their phone number.
+They will simply be unable to choose their country in the selector, but there may be another country
+sharing the same country code (e.g. US and CA are +1).
+
+
 #####
 
 ### Handling the sign-in response

auth/src/main/java/com/firebase/ui/auth/AuthUI.java

@@ -658,16 +658,24 @@ public PhoneBuilder setDefaultCountryIso(@NonNull String iso) {
              * https://en.wikipedia.org/wiki/ISO_3166-1
              * and e-164 codes here: https://en.wikipedia.org/wiki/List_of_country_calling_codes
              *
-             * @param whitelistedCountries a case insensitive list of country codes and/or
-             *                                     isos to be whitelisted
+             * @param whitelistedCountries a non empty case insensitive list of country codes
+             *                             and/or isos to be whitelisted
+             * @throws IllegalArgumentException if an empty whitelist is provided.
+             * @throws NullPointerException if a null whitelist is provided.
              */
             public PhoneBuilder setWhitelistedCountries(
                     @NonNull List<String> whitelistedCountries) {
                 if (getParams().containsKey(ExtraConstants.BLACKLISTED_COUNTRIES)) {
-                    throw new RuntimeException(
+                    throw new IllegalStateException(
                             "You can either whitelist or blacklist country codes for phone " +
                                     "authentication.");
                 }
+
+                String message = "Invalid argument: Only non-%s whitelists are valid. " +
+                        "To specify no whitelist, do not call this method.";
+                Preconditions.checkNotNull(whitelistedCountries, String.format(message, "null"));
+                Preconditions.checkArgument(!whitelistedCountries.isEmpty(), String.format(message, "empty"));
+
                 addCountriesToBundle(whitelistedCountries, ExtraConstants.WHITELISTED_COUNTRIES);
                 return this;
             }
@@ -685,16 +693,25 @@ public PhoneBuilder setWhitelistedCountries(
              * For a list of country iso or codes, see Alpha-2 codes here:
              * https://en.wikipedia.org/wiki/ISO_3166-1
              * and e-164 codes here: https://en.wikipedia.org/wiki/List_of_country_calling_codes
-             * @param blacklistedCountries a case insensitive list of country codes and/or isos
-             *                             to be blacklisted
+             *
+             * @param blacklistedCountries a non empty case insensitive list of country codes
+             *                             and/or isos to be blacklisted
+             * @throws IllegalArgumentException if an empty blacklist is provided.
+             * @throws NullPointerException if a null blacklist is provided.
              */
             public PhoneBuilder setBlacklistedCountries(
                     @NonNull List<String> blacklistedCountries) {
                 if (getParams().containsKey(ExtraConstants.WHITELISTED_COUNTRIES)) {
-                    throw new RuntimeException(
+                    throw new IllegalStateException(
                             "You can either whitelist or blacklist country codes for phone " +
                                     "authentication.");
                 }
+
+                String message = "Invalid argument: Only non-%s blacklists are valid. " +
+                        "To specify no blacklist, do not call this method.";
+                Preconditions.checkNotNull(blacklistedCountries, String.format(message, "null"));
+                Preconditions.checkArgument(!blacklistedCountries.isEmpty(), String.format(message, "empty"));
+
                 addCountriesToBundle(blacklistedCountries, ExtraConstants.BLACKLISTED_COUNTRIES);
                 return this;
             }
@@ -722,41 +739,70 @@ private void validateInputs() {
 
                 if (whitelistedCountries != null &&
                         blacklistedCountries != null) {
-                    throw new RuntimeException(
+                    throw new IllegalStateException(
                             "You can either whitelist or blacklist country codes for phone " +
                                     "authentication.");
                 } else if (whitelistedCountries != null) {
-                    validateCountries(whitelistedCountries);
-                    validateDefaultCountryIso(whitelistedCountries, true);
+                    validateInputs(whitelistedCountries, true);
 
                 } else if (blacklistedCountries != null) {
-                    validateCountries(blacklistedCountries);
-                    validateDefaultCountryIso(blacklistedCountries, false);
+                    validateInputs(blacklistedCountries, false);
                 }
             }
 
-            private void validateCountries(List<String> codes) {
+            private void validateInputs(List<String> countries, boolean whitelisted) {
+                validateCountryInput(countries);
+                validateDefaultCountryInput(countries, whitelisted);
+            }
+
+            private void validateCountryInput(List<String> codes) {
                 for (String code : codes) {
                     if (!PhoneNumberUtils.isValidIso(code) && !PhoneNumberUtils.isValid(code)) {
-                        throw new RuntimeException("Invalid input: You must provide a valid " +
-                                "country iso (alpha-2) or code (e-164). e.g. 'us' or '+1'.");
+                        throw new IllegalArgumentException("Invalid input: You must provide a " +
+                                "valid country iso (alpha-2) or code (e-164). e.g. 'us' or '+1'.");
                     }
                 }
             }
 
-            private void validateDefaultCountryIso(List<String> codes, boolean whitelisted) {
-                if (getParams().containsKey(ExtraConstants.COUNTRY_ISO) && codes != null) {
-                    String defaultIso = getParams().getString(ExtraConstants.COUNTRY_ISO);
-                    boolean containsIso = containsCountryIso(codes, defaultIso);
-                    if (!containsIso && whitelisted || containsIso && !whitelisted) {
-                        throw new RuntimeException("Invalid default country iso. Make sure it " +
-                                "is either part of the whitelisted list or that you " +
-                                "haven't blacklisted it.");
+            private void validateDefaultCountryInput(List<String> codes, boolean whitelisted) {
+                // A default iso/code can be set via #setDefaultCountryIso() or #setDefaultNumber()
+                if (getParams().containsKey(ExtraConstants.COUNTRY_ISO) ||
+                        getParams().containsKey(ExtraConstants.PHONE)) {
+
+                    if (!validateDefaultCountryIso(codes, whitelisted)
+                            || !validateDefaultPhoneIsos(codes, whitelisted)) {
+                        throw new IllegalArgumentException("Invalid default country iso. Make " +
+                                "sure it is either part of the whitelisted list or that you "
+                                + "haven't blacklisted it.");
                     }
                 }
+
+            }
+
+            private boolean validateDefaultCountryIso(List<String> codes, boolean whitelisted) {
+                String defaultIso = getDefaultIso();
+                return isValidDefaultIso(codes, defaultIso, whitelisted);
+            }
+
+            private boolean validateDefaultPhoneIsos(List<String> codes, boolean whitelisted) {
+                List<String> phoneIsos = getPhoneIsosFromCode();
+                for (String iso : phoneIsos) {
+                    if (isValidDefaultIso(codes, iso, whitelisted)) {
+                        return true;
+                    }
+                }
+                return phoneIsos.isEmpty();
+            }
+
+            private boolean isValidDefaultIso(List<String> codes, String iso, boolean whitelisted) {
+                if (iso == null) return true;
+                boolean containsIso = containsCountryIso(codes, iso);
+                return containsIso && whitelisted || !containsIso && !whitelisted;
+
             }
 
             private boolean containsCountryIso(List<String> codes, String iso) {
+                iso = iso.toUpperCase(Locale.getDefault());
                 for (String code : codes) {
                     if (PhoneNumberUtils.isValidIso(code)) {
                         if (code.equals(iso)) {
@@ -771,6 +817,26 @@ private boolean containsCountryIso(List<String> codes, String iso) {
                 }
                 return false;
             }
+
+            private List<String> getPhoneIsosFromCode() {
+                List<String> isos = new ArrayList<>();
+                String phone = getParams().getString(ExtraConstants.PHONE);
+                if (phone != null && phone.startsWith("+")) {
+                    String countryCode = "+" + PhoneNumberUtils.getPhoneNumber(phone)
+                            .getCountryCode();
+                    List<String> isosToAdd = PhoneNumberUtils.
+                            getCountryIsosFromCountryCode(countryCode);
+                    if (isosToAdd != null) {
+                        isos.addAll(isosToAdd);
+                    }
+                }
+                return isos;
+            }
+
+            private String getDefaultIso() {
+                return getParams().containsKey(ExtraConstants.COUNTRY_ISO) ?
+                        getParams().getString(ExtraConstants.COUNTRY_ISO) : null;
+            }
         }
 
         /**
@@ -933,8 +999,8 @@ public T setLogo(@DrawableRes int logo) {
         /**
          * Specifies the terms-of-service URL for the application.
          *
-         * @deprecated Please use {@link #setTosAndPrivacyPolicyUrls(String, String)}
-         * For the Tos link to be displayed a Privacy Policy url must also be provided.
+         * @deprecated Please use {@link #setTosAndPrivacyPolicyUrls(String, String)} For the Tos
+         * link to be displayed a Privacy Policy url must also be provided.
          */
         @NonNull
         @Deprecated
@@ -946,8 +1012,8 @@ public T setTosUrl(@Nullable String tosUrl) {
         /**
          * Specifies the privacy policy URL for the application.
          *
-         * @deprecated Please use {@link #setTosAndPrivacyPolicyUrls(String, String)}
-         * For the Privacy Policy link to be displayed a Tos url must also be provided.
+         * @deprecated Please use {@link #setTosAndPrivacyPolicyUrls(String, String)} For the
+         * Privacy Policy link to be displayed a Tos url must also be provided.
          */
         @NonNull
         @Deprecated