Canonical ID Schema Migration

Author: schmidt-sebastian

firebase-firestore/src/main/java/com/google/firebase/firestore/local/SQLitePersistence.java

@@ -108,7 +108,10 @@ public SQLitePersistence(
       DatabaseId databaseId,
       LocalSerializer serializer,
       LruGarbageCollector.Params params) {
-    this(serializer, params, new OpenHelper(context, databaseName(persistenceKey, databaseId)));
+    this(
+        serializer,
+        params,
+        new OpenHelper(context, serializer, databaseName(persistenceKey, databaseId)));
   }
 
   public SQLitePersistence(
@@ -274,10 +277,12 @@ private long getPageCount() {
    */
   private static class OpenHelper extends SQLiteOpenHelper {
 
+    private final LocalSerializer serializer;
     private boolean configured;
 
-    OpenHelper(Context context, String databaseName) {
+    OpenHelper(Context context, LocalSerializer serializer, String databaseName) {
       super(context, databaseName, null, SQLiteSchema.VERSION);
+      this.serializer = serializer;
     }
 
     @Override
@@ -303,13 +308,13 @@ private void ensureConfigured(SQLiteDatabase db) {
     @Override
     public void onCreate(SQLiteDatabase db) {
       ensureConfigured(db);
-      new SQLiteSchema(db).runMigrations(0);
+      new SQLiteSchema(db, serializer).runMigrations(0);
     }
 
     @Override
     public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
       ensureConfigured(db);
-      new SQLiteSchema(db).runMigrations(oldVersion);
+      new SQLiteSchema(db, serializer).runMigrations(oldVersion);
     }
 
     @Override

firebase-firestore/src/main/java/com/google/firebase/firestore/local/SQLiteSchema.java

@@ -49,7 +49,7 @@ class SQLiteSchema {
    * The version of the schema. Increase this by one for each migration added to runMigrations
    * below.
    */
-  static final int VERSION = 10;
+  static final int VERSION = 11;
 
   // Remove this constant and increment VERSION to enable indexing support
   static final int INDEXING_SUPPORT_VERSION = VERSION + 1;
@@ -65,9 +65,11 @@ class SQLiteSchema {
 
   private final SQLiteDatabase db;
 
-  // PORTING NOTE: The Android client doesn't need to use a serializer to remove held write acks.
-  SQLiteSchema(SQLiteDatabase db) {
+  private final LocalSerializer serializer;
+
+  SQLiteSchema(SQLiteDatabase db, LocalSerializer serializer) {
     this.db = db;
+    this.serializer = serializer;
   }
 
   void runMigrations() {
@@ -151,6 +153,11 @@ void runMigrations(int fromVersion, int toVersion) {
       dropLastLimboFreeSnapshotVersion();
     }
 
+    if (fromVersion < 11 && toVersion >= 11) {
+      // Schema version 11 changed the format of canonical IDs in the target cache.
+      rewriteCanonicalIds();
+    }
+
     /*
      * Adding a new migration? READ THIS FIRST!
      *
@@ -530,6 +537,26 @@ List<String> getTableColumns(String table) {
     return columns;
   }
 
+  private void rewriteCanonicalIds() {
+    new SQLitePersistence.Query(db, "SELECT target_id, target_proto FROM targets")
+        .forEach(
+            cursor -> {
+              int targetId = cursor.getInt(0);
+              byte[] targetProtoBytes = cursor.getBlob(1);
+
+              try {
+                Target targetProto = Target.parseFrom(targetProtoBytes);
+                TargetData targetData = serializer.decodeTargetData(targetProto);
+                String updatedCanonicalId = targetData.getTarget().getCanonicalId();
+                db.execSQL(
+                    "UPDATE targets SET canonical_id  = ? WHERE target_id = ?",
+                    new Object[] {updatedCanonicalId, targetId});
+              } catch (InvalidProtocolBufferException e) {
+                throw fail("Failed to decode Query data for target %s", targetId);
+              }
+            });
+  };
+
   private boolean tableExists(String table) {
     return !new SQLitePersistence.Query(db, "SELECT 1=1 FROM sqlite_master WHERE tbl_name = ?")
         .binding(table)

firebase-firestore/src/test/java/com/google/firebase/firestore/local/SQLiteSchemaTest.java

@@ -16,6 +16,7 @@
 
 import static com.google.firebase.firestore.local.EncodedPath.decodeResourcePath;
 import static com.google.firebase.firestore.local.EncodedPath.encode;
+import static com.google.firebase.firestore.testutil.TestUtil.filter;
 import static com.google.firebase.firestore.testutil.TestUtil.key;
 import static com.google.firebase.firestore.testutil.TestUtil.map;
 import static com.google.firebase.firestore.testutil.TestUtil.path;
@@ -33,6 +34,7 @@
 import android.database.sqlite.SQLiteOpenHelper;
 import androidx.test.core.app.ApplicationProvider;
 import com.google.firebase.database.collection.ImmutableSortedMap;
+import com.google.firebase.firestore.core.Query;
 import com.google.firebase.firestore.model.DatabaseId;
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.ResourcePath;
@@ -68,8 +70,13 @@ public class SQLiteSchemaTest {
   private SQLiteSchema schema;
   private SQLiteOpenHelper opener;
 
+  private DatabaseId databaseId;
+  private LocalSerializer serializer;
+
   @Before
   public void setUp() {
+    databaseId = DatabaseId.forProject("foo");
+    serializer = new LocalSerializer(new RemoteSerializer(databaseId));
     opener =
         new SQLiteOpenHelper(ApplicationProvider.getApplicationContext(), "foo", null, 1) {
           @Override
@@ -79,7 +86,7 @@ public void onCreate(SQLiteDatabase db) {}
           public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {}
         };
     db = opener.getWritableDatabase();
-    schema = new SQLiteSchema(db);
+    schema = new SQLiteSchema(db, serializer);
   }
 
   @After
@@ -521,14 +528,46 @@ public void keepsLastLimboFreeSnapshotIfNotDowngraded() {
                 Target targetProto = Target.parseFrom(targetProtoBytes);
                 assertTrue(targetProto.hasLastLimboFreeSnapshotVersion());
               } catch (InvalidProtocolBufferException e) {
-                fail("Failed to decode Query data");
+                fail("Failed to decode Target data");
+              }
+            });
+  }
+
+  @Test
+  public void rewritesCanonicalIds() {
+    schema.runMigrations(0, 10);
+
+    Query filteredQuery = query("colletion").filter(filter("foo", "==", "bar"));
+    TargetData initialTargetData =
+        new TargetData(
+            filteredQuery.toTarget(),
+            /* targetId= */ 2,
+            /* sequenceNumber= */ 1,
+            QueryPurpose.LISTEN);
+
+    db.execSQL(
+        "INSERT INTO targets (target_id, canonical_id, target_proto) VALUES (?,?, ?)",
+        new Object[] {2, "foo", serializer.encodeTargetData(initialTargetData).toByteArray()});
+
+    schema.runMigrations(10, 11);
+    new SQLitePersistence.Query(db, "SELECT canonical_id, target_proto, canonical_id FROM targets")
+        .forEach(
+            cursor -> {
+              String actualCanonicalId = cursor.getString(0);
+              byte[] targetProtoBytes = cursor.getBlob(1);
+
+              try {
+                Target targetProto = Target.parseFrom(targetProtoBytes);
+                TargetData targetData = serializer.decodeTargetData(targetProto);
+                String expectedCanonicalId = targetData.getTarget().getCanonicalId();
+                assertEquals(actualCanonicalId, expectedCanonicalId);
+              } catch (InvalidProtocolBufferException e) {
+                fail("Failed to decode Target data");
               }
             });
   }
 
   private SQLiteRemoteDocumentCache createRemoteDocumentCache() {
-    DatabaseId databaseId = DatabaseId.forProject("foo");
-    LocalSerializer serializer = new LocalSerializer(new RemoteSerializer(databaseId));
     SQLitePersistence persistence =
         new SQLitePersistence(serializer, LruGarbageCollector.Params.Default(), opener);
     persistence.start();