added testing to ensure outbox only contains expected fields

aws-amplify · Jun 10, 2022 · aebf936 · aebf936
1 parent 305cc1c
commit aebf936
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 0 deletions.
diff --git a/packages/datastore-storage-adapter/__tests__/SQLiteAdapter.test.ts b/packages/datastore-storage-adapter/__tests__/SQLiteAdapter.test.ts
@@ -120,12 +120,20 @@ describe('SQLiteAdapter', () => {
 		return await db.getAll('select * from MutationEvent', []);
 	}
 
+	async function clearOutbox() {
+		await pause(250);
+		const adapter = (DataStore as any).storageAdapter;
+		const db = (adapter as any).db;
+		return await db.executeStatements(['delete from MutationEvent']);
+	}
+
 	({ initSchema, DataStore } = require('@aws-amplify/datastore'));
 	addCommonQueryTests({
 		initSchema,
 		DataStore,
 		storageAdapter: SQLiteAdapter,
 		getMutations,
+		clearOutbox,
 	});
 
 	describe('something', () => {

diff --git a/packages/datastore/__tests__/AsyncStorageAdapter.test.ts b/packages/datastore/__tests__/AsyncStorageAdapter.test.ts
@@ -2,6 +2,7 @@ import AsyncStorageAdapter from '../src/storage/adapter/AsyncStorageAdapter';
 import {
 	DataStore as DataStoreType,
 	initSchema as initSchemaType,
+	syncClasses,
 } from '../src/datastore/datastore';
 import { PersistentModelConstructor, SortDirection } from '../src/types';
 import { pause, Model, User, Profile, testSchema } from './helpers';
@@ -23,12 +24,18 @@ describe('AsyncStorageAdapter tests', () => {
 		return await adapter.getAll('sync_MutationEvent');
 	}
 
+	async function clearOutbox(adapter) {
+		await pause(250);
+		return await adapter.delete(syncClasses['MutationEvent']);
+	}
+
 	({ initSchema, DataStore } = require('../src/datastore/datastore'));
 	addCommonQueryTests({
 		initSchema,
 		DataStore,
 		storageAdapter: AsyncStorageAdapter,
 		getMutations,
+		clearOutbox,
 	});
 
 	describe('Query', () => {

diff --git a/packages/datastore/__tests__/IndexedDBAdapter.test.ts b/packages/datastore/__tests__/IndexedDBAdapter.test.ts
@@ -3,6 +3,7 @@ import 'fake-indexeddb/auto';
 import {
 	DataStore as DataStoreType,
 	initSchema as initSchemaType,
+	syncClasses,
 } from '../src/datastore/datastore';
 import { PersistentModelConstructor, SortDirection } from '../src/types';
 import {
@@ -29,12 +30,18 @@ describe('IndexedDBAdapter tests', () => {
 		return await adapter.getAll('sync_MutationEvent');
 	}
 
+	async function clearOutbox(adapter) {
+		await pause(250);
+		return await adapter.delete(syncClasses['MutationEvent']);
+	}
+
 	({ initSchema, DataStore } = require('../src/datastore/datastore'));
 	addCommonQueryTests({
 		initSchema,
 		DataStore,
 		storageAdapter: Adapter,
 		getMutations,
+		clearOutbox,
 	});
 
 	describe('Query', () => {

diff --git a/packages/datastore/__tests__/commonAdapterTests.ts b/packages/datastore/__tests__/commonAdapterTests.ts
@@ -28,6 +28,7 @@ export function addCommonQueryTests({
 	DataStore,
 	storageAdapter,
 	getMutations,
+	clearOutbox,
 }) {
 	describe('Common `query()` cases', () => {
 		let Model: PersistentModelConstructor<Model>;
@@ -341,5 +342,30 @@ export function addCommonQueryTests({
 				postId: mutations[0].modelId,
 			});
 		});
+
+		it('only includes changed fields in mutations', async () => {
+			const profile = await DataStore.save(
+				new Profile({ firstName: 'original first', lastName: 'original last' })
+			);
+
+			await clearOutbox(adapter);
+
+			await DataStore.save(
+				Profile.copyOf(profile, draft => {
+					draft.firstName = 'new first';
+				})
+			);
+
+			const mutations = await getMutations(adapter);
+
+			expect(mutations.length).toBe(1);
+			expectMutation(mutations[0], {
+				firstName: 'new first',
+				lastName: undefined,
+				_version: v => v === undefined || v === null,
+				_lastChangedAt: v => v === undefined || v === null,
+				_deleted: v => v === undefined || v === null,
+			});
+		});
 	});
 }
diff --git a/packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts b/packages/datastore/src/storage/adapter/AsyncStorageAdapter.ts
@@ -399,6 +399,7 @@ export class AsyncStorageAdapter implements Adapter {
 			const nameSpace = this.namespaceResolver(modelConstructor);
 
 			const storeName = this.getStorenameForModel(modelConstructor);
+
 			if (condition) {
 				const fromDB = await this.db.get(model.id, storeName);