Retiring diffDeep.

jdmarshall · jdmarshall · commit a0ad69fb2920 · 2025-08-15T12:07:23.000-07:00
This function has a number of bugs, and lodash does it better. closes #814
diff --git a/lib/config.js b/lib/config.js
@@ -546,61 +546,6 @@ util.attachProtoDeep = function(toObject, depth) {
   return toObject;
 };
 
-/**
- * Returns an object containing all elements that differ between two objects.
- * <p>
- * This method was designed to be used to create the runtime.json file
- * contents, but can be used to get the diffs between any two Javascript objects.
- * </p>
- * <p>
- * It works best when object2 originated by deep copying object1, then
- * changes were made to object2, and you want an object that would give you
- * the changes made to object1 which resulted in object2.
- * </p>
- *
- * <b>This function has a number of issues and you may be better off with lodash</b>
- *
- * @protected
- * @deprecated please investigate lodash or similar tools for object traversal
- * @method diffDeep
- * @param object1 {Object} The base object to compare to
- * @param object2 {Object} The object to compare with
- * @param depth {integer} An optional depth to prevent recursion.  Default: 20.
- * @return {Object} A differential object, which if extended onto object1 would
- *                  result in object2.
- */
-util.diffDeep = function(object1, object2, depth) {
-  // Recursion detection
-  const diff = {};
-  depth = (depth === null ? DEFAULT_CLONE_DEPTH : depth);
-  if (depth < 0) {
-    return {};
-  }
-
-  // Process each element from object2, adding any element that's different
-  // from object 1.
-  for (const parm in object2) {
-    const value1 = object1[parm];
-    const value2 = object2[parm];
-    if (value1 && value2 && Util.isObject(value2)) {
-      if (!(Util.equalsDeep(value1, value2))) {
-        diff[parm] = util.diffDeep(value1, value2, depth - 1);
-      }
-    }
-    else if (Array.isArray(value1) && Array.isArray(value2)) {
-      if(!Util.equalsDeep(value1, value2)) {
-        diff[parm] = value2;
-      }
-    }
-    else if (value1 !== value2){
-      diff[parm] = value2;
-    }
-  }
-
-  // Return the diff object
-  return diff;
-};
-
 /**
  * Returns a new deep copy of the current config object, or any part of the config if provided.
  *
diff --git a/test/1-protected-test.js b/test/1-protected-test.js
@@ -55,50 +55,6 @@ describe('Protected (hackable) utilities test', function() {
     });
   });
 
-  describe('diffDeep() tests', function() {
-    it('The function exists', function() {
-      assert.strictEqual(typeof config.util.diffDeep, 'function');
-    });
-
-    it('Returns an empty object if no differences', function() {
-      let a = {value_3: 14, hello:'world', value_1: 29};
-      let b = {value_1: 29, hello:'world', value_3: 14};
-
-      assert.strictEqual(typeof config.util.diffDeep(a,b), 'object');
-      assert.strictEqual(Object.keys(config.util.diffDeep(a, b)).length, 0);
-    });
-
-    it('Returns an empty object if no differences (deep)', function() {
-      let a = { value_3: 14, hello:'world', value_1: 29, value_4: [1,'hello',2], deepObj: { a: 22, b: { c: 45, a: 44 } } };
-      let b = { value_1: 29, hello:'world', value_3: 14, value_4: [1,'hello',2], deepObj: { a: 22, b: { a: 44, c: 45 } } };
-
-      assert.strictEqual(typeof(config.util.diffDeep(a,b)), 'object');
-      assert.strictEqual(Object.keys(config.util.diffDeep(a, b)).length, 0);
-    });
-
-    it('Returns just the diff values', function() {
-      let a = { value_3: 14, hello:'wurld', value_1: 29, deepObj: { a: 22, b: { c: 45, a: 44 } } };
-      let b = { value_1: 29, hello:'world', value_3: 14, deepObj: { a: 22, b: { a: 44, c: 45 } } };
-      let diff = config.util.diffDeep(a,b);
-
-      assert.strictEqual(Object.keys(diff).length, 1);
-      assert.strictEqual(diff.hello, 'world');
-    });
-
-    it('Returns just the diff values (deep)', function() {
-      let a = { value_3: 14, hello: 'wurld', value_1: 29, value_4: [1,'hello',2], deepObj: { a:22, b: { c: 45, a: 44} } };
-      let b = { value_1: 29, hello: 'wurld', value_3: 14, value_4: [1,'goodbye',2], deepObj: { a:22, b: { a: 45, c: 44} } };
-      let diff = config.util.diffDeep(a,b);
-
-      assert.strictEqual(Object.keys(diff).length, 2);
-      assert.strictEqual(Object.keys(diff.deepObj).length, 1);
-      assert.strictEqual(Object.keys(diff.deepObj.b).length, 2);
-      assert.strictEqual(diff.deepObj.b.a, 45);
-      assert.strictEqual(diff.deepObj.b.c, 44);
-      assert.deepEqual(diff.value_4, [1, 'goodbye', 2]);
-    })
-  });
-
   describe('loadFileConfigs() tests', function() {
     let configs;
 
