Http client in Firebase Segmentation SDK to call backend service. (#573)

* Implement Firebase segmentation SDK device local cache

* [Firebase Segmentation] Add custom installation id cache layer and tests for it.

* Add test for updating cache

* Switch to use SQLiteOpenHelper

* Switch to use SharedPreferences from SQLite.

* Change the cache class to be singleton

* Wrap shared pref commit in a async task.

* Address comments

* Google format fix

* Replace some deprecated code.

* Package refactor

* nit

* nit

* Add the state machine of updating custom installation id in the local
cache and update to Firebase Segmentation backend. CL also contains unit
tests.
(The http client is not implemented yet.)

* minor format fix

* Address comments #1

* Http client in Firebase Segmentation SDK to call backend service.

* Revert unintentional change

* Fix connected device test

* Fix connected device test

* 1. Add a few annotations to make java code Kotlin friendly
2. Some fixes for the http request format

* Fix java format

* Fix API version

* Change the segmentation API implementation to synchronous and put the
entire synchronous code block in async task.

* Fix a async getResult race issue.

* OkHttpClient -> HttpsUrlConnection

* Use gzip for compressing content and fix ourput stream memory leak risk.

* Addressed a few comments

Author: diwu-arete

firebase-segmentation/firebase-segmentation.gradle

@@ -14,45 +14,12 @@
 
 plugins {
     id 'firebase-library'
-    id 'com.google.protobuf'
 }
 
 firebaseLibrary {
     testLab.enabled = true
 }
 
-protobuf {
-    // Configure the protoc executable
-    protoc {
-        // Download from repositories
-        artifact = 'com.google.protobuf:protoc:3.4.0'
-    }
-    plugins {
-        grpc {
-            artifact = 'io.grpc:protoc-gen-grpc-java:1.12.0'
-        }
-        javalite {
-            // The codegen for lite comes as a separate artifact
-            artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'
-        }
-    }
-    generateProtoTasks {
-        all().each { task ->
-            task.builtins {
-                // In most cases you don't need the full Java output
-                // if you use the lite output.
-                remove java
-            }
-            task.plugins {
-                grpc {
-                    option 'lite'
-                }
-                javalite {}
-            }
-        }
-    }
-}
-
 android {
     compileSdkVersion project.targetSdkVersion
 
@@ -63,13 +30,6 @@ android {
         versionName version
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
-    sourceSets {
-        main {
-            proto {
-                srcDir 'src/main/proto'
-            }
-        }
-    }
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
@@ -83,18 +43,14 @@ android {
 
 dependencies {
     implementation project(':firebase-common')
-    implementation project(':protolite-well-known-types')
 
     implementation('com.google.firebase:firebase-iid:17.0.3') {
         exclude group: "com.google.firebase", module: "firebase-common"
     }
-    implementation 'io.grpc:grpc-stub:1.21.0'
-    implementation 'io.grpc:grpc-protobuf-lite:1.21.0'
-    implementation 'io.grpc:grpc-okhttp:1.21.0'
+
     implementation 'androidx.appcompat:appcompat:1.0.2'
-    implementation 'androidx.multidex:multidex:2.0.0'
-    implementation 'com.google.android.gms:play-services-tasks:16.0.1'
-    implementation 'com.squareup.okhttp:okhttp:2.7.5'
+    implementation 'androidx.multidex:multidex:2.0.1'
+    implementation 'com.google.android.gms:play-services-tasks:17.0.0'
 
     compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
     annotationProcessor "com.google.auto.value:auto-value:1.6.2"
@@ -103,7 +59,7 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     testImplementation "org.robolectric:robolectric:$robolectricVersion"
 
-    androidTestImplementation "androidx.annotation:annotation:1.1.0"
+    androidTestImplementation "androidx.annotation:annotation:1.0.0"
     androidTestImplementation 'androidx.test.ext:junit:1.1.1'
     androidTestImplementation 'androidx.test:rules:1.2.0'
     androidTestImplementation 'androidx.test:runner:1.2.0'

firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java

@@ -69,19 +69,24 @@ public void setUp() {
     firebaseApp =
         FirebaseApp.initializeApp(
             ApplicationProvider.getApplicationContext(),
-            new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
+            new FirebaseOptions.Builder()
+                .setApplicationId("1:123456789:android:abcdef")
+                .setApiKey("api_key")
+                .build());
     actualCache = new CustomInstallationIdCache(firebaseApp);
 
     when(backendClientReturnsOk.updateCustomInstallationId(
+            anyLong(), anyString(), anyString(), anyString(), anyString()))
+        .thenReturn(SegmentationServiceClient.Code.OK);
+    when(backendClientReturnsOk.clearCustomInstallationId(
             anyLong(), anyString(), anyString(), anyString()))
-        .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
-    when(backendClientReturnsOk.clearCustomInstallationId(anyLong(), anyString(), anyString()))
-        .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+        .thenReturn(SegmentationServiceClient.Code.OK);
     when(backendClientReturnsError.updateCustomInstallationId(
+            anyLong(), anyString(), anyString(), anyString(), anyString()))
+        .thenReturn(SegmentationServiceClient.Code.SERVER_ERROR);
+    when(backendClientReturnsError.clearCustomInstallationId(
             anyLong(), anyString(), anyString(), anyString()))
-        .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.SERVER_INTERNAL_ERROR));
-    when(backendClientReturnsError.clearCustomInstallationId(anyLong(), anyString(), anyString()))
-        .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.SERVER_INTERNAL_ERROR));
+        .thenReturn(SegmentationServiceClient.Code.SERVER_ERROR);
     when(firebaseInstanceId.getInstanceId())
         .thenReturn(
             Tasks.forResult(
@@ -98,13 +103,13 @@ public String getToken() {
                     return "iid_token";
                   }
                 }));
-    when(cacheReturnsError.insertOrUpdateCacheEntry(any())).thenReturn(Tasks.forResult(false));
+    when(cacheReturnsError.insertOrUpdateCacheEntry(any())).thenReturn(false);
     when(cacheReturnsError.readCacheEntryValue()).thenReturn(null);
   }
 
   @After
   public void cleanUp() throws Exception {
-    Tasks.await(actualCache.clear());
+    actualCache.clear();
   }
 
   @Test
