Implementing Phone Auth Support (#60)

* Implementing phone auth support in the user management API

* Updated error message

* Updated javadoc comment

* Simplifying the phone number format check; Annotating nullable args in UpdateRequest

Author: hiranya911

src/main/java/com/google/firebase/auth/FirebaseAuth.java

@@ -243,6 +243,26 @@ public UserRecord then(Task<GetTokenResult> task) throws Exception {
         });
   }
 
+  /**
+   * Gets the user data corresponding to the specified user phone number.
+   *
+   * @param phoneNumber A user phone number string.
+   * @return A {@link Task} which will complete successfully with a {@link UserRecord} instance.
+   *     If an error occurs while retrieving user data or if the phone number does not
+   *     correspond to a user, the task fails with a FirebaseAuthException.
+   * @throws IllegalArgumentException If the phone number is null or empty.
+   */
+  public Task<UserRecord> getUserByPhoneNumber(final String phoneNumber) {
+    checkArgument(!Strings.isNullOrEmpty(phoneNumber), "phone number must not be null or empty");
+    return ImplFirebaseTrampolines.getToken(firebaseApp, false).continueWith(
+        new Continuation<GetTokenResult, UserRecord>() {
+          @Override
+          public UserRecord then(Task<GetTokenResult> task) throws Exception {
+            return userManager.getUserByPhoneNumber(phoneNumber, task.getResult().getToken());
+          }
+        });
+  }
+
   /**
    * Creates a new user account with the attributes contained in the specified
    * {@link CreateRequest}.

src/main/java/com/google/firebase/auth/FirebaseUserManager.java

@@ -119,6 +119,24 @@ UserRecord getUserByEmail(String email, String token) throws FirebaseAuthExcepti
     return new UserRecord(response.getUsers().get(0));
   }
 
+  UserRecord getUserByPhoneNumber(String phoneNumber, String token) throws FirebaseAuthException {
+    final Map<String, Object> payload = ImmutableMap.<String, Object>of(
+        "phoneNumber", ImmutableList.of(phoneNumber));
+    GetAccountInfoResponse response;
+    try {
+      response = post("getAccountInfo", token, payload, GetAccountInfoResponse.class);
+    } catch (IOException e) {
+      throw new FirebaseAuthException(INTERNAL_ERROR,
+          "IO error while retrieving user with phone number: " + phoneNumber, e);
+    }
+
+    if (response == null || response.getUsers() == null || response.getUsers().isEmpty()) {
+      throw new FirebaseAuthException(USER_NOT_FOUND_ERROR,
+          "No user record found for the provided phone number: " + phoneNumber);
+    }
+    return new UserRecord(response.getUsers().get(0));
+  }
+
   String createUser(CreateRequest request, String token) throws FirebaseAuthException {
     GenericJson response;
     try {

src/main/java/com/google/firebase/auth/ProviderUserInfo.java

@@ -28,13 +28,15 @@ class ProviderUserInfo implements UserInfo {
   private final String uid;
   private final String displayName;
   private final String email;
+  private final String phoneNumber;
   private final String photoUrl;
   private final String providerId;
 
   ProviderUserInfo(GetAccountInfoResponse.Provider response) {
     this.uid = response.getUid();
     this.displayName = response.getDisplayName();
     this.email = response.getEmail();
+    this.phoneNumber = response.getPhoneNumber();
     this.photoUrl = response.getPhotoUrl();
     this.providerId = response.getProviderId();
   }
@@ -56,6 +58,12 @@ public String getEmail() {
     return email;
   }
 
+  @Nullable
+  @Override
+  public String getPhoneNumber() {
+    return phoneNumber;
+  }
+
   @Nullable
   @Override
   public String getPhotoUrl() {

src/main/java/com/google/firebase/auth/UserInfo.java

@@ -47,6 +47,14 @@ public interface UserInfo {
   @Nullable
   String getEmail();
 
+  /**
+   * Returns the user's phone number, if available.
+   *
+   * @return a phone number string or null.
+   */
+  @Nullable
+  String getPhoneNumber();
+
   /**
    * Returns the user's photo URL, if available.
    *

src/main/java/com/google/firebase/auth/UserRecord.java

@@ -18,6 +18,7 @@
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
+import static com.google.common.base.Preconditions.checkState;
 
 import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableList;
@@ -45,6 +46,7 @@ public class UserRecord implements UserInfo {
 
   private final String uid;
   private final String email;
+  private final String phoneNumber;
   private final boolean emailVerified;
   private final String displayName;
   private final String photoUrl;
@@ -57,6 +59,7 @@ public class UserRecord implements UserInfo {
     checkArgument(!Strings.isNullOrEmpty(response.getUid()), "uid must not be null or empty");
     this.uid = response.getUid();
     this.email = response.getEmail();
+    this.phoneNumber = response.getPhoneNumber();
     this.emailVerified = response.isEmailVerified();
     this.displayName = response.getDisplayName();
     this.photoUrl = response.getPhotoUrl();
@@ -103,6 +106,17 @@ public String getEmail() {
     return email;
   }
 
+  /**
+   * Returns the phone number associated with this user.
+   *
+   * @return a phone number string or null.
+   */
+  @Nullable
+  @Override
+  public String getPhoneNumber() {
+    return phoneNumber;
+  }
+
   /**
    * Returns whether the email address of this user has been verified.
    *
@@ -177,6 +191,14 @@ private static void checkEmail(String email) {
     checkArgument(email.matches("^[^@]+@[^@]+$"));
   }
 
+  private static void checkPhoneNumber(String phoneNumber) {
+    // Phone number verification is very lax here. Backend will enforce E.164 spec compliance, and
+    // normalize accordingly.
+    checkArgument(!Strings.isNullOrEmpty(phoneNumber), "phone number cannot be null or empty");
+    checkState(phoneNumber.startsWith("+"),
+        "phone number must be a valid, E.164 compliant identifier starting with a '+' sign");
+  }
+
   private static void checkPassword(String password) {
     checkArgument(!Strings.isNullOrEmpty(password), "password cannot be null or empty");
     checkArgument(password.length() >= 6, "password must be at least 6 characters long");
@@ -223,6 +245,17 @@ public CreateRequest setEmail(String email) {
       return this;
     }
 
+    /**
+     * Sets a phone number for the new user.
+     *
+     * @param phone a non-null, non-empty phone number string.
+     */
+    public CreateRequest setPhoneNumber(String phone) {
+      checkPhoneNumber(phone);
+      properties.put("phoneNumber", phone);
+      return this;
+    }
+
     /**
      * Sets whether the user email address has been verified or not.
      *
@@ -323,6 +356,20 @@ public UpdateRequest setEmail(String email) {
       return this;
     }
 
+    /**
+     * Updates the phone number associated with this user. Calling this method with a null argument
+     * removes the phone number from the user account.
+     *
+     * @param phone a valid phone number string or null.
+     */
+    public UpdateRequest setPhoneNumber(@Nullable String phone) {
+      if (phone != null) {
+        checkPhoneNumber(phone);
+      }
+      properties.put("phoneNumber", phone);
+      return this;
+    }
+
     /**
      * Updates the email verification status of this account.
      *
@@ -339,7 +386,7 @@ public UpdateRequest setEmailVerified(boolean emailVerified) {
      *
      * @param displayName a display name string or null
      */
