Merge branch 'master' of github.com:firebase/firebase-android-sdk into nullFixFis

Author: ankitaj224

firebase-common/api.txt

@@ -2,8 +2,10 @@
 package com.google.firebase {
 
   public class FirebaseApp {
+    method public void enableEmulators(@NonNull com.google.firebase.emulators.EmulatorSettings);
     method @NonNull public android.content.Context getApplicationContext();
     method @NonNull public static java.util.List<com.google.firebase.FirebaseApp> getApps(@NonNull android.content.Context);
+    method @NonNull public com.google.firebase.emulators.EmulatorSettings getEmulatorSettings();
     method @NonNull public static com.google.firebase.FirebaseApp getInstance();
     method @NonNull public static com.google.firebase.FirebaseApp getInstance(@NonNull String);
     method @NonNull public String getName();
@@ -47,6 +49,30 @@ package com.google.firebase {
 
 }
 
+package com.google.firebase.emulators {
+
+  public final class EmulatedServiceSettings {
+    ctor public EmulatedServiceSettings(@NonNull String, int);
+    method @NonNull public String getHost();
+    method public int getPort();
+  }
+
+  public final class EmulatorSettings {
+    field public static final com.google.firebase.emulators.EmulatorSettings DEFAULT;
+  }
+
+  public static final class EmulatorSettings.Builder {
+    ctor public EmulatorSettings.Builder();
+    method @NonNull public com.google.firebase.emulators.EmulatorSettings.Builder addEmulatedService(@NonNull com.google.firebase.emulators.FirebaseEmulator, @NonNull com.google.firebase.emulators.EmulatedServiceSettings);
+    method @NonNull public com.google.firebase.emulators.EmulatorSettings build();
+  }
+
+  public final class FirebaseEmulator {
+    method @NonNull public String getName();
+  }
+
+}
+
 package com.google.firebase.provider {
 
   public class FirebaseInitProvider extends android.content.ContentProvider {

firebase-common/gradle.properties

@@ -1,3 +1,3 @@
-version=19.3.1
+version=19.4.0
 latestReleasedVersion=19.3.0
 android.enableUnitTestBinaryResources=true

firebase-common/src/main/java/com/google/firebase/FirebaseApp.java

@@ -149,9 +149,8 @@ public FirebaseOptions getOptions() {
   /**
    * Returns the specified {@link EmulatorSettings} or a default.
    *
-   * <p>TODO(samstern): Un-hide this once Firestore, Database, and Functions are implemented
-   *
-   * @hide
+   * <p>Calling this method "freezes" the emulator settings and future calls to enableEmulators on
+   * the same FirebaseApp instance will fail.
    */
   @NonNull
   public EmulatorSettings getEmulatorSettings() {
@@ -330,10 +329,7 @@ public static FirebaseApp initializeApp(
    * com.google.firebase.emulators.EmulatedServiceSettings} for {@link FirebaseDatabase#EMULATOR},
    * then calls to Cloud Firestore will communicate with the emulator rather than production.
    *
-   * <p>TODO(samstern): Un-hide this once Firestore, Database, and Functions are implemented
-   *
    * @param emulatorSettings the emulator settings for all services.
-   * @hide
    */
   public void enableEmulators(@NonNull EmulatorSettings emulatorSettings) {
     checkNotDeleted();

firebase-common/src/main/java/com/google/firebase/emulators/EmulatedServiceSettings.java

@@ -19,10 +19,7 @@
 /**
  * Settings to connect a single Firebase service to a local emulator.
  *
- * <p>TODO(samstern): Un-hide this once Firestore, Database, and Functions are implemented
- *
  * @see EmulatorSettings
- * @hide
  */
 public final class EmulatedServiceSettings {
 
@@ -34,6 +31,7 @@ public EmulatedServiceSettings(@NonNull String host, int port) {
     this.port = port;
   }
 
+  @NonNull
   public String getHost() {
     return host;
   }

firebase-common/src/main/java/com/google/firebase/emulators/EmulatorSettings.java

@@ -25,10 +25,7 @@
  * Settings that control which Firebase services should access a local emulator, rather than
  * production.
  *
- * <p>TODO(samstern): Un-hide this once Firestore, Database, and Functions are implemented
- *
  * @see com.google.firebase.FirebaseApp#enableEmulators(EmulatorSettings)
- * @hide
  */
 public final class EmulatorSettings {
 

firebase-common/src/main/java/com/google/firebase/emulators/FirebaseEmulator.java

@@ -19,12 +19,9 @@
 /**
  * Identifier Firebase services that can be emulated using the Firebase Emulator Suite.
  *
- * <p>TODO(samstern): Un-hide this once Firestore, Database, and Functions are implemented
- *
  * @see com.google.firebase.FirebaseApp#enableEmulators(EmulatorSettings)
  * @see EmulatorSettings
  * @see EmulatedServiceSettings
- * @hide
  */
 public final class FirebaseEmulator {
 
@@ -36,14 +33,15 @@ public final class FirebaseEmulator {
    * @hide
    */
   @NonNull
-  public static FirebaseEmulator forName(String name) {
+  public static FirebaseEmulator forName(@NonNull String name) {
     return new FirebaseEmulator(name);
   }
 
-  private FirebaseEmulator(String name) {
+  private FirebaseEmulator(@NonNull String name) {
     this.name = name;
   }
 
+  @NonNull
   public String getName() {
     return name;
   }

firebase-config/ktx/src/test/kotlin/com/google/firebase/remoteconfig/ktx/RemoteConfigTests.kt

@@ -39,8 +39,8 @@ import org.robolectric.RuntimeEnvironment
 import org.mockito.Mockito.mock
 import org.mockito.Mockito.`when`
 
-const val APP_ID = "APP_ID"
-const val API_KEY = "API_KEY"
+const val APP_ID = "1:14368190084:android:09cb977358c6f241"
+const val API_KEY = "AIzaSyabcdefghijklmnopqrstuvwxyz1234567"
 
 const val EXISTING_APP = "existing"
 

firebase-config/src/androidTest/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigIntegrationTest.java

@@ -50,8 +50,9 @@
 
 @RunWith(AndroidJUnit4.class)
 public class FirebaseRemoteConfigIntegrationTest {
-  private static final String API_KEY = "api_key";
+  private static final String API_KEY = "AIzaSyabcdefghijklmnopqrstuvwxyz1234567";
   private static final String APP_ID = "1:14368190084:android:09cb977358c6f241";
+  private static final String PROJECT_ID = "fake-frc-test-id";
 
   @Mock private ConfigCacheClient mockFetchedCache;
   @Mock private ConfigCacheClient mockActivatedCache;
@@ -84,7 +85,11 @@ public void setUp() {
     FirebaseApp firebaseApp =
         FirebaseApp.initializeApp(
             context,
-            new FirebaseOptions.Builder().setApiKey(API_KEY).setApplicationId(APP_ID).build());
+            new FirebaseOptions.Builder()
+                .setApiKey(API_KEY)
+                .setApplicationId(APP_ID)
+                .setProjectId(PROJECT_ID)
+                .build());
 
     // Catch all to avoid NPEs (the getters should never return null).
     when(mockFetchedCache.get()).thenReturn(Tasks.forResult(null));

firebase-config/src/main/java/com/google/firebase/remoteconfig/RemoteConfigConstants.java

@@ -31,6 +31,10 @@ public final class RemoteConfigConstants {
   /**
    * Keys of fields in the Fetch request body that the client sends to the Firebase Remote Config
    * server.
+   *
+   * <p>{@code INSTANCE_ID} and {@code INSTANCE_ID_TOKEN} are legacy names for the fields that used
+   * to be populated by the IID SDK. The fields have been replaced by the installation ID and
+   * installation auth token, respectively, which are fetched from the FIS SDK.
    */
   @StringDef({
     RequestFieldKey.INSTANCE_ID,

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigFetchHttpClient.java

@@ -78,6 +78,8 @@ public class ConfigFetchHttpClient {
   private static final String X_ANDROID_PACKAGE_HEADER = "X-Android-Package";
   private static final String X_ANDROID_CERT_HEADER = "X-Android-Cert";
   private static final String X_GOOGLE_GFE_CAN_RETRY = "X-Google-GFE-Can-Retry";
+  private static final String INSTALLATIONS_AUTH_TOKEN_HEADER =
+      "X-Goog-Firebase-Installations-Auth";
 
   private final Context context;
   private final String appId;
@@ -149,9 +151,9 @@ HttpURLConnection createHttpURLConnection() throws FirebaseRemoteConfigException
    *
    * @param urlConnection a {@link HttpURLConnection} created by a call to {@link
    *     #createHttpURLConnection}.
-   * @param instanceId the Firebase Instance ID that identifies a Firebase App Instance.
-   * @param instanceIdToken a valid Firebase Instance ID Token that authenticates a Firebase App
-   *     Instance.
+   * @param installationId the Firebase installation ID that identifies a Firebase App Instance.
+   * @param installationAuthToken a valid Firebase installation auth token that authenticates a
+   *     Firebase App Instance.
    * @param analyticsUserProperties a map of Google Analytics User Properties and the device's
    *     corresponding values.
    * @param lastFetchETag the ETag returned by the last successful fetch call to the FRC server. The
@@ -164,20 +166,20 @@ HttpURLConnection createHttpURLConnection() throws FirebaseRemoteConfigException
   @Keep
   FetchResponse fetch(
       HttpURLConnection urlConnection,
-      String instanceId,
-      String instanceIdToken,
+      String installationId,
+      String installationAuthToken,
       Map<String, String> analyticsUserProperties,
       String lastFetchETag,
       Map<String, String> customHeaders,
       Date currentTime)
       throws FirebaseRemoteConfigException {
-    setUpUrlConnection(urlConnection, lastFetchETag, customHeaders);
+    setUpUrlConnection(urlConnection, lastFetchETag, installationAuthToken, customHeaders);
 
     String fetchResponseETag;
     JSONObject fetchResponse;
     try {
       byte[] requestBody =
-          createFetchRequestBody(instanceId, instanceIdToken, analyticsUserProperties)
+          createFetchRequestBody(installationId, installationAuthToken, analyticsUserProperties)
               .toString()
               .getBytes("utf-8");
       setFetchRequestBody(urlConnection, requestBody);
@@ -212,7 +214,10 @@ FetchResponse fetch(
   }
 
   private void setUpUrlConnection(
-      HttpURLConnection urlConnection, String lastFetchEtag, Map<String, String> customHeaders) {
+      HttpURLConnection urlConnection,
+      String lastFetchEtag,
+      String installationAuthToken,
+      Map<String, String> customHeaders) {
     urlConnection.setDoOutput(true);
     urlConnection.setConnectTimeout((int) SECONDS.toMillis(connectTimeoutInSeconds));
     urlConnection.setReadTimeout((int) SECONDS.toMillis(readTimeoutInSeconds));
@@ -221,15 +226,16 @@ private void setUpUrlConnection(
     // change in the Fetch Response since the last fetch call.
     urlConnection.setRequestProperty(IF_NONE_MATCH_HEADER, lastFetchEtag);
 
-    setCommonRequestHeaders(urlConnection);
+    setCommonRequestHeaders(urlConnection, installationAuthToken);
     setCustomRequestHeaders(urlConnection, customHeaders);
   }
 
   private String getFetchUrl(String projectNumber, String namespace) {
     return String.format(FETCH_REGEX_URL, projectNumber, namespace);
   }
 
-  private void setCommonRequestHeaders(HttpURLConnection urlConnection) {
+  private void setCommonRequestHeaders(
+      HttpURLConnection urlConnection, String installationAuthToken) {
     urlConnection.setRequestProperty(API_KEY_HEADER, apiKey);
 
     // Headers required for Android API Key Restrictions.
@@ -239,6 +245,9 @@ private void setCommonRequestHeaders(HttpURLConnection urlConnection) {
     // Header to denote request is retryable on the server.
     urlConnection.setRequestProperty(X_GOOGLE_GFE_CAN_RETRY, "yes");
 
+    // Header for FIS auth token
+    urlConnection.setRequestProperty(INSTALLATIONS_AUTH_TOKEN_HEADER, installationAuthToken);
+
     // Headers to denote that the request body is a JSONObject.
     urlConnection.setRequestProperty("Content-Type", "application/json");
     urlConnection.setRequestProperty("Accept", "application/json");
@@ -278,16 +287,19 @@ private String getFingerprintHashForPackage() {
    * serialized as a JSON.
    */
   private JSONObject createFetchRequestBody(
-      String instanceId, String instanceIdToken, Map<String, String> analyticsUserProperties)
+      String installationId,
+      String installationAuthToken,
+      Map<String, String> analyticsUserProperties)
       throws FirebaseRemoteConfigClientException {
     Map<String, Object> requestBodyMap = new HashMap<>();
 
-    if (instanceId == null) {
-      throw new FirebaseRemoteConfigClientException("Fetch failed: Firebase instance id is null.");
+    if (installationId == null) {
+      throw new FirebaseRemoteConfigClientException(
+          "Fetch failed: Firebase installation id is null.");
     }
-    requestBodyMap.put(INSTANCE_ID, instanceId);
+    requestBodyMap.put(INSTANCE_ID, installationId);
 
-    requestBodyMap.put(INSTANCE_ID_TOKEN, instanceIdToken);
+    requestBodyMap.put(INSTANCE_ID_TOKEN, installationAuthToken);
     requestBodyMap.put(APP_ID, appId);
 
     Locale locale = context.getResources().getConfiguration().locale;

firebase-config/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java

@@ -84,7 +84,8 @@
     shadows = {ShadowPreconditions.class})
 public final class FirebaseRemoteConfigTest {
   private static final String APP_ID = "1:14368190084:android:09cb977358c6f241";
-  private static final String API_KEY = "api_key";
+  private static final String API_KEY = "AIzaSyabcdefghijklmnopqrstuvwxyz1234567";
+  private static final String PROJECT_ID = "fake-frc-test-id";
 
   private static final String FIREPERF_NAMESPACE = "fireperf";
 
@@ -1220,6 +1221,11 @@ private static FirebaseApp initializeFirebaseApp(Context context) {
     FirebaseApp.clearInstancesForTest();
 
     return FirebaseApp.initializeApp(
-        context, new FirebaseOptions.Builder().setApiKey(API_KEY).setApplicationId(APP_ID).build());
+        context,
+        new FirebaseOptions.Builder()
+            .setApiKey(API_KEY)
+            .setApplicationId(APP_ID)
+            .setProjectId(PROJECT_ID)
+            .build());
   }
 }

firebase-config/src/test/java/com/google/firebase/remoteconfig/RemoteConfigComponentTest.java

@@ -58,9 +58,10 @@
 @RunWith(RobolectricTestRunner.class)
 @Config(manifest = Config.NONE)
 public class RemoteConfigComponentTest {
-  private static final String API_KEY = "api_key";
+  private static final String API_KEY = "AIzaSyabcdefghijklmnopqrstuvwxyz1234567";
   private static final String APP_ID = "1:14368190084:android:09cb977358c6f241";
   private static final String DUMMY_API_KEY = "api_key";
+  private static final String PROJECT_ID = "fake-frc-test-id";
 
   @Mock private FirebaseApp mockFirebaseApp;
   @Mock private FirebaseInstallationsApi mockFirebaseInstallations;
@@ -237,6 +238,11 @@ private static FirebaseApp initializeFirebaseApp(Context context) {
     FirebaseApp.clearInstancesForTest();
 
     return FirebaseApp.initializeApp(
-        context, new FirebaseOptions.Builder().setApiKey(API_KEY).setApplicationId(APP_ID).build());
+        context,
+        new FirebaseOptions.Builder()
+            .setApiKey(API_KEY)
+            .setApplicationId(APP_ID)
+            .setProjectId(PROJECT_ID)
+            .build());
   }
 }