akira
/
superdiff
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Superdiff provides a complete and readable diff for both arrays and objects. Plus, it supports stream and file inputs for handling large datasets efficiently, is battle-tested, has zero dependencies, and is super fast.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 Commits
1 Branch
13 Tags
585 KiB
 
 
Tree: b48eefa69c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b48eefa69c'
${ noResults }
superdiff/test/object-diff.test.ts

943 lines
23 KiB
Raw Blame History

import { getObjectDiff } from "../src/object-diff";
describe("getObjectDiff", () => {
it("returns an empty diff if no objects are provided", () => {
expect(getObjectDiff(null, null)).toStrictEqual({
type: "object",
status: "equal",
diff: [],
});
});
it("consider previous object as completely deleted if no next object is provided", () => {
expect(
getObjectDiff(
{ name: "joe", age: 54, hobbies: ["golf", "football"] },
null
)
).toStrictEqual({
type: "object",
status: "deleted",
diff: [
{
property: "name",
previousValue: "joe",
currentValue: undefined,
status: "deleted",
},
{
property: "age",
previousValue: 54,
currentValue: undefined,
status: "deleted",
},
{
property: "hobbies",
previousValue: ["golf", "football"],
currentValue: undefined,
status: "deleted",
},
],
});
});
it("consider next object as completely added if no previous object is provided", () => {
expect(
getObjectDiff(null, {
name: "joe",
age: 54,
hobbies: ["golf", "football"],
})
).toStrictEqual({
type: "object",
status: "added",
diff: [
{
property: "name",
previousValue: undefined,
currentValue: "joe",
status: "added",
},
{
property: "age",
previousValue: undefined,
currentValue: 54,
status: "added",
},
{
property: "hobbies",
previousValue: undefined,
currentValue: ["golf", "football"],
status: "added",
},
],
});
});
it("consider objects as equal if no changes are detected", () => {
expect(
getObjectDiff(
{
age: 66,
member: false,
promoCode: null,
city: undefined,
hobbies: ["golf", "football"],
options: { vegan: undefined, phone: null },
},
{
age: 66,
member: false,
promoCode: null,
city: undefined,
hobbies: ["golf", "football"],
options: { vegan: undefined, phone: null },
}
)
).toStrictEqual({
type: "object",
status: "equal",
diff: [
{
property: "age",
previousValue: 66,
currentValue: 66,
status: "equal",
},
{
property: "member",
previousValue: false,
currentValue: false,
status: "equal",
},
{
property: "promoCode",
previousValue: null,
currentValue: null,
status: "equal",
},
{
property: "city",
previousValue: undefined,
currentValue: undefined,
status: "equal",
},
{
property: "hobbies",
previousValue: ["golf", "football"],
currentValue: ["golf", "football"],
status: "equal",
},
{
property: "options",
previousValue: { vegan: undefined, phone: null },
currentValue: { vegan: undefined, phone: null },
status: "equal",
},
],
});
});
it("detects changed between two objects", () => {
expect(
getObjectDiff(
{
id: 54,
type: "sport",
user: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
},
{
id: 54,
country: "us",
user: {
name: "joe",
member: false,
hobbies: ["golf", "chess"],
nickname: "super joe",
},
}
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "id",
previousValue: 54,
currentValue: 54,
status: "equal",
},
{
property: "country",
previousValue: undefined,
currentValue: "us",
status: "added",
},
{
property: "user",
previousValue: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
currentValue: {
name: "joe",
member: false,
hobbies: ["golf", "chess"],
nickname: "super joe",
},
status: "updated",
subPropertiesDiff: [
{
property: "age",
previousValue: 66,
currentValue: undefined,
status: "deleted",
},
{
property: "name",
previousValue: "joe",
currentValue: "joe",
status: "equal",
},
{
property: "member",
previousValue: true,
currentValue: false,
status: "updated",
},
{
property: "hobbies",
previousValue: ["golf", "football"],
currentValue: ["golf", "chess"],
status: "updated",
},
{
property: "nickname",
previousValue: undefined,
currentValue: "super joe",
status: "added",
},
],
},
{
property: "type",
previousValue: "sport",
currentValue: undefined,
status: "deleted",
},
],
});
});
it("detects changed between two deep nested objects", () => {
expect(
getObjectDiff(
{
id: 54,
user: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg"],
rugby: ["france"],
},
},
},
},
{
id: 54,
user: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
},
}
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "id",
previousValue: 54,
currentValue: 54,
status: "equal",
},
{
property: "user",
previousValue: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg"],
rugby: ["france"],
},
},
},
currentValue: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
},
status: "updated",
subPropertiesDiff: [
{
property: "name",
previousValue: "joe",
currentValue: "joe",
status: "equal",
},
{
property: "data",
previousValue: {
member: true,
hobbies: {
football: ["psg"],
rugby: ["france"],
},
},
currentValue: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
status: "updated",
subDiff: [
{
property: "member",
previousValue: true,
currentValue: true,
status: "equal",
},
{
property: "hobbies",
previousValue: {
football: ["psg"],
rugby: ["france"],
},
currentValue: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
status: "updated",
subDiff: [
{
property: "rugby",
previousValue: ["france"],
currentValue: undefined,
status: "deleted",
},
{
property: "football",
previousValue: ["psg"],
currentValue: ["psg", "nantes"],
status: "updated",
},
{
property: "golf",
previousValue: undefined,
currentValue: ["st andrews"],
status: "added",
},
],
},
],
},
],
},
],
});
});
it("detects changed between two objects BUT doesn't care about array order as long as all values are preserved when ignoreArrayOrder option is activated", () => {
expect(
getObjectDiff(
{
id: 54,
type: "sport",
user: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
},
{
id: 54,
country: "us",
user: {
name: "joe",
member: false,
hobbies: ["football", "golf"],
nickname: "super joe",
},
},
{ ignoreArrayOrder: true }
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "id",
previousValue: 54,
currentValue: 54,
status: "equal",
},
{
property: "country",
previousValue: undefined,
currentValue: "us",
status: "added",
},
{
property: "user",
previousValue: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
currentValue: {
name: "joe",
member: false,
hobbies: ["football", "golf"],
nickname: "super joe",
},
status: "updated",
subPropertiesDiff: [
{
property: "age",
previousValue: 66,
currentValue: undefined,
status: "deleted",
},
{
property: "name",
previousValue: "joe",
currentValue: "joe",
status: "equal",
},
{
property: "member",
previousValue: true,
currentValue: false,
status: "updated",
},
{
property: "hobbies",
previousValue: ["golf", "football"],
currentValue: ["football", "golf"],
status: "equal",
},
{
property: "nickname",
previousValue: undefined,
currentValue: "super joe",
status: "added",
},
],
},
{
property: "type",
previousValue: "sport",
currentValue: undefined,
status: "deleted",
},
],
});
});
it("shows only main added values", () => {
expect(
getObjectDiff(
{
id: 54,
type: "sport",
user: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
},
{
id: 54,
country: "us",
user: {
name: "joe",
member: false,
hobbies: ["golf", "chess"],
nickname: "super joe",
},
},
{ showOnly: { statuses: ["added"] } }
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "country",
previousValue: undefined,
currentValue: "us",
status: "added",
},
],
});
});
it("shows only added and deleted values in nested objects", () => {
expect(
getObjectDiff(
{
id: 54,
type: "sport",
user: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
},
{
id: 54,
country: "us",
user: {
name: "joe",
member: false,
hobbies: ["golf", "chess"],
nickname: "super joe",
},
},
{ showOnly: { statuses: ["added", "deleted"], granularity: "deep" } }
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "country",
previousValue: undefined,
currentValue: "us",
status: "added",
},
{
property: "user",
previousValue: {
name: "joe",
member: true,
hobbies: ["golf", "football"],
age: 66,
},
currentValue: {
name: "joe",
member: false,
hobbies: ["golf", "chess"],
nickname: "super joe",
},
status: "updated",
subPropertiesDiff: [
{
property: "age",
previousValue: 66,
currentValue: undefined,
status: "deleted",
},
{
property: "nickname",
previousValue: undefined,
currentValue: "super joe",
status: "added",
},
],
},
{
property: "type",
previousValue: "sport",
currentValue: undefined,
status: "deleted",
},
],
});
});
it("shows only updated values in deeply nested objects", () => {
expect(
getObjectDiff(
{
id: 54,
user: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg"],
rugby: ["france"],
},
},
},
},
{
id: 54,
user: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
},
},
{
showOnly: {
statuses: ["updated"],
granularity: "deep",
},
}
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "user",
previousValue: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg"],
rugby: ["france"],
},
},
},
currentValue: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
},
status: "updated",
subPropertiesDiff: [
{
property: "data",
previousValue: {
member: true,
hobbies: {
football: ["psg"],
rugby: ["france"],
},
},
currentValue: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
status: "updated",
subDiff: [
{
property: "hobbies",
previousValue: {
football: ["psg"],
rugby: ["france"],
},
currentValue: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
status: "updated",
subDiff: [
{
property: "football",
previousValue: ["psg"],
currentValue: ["psg", "nantes"],
status: "updated",
},
],
},
],
},
],
},
],
});
});
it("shows only added values in deeply nested objects", () => {
expect(
getObjectDiff(
{
id: 54,
user: {
name: "joe",
data: {
member: true,
hobbies: {
rugby: ["france"],
},
},
},
},
{
id: 54,
user: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
},
},
{
showOnly: {
statuses: ["added"],
granularity: "deep",
},
}
)
).toStrictEqual({
type: "object",
status: "updated",
diff: [
{
property: "user",
previousValue: {
name: "joe",
data: {
member: true,
hobbies: {
rugby: ["france"],
},
},
},
currentValue: {
name: "joe",
data: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
},
status: "updated",
subPropertiesDiff: [
{
property: "data",
previousValue: {
member: true,
hobbies: {
rugby: ["france"],
},
},
currentValue: {
member: true,
hobbies: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
},
status: "updated",
subDiff: [
{
property: "hobbies",
previousValue: {
rugby: ["france"],
},
currentValue: {
football: ["psg", "nantes"],
golf: ["st andrews"],
},
status: "updated",
subDiff: [
{
property: "football",
previousValue: undefined,
currentValue: ["psg", "nantes"],
status: "added",
},
{
property: "golf",
previousValue: undefined,
currentValue: ["st andrews"],
status: "added",
},
],
},
],
},
],
},
],
});
});
it("returns an empty diff if no property match the required statuses output", () => {
expect(
getObjectDiff(
null,
{
name: "joe",
age: 54,
hobbies: ["golf", "football"],
},
{ showOnly: { statuses: ["deleted"], granularity: "deep" } }
)
).toStrictEqual({
type: "object",
status: "added",
diff: [],
});
});
expect(
getObjectDiff(
{
name: "joe",
age: 54,
hobbies: ["golf", "football"],
},
null,
{ showOnly: { statuses: ["added"], granularity: "deep" } }
)
).toStrictEqual({
type: "object",
status: "deleted",
diff: [],
});
it("returns all values if their status match the required statuses", () => {
expect(
getObjectDiff(
{ name: "joe", age: 54, hobbies: ["golf", "football"] },
null,
{ showOnly: { statuses: ["deleted"] } }
)
).toStrictEqual({
type: "object",
status: "deleted",
diff: [
{
property: "name",
previousValue: "joe",
currentValue: undefined,
status: "deleted",
},
{
property: "age",
previousValue: 54,
currentValue: undefined,
status: "deleted",
},
{
property: "hobbies",
previousValue: ["golf", "football"],
currentValue: undefined,
status: "deleted",
},
],
});
});
it("detects changes when comparing an array value property to a non-array value property", () => {
expect(
getObjectDiff(
{
name: "joe",
age: 55,
hobbies: ["golf", "football"]
},
{
name: "joe",
age: 55,
hobbies: null
}))
.toStrictEqual({
type: "object",
status: "updated",
diff: [
{
currentValue: "joe",
previousValue: "joe",
property: "name",
status: "equal",
},
{
currentValue: 55,
previousValue: 55,
property: "age",
status: "equal",
},
{
currentValue: null,
previousValue: [
"golf",
"football",
],
property: "hobbies",
status: "updated",
}
]
})
})
it("detects changes when comparing a non-array value property to an array value property", () => {
expect(
getObjectDiff(
{
name: "joe",
age: 55,
hobbies: null
},
{
name: "joe",
age: 55,
hobbies: ["golf", "football"]
}))
.toStrictEqual({
type: "object",
status: "updated",
diff: [
{
currentValue: "joe",
previousValue: "joe",
property: "name",
status: "equal",
},
{
currentValue: 55,
previousValue: 55,
property: "age",
status: "equal",
},
{
currentValue: [
"golf",
"football",
],
previousValue: null,
property: "hobbies",
status: "updated",
}
]
})
});
});