Removed dependency of lodash completely from SDK

Author: fayyazarshad

packages/optimizely-sdk/lib/core/bucketer/index.tests.js

@@ -16,14 +16,14 @@
 var bucketer = require('./');
 var enums = require('../../utils/enums');
 var logger = require('../../plugins/logger');
-var fns = require('../../utils/fns');
 var projectConfig = require('../project_config');
 var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var testData = require('../../tests/test_data').getTestProjectConfig();
 
 var chai = require('chai');
 var assert = chai.assert;
 var expect = chai.expect;
+var cloneDeep = require('lodash/cloneDeep');
 var sinon = require('sinon');
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
@@ -47,7 +47,7 @@ describe('lib/core/bucketer', function() {
 
       describe('return values for bucketing (excluding groups)', function() {
         beforeEach(function() {
-          configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+          configObj = projectConfig.createProjectConfig(cloneDeep(testData));
           bucketerParams = {
             experimentId: configObj.experiments[0].id,
             experimentKey: configObj.experiments[0].key,
@@ -67,7 +67,7 @@ describe('lib/core/bucketer', function() {
         });
 
         it('should return correct variation ID when provided bucket value', function() {
-          var bucketerParamsTest1 = bucketerParams;
+          var bucketerParamsTest1 = cloneDeep(bucketerParams);
           bucketerParamsTest1.userId = 'ppid1';
           expect(bucketer.bucket(bucketerParamsTest1)).to.equal('111128');
 
@@ -77,7 +77,7 @@ describe('lib/core/bucketer', function() {
           expect(bucketedUser_log1).to.equal(sprintf(LOG_MESSAGES.USER_ASSIGNED_TO_VARIATION_BUCKET, 'BUCKETER', '50', 'ppid1'));
           expect(bucketedUser_log2).to.equal(sprintf(LOG_MESSAGES.USER_HAS_VARIATION, 'BUCKETER', 'ppid1', 'control', 'testExperiment'));
 
-          var bucketerParamsTest2 = bucketerParams;
+          var bucketerParamsTest2 = cloneDeep(bucketerParams);
           bucketerParamsTest2.userId = 'ppid2';
           expect(bucketer.bucket(bucketerParamsTest2)).to.equal(null);
 
@@ -92,7 +92,7 @@ describe('lib/core/bucketer', function() {
       describe('return values for bucketing (including groups)', function() {
         var bucketerStub;
         beforeEach(function() {
-          configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+          configObj = projectConfig.createProjectConfig(cloneDeep(testData));
           bucketerParams = {
             experimentId: configObj.experiments[0].id,
             experimentKey: configObj.experiments[0].key,
@@ -189,7 +189,7 @@ describe('lib/core/bucketer', function() {
           });
 
           it('should throw an error if group ID is not in the datafile', function() {
-            var bucketerParamsWithInvalidGroupId = bucketerParams;
+            var bucketerParamsWithInvalidGroupId = cloneDeep(bucketerParams);
             bucketerParamsWithInvalidGroupId.experimentKeyMap[configObj.experiments[4].key].groupId = '6969';
 
             assert.throws(function() {
@@ -237,7 +237,7 @@ describe('lib/core/bucketer', function() {
 
       describe('when the bucket value falls into empty traffic allocation ranges', function() {
         beforeEach(function() {
-          configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+          configObj = projectConfig.createProjectConfig(cloneDeep(testData));
           bucketerParams = {
             experimentId: configObj.experiments[0].id,
             experimentKey: configObj.experiments[0].key,
@@ -256,15 +256,15 @@ describe('lib/core/bucketer', function() {
         });
 
         it('should return null', function() {
-          var bucketerParamsTest1 = bucketerParams;
+          var bucketerParamsTest1 = cloneDeep(bucketerParams);
           bucketerParamsTest1.userId = 'ppid1';
           expect(bucketer.bucket(bucketerParamsTest1)).to.equal('');
         });
       });
 
       describe('when the traffic allocation has invalid variation ids', function() {
         beforeEach(function() {
-          configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+          configObj = projectConfig.createProjectConfig(cloneDeep(testData));
           bucketerParams = {
             experimentId: configObj.experiments[0].id,
             experimentKey: configObj.experiments[0].key,
@@ -283,7 +283,7 @@ describe('lib/core/bucketer', function() {
         });
 
         it('should return null', function() {
-          var bucketerParamsTest1 = bucketerParams;
+          var bucketerParamsTest1 = cloneDeep(bucketerParams);
           bucketerParamsTest1.userId = 'ppid1';
           expect(bucketer.bucket(bucketerParamsTest1)).to.equal(null);
         });
@@ -318,7 +318,7 @@ describe('lib/core/bucketer', function() {
       });
 
       beforeEach(function() {
-        configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+        configObj = projectConfig.createProjectConfig(cloneDeep(testData));
         bucketerParams = {
           trafficAllocationConfig: configObj.experiments[0].trafficAllocation,
           variationIdMap: configObj.variationIdMap,
@@ -329,7 +329,7 @@ describe('lib/core/bucketer', function() {
       });
 
       it('check that a non null bucketingId buckets a variation different than the one expected with userId', function () {
-        var bucketerParams1 = bucketerParams;
+        var bucketerParams1 = cloneDeep(bucketerParams);
         bucketerParams1['userId'] = 'testBucketingIdControl';
         bucketerParams1['bucketingId'] = '123456789';
         bucketerParams1['experimentKey'] = 'testExperiment';
@@ -338,7 +338,7 @@ describe('lib/core/bucketer', function() {
       });
 
       it('check that a null bucketing ID defaults to bucketing with the userId', function () {
-        var bucketerParams2 = bucketerParams;
+        var bucketerParams2 = cloneDeep(bucketerParams);
         bucketerParams2['userId'] = 'testBucketingIdControl';
         bucketerParams2['bucketingId'] = null;
         bucketerParams2['experimentKey'] = 'testExperiment';
@@ -347,7 +347,7 @@ describe('lib/core/bucketer', function() {
       });
 
       it('check that bucketing works with an experiment in group', function () {
-        var bucketerParams4 = bucketerParams;
+        var bucketerParams4 = cloneDeep(bucketerParams);
         bucketerParams4['userId'] = 'testBucketingIdControl';
         bucketerParams4['bucketingId'] = '123456789';
         bucketerParams4['experimentKey'] = 'groupExperiment2';

packages/optimizely-sdk/lib/core/decision_service/index.tests.js

@@ -22,6 +22,7 @@ var bucketer = require('../bucketer');
 var DecisionService = require('./');
 var enums = require('../../utils/enums');
 var fns = require('../../utils/fns');
+var cloneDeep = require('lodash/cloneDeep');
 var logger = require('../../plugins/logger');
 var projectConfig = require('../project_config');
 var sprintf = require('@optimizely/js-sdk-utils').sprintf;
@@ -40,7 +41,7 @@ var DECISION_SOURCES = enums.DECISION_SOURCES;
 
 describe('lib/core/decision_service', function() {
   describe('APIs', function() {
-    var configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+    var configObj = projectConfig.createProjectConfig(cloneDeep(testData));
     var decisionServiceInstance;
     var mockLogger = logger.createLogger({logLevel: LOG_LEVEL.INFO});
     var bucketerStub;
@@ -619,7 +620,7 @@ describe('lib/core/decision_service', function() {
       it('should return null when a variation was previously set, and that variation no longer exists on the config object', function() {
         var didSetVariation = decisionServiceInstance.setForcedVariation(configObj, 'testExperiment', 'user1', 'control');
         assert.strictEqual(didSetVariation, true);
-        var newDatafile = fns.cloneJsonObject(testData);
+        var newDatafile = cloneDeep(testData);
         // Remove 'control' variation from variations, traffic allocation, and datafile forcedVariations.
         newDatafile.experiments[0].variations = [{
           key: 'variation',
@@ -642,7 +643,7 @@ describe('lib/core/decision_service', function() {
       it('should return null when a variation was previously set, and that variation\'s experiment no longer exists on the config object', function() {
         var didSetVariation = decisionServiceInstance.setForcedVariation(configObj, 'testExperiment', 'user1', 'control');
         assert.strictEqual(didSetVariation, true);
-        var newConfigObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testDataWithFeatures));
+        var newConfigObj = projectConfig.createProjectConfig(cloneDeep(testDataWithFeatures));
         var forcedVar = decisionServiceInstance.getForcedVariation(newConfigObj, 'testExperiment', 'user1');
         assert.strictEqual(forcedVar, null);
       });
@@ -658,7 +659,7 @@ describe('lib/core/decision_service', function() {
 
   // TODO: Move tests that test methods of Optimizely to lib/optimizely/index.tests.js
   describe('when a bucketingID is provided', function() {
-    var configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+    var configObj = projectConfig.createProjectConfig(cloneDeep(testData));
     var createdLogger = logger.createLogger({
       logLevel: LOG_LEVEL.DEBUG,
       logToConsole: false,
@@ -667,7 +668,7 @@ describe('lib/core/decision_service', function() {
     beforeEach(function () {
       optlyInstance = new Optimizely({
         clientEngine: 'node-sdk',
-        datafile: fns.cloneJsonObject(testData),
+        datafile: cloneDeep(testData),
         jsonSchemaValidator: jsonSchemaValidator,
         isValidInstance: true,
         logger: createdLogger,
@@ -805,7 +806,7 @@ describe('lib/core/decision_service', function() {
 
     beforeEach(function() {
       sinon.stub(mockLogger, 'log');
-      configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+      configObj = projectConfig.createProjectConfig(cloneDeep(testData));
       decisionService = DecisionService.createDecisionService({
         logger: mockLogger,
       });
@@ -840,7 +841,7 @@ describe('lib/core/decision_service', function() {
       var sandbox;
       var mockLogger = logger.createLogger({logLevel: LOG_LEVEL.INFO});
       beforeEach(function() {
-        configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testDataWithFeatures));
+        configObj = projectConfig.createProjectConfig(cloneDeep(testDataWithFeatures));
         sandbox = sinon.sandbox.create();
         sandbox.stub(mockLogger, 'log');
         decisionServiceInstance = DecisionService.createDecisionService({
@@ -1622,7 +1623,7 @@ describe('lib/core/decision_service', function() {
       var __buildBucketerParamsSpy;
 
       beforeEach(function() {
-        configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testDataWithFeatures));
+        configObj = projectConfig.createProjectConfig(cloneDeep(testDataWithFeatures));
         feature = configObj.featureKeyMap.test_feature;
         decisionService = DecisionService.createDecisionService({
           logger: logger.createLogger({logLevel: LOG_LEVEL.INFO}),

packages/optimizely-sdk/lib/core/optimizely_config/index.tests.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 var assert = require('chai').assert;
-var fns = require('../../utils/fns');
+var cloneDeep = require('lodash/cloneDeep');
 var datafile = require('../../tests/test_data').getTestProjectConfigWithFeatures();
 var projectConfig = require('../project_config');
 var optimizelyConfig = require('./index');
@@ -37,7 +37,7 @@ describe('lib/core/optimizely_config', function() {
     var optimizelyConfigObject;
     var projectConfigObject;
     beforeEach(function() {
-      projectConfigObject = projectConfig.createProjectConfig(fns.cloneJsonObject(datafile));
+      projectConfigObject = projectConfig.createProjectConfig(cloneDeep(datafile));
       optimizelyConfigObject = optimizelyConfig.getOptimizelyConfig(projectConfigObject);
     });
 

packages/optimizely-sdk/lib/core/project_config/index.tests.js

@@ -22,6 +22,7 @@ var logging = require('@optimizely/js-sdk-logging');
 var logger = logging.getLogger();
 
 var _ = require('lodash/core');
+var cloneDeep = require('lodash/cloneDeep');
 var fns = require('../../utils/fns');
 var chai = require('chai');
 var assert = chai.assert;
@@ -230,7 +231,7 @@ describe('lib/core/project_config', function() {
     var createdLogger = loggerPlugin.createLogger({logLevel: LOG_LEVEL.INFO});
 
     beforeEach(function() {
-      configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+      configObj = projectConfig.createProjectConfig(cloneDeep(testData));
       sinon.stub(createdLogger, 'log');
     });
 
@@ -531,13 +532,13 @@ describe('lib/core/project_config', function() {
 
     describe('#getExperimentAudienceConditions', function() {
       it('should retrieve audiences for valid experiment key', function() {
-        configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+        configObj = projectConfig.createProjectConfig(cloneDeep(testData));
         assert.deepEqual(projectConfig.getExperimentAudienceConditions(configObj, testData.experiments[1].key),
                          ['11154']);
       });
 
       it('should throw error for invalid experiment key', function() {
-        configObj = projectConfig.createProjectConfig(fns.cloneJsonObject(testData));
+        configObj = projectConfig.createProjectConfig(cloneDeep(testData));
         assert.throws(function() {
           projectConfig.getExperimentAudienceConditions(configObj, 'invalidExperimentKey');
         }, sprintf(ERROR_MESSAGES.INVALID_EXPERIMENT_KEY, 'PROJECT_CONFIG', 'invalidExperimentKey'));

packages/optimizely-sdk/lib/core/project_config/project_config_manager.tests.js

@@ -18,7 +18,7 @@ var assert = require('chai').assert;
 var datafileManager = require('@optimizely/js-sdk-datafile-manager');
 var logging = require('@optimizely/js-sdk-logging');
 var sinon = require('sinon');
-var fns = require('../../utils/fns');
+var cloneDeep = require('lodash/cloneDeep');
 var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var enums = require('../../utils/enums');
 var jsonSchemaValidator = require('../../utils/json_schema_validator');
@@ -154,7 +154,7 @@ describe('lib/core/project_config/project_config_manager', function() {
   it('should return a valid datafile from getConfig and resolve onReady with a successful result', function() {
     var configWithFeatures = testData.getTestProjectConfigWithFeatures();
     var manager = new projectConfigManager.ProjectConfigManager({
-      datafile: fns.cloneJsonObject(configWithFeatures),
+      datafile: cloneDeep(configWithFeatures),
     });
     assert.deepEqual(
       manager.getConfig(),
@@ -205,7 +205,7 @@ describe('lib/core/project_config/project_config_manager', function() {
         datafileManager.HttpPollingDatafileManager.returns({
           start: sinon.stub(),
           stop: sinon.stub(),
-          get: sinon.stub().returns(fns.cloneJsonObject(configWithFeatures)),
+          get: sinon.stub().returns(cloneDeep(configWithFeatures)),
           on: sinon.stub().returns(function() {}),
           onReady: sinon.stub().returns(Promise.resolve())
         });
@@ -235,7 +235,7 @@ describe('lib/core/project_config/project_config_manager', function() {
           });
           nextDatafile.revision = '36';
           var fakeDatafileManager = datafileManager.HttpPollingDatafileManager.getCall(0).returnValue;
-          fakeDatafileManager.get.returns(fns.cloneJsonObject(nextDatafile));
+          fakeDatafileManager.get.returns(cloneDeep(nextDatafile));
           var updateListener = fakeDatafileManager.on.getCall(0).args[1];
           updateListener({ datafile: nextDatafile });
           assert.deepEqual(

packages/optimizely-sdk/lib/tests/test_data.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var fns = require('../utils/fns');
+var cloneDeep = require('lodash/cloneDeep');
 
 var config = {
   revision: '42',
@@ -345,7 +345,7 @@ var getParsedAudiences = [
 ];
 
 var getTestProjectConfig = function() {
-  return fns.cloneJsonObject(config);
+  return cloneDeep(config);
 };
 
 var configWithFeatures = {
@@ -1010,7 +1010,7 @@ var configWithFeatures = {
 };
 
 var getTestProjectConfigWithFeatures = function() {
-  return fns.cloneJsonObject(configWithFeatures);
+  return cloneDeep(configWithFeatures);
 };
 
 var datafileWithFeaturesExpectedData = {
@@ -2036,7 +2036,7 @@ var unsupportedVersionConfig = {
 };
 
 var getUnsupportedVersionConfig = function() {
-  return unsupportedVersionConfig;
+  return cloneDeep(unsupportedVersionConfig);
 };
 
 var typedAudiencesConfig = {
@@ -2437,7 +2437,7 @@ var typedAudiencesConfig = {
 };
 
 var getTypedAudiencesConfig = function() {
-  return fns.cloneJsonObject(typedAudiencesConfig);
+  return cloneDeep(typedAudiencesConfig);
 };
 
 var typedAudiencesById = {
@@ -2575,7 +2575,7 @@ var mutexFeatureTestsConfig = {
 };
 
 var getMutexFeatureTestsConfig = function() {
-  return mutexFeatureTestsConfig;
+  return cloneDeep(mutexFeatureTestsConfig);
 };
 
 module.exports = {

packages/optimizely-sdk/lib/utils/fns/index.js

@@ -39,9 +39,6 @@ module.exports = {
       return to;
     }
   },
-  cloneJsonObject: function(object) {
-    return JSON.parse(JSON.stringify(object));
-  },
   currentTimestamp: function() {
     return Math.round(new Date().getTime());
   },

packages/optimizely-sdk/package-lock.json

@@ -38,14 +38,14 @@
     "@optimizely/js-sdk-logging": "^0.1.0",
     "@optimizely/js-sdk-utils": "^0.2.0",
     "json-schema": "^0.2.3",
-    "lodash": "^4.17.11",
     "murmurhash": "0.0.2",
     "promise-polyfill": "8.1.0",
     "uuid": "^3.3.2"
   },
   "devDependencies": {
     "bluebird": "^3.4.6",
     "chai": "^4.2.0",
+    "lodash": "^4.17.11",
     "coveralls": "^3.0.2",
     "eslint": "^6.7.2",
     "istanbul": "^0.4.5",