Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

LDS: Improve pinning unsaved objects #795

Merged
merged 8 commits into from
Apr 23, 2019
Merged

LDS: Improve pinning unsaved objects #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
259e0ee
LDS: Improve pinning unsaved objects
dplewis Apr 13, 2019
32f59b8
add missing commit
dplewis Apr 13, 2019
ce163f5
more tests
dplewis Apr 13, 2019
9308f03
remove console.log
dplewis Apr 13, 2019
596a7c3
updateFromServer ignore unsaved objects
dplewis Apr 19, 2019
379935a
Update package-lock.json
dplewis Apr 19, 2019
aff297f
Revert "Update package-lock.json"
dplewis Apr 23, 2019
c0eefba
Merge branch 'master' into lds-pin-fix
dplewis Apr 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion integration/server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ const api = new ParseServer({
facebook: {
appIds: "test"
}
}
},
verbose: false,
silent: true,
});

app.use('/parse', api);
Expand Down
174 changes: 124 additions & 50 deletions integration/test/ParseLocalDatastoreTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,13 @@ const PIN_PREFIX = LocalDatastoreUtils.PIN_PREFIX;
function LDS_KEY(object) {
return Parse.LocalDatastore.getKeyForObject(object);
}

function LDS_FULL_JSON(object) {
const json = object._toFullJSON();
if (object._localId) {
json._localId = object._localId;
}
return json;
}
function runTest(controller) {
describe(`Parse Object Pinning (${controller.name})`, () => {
beforeEach(async () => {
Expand Down Expand Up @@ -75,7 +81,7 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 2);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(object)]);
assert.deepEqual(localDatastore[LDS_KEY(object)], [object._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(object)], [LDS_FULL_JSON(object)]);
await object.save();
// Check if localDatastore updated localId to objectId
localDatastore = await Parse.LocalDatastore._getAllContents();
Expand All @@ -84,6 +90,55 @@ function runTest(controller) {
assert.deepEqual(localDatastore[LDS_KEY(object)], [object._toFullJSON()]);
});

it(`${controller.name} can store data to pin (unsaved)`, async () => {
const object = new TestObject();
object.set('foo', 'bar');
await object.pin();

const query = new Parse.Query(TestObject);
query.fromLocalDatastore();
let results = await query.find();
assert.equal(results.length, 1);

let pinnedObject = results[0];
assert.equal(pinnedObject.get('foo'), 'bar');
pinnedObject.set('foo', 'baz');
await pinnedObject.pin();

results = await query.find();
assert.equal(results.length, 1);
pinnedObject = results[0];
assert.equal(pinnedObject.get('foo'), 'baz');
});

it(`${controller.name} can query unsaved pin and save`, async () => {
const object = new TestObject();
object.set('foo', 'bar');
await object.pin();

const query = new Parse.Query(TestObject);
query.fromLocalDatastore();
let results = await query.find();

assert.equal(results.length, 1);

let pinnedObject = results[0];
assert.equal(pinnedObject.get('foo'), 'bar');

pinnedObject.set('foo', 'baz');
await pinnedObject.save();

assert(pinnedObject.id);
assert.equal(pinnedObject._localId, undefined);

results = await query.find();
pinnedObject = results[0];

assert.equal(pinnedObject.get('foo'), 'baz');
assert(pinnedObject.id);
assert.equal(pinnedObject._localId, undefined);
});

it(`${controller.name} cannot pin unsaved pointer`, async () => {
try {
const object = new TestObject();
Expand Down Expand Up @@ -174,9 +229,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand Down Expand Up @@ -216,9 +271,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[PIN_PREFIX + 'test_pin'], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand Down Expand Up @@ -315,17 +370,17 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await obj2.unPin();

localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 3);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -347,9 +402,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -358,8 +413,8 @@ function runTest(controller) {
localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 3);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);
});

