deep-diff

Javascript utility for calculating deep difference, capturing changes, and applying changes across objects; for nodejs and the browser.

deep-diff

deep-diff is a javascript/node.js module providing utility functions for working with the structural differences between objects.

Features

• Get the structural differences between two objects.
• Observe the structural differences between two objects.
• When structural differences represent change, apply change from one object to another.
• When structural differences represent change, selectively apply change from one object to another.

ChangeLog

0.2.0 - Fixes Bug #17, Fixes Bug #19, Enhancement #21 Applying changes that are properly structured can now be applied as a change (no longer requires typeof Diff) - supports differences being applied after round-trip serialization to JSON format. Prefilter now reports the path of all changes - it was not showing a path for arrays and anything in the structure below (reported by @ravishvt).

Breaking Change – The structure of change records for differences below an array element has changed. Array indexes are now reported as numeric elements in the path if the changes is merely edited (an E kind). Changes of kind A (array) are only reported for changes in the terminal array itself and will have a nested N (new) item or a nested D (deleted) item.

0.1.7 - Enhancement #11 Added the ability to filter properties that should not be analyzed while calculating differences. Makes deep-diff more usable with frameworks that attach housekeeping properties to existing objects. AngularJS does this, and the new filter ability should ease working with it.

0.1.6 - Changed objects within nested arrays can now be applied. They were previously recording the changes appropriately but applyDiff would error. Comparison of NaN works more sanely - comparison to number shows difference, comparison to another Nan does not.

Installation

npm install deep-diff

For the browser, you can install with bower:

bower install deep-diff

Tests

Tests use mocha and expect.js, so if you clone the github repository you'll need to run:

npm install

... followed by ...

npm test

... or ...

mocha -R spec

Importing

nodejs

var deep = require('deep-diff')

browser

<script src="deep-diff-0.2.0.min.js"></script>

Minified, browser release of the current version of the module is under the releases folder. In a browser, deep-diff defines a global variable DeepDiff. If there is a conflict in the global namesapce you can restore the conflicting definition and assign deep-diff to another variable like this: var deep = DeepDiff.noConflict();.

Simple Examples

In order to describe differences, change revolves around an origin object. For consistency, the origin object is always the operand on the left-hand-side of operations. The comparand, which may contain changes, is always on the right-hand-side of operations.

var diff = require('deep-diff').diff;
 
var lhs = {
    name: 'my object',
    description: 'it\'s an object!',
    details: {
        it: 'has',
        an: 'array',
        with: ['a', 'few', 'elements']
    }
};
 
var rhs = {
    name: 'updated object',
    description: 'it\'s an object!',
    details: {
        it: 'has',
        an: 'array',
        with: ['a', 'few', 'more', 'elements', { than: 'before' }]
    }
};
 
var differences = diff(lhs, rhs);

up to v 0.1.7 The code snippet above would result in the following structure describing the differences:

// Versions < 0.2.0 
[ { kind: 'E',
    path: [ 'name' ],
    lhs: 'my object',
    rhs: 'updated object' },
  { kind: 'A',
    path: [ 'details', 'with' ],
    index: 2,
    item: { kind: 'E', path: [], lhs: 'elements', rhs: 'more' } },
  { kind: 'A',
    path: [ 'details', 'with' ],
    index: 3,
    item: { kind: 'N', rhs: 'elements' } },
  { kind: 'A',
    path: [ 'details', 'with' ],
    index: 4,
    item: { kind: 'N', rhs: { than: 'before' } } } ]

v 0.2.0 and above The code snippet above would result in the following structure describing the differences:

[ { kind: 'E',
    path: [ 'name' ],
    lhs: 'my object',
    rhs: 'updated object' },
  { kind: 'E',
    path: [ 'details', 'with', 2 ],
        lhs: 'elements',
        rhs: 'more' },
  { kind: 'A',
    path: [ 'details', 'with' ],
    index: 3,
    item: { kind: 'N', rhs: 'elements' } },
  { kind: 'A',
    path: [ 'details', 'with' ],
    index: 4,
    item: { kind: 'N', rhs: { than: 'before' } } } ]

Differences

Differences are reported as one or more change records. Change records have the following structure:

• kind - indicates the kind of change; will be one of the following:
  • N - indicates a newly added property/element
  • D - indicates a property/element was deleted
  • E - indicates a property/element was edited
  • A - indicates a change occurred within an array
• path - the property path (from the left-hand-side root)
• lhs - the value on the left-hand-side of the comparison (undefined if kind === 'N')
• rhs - the value on the right-hand-side of the comparison (undefined if kind === 'D')
• index - when kind === 'A', indicates the array index where the change occurred
• item - when kind === 'A', contains a nested change record indicating the change that occurred at the array index

Change records are generated for all structural differences between origin and comparand. The methods only consider an object's own properties and array elements; those inherited from an object's prototype chain are not considered.

Changes to arrays are recorded simplistically. We care most about the shape of the structure; therefore we don't take the time to determine if an object moved from one slot in the array to another. Instead, we only record the structural differences. If the structural differences are applied from the comparand to the origin then the two objects will compare as "deep equal" using most isEqual implementations such as found in lodash or underscore.

Changes

When two objects differ, you can observe the differences as they are calculated and selectively apply those changes to the origin object (left-hand-side).

var observableDiff = require('deep-diff').observableDiff,
applyChange        = require('deep-diff').applyChange;
 
var lhs = {
    name: 'my object',
    description: 'it\'s an object!',
    details: {
        it: 'has',
        an: 'array',
        with: ['a', 'few', 'elements']
    }
};
 
var rhs = {
    name: 'updated object',
    description: 'it\'s an object!',
    details: {
        it: 'has',
        an: 'array',
        with: ['a', 'few', 'more', 'elements', { than: 'before' }]
    }
};
 
observableDiff(lhs, rhs, function (d) {
    // Apply all changes except those to the 'name' property... 
    if (d.path.length !== 1 || d.path.join('.') !== 'name') {
        applyChange(lhs, rhs, d);
    }
});

API Documentation

A standard import of var diff = require('deep-diff') is assumed in all of the code examples. The import results in an object having the following public properties:

• diff - a function that calculates the differences between two objects.
• observableDiff - a function that calculates the differences between two objects and reports each to an observer function.
• applyDiff - a function that applies any structural differences from one object to another.
• applyChange - a function that applies a single change record to an origin object.
• revertChange - a function that reverts a single change record from a target object.

diff

The diff function calculates the difference between two objects. In version 0.1.7 you can supply your own prefilter function as the 3rd arguement and control which properties are ignored while calculating differences throughout the object graph.

Arguments

• lhs - the left-hand operand; the origin object.
• rhs - the right-hand operand; the object being compared structurally with the origin object.
• prefilter - an optional function that determines whether difference analysis should continue down the object graph.
• acc - an optional accumulator/array (requirement is that it have a push function). Each difference is pushed to the specified accumulator.

Pre-filtering Object Properties

The prefilter's signature should be function(path, key) and it should return a truthy value for any path-key combination that should be filtered. If filtered, the difference analysis does no further analysis of on the identified object-property path.

Compatability

Currently testing on Travis CI against:

• node.js 0.11
• node.js 0.10
• node.js 0.8