Replace the custom installation id cache SharedPref implementation by file implementation.

firebase-segmentation/api.txt

@@ -0,0 +1,72 @@
+// Signature format: 2.0
+package com.google.firebase.segmentation {
+
+  public class FirebaseSegmentation {
+    method @NonNull public static com.google.firebase.segmentation.FirebaseSegmentation getInstance();
+    method @NonNull public static com.google.firebase.segmentation.FirebaseSegmentation getInstance(@NonNull com.google.firebase.FirebaseApp);
+    method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> setCustomInstallationId(@Nullable String);
+    field public static final String TAG = "FirebaseSegmentation";
+  }
+
+  public class FirebaseSegmentationRegistrar implements com.google.firebase.components.ComponentRegistrar {
+    ctor public FirebaseSegmentationRegistrar();
+    method @NonNull public java.util.List<com.google.firebase.components.Component<?>> getComponents();
+  }
+
+  public class SetCustomInstallationIdException extends com.google.firebase.FirebaseException {
+    method @NonNull public com.google.firebase.segmentation.SetCustomInstallationIdException.Status getStatus();
+  }
+
+  public enum SetCustomInstallationIdException.Status {
+    enum_constant public static final com.google.firebase.segmentation.SetCustomInstallationIdException.Status BACKEND_ERROR;
+    enum_constant public static final com.google.firebase.segmentation.SetCustomInstallationIdException.Status CLIENT_ERROR;
+    enum_constant public static final com.google.firebase.segmentation.SetCustomInstallationIdException.Status DUPLICATED_CUSTOM_INSTALLATION_ID;
+    enum_constant public static final com.google.firebase.segmentation.SetCustomInstallationIdException.Status UNKOWN;
+  }
+
+}
+
+package com.google.firebase.segmentation.local {
+
+  public class CustomInstallationIdCache {
+    ctor public CustomInstallationIdCache(@NonNull com.google.firebase.FirebaseApp);
+    method @NonNull public boolean clear();
+    method @NonNull public boolean insertOrUpdateCacheEntry(@NonNull com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue);
+    method @Nullable public com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue readCacheEntryValue();
+  }
+
+  public enum CustomInstallationIdCache.CacheStatus {
+    enum_constant public static final com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus PENDING_CLEAR;
+    enum_constant public static final com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus PENDING_UPDATE;
+    enum_constant public static final com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus SYNCED;
+  }
+
+  public abstract class CustomInstallationIdCacheEntryValue {
+    ctor public CustomInstallationIdCacheEntryValue();
+    method @NonNull public static com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue create(@NonNull String, @NonNull String, @NonNull com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus);
+    method @NonNull public abstract com.google.firebase.segmentation.local.CustomInstallationIdCache.CacheStatus getCacheStatus();
+    method @NonNull public abstract String getCustomInstallationId();
+    method @NonNull public abstract String getFirebaseInstanceId();
+  }
+
+}
+
+package com.google.firebase.segmentation.remote {
+
+  public class SegmentationServiceClient {
+    ctor public SegmentationServiceClient(@NonNull android.content.Context);
+    method @NonNull public com.google.firebase.segmentation.remote.SegmentationServiceClient.Code clearCustomInstallationId(long, @NonNull String, @NonNull String, @NonNull String);
+    method @NonNull public com.google.firebase.segmentation.remote.SegmentationServiceClient.Code updateCustomInstallationId(long, @NonNull String, @NonNull String, @NonNull String, @NonNull String);
+  }
+
+  public enum SegmentationServiceClient.Code {
+    enum_constant public static final com.google.firebase.segmentation.remote.SegmentationServiceClient.Code CONFLICT;
+    enum_constant public static final com.google.firebase.segmentation.remote.SegmentationServiceClient.Code HTTP_CLIENT_ERROR;
+    enum_constant public static final com.google.firebase.segmentation.remote.SegmentationServiceClient.Code NETWORK_ERROR;
+    enum_constant public static final com.google.firebase.segmentation.remote.SegmentationServiceClient.Code OK;
+    enum_constant public static final com.google.firebase.segmentation.remote.SegmentationServiceClient.Code SERVER_ERROR;
+    enum_constant public static final com.google.firebase.segmentation.remote.SegmentationServiceClient.Code UNAUTHORIZED;
+  }
+
+}
+

firebase-segmentation/firebase-segmentation.gradle

@@ -16,10 +16,6 @@ plugins {
     id 'firebase-library'
 }
 