it(`${controller.name} can unPin / unPinAll without pin (unsaved)`, async () => {
Expand Down Expand Up @@ -407,16 +462,16 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert(Object.keys(localDatastore).length === 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.unPinAll([obj1, obj2]);

localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 2);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -437,9 +492,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -461,17 +516,17 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert(Object.keys(localDatastore).length === 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.unPinAllObjects();

localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 3);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -493,9 +548,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[DEFAULT_PIN], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -518,16 +573,16 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert(Object.keys(localDatastore).length === 4);
assert.deepEqual(localDatastore[PIN_PREFIX + 'test_unpin'], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.unPinAllWithName('test_unpin', [obj1, obj2]);

localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 2);
assert.deepEqual(localDatastore[PIN_PREFIX + 'test_unpin'], [LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -548,9 +603,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[PIN_PREFIX + 'test_unpin'], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -572,17 +627,17 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert(Object.keys(localDatastore).length === 4);
assert.deepEqual(localDatastore[PIN_PREFIX + 'test_unpin'], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.unPinAllObjectsWithName('test_unpin');

localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 3);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand All @@ -604,9 +659,9 @@ function runTest(controller) {
let localDatastore = await Parse.LocalDatastore._getAllContents();
assert.equal(Object.keys(localDatastore).length, 4);
assert.deepEqual(localDatastore[PIN_PREFIX + 'test_unpin'], [LDS_KEY(obj1), LDS_KEY(obj2), LDS_KEY(obj3)]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [obj1._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [obj2._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [obj3._toFullJSON()]);
assert.deepEqual(localDatastore[LDS_KEY(obj1)], [LDS_FULL_JSON(obj1)]);
assert.deepEqual(localDatastore[LDS_KEY(obj2)], [LDS_FULL_JSON(obj2)]);
assert.deepEqual(localDatastore[LDS_KEY(obj3)], [LDS_FULL_JSON(obj3)]);

await Parse.Object.saveAll(objects);

Expand Down Expand Up @@ -871,6 +926,25 @@ function runTest(controller) {
const childJSON = updatedLDS[LDS_KEY(child)];
assert.equal(childJSON.foo, 'changed');
});

it(`${controller.name} can update Local Datastore from network ignore unsaved`, async () => {
const object = new TestObject();
const item = new Item();
await item.save();
await Parse.Object.pinAll([object, item]);

// Updates item with { foo: 'changed' }
const params = { id: item.id };
await Parse.Cloud.run('TestFetchFromLocalDatastore', params);

Parse.LocalDatastore.isSyncing = false;

await Parse.LocalDatastore.updateFromServer();

const updatedLDS = await Parse.LocalDatastore._getAllContents();
const itemJSON = updatedLDS[LDS_KEY(item)];
assert.equal(itemJSON.foo, 'changed');
});
});

describe(`Parse Query Pinning (${controller.name})`, () => {
Expand Down
9 changes: 8 additions & 1 deletion src/LocalDatastore.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,11 @@ const LocalDatastore = {
for (const parent of objects) {
const children = this._getChildren(parent);
const parentKey = this.getKeyForObject(parent);
children[parentKey] = parent._toFullJSON();
const json = parent._toFullJSON();
if (parent._localId) {
json._localId = parent._localId;
}
children[parentKey] = json;
for (const objectKey in children) {
objectKeys.push(objectKey);
toPinPromises.push(this.pinWithName(objectKey, [children[objectKey]]));
Expand Down Expand Up @@ -338,6 +342,9 @@ const LocalDatastore = {
for (const key of keys) {
// Ignore the OBJECT_PREFIX
const [ , , className, objectId] = key.split('_');
if (objectId.startsWith('local')) {
continue;
}
if (!(className in pointersHash)) {
pointersHash[className] = new Set();
}
Expand Down
4 changes: 3 additions & 1 deletion src/ParseQuery.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,9 @@ class ParseQuery {
const objects = await localDatastore._serializeObjectsFromPinName(this._localDatastorePinName);
let results = objects.map((json, index, arr) => {
const object = ParseObject.fromJSON(json, false);

if (json._localId && !json.objectId) {
object._localId = json._localId;
}
if (!OfflineQuery.matchesQuery(this.className, object, arr, this)) {
return null;
}
Expand Down
Loading