-    public UpdateRequest setDisplayName(String displayName) {
+    public UpdateRequest setDisplayName(@Nullable String displayName) {
       properties.put("displayName", displayName);
       return this;
     }
@@ -350,7 +397,7 @@ public UpdateRequest setDisplayName(String displayName) {
      *
      * @param photoUrl a valid URL string or null
      */
-    public UpdateRequest setPhotoUrl(String photoUrl) {
+    public UpdateRequest setPhotoUrl(@Nullable String photoUrl) {
       if (photoUrl != null) {
         try {
           new URL(photoUrl);
@@ -396,6 +443,11 @@ Map<String, Object> getProperties() {
       if (!remove.isEmpty()) {
         copy.put("deleteAttribute", ImmutableList.copyOf(remove));
       }
+
+      if (copy.containsKey("phoneNumber") && copy.get("phoneNumber") == null) {
+        copy.put("deleteProvider", ImmutableList.of("phone"));
+        copy.remove("phoneNumber");
+      }
       return ImmutableMap.copyOf(copy);
     }
   }

src/main/java/com/google/firebase/auth/internal/GetAccountInfoResponse.java

@@ -49,6 +49,9 @@ public static final class User {
     @Key("email")
     private String email;
 
+    @Key("phoneNumber")
+    private String phoneNumber;
+
     @Key("emailVerified")
     private boolean emailVerified;
 
@@ -78,6 +81,10 @@ public String getEmail() {
       return email;
     }
 
+    public String getPhoneNumber() {
+      return phoneNumber;
+    }
+
     public boolean isEmailVerified() {
       return emailVerified;
     }
@@ -121,6 +128,9 @@ public static final class Provider {
     @Key("email")
     private String email;
 
+    @Key("phoneNumber")
+    private String phoneNumber;
+
     @Key("photoUrl")
     private String photoUrl;
 
@@ -139,6 +149,10 @@ public String getEmail() {
       return email;
     }
 
+    public String getPhoneNumber() {
+      return phoneNumber;
+    }
+
     public String getPhotoUrl() {
       return photoUrl;
     }

src/test/java/com/google/firebase/auth/FirebaseAuthIT.java

@@ -38,7 +38,10 @@
 import com.google.firebase.tasks.Tasks;
 import com.google.firebase.testing.IntegrationTestUtils;
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
+import java.util.Random;
 import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 import org.junit.BeforeClass;
@@ -107,14 +110,25 @@ public void testDeleteNonExistingUser() throws Exception {
     }
   }
 
+  private String randomPhoneNumber() {
+    Random random = new Random();
+    StringBuilder builder = new StringBuilder("+1");
+    for (int i = 0; i < 10; i++) {
+      builder.append(random.nextInt(10));
+    }
+    return builder.toString();
+  }
+
   @Test
   public void testCreateUserWithParams() throws Exception {
     String randomId = UUID.randomUUID().toString().replaceAll("-", "");
     String userEmail = ("test" + randomId.substring(0, 12) + "@example." + randomId.substring(12)
         + ".com").toLowerCase();
+    String phone = randomPhoneNumber();
     CreateRequest user = new CreateRequest()
         .setUid(randomId)
         .setEmail(userEmail)
+        .setPhoneNumber(phone)
         .setDisplayName("Random User")
         .setPhotoUrl("https://example.com/photo.png")
         .setEmailVerified(true)
@@ -125,10 +139,19 @@ public void testCreateUserWithParams() throws Exception {
       assertEquals(randomId, userRecord.getUid());
       assertEquals("Random User", userRecord.getDisplayName());
       assertEquals(userEmail, userRecord.getEmail());
+      assertEquals(phone, userRecord.getPhoneNumber());
       assertEquals("https://example.com/photo.png", userRecord.getPhotoUrl());
       assertTrue(userRecord.isEmailVerified());
       assertFalse(userRecord.isDisabled());
 
+      assertEquals(2, userRecord.getProviderData().length);
+      List<String> providers = new ArrayList<>();
+      for (UserInfo provider : userRecord.getProviderData()) {
+        providers.add(provider.getProviderId());
+      }
+      assertTrue(providers.contains("password"));
+      assertTrue(providers.contains("phone"));
+
       checkRecreate(randomId);
     } finally {
       Tasks.await(auth.deleteUser(userRecord.getUid()));
@@ -157,29 +180,35 @@ public void testUserLifecycle() throws Exception {
     assertEquals(uid, userRecord.getUid());
     assertNull(userRecord.getDisplayName());
     assertNull(userRecord.getEmail());
+    assertNull(userRecord.getPhoneNumber());
     assertNull(userRecord.getPhotoUrl());
     assertFalse(userRecord.isEmailVerified());
     assertFalse(userRecord.isDisabled());
     assertTrue(userRecord.getUserMetadata().getCreationTimestamp() > 0);
     assertEquals(0, userRecord.getUserMetadata().getLastSignInTimestamp());
+    assertEquals(0, userRecord.getProviderData().length);
 
     // Update user
     String randomId = UUID.randomUUID().toString().replaceAll("-", "");
     String userEmail = ("test" + randomId.substring(0, 12) + "@example." + randomId.substring(12)
         + ".com").toLowerCase();
+    String phone = randomPhoneNumber();
     UpdateRequest request = userRecord.updateRequest()
         .setDisplayName("Updated Name")
         .setEmail(userEmail)
+        .setPhoneNumber(phone)
         .setPhotoUrl("https://example.com/photo.png")
         .setEmailVerified(true)
         .setPassword("secret");
     userRecord = Tasks.await(auth.updateUser(request));
     assertEquals(uid, userRecord.getUid());
     assertEquals("Updated Name", userRecord.getDisplayName());
     assertEquals(userEmail, userRecord.getEmail());
+    assertEquals(phone, userRecord.getPhoneNumber());
     assertEquals("https://example.com/photo.png", userRecord.getPhotoUrl());
     assertTrue(userRecord.isEmailVerified());
     assertFalse(userRecord.isDisabled());
+    assertEquals(2, userRecord.getProviderData().length);
 
     // Get user by email
     userRecord = Tasks.await(auth.getUserByEmail(userRecord.getEmail()));
@@ -189,14 +218,17 @@ public void testUserLifecycle() throws Exception {
     request = userRecord.updateRequest()
         .setPhotoUrl(null)
         .setDisplayName(null)
+        .setPhoneNumber(null)
         .setDisabled(true);
     userRecord = Tasks.await(auth.updateUser(request));
     assertEquals(uid, userRecord.getUid());
     assertNull(userRecord.getDisplayName());
     assertEquals(userEmail, userRecord.getEmail());
+    assertNull(userRecord.getPhoneNumber());
     assertNull(userRecord.getPhotoUrl());
     assertTrue(userRecord.isEmailVerified());
     assertTrue(userRecord.isDisabled());
+    assertEquals(1, userRecord.getProviderData().length);
 
     // Delete user
     Tasks.await(auth.deleteUser(userRecord.getUid()));