@@ -165,12 +170,11 @@ public void testUpdateCustomInstallationId_CacheError_BackendOk() throws Interru
 
   @Test
   public void testClearCustomInstallationId_CacheOk_BackendOk() throws Exception {
-    Tasks.await(
-        actualCache.insertOrUpdateCacheEntry(
-            CustomInstallationIdCacheEntryValue.create(
-                CUSTOM_INSTALLATION_ID,
-                FIREBASE_INSTANCE_ID,
-                CustomInstallationIdCache.CacheStatus.SYNCED)));
+    actualCache.insertOrUpdateCacheEntry(
+        CustomInstallationIdCacheEntryValue.create(
+            CUSTOM_INSTALLATION_ID,
+            FIREBASE_INSTANCE_ID,
+            CustomInstallationIdCache.CacheStatus.SYNCED));
     FirebaseSegmentation firebaseSegmentation =
         new FirebaseSegmentation(
             firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
@@ -183,12 +187,11 @@ public void testClearCustomInstallationId_CacheOk_BackendOk() throws Exception {
 
   @Test
   public void testClearCustomInstallationId_CacheOk_BackendError() throws Exception {
-    Tasks.await(
-        actualCache.insertOrUpdateCacheEntry(
-            CustomInstallationIdCacheEntryValue.create(
-                CUSTOM_INSTALLATION_ID,
-                FIREBASE_INSTANCE_ID,
-                CustomInstallationIdCache.CacheStatus.SYNCED)));
+    actualCache.insertOrUpdateCacheEntry(
+        CustomInstallationIdCacheEntryValue.create(
+            CUSTOM_INSTALLATION_ID,
+            FIREBASE_INSTANCE_ID,
+            CustomInstallationIdCache.CacheStatus.SYNCED));
     FirebaseSegmentation firebaseSegmentation =
         new FirebaseSegmentation(
             firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsError);

firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java

@@ -20,7 +20,6 @@
 
 import androidx.test.core.app.ApplicationProvider;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
-import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.FirebaseOptions;
 import org.junit.After;
@@ -55,8 +54,8 @@ public void setUp() {
 
   @After
   public void cleanUp() throws Exception {
-    Tasks.await(cache0.clear());
-    Tasks.await(cache1.clear());
+    cache0.clear();
+    cache1.clear();
   }
 
   @Test
@@ -68,12 +67,9 @@ public void testReadCacheEntry_Null() {
   @Test
   public void testUpdateAndReadCacheEntry() throws Exception {
     assertTrue(
-        Tasks.await(
-            cache0.insertOrUpdateCacheEntry(
-                CustomInstallationIdCacheEntryValue.create(
-                    "123456",
-                    "cAAAAAAAAAA",
-                    CustomInstallationIdCache.CacheStatus.PENDING_UPDATE))));
+        cache0.insertOrUpdateCacheEntry(
+            CustomInstallationIdCacheEntryValue.create(
+                "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.PENDING_UPDATE)));
     CustomInstallationIdCacheEntryValue entryValue = cache0.readCacheEntryValue();
     assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
     assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
@@ -82,10 +78,9 @@ public void testUpdateAndReadCacheEntry() throws Exception {
     assertNull(cache1.readCacheEntryValue());
 
     assertTrue(
-        Tasks.await(
-            cache0.insertOrUpdateCacheEntry(
-                CustomInstallationIdCacheEntryValue.create(
-                    "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED))));
+        cache0.insertOrUpdateCacheEntry(
+            CustomInstallationIdCacheEntryValue.create(
+                "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED)));
     entryValue = cache0.readCacheEntryValue();
     assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
     assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");