Skip to content

fix(compare): emit replace when a root container type changes from an empty value #333

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

Open
maximilliangrand wants to merge 1 commit into
base: master
Choose a base branch
from
+91 −23
Open

fix(compare): emit replace when a root container type changes from an empty value #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 14 additions & 8 deletions commonjs/duplex.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@ function _generate(mirror, obj, patches, path, invertible) {
if (typeof obj.toJSON === "function") {
obj = obj.toJSON();
}
// If one operand is an array and the other is an object, the whole subtree
// has to be replaced. Handling it here (instead of only inside the key loop
// below) also covers the case where `mirror` is an empty container, in which
// the loop would never run and no patch would be emitted.
if (Array.isArray(mirror) !== Array.isArray(obj)) {
if (invertible) {
patches.push({ op: "test", path: path, value: helpers_js_1._deepClone(mirror) });
}
patches.push({ op: "replace", path: path, value: helpers_js_1._deepClone(obj) });
return;
}
var newKeys = helpers_js_1._objectKeys(obj);
var oldKeys = helpers_js_1._objectKeys(mirror);
var changed = false;
Expand All @@ -144,20 +155,15 @@ function _generate(mirror, obj, patches, path, invertible) {
}
}
}
else if (Array.isArray(mirror) === Array.isArray(obj)) {
else {
// container types match here (handled above otherwise), so a missing key
// is always a removal
if (invertible) {
patches.push({ op: "test", path: path + "/" + helpers_js_1.escapePathComponent(key), value: helpers_js_1._deepClone(oldVal) });
}
patches.push({ op: "remove", path: path + "/" + helpers_js_1.escapePathComponent(key) });
deleted = true; // property has been deleted
}
else {
if (invertible) {
patches.push({ op: "test", path: path, value: mirror });
}
patches.push({ op: "replace", path: path, value: obj });
changed = true;
}
}
if (!deleted && newKeys.length == oldKeys.length) {
return;
Expand Down
22 changes: 14 additions & 8 deletions module/duplex.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,17 @@ function _generate(mirror, obj, patches, path, invertible) {
if (typeof obj.toJSON === "function") {
obj = obj.toJSON();
}
// If one operand is an array and the other is an object, the whole subtree
// has to be replaced. Handling it here (instead of only inside the key loop
// below) also covers the case where `mirror` is an empty container, in which
// the loop would never run and no patch would be emitted.
if (Array.isArray(mirror) !== Array.isArray(obj)) {
if (invertible) {
patches.push({ op: "test", path: path, value: _deepClone(mirror) });
}
patches.push({ op: "replace", path: path, value: _deepClone(obj) });
return;
}
var newKeys = _objectKeys(obj);
var oldKeys = _objectKeys(mirror);
var changed = false;
Expand All @@ -140,20 +151,15 @@ function _generate(mirror, obj, patches, path, invertible) {
}
}
}
else if (Array.isArray(mirror) === Array.isArray(obj)) {
else {
// container types match here (handled above otherwise), so a missing key
// is always a removal
if (invertible) {
patches.push({ op: "test", path: path + "/" + escapePathComponent(key), value: _deepClone(oldVal) });
}
patches.push({ op: "remove", path: path + "/" + escapePathComponent(key) });
deleted = true; // property has been deleted
}
else {
if (invertible) {
patches.push({ op: "test", path: path, value: mirror });
}
patches.push({ op: "replace", path: path, value: obj });
changed = true;
}
}
if (!deleted && newKeys.length == oldKeys.length) {
return;
Expand Down
22 changes: 15 additions & 7 deletions src/duplex.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,18 @@ function _generate(mirror, obj, patches, path, invertible) {
obj = obj.toJSON();
}

// If one operand is an array and the other is an object, the whole subtree
// has to be replaced. Handling it here (instead of only inside the key loop
// below) also covers the case where `mirror` is an empty container, in which
// the loop would never run and no patch would be emitted.
if (Array.isArray(mirror) !== Array.isArray(obj)) {
if (invertible) {
patches.push({ op: "test", path, value: _deepClone(mirror) });
}
patches.push({ op: "replace", path, value: _deepClone(obj) });
return;
}

var newKeys = _objectKeys(obj);
var oldKeys = _objectKeys(mirror);
var changed = false;
Expand Down Expand Up @@ -176,18 +188,14 @@ function _generate(mirror, obj, patches, path, invertible) {
}
}
}
else if(Array.isArray(mirror) === Array.isArray(obj)) {
else {
// container types match here (handled above otherwise), so a missing key
// is always a removal
if (invertible) {
patches.push({ op: "test", path: path + "/" + escapePathComponent(key), value: _deepClone(oldVal) });
}
patches.push({ op: "remove", path: path + "/" + escapePathComponent(key) });
deleted = true; // property has been deleted
} else {
if (invertible) {
patches.push({ op: "test", path, value: mirror });
}
patches.push({ op: "replace", path, value: obj });
changed = true;
}
}

Expand Down
48 changes: 48 additions & 0 deletions test/spec/duplexSpec.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1704,6 +1704,54 @@ describe('duplex', function() {
]);
}
});
variantIt('Replacing an empty array root with an object should be handled well', [
['invertible = FALSE', false],
['invertible = TRUE', true]
], function (testInvertible) {
return function () {
const objA = [];
const objB = { a: 1 };
const patches = jsonpatch.compare(objA, objB, testInvertible);
expect(patches).toEqual([
...insertIf(testInvertible, {
op: 'test',
path: '',
value: objA
}),
{
op: 'replace',
path: '',
value: objB
}
]);
// patch round-trips
expect(jsonpatch.applyPatch([], patches, true).newDocument).toEqual(objB);
}
});
variantIt('Replacing an empty object root with an array should be handled well', [
['invertible = FALSE', false],
['invertible = TRUE', true]
], function (testInvertible) {
return function () {
const objA = {};
const objB = [1, 2];
const patches = jsonpatch.compare(objA, objB, testInvertible);
expect(patches).toEqual([
...insertIf(testInvertible, {
op: 'test',
path: '',
value: objA
}),
{
op: 'replace',
path: '',
value: objB
}
]);
// patch round-trips
expect(jsonpatch.applyPatch({}, patches, true).newDocument).toEqual(objB);
}
});
variantIt('should return an add for a property that does not exist in the first obj, without a test operation', [
['invertible = FALSE', false],
['invertible = TRUE', true]
Expand Down