Date: Fri, 14 Jun 2019 17:03:52 -0700
Subject: [PATCH 05/74] Switch to use SQLiteOpenHelper
---
.../firebase-segmentation.gradle | 2 +-
.../CustomInstallationIdCache.java | 176 +++++++++++++-----
2 files changed, 127 insertions(+), 51 deletions(-)
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index cc24fe30ced..dc4606715c5 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/firebase-segmentation/firebase-segmentation.gradle
@@ -57,7 +57,7 @@ android {
compileSdkVersion project.targetSdkVersion
defaultConfig {
- minSdkVersion 21
+ minSdkVersion project.minSdkVersion
targetSdkVersion project.targetSdkVersion
multiDexEnabled true
versionName version
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
index 94df707d3fe..e2647f75cca 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -14,8 +14,11 @@
package com.google.firebase.segmentation;
+import android.content.Context;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
+import android.database.sqlite.SQLiteOpenHelper;
+import android.os.Build;
import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;
import com.google.android.gms.common.internal.Preconditions;
@@ -49,34 +52,105 @@ enum CacheStatus {
String.format(
"%s = ? " + "AND " + "%s = ?", GMP_APP_ID_COLUMN_NAME, FIREBASE_APP_NAME_COLUMN_NAME);
- private final SQLiteDatabase localDb;
+ /**
+ * A SQLiteOpenHelper that configures database connections just the way we like them, delegating
+ * to SQLiteSchema to actually do the work of migration.
+ *
+ * The order of events when opening a new connection is as follows:
+ *
+ *
+ * - New connection
+ *
- onConfigure (API 16 and above)
+ *
- onCreate / onUpgrade (optional; if version already matches these aren't called)
+ *
- onOpen
+ *
+ *
+ * This OpenHelper attempts to obtain exclusive access to the database and attempts to do so as
+ * early as possible. On Jelly Bean devices and above (some 98% of devices at time of writing)
+ * this happens naturally during onConfigure. On pre-Jelly Bean devices all other methods ensure
+ * that the configuration is applied before any action is taken.
+ */
+ private static class OpenHelper extends SQLiteOpenHelper {
+ // TODO: when we do schema upgrades in the future we need to make sure both downgrades and
+ // upgrades work as expected, e.g. `up+down+up` is equivalent to `up`.
+ private static int SCHEMA_VERSION = 1;
+
+ private boolean configured = false;
+
+ private OpenHelper(Context context) {
+ super(context, LOCAL_DB_NAME, null, SCHEMA_VERSION);
+ }
+
+ @Override
+ public void onConfigure(SQLiteDatabase db) {
+ // Note that this is only called automatically by the SQLiteOpenHelper base class on Jelly
+ // Bean and above.
+ configured = true;
+
+ db.rawQuery("PRAGMA busy_timeout=0;", new String[0]).close();
+
+ if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN) {
+ db.setForeignKeyConstraintsEnabled(true);
+ }
+ }
+
+ private void ensureConfigured(SQLiteDatabase db) {
+ if (!configured) {
+ onConfigure(db);
+ }
+ }
+
+ @Override
+ public void onCreate(SQLiteDatabase db) {
+ ensureConfigured(db);
+ // Create custom id mapping table.
+ db.execSQL(
+ String.format(
+ "CREATE TABLE IF NOT EXISTS %s(%s TEXT NOT NULL, %s TEXT NOT NULL, "
+ + "%s TEXT NOT NULL, %s TEXT NOT NULL, %s INTEGER NOT NULL, PRIMARY KEY (%s, %s));",
+ TABLE_NAME,
+ GMP_APP_ID_COLUMN_NAME,
+ FIREBASE_APP_NAME_COLUMN_NAME,
+ CUSTOM_INSTALLATION_ID_COLUMN_NAME,
+ INSTANCE_ID_COLUMN_NAME,
+ CACHE_STATUS_COLUMN,
+ GMP_APP_ID_COLUMN_NAME,
+ FIREBASE_APP_NAME_COLUMN_NAME));
+ }
+
+ @Override
+ public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
+ ensureConfigured(db);
+ }
+
+ @Override
+ public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {
+ ensureConfigured(db);
+ }
+
+ @Override
+ public void onOpen(SQLiteDatabase db) {
+ ensureConfigured(db);
+ }
+ }
+
+ private final OpenHelper openHelper;
CustomInstallationIdCache() {
- // Since different FirebaseApp in the same Android application should have the same application
- // context and same dir path, so that use the context of the default FirebaseApp to create/open
+ // Since different FirebaseApp in the same Android application should
+ // have the same application
+ // context and same dir path, so that use the context of the default
+ // FirebaseApp to create/open
// the database.
- localDb =
- SQLiteDatabase.openOrCreateDatabase(
- FirebaseApp.getInstance()
- .getApplicationContext()
- .getNoBackupFilesDir()
- .getAbsolutePath()
- + "/"
- + LOCAL_DB_NAME,
- null);
-
- localDb.execSQL(
- String.format(
- "CREATE TABLE IF NOT EXISTS %s(%s TEXT NOT NULL, %s TEXT NOT NULL, "
- + "%s TEXT NOT NULL, %s TEXT NOT NULL, %s INTEGER NOT NULL, PRIMARY KEY (%s, %s));",
- TABLE_NAME,
- GMP_APP_ID_COLUMN_NAME,
- FIREBASE_APP_NAME_COLUMN_NAME,
- CUSTOM_INSTALLATION_ID_COLUMN_NAME,
- INSTANCE_ID_COLUMN_NAME,
- CACHE_STATUS_COLUMN,
- GMP_APP_ID_COLUMN_NAME,
- FIREBASE_APP_NAME_COLUMN_NAME));
+ openHelper = new OpenHelper(FirebaseApp.getInstance().getApplicationContext());
+ }
+
+ private SQLiteDatabase getReadableDb() {
+ return openHelper.getReadableDatabase();
+ }
+
+ private SQLiteDatabase getWritableDb() {
+ return openHelper.getWritableDatabase();
}
@Nullable
@@ -84,16 +158,17 @@ CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp)
String gmpAppId = firebaseApp.getOptions().getApplicationId();
String appName = firebaseApp.getName();
Cursor cursor =
- localDb.query(
- TABLE_NAME,
- new String[] {
- CUSTOM_INSTALLATION_ID_COLUMN_NAME, INSTANCE_ID_COLUMN_NAME, CACHE_STATUS_COLUMN
- },
- QUERY_WHERE_CLAUSE,
- new String[] {gmpAppId, appName},
- null,
- null,
- null);
+ getReadableDb()
+ .query(
+ TABLE_NAME,
+ new String[] {
+ CUSTOM_INSTALLATION_ID_COLUMN_NAME, INSTANCE_ID_COLUMN_NAME, CACHE_STATUS_COLUMN
+ },
+ QUERY_WHERE_CLAUSE,
+ new String[] {gmpAppId, appName},
+ null,
+ null,
+ null);
CustomInstallationIdCacheEntryValue value = null;
while (cursor.moveToNext()) {
Preconditions.checkArgument(
@@ -109,24 +184,25 @@ CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp)
void insertOrUpdateCacheEntry(
FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
- localDb.execSQL(
- String.format(
- "INSERT OR REPLACE INTO %s(%s, %s, %s, %s, %s) VALUES(%s, %s, %s, %s, %s)",
- TABLE_NAME,
- GMP_APP_ID_COLUMN_NAME,
- FIREBASE_APP_NAME_COLUMN_NAME,
- CUSTOM_INSTALLATION_ID_COLUMN_NAME,
- INSTANCE_ID_COLUMN_NAME,
- CACHE_STATUS_COLUMN,
- "\"" + firebaseApp.getOptions().getApplicationId() + "\"",
- "\"" + firebaseApp.getName() + "\"",
- "\"" + entryValue.getCustomInstallationId() + "\"",
- "\"" + entryValue.getFirebaseInstanceId() + "\"",
- entryValue.getCacheStatus().ordinal()));
+ getWritableDb()
+ .execSQL(
+ String.format(
+ "INSERT OR REPLACE INTO %s(%s, %s, %s, %s, %s) VALUES(%s, %s, %s, %s, %s)",
+ TABLE_NAME,
+ GMP_APP_ID_COLUMN_NAME,
+ FIREBASE_APP_NAME_COLUMN_NAME,
+ CUSTOM_INSTALLATION_ID_COLUMN_NAME,
+ INSTANCE_ID_COLUMN_NAME,
+ CACHE_STATUS_COLUMN,
+ "\"" + firebaseApp.getOptions().getApplicationId() + "\"",
+ "\"" + firebaseApp.getName() + "\"",
+ "\"" + entryValue.getCustomInstallationId() + "\"",
+ "\"" + entryValue.getFirebaseInstanceId() + "\"",
+ entryValue.getCacheStatus().ordinal()));
}
@VisibleForTesting
void clear() {
- localDb.execSQL(String.format("DROP TABLE IF EXISTS %s", TABLE_NAME));
+ getWritableDb().execSQL(String.format("DELETE FROM %s", TABLE_NAME));
}
}
From f118d39bf6cef56330d37ce154afa246b3891269 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Mon, 17 Jun 2019 14:20:39 -0700
Subject: [PATCH 06/74] Switch to use SharedPreferences from SQLite.
---
.../CustomInstallationIdCacheTest.java | 2 +-
.../CustomInstallationIdCache.java | 207 +++++-------------
2 files changed, 51 insertions(+), 158 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
index 0dd24398e32..3e085e32a22 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
@@ -51,7 +51,7 @@ public void setUp() {
@After
public void cleanUp() {
- cache.clear();
+ cache.clearAll();
}
@Test
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
index e2647f75cca..cb50fb3891c 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -14,14 +14,10 @@
package com.google.firebase.segmentation;
-import android.content.Context;
-import android.database.Cursor;
-import android.database.sqlite.SQLiteDatabase;
-import android.database.sqlite.SQLiteOpenHelper;
-import android.os.Build;
+import android.content.SharedPreferences;
import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;
-import com.google.android.gms.common.internal.Preconditions;
+import com.google.android.gms.common.util.Strings;
import com.google.firebase.FirebaseApp;
class CustomInstallationIdCache {
@@ -36,173 +32,70 @@ enum CacheStatus {
// errors.
PENDING,
// Cache entry is not accepted by Firebase backend.
- ERROR
+ ERROR,
}
- private static final String LOCAL_DB_NAME = "CustomInstallationIdCache";
- private static final String TABLE_NAME = "InstallationIdMapping";
+ private static final String SHARED_PREFS_NAME = "CustomInstallationIdCache";
- private static final String GMP_APP_ID_COLUMN_NAME = "GmpAppId";
- private static final String FIREBASE_APP_NAME_COLUMN_NAME = "AppName";
- private static final String CUSTOM_INSTALLATION_ID_COLUMN_NAME = "Cid";
- private static final String INSTANCE_ID_COLUMN_NAME = "Iid";
- private static final String CACHE_STATUS_COLUMN = "Status";
+ private static final String CUSTOM_INSTALLATION_ID_KEY = "Cid";
+ private static final String INSTANCE_ID_KEY = "Iid";
+ private static final String CACHE_STATUS_KEY = "Status";
- private static final String QUERY_WHERE_CLAUSE =
- String.format(
- "%s = ? " + "AND " + "%s = ?", GMP_APP_ID_COLUMN_NAME, FIREBASE_APP_NAME_COLUMN_NAME);
-
- /**
- * A SQLiteOpenHelper that configures database connections just the way we like them, delegating
- * to SQLiteSchema to actually do the work of migration.
- *
- * The order of events when opening a new connection is as follows:
- *
- *
- * - New connection
- *
- onConfigure (API 16 and above)
- *
- onCreate / onUpgrade (optional; if version already matches these aren't called)
- *
- onOpen
- *
- *
- * This OpenHelper attempts to obtain exclusive access to the database and attempts to do so as
- * early as possible. On Jelly Bean devices and above (some 98% of devices at time of writing)
- * this happens naturally during onConfigure. On pre-Jelly Bean devices all other methods ensure
- * that the configuration is applied before any action is taken.
- */
- private static class OpenHelper extends SQLiteOpenHelper {
- // TODO: when we do schema upgrades in the future we need to make sure both downgrades and
- // upgrades work as expected, e.g. `up+down+up` is equivalent to `up`.
- private static int SCHEMA_VERSION = 1;
-
- private boolean configured = false;
-
- private OpenHelper(Context context) {
- super(context, LOCAL_DB_NAME, null, SCHEMA_VERSION);
- }
-
- @Override
- public void onConfigure(SQLiteDatabase db) {
- // Note that this is only called automatically by the SQLiteOpenHelper base class on Jelly
- // Bean and above.
- configured = true;
-
- db.rawQuery("PRAGMA busy_timeout=0;", new String[0]).close();
-
- if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN) {
- db.setForeignKeyConstraintsEnabled(true);
- }
- }
-
- private void ensureConfigured(SQLiteDatabase db) {
- if (!configured) {
- onConfigure(db);
- }
- }
-
- @Override
- public void onCreate(SQLiteDatabase db) {
- ensureConfigured(db);
- // Create custom id mapping table.
- db.execSQL(
- String.format(
- "CREATE TABLE IF NOT EXISTS %s(%s TEXT NOT NULL, %s TEXT NOT NULL, "
- + "%s TEXT NOT NULL, %s TEXT NOT NULL, %s INTEGER NOT NULL, PRIMARY KEY (%s, %s));",
- TABLE_NAME,
- GMP_APP_ID_COLUMN_NAME,
- FIREBASE_APP_NAME_COLUMN_NAME,
- CUSTOM_INSTALLATION_ID_COLUMN_NAME,
- INSTANCE_ID_COLUMN_NAME,
- CACHE_STATUS_COLUMN,
- GMP_APP_ID_COLUMN_NAME,
- FIREBASE_APP_NAME_COLUMN_NAME));
- }
-
- @Override
- public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
- ensureConfigured(db);
- }
-
- @Override
- public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {
- ensureConfigured(db);
- }
-
- @Override
- public void onOpen(SQLiteDatabase db) {
- ensureConfigured(db);
- }
- }
-
- private final OpenHelper openHelper;
+ private final SharedPreferences prefs;
CustomInstallationIdCache() {
- // Since different FirebaseApp in the same Android application should
- // have the same application
- // context and same dir path, so that use the context of the default
- // FirebaseApp to create/open
- // the database.
- openHelper = new OpenHelper(FirebaseApp.getInstance().getApplicationContext());
+ // Since different FirebaseApp in the same Android application should have the same application
+ // context and same dir path, so that use the context of the default FirebaseApp to create the
+ // shared preferences.
+ prefs =
+ FirebaseApp.getInstance()
+ .getApplicationContext()
+ .getSharedPreferences(SHARED_PREFS_NAME, 0); // private mode
}
- private SQLiteDatabase getReadableDb() {
- return openHelper.getReadableDatabase();
+ @Nullable
+ synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp) {
+ String cid =
+ prefs.getString(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY), null);
+ String iid = prefs.getString(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), null);
+ int status = prefs.getInt(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY), -1);
+
+ if (Strings.isEmptyOrWhitespace(cid) || Strings.isEmptyOrWhitespace(iid) || status == -1) {
+ return null;
+ }
+
+ return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
}
- private SQLiteDatabase getWritableDb() {
- return openHelper.getWritableDatabase();
+ synchronized void insertOrUpdateCacheEntry(
+ FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.putString(
+ getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY),
+ entryValue.getCustomInstallationId());
+ editor.putString(
+ getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
+ editor.putInt(
+ getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY),
+ entryValue.getCacheStatus().ordinal());
+ editor.commit();
}
- @Nullable
- CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp) {
- String gmpAppId = firebaseApp.getOptions().getApplicationId();
- String appName = firebaseApp.getName();
- Cursor cursor =
- getReadableDb()
- .query(
- TABLE_NAME,
- new String[] {
- CUSTOM_INSTALLATION_ID_COLUMN_NAME, INSTANCE_ID_COLUMN_NAME, CACHE_STATUS_COLUMN
- },
- QUERY_WHERE_CLAUSE,
- new String[] {gmpAppId, appName},
- null,
- null,
- null);
- CustomInstallationIdCacheEntryValue value = null;
- while (cursor.moveToNext()) {
- Preconditions.checkArgument(
- value == null, "Multiple cache entries found for " + "firebase app %s", appName);
- value =
- CustomInstallationIdCacheEntryValue.create(
- cursor.getString(cursor.getColumnIndex(CUSTOM_INSTALLATION_ID_COLUMN_NAME)),
- cursor.getString(cursor.getColumnIndex(INSTANCE_ID_COLUMN_NAME)),
- CacheStatus.values()[cursor.getInt(cursor.getColumnIndex(CACHE_STATUS_COLUMN))]);
- }
- return value;
+ synchronized void clear(FirebaseApp firebaseApp) {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.remove(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY));
+ editor.remove(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY));
+ editor.remove(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY));
}
- void insertOrUpdateCacheEntry(
- FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
- getWritableDb()
- .execSQL(
- String.format(
- "INSERT OR REPLACE INTO %s(%s, %s, %s, %s, %s) VALUES(%s, %s, %s, %s, %s)",
- TABLE_NAME,
- GMP_APP_ID_COLUMN_NAME,
- FIREBASE_APP_NAME_COLUMN_NAME,
- CUSTOM_INSTALLATION_ID_COLUMN_NAME,
- INSTANCE_ID_COLUMN_NAME,
- CACHE_STATUS_COLUMN,
- "\"" + firebaseApp.getOptions().getApplicationId() + "\"",
- "\"" + firebaseApp.getName() + "\"",
- "\"" + entryValue.getCustomInstallationId() + "\"",
- "\"" + entryValue.getFirebaseInstanceId() + "\"",
- entryValue.getCacheStatus().ordinal()));
+ private static String getSharedPreferencesKey(FirebaseApp firebaseApp, String key) {
+ return String.format("%s|%s", firebaseApp.getPersistenceKey(), key);
}
@VisibleForTesting
- void clear() {
- getWritableDb().execSQL(String.format("DELETE FROM %s", TABLE_NAME));
+ synchronized void clearAll() {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.clear();
+ editor.commit();
}
}
From 4da5d31f31d2160e6ed3702e72d305f04a90e0c5 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Mon, 17 Jun 2019 17:05:01 -0700
Subject: [PATCH 07/74] Change the cache class to be singleton
---
.../segmentation/CustomInstallationIdCacheTest.java | 2 +-
.../segmentation/CustomInstallationIdCache.java | 10 +++++++++-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
index 3e085e32a22..2645ab1571f 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
@@ -46,7 +46,7 @@ public void setUp() {
InstrumentationRegistry.getContext(),
new FirebaseOptions.Builder().setApplicationId("1:987654321:android:abcdef").build(),
"firebase_app_1");
- cache = new CustomInstallationIdCache();
+ cache = CustomInstallationIdCache.getInstance();
}
@After
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
index cb50fb3891c..1e48ca6d6c9 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -41,9 +41,17 @@ enum CacheStatus {
private static final String INSTANCE_ID_KEY = "Iid";
private static final String CACHE_STATUS_KEY = "Status";
+ private static CustomInstallationIdCache singleton = null;
private final SharedPreferences prefs;
- CustomInstallationIdCache() {
+ static CustomInstallationIdCache getInstance() {
+ if (singleton == null) {
+ singleton = new CustomInstallationIdCache();
+ }
+ return singleton;
+ }
+
+ private CustomInstallationIdCache() {
// Since different FirebaseApp in the same Android application should have the same application
// context and same dir path, so that use the context of the default FirebaseApp to create the
// shared preferences.
From d1ff0ec0bcd7b111ea67d18950f8c5f455a759e9 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 10:41:01 -0700
Subject: [PATCH 08/74] Wrap shared pref commit in a async task.
---
.../CustomInstallationIdCacheTest.java | 28 +++++++------
.../CustomInstallationIdCache.java | 39 ++++++++++++++-----
2 files changed, 47 insertions(+), 20 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
index 2645ab1571f..5783294cfa3 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
@@ -16,9 +16,11 @@
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
import androidx.test.InstrumentationRegistry;
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;
@@ -50,8 +52,8 @@ public void setUp() {
}
@After
- public void cleanUp() {
- cache.clearAll();
+ public void cleanUp() throws Exception {
+ Tasks.await(cache.clearAll());
}
@Test
@@ -61,11 +63,13 @@ public void testReadCacheEntry_Null() {
}
@Test
- public void testUpdateAndReadCacheEntry() {
- cache.insertOrUpdateCacheEntry(
- firebaseApp0,
- CustomInstallationIdCacheEntryValue.create(
- "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.PENDING));
+ public void testUpdateAndReadCacheEntry() throws Exception {
+ assertTrue(
+ Tasks.await(
+ cache.insertOrUpdateCacheEntry(
+ firebaseApp0,
+ CustomInstallationIdCacheEntryValue.create(
+ "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.PENDING))));
CustomInstallationIdCacheEntryValue entryValue = cache.readCacheEntryValue(firebaseApp0);
assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
@@ -73,10 +77,12 @@ public void testUpdateAndReadCacheEntry() {
.isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING);
assertNull(cache.readCacheEntryValue(firebaseApp1));
- cache.insertOrUpdateCacheEntry(
- firebaseApp0,
- CustomInstallationIdCacheEntryValue.create(
- "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED));
+ assertTrue(
+ Tasks.await(
+ cache.insertOrUpdateCacheEntry(
+ firebaseApp0,
+ CustomInstallationIdCacheEntryValue.create(
+ "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED))));
entryValue = cache.readCacheEntryValue(firebaseApp0);
assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
index 1e48ca6d6c9..1863b976d9d 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -14,11 +14,16 @@
package com.google.firebase.segmentation;
+import android.content.Context;
import android.content.SharedPreferences;
import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;
import com.google.android.gms.common.util.Strings;
+import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.firebase.FirebaseApp;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Executors;
class CustomInstallationIdCache {
@@ -42,6 +47,7 @@ enum CacheStatus {
private static final String CACHE_STATUS_KEY = "Status";
private static CustomInstallationIdCache singleton = null;
+ private final Executor ioExecuter;
private final SharedPreferences prefs;
static CustomInstallationIdCache getInstance() {
@@ -58,7 +64,9 @@ private CustomInstallationIdCache() {
prefs =
FirebaseApp.getInstance()
.getApplicationContext()
- .getSharedPreferences(SHARED_PREFS_NAME, 0); // private mode
+ .getSharedPreferences(SHARED_PREFS_NAME, Context.MODE_PRIVATE);
+
+ ioExecuter = Executors.newFixedThreadPool(2);
}
@Nullable
@@ -75,7 +83,7 @@ synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp
return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
}
- synchronized void insertOrUpdateCacheEntry(
+ synchronized Task insertOrUpdateCacheEntry(
FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
SharedPreferences.Editor editor = prefs.edit();
editor.putString(
@@ -86,24 +94,37 @@ synchronized void insertOrUpdateCacheEntry(
editor.putInt(
getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY),
entryValue.getCacheStatus().ordinal());
- editor.commit();
+ return commitSharedPreferencesEditAsync(editor);
}
- synchronized void clear(FirebaseApp firebaseApp) {
+ synchronized Task clear(FirebaseApp firebaseApp) {
SharedPreferences.Editor editor = prefs.edit();
editor.remove(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY));
editor.remove(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY));
editor.remove(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY));
+ return commitSharedPreferencesEditAsync(editor);
+ }
+
+ @VisibleForTesting
+ synchronized Task clearAll() {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.clear();
+ return commitSharedPreferencesEditAsync(editor);
}
private static String getSharedPreferencesKey(FirebaseApp firebaseApp, String key) {
return String.format("%s|%s", firebaseApp.getPersistenceKey(), key);
}
- @VisibleForTesting
- synchronized void clearAll() {
- SharedPreferences.Editor editor = prefs.edit();
- editor.clear();
- editor.commit();
+ private Task commitSharedPreferencesEditAsync(SharedPreferences.Editor editor) {
+ TaskCompletionSource result = new TaskCompletionSource();
+ ioExecuter.execute(
+ new Runnable() {
+ @Override
+ public void run() {
+ result.setResult(editor.commit());
+ }
+ });
+ return result.getTask();
}
}
From 41fbfee9e518794f9de09ee7e47ec5716fc92ead Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 11:02:46 -0700
Subject: [PATCH 09/74] Address comments
---
.../firebase/segmentation/CustomInstallationIdCache.java | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
index 1863b976d9d..2a7fb54d1e7 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -17,6 +17,7 @@
import android.content.Context;
import android.content.SharedPreferences;
import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
import androidx.annotation.VisibleForTesting;
import com.google.android.gms.common.util.Strings;
import com.google.android.gms.tasks.Task;
@@ -50,7 +51,7 @@ enum CacheStatus {
private final Executor ioExecuter;
private final SharedPreferences prefs;
- static CustomInstallationIdCache getInstance() {
+ synchronized static CustomInstallationIdCache getInstance() {
if (singleton == null) {
singleton = new CustomInstallationIdCache();
}
@@ -105,7 +106,7 @@ synchronized Task clear(FirebaseApp firebaseApp) {
return commitSharedPreferencesEditAsync(editor);
}
- @VisibleForTesting
+ @RestrictTo(RestrictTo.Scope.TESTS)
synchronized Task clearAll() {
SharedPreferences.Editor editor = prefs.edit();
editor.clear();
From 5fd2fa0d6f4b83e152cb9bceb1fa2467e74e58e0 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 11:57:08 -0700
Subject: [PATCH 10/74] Google format fix
---
.../firebase/segmentation/CustomInstallationIdCache.java | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
index 2a7fb54d1e7..5096a265714 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -18,7 +18,6 @@
import android.content.SharedPreferences;
import androidx.annotation.Nullable;
import androidx.annotation.RestrictTo;
-import androidx.annotation.VisibleForTesting;
import com.google.android.gms.common.util.Strings;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.TaskCompletionSource;
@@ -51,7 +50,7 @@ enum CacheStatus {
private final Executor ioExecuter;
private final SharedPreferences prefs;
- synchronized static CustomInstallationIdCache getInstance() {
+ static synchronized CustomInstallationIdCache getInstance() {
if (singleton == null) {
singleton = new CustomInstallationIdCache();
}
From dc46eee03af6193666fd5b9d6e981eecfce65ccc Mon Sep 17 00:00:00 2001
From: Di Wu <49409954+diwu-arete@users.noreply.github.com>
Date: Tue, 18 Jun 2019 14:03:06 -0700
Subject: [PATCH 11/74] [Firebase Segmentation] Add custom installation id
cache layer and tests for it. (#524)
* Add type arguments in StorageTaskManager (#517)
* Output artifact list during local publishing. (#515)
This effort replaces #494.
* Implement Firebase segmentation SDK device local cache
* fix functions (#523)
* fix functions
* update minsdk version
* remove idea
* Set test type to release only in CI. (#522)
* Set test type to release only in CI.
This fixes Android Studio issue, where it is impossible to run
integration tests in debug mode.
Additionally move build type configuration to FirebaseLibraryPlugin to
avoid projects.all configuration in gradle.
* Add comment back.
* [Firebase Segmentation] Add custom installation id cache layer and tests for it.
* Add test for updating cache
* Switch to use SQLiteOpenHelper
* Minor fix to error message to match the admin sdk. (#525)
* Minor fix to error message to match the admin sdk.
In particular, it *is* allowed to have slashes, etc in field paths.
* Added clean task to smoke tests. (#527)
This change allows the smoke tests to clean all build variants created
by the infrastructure.
* Update deps to post-androidx gms versions. (#526)
* Update deps to post-androidx gms versions.
Additionally configure sources.jar for SDKs.
* Update functions-ktx deps
* Fix versions.
* unbump fiam version in fiamui-app
* Switch to use SharedPreferences from SQLite.
* Change the cache class to be singleton
* Copy firebase-firestore-ktx dependencies on firestore into its own subfolder (#528)
* Wrap shared pref commit in a async task.
* Address comments
* Bump firestore version for release (#530)
Additionally fix pom filter to exclude multidex from deps.
* Google format fix
---
buildSrc/build.gradle | 2 +-
.../gradle/plugins/FirebaseLibraryPlugin.java | 23 +-
.../plugins/ci/AffectedProjectFinder.groovy | 11 +
.../ci/ContinuousIntegrationPlugin.groovy | 8 -
.../gradle/plugins/ci/SmokeTestsPlugin.groovy | 105 +++
.../gradle/plugins/publish/Publisher.groovy | 2 +-
fiamui-app/fiamui-app.gradle | 6 +-
firebase-common/firebase-common.gradle | 4 +-
firebase-common/gradle.properties | 4 +-
.../firebase-database-collection.gradle | 2 +-
.../gradle.properties | 4 +-
firebase-database/firebase-database.gradle | 8 +-
firebase-database/gradle.properties | 4 +-
firebase-datatransport/gradle.properties | 4 +-
firebase-firestore/firebase-firestore.gradle | 8 +-
firebase-firestore/gradle.properties | 4 +-
firebase-firestore/ktx/ktx.gradle | 12 +-
.../firebase/firestore/TestAccessHelper.java | 31 +
.../google/firebase/firestore/TestUtil.java | 179 +++++
.../firebase/firestore/testutil/TestUtil.java | 618 ++++++++++++++++++
.../firebase/firestore/ValidationTest.java | 6 +-
.../google/firebase/firestore/FieldPath.java | 3 +-
firebase-functions/firebase-functions.gradle | 12 +-
firebase-functions/gradle.properties | 4 +-
firebase-functions/ktx/ktx.gradle | 4 +-
.../ktx/src/androidTest/AndroidManifest.xml | 2 +-
.../ktx/src/main/AndroidManifest.xml | 2 +-
.../src/main/AndroidManifest.xml | 2 +-
.../firebase-segmentation.gradle | 11 +-
.../CustomInstallationIdCacheTest.java | 91 +++
.../CustomInstallationIdCache.java | 130 ++++
.../CustomInstallationIdCacheEntryValue.java | 37 ++
firebase-storage/firebase-storage.gradle | 7 +-
firebase-storage/gradle.properties | 4 +-
.../firebase/storage/StorageTaskManager.java | 16 +-
firebase-storage/test-app/test-app.gradle | 8 +-
protolite-well-known-types/gradle.properties | 4 +-
root-project.gradle | 33 +-
smoke-tests/build.gradle | 12 +
.../apksize/src/firestore/firestore.gradle | 2 +-
transport/transport-api/gradle.properties | 4 +-
.../transport-backend-cct/gradle.properties | 4 +-
transport/transport-runtime/gradle.properties | 4 +-
43 files changed, 1320 insertions(+), 121 deletions(-)
create mode 100644 buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/SmokeTestsPlugin.groovy
create mode 100644 firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestAccessHelper.java
create mode 100644 firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestUtil.java
create mode 100644 firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/testutil/TestUtil.java
create mode 100644 firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
index 9cea827df36..a70e1c40638 100644
--- a/buildSrc/build.gradle
+++ b/buildSrc/build.gradle
@@ -37,6 +37,7 @@ dependencies {
implementation 'org.jsoup:jsoup:1.11.2'
implementation 'digital.wup:android-maven-publish:3.6.2'
implementation 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.20'
+ implementation 'org.json:json:20180813'
implementation 'io.opencensus:opencensus-api:0.18.0'
implementation 'io.opencensus:opencensus-exporter-stats-stackdriver:0.18.0'
@@ -44,7 +45,6 @@ dependencies {
implementation 'com.android.tools.build:gradle:3.2.1'
testImplementation 'junit:junit:4.12'
- testImplementation 'org.json:json:20180813'
testImplementation('org.spockframework:spock-core:1.1-groovy-2.4') {
exclude group: 'org.codehaus.groovy'
}
diff --git a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java
index 5950a5477dd..522065eab14 100644
--- a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java
+++ b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/FirebaseLibraryPlugin.java
@@ -20,7 +20,6 @@
import com.google.firebase.gradle.plugins.ci.device.FirebaseTestServer;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
-import org.gradle.api.tasks.bundling.Jar;
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile;
public class FirebaseLibraryPlugin implements Plugin {
@@ -33,6 +32,28 @@ public void apply(Project project) {
LibraryExtension android = project.getExtensions().getByType(LibraryExtension.class);
+ // In the case of and android library signing config only affects instrumentation test APK.
+ // We need it signed with default debug credentials in order for FTL to accept the APK.
+ android.buildTypes(
+ types ->
+ types
+ .getByName("release")
+ .setSigningConfig(types.getByName("debug").getSigningConfig()));
+
+ // skip debug tests in CI
+ // TODO(vkryachko): provide ability for teams to control this if needed
+ if (System.getenv().containsKey("FIREBASE_CI")) {
+ android.setTestBuildType("release");
+ project
+ .getTasks()
+ .all(
+ task -> {
+ if ("testDebugUnitTest".equals(task.getName())) {
+ task.setEnabled(false);
+ }
+ });
+ }
+
android.testServer(new FirebaseTestServer(project, firebaseLibrary.testLab));
// reduce the likelihood of kotlin module files colliding.
diff --git a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/AffectedProjectFinder.groovy b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/AffectedProjectFinder.groovy
index d04607189e9..ffe1e43099c 100644
--- a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/AffectedProjectFinder.groovy
+++ b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/AffectedProjectFinder.groovy
@@ -25,6 +25,10 @@ class AffectedProjectFinder {
Set changedPaths;
@Builder
+ AffectedProjectFinder(Project project, List ignorePaths) {
+ this(project, changedPaths(project.rootDir), ignorePaths)
+ }
+
AffectedProjectFinder(Project project,
Set changedPaths,
List ignorePaths) {
@@ -49,6 +53,13 @@ class AffectedProjectFinder {
return project.subprojects
}
+ private static Set changedPaths(File workDir) {
+ return 'git diff --name-only --submodule=diff HEAD@{0} HEAD@{1}'
+ .execute([], workDir)
+ .text
+ .readLines()
+ }
+
/**
* Performs a post-order project tree traversal and returns a set of projects that own the
* 'changedPaths'.
diff --git a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/ContinuousIntegrationPlugin.groovy b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/ContinuousIntegrationPlugin.groovy
index 95334ba6dbd..7c44748e6be 100644
--- a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/ContinuousIntegrationPlugin.groovy
+++ b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/ContinuousIntegrationPlugin.groovy
@@ -97,7 +97,6 @@ class ContinuousIntegrationPlugin implements Plugin {
def affectedProjects = AffectedProjectFinder.builder()
.project(project)
- .changedPaths(changedPaths(project.rootDir))
.ignorePaths(extension.ignorePaths)
.build()
.find()
@@ -143,13 +142,6 @@ class ContinuousIntegrationPlugin implements Plugin {
}
}
- private static Set changedPaths(File workDir) {
- return 'git diff --name-only --submodule=diff HEAD@{0} HEAD@{1}'
- .execute([], workDir)
- .text
- .readLines()
- }
-
private static final ANDROID_PLUGINS = ["com.android.application", "com.android.library",
"com.android.test"]
diff --git a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/SmokeTestsPlugin.groovy b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/SmokeTestsPlugin.groovy
new file mode 100644
index 00000000000..853e845418d
--- /dev/null
+++ b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/ci/SmokeTestsPlugin.groovy
@@ -0,0 +1,105 @@
+// Copyright 2018 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.gradle.plugins.ci
+
+import com.google.firebase.gradle.plugins.FirebaseLibraryExtension
+import com.google.firebase.gradle.plugins.ci.AffectedProjectFinder
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.artifacts.ProjectDependency
+import org.json.JSONArray
+import org.json.JSONObject
+
+/** Builds Firebase libraries for consumption by the smoke tests. */
+class SmokeTestsPlugin implements Plugin {
+ @Override
+ public void apply(Project project) {
+ def assembleAllTask = project.task("assembleAllForSmokeTests")
+
+ // Wait until after the projects have been evaluated or else we might skip projects.
+ project.gradle.projectsEvaluated {
+ def changedProjects = getChangedProjects(project)
+ def changedArtifacts = new HashSet()
+ def allArtifacts = new HashSet()
+
+ // Visit each project and add the artifacts to the appropriate sets.
+ project.subprojects {
+ def firebaseLibrary = it.extensions.findByType(FirebaseLibraryExtension)
+ if (firebaseLibrary == null) {
+ return
+ }
+
+ def groupId = firebaseLibrary.groupId.get()
+ def artifactId = firebaseLibrary.artifactId.get()
+ def artifact = "$groupId:$artifactId:$it.version-SNAPSHOT"
+ allArtifacts.add(artifact)
+
+ if (changedProjects.contains(it)) {
+ changedArtifacts.add(artifact)
+ }
+ }
+
+ // Reuse the publish task for building the libraries.
+ def publishAllTask = project.tasks.getByPath("publishAllToBuildDir")
+ assembleAllTask.dependsOn(publishAllTask)
+
+ // Generate a JSON file listing the artifacts after everything is complete.
+ assembleAllTask.doLast {
+ def changed = new JSONArray()
+ changedArtifacts.each { changed.put(it) }
+
+ def all = new JSONArray()
+ allArtifacts.each { all.put(it) }
+
+ def json = new JSONObject()
+ json.put("all", all)
+ json.put("changed", changed)
+
+ def path = project.buildDir.toPath()
+ path.resolve("m2repository/changed-artifacts.json").write(json.toString())
+ }
+ }
+ }
+
+ private static Set getChangedProjects(Project p) {
+ Set roots = new AffectedProjectFinder(p, []).find()
+ HashSet changed = new HashSet<>()
+
+ getChangedProjectsLoop(roots, changed)
+ return changed
+ }
+
+ private static void getChangedProjectsLoop(Collection projects, Set changed) {
+ for (Project p : projects) {
+ // Skip project if it is not a Firebase library.
+ if (p.extensions.findByType(FirebaseLibraryExtension) == null) {
+ continue;
+ }
+
+ // Skip processing and recursion if this project has already been added to the set.
+ if (!changed.add(p)) {
+ continue;
+ }
+
+ // Find all (head) dependencies to other projects in this respository.
+ def all = p.configurations.releaseRuntimeClasspath.allDependencies
+ def affected =
+ all.findAll { it instanceof ProjectDependency }.collect { it.getDependencyProject() }
+
+ // Recurse with the new dependencies.
+ getChangedProjectsLoop(affected, changed)
+ }
+ }
+}
diff --git a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/publish/Publisher.groovy b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/publish/Publisher.groovy
index 51036b38cc9..311e1626368 100644
--- a/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/publish/Publisher.groovy
+++ b/buildSrc/src/main/groovy/com/google/firebase/gradle/plugins/publish/Publisher.groovy
@@ -74,7 +74,7 @@ class Publisher {
pom.dependencies.dependency.each {
// remove multidex as it is supposed to be added by final applications and is needed for
// some libraries only for instrumentation tests to build.
- if (it.groupId.text() in ['com.android.support', 'androidx'] && it.artifactId.text() == 'multidex') {
+ if (it.groupId.text() in ['com.android.support', 'androidx.multidex'] && it.artifactId.text() == 'multidex') {
it.parent().remove(it)
}
it.appendNode('type', [:], deps["${it.groupId.text()}:${it.artifactId.text()}"])
diff --git a/fiamui-app/fiamui-app.gradle b/fiamui-app/fiamui-app.gradle
index 4b3b3659e8e..3382bd3ce27 100644
--- a/fiamui-app/fiamui-app.gradle
+++ b/fiamui-app/fiamui-app.gradle
@@ -53,11 +53,11 @@ android {
dependencies {
implementation project(path: ":firebase-inappmessaging-display")
- implementation "com.google.firebase:firebase-measurement-connector:17.0.1"
+ implementation "com.google.firebase:firebase-measurement-connector:18.0.0"
implementation('com.google.firebase:firebase-inappmessaging:17.0.3') {
exclude group: 'com.google.firebase', module: 'firebase-common'
}
- implementation('com.google.firebase:firebase-analytics:16.0.4') {
+ implementation('com.google.firebase:firebase-analytics:17.0.0') {
exclude group: 'com.google.firebase', module: 'firebase-common'
}
@@ -67,7 +67,7 @@ dependencies {
implementation "com.google.code.findbugs:jsr305:3.0.2"
implementation "com.squareup.okhttp:okhttp:2.7.5"
implementation "com.google.auto.value:auto-value-annotations:1.6.5"
- implementation "com.google.android.gms:play-services-basement:16.2.0"
+ implementation "com.google.android.gms:play-services-basement:17.0.0"
// The following dependencies are not required to use the FIAM UI library.
// They are used to make some aspects of the demo app implementation simpler for
diff --git a/firebase-common/firebase-common.gradle b/firebase-common/firebase-common.gradle
index ed68cd80597..2a8c84ce1e6 100644
--- a/firebase-common/firebase-common.gradle
+++ b/firebase-common/firebase-common.gradle
@@ -58,8 +58,8 @@ android {
}
dependencies {
- implementation 'com.google.android.gms:play-services-basement:16.2.0'
- implementation "com.google.android.gms:play-services-tasks:16.0.1"
+ implementation 'com.google.android.gms:play-services-basement:17.0.0'
+ implementation "com.google.android.gms:play-services-tasks:17.0.0"
api 'com.google.auto.value:auto-value-annotations:1.6.5'
compileOnly 'com.google.code.findbugs:jsr305:3.0.2'
diff --git a/firebase-common/gradle.properties b/firebase-common/gradle.properties
index 5328ce212de..9b7be4891d1 100644
--- a/firebase-common/gradle.properties
+++ b/firebase-common/gradle.properties
@@ -1,2 +1,2 @@
-version=17.1.1
-latestReleasedVersion=17.1.0
+version=18.0.1
+latestReleasedVersion=18.0.0
diff --git a/firebase-database-collection/firebase-database-collection.gradle b/firebase-database-collection/firebase-database-collection.gradle
index 1d29321dd24..a9d5af2f3c3 100644
--- a/firebase-database-collection/firebase-database-collection.gradle
+++ b/firebase-database-collection/firebase-database-collection.gradle
@@ -29,7 +29,7 @@ android {
}
dependencies {
- implementation 'com.google.android.gms:play-services-base:16.1.0'
+ implementation 'com.google.android.gms:play-services-base:17.0.0'
testImplementation 'junit:junit:4.12'
testImplementation 'net.java:quickcheck:0.6'
diff --git a/firebase-database-collection/gradle.properties b/firebase-database-collection/gradle.properties
index c763f64467b..54be3eb478f 100644
--- a/firebase-database-collection/gradle.properties
+++ b/firebase-database-collection/gradle.properties
@@ -1,2 +1,2 @@
-version=16.0.2
-latestReleasedVersion=16.0.1
+version=17.0.1
+latestReleasedVersion=17.0.0
diff --git a/firebase-database/firebase-database.gradle b/firebase-database/firebase-database.gradle
index b6ef29308c9..b68e911ad69 100644
--- a/firebase-database/firebase-database.gradle
+++ b/firebase-database/firebase-database.gradle
@@ -73,10 +73,10 @@ dependencies {
implementation project(':firebase-common')
implementation project(':firebase-database-collection')
- implementation 'com.google.android.gms:play-services-basement:16.2.0'
- implementation 'com.google.android.gms:play-services-base:16.1.0'
- implementation 'com.google.android.gms:play-services-tasks:16.0.1'
- implementation('com.google.firebase:firebase-auth-interop:17.0.0') {
+ implementation 'com.google.android.gms:play-services-basement:17.0.0'
+ implementation 'com.google.android.gms:play-services-base:17.0.0'
+ implementation 'com.google.android.gms:play-services-tasks:17.0.0'
+ implementation('com.google.firebase:firebase-auth-interop:18.0.0') {
exclude group: "com.google.firebase", module: "firebase-common"
}
diff --git a/firebase-database/gradle.properties b/firebase-database/gradle.properties
index f4ae1a57594..b2337aeb5ba 100644
--- a/firebase-database/gradle.properties
+++ b/firebase-database/gradle.properties
@@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-version=17.0.0
-latestReleasedVersion=16.1.0
+version=18.0.1
+latestReleasedVersion=18.0.0
android.enableUnitTestBinaryResources=true
diff --git a/firebase-datatransport/gradle.properties b/firebase-datatransport/gradle.properties
index 03f6ea19074..a8dce55d4ea 100644
--- a/firebase-datatransport/gradle.properties
+++ b/firebase-datatransport/gradle.properties
@@ -1,3 +1,3 @@
-version=16.0.1
-latestReleasedVersion=16.0.0
+version=17.0.1
+latestReleasedVersion=17.0.0
android.enableUnitTestBinaryResources=true
diff --git a/firebase-firestore/firebase-firestore.gradle b/firebase-firestore/firebase-firestore.gradle
index f92916e98a1..9d8d86a686f 100644
--- a/firebase-firestore/firebase-firestore.gradle
+++ b/firebase-firestore/firebase-firestore.gradle
@@ -106,13 +106,13 @@ dependencies {
implementation 'io.grpc:grpc-protobuf-lite:1.21.0'
implementation 'io.grpc:grpc-okhttp:1.21.0'
implementation 'io.grpc:grpc-android:1.21.0'
- implementation 'com.google.android.gms:play-services-basement:16.2.0'
- implementation 'com.google.android.gms:play-services-tasks:16.0.1'
- implementation 'com.google.android.gms:play-services-base:16.1.0'
+ implementation 'com.google.android.gms:play-services-basement:17.0.0'
+ implementation 'com.google.android.gms:play-services-tasks:17.0.0'
+ implementation 'com.google.android.gms:play-services-base:17.0.0'
implementation 'com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava'
implementation 'com.squareup.okhttp:okhttp:2.7.5'
- implementation('com.google.firebase:firebase-auth-interop:17.0.0') {
+ implementation('com.google.firebase:firebase-auth-interop:18.0.0') {
exclude group: "com.google.firebase", module: "firebase-common"
}
diff --git a/firebase-firestore/gradle.properties b/firebase-firestore/gradle.properties
index 04d7bc444aa..346e8670d44 100644
--- a/firebase-firestore/gradle.properties
+++ b/firebase-firestore/gradle.properties
@@ -1,2 +1,2 @@
-version=19.0.2
-latestReleasedVersion=19.0.1
+version=20.1.0
+latestReleasedVersion=20.0.0
diff --git a/firebase-firestore/ktx/ktx.gradle b/firebase-firestore/ktx/ktx.gradle
index cad7aece2d9..ffbfb8f652f 100644
--- a/firebase-firestore/ktx/ktx.gradle
+++ b/firebase-firestore/ktx/ktx.gradle
@@ -19,10 +19,11 @@ plugins {
firebaseLibrary {
releaseWith project(':firebase-firestore')
+ publishSources = true
}
android {
- compileSdkVersion project.targetSdkVersion
+ compileSdkVersion 28
defaultConfig {
minSdkVersion project.minSdkVersion
multiDexEnabled true
@@ -33,21 +34,22 @@ android {
main.java.srcDirs += 'src/main/kotlin'
test.java {
srcDir 'src/test/kotlin'
- srcDir '../src/testUtil/java'
- srcDir '../src/roboUtil/java'
+ srcDir 'src/test/java'
}
}
testOptions.unitTests.includeAndroidResources = true
+ compileOptions {
+ sourceCompatibility JavaVersion.VERSION_1_8
+ targetCompatibility JavaVersion.VERSION_1_8
+ }
}
dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion"
-
implementation project(':firebase-common')
implementation project(':firebase-common:ktx')
implementation project(':firebase-firestore')
implementation 'androidx.annotation:annotation:1.1.0'
-
testImplementation project(':firebase-database-collection')
testImplementation 'org.mockito:mockito-core:2.25.0'
testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.9.8'
diff --git a/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestAccessHelper.java b/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestAccessHelper.java
new file mode 100644
index 00000000000..bab88979493
--- /dev/null
+++ b/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestAccessHelper.java
@@ -0,0 +1,31 @@
+// Copyright 2018 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore;
+
+import com.google.firebase.firestore.model.DocumentKey;
+
+public final class TestAccessHelper {
+
+ /** Makes the DocumentReference constructor accessible. */
+ public static DocumentReference createDocumentReference(DocumentKey documentKey) {
+ // We can use null here because the tests only use this as a wrapper for documentKeys.
+ return new DocumentReference(documentKey, null);
+ }
+
+ /** Makes the getKey() method accessible. */
+ public static DocumentKey referenceKey(DocumentReference documentReference) {
+ return documentReference.getKey();
+ }
+}
diff --git a/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestUtil.java b/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestUtil.java
new file mode 100644
index 00000000000..d2d032ea3ae
--- /dev/null
+++ b/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/TestUtil.java
@@ -0,0 +1,179 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore;
+
+import static com.google.firebase.firestore.testutil.TestUtil.doc;
+import static com.google.firebase.firestore.testutil.TestUtil.docSet;
+import static com.google.firebase.firestore.testutil.TestUtil.key;
+import static org.mockito.Mockito.mock;
+
+import androidx.annotation.Nullable;
+import com.google.android.gms.tasks.Task;
+import com.google.firebase.database.collection.ImmutableSortedSet;
+import com.google.firebase.firestore.core.DocumentViewChange;
+import com.google.firebase.firestore.core.DocumentViewChange.Type;
+import com.google.firebase.firestore.core.ViewSnapshot;
+import com.google.firebase.firestore.local.QueryData;
+import com.google.firebase.firestore.model.Document;
+import com.google.firebase.firestore.model.DocumentKey;
+import com.google.firebase.firestore.model.DocumentSet;
+import com.google.firebase.firestore.model.ResourcePath;
+import com.google.firebase.firestore.model.value.ObjectValue;
+import com.google.firebase.firestore.remote.WatchChangeAggregator;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import org.junit.Assert;
+import org.robolectric.Robolectric;
+
+public class TestUtil {
+
+ private static final FirebaseFirestore FIRESTORE = mock(FirebaseFirestore.class);
+
+ public static FirebaseFirestore firestore() {
+ return FIRESTORE;
+ }
+
+ public static CollectionReference collectionReference(String path) {
+ return new CollectionReference(ResourcePath.fromString(path), FIRESTORE);
+ }
+
+ public static DocumentReference documentReference(String path) {
+ return new DocumentReference(key(path), FIRESTORE);
+ }
+
+ public static DocumentSnapshot documentSnapshot(
+ String path, Map data, boolean isFromCache) {
+ if (data == null) {
+ return DocumentSnapshot.fromNoDocument(
+ FIRESTORE, key(path), isFromCache, /*hasPendingWrites=*/ false);
+ } else {
+ return DocumentSnapshot.fromDocument(
+ FIRESTORE, doc(path, 1L, data), isFromCache, /*hasPendingWrites=*/ false);
+ }
+ }
+
+ public static Query query(String path) {
+ return new Query(com.google.firebase.firestore.testutil.TestUtil.query(path), FIRESTORE);
+ }
+
+ /**
+ * A convenience method for creating a particular query snapshot for tests.
+ *
+ * @param path To be used in constructing the query.
+ * @param oldDocs Provides the prior set of documents in the QuerySnapshot. Each entry maps to a
+ * document, with the key being the document id, and the value being the document contents.
+ * @param docsToAdd Specifies data to be added into the query snapshot as of now. Each entry maps
+ * to a document, with the key being the document id, and the value being the document
+ * contents.
+ * @param isFromCache Whether the query snapshot is cache result.
+ * @return A query snapshot that consists of both sets of documents.
+ */
+ public static QuerySnapshot querySnapshot(
+ String path,
+ Map oldDocs,
+ Map docsToAdd,
+ boolean hasPendingWrites,
+ boolean isFromCache) {
+ DocumentSet oldDocuments = docSet(Document.keyComparator());
+ ImmutableSortedSet mutatedKeys = DocumentKey.emptyKeySet();
+ for (Map.Entry pair : oldDocs.entrySet()) {
+ String docKey = path + "/" + pair.getKey();
+ oldDocuments =
+ oldDocuments.add(
+ doc(
+ docKey,
+ 1L,
+ pair.getValue(),
+ hasPendingWrites
+ ? Document.DocumentState.SYNCED
+ : Document.DocumentState.LOCAL_MUTATIONS));
+
+ if (hasPendingWrites) {
+ mutatedKeys = mutatedKeys.insert(key(docKey));
+ }
+ }
+ DocumentSet newDocuments = docSet(Document.keyComparator());
+ List documentChanges = new ArrayList<>();
+ for (Map.Entry pair : docsToAdd.entrySet()) {
+ String docKey = path + "/" + pair.getKey();
+ Document docToAdd =
+ doc(
+ docKey,
+ 1L,
+ pair.getValue(),
+ hasPendingWrites
+ ? Document.DocumentState.SYNCED
+ : Document.DocumentState.LOCAL_MUTATIONS);
+ newDocuments = newDocuments.add(docToAdd);
+ documentChanges.add(DocumentViewChange.create(Type.ADDED, docToAdd));
+
+ if (hasPendingWrites) {
+ mutatedKeys = mutatedKeys.insert(key(docKey));
+ }
+ }
+ ViewSnapshot viewSnapshot =
+ new ViewSnapshot(
+ com.google.firebase.firestore.testutil.TestUtil.query(path),
+ newDocuments,
+ oldDocuments,
+ documentChanges,
+ isFromCache,
+ mutatedKeys,
+ true,
+ /* excludesMetadataChanges= */ false);
+ return new QuerySnapshot(query(path), viewSnapshot, FIRESTORE);
+ }
+
+ /**
+ * An implementation of TargetMetadataProvider that provides controlled access to the
+ * `TargetMetadataProvider` callbacks. Any target accessed via these callbacks must be registered
+ * beforehand via `setSyncedKeys()`.
+ */
+ public static class TestTargetMetadataProvider
+ implements WatchChangeAggregator.TargetMetadataProvider {
+ final Map> syncedKeys = new HashMap<>();
+ final Map queryData = new HashMap<>();
+
+ @Override
+ public ImmutableSortedSet getRemoteKeysForTarget(int targetId) {
+ return syncedKeys.get(targetId) != null
+ ? syncedKeys.get(targetId)
+ : DocumentKey.emptyKeySet();
+ }
+
+ @Nullable
+ @Override
+ public QueryData getQueryDataForTarget(int targetId) {
+ return queryData.get(targetId);
+ }
+
+ /** Sets or replaces the local state for the provided query data. */
+ public void setSyncedKeys(QueryData queryData, ImmutableSortedSet keys) {
+ this.queryData.put(queryData.getTargetId(), queryData);
+ this.syncedKeys.put(queryData.getTargetId(), keys);
+ }
+ }
+
+ public static T waitFor(Task task) {
+ if (!task.isComplete()) {
+ Robolectric.flushBackgroundThreadScheduler();
+ }
+ Assert.assertTrue(
+ "Expected task to be completed after background thread flush", task.isComplete());
+ return task.getResult();
+ }
+}
diff --git a/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/testutil/TestUtil.java b/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/testutil/TestUtil.java
new file mode 100644
index 00000000000..c2ce41b0d8a
--- /dev/null
+++ b/firebase-firestore/ktx/src/test/java/com/google/firebase/firestore/testutil/TestUtil.java
@@ -0,0 +1,618 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore.testutil;
+
+import static com.google.common.truth.Truth.assertThat;
+import static java.util.Arrays.asList;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.fail;
+
+import androidx.annotation.NonNull;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.base.Charsets;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Sets;
+import com.google.firebase.Timestamp;
+import com.google.firebase.database.collection.ImmutableSortedMap;
+import com.google.firebase.database.collection.ImmutableSortedSet;
+import com.google.firebase.firestore.Blob;
+import com.google.firebase.firestore.DocumentReference;
+import com.google.firebase.firestore.TestAccessHelper;
+import com.google.firebase.firestore.UserDataConverter;
+import com.google.firebase.firestore.core.Filter;
+import com.google.firebase.firestore.core.Filter.Operator;
+import com.google.firebase.firestore.core.OrderBy;
+import com.google.firebase.firestore.core.OrderBy.Direction;
+import com.google.firebase.firestore.core.Query;
+import com.google.firebase.firestore.core.UserData.ParsedUpdateData;
+import com.google.firebase.firestore.local.LocalViewChanges;
+import com.google.firebase.firestore.local.QueryData;
+import com.google.firebase.firestore.local.QueryPurpose;
+import com.google.firebase.firestore.model.DatabaseId;
+import com.google.firebase.firestore.model.Document;
+import com.google.firebase.firestore.model.DocumentKey;
+import com.google.firebase.firestore.model.DocumentSet;
+import com.google.firebase.firestore.model.FieldPath;
+import com.google.firebase.firestore.model.MaybeDocument;
+import com.google.firebase.firestore.model.NoDocument;
+import com.google.firebase.firestore.model.ResourcePath;
+import com.google.firebase.firestore.model.SnapshotVersion;
+import com.google.firebase.firestore.model.UnknownDocument;
+import com.google.firebase.firestore.model.mutation.DeleteMutation;
+import com.google.firebase.firestore.model.mutation.FieldMask;
+import com.google.firebase.firestore.model.mutation.FieldTransform;
+import com.google.firebase.firestore.model.mutation.MutationResult;
+import com.google.firebase.firestore.model.mutation.PatchMutation;
+import com.google.firebase.firestore.model.mutation.Precondition;
+import com.google.firebase.firestore.model.mutation.SetMutation;
+import com.google.firebase.firestore.model.mutation.TransformMutation;
+import com.google.firebase.firestore.model.value.FieldValue;
+import com.google.firebase.firestore.model.value.ObjectValue;
+import com.google.firebase.firestore.remote.RemoteEvent;
+import com.google.firebase.firestore.remote.TargetChange;
+import com.google.firebase.firestore.remote.WatchChange.DocumentChange;
+import com.google.firebase.firestore.remote.WatchChangeAggregator;
+import com.google.protobuf.ByteString;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
+import javax.annotation.Nullable;
+
+/** A set of utilities for tests */
+public class TestUtil {
+
+ /** A string sentinel that can be used with patchMutation() to mark a field for deletion. */
+ public static final String DELETE_SENTINEL = "";
+
+ public static final long ARBITRARY_SEQUENCE_NUMBER = 2;
+
+ @SuppressWarnings("unchecked")
+ public static Map map(Object... entries) {
+ Map res = new HashMap<>();
+ for (int i = 0; i < entries.length; i += 2) {
+ res.put((String) entries[i], (T) entries[i + 1]);
+ }
+ return res;
+ }
+
+ public static Blob blob(int... bytes) {
+ return Blob.fromByteString(byteString(bytes));
+ }
+
+ public static ByteString byteString(int... bytes) {
+ byte[] primitive = new byte[bytes.length];
+ for (int i = 0; i < bytes.length; i++) {
+ primitive[i] = (byte) bytes[i];
+ }
+ return ByteString.copyFrom(primitive);
+ }
+
+ public static FieldMask fieldMask(String... fields) {
+ FieldPath[] mask = new FieldPath[fields.length];
+ for (int i = 0; i < fields.length; i++) {
+ mask[i] = field(fields[i]);
+ }
+ return FieldMask.fromSet(new HashSet<>(Arrays.asList(mask)));
+ }
+
+ public static final Map EMPTY_MAP = new HashMap<>();
+
+ public static FieldValue wrap(Object value) {
+ DatabaseId databaseId = DatabaseId.forProject("project");
+ UserDataConverter dataConverter = new UserDataConverter(databaseId);
+ // HACK: We use parseQueryValue() since it accepts scalars as well as arrays / objects, and
+ // our tests currently use wrap() pretty generically so we don't know the intent.
+ return dataConverter.parseQueryValue(value);
+ }
+
+ public static ObjectValue wrapObject(Map value) {
+ // Cast is safe here because value passed in is a map
+ return (ObjectValue) wrap(value);
+ }
+
+ public static ObjectValue wrapObject(Object... entries) {
+ return wrapObject(map(entries));
+ }
+
+ public static DocumentKey key(String key) {
+ return DocumentKey.fromPathString(key);
+ }
+
+ public static ResourcePath path(String key) {
+ return ResourcePath.fromString(key);
+ }
+
+ public static Query query(String path) {
+ return Query.atPath(path(path));
+ }
+
+ public static FieldPath field(String path) {
+ return FieldPath.fromSegments(Arrays.asList(path.split("\\.")));
+ }
+
+ public static DocumentReference ref(String key) {
+ return TestAccessHelper.createDocumentReference(key(key));
+ }
+
+ public static DatabaseId dbId(String project, String database) {
+ return DatabaseId.forDatabase(project, database);
+ }
+
+ public static DatabaseId dbId(String project) {
+ return DatabaseId.forProject(project);
+ }
+
+ public static SnapshotVersion version(long versionMicros) {
+ long seconds = versionMicros / 1000000;
+ int nanos = (int) (versionMicros % 1000000L) * 1000;
+ return new SnapshotVersion(new Timestamp(seconds, nanos));
+ }
+
+ public static Document doc(String key, long version, Map data) {
+ return new Document(
+ key(key), version(version), wrapObject(data), Document.DocumentState.SYNCED);
+ }
+
+ public static Document doc(DocumentKey key, long version, Map data) {
+ return new Document(key, version(version), wrapObject(data), Document.DocumentState.SYNCED);
+ }
+
+ public static Document doc(
+ String key, long version, ObjectValue data, Document.DocumentState documentState) {
+ return new Document(key(key), version(version), data, documentState);
+ }
+
+ public static Document doc(
+ String key, long version, Map data, Document.DocumentState documentState) {
+ return new Document(key(key), version(version), wrapObject(data), documentState);
+ }
+
+ public static NoDocument deletedDoc(String key, long version) {
+ return deletedDoc(key, version, /*hasCommittedMutations=*/ false);
+ }
+
+ public static NoDocument deletedDoc(String key, long version, boolean hasCommittedMutations) {
+ return new NoDocument(key(key), version(version), hasCommittedMutations);
+ }
+
+ public static UnknownDocument unknownDoc(String key, long version) {
+ return new UnknownDocument(key(key), version(version));
+ }
+
+ public static DocumentSet docSet(Comparator comparator, Document... documents) {
+ DocumentSet set = DocumentSet.emptySet(comparator);
+ for (Document document : documents) {
+ set = set.add(document);
+ }
+ return set;
+ }
+
+ public static ImmutableSortedSet keySet(DocumentKey... keys) {
+ ImmutableSortedSet keySet = DocumentKey.emptyKeySet();
+ for (DocumentKey key : keys) {
+ keySet = keySet.insert(key);
+ }
+ return keySet;
+ }
+
+ public static Filter filter(String key, String operator, Object value) {
+ return Filter.create(field(key), operatorFromString(operator), wrap(value));
+ }
+
+ public static Operator operatorFromString(String s) {
+ if (s.equals("<")) {
+ return Operator.LESS_THAN;
+ } else if (s.equals("<=")) {
+ return Operator.LESS_THAN_OR_EQUAL;
+ } else if (s.equals("==")) {
+ return Operator.EQUAL;
+ } else if (s.equals(">")) {
+ return Operator.GREATER_THAN;
+ } else if (s.equals(">=")) {
+ return Operator.GREATER_THAN_OR_EQUAL;
+ } else if (s.equals("array-contains")) {
+ return Operator.ARRAY_CONTAINS;
+ } else {
+ throw new IllegalStateException("Unknown operator: " + s);
+ }
+ }
+
+ public static OrderBy orderBy(String key) {
+ return orderBy(key, "asc");
+ }
+
+ public static OrderBy orderBy(String key, String dir) {
+ Direction direction;
+ if (dir.equals("asc")) {
+ direction = Direction.ASCENDING;
+ } else if (dir.equals("desc")) {
+ direction = Direction.DESCENDING;
+ } else {
+ throw new IllegalArgumentException("Unknown direction: " + dir);
+ }
+ return OrderBy.getInstance(direction, field(key));
+ }
+
+ public static void testEquality(List> equalityGroups) {
+ for (int i = 0; i < equalityGroups.size(); i++) {
+ List group = equalityGroups.get(i);
+ for (Object value : group) {
+ for (List otherGroup : equalityGroups) {
+ for (Object otherValue : otherGroup) {
+ if (otherGroup == group) {
+ assertEquals(value, otherValue);
+ } else {
+ assertNotEquals(value, otherValue);
+ }
+ }
+ }
+ }
+ }
+ }
+
+ public static QueryData queryData(int targetId, QueryPurpose queryPurpose, String path) {
+ return new QueryData(query(path), targetId, ARBITRARY_SEQUENCE_NUMBER, queryPurpose);
+ }
+
+ public static ImmutableSortedMap docUpdates(MaybeDocument... docs) {
+ ImmutableSortedMap res =
+ ImmutableSortedMap.Builder.emptyMap(DocumentKey.comparator());
+ for (MaybeDocument doc : docs) {
+ res = res.insert(doc.getKey(), doc);
+ }
+ return res;
+ }
+
+ public static ImmutableSortedMap docUpdates(Document... docs) {
+ ImmutableSortedMap res =
+ ImmutableSortedMap.Builder.emptyMap(DocumentKey.comparator());
+ for (Document doc : docs) {
+ res = res.insert(doc.getKey(), doc);
+ }
+ return res;
+ }
+
+ public static TargetChange targetChange(
+ ByteString resumeToken,
+ boolean current,
+ @Nullable Collection addedDocuments,
+ @Nullable Collection modifiedDocuments,
+ @Nullable Collection removedDocuments) {
+ ImmutableSortedSet addedDocumentKeys = DocumentKey.emptyKeySet();
+ ImmutableSortedSet modifiedDocumentKeys = DocumentKey.emptyKeySet();
+ ImmutableSortedSet removedDocumentKeys = DocumentKey.emptyKeySet();
+
+ if (addedDocuments != null) {
+ for (Document document : addedDocuments) {
+ addedDocumentKeys = addedDocumentKeys.insert(document.getKey());
+ }
+ }
+
+ if (modifiedDocuments != null) {
+ for (Document document : modifiedDocuments) {
+ modifiedDocumentKeys = modifiedDocumentKeys.insert(document.getKey());
+ }
+ }
+
+ if (removedDocuments != null) {
+ for (MaybeDocument document : removedDocuments) {
+ removedDocumentKeys = removedDocumentKeys.insert(document.getKey());
+ }
+ }
+
+ return new TargetChange(
+ resumeToken, current, addedDocumentKeys, modifiedDocumentKeys, removedDocumentKeys);
+ }
+
+ public static TargetChange ackTarget(Document... docs) {
+ return targetChange(ByteString.EMPTY, true, Arrays.asList(docs), null, null);
+ }
+
+ public static Map activeQueries(Iterable targets) {
+ Query query = query("foo");
+ Map listenMap = new HashMap<>();
+ for (Integer targetId : targets) {
+ QueryData queryData =
+ new QueryData(query, targetId, ARBITRARY_SEQUENCE_NUMBER, QueryPurpose.LISTEN);
+ listenMap.put(targetId, queryData);
+ }
+ return listenMap;
+ }
+
+ public static Map activeQueries(Integer... targets) {
+ return activeQueries(asList(targets));
+ }
+
+ public static Map activeLimboQueries(
+ String docKey, Iterable targets) {
+ Query query = query(docKey);
+ Map listenMap = new HashMap<>();
+ for (Integer targetId : targets) {
+ QueryData queryData =
+ new QueryData(query, targetId, ARBITRARY_SEQUENCE_NUMBER, QueryPurpose.LIMBO_RESOLUTION);
+ listenMap.put(targetId, queryData);
+ }
+ return listenMap;
+ }
+
+ public static Map activeLimboQueries(String docKey, Integer... targets) {
+ return activeLimboQueries(docKey, asList(targets));
+ }
+
+ public static RemoteEvent addedRemoteEvent(
+ MaybeDocument doc, List updatedInTargets, List removedFromTargets) {
+ DocumentChange change =
+ new DocumentChange(updatedInTargets, removedFromTargets, doc.getKey(), doc);
+ WatchChangeAggregator aggregator =
+ new WatchChangeAggregator(
+ new WatchChangeAggregator.TargetMetadataProvider() {
+ @Override
+ public ImmutableSortedSet getRemoteKeysForTarget(int targetId) {
+ return DocumentKey.emptyKeySet();
+ }
+
+ @Override
+ public QueryData getQueryDataForTarget(int targetId) {
+ return queryData(targetId, QueryPurpose.LISTEN, doc.getKey().toString());
+ }
+ });
+ aggregator.handleDocumentChange(change);
+ return aggregator.createRemoteEvent(doc.getVersion());
+ }
+
+ public static RemoteEvent updateRemoteEvent(
+ MaybeDocument doc, List updatedInTargets, List removedFromTargets) {
+ return updateRemoteEvent(doc, updatedInTargets, removedFromTargets, Collections.emptyList());
+ }
+
+ public static RemoteEvent updateRemoteEvent(
+ MaybeDocument doc,
+ List updatedInTargets,
+ List removedFromTargets,
+ List limboTargets) {
+ DocumentChange change =
+ new DocumentChange(updatedInTargets, removedFromTargets, doc.getKey(), doc);
+ WatchChangeAggregator aggregator =
+ new WatchChangeAggregator(
+ new WatchChangeAggregator.TargetMetadataProvider() {
+ @Override
+ public ImmutableSortedSet getRemoteKeysForTarget(int targetId) {
+ return DocumentKey.emptyKeySet().insert(doc.getKey());
+ }
+
+ @Override
+ public QueryData getQueryDataForTarget(int targetId) {
+ boolean isLimbo =
+ !(updatedInTargets.contains(targetId) || removedFromTargets.contains(targetId));
+ QueryPurpose purpose =
+ isLimbo ? QueryPurpose.LIMBO_RESOLUTION : QueryPurpose.LISTEN;
+ return queryData(targetId, purpose, doc.getKey().toString());
+ }
+ });
+ aggregator.handleDocumentChange(change);
+ return aggregator.createRemoteEvent(doc.getVersion());
+ }
+
+ public static SetMutation setMutation(String path, Map values) {
+ return new SetMutation(key(path), wrapObject(values), Precondition.NONE);
+ }
+
+ public static PatchMutation patchMutation(String path, Map values) {
+ return patchMutation(path, values, null);
+ }
+
+ public static PatchMutation patchMutation(
+ String path, Map values, @Nullable List updateMask) {
+ ObjectValue objectValue = ObjectValue.emptyObject();
+ ArrayList objectMask = new ArrayList<>();
+ for (Entry entry : values.entrySet()) {
+ FieldPath fieldPath = field(entry.getKey());
+ objectMask.add(fieldPath);
+ if (!entry.getValue().equals(DELETE_SENTINEL)) {
+ FieldValue parsedValue = wrap(entry.getValue());
+ objectValue = objectValue.set(fieldPath, parsedValue);
+ }
+ }
+
+ boolean merge = updateMask != null;
+
+ // We sort the fieldMaskPaths to make the order deterministic in tests. (Otherwise, when we
+ // flatten a Set to a proto repeated field, we'll end up comparing in iterator order and
+ // possibly consider {foo,bar} != {bar,foo}.)
+ SortedSet fieldMaskPaths = new TreeSet<>(merge ? updateMask : objectMask);
+
+ return new PatchMutation(
+ key(path),
+ objectValue,
+ FieldMask.fromSet(fieldMaskPaths),
+ merge ? Precondition.NONE : Precondition.exists(true));
+ }
+
+ public static DeleteMutation deleteMutation(String path) {
+ return new DeleteMutation(key(path), Precondition.NONE);
+ }
+
+ /**
+ * Creates a TransformMutation by parsing any FieldValue sentinels in the provided data. The data
+ * is expected to use dotted-notation for nested fields (i.e. { "foo.bar": FieldValue.foo() } and
+ * must not contain any non-sentinel data.
+ */
+ public static TransformMutation transformMutation(String path, Map data) {
+ UserDataConverter dataConverter = new UserDataConverter(DatabaseId.forProject("project"));
+ ParsedUpdateData result = dataConverter.parseUpdateData(data);
+
+ // The order of the transforms doesn't matter, but we sort them so tests can assume a particular
+ // order.
+ ArrayList fieldTransforms = new ArrayList<>(result.getFieldTransforms());
+ Collections.sort(
+ fieldTransforms, (ft1, ft2) -> ft1.getFieldPath().compareTo(ft2.getFieldPath()));
+
+ return new TransformMutation(key(path), fieldTransforms);
+ }
+
+ public static MutationResult mutationResult(long version) {
+ return new MutationResult(version(version), null);
+ }
+
+ public static LocalViewChanges viewChanges(
+ int targetId, List addedKeys, List removedKeys) {
+ ImmutableSortedSet added = DocumentKey.emptyKeySet();
+ for (String keyPath : addedKeys) {
+ added = added.insert(key(keyPath));
+ }
+ ImmutableSortedSet removed = DocumentKey.emptyKeySet();
+ for (String keyPath : removedKeys) {
+ removed = removed.insert(key(keyPath));
+ }
+ return new LocalViewChanges(targetId, added, removed);
+ }
+
+ /** Creates a resume token to match the given snapshot version. */
+ @Nullable
+ public static ByteString resumeToken(long snapshotVersion) {
+ if (snapshotVersion == 0) {
+ return null;
+ }
+
+ String snapshotString = "snapshot-" + snapshotVersion;
+ return ByteString.copyFrom(snapshotString, Charsets.UTF_8);
+ }
+
+ @NonNull
+ private static ByteString resumeToken(SnapshotVersion snapshotVersion) {
+ if (snapshotVersion.equals(SnapshotVersion.NONE)) {
+ return ByteString.EMPTY;
+ } else {
+ return ByteString.copyFromUtf8(snapshotVersion.toString());
+ }
+ }
+
+ public static ByteString streamToken(String contents) {
+ return ByteString.copyFrom(contents, Charsets.UTF_8);
+ }
+
+ private static Map fromJsonString(String json) {
+ try {
+ ObjectMapper mapper = new ObjectMapper();
+ return mapper.readValue(json, new TypeReference>() {});
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ public static Map fromSingleQuotedString(String json) {
+ return fromJsonString(json.replace("'", "\""));
+ }
+
+ /** Converts the values of an ImmutableSortedMap into a list, preserving key order. */
+ public static List values(ImmutableSortedMap map) {
+ List result = new ArrayList<>();
+ for (Map.Entry entry : map) {
+ result.add(entry.getValue());
+ }
+ return result;
+ }
+
+ /**
+ * Asserts that the actual set is equal to the expected one.
+ *
+ * @param expected A list of the expected contents of the set, in order.
+ * @param actual The set to compare against.
+ * @param The type of the values of in common between the expected list and actual set.
+ */
+ // PORTING NOTE: JUnit and XCTest use reversed conventions on expected and actual values :-(.
+ public static void assertSetEquals(List expected, ImmutableSortedSet actual) {
+ List actualList = Lists.newArrayList(actual);
+ assertEquals(expected, actualList);
+ }
+
+ /**
+ * Asserts that the actual set is equal to the expected one.
+ *
+ * @param expected A list of the expected contents of the set, in order.
+ * @param actual The set to compare against.
+ * @param The type of the values of in common between the expected list and actual set.
+ */
+ // PORTING NOTE: JUnit and XCTest use reversed conventions on expected and actual values :-(.
+ public static void assertSetEquals(List expected, Set actual) {
+ Set expectedSet = Sets.newHashSet(expected);
+ assertEquals(expectedSet, actual);
+ }
+
+ /** Asserts that the given runnable block fails with an internal error. */
+ public static void assertFails(Runnable block) {
+ try {
+ block.run();
+ } catch (AssertionError e) {
+ assertThat(e).hasMessageThat().startsWith("INTERNAL ASSERTION FAILED:");
+ // Otherwise success
+ return;
+ }
+ fail("Should have failed");
+ }
+
+ public static void assertDoesNotThrow(Runnable block) {
+ try {
+ block.run();
+ } catch (Exception e) {
+ fail("Should not have thrown " + e);
+ }
+ }
+
+ // TODO: We could probably do some de-duplication between assertFails / expectError.
+ /** Expects runnable to throw an exception with a specific error message. */
+ public static void expectError(Runnable runnable, String exceptionMessage) {
+ expectError(runnable, exceptionMessage, /*context=*/ null);
+ }
+
+ /**
+ * Expects runnable to throw an exception with a specific error message. An optional context (e.g.
+ * "for bad_data") can be provided which will be displayed in any resulting failure message.
+ */
+ public static void expectError(Runnable runnable, String exceptionMessage, String context) {
+ boolean exceptionThrown = false;
+ try {
+ runnable.run();
+ } catch (Throwable throwable) {
+ exceptionThrown = true;
+ String contextMessage = "Expected exception message was incorrect";
+ if (context != null) {
+ contextMessage += " (" + context + ")";
+ }
+ assertEquals(contextMessage, exceptionMessage, throwable.getMessage());
+ }
+ if (!exceptionThrown) {
+ context = (context == null) ? "" : context;
+ fail(
+ "Expected exception with message '"
+ + exceptionMessage
+ + "' but no exception was thrown"
+ + context);
+ }
+ }
+}
diff --git a/firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ValidationTest.java b/firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ValidationTest.java
index 1990f7ccf06..8ce172c91f7 100644
--- a/firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ValidationTest.java
+++ b/firebase-firestore/src/androidTest/java/com/google/firebase/firestore/ValidationTest.java
@@ -332,11 +332,7 @@ public void fieldPathsMustNotHaveInvalidSegments() {
List badFieldPaths =
asList("foo~bar", "foo*bar", "foo/bar", "foo[1", "foo]1", "foo[1]");
for (String fieldPath : badFieldPaths) {
- String reason =
- "Invalid field path ("
- + fieldPath
- + "). Paths must not contain '~', '*', '/', '[', or ']'";
- verifyFieldPathThrows(fieldPath, reason);
+ verifyFieldPathThrows(fieldPath, "Use FieldPath.of() for field names containing '~*/[]'.");
}
}
diff --git a/firebase-firestore/src/main/java/com/google/firebase/firestore/FieldPath.java b/firebase-firestore/src/main/java/com/google/firebase/firestore/FieldPath.java
index af3360926c3..ee8c1bc51ec 100644
--- a/firebase-firestore/src/main/java/com/google/firebase/firestore/FieldPath.java
+++ b/firebase-firestore/src/main/java/com/google/firebase/firestore/FieldPath.java
@@ -84,8 +84,7 @@ public static FieldPath documentId() {
static FieldPath fromDotSeparatedPath(@NonNull String path) {
checkNotNull(path, "Provided field path must not be null.");
checkArgument(
- !RESERVED.matcher(path).find(),
- "Invalid field path (" + path + "). Paths must not contain '~', '*', '/', '[', or ']'");
+ !RESERVED.matcher(path).find(), "Use FieldPath.of() for field names containing '~*/[]'.");
try {
// By default, split() doesn't return empty leading and trailing segments. This can be enabled
// by passing "-1" as the limit.
diff --git a/firebase-functions/firebase-functions.gradle b/firebase-functions/firebase-functions.gradle
index 64d888dd000..dce829719ba 100644
--- a/firebase-functions/firebase-functions.gradle
+++ b/firebase-functions/firebase-functions.gradle
@@ -29,7 +29,7 @@ android {
compileSdkVersion project.targetSdkVersion
defaultConfig {
targetSdkVersion project.targetSdkVersion
- minSdkVersion project.minSdkVersion
+ minSdkVersion 16
versionName version
multiDexEnabled true
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -50,16 +50,16 @@ android {
dependencies {
implementation project(':firebase-common')
- implementation 'com.google.android.gms:play-services-basement:16.2.0'
- implementation 'com.google.android.gms:play-services-base:16.1.0'
- implementation 'com.google.android.gms:play-services-tasks:16.0.1'
- implementation ('com.google.firebase:firebase-iid:17.0.3') {
+ implementation 'com.google.android.gms:play-services-basement:17.0.0'
+ implementation 'com.google.android.gms:play-services-base:17.0.0'
+ implementation 'com.google.android.gms:play-services-tasks:17.0.0'
+ implementation ('com.google.firebase:firebase-iid:19.0.0') {
exclude group: 'com.google.firebase', module: 'firebase-common'
}
implementation ('com.google.firebase:firebase-auth-interop:17.0.0') {
exclude group: 'com.google.firebase', module: 'firebase-common'
}
- implementation 'com.google.firebase:firebase-iid-interop:16.0.1'
+ implementation 'com.google.firebase:firebase-iid-interop:17.0.0'
implementation 'com.squareup.okhttp3:okhttp:3.12.1'
diff --git a/firebase-functions/gradle.properties b/firebase-functions/gradle.properties
index 4c7da9c1258..904cf7b5e5a 100644
--- a/firebase-functions/gradle.properties
+++ b/firebase-functions/gradle.properties
@@ -1,3 +1,3 @@
-version=16.3.1
-latestReleasedVersion=16.3.0
+version=18.0.1
+latestReleasedVersion=18.0.0
android.enableUnitTestBinaryResources=true
diff --git a/firebase-functions/ktx/ktx.gradle b/firebase-functions/ktx/ktx.gradle
index 48a014c76ae..f2ce73b2641 100644
--- a/firebase-functions/ktx/ktx.gradle
+++ b/firebase-functions/ktx/ktx.gradle
@@ -27,7 +27,7 @@ firebaseLibrary {
android {
compileSdkVersion project.targetSdkVersion
defaultConfig {
- minSdkVersion project.minSdkVersion
+ minSdkVersion 16
multiDexEnabled true
targetSdkVersion project.targetSdkVersion
versionName version
@@ -50,7 +50,7 @@ dependencies {
implementation project(':firebase-common:ktx')
implementation project(':firebase-functions')
implementation 'androidx.annotation:annotation:1.1.0'
- implementation 'com.google.android.gms:play-services-tasks:16.0.1'
+ implementation 'com.google.android.gms:play-services-tasks:17.0.0'
androidTestImplementation 'junit:junit:4.12'
androidTestImplementation "com.google.truth:truth:$googleTruthVersion"
diff --git a/firebase-functions/ktx/src/androidTest/AndroidManifest.xml b/firebase-functions/ktx/src/androidTest/AndroidManifest.xml
index 53cd9caa09e..e00dc0c7ec9 100644
--- a/firebase-functions/ktx/src/androidTest/AndroidManifest.xml
+++ b/firebase-functions/ktx/src/androidTest/AndroidManifest.xml
@@ -1,7 +1,7 @@
-
+
diff --git a/firebase-functions/ktx/src/main/AndroidManifest.xml b/firebase-functions/ktx/src/main/AndroidManifest.xml
index 8eda8b99bae..bcdb806609a 100644
--- a/firebase-functions/ktx/src/main/AndroidManifest.xml
+++ b/firebase-functions/ktx/src/main/AndroidManifest.xml
@@ -2,7 +2,7 @@
-
+
-
+
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index 88ea12a1ed0..dc4606715c5 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/firebase-segmentation/firebase-segmentation.gradle
@@ -91,12 +91,17 @@ dependencies {
implementation 'androidx.multidex:multidex:2.0.0'
implementation 'com.google.android.gms:play-services-tasks:16.0.1'
+ compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
+ annotationProcessor "com.google.auto.value:auto-value:1.6.2"
+
testImplementation 'androidx.test:core:1.2.0'
testImplementation 'junit:junit:4.12'
testImplementation "org.robolectric:robolectric:$robolectricVersion"
- androidTestImplementation 'androidx.annotation:annotation:1.1.0'
- androidTestImplementation 'androidx.test:runner:1.2.0'
- androidTestImplementation 'androidx.test:rules:1.2.0'
+ androidTestImplementation "androidx.annotation:annotation:1.1.0"
androidTestImplementation 'androidx.test.ext:junit:1.1.1'
+ androidTestImplementation 'androidx.test:rules:1.2.0'
+ androidTestImplementation 'androidx.test:runner:1.2.0'
+ androidTestImplementation "com.google.truth:truth:$googleTruthVersion"
+ androidTestImplementation 'junit:junit:4.12'
}
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
new file mode 100644
index 00000000000..5783294cfa3
--- /dev/null
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
@@ -0,0 +1,91 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import androidx.test.InstrumentationRegistry;
+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;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/** Instrumented tests for {@link CustomInstallationIdCache} */
+@RunWith(AndroidJUnit4.class)
+public class CustomInstallationIdCacheTest {
+
+ private FirebaseApp firebaseApp0;
+ private FirebaseApp firebaseApp1;
+ private CustomInstallationIdCache cache;
+
+ @Before
+ public void setUp() {
+ FirebaseApp.clearInstancesForTest();
+ firebaseApp0 =
+ FirebaseApp.initializeApp(
+ InstrumentationRegistry.getContext(),
+ new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
+ firebaseApp1 =
+ FirebaseApp.initializeApp(
+ InstrumentationRegistry.getContext(),
+ new FirebaseOptions.Builder().setApplicationId("1:987654321:android:abcdef").build(),
+ "firebase_app_1");
+ cache = CustomInstallationIdCache.getInstance();
+ }
+
+ @After
+ public void cleanUp() throws Exception {
+ Tasks.await(cache.clearAll());
+ }
+
+ @Test
+ public void testReadCacheEntry_Null() {
+ assertNull(cache.readCacheEntryValue(firebaseApp0));
+ assertNull(cache.readCacheEntryValue(firebaseApp1));
+ }
+
+ @Test
+ public void testUpdateAndReadCacheEntry() throws Exception {
+ assertTrue(
+ Tasks.await(
+ cache.insertOrUpdateCacheEntry(
+ firebaseApp0,
+ CustomInstallationIdCacheEntryValue.create(
+ "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.PENDING))));
+ CustomInstallationIdCacheEntryValue entryValue = cache.readCacheEntryValue(firebaseApp0);
+ assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
+ assertThat(entryValue.getCacheStatus())
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING);
+ assertNull(cache.readCacheEntryValue(firebaseApp1));
+
+ assertTrue(
+ Tasks.await(
+ cache.insertOrUpdateCacheEntry(
+ firebaseApp0,
+ CustomInstallationIdCacheEntryValue.create(
+ "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED))));
+ entryValue = cache.readCacheEntryValue(firebaseApp0);
+ assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
+ assertThat(entryValue.getCacheStatus()).isEqualTo(CustomInstallationIdCache.CacheStatus.SYNCED);
+ }
+}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
new file mode 100644
index 00000000000..5096a265714
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
@@ -0,0 +1,130 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
+import com.google.android.gms.common.util.Strings;
+import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.TaskCompletionSource;
+import com.google.firebase.FirebaseApp;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Executors;
+
+class CustomInstallationIdCache {
+
+ // Status of each cache entry
+ // NOTE: never change the ordinal of the enum values because the enum values are stored in cache
+ // as their ordinal numbers.
+ enum CacheStatus {
+ // Cache entry is synced to Firebase backend
+ SYNCED,
+ // Cache entry is waiting for Firebase backend response or pending internal retry for retryable
+ // errors.
+ PENDING,
+ // Cache entry is not accepted by Firebase backend.
+ ERROR,
+ }
+
+ private static final String SHARED_PREFS_NAME = "CustomInstallationIdCache";
+
+ private static final String CUSTOM_INSTALLATION_ID_KEY = "Cid";
+ private static final String INSTANCE_ID_KEY = "Iid";
+ private static final String CACHE_STATUS_KEY = "Status";
+
+ private static CustomInstallationIdCache singleton = null;
+ private final Executor ioExecuter;
+ private final SharedPreferences prefs;
+
+ static synchronized CustomInstallationIdCache getInstance() {
+ if (singleton == null) {
+ singleton = new CustomInstallationIdCache();
+ }
+ return singleton;
+ }
+
+ private CustomInstallationIdCache() {
+ // Since different FirebaseApp in the same Android application should have the same application
+ // context and same dir path, so that use the context of the default FirebaseApp to create the
+ // shared preferences.
+ prefs =
+ FirebaseApp.getInstance()
+ .getApplicationContext()
+ .getSharedPreferences(SHARED_PREFS_NAME, Context.MODE_PRIVATE);
+
+ ioExecuter = Executors.newFixedThreadPool(2);
+ }
+
+ @Nullable
+ synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp) {
+ String cid =
+ prefs.getString(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY), null);
+ String iid = prefs.getString(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), null);
+ int status = prefs.getInt(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY), -1);
+
+ if (Strings.isEmptyOrWhitespace(cid) || Strings.isEmptyOrWhitespace(iid) || status == -1) {
+ return null;
+ }
+
+ return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
+ }
+
+ synchronized Task insertOrUpdateCacheEntry(
+ FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.putString(
+ getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY),
+ entryValue.getCustomInstallationId());
+ editor.putString(
+ getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
+ editor.putInt(
+ getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY),
+ entryValue.getCacheStatus().ordinal());
+ return commitSharedPreferencesEditAsync(editor);
+ }
+
+ synchronized Task clear(FirebaseApp firebaseApp) {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.remove(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY));
+ editor.remove(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY));
+ editor.remove(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY));
+ return commitSharedPreferencesEditAsync(editor);
+ }
+
+ @RestrictTo(RestrictTo.Scope.TESTS)
+ synchronized Task clearAll() {
+ SharedPreferences.Editor editor = prefs.edit();
+ editor.clear();
+ return commitSharedPreferencesEditAsync(editor);
+ }
+
+ private static String getSharedPreferencesKey(FirebaseApp firebaseApp, String key) {
+ return String.format("%s|%s", firebaseApp.getPersistenceKey(), key);
+ }
+
+ private Task commitSharedPreferencesEditAsync(SharedPreferences.Editor editor) {
+ TaskCompletionSource result = new TaskCompletionSource();
+ ioExecuter.execute(
+ new Runnable() {
+ @Override
+ public void run() {
+ result.setResult(editor.commit());
+ }
+ });
+ return result.getTask();
+ }
+}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
new file mode 100644
index 00000000000..c79d5f091a9
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
@@ -0,0 +1,37 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import com.google.auto.value.AutoValue;
+import com.google.firebase.segmentation.CustomInstallationIdCache.CacheStatus;
+
+/**
+ * This class represents a cache entry value in {@link CustomInstallationIdCache}, which contains a
+ * Firebase instance id, a custom installation id and the cache status of this entry.
+ */
+@AutoValue
+abstract class CustomInstallationIdCacheEntryValue {
+ abstract String getCustomInstallationId();
+
+ abstract String getFirebaseInstanceId();
+
+ abstract CacheStatus getCacheStatus();
+
+ static CustomInstallationIdCacheEntryValue create(
+ String customInstallationId, String firebaseInstanceId, CacheStatus cacheStatus) {
+ return new AutoValue_CustomInstallationIdCacheEntryValue(
+ customInstallationId, firebaseInstanceId, cacheStatus);
+ }
+}
diff --git a/firebase-storage/firebase-storage.gradle b/firebase-storage/firebase-storage.gradle
index 4abc6369812..2fa2abb6542 100644
--- a/firebase-storage/firebase-storage.gradle
+++ b/firebase-storage/firebase-storage.gradle
@@ -20,6 +20,7 @@ plugins {
firebaseLibrary {
testLab.enabled = true
publishJavadoc = true
+ publishSources = true
}
android {
@@ -76,9 +77,9 @@ android {
dependencies {
implementation project(':firebase-common')
- implementation 'com.google.android.gms:play-services-base:16.1.0'
- implementation 'com.google.android.gms:play-services-tasks:16.0.1'
- implementation('com.google.firebase:firebase-auth-interop:17.0.0') {
+ implementation 'com.google.android.gms:play-services-base:17.0.0'
+ implementation 'com.google.android.gms:play-services-tasks:17.0.0'
+ implementation('com.google.firebase:firebase-auth-interop:18.0.0') {
exclude group: "com.google.firebase", module: "firebase-common"
}
diff --git a/firebase-storage/gradle.properties b/firebase-storage/gradle.properties
index f4ae1a57594..b2337aeb5ba 100644
--- a/firebase-storage/gradle.properties
+++ b/firebase-storage/gradle.properties
@@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-version=17.0.0
-latestReleasedVersion=16.1.0
+version=18.0.1
+latestReleasedVersion=18.0.0
android.enableUnitTestBinaryResources=true
diff --git a/firebase-storage/src/main/java/com/google/firebase/storage/StorageTaskManager.java b/firebase-storage/src/main/java/com/google/firebase/storage/StorageTaskManager.java
index f703a9d845f..8814afcfbe8 100644
--- a/firebase-storage/src/main/java/com/google/firebase/storage/StorageTaskManager.java
+++ b/firebase-storage/src/main/java/com/google/firebase/storage/StorageTaskManager.java
@@ -32,7 +32,7 @@
/*package*/ class StorageTaskManager {
private static final StorageTaskManager _instance = new StorageTaskManager();
- private final Map> inProgressTasks = new HashMap<>();
+ private final Map>> inProgressTasks = new HashMap<>();
private final Object syncObject = new Object();
@@ -44,7 +44,7 @@ public List getUploadTasksUnder(@NonNull StorageReference parent) {
synchronized (syncObject) {
ArrayList inProgressList = new ArrayList<>();
String parentPath = parent.toString();
- for (Map.Entry> entry : inProgressTasks.entrySet()) {
+ for (Map.Entry>> entry : inProgressTasks.entrySet()) {
if (entry.getKey().startsWith(parentPath)) {
StorageTask task = entry.getValue().get();
if (task instanceof UploadTask) {
@@ -60,9 +60,9 @@ public List getDownloadTasksUnder(@NonNull StorageReference pa
synchronized (syncObject) {
ArrayList inProgressList = new ArrayList<>();
String parentPath = parent.toString();
- for (Map.Entry> entry : inProgressTasks.entrySet()) {
+ for (Map.Entry>> entry : inProgressTasks.entrySet()) {
if (entry.getKey().startsWith(parentPath)) {
- StorageTask task = entry.getValue().get();
+ StorageTask task = entry.getValue().get();
if (task instanceof FileDownloadTask) {
inProgressList.add((FileDownloadTask) task);
}
@@ -72,19 +72,19 @@ public List getDownloadTasksUnder(@NonNull StorageReference pa
}
}
- public void ensureRegistered(StorageTask targetTask) {
+ public void ensureRegistered(StorageTask targetTask) {
synchronized (syncObject) {
// ensure *this* is added to the in progress list
inProgressTasks.put(targetTask.getStorage().toString(), new WeakReference<>(targetTask));
}
}
- public void unRegister(StorageTask targetTask) {
+ public void unRegister(StorageTask targetTask) {
synchronized (syncObject) {
// ensure *this* is added to the in progress list
String key = targetTask.getStorage().toString();
- WeakReference weakReference = inProgressTasks.get(key);
- StorageTask task = weakReference != null ? weakReference.get() : null;
+ WeakReference> weakReference = inProgressTasks.get(key);
+ StorageTask task = weakReference != null ? weakReference.get() : null;
if (task == null || task == targetTask) {
inProgressTasks.remove(key);
}
diff --git a/firebase-storage/test-app/test-app.gradle b/firebase-storage/test-app/test-app.gradle
index b45d4f1b021..ab9fadb4dfd 100644
--- a/firebase-storage/test-app/test-app.gradle
+++ b/firebase-storage/test-app/test-app.gradle
@@ -49,10 +49,10 @@ dependencies {
// We intentionally use an open ended version to pick up any SNAPSHOT
// versions published to the root project' s build/ directory.
- implementation 'com.google.firebase:firebase-auth:17+'
- implementation 'com.google.firebase:firebase-common:17+'
- implementation 'com.google.android.gms:play-services-basement:16.2.0'
- implementation 'com.google.android.gms:play-services-base:16.1.0'
+ implementation 'com.google.firebase:firebase-auth:18+'
+ implementation 'com.google.firebase:firebase-common:18+'
+ implementation 'com.google.android.gms:play-services-basement:17.0.0'
+ implementation 'com.google.android.gms:play-services-base:17.0.0'
implementation 'com.google.android.material:material:1.0.0'
implementation 'androidx.appcompat:appcompat:1.0.2'
diff --git a/protolite-well-known-types/gradle.properties b/protolite-well-known-types/gradle.properties
index c763f64467b..54be3eb478f 100644
--- a/protolite-well-known-types/gradle.properties
+++ b/protolite-well-known-types/gradle.properties
@@ -1,2 +1,2 @@
-version=16.0.2
-latestReleasedVersion=16.0.1
+version=17.0.1
+latestReleasedVersion=17.0.0
diff --git a/root-project.gradle b/root-project.gradle
index 1d519f9278f..664cce0efd9 100644
--- a/root-project.gradle
+++ b/root-project.gradle
@@ -52,6 +52,7 @@ ext {
apply plugin: com.google.firebase.gradle.plugins.publish.PublishingPlugin
apply plugin: com.google.firebase.gradle.plugins.ci.ContinuousIntegrationPlugin
+apply plugin: com.google.firebase.gradle.plugins.ci.SmokeTestsPlugin
apply plugin: com.google.firebase.gradle.plugins.ci.metrics.MetricsPlugin
firebaseContinuousIntegration {
@@ -139,38 +140,6 @@ configure(subprojects) {
}
}
-/**
- * Disable "debug" build type for all subprojects.
- *
- * They are identical to "release" and are not used in either release or smoke tests. Disabling them
- * to reduce the number of tests we run on pre/post-submit.
- */
-configure(subprojects) {
- afterEvaluate { Project sub ->
- if (!sub.plugins.hasPlugin('com.android.library') && !sub.plugins.hasPlugin('com.android.application')) {
- return
- }
-
- // skip debug unit tests in CI
- // TODO(vkryachko): provide ability for teams to control this if needed
- if (System.getenv().containsKey("FIREBASE_CI")) {
- sub.tasks.all {Task task ->
- if (task.name == 'testDebugUnitTest') {
- task.enabled = false
- }
- }
- }
- sub.android {
- testBuildType "release"
-
- buildTypes {
- // In the case of and android library signing config only affects instrumentation test APK.
- // We need it signed with default debug credentials in order for FTL to accept the APK.
- release.signingConfig = debug.signingConfig
- }
- }
- }
-}
/**
* Configure "Preguarding" and Desugaring for the subprojects.
diff --git a/smoke-tests/build.gradle b/smoke-tests/build.gradle
index 55b7f1d3aac..2c7be0fe133 100644
--- a/smoke-tests/build.gradle
+++ b/smoke-tests/build.gradle
@@ -12,6 +12,10 @@
// See the License for the specific language governing permissions and
// limitations under the License.
+import java.nio.file.Files
+import java.nio.file.Path
+import java.nio.file.Paths
+
buildscript {
repositories {
google()
@@ -114,4 +118,12 @@ dependencies {
storageImplementation "com.google.firebase:firebase-storage"
}
+clean.doLast {
+ def paths = Files.newDirectoryStream(Paths.get("."), "build-*")
+
+ for (Path path : paths) {
+ project.delete "$path/"
+ }
+}
+
apply plugin: "com.google.gms.google-services"
diff --git a/tools/measurement/apksize/src/firestore/firestore.gradle b/tools/measurement/apksize/src/firestore/firestore.gradle
index 6b78e0f5598..f8640c43e7c 100644
--- a/tools/measurement/apksize/src/firestore/firestore.gradle
+++ b/tools/measurement/apksize/src/firestore/firestore.gradle
@@ -31,6 +31,6 @@ android {
dependencies {
firestoreImplementation project(":firebase-firestore")
firestoreImplementation "com.google.android.gms:play-services-auth:16.0.1"
- firestoreImplementation "com.google.android.gms:play-services-base:16.1.0"
+ firestoreImplementation "com.google.android.gms:play-services-base:17.0.0"
firestoreImplementation 'androidx.legacy:legacy-support-v4:1.0.0'
}
diff --git a/transport/transport-api/gradle.properties b/transport/transport-api/gradle.properties
index a9aff5b2e2e..983642acd1f 100644
--- a/transport/transport-api/gradle.properties
+++ b/transport/transport-api/gradle.properties
@@ -12,5 +12,5 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-version=1.0.1
-latestReleasedVersion=1.0.0
+version=2.0.1
+latestReleasedVersion=2.0.0
diff --git a/transport/transport-backend-cct/gradle.properties b/transport/transport-backend-cct/gradle.properties
index 4e6041d681d..7708203d64e 100644
--- a/transport/transport-backend-cct/gradle.properties
+++ b/transport/transport-backend-cct/gradle.properties
@@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-version=1.0.1
-latestReleasedVersion=1.0.0
+version=2.0.1
+latestReleasedVersion=2.0.0
firebaseSkipPreguard=false
diff --git a/transport/transport-runtime/gradle.properties b/transport/transport-runtime/gradle.properties
index 0cbb89724a3..18a78760e82 100644
--- a/transport/transport-runtime/gradle.properties
+++ b/transport/transport-runtime/gradle.properties
@@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-version=1.0.1
-latestReleasedVersion=1.0.0
+version=2.0.1
+latestReleasedVersion=2.0.0
android.enableUnitTestBinaryResources=true
From dba0c0eb57aa655b60ebe88de91b121835fd9e00 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 15:16:35 -0700
Subject: [PATCH 12/74] Replace some deprecated code.
---
.../segmentation/CustomInstallationIdCacheTest.java | 6 +++---
.../segmentation/FirebaseSegmentationInstrumentedTest.java | 4 ++--
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
index 5783294cfa3..ced06450c3c 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
@@ -18,7 +18,7 @@
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
-import androidx.test.InstrumentationRegistry;
+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;
@@ -41,11 +41,11 @@ public void setUp() {
FirebaseApp.clearInstancesForTest();
firebaseApp0 =
FirebaseApp.initializeApp(
- InstrumentationRegistry.getContext(),
+ ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
firebaseApp1 =
FirebaseApp.initializeApp(
- InstrumentationRegistry.getContext(),
+ ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:987654321:android:abcdef").build(),
"firebase_app_1");
cache = CustomInstallationIdCache.getInstance();
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index db8fcb9b873..739df092564 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
@@ -16,7 +16,7 @@
import static org.junit.Assert.assertNull;
-import androidx.test.InstrumentationRegistry;
+import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseOptions;
@@ -39,7 +39,7 @@ public void setUp() {
FirebaseApp.clearInstancesForTest();
firebaseApp =
FirebaseApp.initializeApp(
- InstrumentationRegistry.getContext(),
+ ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
}
From 1274b42b9226ea3f6443dd87d98fb39b2d7af16b Mon Sep 17 00:00:00 2001
From: Di Wu <49409954+diwu-arete@users.noreply.github.com>
Date: Tue, 18 Jun 2019 15:21:48 -0700
Subject: [PATCH 13/74] Fix some deprecations (#533)
* 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.
---
.../segmentation/CustomInstallationIdCacheTest.java | 6 +++---
.../segmentation/FirebaseSegmentationInstrumentedTest.java | 4 ++--
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
index 5783294cfa3..ced06450c3c 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
@@ -18,7 +18,7 @@
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
-import androidx.test.InstrumentationRegistry;
+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;
@@ -41,11 +41,11 @@ public void setUp() {
FirebaseApp.clearInstancesForTest();
firebaseApp0 =
FirebaseApp.initializeApp(
- InstrumentationRegistry.getContext(),
+ ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
firebaseApp1 =
FirebaseApp.initializeApp(
- InstrumentationRegistry.getContext(),
+ ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:987654321:android:abcdef").build(),
"firebase_app_1");
cache = CustomInstallationIdCache.getInstance();
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index db8fcb9b873..739df092564 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
@@ -16,7 +16,7 @@
import static org.junit.Assert.assertNull;
-import androidx.test.InstrumentationRegistry;
+import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseOptions;
@@ -39,7 +39,7 @@ public void setUp() {
FirebaseApp.clearInstancesForTest();
firebaseApp =
FirebaseApp.initializeApp(
- InstrumentationRegistry.getContext(),
+ ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
}
From a9a43a45ac18db388618156c962fc55eeda75424 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 16:02:04 -0700
Subject: [PATCH 14/74] Package refactor
---
.../{ => local}/CustomInstallationIdCacheTest.java | 6 ++++--
.../segmentation/{ => local}/CustomInstallationIdCache.java | 2 +-
.../{ => local}/CustomInstallationIdCacheEntryValue.java | 4 ++--
3 files changed, 7 insertions(+), 5 deletions(-)
rename firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/{ => local}/CustomInstallationIdCacheTest.java (95%)
rename firebase-segmentation/src/main/java/com/google/firebase/segmentation/{ => local}/CustomInstallationIdCache.java (99%)
rename firebase-segmentation/src/main/java/com/google/firebase/segmentation/{ => local}/CustomInstallationIdCacheEntryValue.java (90%)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
similarity index 95%
rename from firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
rename to firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index ced06450c3c..4a63177ba26 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.firebase.segmentation;
+package com.google.firebase.segmentation.local;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNull;
@@ -28,7 +28,9 @@
import org.junit.Test;
import org.junit.runner.RunWith;
-/** Instrumented tests for {@link CustomInstallationIdCache} */
+/**
+ * Instrumented tests for {@link com.google.firebase.segmentation.local.CustomInstallationIdCache}
+ */
@RunWith(AndroidJUnit4.class)
public class CustomInstallationIdCacheTest {
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
similarity index 99%
rename from firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
rename to firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index 5096a265714..2b93231eb39 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.firebase.segmentation;
+package com.google.firebase.segmentation.local;
import android.content.Context;
import android.content.SharedPreferences;
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
similarity index 90%
rename from firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
rename to firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
index c79d5f091a9..2d3b5f3c3a6 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
@@ -12,10 +12,10 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.firebase.segmentation;
+package com.google.firebase.segmentation.local;
import com.google.auto.value.AutoValue;
-import com.google.firebase.segmentation.CustomInstallationIdCache.CacheStatus;
+import com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus;
/**
* This class represents a cache entry value in {@link CustomInstallationIdCache}, which contains a
From ca6dacfff2f9d9b29b0495b09927bf374892b96a Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 16:04:34 -0700
Subject: [PATCH 15/74] nit
---
.../segmentation/local/CustomInstallationIdCacheTest.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index 4a63177ba26..b7028f1e595 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
@@ -29,7 +29,7 @@
import org.junit.runner.RunWith;
/**
- * Instrumented tests for {@link com.google.firebase.segmentation.local.CustomInstallationIdCache}
+ * Instrumented tests for {@link CustomInstallationIdCache}
*/
@RunWith(AndroidJUnit4.class)
public class CustomInstallationIdCacheTest {
From e7fff8152e3e912821622703565f8741497b6b9e Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 18 Jun 2019 16:05:32 -0700
Subject: [PATCH 16/74] nit
---
.../segmentation/local/CustomInstallationIdCacheTest.java | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index b7028f1e595..27ab706b3a8 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
@@ -28,9 +28,7 @@
import org.junit.Test;
import org.junit.runner.RunWith;
-/**
- * Instrumented tests for {@link CustomInstallationIdCache}
- */
+/** Instrumented tests for {@link CustomInstallationIdCache} */
@RunWith(AndroidJUnit4.class)
public class CustomInstallationIdCacheTest {
From d9520039c24708e4ee90d401dca8b02e16930529 Mon Sep 17 00:00:00 2001
From: Di Wu <49409954+diwu-arete@users.noreply.github.com>
Date: Tue, 18 Jun 2019 16:06:15 -0700
Subject: [PATCH 17/74] package refactor (#534)
* 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
---
.../{ => local}/CustomInstallationIdCacheTest.java | 2 +-
.../segmentation/{ => local}/CustomInstallationIdCache.java | 2 +-
.../{ => local}/CustomInstallationIdCacheEntryValue.java | 4 ++--
3 files changed, 4 insertions(+), 4 deletions(-)
rename firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/{ => local}/CustomInstallationIdCacheTest.java (98%)
rename firebase-segmentation/src/main/java/com/google/firebase/segmentation/{ => local}/CustomInstallationIdCache.java (99%)
rename firebase-segmentation/src/main/java/com/google/firebase/segmentation/{ => local}/CustomInstallationIdCacheEntryValue.java (90%)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
similarity index 98%
rename from firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
rename to firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index ced06450c3c..27ab706b3a8 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.firebase.segmentation;
+package com.google.firebase.segmentation.local;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNull;
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
similarity index 99%
rename from firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
rename to firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index 5096a265714..2b93231eb39 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.firebase.segmentation;
+package com.google.firebase.segmentation.local;
import android.content.Context;
import android.content.SharedPreferences;
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
similarity index 90%
rename from firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
rename to firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
index c79d5f091a9..2d3b5f3c3a6 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/CustomInstallationIdCacheEntryValue.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
@@ -12,10 +12,10 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.firebase.segmentation;
+package com.google.firebase.segmentation.local;
import com.google.auto.value.AutoValue;
-import com.google.firebase.segmentation.CustomInstallationIdCache.CacheStatus;
+import com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus;
/**
* This class represents a cache entry value in {@link CustomInstallationIdCache}, which contains a
From b381889c8ef8e86c0f8f662538421ce1763aba5b Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Wed, 19 Jun 2019 16:47:20 -0700
Subject: [PATCH 18/74] 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.)
---
.../firebase-segmentation.gradle | 7 +
.../FirebaseSegmentationInstrumentedTest.java | 189 +++++++++++++++++-
.../local/CustomInstallationIdCacheTest.java | 31 +--
.../segmentation/FirebaseSegmentation.java | 184 ++++++++++++++++-
.../SetCustomInstallationIdException.java | 68 +++++++
.../google/firebase/segmentation/Utils.java | 33 +++
.../local/CustomInstallationIdCache.java | 87 ++++----
.../CustomInstallationIdCacheEntryValue.java | 10 +-
.../remote/SegmentationServiceClient.java | 56 ++++++
.../FirebaseSegmentationRegistrarTest.java | 3 -
10 files changed, 588 insertions(+), 80 deletions(-)
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index dc4606715c5..1f76b8b593a 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/firebase-segmentation/firebase-segmentation.gradle
@@ -83,13 +83,18 @@ 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'
compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
annotationProcessor "com.google.auto.value:auto-value:1.6.2"
@@ -104,4 +109,6 @@ dependencies {
androidTestImplementation 'androidx.test:runner:1.2.0'
androidTestImplementation "com.google.truth:truth:$googleTruthVersion"
androidTestImplementation 'junit:junit:4.12'
+ androidTestImplementation 'org.mockito:mockito-core:2.25.0'
+ androidTestImplementation 'org.mockito:mockito-android:2.25.0'
}
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index 739df092564..289c448fd1f 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
@@ -14,15 +14,34 @@
package com.google.firebase.segmentation;
+import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNull;
+import static org.junit.Assert.fail;
+import static org.mockito.ArgumentMatchers.anyLong;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.when;
+import androidx.annotation.NonNull;
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 com.google.firebase.iid.FirebaseInstanceId;
+import com.google.firebase.iid.InstanceIdResult;
+import com.google.firebase.segmentation.local.CustomInstallationIdCache;
+import com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue;
+import com.google.firebase.segmentation.remote.SegmentationServiceClient;
+import java.util.concurrent.ExecutionException;
+import org.junit.After;
import org.junit.Before;
+import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runner.RunWith;
+import org.junit.runners.MethodSorters;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
/**
* Instrumented test, which will execute on an Android device.
@@ -30,21 +49,185 @@
* @see Testing documentation
*/
@RunWith(AndroidJUnit4.class)
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class FirebaseSegmentationInstrumentedTest {
+ private static final String CUSTOM_INSTALLATION_ID = "123";
+ private static final String FIREBASE_INSTANCE_ID = "cAAAAAAAAAA";
+
private FirebaseApp firebaseApp;
+ @Mock private FirebaseInstanceId firebaseInstanceId;
+ @Mock private SegmentationServiceClient backendClientReturnsOk;
+ @Mock private SegmentationServiceClient backendClientReturnsError;
+ private CustomInstallationIdCache actualCache;
+ @Mock private CustomInstallationIdCache cacheReturnsError;
@Before
public void setUp() {
+ MockitoAnnotations.initMocks(this);
FirebaseApp.clearInstancesForTest();
firebaseApp =
FirebaseApp.initializeApp(
ApplicationProvider.getApplicationContext(),
- new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
+ new FirebaseOptions.Builder()
+ .setApplicationId("1" + ":123456789:android:abcdef")
+ .build());
+ actualCache = new CustomInstallationIdCache(firebaseApp);
+
+ when(backendClientReturnsOk.updateCustomInstallationId(
+ anyLong(), anyString(), anyString(), anyString()))
+ .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+ when(backendClientReturnsOk.clearCustomInstallationId(anyLong(), anyString(), anyString()))
+ .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+ when(backendClientReturnsError.updateCustomInstallationId(
+ 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));
+ when(firebaseInstanceId.getInstanceId())
+ .thenReturn(
+ Tasks.forResult(
+ new InstanceIdResult() {
+ @NonNull
+ @Override
+ public String getId() {
+ return FIREBASE_INSTANCE_ID;
+ }
+
+ @NonNull
+ @Override
+ public String getToken() {
+ return "iid_token";
+ }
+ }));
+ when(cacheReturnsError.insertOrUpdateCacheEntry(any())).thenReturn(Tasks.forResult(false));
+ when(cacheReturnsError.readCacheEntryValue()).thenReturn(null);
+ }
+
+ @After
+ public void cleanUp() throws Exception {
+ Tasks.await(actualCache.clear());
+ }
+
+ @Test
+ public void testUpdateCustomInstallationId_CacheOk_BackendOk() throws Exception {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
+
+ // No exception, means success.
+ assertNull(Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID)));
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertThat(entryValue.getCustomInstallationId()).isEqualTo(CUSTOM_INSTALLATION_ID);
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
+ assertThat(entryValue.getCacheStatus()).isEqualTo(CustomInstallationIdCache.CacheStatus.SYNCED);
+ }
+
+ @Test
+ public void testUpdateCustomInstallationId_CacheOk_BackendError() throws InterruptedException {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsError);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.BACKEND_ERROR);
+ }
+
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertThat(entryValue.getCustomInstallationId()).isEqualTo(CUSTOM_INSTALLATION_ID);
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
+ assertThat(entryValue.getCacheStatus())
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING_UPDATE);
}
@Test
- public void useAppContext() {
- assertNull(FirebaseSegmentation.getInstance().setCustomInstallationId("123123").getResult());
+ public void testUpdateCustomInstallationId_CacheError_BackendOk() throws InterruptedException {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, cacheReturnsError, backendClientReturnsOk);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.CLIENT_ERROR);
+ }
+ }
+
+ @Test
+ public void testClearCustomInstallationId_CacheOk_BackendOk() throws Exception {
+ Tasks.await(
+ actualCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ CUSTOM_INSTALLATION_ID,
+ FIREBASE_INSTANCE_ID,
+ CustomInstallationIdCache.CacheStatus.SYNCED)));
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
+
+ // No exception, means success.
+ assertNull(Tasks.await(firebaseSegmentation.setCustomInstallationId(null)));
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertNull(entryValue);
+ }
+
+ @Test
+ public void testClearCustomInstallationId_CacheOk_BackendError() throws Exception {
+ Tasks.await(
+ actualCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ CUSTOM_INSTALLATION_ID,
+ FIREBASE_INSTANCE_ID,
+ CustomInstallationIdCache.CacheStatus.SYNCED)));
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsError);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(null));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.BACKEND_ERROR);
+ }
+
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertThat(entryValue.getCustomInstallationId().isEmpty()).isTrue();
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
+ assertThat(entryValue.getCacheStatus())
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING_CLEAR);
+ }
+
+ @Test
+ public void testClearCustomInstallationId_CacheError_BackendOk() throws InterruptedException {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, cacheReturnsError, backendClientReturnsOk);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.CLIENT_ERROR);
+ }
}
}
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index 27ab706b3a8..019a2b8ba08 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
@@ -34,7 +34,8 @@ public class CustomInstallationIdCacheTest {
private FirebaseApp firebaseApp0;
private FirebaseApp firebaseApp1;
- private CustomInstallationIdCache cache;
+ private CustomInstallationIdCache cache0;
+ private CustomInstallationIdCache cache1;
@Before
public void setUp() {
@@ -48,42 +49,44 @@ public void setUp() {
ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:987654321:android:abcdef").build(),
"firebase_app_1");
- cache = CustomInstallationIdCache.getInstance();
+ cache0 = new CustomInstallationIdCache(firebaseApp0);
+ cache1 = new CustomInstallationIdCache(firebaseApp1);
}
@After
public void cleanUp() throws Exception {
- Tasks.await(cache.clearAll());
+ Tasks.await(cache0.clear());
+ Tasks.await(cache1.clear());
}
@Test
public void testReadCacheEntry_Null() {
- assertNull(cache.readCacheEntryValue(firebaseApp0));
- assertNull(cache.readCacheEntryValue(firebaseApp1));
+ assertNull(cache0.readCacheEntryValue());
+ assertNull(cache1.readCacheEntryValue());
}
@Test
public void testUpdateAndReadCacheEntry() throws Exception {
assertTrue(
Tasks.await(
- cache.insertOrUpdateCacheEntry(
- firebaseApp0,
+ cache0.insertOrUpdateCacheEntry(
CustomInstallationIdCacheEntryValue.create(
- "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.PENDING))));
- CustomInstallationIdCacheEntryValue entryValue = cache.readCacheEntryValue(firebaseApp0);
+ "123456",
+ "cAAAAAAAAAA",
+ CustomInstallationIdCache.CacheStatus.PENDING_UPDATE))));
+ CustomInstallationIdCacheEntryValue entryValue = cache0.readCacheEntryValue();
assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
assertThat(entryValue.getCacheStatus())
- .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING);
- assertNull(cache.readCacheEntryValue(firebaseApp1));
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING_UPDATE);
+ assertNull(cache1.readCacheEntryValue());
assertTrue(
Tasks.await(
- cache.insertOrUpdateCacheEntry(
- firebaseApp0,
+ cache0.insertOrUpdateCacheEntry(
CustomInstallationIdCacheEntryValue.create(
"123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED))));
- entryValue = cache.readCacheEntryValue(firebaseApp0);
+ entryValue = cache0.readCacheEntryValue();
assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
assertThat(entryValue.getCacheStatus()).isEqualTo(CustomInstallationIdCache.CacheStatus.SYNCED);
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index eca517db1b3..5bed0660b8a 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -15,21 +15,45 @@
package com.google.firebase.segmentation;
import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
import com.google.android.gms.common.internal.Preconditions;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.Tasks;
import com.google.firebase.FirebaseApp;
import com.google.firebase.iid.FirebaseInstanceId;
+import com.google.firebase.iid.InstanceIdResult;
+import com.google.firebase.segmentation.SetCustomInstallationIdException.Status;
+import com.google.firebase.segmentation.local.CustomInstallationIdCache;
+import com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue;
+import com.google.firebase.segmentation.remote.SegmentationServiceClient;
+import com.google.firebase.segmentation.remote.SegmentationServiceClient.Code;
/** Entry point of Firebase Segmentation SDK. */
public class FirebaseSegmentation {
private final FirebaseApp firebaseApp;
private final FirebaseInstanceId firebaseInstanceId;
+ private final CustomInstallationIdCache localCache;
+ private final SegmentationServiceClient backendServiceClient;
FirebaseSegmentation(FirebaseApp firebaseApp) {
this.firebaseApp = firebaseApp;
this.firebaseInstanceId = FirebaseInstanceId.getInstance(firebaseApp);
+ localCache = new CustomInstallationIdCache(firebaseApp);
+ backendServiceClient = new SegmentationServiceClient();
+ }
+
+ @RestrictTo(RestrictTo.Scope.TESTS)
+ FirebaseSegmentation(
+ FirebaseApp firebaseApp,
+ FirebaseInstanceId firebaseInstanceId,
+ CustomInstallationIdCache localCache,
+ SegmentationServiceClient backendServiceClient) {
+ this.firebaseApp = firebaseApp;
+ this.firebaseInstanceId = firebaseInstanceId;
+ this.localCache = localCache;
+ this.backendServiceClient = backendServiceClient;
}
/**
@@ -51,11 +75,165 @@ public static FirebaseSegmentation getInstance() {
*/
@NonNull
public static FirebaseSegmentation getInstance(@NonNull FirebaseApp app) {
- Preconditions.checkArgument(app != null, "Null is not a valid value of FirebaseApp.");
+ Preconditions.checkArgument(app != null, "Null is not a valid value " + "of FirebaseApp.");
return app.get(FirebaseSegmentation.class);
}
- Task setCustomInstallationId(String customInstallationId) {
- return Tasks.forResult(null);
+ Task setCustomInstallationId(@Nullable String customInstallationId) {
+ if (customInstallationId == null) {
+ return clearCustomInstallationId();
+ }
+ return updateCustomInstallationId(customInstallationId);
+ }
+
+ /**
+ * Update custom installation id of the {@link FirebaseApp} on Firebase segmentation backend and
+ * client side cache.
+ *
+ *
+ * The workflow is:
+ * check diff against cache or cache status is not SYNCED
+ * |
+ * get Firebase instance id and token
+ * | |
+ * | update cache with cache status PENDING_UPDATE
+ * | |
+ * send http request to backend
+ * |
+ * on success: set cache entry status to SYNCED
+ * |
+ * return
+ *
+ */
+ private Task updateCustomInstallationId(String customInstallationId) {
+ CustomInstallationIdCacheEntryValue cacheEntryValue = localCache.readCacheEntryValue();
+ if (cacheEntryValue != null
+ && cacheEntryValue.getCustomInstallationId().equals(customInstallationId)
+ && cacheEntryValue.getCacheStatus() == CustomInstallationIdCache.CacheStatus.SYNCED) {
+ // If the given custom installation id matches up the cached
+ // value, there's no need to update.
+ return Tasks.forResult(null);
+ }
+
+ Task instanceIdResultTask = firebaseInstanceId.getInstanceId();
+ Task firstUpdateCacheResultTask =
+ instanceIdResultTask.onSuccessTask(
+ instanceIdResult ->
+ localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ customInstallationId,
+ instanceIdResult.getId(),
+ CustomInstallationIdCache.CacheStatus.PENDING_UPDATE)));
+
+ // Start requesting backend when first cache update is done.
+ Task backendRequestResultTask =
+ firstUpdateCacheResultTask.onSuccessTask(
+ firstUpdateCacheResult -> {
+ if (firstUpdateCacheResult) {
+ String iid = instanceIdResultTask.getResult().getId();
+ String iidToken = instanceIdResultTask.getResult().getToken();
+ return backendServiceClient.updateCustomInstallationId(
+ Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ customInstallationId,
+ iid,
+ iidToken);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
+
+ Task finalUpdateCacheResultTask =
+ backendRequestResultTask.onSuccessTask(
+ backendRequestResult -> {
+ switch (backendRequestResult) {
+ case OK:
+ return localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ customInstallationId,
+ instanceIdResultTask.getResult().getId(),
+ CustomInstallationIdCache.CacheStatus.SYNCED));
+ case ALREADY_EXISTS:
+ throw new SetCustomInstallationIdException(
+ Status.DUPLICATED_CUSTOM_INSTALLATION_ID);
+ default:
+ throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
+ }
+ });
+
+ return finalUpdateCacheResultTask.onSuccessTask(
+ finalUpdateCacheResult -> {
+ if (finalUpdateCacheResult) {
+ return Tasks.forResult(null);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
+ }
+
+ /**
+ * Clear custom installation id of the {@link FirebaseApp} on Firebase segmentation backend and
+ * client side cache.
+ *
+ *
+ * The workflow is:
+ * get Firebase instance id and token
+ * | |
+ * | update cache with cache status PENDING_CLEAR
+ * | |
+ * send http request to backend
+ * |
+ * on success: delete cache entry
+ * |
+ * return
+ *
+ */
+ private Task clearCustomInstallationId() {
+ Task instanceIdResultTask = firebaseInstanceId.getInstanceId();
+ Task firstUpdateCacheResultTask =
+ instanceIdResultTask.onSuccessTask(
+ instanceIdResult ->
+ localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ "",
+ instanceIdResult.getId(),
+ CustomInstallationIdCache.CacheStatus.PENDING_CLEAR)));
+
+ Task backendRequestResultTask =
+ firstUpdateCacheResultTask.onSuccessTask(
+ firstUpdateCacheResult -> {
+ if (firstUpdateCacheResult) {
+ String iid = instanceIdResultTask.getResult().getId();
+ String iidToken = instanceIdResultTask.getResult().getToken();
+ return backendServiceClient.clearCustomInstallationId(
+ Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ iid,
+ iidToken);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
+
+ Task finalUpdateCacheResultTask =
+ backendRequestResultTask.onSuccessTask(
+ backendRequestResult -> {
+ if (backendRequestResult == Code.OK) {
+ return localCache.clear();
+ } else {
+ throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
+ }
+ });
+
+ return finalUpdateCacheResultTask.onSuccessTask(
+ finalUpdateCacheResult -> {
+ if (finalUpdateCacheResult) {
+ return Tasks.forResult(null);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
}
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java
new file mode 100644
index 00000000000..3c957ce3294
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java
@@ -0,0 +1,68 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import androidx.annotation.NonNull;
+import com.google.firebase.FirebaseException;
+
+/** The class for all Exceptions thrown by {@link FirebaseSegmentation}. */
+public class SetCustomInstallationIdException extends FirebaseException {
+
+ public enum Status {
+ UNKOWN(0),
+
+ /** Error in Firebase SDK. */
+ CLIENT_ERROR(1),
+
+ /** Error when calling Firebase segmentation backend. */
+ BACKEND_ERROR(2),
+
+ /** The given custom installation is already tied to another Firebase installation. */
+ DUPLICATED_CUSTOM_INSTALLATION_ID(3);
+
+ private final int value;
+
+ Status(int value) {
+ this.value = value;
+ }
+ }
+
+ @NonNull private final Status status;
+
+ SetCustomInstallationIdException(@NonNull Status status) {
+ this.status = status;
+ }
+
+ SetCustomInstallationIdException(@NonNull String message, @NonNull Status status) {
+ super(message);
+ this.status = status;
+ }
+
+ SetCustomInstallationIdException(
+ @NonNull String message, @NonNull Status status, Throwable cause) {
+ super(message, cause);
+ this.status = status;
+ }
+
+ /**
+ * Gets the status code for the operation that failed.
+ *
+ * @return the code for the SetCustomInstallationIdException
+ */
+ @NonNull
+ public Status getStatus() {
+ return status;
+ }
+}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java
new file mode 100644
index 00000000000..ca231a89cb5
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java
@@ -0,0 +1,33 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/** Util methods used for {@link FirebaseSegmentation} */
+class Utils {
+
+ private static final Pattern APP_ID_PATTERN =
+ Pattern.compile("^[^:]+:([0-9]+):(android|ios|web):([0-9a-f]+)");
+
+ static long getProjectNumberFromAppId(String appId) {
+ Matcher matcher = APP_ID_PATTERN.matcher(appId);
+ if (matcher.matches()) {
+ return Long.valueOf(matcher.group(1));
+ }
+ throw new IllegalArgumentException("Invalid app id " + appId);
+ }
+}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index 2b93231eb39..f650c3463d8 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -17,27 +17,30 @@
import android.content.Context;
import android.content.SharedPreferences;
import androidx.annotation.Nullable;
-import androidx.annotation.RestrictTo;
-import com.google.android.gms.common.util.Strings;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.firebase.FirebaseApp;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
-class CustomInstallationIdCache {
+/**
+ * A layer that locally caches a few Firebase Segmentation attributes on top the Segmentation
+ * backend API.
+ */
+public class CustomInstallationIdCache {
// Status of each cache entry
// NOTE: never change the ordinal of the enum values because the enum values are stored in cache
// as their ordinal numbers.
- enum CacheStatus {
+ public enum CacheStatus {
// Cache entry is synced to Firebase backend
SYNCED,
- // Cache entry is waiting for Firebase backend response or pending internal retry for retryable
- // errors.
- PENDING,
- // Cache entry is not accepted by Firebase backend.
- ERROR,
+ // Cache entry is waiting for Firebase backend response or internal network retry (for update
+ // operation).
+ PENDING_UPDATE,
+ // Cache entry is waiting for Firebase backend response or internal network retry (for clear
+ // operation).
+ PENDING_CLEAR
}
private static final String SHARED_PREFS_NAME = "CustomInstallationIdCache";
@@ -46,78 +49,58 @@ enum CacheStatus {
private static final String INSTANCE_ID_KEY = "Iid";
private static final String CACHE_STATUS_KEY = "Status";
- private static CustomInstallationIdCache singleton = null;
private final Executor ioExecuter;
private final SharedPreferences prefs;
+ private final String persistenceKey;
- static synchronized CustomInstallationIdCache getInstance() {
- if (singleton == null) {
- singleton = new CustomInstallationIdCache();
- }
- return singleton;
- }
-
- private CustomInstallationIdCache() {
- // Since different FirebaseApp in the same Android application should have the same application
- // context and same dir path, so that use the context of the default FirebaseApp to create the
- // shared preferences.
+ public CustomInstallationIdCache(FirebaseApp firebaseApp) {
+ // Different FirebaseApp in the same Android application should have the same application
+ // context and same dir path
prefs =
- FirebaseApp.getInstance()
+ firebaseApp
.getApplicationContext()
.getSharedPreferences(SHARED_PREFS_NAME, Context.MODE_PRIVATE);
-
+ persistenceKey = firebaseApp.getPersistenceKey();
ioExecuter = Executors.newFixedThreadPool(2);
}
@Nullable
- synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp) {
- String cid =
- prefs.getString(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY), null);
- String iid = prefs.getString(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), null);
- int status = prefs.getInt(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY), -1);
+ public synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue() {
+ String cid = prefs.getString(getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY), null);
+ String iid = prefs.getString(getSharedPreferencesKey(INSTANCE_ID_KEY), null);
+ int status = prefs.getInt(getSharedPreferencesKey(CACHE_STATUS_KEY), -1);
- if (Strings.isEmptyOrWhitespace(cid) || Strings.isEmptyOrWhitespace(iid) || status == -1) {
+ if (cid == null || iid == null || status == -1) {
return null;
}
return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
}
- synchronized Task insertOrUpdateCacheEntry(
- FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
+ public synchronized Task insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue entryValue) {
SharedPreferences.Editor editor = prefs.edit();
editor.putString(
- getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY),
- entryValue.getCustomInstallationId());
- editor.putString(
- getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
- editor.putInt(
- getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY),
- entryValue.getCacheStatus().ordinal());
- return commitSharedPreferencesEditAsync(editor);
- }
-
- synchronized Task clear(FirebaseApp firebaseApp) {
- SharedPreferences.Editor editor = prefs.edit();
- editor.remove(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY));
- editor.remove(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY));
- editor.remove(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY));
+ getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY), entryValue.getCustomInstallationId());
+ editor.putString(getSharedPreferencesKey(INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
+ editor.putInt(getSharedPreferencesKey(CACHE_STATUS_KEY), entryValue.getCacheStatus().ordinal());
return commitSharedPreferencesEditAsync(editor);
}
- @RestrictTo(RestrictTo.Scope.TESTS)
- synchronized Task clearAll() {
+ public synchronized Task clear() {
SharedPreferences.Editor editor = prefs.edit();
- editor.clear();
+ editor.remove(getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY));
+ editor.remove(getSharedPreferencesKey(INSTANCE_ID_KEY));
+ editor.remove(getSharedPreferencesKey(CACHE_STATUS_KEY));
return commitSharedPreferencesEditAsync(editor);
}
- private static String getSharedPreferencesKey(FirebaseApp firebaseApp, String key) {
- return String.format("%s|%s", firebaseApp.getPersistenceKey(), key);
+ private String getSharedPreferencesKey(String key) {
+ return String.format("%s|%s", persistenceKey, key);
}
private Task commitSharedPreferencesEditAsync(SharedPreferences.Editor editor) {
- TaskCompletionSource result = new TaskCompletionSource();
+ TaskCompletionSource result = new TaskCompletionSource<>();
ioExecuter.execute(
new Runnable() {
@Override
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
index 2d3b5f3c3a6..05528cd40f0 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
@@ -22,14 +22,14 @@
* Firebase instance id, a custom installation id and the cache status of this entry.
*/
@AutoValue
-abstract class CustomInstallationIdCacheEntryValue {
- abstract String getCustomInstallationId();
+public abstract class CustomInstallationIdCacheEntryValue {
+ public abstract String getCustomInstallationId();
- abstract String getFirebaseInstanceId();
+ public abstract String getFirebaseInstanceId();
- abstract CacheStatus getCacheStatus();
+ public abstract CacheStatus getCacheStatus();
- static CustomInstallationIdCacheEntryValue create(
+ public static CustomInstallationIdCacheEntryValue create(
String customInstallationId, String firebaseInstanceId, CacheStatus cacheStatus) {
return new AutoValue_CustomInstallationIdCacheEntryValue(
customInstallationId, firebaseInstanceId, cacheStatus);
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
new file mode 100644
index 00000000000..59398b369d5
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
@@ -0,0 +1,56 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation.remote;
+
+import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.Tasks;
+import com.squareup.okhttp.OkHttpClient;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Executors;
+
+/** Http client that sends request to Firebase Segmentation backend API. To be implemented */
+public class SegmentationServiceClient {
+
+ private final OkHttpClient httpClient;
+ private final Executor httpRequestExecutor;
+
+ public enum Code {
+ OK,
+
+ SERVER_INTERNAL_ERROR,
+
+ ALREADY_EXISTS,
+
+ PERMISSION_DENIED
+ }
+
+ public SegmentationServiceClient() {
+ httpClient = new OkHttpClient();
+ httpRequestExecutor = Executors.newFixedThreadPool(4);
+ }
+
+ public Task updateCustomInstallationId(
+ long projectNumber,
+ String customInstallationId,
+ String firebaseInstanceId,
+ String firebaseInstanceIdToken) {
+ return Tasks.forResult(Code.OK);
+ }
+
+ public Task clearCustomInstallationId(
+ long projectNumber, String firebaseInstanceId, String firebaseInstanceIdToken) {
+ return Tasks.forResult(Code.OK);
+ }
+}
diff --git a/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java b/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java
index 1f3c441808f..56b0d120eb0 100644
--- a/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java
+++ b/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java
@@ -15,7 +15,6 @@
package com.google.firebase.segmentation;
import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
import androidx.test.core.app.ApplicationProvider;
import com.google.firebase.FirebaseApp;
@@ -48,10 +47,8 @@ public void getFirebaseInstallationsInstance() {
FirebaseSegmentation defaultSegmentation = FirebaseSegmentation.getInstance();
assertNotNull(defaultSegmentation);
- assertNull(defaultSegmentation.setCustomInstallationId("12345").getResult());
FirebaseSegmentation anotherSegmentation = FirebaseSegmentation.getInstance(anotherApp);
assertNotNull(anotherSegmentation);
- assertNull(anotherSegmentation.setCustomInstallationId("ghdjaas").getResult());
}
}
From 1adcfbd864f3ed65f0898034bea59fefb0864156 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Wed, 19 Jun 2019 17:02:20 -0700
Subject: [PATCH 19/74] minor format fix
---
.../segmentation/FirebaseSegmentationInstrumentedTest.java | 4 +---
.../google/firebase/segmentation/FirebaseSegmentation.java | 2 +-
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index 289c448fd1f..8519e641cb7 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
@@ -69,9 +69,7 @@ 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").build());
actualCache = new CustomInstallationIdCache(firebaseApp);
when(backendClientReturnsOk.updateCustomInstallationId(
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index 5bed0660b8a..e7566cd965b 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -75,7 +75,7 @@ public static FirebaseSegmentation getInstance() {
*/
@NonNull
public static FirebaseSegmentation getInstance(@NonNull FirebaseApp app) {
- Preconditions.checkArgument(app != null, "Null is not a valid value " + "of FirebaseApp.");
+ Preconditions.checkArgument(app != null, "Null is not a valid value of FirebaseApp.");
return app.get(FirebaseSegmentation.class);
}
From 6091f82032fc78512d64de8e9e5c2257b98cdeda Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Thu, 20 Jun 2019 13:46:10 -0700
Subject: [PATCH 20/74] Address comments #1
---
.../firebase/segmentation/FirebaseSegmentation.java | 3 ++-
.../segmentation/local/CustomInstallationIdCache.java | 8 +-------
2 files changed, 3 insertions(+), 8 deletions(-)
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index e7566cd965b..34de68597c1 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -79,7 +79,8 @@ public static FirebaseSegmentation getInstance(@NonNull FirebaseApp app) {
return app.get(FirebaseSegmentation.class);
}
- Task setCustomInstallationId(@Nullable String customInstallationId) {
+ @NonNull
+ public synchronized Task setCustomInstallationId(@Nullable String customInstallationId) {
if (customInstallationId == null) {
return clearCustomInstallationId();
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index f650c3463d8..a1346062440 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -101,13 +101,7 @@ private String getSharedPreferencesKey(String key) {
private Task commitSharedPreferencesEditAsync(SharedPreferences.Editor editor) {
TaskCompletionSource result = new TaskCompletionSource<>();
- ioExecuter.execute(
- new Runnable() {
- @Override
- public void run() {
- result.setResult(editor.commit());
- }
- });
+ ioExecuter.execute(() -> result.setResult(editor.commit()));
return result.getTask();
}
}
From e7fb811fce9cc477f65c75bf8aaa743c2b946921 Mon Sep 17 00:00:00 2001
From: Di Wu <49409954+diwu-arete@users.noreply.github.com>
Date: Mon, 24 Jun 2019 09:56:25 -0700
Subject: [PATCH 21/74] Add the state machine of updating custom installation
id in the local cache and update to Firebase Segmentation backend. (#545)
* 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
---
.../firebase-segmentation.gradle | 7 +
.../FirebaseSegmentationInstrumentedTest.java | 185 +++++++++++++++++-
.../local/CustomInstallationIdCacheTest.java | 31 +--
.../segmentation/FirebaseSegmentation.java | 183 ++++++++++++++++-
.../SetCustomInstallationIdException.java | 68 +++++++
.../google/firebase/segmentation/Utils.java | 33 ++++
.../local/CustomInstallationIdCache.java | 95 ++++-----
.../CustomInstallationIdCacheEntryValue.java | 10 +-
.../remote/SegmentationServiceClient.java | 56 ++++++
.../FirebaseSegmentationRegistrarTest.java | 3 -
10 files changed, 586 insertions(+), 85 deletions(-)
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java
create mode 100644 firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index dc4606715c5..1f76b8b593a 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/firebase-segmentation/firebase-segmentation.gradle
@@ -83,13 +83,18 @@ 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'
compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
annotationProcessor "com.google.auto.value:auto-value:1.6.2"
@@ -104,4 +109,6 @@ dependencies {
androidTestImplementation 'androidx.test:runner:1.2.0'
androidTestImplementation "com.google.truth:truth:$googleTruthVersion"
androidTestImplementation 'junit:junit:4.12'
+ androidTestImplementation 'org.mockito:mockito-core:2.25.0'
+ androidTestImplementation 'org.mockito:mockito-android:2.25.0'
}
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index 739df092564..8519e641cb7 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
@@ -14,15 +14,34 @@
package com.google.firebase.segmentation;
+import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertNull;
+import static org.junit.Assert.fail;
+import static org.mockito.ArgumentMatchers.anyLong;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.when;
+import androidx.annotation.NonNull;
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 com.google.firebase.iid.FirebaseInstanceId;
+import com.google.firebase.iid.InstanceIdResult;
+import com.google.firebase.segmentation.local.CustomInstallationIdCache;
+import com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue;
+import com.google.firebase.segmentation.remote.SegmentationServiceClient;
+import java.util.concurrent.ExecutionException;
+import org.junit.After;
import org.junit.Before;
+import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runner.RunWith;
+import org.junit.runners.MethodSorters;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
/**
* Instrumented test, which will execute on an Android device.
@@ -30,21 +49,183 @@
* @see Testing documentation
*/
@RunWith(AndroidJUnit4.class)
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class FirebaseSegmentationInstrumentedTest {
+ private static final String CUSTOM_INSTALLATION_ID = "123";
+ private static final String FIREBASE_INSTANCE_ID = "cAAAAAAAAAA";
+
private FirebaseApp firebaseApp;
+ @Mock private FirebaseInstanceId firebaseInstanceId;
+ @Mock private SegmentationServiceClient backendClientReturnsOk;
+ @Mock private SegmentationServiceClient backendClientReturnsError;
+ private CustomInstallationIdCache actualCache;
+ @Mock private CustomInstallationIdCache cacheReturnsError;
@Before
public void setUp() {
+ MockitoAnnotations.initMocks(this);
FirebaseApp.clearInstancesForTest();
firebaseApp =
FirebaseApp.initializeApp(
ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:123456789:android:abcdef").build());
+ actualCache = new CustomInstallationIdCache(firebaseApp);
+
+ when(backendClientReturnsOk.updateCustomInstallationId(
+ anyLong(), anyString(), anyString(), anyString()))
+ .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+ when(backendClientReturnsOk.clearCustomInstallationId(anyLong(), anyString(), anyString()))
+ .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+ when(backendClientReturnsError.updateCustomInstallationId(
+ 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));
+ when(firebaseInstanceId.getInstanceId())
+ .thenReturn(
+ Tasks.forResult(
+ new InstanceIdResult() {
+ @NonNull
+ @Override
+ public String getId() {
+ return FIREBASE_INSTANCE_ID;
+ }
+
+ @NonNull
+ @Override
+ public String getToken() {
+ return "iid_token";
+ }
+ }));
+ when(cacheReturnsError.insertOrUpdateCacheEntry(any())).thenReturn(Tasks.forResult(false));
+ when(cacheReturnsError.readCacheEntryValue()).thenReturn(null);
+ }
+
+ @After
+ public void cleanUp() throws Exception {
+ Tasks.await(actualCache.clear());
+ }
+
+ @Test
+ public void testUpdateCustomInstallationId_CacheOk_BackendOk() throws Exception {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
+
+ // No exception, means success.
+ assertNull(Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID)));
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertThat(entryValue.getCustomInstallationId()).isEqualTo(CUSTOM_INSTALLATION_ID);
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
+ assertThat(entryValue.getCacheStatus()).isEqualTo(CustomInstallationIdCache.CacheStatus.SYNCED);
+ }
+
+ @Test
+ public void testUpdateCustomInstallationId_CacheOk_BackendError() throws InterruptedException {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsError);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.BACKEND_ERROR);
+ }
+
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertThat(entryValue.getCustomInstallationId()).isEqualTo(CUSTOM_INSTALLATION_ID);
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
+ assertThat(entryValue.getCacheStatus())
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING_UPDATE);
}
@Test
- public void useAppContext() {
- assertNull(FirebaseSegmentation.getInstance().setCustomInstallationId("123123").getResult());
+ public void testUpdateCustomInstallationId_CacheError_BackendOk() throws InterruptedException {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, cacheReturnsError, backendClientReturnsOk);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.CLIENT_ERROR);
+ }
+ }
+
+ @Test
+ public void testClearCustomInstallationId_CacheOk_BackendOk() throws Exception {
+ Tasks.await(
+ actualCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ CUSTOM_INSTALLATION_ID,
+ FIREBASE_INSTANCE_ID,
+ CustomInstallationIdCache.CacheStatus.SYNCED)));
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
+
+ // No exception, means success.
+ assertNull(Tasks.await(firebaseSegmentation.setCustomInstallationId(null)));
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertNull(entryValue);
+ }
+
+ @Test
+ public void testClearCustomInstallationId_CacheOk_BackendError() throws Exception {
+ Tasks.await(
+ actualCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ CUSTOM_INSTALLATION_ID,
+ FIREBASE_INSTANCE_ID,
+ CustomInstallationIdCache.CacheStatus.SYNCED)));
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsError);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(null));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.BACKEND_ERROR);
+ }
+
+ CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
+ assertThat(entryValue.getCustomInstallationId().isEmpty()).isTrue();
+ assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
+ assertThat(entryValue.getCacheStatus())
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING_CLEAR);
+ }
+
+ @Test
+ public void testClearCustomInstallationId_CacheError_BackendOk() throws InterruptedException {
+ FirebaseSegmentation firebaseSegmentation =
+ new FirebaseSegmentation(
+ firebaseApp, firebaseInstanceId, cacheReturnsError, backendClientReturnsOk);
+
+ // Expect exception
+ try {
+ Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+ fail();
+ } catch (ExecutionException expected) {
+ Throwable cause = expected.getCause();
+ assertThat(cause).isInstanceOf(SetCustomInstallationIdException.class);
+ assertThat(((SetCustomInstallationIdException) cause).getStatus())
+ .isEqualTo(SetCustomInstallationIdException.Status.CLIENT_ERROR);
+ }
}
}
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index 27ab706b3a8..019a2b8ba08 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
@@ -34,7 +34,8 @@ public class CustomInstallationIdCacheTest {
private FirebaseApp firebaseApp0;
private FirebaseApp firebaseApp1;
- private CustomInstallationIdCache cache;
+ private CustomInstallationIdCache cache0;
+ private CustomInstallationIdCache cache1;
@Before
public void setUp() {
@@ -48,42 +49,44 @@ public void setUp() {
ApplicationProvider.getApplicationContext(),
new FirebaseOptions.Builder().setApplicationId("1:987654321:android:abcdef").build(),
"firebase_app_1");
- cache = CustomInstallationIdCache.getInstance();
+ cache0 = new CustomInstallationIdCache(firebaseApp0);
+ cache1 = new CustomInstallationIdCache(firebaseApp1);
}
@After
public void cleanUp() throws Exception {
- Tasks.await(cache.clearAll());
+ Tasks.await(cache0.clear());
+ Tasks.await(cache1.clear());
}
@Test
public void testReadCacheEntry_Null() {
- assertNull(cache.readCacheEntryValue(firebaseApp0));
- assertNull(cache.readCacheEntryValue(firebaseApp1));
+ assertNull(cache0.readCacheEntryValue());
+ assertNull(cache1.readCacheEntryValue());
}
@Test
public void testUpdateAndReadCacheEntry() throws Exception {
assertTrue(
Tasks.await(
- cache.insertOrUpdateCacheEntry(
- firebaseApp0,
+ cache0.insertOrUpdateCacheEntry(
CustomInstallationIdCacheEntryValue.create(
- "123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.PENDING))));
- CustomInstallationIdCacheEntryValue entryValue = cache.readCacheEntryValue(firebaseApp0);
+ "123456",
+ "cAAAAAAAAAA",
+ CustomInstallationIdCache.CacheStatus.PENDING_UPDATE))));
+ CustomInstallationIdCacheEntryValue entryValue = cache0.readCacheEntryValue();
assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
assertThat(entryValue.getCacheStatus())
- .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING);
- assertNull(cache.readCacheEntryValue(firebaseApp1));
+ .isEqualTo(CustomInstallationIdCache.CacheStatus.PENDING_UPDATE);
+ assertNull(cache1.readCacheEntryValue());
assertTrue(
Tasks.await(
- cache.insertOrUpdateCacheEntry(
- firebaseApp0,
+ cache0.insertOrUpdateCacheEntry(
CustomInstallationIdCacheEntryValue.create(
"123456", "cAAAAAAAAAA", CustomInstallationIdCache.CacheStatus.SYNCED))));
- entryValue = cache.readCacheEntryValue(firebaseApp0);
+ entryValue = cache0.readCacheEntryValue();
assertThat(entryValue.getCustomInstallationId()).isEqualTo("123456");
assertThat(entryValue.getFirebaseInstanceId()).isEqualTo("cAAAAAAAAAA");
assertThat(entryValue.getCacheStatus()).isEqualTo(CustomInstallationIdCache.CacheStatus.SYNCED);
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index eca517db1b3..34de68597c1 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -15,21 +15,45 @@
package com.google.firebase.segmentation;
import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.annotation.RestrictTo;
import com.google.android.gms.common.internal.Preconditions;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.Tasks;
import com.google.firebase.FirebaseApp;
import com.google.firebase.iid.FirebaseInstanceId;
+import com.google.firebase.iid.InstanceIdResult;
+import com.google.firebase.segmentation.SetCustomInstallationIdException.Status;
+import com.google.firebase.segmentation.local.CustomInstallationIdCache;
+import com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue;
+import com.google.firebase.segmentation.remote.SegmentationServiceClient;
+import com.google.firebase.segmentation.remote.SegmentationServiceClient.Code;
/** Entry point of Firebase Segmentation SDK. */
public class FirebaseSegmentation {
private final FirebaseApp firebaseApp;
private final FirebaseInstanceId firebaseInstanceId;
+ private final CustomInstallationIdCache localCache;
+ private final SegmentationServiceClient backendServiceClient;
FirebaseSegmentation(FirebaseApp firebaseApp) {
this.firebaseApp = firebaseApp;
this.firebaseInstanceId = FirebaseInstanceId.getInstance(firebaseApp);
+ localCache = new CustomInstallationIdCache(firebaseApp);
+ backendServiceClient = new SegmentationServiceClient();
+ }
+
+ @RestrictTo(RestrictTo.Scope.TESTS)
+ FirebaseSegmentation(
+ FirebaseApp firebaseApp,
+ FirebaseInstanceId firebaseInstanceId,
+ CustomInstallationIdCache localCache,
+ SegmentationServiceClient backendServiceClient) {
+ this.firebaseApp = firebaseApp;
+ this.firebaseInstanceId = firebaseInstanceId;
+ this.localCache = localCache;
+ this.backendServiceClient = backendServiceClient;
}
/**
@@ -55,7 +79,162 @@ public static FirebaseSegmentation getInstance(@NonNull FirebaseApp app) {
return app.get(FirebaseSegmentation.class);
}
- Task setCustomInstallationId(String customInstallationId) {
- return Tasks.forResult(null);
+ @NonNull
+ public synchronized Task setCustomInstallationId(@Nullable String customInstallationId) {
+ if (customInstallationId == null) {
+ return clearCustomInstallationId();
+ }
+ return updateCustomInstallationId(customInstallationId);
+ }
+
+ /**
+ * Update custom installation id of the {@link FirebaseApp} on Firebase segmentation backend and
+ * client side cache.
+ *
+ *
+ * The workflow is:
+ * check diff against cache or cache status is not SYNCED
+ * |
+ * get Firebase instance id and token
+ * | |
+ * | update cache with cache status PENDING_UPDATE
+ * | |
+ * send http request to backend
+ * |
+ * on success: set cache entry status to SYNCED
+ * |
+ * return
+ *
+ */
+ private Task updateCustomInstallationId(String customInstallationId) {
+ CustomInstallationIdCacheEntryValue cacheEntryValue = localCache.readCacheEntryValue();
+ if (cacheEntryValue != null
+ && cacheEntryValue.getCustomInstallationId().equals(customInstallationId)
+ && cacheEntryValue.getCacheStatus() == CustomInstallationIdCache.CacheStatus.SYNCED) {
+ // If the given custom installation id matches up the cached
+ // value, there's no need to update.
+ return Tasks.forResult(null);
+ }
+
+ Task instanceIdResultTask = firebaseInstanceId.getInstanceId();
+ Task firstUpdateCacheResultTask =
+ instanceIdResultTask.onSuccessTask(
+ instanceIdResult ->
+ localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ customInstallationId,
+ instanceIdResult.getId(),
+ CustomInstallationIdCache.CacheStatus.PENDING_UPDATE)));
+
+ // Start requesting backend when first cache update is done.
+ Task backendRequestResultTask =
+ firstUpdateCacheResultTask.onSuccessTask(
+ firstUpdateCacheResult -> {
+ if (firstUpdateCacheResult) {
+ String iid = instanceIdResultTask.getResult().getId();
+ String iidToken = instanceIdResultTask.getResult().getToken();
+ return backendServiceClient.updateCustomInstallationId(
+ Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ customInstallationId,
+ iid,
+ iidToken);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
+
+ Task finalUpdateCacheResultTask =
+ backendRequestResultTask.onSuccessTask(
+ backendRequestResult -> {
+ switch (backendRequestResult) {
+ case OK:
+ return localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ customInstallationId,
+ instanceIdResultTask.getResult().getId(),
+ CustomInstallationIdCache.CacheStatus.SYNCED));
+ case ALREADY_EXISTS:
+ throw new SetCustomInstallationIdException(
+ Status.DUPLICATED_CUSTOM_INSTALLATION_ID);
+ default:
+ throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
+ }
+ });
+
+ return finalUpdateCacheResultTask.onSuccessTask(
+ finalUpdateCacheResult -> {
+ if (finalUpdateCacheResult) {
+ return Tasks.forResult(null);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
+ }
+
+ /**
+ * Clear custom installation id of the {@link FirebaseApp} on Firebase segmentation backend and
+ * client side cache.
+ *
+ *
+ * The workflow is:
+ * get Firebase instance id and token
+ * | |
+ * | update cache with cache status PENDING_CLEAR
+ * | |
+ * send http request to backend
+ * |
+ * on success: delete cache entry
+ * |
+ * return
+ *
+ */
+ private Task clearCustomInstallationId() {
+ Task instanceIdResultTask = firebaseInstanceId.getInstanceId();
+ Task firstUpdateCacheResultTask =
+ instanceIdResultTask.onSuccessTask(
+ instanceIdResult ->
+ localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ "",
+ instanceIdResult.getId(),
+ CustomInstallationIdCache.CacheStatus.PENDING_CLEAR)));
+
+ Task backendRequestResultTask =
+ firstUpdateCacheResultTask.onSuccessTask(
+ firstUpdateCacheResult -> {
+ if (firstUpdateCacheResult) {
+ String iid = instanceIdResultTask.getResult().getId();
+ String iidToken = instanceIdResultTask.getResult().getToken();
+ return backendServiceClient.clearCustomInstallationId(
+ Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ iid,
+ iidToken);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
+
+ Task finalUpdateCacheResultTask =
+ backendRequestResultTask.onSuccessTask(
+ backendRequestResult -> {
+ if (backendRequestResult == Code.OK) {
+ return localCache.clear();
+ } else {
+ throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
+ }
+ });
+
+ return finalUpdateCacheResultTask.onSuccessTask(
+ finalUpdateCacheResult -> {
+ if (finalUpdateCacheResult) {
+ return Tasks.forResult(null);
+ } else {
+ throw new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR);
+ }
+ });
}
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java
new file mode 100644
index 00000000000..3c957ce3294
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/SetCustomInstallationIdException.java
@@ -0,0 +1,68 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import androidx.annotation.NonNull;
+import com.google.firebase.FirebaseException;
+
+/** The class for all Exceptions thrown by {@link FirebaseSegmentation}. */
+public class SetCustomInstallationIdException extends FirebaseException {
+
+ public enum Status {
+ UNKOWN(0),
+
+ /** Error in Firebase SDK. */
+ CLIENT_ERROR(1),
+
+ /** Error when calling Firebase segmentation backend. */
+ BACKEND_ERROR(2),
+
+ /** The given custom installation is already tied to another Firebase installation. */
+ DUPLICATED_CUSTOM_INSTALLATION_ID(3);
+
+ private final int value;
+
+ Status(int value) {
+ this.value = value;
+ }
+ }
+
+ @NonNull private final Status status;
+
+ SetCustomInstallationIdException(@NonNull Status status) {
+ this.status = status;
+ }
+
+ SetCustomInstallationIdException(@NonNull String message, @NonNull Status status) {
+ super(message);
+ this.status = status;
+ }
+
+ SetCustomInstallationIdException(
+ @NonNull String message, @NonNull Status status, Throwable cause) {
+ super(message, cause);
+ this.status = status;
+ }
+
+ /**
+ * Gets the status code for the operation that failed.
+ *
+ * @return the code for the SetCustomInstallationIdException
+ */
+ @NonNull
+ public Status getStatus() {
+ return status;
+ }
+}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java
new file mode 100644
index 00000000000..ca231a89cb5
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/Utils.java
@@ -0,0 +1,33 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/** Util methods used for {@link FirebaseSegmentation} */
+class Utils {
+
+ private static final Pattern APP_ID_PATTERN =
+ Pattern.compile("^[^:]+:([0-9]+):(android|ios|web):([0-9a-f]+)");
+
+ static long getProjectNumberFromAppId(String appId) {
+ Matcher matcher = APP_ID_PATTERN.matcher(appId);
+ if (matcher.matches()) {
+ return Long.valueOf(matcher.group(1));
+ }
+ throw new IllegalArgumentException("Invalid app id " + appId);
+ }
+}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index 2b93231eb39..a1346062440 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -17,27 +17,30 @@
import android.content.Context;
import android.content.SharedPreferences;
import androidx.annotation.Nullable;
-import androidx.annotation.RestrictTo;
-import com.google.android.gms.common.util.Strings;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.firebase.FirebaseApp;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
-class CustomInstallationIdCache {
+/**
+ * A layer that locally caches a few Firebase Segmentation attributes on top the Segmentation
+ * backend API.
+ */
+public class CustomInstallationIdCache {
// Status of each cache entry
// NOTE: never change the ordinal of the enum values because the enum values are stored in cache
// as their ordinal numbers.
- enum CacheStatus {
+ public enum CacheStatus {
// Cache entry is synced to Firebase backend
SYNCED,
- // Cache entry is waiting for Firebase backend response or pending internal retry for retryable
- // errors.
- PENDING,
- // Cache entry is not accepted by Firebase backend.
- ERROR,
+ // Cache entry is waiting for Firebase backend response or internal network retry (for update
+ // operation).
+ PENDING_UPDATE,
+ // Cache entry is waiting for Firebase backend response or internal network retry (for clear
+ // operation).
+ PENDING_CLEAR
}
private static final String SHARED_PREFS_NAME = "CustomInstallationIdCache";
@@ -46,85 +49,59 @@ enum CacheStatus {
private static final String INSTANCE_ID_KEY = "Iid";
private static final String CACHE_STATUS_KEY = "Status";
- private static CustomInstallationIdCache singleton = null;
private final Executor ioExecuter;
private final SharedPreferences prefs;
+ private final String persistenceKey;
- static synchronized CustomInstallationIdCache getInstance() {
- if (singleton == null) {
- singleton = new CustomInstallationIdCache();
- }
- return singleton;
- }
-
- private CustomInstallationIdCache() {
- // Since different FirebaseApp in the same Android application should have the same application
- // context and same dir path, so that use the context of the default FirebaseApp to create the
- // shared preferences.
+ public CustomInstallationIdCache(FirebaseApp firebaseApp) {
+ // Different FirebaseApp in the same Android application should have the same application
+ // context and same dir path
prefs =
- FirebaseApp.getInstance()
+ firebaseApp
.getApplicationContext()
.getSharedPreferences(SHARED_PREFS_NAME, Context.MODE_PRIVATE);
-
+ persistenceKey = firebaseApp.getPersistenceKey();
ioExecuter = Executors.newFixedThreadPool(2);
}
@Nullable
- synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue(FirebaseApp firebaseApp) {
- String cid =
- prefs.getString(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY), null);
- String iid = prefs.getString(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), null);
- int status = prefs.getInt(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY), -1);
+ public synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue() {
+ String cid = prefs.getString(getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY), null);
+ String iid = prefs.getString(getSharedPreferencesKey(INSTANCE_ID_KEY), null);
+ int status = prefs.getInt(getSharedPreferencesKey(CACHE_STATUS_KEY), -1);
- if (Strings.isEmptyOrWhitespace(cid) || Strings.isEmptyOrWhitespace(iid) || status == -1) {
+ if (cid == null || iid == null || status == -1) {
return null;
}
return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
}
- synchronized Task insertOrUpdateCacheEntry(
- FirebaseApp firebaseApp, CustomInstallationIdCacheEntryValue entryValue) {
+ public synchronized Task insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue entryValue) {
SharedPreferences.Editor editor = prefs.edit();
editor.putString(
- getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY),
- entryValue.getCustomInstallationId());
- editor.putString(
- getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
- editor.putInt(
- getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY),
- entryValue.getCacheStatus().ordinal());
- return commitSharedPreferencesEditAsync(editor);
- }
-
- synchronized Task clear(FirebaseApp firebaseApp) {
- SharedPreferences.Editor editor = prefs.edit();
- editor.remove(getSharedPreferencesKey(firebaseApp, CUSTOM_INSTALLATION_ID_KEY));
- editor.remove(getSharedPreferencesKey(firebaseApp, INSTANCE_ID_KEY));
- editor.remove(getSharedPreferencesKey(firebaseApp, CACHE_STATUS_KEY));
+ getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY), entryValue.getCustomInstallationId());
+ editor.putString(getSharedPreferencesKey(INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
+ editor.putInt(getSharedPreferencesKey(CACHE_STATUS_KEY), entryValue.getCacheStatus().ordinal());
return commitSharedPreferencesEditAsync(editor);
}
- @RestrictTo(RestrictTo.Scope.TESTS)
- synchronized Task clearAll() {
+ public synchronized Task clear() {
SharedPreferences.Editor editor = prefs.edit();
- editor.clear();
+ editor.remove(getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY));
+ editor.remove(getSharedPreferencesKey(INSTANCE_ID_KEY));
+ editor.remove(getSharedPreferencesKey(CACHE_STATUS_KEY));
return commitSharedPreferencesEditAsync(editor);
}
- private static String getSharedPreferencesKey(FirebaseApp firebaseApp, String key) {
- return String.format("%s|%s", firebaseApp.getPersistenceKey(), key);
+ private String getSharedPreferencesKey(String key) {
+ return String.format("%s|%s", persistenceKey, key);
}
private Task commitSharedPreferencesEditAsync(SharedPreferences.Editor editor) {
- TaskCompletionSource result = new TaskCompletionSource();
- ioExecuter.execute(
- new Runnable() {
- @Override
- public void run() {
- result.setResult(editor.commit());
- }
- });
+ TaskCompletionSource result = new TaskCompletionSource<>();
+ ioExecuter.execute(() -> result.setResult(editor.commit()));
return result.getTask();
}
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
index 2d3b5f3c3a6..05528cd40f0 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
@@ -22,14 +22,14 @@
* Firebase instance id, a custom installation id and the cache status of this entry.
*/
@AutoValue
-abstract class CustomInstallationIdCacheEntryValue {
- abstract String getCustomInstallationId();
+public abstract class CustomInstallationIdCacheEntryValue {
+ public abstract String getCustomInstallationId();
- abstract String getFirebaseInstanceId();
+ public abstract String getFirebaseInstanceId();
- abstract CacheStatus getCacheStatus();
+ public abstract CacheStatus getCacheStatus();
- static CustomInstallationIdCacheEntryValue create(
+ public static CustomInstallationIdCacheEntryValue create(
String customInstallationId, String firebaseInstanceId, CacheStatus cacheStatus) {
return new AutoValue_CustomInstallationIdCacheEntryValue(
customInstallationId, firebaseInstanceId, cacheStatus);
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
new file mode 100644
index 00000000000..59398b369d5
--- /dev/null
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
@@ -0,0 +1,56 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.segmentation.remote;
+
+import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.Tasks;
+import com.squareup.okhttp.OkHttpClient;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Executors;
+
+/** Http client that sends request to Firebase Segmentation backend API. To be implemented */
+public class SegmentationServiceClient {
+
+ private final OkHttpClient httpClient;
+ private final Executor httpRequestExecutor;
+
+ public enum Code {
+ OK,
+
+ SERVER_INTERNAL_ERROR,
+
+ ALREADY_EXISTS,
+
+ PERMISSION_DENIED
+ }
+
+ public SegmentationServiceClient() {
+ httpClient = new OkHttpClient();
+ httpRequestExecutor = Executors.newFixedThreadPool(4);
+ }
+
+ public Task updateCustomInstallationId(
+ long projectNumber,
+ String customInstallationId,
+ String firebaseInstanceId,
+ String firebaseInstanceIdToken) {
+ return Tasks.forResult(Code.OK);
+ }
+
+ public Task clearCustomInstallationId(
+ long projectNumber, String firebaseInstanceId, String firebaseInstanceIdToken) {
+ return Tasks.forResult(Code.OK);
+ }
+}
diff --git a/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java b/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java
index 1f3c441808f..56b0d120eb0 100644
--- a/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java
+++ b/firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrarTest.java
@@ -15,7 +15,6 @@
package com.google.firebase.segmentation;
import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
import androidx.test.core.app.ApplicationProvider;
import com.google.firebase.FirebaseApp;
@@ -48,10 +47,8 @@ public void getFirebaseInstallationsInstance() {
FirebaseSegmentation defaultSegmentation = FirebaseSegmentation.getInstance();
assertNotNull(defaultSegmentation);
- assertNull(defaultSegmentation.setCustomInstallationId("12345").getResult());
FirebaseSegmentation anotherSegmentation = FirebaseSegmentation.getInstance(anotherApp);
assertNotNull(anotherSegmentation);
- assertNull(anotherSegmentation.setCustomInstallationId("ghdjaas").getResult());
}
}
From 6a0f50241fe81025e2c6c48e803cdf78abb6e5f6 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Wed, 26 Jun 2019 13:21:20 -0700
Subject: [PATCH 22/74] Http client in Firebase Segmentation SDK to call
backend service.
---
.../firebase-segmentation.gradle | 45 +-----
.../segmentation/FirebaseSegmentation.java | 17 +-
.../remote/SegmentationServiceClient.java | 153 +++++++++++++++++-
3 files changed, 165 insertions(+), 50 deletions(-)
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index 1f76b8b593a..70b0f82fa14 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/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
@@ -65,8 +32,11 @@ android {
}
sourceSets {
main {
- proto {
- srcDir 'src/main/proto'
+ java {
+ }
+ }
+ test {
+ java {
}
}
}
@@ -83,14 +53,11 @@ 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'
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index 34de68597c1..6a7550cb5a4 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -135,6 +135,7 @@ private Task updateCustomInstallationId(String customInstallationId) {
String iidToken = instanceIdResultTask.getResult().getToken();
return backendServiceClient.updateCustomInstallationId(
Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ firebaseApp.getOptions().getApiKey(),
customInstallationId,
iid,
iidToken);
@@ -154,7 +155,9 @@ private Task updateCustomInstallationId(String customInstallationId) {
customInstallationId,
instanceIdResultTask.getResult().getId(),
CustomInstallationIdCache.CacheStatus.SYNCED));
- case ALREADY_EXISTS:
+ case HTTP_CLIENT_ERROR:
+ throw new SetCustomInstallationIdException(Status.CLIENT_ERROR);
+ case CONFLICT:
throw new SetCustomInstallationIdException(
Status.DUPLICATED_CUSTOM_INSTALLATION_ID);
default:
@@ -209,6 +212,7 @@ private Task clearCustomInstallationId() {
String iidToken = instanceIdResultTask.getResult().getToken();
return backendServiceClient.clearCustomInstallationId(
Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ firebaseApp.getOptions().getApiKey(),
iid,
iidToken);
} else {
@@ -220,10 +224,13 @@ private Task clearCustomInstallationId() {
Task finalUpdateCacheResultTask =
backendRequestResultTask.onSuccessTask(
backendRequestResult -> {
- if (backendRequestResult == Code.OK) {
- return localCache.clear();
- } else {
- throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
+ switch (backendRequestResult) {
+ case OK:
+ return localCache.clear();
+ case HTTP_CLIENT_ERROR:
+ throw new SetCustomInstallationIdException(Status.CLIENT_ERROR);
+ default:
+ throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
}
});
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
index 59398b369d5..5292bc74180 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
@@ -15,25 +15,47 @@
package com.google.firebase.segmentation.remote;
import com.google.android.gms.tasks.Task;
+import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.android.gms.tasks.Tasks;
+import com.squareup.okhttp.MediaType;
import com.squareup.okhttp.OkHttpClient;
+import com.squareup.okhttp.Request;
+import com.squareup.okhttp.RequestBody;
+import com.squareup.okhttp.Response;
+import java.io.IOException;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
+import org.json.JSONException;
+import org.json.JSONObject;
/** Http client that sends request to Firebase Segmentation backend API. To be implemented */
public class SegmentationServiceClient {
+ private static final String FIREBASE_SEGMENTATION_API_DOMAIN =
+ "firebasesegmentation.googleapis.com";
+ private static final String UPDATE_REQUEST_RESOURCE_NAME_FORMAT =
+ "projects/%s/installations/%s/customSegmentationData";
+ private static final String CLEAR_REQUEST_RESOURCE_NAME_FORMAT =
+ "projects/%s/installations/%s/customSegmentationData:clear";
+ private static final String FIREBASE_SEGMENTATION_API_VERSION = "alpha1";
+
+ private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
+
private final OkHttpClient httpClient;
private final Executor httpRequestExecutor;
public enum Code {
OK,
- SERVER_INTERNAL_ERROR,
+ HTTP_CLIENT_ERROR,
+
+ CONFLICT,
- ALREADY_EXISTS,
+ NETWORK_ERROR,
- PERMISSION_DENIED
+ SERVER_ERROR,
+
+ UNAUTHORIZED,
}
public SegmentationServiceClient() {
@@ -43,14 +65,133 @@ public SegmentationServiceClient() {
public Task updateCustomInstallationId(
long projectNumber,
+ String apiKey,
String customInstallationId,
String firebaseInstanceId,
String firebaseInstanceIdToken) {
- return Tasks.forResult(Code.OK);
+ String resourceName =
+ String.format(UPDATE_REQUEST_RESOURCE_NAME_FORMAT, projectNumber, firebaseInstanceId);
+
+ RequestBody requestBody;
+ try {
+ requestBody =
+ RequestBody.create(
+ JSON,
+ buildUpdateCustomSegmentationDataRequestBody(resourceName, customInstallationId)
+ .toString());
+ } catch (JSONException e) {
+ return Tasks.forException(e);
+ }
+
+ Request request =
+ new Request.Builder()
+ .url(
+ String.format(
+ "https://%s/%s/%s",
+ FIREBASE_SEGMENTATION_API_DOMAIN,
+ FIREBASE_SEGMENTATION_API_VERSION,
+ resourceName))
+ .header("X-Goog-Api-Key", apiKey)
+ .header("Authorization", "FIREBASE_INSTALLATIONS_AUTH " + firebaseInstanceIdToken)
+ .header("Content-Type", "application/json")
+ .patch(requestBody)
+ .build();
+
+ TaskCompletionSource taskCompletionSource = new TaskCompletionSource<>();
+ httpRequestExecutor.execute(
+ () -> {
+ try {
+ Response response = httpClient.newCall(request).execute();
+ switch (response.code()) {
+ case 200:
+ taskCompletionSource.setResult(Code.OK);
+ break;
+ case 401:
+ taskCompletionSource.setResult(Code.UNAUTHORIZED);
+ break;
+ case 409:
+ taskCompletionSource.setResult(Code.CONFLICT);
+ break;
+ default:
+ taskCompletionSource.setResult(Code.SERVER_ERROR);
+ break;
+ }
+ } catch (IOException e) {
+ taskCompletionSource.setResult(Code.NETWORK_ERROR);
+ }
+ });
+ return taskCompletionSource.getTask();
+ }
+
+ private static JSONObject buildUpdateCustomSegmentationDataRequestBody(
+ String resourceName, String customInstallationId) throws JSONException {
+ JSONObject rlt = new JSONObject();
+ rlt.put(
+ "update_mask",
+ "custom_segmentation_data.name,custom_segmentation_data.custom_installation_id");
+ JSONObject customSegmentationData = new JSONObject();
+ customSegmentationData.put("name", resourceName);
+ customSegmentationData.put("custom_installation_id", customInstallationId);
+ rlt.put("custom_segmentation_data", customSegmentationData);
+ return rlt;
}
public Task clearCustomInstallationId(
- long projectNumber, String firebaseInstanceId, String firebaseInstanceIdToken) {
- return Tasks.forResult(Code.OK);
+ long projectNumber,
+ String apiKey,
+ String firebaseInstanceId,
+ String firebaseInstanceIdToken) {
+ String resourceName =
+ String.format(CLEAR_REQUEST_RESOURCE_NAME_FORMAT, projectNumber, firebaseInstanceId);
+
+ RequestBody requestBody;
+ try {
+ requestBody =
+ RequestBody.create(
+ JSON, buildClearCustomSegmentationDataRequestBody(resourceName).toString());
+ } catch (JSONException e) {
+ return Tasks.forException(e);
+ }
+
+ Request request =
+ new Request.Builder()
+ .url(
+ String.format(
+ "https://%s/%s/%s",
+ FIREBASE_SEGMENTATION_API_DOMAIN,
+ FIREBASE_SEGMENTATION_API_VERSION,
+ resourceName))
+ .header("X-Goog-Api-Key", apiKey)
+ .header("Authorization", "FIREBASE_INSTALLATIONS_AUTH " + firebaseInstanceIdToken)
+ .header("Content-Type", "application/json")
+ .post(requestBody)
+ .build();
+
+ TaskCompletionSource taskCompletionSource = new TaskCompletionSource<>();
+ httpRequestExecutor.execute(
+ () -> {
+ try {
+ Response response = httpClient.newCall(request).execute();
+ switch (response.code()) {
+ case 200:
+ taskCompletionSource.setResult(Code.OK);
+ break;
+ case 401:
+ taskCompletionSource.setResult(Code.UNAUTHORIZED);
+ break;
+ default:
+ taskCompletionSource.setResult(Code.SERVER_ERROR);
+ break;
+ }
+ } catch (IOException e) {
+ taskCompletionSource.setResult(Code.NETWORK_ERROR);
+ }
+ });
+ return taskCompletionSource.getTask();
+ }
+
+ private static JSONObject buildClearCustomSegmentationDataRequestBody(String resourceName)
+ throws JSONException {
+ return new JSONObject().put("name", resourceName);
}
}
From 7f4097836d1787bc1f267c2170dc318738423479 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Wed, 26 Jun 2019 13:26:07 -0700
Subject: [PATCH 23/74] Revert unintentional change
---
subprojects.cfg | 1 -
1 file changed, 1 deletion(-)
diff --git a/subprojects.cfg b/subprojects.cfg
index e27229cee5b..6a09b6d4a45 100644
--- a/subprojects.cfg
+++ b/subprojects.cfg
@@ -15,7 +15,6 @@ firebase-inappmessaging-display
firebase-storage
firebase-storage:test-app
firebase-segmentation
-
protolite-well-known-types
tools:errorprone
From b2fc302762cb4562646587466a08eb7e244c5928 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Wed, 26 Jun 2019 13:39:30 -0700
Subject: [PATCH 24/74] Fix connected device test
---
.../FirebaseSegmentationInstrumentedTest.java | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index 8519e641cb7..3bac1321da6 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/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()))
+ anyLong(), anyString(), anyString(), anyString(), anyString()))
.thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
- when(backendClientReturnsOk.clearCustomInstallationId(anyLong(), anyString(), anyString()))
+ when(backendClientReturnsOk.clearCustomInstallationId(
+ anyLong(), anyString(), anyString(), anyString()))
.thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
when(backendClientReturnsError.updateCustomInstallationId(
+ anyLong(), anyString(), anyString(), anyString(), anyString()))
+ .thenReturn(Tasks.forResult(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(Tasks.forResult(SegmentationServiceClient.Code.SERVER_ERROR));
when(firebaseInstanceId.getInstanceId())
.thenReturn(
Tasks.forResult(
From 1f2ab34e45e6414d8663a70099650d0feac2b8f2 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Wed, 26 Jun 2019 13:39:30 -0700
Subject: [PATCH 25/74] Fix connected device test
---
.../FirebaseSegmentationInstrumentedTest.java | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index 8519e641cb7..a2ac5f52b90 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/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()))
+ anyLong(), anyString(), anyString(), anyString(), anyString()))
.thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
- when(backendClientReturnsOk.clearCustomInstallationId(anyLong(), anyString(), anyString()))
+ when(backendClientReturnsOk.clearCustomInstallationId(
+ anyLong(), anyString(), anyString(), anyString()))
.thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
when(backendClientReturnsError.updateCustomInstallationId(
+ anyLong(), anyString(), anyString(), anyString(), anyString()))
+ .thenReturn(Tasks.forResult(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(Tasks.forResult(SegmentationServiceClient.Code.SERVER_ERROR));
when(firebaseInstanceId.getInstanceId())
.thenReturn(
Tasks.forResult(
From 9880624380da20818bcc43a9902cd6bf9b2bba73 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Mon, 8 Jul 2019 12:46:15 -0700
Subject: [PATCH 26/74] 1. Add a few annotations to make java code Kotlin
friendly 2. Some fixes for the http request format
---
.../firebase-segmentation.gradle | 2 +-
.../segmentation/FirebaseSegmentation.java | 1 +
.../FirebaseSegmentationRegistrar.java | 2 ++
.../local/CustomInstallationIdCache.java | 7 ++--
.../CustomInstallationIdCacheEntryValue.java | 9 ++++-
.../remote/SegmentationServiceClient.java | 36 +++++++++----------
6 files changed, 34 insertions(+), 23 deletions(-)
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index 70b0f82fa14..fa48a4ac58e 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/firebase-segmentation/firebase-segmentation.gradle
@@ -70,7 +70,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'
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index 6a7550cb5a4..26af8c6a817 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -17,6 +17,7 @@
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RestrictTo;
+
import com.google.android.gms.common.internal.Preconditions;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.Tasks;
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrar.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrar.java
index 7d1d5fcfaab..ca7f688d60a 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrar.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentationRegistrar.java
@@ -14,6 +14,7 @@
package com.google.firebase.segmentation;
+import androidx.annotation.NonNull;
import com.google.firebase.FirebaseApp;
import com.google.firebase.components.Component;
import com.google.firebase.components.ComponentRegistrar;
@@ -25,6 +26,7 @@
public class FirebaseSegmentationRegistrar implements ComponentRegistrar {
@Override
+ @NonNull
public List> getComponents() {
return Arrays.asList(
Component.builder(FirebaseSegmentation.class)
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index a1346062440..05f652d4723 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -16,6 +16,7 @@
import android.content.Context;
import android.content.SharedPreferences;
+import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.TaskCompletionSource;
@@ -53,7 +54,7 @@ public enum CacheStatus {
private final SharedPreferences prefs;
private final String persistenceKey;
- public CustomInstallationIdCache(FirebaseApp firebaseApp) {
+ public CustomInstallationIdCache(@NonNull FirebaseApp firebaseApp) {
// Different FirebaseApp in the same Android application should have the same application
// context and same dir path
prefs =
@@ -77,8 +78,9 @@ public synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue() {
return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
}
+ @NonNull
public synchronized Task insertOrUpdateCacheEntry(
- CustomInstallationIdCacheEntryValue entryValue) {
+ @NonNull CustomInstallationIdCacheEntryValue entryValue) {
SharedPreferences.Editor editor = prefs.edit();
editor.putString(
getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY), entryValue.getCustomInstallationId());
@@ -87,6 +89,7 @@ public synchronized Task insertOrUpdateCacheEntry(
return commitSharedPreferencesEditAsync(editor);
}
+ @NonNull
public synchronized Task clear() {
SharedPreferences.Editor editor = prefs.edit();
editor.remove(getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY));
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
index 05528cd40f0..5e2c1944278 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheEntryValue.java
@@ -14,6 +14,7 @@
package com.google.firebase.segmentation.local;
+import androidx.annotation.NonNull;
import com.google.auto.value.AutoValue;
import com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus;
@@ -23,14 +24,20 @@
*/
@AutoValue
public abstract class CustomInstallationIdCacheEntryValue {
+ @NonNull
public abstract String getCustomInstallationId();
+ @NonNull
public abstract String getFirebaseInstanceId();
+ @NonNull
public abstract CacheStatus getCacheStatus();
+ @NonNull
public static CustomInstallationIdCacheEntryValue create(
- String customInstallationId, String firebaseInstanceId, CacheStatus cacheStatus) {
+ @NonNull String customInstallationId,
+ @NonNull String firebaseInstanceId,
+ @NonNull CacheStatus cacheStatus) {
return new AutoValue_CustomInstallationIdCacheEntryValue(
customInstallationId, firebaseInstanceId, cacheStatus);
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
index 5292bc74180..71dfb19c6c9 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
@@ -14,6 +14,7 @@
package com.google.firebase.segmentation.remote;
+import androidx.annotation.NonNull;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.android.gms.tasks.Tasks;
@@ -63,12 +64,13 @@ public SegmentationServiceClient() {
httpRequestExecutor = Executors.newFixedThreadPool(4);
}
+ @NonNull
public Task updateCustomInstallationId(
long projectNumber,
- String apiKey,
- String customInstallationId,
- String firebaseInstanceId,
- String firebaseInstanceIdToken) {
+ @NonNull String apiKey,
+ @NonNull String customInstallationId,
+ @NonNull String firebaseInstanceId,
+ @NonNull String firebaseInstanceIdToken) {
String resourceName =
String.format(UPDATE_REQUEST_RESOURCE_NAME_FORMAT, projectNumber, firebaseInstanceId);
@@ -87,11 +89,11 @@ public Task updateCustomInstallationId(
new Request.Builder()
.url(
String.format(
- "https://%s/%s/%s",
+ "https://%s/%s/%s?key=%s",
FIREBASE_SEGMENTATION_API_DOMAIN,
FIREBASE_SEGMENTATION_API_VERSION,
- resourceName))
- .header("X-Goog-Api-Key", apiKey)
+ resourceName,
+ apiKey))
.header("Authorization", "FIREBASE_INSTALLATIONS_AUTH " + firebaseInstanceIdToken)
.header("Content-Type", "application/json")
.patch(requestBody)
@@ -125,22 +127,18 @@ public Task updateCustomInstallationId(
private static JSONObject buildUpdateCustomSegmentationDataRequestBody(
String resourceName, String customInstallationId) throws JSONException {
- JSONObject rlt = new JSONObject();
- rlt.put(
- "update_mask",
- "custom_segmentation_data.name,custom_segmentation_data.custom_installation_id");
JSONObject customSegmentationData = new JSONObject();
customSegmentationData.put("name", resourceName);
customSegmentationData.put("custom_installation_id", customInstallationId);
- rlt.put("custom_segmentation_data", customSegmentationData);
- return rlt;
+ return customSegmentationData;
}
+ @NonNull
public Task clearCustomInstallationId(
long projectNumber,
- String apiKey,
- String firebaseInstanceId,
- String firebaseInstanceIdToken) {
+ @NonNull String apiKey,
+ @NonNull String firebaseInstanceId,
+ @NonNull String firebaseInstanceIdToken) {
String resourceName =
String.format(CLEAR_REQUEST_RESOURCE_NAME_FORMAT, projectNumber, firebaseInstanceId);
@@ -157,11 +155,11 @@ public Task clearCustomInstallationId(
new Request.Builder()
.url(
String.format(
- "https://%s/%s/%s",
+ "https://%s/%s/%s?key=%s",
FIREBASE_SEGMENTATION_API_DOMAIN,
FIREBASE_SEGMENTATION_API_VERSION,
- resourceName))
- .header("X-Goog-Api-Key", apiKey)
+ resourceName,
+ apiKey))
.header("Authorization", "FIREBASE_INSTALLATIONS_AUTH " + firebaseInstanceIdToken)
.header("Content-Type", "application/json")
.post(requestBody)
From 8ffb5bb6e35e4b753c0eb6376a66f964ad37db4e Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Mon, 8 Jul 2019 13:26:45 -0700
Subject: [PATCH 27/74] Fix java format
---
.../com/google/firebase/segmentation/FirebaseSegmentation.java | 1 -
1 file changed, 1 deletion(-)
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index 26af8c6a817..6a7550cb5a4 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -17,7 +17,6 @@
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RestrictTo;
-
import com.google.android.gms.common.internal.Preconditions;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.tasks.Tasks;
From daf4698905e6fb54bd4f9fd190c2b2dfc8e51c83 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Mon, 8 Jul 2019 13:46:38 -0700
Subject: [PATCH 28/74] Fix API version
---
.../firebase/segmentation/remote/SegmentationServiceClient.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
index 71dfb19c6c9..e258b84ad06 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
@@ -38,7 +38,7 @@ public class SegmentationServiceClient {
"projects/%s/installations/%s/customSegmentationData";
private static final String CLEAR_REQUEST_RESOURCE_NAME_FORMAT =
"projects/%s/installations/%s/customSegmentationData:clear";
- private static final String FIREBASE_SEGMENTATION_API_VERSION = "alpha1";
+ private static final String FIREBASE_SEGMENTATION_API_VERSION = "v1alpha";
private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
From 7985e146526d6b648d322ba81b3da5a752c22df5 Mon Sep 17 00:00:00 2001
From: Di Wu
Date: Tue, 9 Jul 2019 10:55:56 -0700
Subject: [PATCH 29/74] Change the segmentation API implementation to
synchronous and put the entire synchronous code block in async task.
---
.../firebase-segmentation.gradle | 14 +-
.../FirebaseSegmentationInstrumentedTest.java | 34 ++-
.../local/CustomInstallationIdCacheTest.java | 21 +-
.../segmentation/FirebaseSegmentation.java | 229 ++++++++++--------
.../local/CustomInstallationIdCache.java | 20 +-
.../remote/SegmentationServiceClient.java | 90 +++----
6 files changed, 186 insertions(+), 222 deletions(-)
diff --git a/firebase-segmentation/firebase-segmentation.gradle b/firebase-segmentation/firebase-segmentation.gradle
index fa48a4ac58e..d16e46b402b 100644
--- a/firebase-segmentation/firebase-segmentation.gradle
+++ b/firebase-segmentation/firebase-segmentation.gradle
@@ -30,16 +30,6 @@ android {
versionName version
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
- sourceSets {
- main {
- java {
- }
- }
- test {
- java {
- }
- }
- }
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
@@ -59,8 +49,8 @@ dependencies {
}
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 'androidx.multidex:multidex:2.0.1'
+ implementation 'com.google.android.gms:play-services-tasks:17.0.0'
implementation 'com.squareup.okhttp:okhttp:2.7.5'
compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
index a2ac5f52b90..19498782a78 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
+++ b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java
@@ -77,16 +77,16 @@ public void setUp() {
when(backendClientReturnsOk.updateCustomInstallationId(
anyLong(), anyString(), anyString(), anyString(), anyString()))
- .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+ .thenReturn(SegmentationServiceClient.Code.OK);
when(backendClientReturnsOk.clearCustomInstallationId(
anyLong(), anyString(), anyString(), anyString()))
- .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.OK));
+ .thenReturn(SegmentationServiceClient.Code.OK);
when(backendClientReturnsError.updateCustomInstallationId(
anyLong(), anyString(), anyString(), anyString(), anyString()))
- .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.SERVER_ERROR));
+ .thenReturn(SegmentationServiceClient.Code.SERVER_ERROR);
when(backendClientReturnsError.clearCustomInstallationId(
anyLong(), anyString(), anyString(), anyString()))
- .thenReturn(Tasks.forResult(SegmentationServiceClient.Code.SERVER_ERROR));
+ .thenReturn(SegmentationServiceClient.Code.SERVER_ERROR);
when(firebaseInstanceId.getInstanceId())
.thenReturn(
Tasks.forResult(
@@ -103,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
@@ -170,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);
@@ -188,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);
diff --git a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java b/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
index 019a2b8ba08..9e22e522d2b 100644
--- a/firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/local/CustomInstallationIdCacheTest.java
+++ b/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");
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
index 6a7550cb5a4..7a6d879d669 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/FirebaseSegmentation.java
@@ -19,7 +19,7 @@
import androidx.annotation.RestrictTo;
import com.google.android.gms.common.internal.Preconditions;
import com.google.android.gms.tasks.Task;
-import com.google.android.gms.tasks.Tasks;
+import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.firebase.FirebaseApp;
import com.google.firebase.iid.FirebaseInstanceId;
import com.google.firebase.iid.InstanceIdResult;
@@ -28,6 +28,8 @@
import com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue;
import com.google.firebase.segmentation.remote.SegmentationServiceClient;
import com.google.firebase.segmentation.remote.SegmentationServiceClient.Code;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Executors;
/** Entry point of Firebase Segmentation SDK. */
public class FirebaseSegmentation {
@@ -36,12 +38,14 @@ public class FirebaseSegmentation {
private final FirebaseInstanceId firebaseInstanceId;
private final CustomInstallationIdCache localCache;
private final SegmentationServiceClient backendServiceClient;
+ private final Executor executor;
FirebaseSegmentation(FirebaseApp firebaseApp) {
this.firebaseApp = firebaseApp;
this.firebaseInstanceId = FirebaseInstanceId.getInstance(firebaseApp);
- localCache = new CustomInstallationIdCache(firebaseApp);
- backendServiceClient = new SegmentationServiceClient();
+ this.localCache = new CustomInstallationIdCache(firebaseApp);
+ this.backendServiceClient = new SegmentationServiceClient();
+ this.executor = Executors.newFixedThreadPool(4);
}
@RestrictTo(RestrictTo.Scope.TESTS)
@@ -54,6 +58,7 @@ public class FirebaseSegmentation {
this.firebaseInstanceId = firebaseInstanceId;
this.localCache = localCache;
this.backendServiceClient = backendServiceClient;
+ this.executor = Executors.newFixedThreadPool(4);
}
/**
@@ -107,73 +112,79 @@ public synchronized Task setCustomInstallationId(@Nullable String customIn
*
*/
private Task updateCustomInstallationId(String customInstallationId) {
- CustomInstallationIdCacheEntryValue cacheEntryValue = localCache.readCacheEntryValue();
- if (cacheEntryValue != null
- && cacheEntryValue.getCustomInstallationId().equals(customInstallationId)
- && cacheEntryValue.getCacheStatus() == CustomInstallationIdCache.CacheStatus.SYNCED) {
- // If the given custom installation id matches up the cached
- // value, there's no need to update.
- return Tasks.forResult(null);
- }
+ TaskCompletionSource taskCompletionSource = new TaskCompletionSource<>();
+
+ executor.execute(
+ () -> {
+ CustomInstallationIdCacheEntryValue cacheEntryValue = localCache.readCacheEntryValue();
+ if (cacheEntryValue != null
+ && cacheEntryValue.getCustomInstallationId().equals(customInstallationId)
+ && cacheEntryValue.getCacheStatus() == CustomInstallationIdCache.CacheStatus.SYNCED) {
+ // If the given custom installation id matches up the cached
+ // value, there's no need to update.
+ taskCompletionSource.setResult(null);
+ return;
+ }
- Task instanceIdResultTask = firebaseInstanceId.getInstanceId();
- Task firstUpdateCacheResultTask =
- instanceIdResultTask.onSuccessTask(
- instanceIdResult ->
- localCache.insertOrUpdateCacheEntry(
- CustomInstallationIdCacheEntryValue.create(
- customInstallationId,
- instanceIdResult.getId(),
- CustomInstallationIdCache.CacheStatus.PENDING_UPDATE)));
-
- // Start requesting backend when first cache update is done.
- Task backendRequestResultTask =
- firstUpdateCacheResultTask.onSuccessTask(
- firstUpdateCacheResult -> {
- if (firstUpdateCacheResult) {
- String iid = instanceIdResultTask.getResult().getId();
- String iidToken = instanceIdResultTask.getResult().getToken();
- return backendServiceClient.updateCustomInstallationId(
- Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
- firebaseApp.getOptions().getApiKey(),
- customInstallationId,
- iid,
- iidToken);
- } else {
- throw new SetCustomInstallationIdException(
- "Failed to update client side cache", Status.CLIENT_ERROR);
- }
- });
-
- Task finalUpdateCacheResultTask =
- backendRequestResultTask.onSuccessTask(
- backendRequestResult -> {
- switch (backendRequestResult) {
- case OK:
- return localCache.insertOrUpdateCacheEntry(
+ InstanceIdResult instanceIdResult = firebaseInstanceId.getInstanceId().getResult();
+ boolean firstUpdateCacheResult =
+ localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ customInstallationId,
+ instanceIdResult.getId(),
+ CustomInstallationIdCache.CacheStatus.PENDING_UPDATE));
+
+ if (!firstUpdateCacheResult) {
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR));
+ return;
+ }
+
+ // Start requesting backend when first cache updae is done.
+ String iid = instanceIdResult.getId();
+ String iidToken = instanceIdResult.getToken();
+ Code backendRequestResult =
+ backendServiceClient.updateCustomInstallationId(
+ Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ firebaseApp.getOptions().getApiKey(),
+ customInstallationId,
+ iid,
+ iidToken);
+
+ boolean finalUpdateCacheResult;
+ switch (backendRequestResult) {
+ case OK:
+ finalUpdateCacheResult =
+ localCache.insertOrUpdateCacheEntry(
CustomInstallationIdCacheEntryValue.create(
customInstallationId,
- instanceIdResultTask.getResult().getId(),
+ instanceIdResult.getId(),
CustomInstallationIdCache.CacheStatus.SYNCED));
- case HTTP_CLIENT_ERROR:
- throw new SetCustomInstallationIdException(Status.CLIENT_ERROR);
- case CONFLICT:
- throw new SetCustomInstallationIdException(
- Status.DUPLICATED_CUSTOM_INSTALLATION_ID);
- default:
- throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
- }
- });
-
- return finalUpdateCacheResultTask.onSuccessTask(
- finalUpdateCacheResult -> {
+ break;
+ case HTTP_CLIENT_ERROR:
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(Status.CLIENT_ERROR));
+ return;
+ case CONFLICT:
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(Status.DUPLICATED_CUSTOM_INSTALLATION_ID));
+ return;
+ default:
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(Status.BACKEND_ERROR));
+ return;
+ }
+
if (finalUpdateCacheResult) {
- return Tasks.forResult(null);
+ taskCompletionSource.setResult(null);
} else {
- throw new SetCustomInstallationIdException(
- "Failed to update client side cache", Status.CLIENT_ERROR);
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR));
}
});
+ return taskCompletionSource.getTask();
}
/**
@@ -194,54 +205,58 @@ private Task updateCustomInstallationId(String customInstallationId) {
*
*/
private Task clearCustomInstallationId() {
- Task instanceIdResultTask = firebaseInstanceId.getInstanceId();
- Task firstUpdateCacheResultTask =
- instanceIdResultTask.onSuccessTask(
- instanceIdResult ->
- localCache.insertOrUpdateCacheEntry(
- CustomInstallationIdCacheEntryValue.create(
- "",
- instanceIdResult.getId(),
- CustomInstallationIdCache.CacheStatus.PENDING_CLEAR)));
-
- Task backendRequestResultTask =
- firstUpdateCacheResultTask.onSuccessTask(
- firstUpdateCacheResult -> {
- if (firstUpdateCacheResult) {
- String iid = instanceIdResultTask.getResult().getId();
- String iidToken = instanceIdResultTask.getResult().getToken();
- return backendServiceClient.clearCustomInstallationId(
- Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
- firebaseApp.getOptions().getApiKey(),
- iid,
- iidToken);
- } else {
- throw new SetCustomInstallationIdException(
- "Failed to update client side cache", Status.CLIENT_ERROR);
- }
- });
-
- Task finalUpdateCacheResultTask =
- backendRequestResultTask.onSuccessTask(
- backendRequestResult -> {
- switch (backendRequestResult) {
- case OK:
- return localCache.clear();
- case HTTP_CLIENT_ERROR:
- throw new SetCustomInstallationIdException(Status.CLIENT_ERROR);
- default:
- throw new SetCustomInstallationIdException(Status.BACKEND_ERROR);
- }
- });
-
- return finalUpdateCacheResultTask.onSuccessTask(
- finalUpdateCacheResult -> {
+
+ TaskCompletionSource taskCompletionSource = new TaskCompletionSource<>();
+
+ executor.execute(
+ () -> {
+ InstanceIdResult instanceIdResult = firebaseInstanceId.getInstanceId().getResult();
+ boolean firstUpdateCacheResult =
+ localCache.insertOrUpdateCacheEntry(
+ CustomInstallationIdCacheEntryValue.create(
+ "",
+ instanceIdResult.getId(),
+ CustomInstallationIdCache.CacheStatus.PENDING_CLEAR));
+
+ if (!firstUpdateCacheResult) {
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR));
+ return;
+ }
+
+ String iid = instanceIdResult.getId();
+ String iidToken = instanceIdResult.getToken();
+ Code backendRequestResult =
+ backendServiceClient.clearCustomInstallationId(
+ Utils.getProjectNumberFromAppId(firebaseApp.getOptions().getApplicationId()),
+ firebaseApp.getOptions().getApiKey(),
+ iid,
+ iidToken);
+
+ boolean finalUpdateCacheResult;
+ switch (backendRequestResult) {
+ case OK:
+ finalUpdateCacheResult = localCache.clear();
+ break;
+ case HTTP_CLIENT_ERROR:
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(Status.CLIENT_ERROR));
+ return;
+ default:
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(Status.BACKEND_ERROR));
+ return;
+ }
+
if (finalUpdateCacheResult) {
- return Tasks.forResult(null);
+ taskCompletionSource.setResult(null);
} else {
- throw new SetCustomInstallationIdException(
- "Failed to update client side cache", Status.CLIENT_ERROR);
+ taskCompletionSource.setException(
+ new SetCustomInstallationIdException(
+ "Failed to update client side cache", Status.CLIENT_ERROR));
}
});
+ return taskCompletionSource.getTask();
}
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
index 05f652d4723..307d5d49923 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java
@@ -18,11 +18,7 @@
import android.content.SharedPreferences;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
-import com.google.android.gms.tasks.Task;
-import com.google.android.gms.tasks.TaskCompletionSource;
import com.google.firebase.FirebaseApp;
-import java.util.concurrent.Executor;
-import java.util.concurrent.Executors;
/**
* A layer that locally caches a few Firebase Segmentation attributes on top the Segmentation
@@ -50,7 +46,6 @@ public enum CacheStatus {
private static final String INSTANCE_ID_KEY = "Iid";
private static final String CACHE_STATUS_KEY = "Status";
- private final Executor ioExecuter;
private final SharedPreferences prefs;
private final String persistenceKey;
@@ -62,7 +57,6 @@ public CustomInstallationIdCache(@NonNull FirebaseApp firebaseApp) {
.getApplicationContext()
.getSharedPreferences(SHARED_PREFS_NAME, Context.MODE_PRIVATE);
persistenceKey = firebaseApp.getPersistenceKey();
- ioExecuter = Executors.newFixedThreadPool(2);
}
@Nullable
@@ -79,32 +73,26 @@ public synchronized CustomInstallationIdCacheEntryValue readCacheEntryValue() {
}
@NonNull
- public synchronized Task insertOrUpdateCacheEntry(
+ public synchronized boolean insertOrUpdateCacheEntry(
@NonNull CustomInstallationIdCacheEntryValue entryValue) {
SharedPreferences.Editor editor = prefs.edit();
editor.putString(
getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY), entryValue.getCustomInstallationId());
editor.putString(getSharedPreferencesKey(INSTANCE_ID_KEY), entryValue.getFirebaseInstanceId());
editor.putInt(getSharedPreferencesKey(CACHE_STATUS_KEY), entryValue.getCacheStatus().ordinal());
- return commitSharedPreferencesEditAsync(editor);
+ return editor.commit();
}
@NonNull
- public synchronized Task clear() {
+ public synchronized boolean clear() {
SharedPreferences.Editor editor = prefs.edit();
editor.remove(getSharedPreferencesKey(CUSTOM_INSTALLATION_ID_KEY));
editor.remove(getSharedPreferencesKey(INSTANCE_ID_KEY));
editor.remove(getSharedPreferencesKey(CACHE_STATUS_KEY));
- return commitSharedPreferencesEditAsync(editor);
+ return editor.commit();
}
private String getSharedPreferencesKey(String key) {
return String.format("%s|%s", persistenceKey, key);
}
-
- private Task commitSharedPreferencesEditAsync(SharedPreferences.Editor editor) {
- TaskCompletionSource result = new TaskCompletionSource<>();
- ioExecuter.execute(() -> result.setResult(editor.commit()));
- return result.getTask();
- }
}
diff --git a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
index e258b84ad06..a88ecd7b662 100644
--- a/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
+++ b/firebase-segmentation/src/main/java/com/google/firebase/segmentation/remote/SegmentationServiceClient.java
@@ -15,17 +15,12 @@
package com.google.firebase.segmentation.remote;
import androidx.annotation.NonNull;
-import com.google.android.gms.tasks.Task;
-import com.google.android.gms.tasks.TaskCompletionSource;
-import com.google.android.gms.tasks.Tasks;
import com.squareup.okhttp.MediaType;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.RequestBody;
import com.squareup.okhttp.Response;
import java.io.IOException;
-import java.util.concurrent.Executor;
-import java.util.concurrent.Executors;
import org.json.JSONException;
import org.json.JSONObject;
@@ -43,7 +38,6 @@ public class SegmentationServiceClient {
private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
private final OkHttpClient httpClient;
- private final Executor httpRequestExecutor;
public enum Code {
OK,
@@ -61,11 +55,10 @@ public enum Code {
public SegmentationServiceClient() {
httpClient = new OkHttpClient();
- httpRequestExecutor = Executors.newFixedThreadPool(4);
}
@NonNull
- public Task updateCustomInstallationId(
+ public Code updateCustomInstallationId(
long projectNumber,
@NonNull String apiKey,
@NonNull String customInstallationId,
@@ -82,7 +75,8 @@ public Task updateCustomInstallationId(
buildUpdateCustomSegmentationDataRequestBody(resourceName, customInstallationId)
.toString());
} catch (JSONException e) {
- return Tasks.forException(e);
+ // This should never happen
+ throw new IllegalStateException(e);
}
Request request =
@@ -99,30 +93,21 @@ public Task updateCustomInstallationId(
.patch(requestBody)
.build();
- TaskCompletionSource taskCompletionSource = new TaskCompletionSource<>();
- httpRequestExecutor.execute(
- () -> {
- try {
- Response response = httpClient.newCall(request).execute();
- switch (response.code()) {
- case 200:
- taskCompletionSource.setResult(Code.OK);
- break;
- case 401:
- taskCompletionSource.setResult(Code.UNAUTHORIZED);
- break;
- case 409:
- taskCompletionSource.setResult(Code.CONFLICT);
- break;
- default:
- taskCompletionSource.setResult(Code.SERVER_ERROR);
- break;
- }
- } catch (IOException e) {
- taskCompletionSource.setResult(Code.NETWORK_ERROR);
- }
- });
- return taskCompletionSource.getTask();
+ try {
+ Response response = httpClient.newCall(request).execute();
+ switch (response.code()) {
+ case 200:
+ return Code.OK;
+ case 401:
+ return Code.UNAUTHORIZED;
+ case 409:
+ return Code.CONFLICT;
+ default:
+ return Code.SERVER_ERROR;
+ }
+ } catch (IOException e) {
+ return Code.NETWORK_ERROR;
+ }
}
private static JSONObject buildUpdateCustomSegmentationDataRequestBody(
@@ -134,7 +119,7 @@ private static JSONObject buildUpdateCustomSegmentationDataRequestBody(
}
@NonNull
- public Task clearCustomInstallationId(
+ public Code clearCustomInstallationId(
long projectNumber,
@NonNull String apiKey,
@NonNull String firebaseInstanceId,
@@ -148,7 +133,8 @@ public Task clearCustomInstallationId(
RequestBody.create(
JSON, buildClearCustomSegmentationDataRequestBody(resourceName).toString());
} catch (JSONException e) {
- return Tasks.forException(e);
+ // This should never happen
+ throw new IllegalStateException(e);
}
Request request =
@@ -165,27 +151,19 @@ public Task