fix: add newly created models to IDB during migration (aws-amplify#9754)

james-ingold · Apr 21, 2022 · 58d7e00 · 58d7e00
1 parent 84c94fd
commit 58d7e00
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 93 deletions.
diff --git a/packages/datastore/__tests__/__snapshots__/indexeddb.test.ts.snap b/packages/datastore/__tests__/__snapshots__/indexeddb.test.ts.snap
@@ -404,50 +404,14 @@ Object {
       },
       Object {
         "inbound": false,
-        "rows": Array [
-          Object {
-            "$": Array [
-              1,
-              Object {
-                "_deleted": null,
-                "_lastChangedAt": null,
-                "_version": null,
-                "commentPostId": "d129800d-679f-4df2-92cd-2b96573a618e",
-                "content": "c2",
-                "id": "007ea314-6645-486f-88a9-d1aaa4fddb9e",
-              },
-            ],
-            "$types": Object {
-              "$": Object {
-                "1._deleted": "undef",
-                "1._lastChangedAt": "undef",
-                "1._version": "undef",
-              },
-            },
-          },
-          Object {
-            "$": Array [
-              2,
-              Object {
-                "_deleted": null,
-                "_lastChangedAt": null,
-                "_version": null,
-                "commentPostId": "d129800d-679f-4df2-92cd-2b96573a618e",
-                "content": "c1",
-                "id": "13c99f5f-1fbb-4088-aaf9-63b789e68574",
-              },
-            ],
-            "$types": Object {
-              "$": Object {
-                "1._deleted": "undef",
-                "1._lastChangedAt": "undef",
-                "1._version": "undef",
-              },
-            },
-          },
-        ],
+        "rows": Array [],
         "tableName": "user_Comment",
       },
+      Object {
+        "inbound": false,
+        "rows": Array [],
+        "tableName": "user_Person",
+      },
       Object {
         "inbound": false,
         "rows": Array [
@@ -537,7 +501,12 @@ Object {
       },
       Object {
         "name": "user_Comment",
-        "rowCount": 2,
+        "rowCount": 0,
+        "schema": "++,&id,commentPostId",
+      },
+      Object {
+        "name": "user_Person",
+        "rowCount": 0,
         "schema": "++,&id",
       },
       Object {

diff --git a/packages/datastore/__tests__/indexeddb.test.ts b/packages/datastore/__tests__/indexeddb.test.ts
@@ -550,8 +550,14 @@ describe('DB versions migration', () => {
 		// Open V2
 		db = await idb.openDB('amplify-datastore', 2);
 
-		expect(db.objectStoreNames).toMatchObject(
-			v1Data.data.tables.map(({ name }) => name)
+		expect([...db.objectStoreNames].sort()).toMatchObject(
+			[
+				...v1Data.data.tables.map(({ name }) => name),
+				// Simulate Comment model added after IndexedDB was created,
+				// but before migration
+				`${USER}_Comment`,
+				`${USER}_Person`,
+			].sort()
 		);
 
 		for (const storeName of db.objectStoreNames) {

diff --git a/packages/datastore/__tests__/v1schema.data.json b/packages/datastore/__tests__/v1schema.data.json
@@ -35,11 +35,6 @@
 				"schema": "id",
 				"rowCount": 9
 			},
-			{
-				"name": "user_Comment",
-				"schema": "id,commentPostId",
-				"rowCount": 2
-			},
 			{
 				"name": "user_Post",
 				"schema": "id,postBlogId,referencePostId",
@@ -328,38 +323,6 @@
 					}
 				]
 			},
-			{
-				"tableName": "user_Comment",
-				"inbound": true,
-				"rows": [
-					{
-						"content": "c2",
-						"id": "007ea314-6645-486f-88a9-d1aaa4fddb9e",
-						"_version": null,
-						"_lastChangedAt": null,
-						"_deleted": null,
-						"commentPostId": "d129800d-679f-4df2-92cd-2b96573a618e",
-						"$types": {
-							"_version": "undef",
-							"_lastChangedAt": "undef",
-							"_deleted": "undef"
-						}
-					},
-					{
-						"content": "c1",
-						"id": "13c99f5f-1fbb-4088-aaf9-63b789e68574",
-						"_version": null,
-						"_lastChangedAt": null,
-						"_deleted": null,
-						"commentPostId": "d129800d-679f-4df2-92cd-2b96573a618e",
-						"$types": {
-							"_version": "undef",
-							"_lastChangedAt": "undef",
-							"_deleted": "undef"
-						}
-					}
-				]
-			},
 			{
 				"tableName": "user_Post",
 				"inbound": true,

diff --git a/packages/datastore/src/storage/adapter/IndexedDBAdapter.ts b/packages/datastore/src/storage/adapter/IndexedDBAdapter.ts
@@ -117,17 +117,12 @@ class IndexedDBAdapter implements Adapter {
 
 								Object.keys(namespace.models).forEach(modelName => {
 									const storeName = this.getStorename(namespaceName, modelName);
-									const store = db.createObjectStore(storeName, {
-										autoIncrement: true,
-									});
-
-									const indexes =
-										this.schema.namespaces[namespaceName].relationships[
-											modelName
-										].indexes;
-									indexes.forEach(index => store.createIndex(index, index));
-
-									store.createIndex('byId', 'id', { unique: true });
+									this.createObjectStoreForModel(
+										db,
+										namespaceName,
+										storeName,
+										modelName
+									);
 								});
 							});
 
@@ -168,6 +163,31 @@ class IndexedDBAdapter implements Adapter {
 
 									logger.debug(`${count} ${storeName} records migrated`);
 								}
+
+								// add new models created after IndexedDB, but before migration
+								// this case may happen when a user has not opened an app for
+								// some time and a new model is added during that time
+								Object.keys(theSchema.namespaces).forEach(namespaceName => {
+									const namespace = theSchema.namespaces[namespaceName];
+									const objectStoreNames = new Set(txn.objectStoreNames);
+
+									Object.keys(namespace.models)
+										.map(modelName => {
+											return [
+												modelName,
+												this.getStorename(namespaceName, modelName),
+											];
+										})
+										.filter(([, storeName]) => !objectStoreNames.has(storeName))
+										.forEach(([modelName, storeName]) => {
+											this.createObjectStoreForModel(
+												db,
+												namespaceName,
+												storeName,
+												modelName
+											);
+										});
+								});
 							} catch (error) {
 								logger.error('Error migrating IndexedDB data', error);
 								txn.abort();
@@ -835,6 +855,23 @@ class IndexedDBAdapter implements Adapter {
 
 		return result;
 	}
+
+	private async createObjectStoreForModel(
+		db: idb.IDBPDatabase,
+		namespaceName: string,
+		storeName: string,
+		modelName: string
+	) {
+		const store = db.createObjectStore(storeName, {
+			autoIncrement: true,
+		});
+
+		const indexes =
+			this.schema.namespaces[namespaceName].relationships[modelName].indexes;
+		indexes.forEach(index => store.createIndex(index, index));
+
+		store.createIndex('byId', 'id', { unique: true });
+	}
 }
 
 export default new IndexedDBAdapter();