Remove sprintf-js package replace with home-rolled version (optimizely#242)

jordangarcia · web-flow · commit 066b99d66e61 · 2019-03-08T14:22:07.000-08:00
* Remove sprintf-js and replace with home-rolled version

* Update LICENSE headers
diff --git a/packages/optimizely-sdk/lib/core/audience_evaluator/index.js b/packages/optimizely-sdk/lib/core/audience_evaluator/index.js
@@ -16,7 +16,7 @@
 var conditionTreeEvaluator = require('../condition_tree_evaluator');
 var customAttributeConditionEvaluator = require('../custom_attribute_condition_evaluator');
 var enums = require('../../utils/enums');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var LOG_LEVEL = enums.LOG_LEVEL;
 var LOG_MESSAGES = enums.LOG_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/core/audience_evaluator/index.tests.js b/packages/optimizely-sdk/lib/core/audience_evaluator/index.tests.js
@@ -15,7 +15,7 @@
  */
 var audienceEvaluator = require('./');
 var chai = require('chai');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var conditionTreeEvaluator = require('../condition_tree_evaluator');
 var customAttributeConditionEvaluator = require('../custom_attribute_condition_evaluator');
 var sinon = require('sinon');
diff --git a/packages/optimizely-sdk/lib/core/bucketer/index.js b/packages/optimizely-sdk/lib/core/bucketer/index.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2016, Optimizely
+ * Copyright 2016, 2019 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
  */
 var enums = require('../../utils/enums');
 var murmurhash = require('murmurhash');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
 var HASH_SEED = 1;
diff --git a/packages/optimizely-sdk/lib/core/bucketer/index.tests.js b/packages/optimizely-sdk/lib/core/bucketer/index.tests.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2017, Optimizely
+ * Copyright 2016-2017, 2019 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@ var bucketer = require('./');
 var enums = require('../../utils/enums');
 var logger = require('../../plugins/logger');
 var projectConfig = require('../project_config');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var testData = require('../../tests/test_data').getTestProjectConfig();
 
 var chai = require('chai');
diff --git a/packages/optimizely-sdk/lib/core/custom_attribute_condition_evaluator/index.js b/packages/optimizely-sdk/lib/core/custom_attribute_condition_evaluator/index.js
@@ -16,7 +16,7 @@
 
 var fns = require('../../utils/fns');
 var enums = require('../../utils/enums');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var LOG_LEVEL = enums.LOG_LEVEL;
 var LOG_MESSAGES = enums.LOG_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/core/decision_service/index.js b/packages/optimizely-sdk/lib/core/decision_service/index.js
@@ -20,7 +20,7 @@ var enums = require('../../utils/enums');
 var fns = require('../../utils/fns');
 var projectConfig = require('../project_config');
 
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var MODULE_NAME = 'DECISION_SERVICE';
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
@@ -170,7 +170,7 @@ DecisionService.prototype.__checkIfUserIsInAudience = function(experimentKey, us
   this.logger.log(LOG_LEVEL.DEBUG, sprintf(LOG_MESSAGES.EVALUATING_AUDIENCES_COMBINED, MODULE_NAME, experimentKey, JSON.stringify(experimentAudienceConditions)));
   var result = audienceEvaluator.evaluate(experimentAudienceConditions, audiencesById, attributes, this.logger);
   this.logger.log(LOG_LEVEL.INFO, sprintf(LOG_MESSAGES.AUDIENCE_EVALUATION_RESULT_COMBINED, MODULE_NAME, experimentKey, result.toString().toUpperCase()));
-  
+
   if (!result) {
     var userDoesNotMeetConditionsLogMessage = sprintf(LOG_MESSAGES.USER_NOT_IN_EXPERIMENT, MODULE_NAME, userId, experimentKey);
     this.logger.log(LOG_LEVEL.INFO, userDoesNotMeetConditionsLogMessage);
diff --git a/packages/optimizely-sdk/lib/core/decision_service/index.tests.js b/packages/optimizely-sdk/lib/core/decision_service/index.tests.js
@@ -23,7 +23,7 @@ var DecisionService = require('./');
 var enums = require('../../utils/enums');
 var logger = require('../../plugins/logger');
 var projectConfig = require('../project_config');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var testData = require('../../tests/test_data').getTestProjectConfig();
 var testDataWithFeatures = require('../../tests/test_data').getTestProjectConfigWithFeatures();
 var jsonSchemaValidator = require('../../utils/json_schema_validator');
@@ -419,7 +419,7 @@ describe('lib/core/decision_service', function() {
 
     describe('__checkIfUserIsInAudience', function () {
       var __audienceEvaluateSpy;
-      
+
       beforeEach(function() {
         __audienceEvaluateSpy = sinon.spy(audienceEvaluator, 'evaluate');
       });
@@ -447,7 +447,7 @@ describe('lib/core/decision_service', function() {
       it('should return false when audience conditions can not be evaluated', function() {
         assert.isFalse(decisionServiceInstance.__checkIfUserIsInAudience('testExperimentWithAudiences', 'testUser'));
         assert.isTrue(__audienceEvaluateSpy.alwaysReturned(false));
-      
+
         assert.strictEqual(6, mockLogger.log.callCount);
         assert.strictEqual(mockLogger.log.args[0][1], 'DECISION_SERVICE: Evaluating audiences for experiment "testExperimentWithAudiences": ["11154"].');
         assert.strictEqual(mockLogger.log.args[4][1], 'DECISION_SERVICE: Audiences for experiment testExperimentWithAudiences collectively evaluated to FALSE.');
@@ -457,7 +457,7 @@ describe('lib/core/decision_service', function() {
       it('should return false when audience conditions are not met', function () {
         assert.isFalse(decisionServiceInstance.__checkIfUserIsInAudience('testExperimentWithAudiences', 'testUser', {browser_type: 'chrome'}));
         assert.isTrue(__audienceEvaluateSpy.alwaysReturned(false));
-        
+
         assert.strictEqual(5, mockLogger.log.callCount);
         assert.strictEqual(mockLogger.log.args[0][1], 'DECISION_SERVICE: Evaluating audiences for experiment "testExperimentWithAudiences": ["11154"].');
         assert.strictEqual(mockLogger.log.args[3][1], 'DECISION_SERVICE: Audiences for experiment testExperimentWithAudiences collectively evaluated to FALSE.');
@@ -1408,7 +1408,7 @@ describe('lib/core/decision_service', function() {
         });
         __buildBucketerParamsSpy = sinon.spy(decisionService, '__buildBucketerParams');
       });
-      
+
       afterEach(function() {
         __buildBucketerParamsSpy.restore();
       });
@@ -1425,10 +1425,10 @@ describe('lib/core/decision_service', function() {
       it('should call __buildBucketerParams with bucketing Id when bucketing Id is provided in the attributes', function () {
         var attributes = {
           test_attribute: 'test_value',
-          $opt_bucketing_id: 'abcdefg' 
+          $opt_bucketing_id: 'abcdefg'
         };
         decisionService._getVariationForRollout(feature, 'testUser', attributes);
-        
+
         sinon.assert.callCount(__buildBucketerParamsSpy, 2);
         sinon.assert.calledWithExactly(__buildBucketerParamsSpy, '594031', 'abcdefg', 'testUser');
         sinon.assert.calledWithExactly(__buildBucketerParamsSpy, '594037', 'abcdefg', 'testUser');
diff --git a/packages/optimizely-sdk/lib/core/notification_center/index.js b/packages/optimizely-sdk/lib/core/notification_center/index.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2017, Optimizely
+ * Copyright 2017, 2019 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 
 var enums = require('../../utils/enums');
 var fns = require('../../utils/fns');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var LOG_LEVEL = enums.LOG_LEVEL;
 var LOG_MESSAGES = enums.LOG_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/core/project_config/index.js b/packages/optimizely-sdk/lib/core/project_config/index.js
@@ -15,7 +15,7 @@
  */
 var fns = require('../../utils/fns');
 var enums = require('../../utils/enums');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var stringValidator = require('../../utils/string_value_validator');
 
 var EXPERIMENT_LAUNCHED_STATUS = 'Launched';
diff --git a/packages/optimizely-sdk/lib/core/project_config/index.tests.js b/packages/optimizely-sdk/lib/core/project_config/index.tests.js
@@ -23,7 +23,7 @@ var chai = require('chai');
 var assert = chai.assert;
 var logger = require('../../plugins/logger');
 var sinon = require('sinon');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
 var FEATURE_VARIABLE_TYPES = enums.FEATURE_VARIABLE_TYPES;
diff --git a/packages/optimizely-sdk/lib/optimizely/index.js b/packages/optimizely-sdk/lib/optimizely/index.js
@@ -23,7 +23,7 @@ var eventTagsValidator = require('../utils/event_tags_validator');
 var notificationCenter = require('../core/notification_center');
 var projectConfig = require('../core/project_config');
 var projectConfigSchema = require('./project_config_schema');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var userProfileServiceValidator = require('../utils/user_profile_service_validator');
 var stringValidator = require('../utils/string_value_validator');
 var configValidator = require('../utils/config_validator');
diff --git a/packages/optimizely-sdk/lib/optimizely/index.tests.js b/packages/optimizely-sdk/lib/optimizely/index.tests.js
@@ -33,7 +33,7 @@ var projectConfig = require('../core/project_config');
 var chai = require('chai');
 var assert = chai.assert;
 var sinon = require('sinon');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var uuid = require('uuid');
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/utils/attributes_validator/index.js b/packages/optimizely-sdk/lib/utils/attributes_validator/index.js
@@ -18,7 +18,7 @@
  * Provides utility method for validating that the attributes user has provided are valid
  */
 
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var lodashForOwn = require('lodash/forOwn');
 var fns = require('../../utils/fns');
 
@@ -46,7 +46,7 @@ module.exports = {
   },
 
   isAttributeValid: function(attributeKey, attributeValue) {
-    return (typeof attributeKey === 'string') && 
+    return (typeof attributeKey === 'string') &&
     (typeof attributeValue === 'string' || typeof attributeValue === 'boolean' || (fns.isNumber(attributeValue) && fns.isFinite(attributeValue)));
   },
 };
diff --git a/packages/optimizely-sdk/lib/utils/attributes_validator/index.tests.js b/packages/optimizely-sdk/lib/utils/attributes_validator/index.tests.js
@@ -15,7 +15,7 @@
  */
 var chai = require('chai');
 var assert = chai.assert;
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var attributesValidator = require('./');
 var fns = require('./../fns/');
 
@@ -79,7 +79,7 @@ describe('lib/utils/attributes_validator', function() {
 
       it('isAttributeValid returns false for invalid values', function() {
         var userAttributes = {
-          'null': null,         
+          'null': null,
           'objects': {a: 'b'},
           'array': [1, 2, 3],
           'infinity': Infinity,
diff --git a/packages/optimizely-sdk/lib/utils/config_validator/index.js b/packages/optimizely-sdk/lib/utils/config_validator/index.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2016, 2018, Optimizely
+ * Copyright 2016, 2018, 2019 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
 var MODULE_NAME = 'CONFIG_VALIDATOR';
@@ -46,7 +46,7 @@ module.exports = {
     if (config.eventDispatcher && (typeof config.eventDispatcher.dispatchEvent !== 'function')) {
       throw new Error(sprintf(ERROR_MESSAGES.INVALID_EVENT_DISPATCHER, MODULE_NAME));
     }
-    
+
     if (config.logger && (typeof config.logger.log !== 'function')) {
       throw new Error(sprintf(ERROR_MESSAGES.INVALID_LOGGER, MODULE_NAME));
     }
@@ -67,7 +67,7 @@ module.exports = {
     if (!datafile) {
       throw new Error(sprintf(ERROR_MESSAGES.NO_DATAFILE_SPECIFIED, MODULE_NAME));
     }
-    
+
     if (typeof datafile === 'string' || datafile instanceof String) {
       // Attempt to parse the datafile string
       try {
diff --git a/packages/optimizely-sdk/lib/utils/config_validator/index.tests.js b/packages/optimizely-sdk/lib/utils/config_validator/index.tests.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2016, 2018, Optimizely
+ * Copyright 2016, 2018, 2019 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 var chai = require('chai');
 var assert = chai.assert;
 var configValidator = require('./');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var testData = require('../../tests/test_data')
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/utils/event_tag_utils/index.js b/packages/optimizely-sdk/lib/utils/event_tag_utils/index.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2017, Optimizely
+ * Copyright 2017, 2019 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
  * Provides utility method for parsing event tag values
  */
 var enums = require('../enums');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var LOG_LEVEL = enums.LOG_LEVEL;
 var LOG_MESSAGES = enums.LOG_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/utils/event_tags_validator/index.js b/packages/optimizely-sdk/lib/utils/event_tags_validator/index.js
@@ -18,7 +18,7 @@
  * Provides utility method for validating that event tags user has provided are valid
  */
 
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
 var MODULE_NAME = 'EVENT_TAGS_VALIDATOR';
diff --git a/packages/optimizely-sdk/lib/utils/event_tags_validator/index.tests.js b/packages/optimizely-sdk/lib/utils/event_tags_validator/index.tests.js
@@ -15,7 +15,7 @@
  */
 var chai = require('chai');
 var assert = chai.assert;
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var eventTagsValidator = require('./');
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/utils/json_schema_validator/index.js b/packages/optimizely-sdk/lib/utils/json_schema_validator/index.js
@@ -15,7 +15,7 @@
  */
 var fns = require('../fns');
 var validate = require('json-schema').validate;
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
 var MODULE_NAME = 'JSON_SCHEMA_VALIDATOR';
diff --git a/packages/optimizely-sdk/lib/utils/json_schema_validator/index.tests.js b/packages/optimizely-sdk/lib/utils/json_schema_validator/index.tests.js
@@ -17,7 +17,7 @@ var chai = require('chai');
 var assert = chai.assert;
 var jsonSchemaValidator = require('./');
 var projectConfigSchema = require('../../optimizely/project_config_schema');
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var testData = require('../../tests/test_data.js');
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
diff --git a/packages/optimizely-sdk/lib/utils/user_profile_service_validator/index.js b/packages/optimizely-sdk/lib/utils/user_profile_service_validator/index.js
@@ -18,7 +18,7 @@
  * Provides utility method for validating that the given user profile service implementation is valid.
  */
 
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
 var MODULE_NAME = 'USER_PROFILE_SERVICE_VALIDATOR';
diff --git a/packages/optimizely-sdk/lib/utils/user_profile_service_validator/index.tests.js b/packages/optimizely-sdk/lib/utils/user_profile_service_validator/index.tests.js
@@ -16,7 +16,7 @@
 
 var chai = require('chai');
 var assert = chai.assert;
-var sprintf = require('sprintf-js').sprintf;
+var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var userProfileServiceValidator = require('./');
 
 var ERROR_MESSAGES = require('../enums').ERROR_MESSAGES;
diff --git a/packages/optimizely-sdk/package-lock.json b/packages/optimizely-sdk/package-lock.json
diff --git a/packages/optimizely-sdk/package.json b/packages/optimizely-sdk/package.json
@@ -33,10 +33,10 @@
   "homepage": "https://github.com/optimizely/javascript-sdk/tree/master/packages/optimizely-sdk",
   "dependencies": {
     "@optimizely/js-sdk-logging": "^0.1.0",
+    "@optimizely/js-sdk-utils": "^0.1.0",
     "json-schema": "^0.2.3",
     "lodash": "^4.0.0",
     "murmurhash": "0.0.2",
-    "sprintf-js": "^1.1.1",
     "uuid": "^3.3.2"
   },
   "devDependencies": {
