fix(@aws-amplify/datastore): consecutive saves 2 (#8038)

aws-amplify · Apr 15, 2021 · a15b8f0 · a15b8f0
1 parent c1ce5ac
commit a15b8f0
Show file tree

Hide file tree

Showing 12 changed files with 425 additions and 204 deletions.
diff --git a/packages/datastore/__tests__/DataStore.ts b/packages/datastore/__tests__/DataStore.ts
@@ -389,12 +389,13 @@ describe('DataStore tests', () => {
  const result = await DataStore.save(model);
 
  const [settingsSave, modelCall] = <any>save.mock.calls;
- const [_model, _condition, _mutator] = modelCall;
+ const [_model, _condition, _mutator, patches] = modelCall;
 
  expect(result).toMatchObject(model);
+ expect(patches).toBeUndefined();
  });
 
- test('Save returns the updated model', async () => {
+ test('Save returns the updated model and patches', async () => {
  let model: Model;
  const save = jest.fn(() => [model]);
  const query = jest.fn(() => [model]);
@@ -437,12 +438,17 @@ describe('DataStore tests', () => {
  const result = await DataStore.save(model);
 
  const [settingsSave, modelSave, modelUpdate] = <any>save.mock.calls;
- const [_model, _condition, _mutator] = modelUpdate;
+ const [_model, _condition, _mutator, [patches]] = modelUpdate;
+
+ const expectedPatches = [
+ { op: 'replace', path: ['field1'], value: 'edited' },
+ ];
 
  expect(result).toMatchObject(model);
+ expect(patches).toMatchObject(expectedPatches);
  });
 
- test('Save returns the updated model - list field', async () => {
+ test('Save returns the updated model and patches - list field', async () => {
  let model: Model;
  const save = jest.fn(() => [model]);
  const query = jest.fn(() => [model]);
@@ -499,8 +505,27 @@ describe('DataStore tests', () => {
  save.mock.calls
  );
 
- const [_model, _condition, _mutator] = modelUpdate;
- const [_model2, _condition2, _mutator2] = modelUpdate2;
+ const [_model, _condition, _mutator, [patches]] = modelUpdate;
+ const [_model2, _condition2, _mutator2, [patches2]] = modelUpdate2;
+
+ const expectedPatches = [
+ {
+ op: 'replace',
+ path: ['emails'],
+ value: ['john@doe.com', 'jane@doe.com', 'joe@doe.com'],
+ },
+ ];
+
+ const expectedPatches2 = [
+ {
+ op: 'add',
+ path: ['emails', 3],
+ value: 'joe@doe.com',
+ },
+ ];
+
+ expect(patches).toMatchObject(expectedPatches);
+ expect(patches2).toMatchObject(expectedPatches2);
  });
 
  test('Instantiation validations', async () => {

diff --git a/packages/datastore/__tests__/outbox.test.ts b/packages/datastore/__tests__/outbox.test.ts
@@ -342,10 +342,9 @@ async function instantiateOutbox(): Promise<void> {
 
  outbox = new MutationEventOutbox(
  schema,
- userClasses,
  MutationEvent,
- ownSymbol,
- getModelDefinition
+ modelInstanceCreator,
+ ownSymbol
  );
  merger = new ModelMerger(outbox, ownSymbol);
 }

diff --git a/packages/datastore/__tests__/storage.test.ts b/packages/datastore/__tests__/storage.test.ts
@@ -65,6 +65,62 @@ describe('Storage tests', () => {
  expect(modelUpdate.element.field1).toEqual('edited');
  });
 
+ test('scalar - unchanged', async () => {
+ const classes = initSchema(testSchema());
+
+ const { Model } = classes as {
+ Model: PersistentModelConstructor<Model>;
+ };
+
+ const dateCreated = new Date().toISOString();
+
+ const model = await DataStore.save(
+ new Model({
+ field1: 'Some value',
+ dateCreated,
+ })
+ );
+
+ await DataStore.save(
+ Model.copyOf(model, draft => {
+ draft.field1 = 'Some value';
+ })
+ );
+
+ const [[_modelSave], modelUpdate] = zenNext.mock.calls;
+
+ expect(modelUpdate).toBeUndefined();
+ expect(modelUpdate).toBeUndefined();
+
+ expect(true).toBeTruthy();
+ });
+
+ test('update by nulling previous value', async () => {
+ const classes = initSchema(testSchema());
+
+ const { Model } = classes as {
+ Model: PersistentModelConstructor<Model>;
+ };
+
+ const model = await DataStore.save(
+ new Model({
+ field1: 'Some value',
+ optionalField1: 'Some optional value',
+ dateCreated: new Date().toISOString(),
+ })
+ );
+
+ await DataStore.save(
+ Model.copyOf(model, draft => {
+ draft.optionalField1 = null;
+ })
+ );
+
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
+
+ expect(modelUpdate.element.optionalField1).toBeNull();
+ });
+
  test('list (destructured)', async () => {
  const classes = initSchema(testSchema());
 
@@ -86,7 +142,7 @@ describe('Storage tests', () => {
  })
  );
 
- const [[modelSave], [modelUpdate]] = zenNext.mock.calls;
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
 
  const expectedValueEmails = [
  'john@doe.com',
@@ -120,7 +176,7 @@ describe('Storage tests', () => {
  })
  );
 
- const [[modelSave], [modelUpdate]] = zenNext.mock.calls;
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
 
  const expectedValueEmails = [
  'john@doe.com',
@@ -133,7 +189,7 @@ describe('Storage tests', () => {
  expect(modelUpdate.element.emails).toMatchObject(expectedValueEmails);
  });
 
- test('list unchanged', async () => {
+ test('update with changed field and list unchanged', async () => {
  const classes = initSchema(testSchema());
 
  const { Model } = classes as {
@@ -156,13 +212,66 @@ describe('Storage tests', () => {
  })
  );
 
- const [[modelSave], [modelUpdate]] = zenNext.mock.calls;
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
 
  expect(modelUpdate.element.dateCreated).toBeUndefined();
  expect(modelUpdate.element.field1).toEqual('Updated value');
  expect(modelUpdate.element.emails).toBeUndefined();
  });
 
+ test('update with list unchanged', async () => {
+ const classes = initSchema(testSchema());
+
+ const { Model } = classes as {
+ Model: PersistentModelConstructor<Model>;
+ };
+
+ const model = await DataStore.save(
+ new Model({
+ field1: 'Some value',
+ dateCreated: new Date().toISOString(),
+ emails: ['john@doe.com', 'jane@doe.com'],
+ })
+ );
+
+ await DataStore.save(
+ Model.copyOf(model, draft => {
+ // same as above. should not result in mutation event
+ draft.emails = ['john@doe.com', 'jane@doe.com'];
+ })
+ );
+
+ const [[_modelSave], modelUpdate] = zenNext.mock.calls;
+
+ expect(modelUpdate).toBeUndefined();
+ });
+
+ test('update by nulling list', async () => {
+ const classes = initSchema(testSchema());
+
+ const { Model } = classes as {
+ Model: PersistentModelConstructor<Model>;
+ };
+
+ const model = await DataStore.save(
+ new Model({
+ field1: 'Some value',
+ dateCreated: new Date().toISOString(),
+ emails: ['john@doe.com', 'jane@doe.com'],
+ })
+ );
+
+ await DataStore.save(
+ Model.copyOf(model, draft => {
+ draft.emails = null;
+ })
+ );
+
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
+
+ expect(modelUpdate.element.emails).toBeNull();
+ });
+
  test('custom type (destructured)', async () => {
  const classes = initSchema(testSchema());
 
@@ -191,7 +300,7 @@ describe('Storage tests', () => {
  })
  );
 
- const [[modelSave], [modelUpdate]] = zenNext.mock.calls;
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
 
  const expectedValueMetadata = {
  author: 'some author',
@@ -231,7 +340,7 @@ describe('Storage tests', () => {
  })
  );
 
- const [[modelSave], [modelUpdate]] = zenNext.mock.calls;
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
 
  const expectedValueMetadata = {
  author: 'some author',
@@ -276,7 +385,7 @@ describe('Storage tests', () => {
  })
  );
 
- const [[modelSave], [modelUpdate]] = zenNext.mock.calls;
+ const [[_modelSave], [modelUpdate]] = zenNext.mock.calls;
 
  expect(modelUpdate.element.dateCreated).toBeUndefined();
  expect(modelUpdate.element.field1).toEqual('Updated value');