FIS getAuthToken implementation.

firebase-installations-interop/api.txt

@@ -5,15 +5,15 @@ package com.google.firebase.installations {
     ctor public InstallationTokenResult();
     method @NonNull public static com.google.firebase.installations.InstallationTokenResult.Builder builder();
     method @NonNull public abstract String getToken();
-    method @NonNull public abstract long getTokenExpirationTimestampMillis();
+    method @NonNull public abstract long getTokenExpirationInSecs();
     method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder toBuilder();
   }
 
   public abstract static class InstallationTokenResult.Builder {
     ctor public InstallationTokenResult.Builder();
     method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult build();
     method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder setToken(@NonNull String);
-    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder setTokenExpirationTimestampMillis(@NonNull long);
+    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder setTokenExpirationInSecs(@NonNull long);
   }
 
 }

firebase-installations/api.txt

@@ -3,7 +3,7 @@ package com.google.firebase.installations {
 
   public class FirebaseInstallations {
     method @NonNull public Task<Void> delete();
-    method @NonNull public Task<InstallationTokenResult> getAuthToken(boolean);
+    method @NonNull public Task<InstallationTokenResult> getAuthToken(int);
     method @NonNull public Task<String> getId();
     method @NonNull public static com.google.firebase.installations.FirebaseInstallations getInstance();
     method @NonNull public static com.google.firebase.installations.FirebaseInstallations getInstance(@NonNull FirebaseApp);

firebase-installations/src/androidTest/java/com/google/firebase/installations/FirebaseInstallationsInstrumentedTest.java

@@ -15,6 +15,7 @@
 package com.google.firebase.installations;
 
 import static com.google.common.truth.Truth.assertWithMessage;
+import static com.google.firebase.installations.FisAndroidTestConstants.TEST_API_KEY;
 import static com.google.firebase.installations.FisAndroidTestConstants.TEST_APP_ID_1;
 import static com.google.firebase.installations.FisAndroidTestConstants.TEST_AUTH_TOKEN;
 import static com.google.firebase.installations.FisAndroidTestConstants.TEST_AUTH_TOKEN_2;
@@ -30,12 +31,11 @@
 import static org.junit.Assert.fail;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-import android.util.Log;
-import androidx.annotation.NonNull;
 import androidx.test.core.app.ApplicationProvider;
 import androidx.test.runner.AndroidJUnit4;
 import com.google.android.gms.common.util.Clock;
@@ -61,6 +61,8 @@
 import org.junit.runners.MethodSorters;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
+import org.mockito.internal.stubbing.answers.AnswersWithDelay;
+import org.mockito.internal.stubbing.answers.Returns;
 
 /**
  * Instrumented test, which will execute on an Android device.
@@ -131,7 +133,7 @@ public void setUp() throws FirebaseInstallationServiceException {
             new FirebaseOptions.Builder()
                 .setApplicationId(TEST_APP_ID_1)
                 .setProjectId(TEST_PROJECT_ID)
-                .setApiKey("api_key")
+                .setApiKey(TEST_API_KEY)
                 .build());
     persistedFid = new PersistedFid(firebaseApp);
     when(backendClientReturnsOk.createFirebaseInstallation(
@@ -264,11 +266,12 @@ public void testGetId_PersistedFidError_BackendOk() throws InterruptedException
     // Expect exception
     try {
       Tasks.await(firebaseInstallations.getId());
-      fail();
+      fail("Could not update local storage.");
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
       assertWithMessage("Exception class doesn't match")
-          .that(cause)
+          .that(expected)
+          .hasCauseThat()
           .isInstanceOf(FirebaseInstallationsException.class);
       assertWithMessage("Exception status doesn't match")
           .that(((FirebaseInstallationsException) cause).getStatus())
@@ -305,11 +308,12 @@ public void testGetAuthToken_PersistedFidError_failure() throws Exception {
     try {
       Tasks.await(
           firebaseInstallations.getAuthToken(FirebaseInstallationsApi.DO_NOT_FORCE_REFRESH));
-      fail();
+      fail("Could not update local storage.");
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
       assertWithMessage("Exception class doesn't match")
-          .that(cause)
+          .that(expected)
+          .hasCauseThat()
           .isInstanceOf(FirebaseInstallationsException.class);
       assertWithMessage("Exception status doesn't match")
           .that(((FirebaseInstallationsException) cause).getStatus())
@@ -351,6 +355,9 @@ public void testGetAuthToken_expiredAuthToken_fetchedNewTokenFromFIS() throws Ex
 
   @Test
   public void testGetAuthToken_unregisteredFid_fetchedNewTokenFromFIS() throws Exception {
+    // Using mockPersistedFid to ensure the order of returning persistedFidEntry. This test
+    // validates that getAuthToken calls getId to ensure FID registration and returns a valid auth
+    // token.
     when(mockPersistedFid.readPersistedFidEntryValue())
         .thenReturn(UNREGISTERED_FID_ENTRY, REGISTERED_FID_ENTRY);
     FirebaseInstallations firebaseInstallations =
@@ -386,11 +393,12 @@ public void testGetAuthToken_serverError_failure() throws Exception {
     // Expect exception
     try {
       Tasks.await(firebaseInstallations.getAuthToken(FirebaseInstallationsApi.FORCE_REFRESH));
-      fail();
+      fail("getAuthToken() failed due to Server Error.");
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
       assertWithMessage("Exception class doesn't match")
-          .that(cause)
+          .that(expected)
+          .hasCauseThat()
           .isInstanceOf(FirebaseInstallationsException.class);
       assertWithMessage("Exception status doesn't match")
           .that(((FirebaseInstallationsException) cause).getStatus())
@@ -399,7 +407,11 @@ public void testGetAuthToken_serverError_failure() throws Exception {
   }
 
   @Test
-  public void testGetAuthToken_multipleCalls_fetchedNewTokenOnce() throws Exception {
+  public void testGetAuthToken_multipleCallsDoNotForceRefresh_fetchedNewTokenOnce()
+      throws Exception {
+    // Using mockPersistedFid to ensure the order of returning persistedFidEntry  to 2 tasks
+    // triggered simultaneously. Task2 waits for Task1 to complete.On Task1 completion, task2 reads
+    // the UPDATED_AUTH_TOKEN_FID_ENTRY by Task1 on execution.
     when(mockPersistedFid.readPersistedFidEntryValue())
         .thenReturn(
             EXPIRED_AUTH_TOKEN_ENTRY,
@@ -425,67 +437,54 @@ public void testGetAuthToken_multipleCalls_fetchedNewTokenOnce() throws Exceptio
         .that(task2.getResult().getToken())
         .isEqualTo(TEST_AUTH_TOKEN_2);
     verify(backendClientReturnsOk, times(1))
-        .generateAuthToken(anyString(), anyString(), anyString(), anyString());
+        .generateAuthToken(TEST_API_KEY, TEST_FID_1, TEST_PROJECT_ID, TEST_REFRESH_TOKEN);
   }
 
   @Test
   public void testGetAuthToken_multipleCallsForceRefresh_fetchedNewTokenTwice() throws Exception {
     when(mockPersistedFid.readPersistedFidEntryValue()).thenReturn(REGISTERED_FID_ENTRY);
-    // Use a custom ServiceClient to mock the network calls ensuring task1 is not completed
-    // before task2. Hence, we can test multiple calls to getAUthToken() and verify task2 waits for
-    // task1 to complete.
-    ServiceClient serviceClient = new ServiceClient();
+    // Use a mock ServiceClient for network calls with delay(1000ms) to ensure first task is not
+    // completed before the second task starts. Hence, we can test multiple calls to getAUthToken()
+    // and verify one task waits for another task to complete.
+
+    doAnswer(
+            new AnswersWithDelay(
+                1000,
+                new Returns(
+                    InstallationTokenResult.builder()
+                        .setToken(TEST_AUTH_TOKEN_3)
+                        .setTokenExpirationInSecs(TEST_TOKEN_EXPIRATION_TIMESTAMP)
+                        .build())))
+        .doAnswer(
+            new AnswersWithDelay(
+                1000,
+                new Returns(
+                    InstallationTokenResult.builder()
+                        .setToken(TEST_AUTH_TOKEN_4)
+                        .setTokenExpirationInSecs(TEST_TOKEN_EXPIRATION_TIMESTAMP)
+                        .build())))
+        .when(backendClientReturnsOk)
+        .generateAuthToken(anyString(), anyString(), anyString(), anyString());
+
     FirebaseInstallations firebaseInstallations =
         new FirebaseInstallations(
-            mockClock, executor, firebaseApp, serviceClient, mockPersistedFid, mockUtils);
+            mockClock, executor, firebaseApp, backendClientReturnsOk, mockPersistedFid, mockUtils);
 
-    // Call getAuthToken multiple times with FORCE_REFRESH option. Also, sleep for 500ms in between
-    // the calls to ensure tasks are called in order.
+    // Call getAuthToken multiple times with FORCE_REFRESH option.
     Task<InstallationTokenResult> task1 =
         firebaseInstallations.getAuthToken(FirebaseInstallationsApi.FORCE_REFRESH);
-    Thread.sleep(500);
     Task<InstallationTokenResult> task2 =
         firebaseInstallations.getAuthToken(FirebaseInstallationsApi.FORCE_REFRESH);
     Tasks.await(Tasks.whenAllComplete(task1, task2));
 
+    // As we cannot ensure which task got executed first, verifying with both expected values
     assertWithMessage("Persisted Auth Token doesn't match")
         .that(task1.getResult().getToken())
-        .isEqualTo(TEST_AUTH_TOKEN_3);
+        .isAnyOf(TEST_AUTH_TOKEN_3, TEST_AUTH_TOKEN_4);
     assertWithMessage("Persisted Auth Token doesn't match")
         .that(task2.getResult().getToken())
-        .isEqualTo(TEST_AUTH_TOKEN_4);
-  }
-
-  class ServiceClient extends FirebaseInstallationServiceClient {
-
-    private boolean secondCall;
-
-    @Override
-    @NonNull
-    public InstallationTokenResult generateAuthToken(
-        @NonNull String apiKey,
-        @NonNull String fid,
-        @NonNull String projectID,
-        @NonNull String refreshToken)
-        throws FirebaseInstallationServiceException {
-      try {
-        Thread.sleep(2000);
-      } catch (InterruptedException e) {
-        Log.e("InterruptedException", e.getMessage());
-      }
-
-      if (!secondCall) {
-        secondCall = true;
-        return InstallationTokenResult.builder()
-            .setToken(TEST_AUTH_TOKEN_3)
-            .setTokenExpirationInSecs(TEST_TOKEN_EXPIRATION_TIMESTAMP)
-            .build();
-      }
-
-      return InstallationTokenResult.builder()
-          .setToken(TEST_AUTH_TOKEN_4)
-          .setTokenExpirationInSecs(TEST_TOKEN_EXPIRATION_TIMESTAMP)
-          .build();
-    }
+        .isAnyOf(TEST_AUTH_TOKEN_4, TEST_AUTH_TOKEN_3);
+    verify(backendClientReturnsOk, times(2))
+        .generateAuthToken(TEST_API_KEY, TEST_FID_1, TEST_PROJECT_ID, TEST_REFRESH_TOKEN);
   }
 }

firebase-installations/src/androidTest/java/com/google/firebase/installations/FisAndroidTestConstants.java

@@ -24,6 +24,8 @@ public final class FisAndroidTestConstants {
   public static final String TEST_AUTH_TOKEN_3 = "fis.auth.token3";
   public static final String TEST_AUTH_TOKEN_4 = "fis.auth.token4";
 
+  public static final String TEST_API_KEY = "apiKey";
+
   public static final String TEST_REFRESH_TOKEN = "1:test-refresh-token";
 
   public static final String TEST_APP_ID_1 = "1:123456789:android:abcdef";

firebase-installations/src/main/java/com/google/firebase/installations/AwaitListener.java

@@ -21,18 +21,18 @@
 import java.util.concurrent.TimeUnit;
 
 final class AwaitListener implements OnCompleteListener<Void> {
-  private final CountDownLatch mLatch = new CountDownLatch(1);
+  private final CountDownLatch latch = new CountDownLatch(1);
 
   public void onSuccess() {
-    mLatch.countDown();
+    latch.countDown();
   }
 
   public boolean await(long timeout, TimeUnit unit) throws InterruptedException {
-    return mLatch.await(timeout, unit);
+    return latch.await(timeout, unit);
   }
 
   @Override
   public void onComplete(@NonNull Task<Void> task) {
-    mLatch.countDown();
+    latch.countDown();
   }
 }

firebase-installations/src/main/java/com/google/firebase/installations/FirebaseInstallations.java

@@ -55,6 +55,7 @@ public class FirebaseInstallations implements FirebaseInstallationsApi {
   private final Utils utils;
 
   private static final long AUTH_TOKEN_EXPIRATION_BUFFER_IN_SECS = 3600L; // 1 hour
+  private static final long AWAIT_TIMEOUT_IN_SECS = 10L;
 
   /** package private constructor. */
   FirebaseInstallations(FirebaseApp firebaseApp) {
@@ -205,7 +206,7 @@ private static <F, T> Continuation<F, T> awaitFidRegistration(
       @NonNull Supplier<T> supplier, AwaitListener listener) {
     return t -> {
       // Waiting for Task that registers FID on the FIS Servers
-      listener.await(10, TimeUnit.SECONDS);
+      listener.await(AWAIT_TIMEOUT_IN_SECS, TimeUnit.SECONDS);
       return supplier.get();
     };
   }