-firebaseLibrary {
-    testLab.enabled = true
-}
-
 android {
     compileSdkVersion project.targetSdkVersion
 
@@ -48,7 +44,7 @@ dependencies {
         exclude group: "com.google.firebase", module: "firebase-common"
     }
 
-    implementation 'androidx.appcompat:appcompat:1.0.2'
+    implementation 'androidx.appcompat:appcompat:1.1.0'
     implementation 'androidx.multidex:multidex:2.0.1'
     implementation 'com.google.android.gms:play-services-tasks:17.0.0'
 
@@ -59,7 +55,7 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     testImplementation "org.robolectric:robolectric:$robolectricVersion"
 
-    androidTestImplementation "androidx.annotation:annotation:1.0.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'

firebase-segmentation/src/main/java/com/google/firebase/segmentation/local/CustomInstallationIdCache.java

@@ -14,11 +14,16 @@
 
 package com.google.firebase.segmentation.local;
 
-import android.content.Context;
-import android.content.SharedPreferences;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.firebase.FirebaseApp;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import org.json.JSONException;
+import org.json.JSONObject;
 
 /**
  * A layer that locally caches a few Firebase Segmentation attributes on top the Segmentation
@@ -40,59 +45,94 @@ public enum CacheStatus {
     PENDING_CLEAR
   }
 
-  private static final String SHARED_PREFS_NAME = "CustomInstallationIdCache";
+  private static final String DATA_FILE_NAME_PREFIX = "PersistedCustomInstallationId";
 
   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 final SharedPreferences prefs;
-  private final String persistenceKey;
+  private final File dataFile;
+  private final 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 =
-        firebaseApp
-            .getApplicationContext()
-            .getSharedPreferences(SHARED_PREFS_NAME, Context.MODE_PRIVATE);
-    persistenceKey = firebaseApp.getPersistenceKey();
+    this.firebaseApp = firebaseApp;
+    // Store custom installation id in different file for different FirebaseApp.
+    dataFile =
+        new File(
+            firebaseApp.getApplicationContext().getFilesDir(),
+            String.format("%s.%s.json", DATA_FILE_NAME_PREFIX, firebaseApp.getPersistenceKey()));
   }
 
   @Nullable
   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);
+    JSONObject cidInfo = readCidInfoFromFile();
+    String cid = cidInfo.optString(CUSTOM_INSTALLATION_ID_KEY, null);
+    String iid = cidInfo.optString(INSTANCE_ID_KEY, null);
+    int status = cidInfo.optInt(CACHE_STATUS_KEY, -1);
 
     if (cid == null || iid == null || status == -1) {
       return null;
     }
-
     return CustomInstallationIdCacheEntryValue.create(cid, iid, CacheStatus.values()[status]);
   }
 
+  private JSONObject readCidInfoFromFile() {
+    final ByteArrayOutputStream baos = new ByteArrayOutputStream();
+    final byte[] tmpBuf = new byte[16 * 1024];
+    try (FileInputStream fis = new FileInputStream(dataFile)) {
+      while (true) {
+        int numRead = fis.read(tmpBuf, 0, tmpBuf.length);
+        if (numRead < 0) {
+          break;
+        }
+        baos.write(tmpBuf, 0, numRead);
+      }
+      return new JSONObject(baos.toString());
+    } catch (IOException | JSONException e) {
+      return new JSONObject();
+    }
+  }
+
+  /**
+   * Write the prefs to a JSON object, serialize them into a JSON string and write the bytes to a
+   * temp file. After writing and closing the temp file, rename it over to the actual
+   * DATA_FILE_NAME.
+   */
   @NonNull
   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 editor.commit();
+    try {
+      // Write the prefs into a JSON object
+      JSONObject json = new JSONObject();
+      json.put(CUSTOM_INSTALLATION_ID_KEY, entryValue.getCustomInstallationId());
+      json.put(INSTANCE_ID_KEY, entryValue.getFirebaseInstanceId());
+      json.put(CACHE_STATUS_KEY, entryValue.getCacheStatus().ordinal());
+      File tmpFile =
+          File.createTempFile(
+              String.format("%s.%s", DATA_FILE_NAME_PREFIX, firebaseApp.getPersistenceKey()),
+              "tmp",
+              firebaseApp.getApplicationContext().getFilesDir());
+
+      // Serialize the JSON object into a string and write the bytes to a temp file
+      FileOutputStream fos = new FileOutputStream(tmpFile);
+      fos.write(json.toString().getBytes("UTF-8"));
+      fos.close();
+
+      // Snapshot the temp file to the actual file
+      if (!tmpFile.renameTo(dataFile)) {
+        throw new IOException("unable to rename the tmpfile to " + dataFile.getPath());
+      }
+    } catch (JSONException | IOException e) {
+      return false;
+    }
+    return true;
   }
 
   @NonNull
   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 editor.commit();
-  }
-
-  private String getSharedPreferencesKey(String key) {
-    return String.format("%s|%s", persistenceKey, key);
+    if (!dataFile.exists()) {
+      return true;
+    }
+    return dataFile.delete();
   }
 }