feat (datafile management): Initialize datafile manager in Optimizely constructor, add onReady method (#13)

Summary:

- Import and use datafile manager package. Create datafile manager instance in Optimizely constructor if `sdkKey`. is provided.
- Provide `onReady` method, returning a promise based on the datafile manager's `onReady` method, or a fulfilled promise if no `sdkKey` was provided.
- Update `isValidInstance` to distinguish between config validity and datafile/project config validity.
- Move some validation/creation logic into a new function in the project config module: `tryCreatingProjectConfig`
- Return early in top-level methods when `configObj` is not available

Test plan:

Unit tests

Issues:
https://optimizely.atlassian.net/browse/OASIS-4384

Author: mjc1283

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

@@ -17,6 +17,8 @@ var fns = require('../../utils/fns');
 var enums = require('../../utils/enums');
 var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var stringValidator = require('../../utils/string_value_validator');
+var configValidator = require('../../utils/config_validator');
+var projectConfigSchema = require('./project_config_schema');
 
 var EXPERIMENT_LAUNCHED_STATUS = 'Launched';
 var EXPERIMENT_RUNNING_STATUS = 'Running';
@@ -594,4 +596,36 @@ module.exports = {
   eventWithKeyExists: function(projectConfig, eventKey) {
     return projectConfig.eventKeyMap.hasOwnProperty(eventKey);
   },
+
+  /**
+   * Try to create a project config object from the given datafile and
+   * configuration properties.
+   * If successful, return the project config object, otherwise return null.
+   * @param  {Object} config
+   * @param  {Object} config.datafile
+   * @param  {Object} config.errorHandler
+   * @param  {Object} config.jsonSchemaValidator
+   * @param  {Object} config.logger
+   * @param  {Object} config.skipJSONValidation
+   * @return {Object|null} Project config object if datafile was valid, otherwise null
+   */
+  tryCreatingProjectConfig: function(config) {
+    var configObj = null;
+    try {
+      configValidator.validateDatafile(config.datafile);
+      if (config.skipJSONValidation === true) {
+        configObj = module.exports.createProjectConfig(config.datafile);
+        config.logger.log(LOG_LEVEL.INFO, sprintf(LOG_MESSAGES.SKIPPING_JSON_VALIDATION, MODULE_NAME));
+      } else if (!config.jsonSchemaValidator) {
+        configObj = module.exports.createProjectConfig(config.datafile);
+      } else if (config.jsonSchemaValidator.validate(projectConfigSchema, config.datafile)) {
+        configObj = module.exports.createProjectConfig(config.datafile);
+        config.logger.log(LOG_LEVEL.INFO, sprintf(LOG_MESSAGES.VALID_DATAFILE, MODULE_NAME));
+      }
+    } catch (ex) {
+      config.logger.log(LOG_LEVEL.ERROR, ex.message);
+      config.errorHandler.handleError(ex);
+    }
+    return configObj;
+  }
 };

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

@@ -16,6 +16,7 @@
 var projectConfig = require('./');
 var enums = require('../../utils/enums');
 var testDatafile = require('../../tests/test_data');
+var configValidator = require('../../utils/config_validator');
 
 var _ = require('lodash/core');
 var fns = require('../../utils/fns');
@@ -727,4 +728,120 @@ describe('lib/core/project_config', function() {
       assert.strictEqual(didSetVariation, false);
     });
   });
+
+  describe('#tryCreatingProjectConfig', function() {
+    var stubErrorHandler;
+    var stubJsonSchemaValidator;
+    var stubLogger;
+    beforeEach(function() {
+      stubErrorHandler = {
+        handleError: sinon.stub(),
+      };
+      stubJsonSchemaValidator = {
+        validate: sinon.stub().returns(true),
+      };
+      stubLogger = {
+        log: sinon.stub(),
+      };
+      sinon.stub(projectConfig, 'createProjectConfig').returns({});
+      sinon.stub(configValidator, 'validateDatafile').returns(true);
+    });
+
+    afterEach(function() {
+      projectConfig.createProjectConfig.restore();
+      configValidator.validateDatafile.restore();
+    });
+
+    it('returns a project config object created by createProjectConfig when all validation is applied and there are no errors', function() {
+      configValidator.validateDatafile.returns(true);
+      stubJsonSchemaValidator.validate.returns(true);
+      var configObj = {
+        foo: 'bar',
+        experimentKeyMap: {
+          a: { key: 'a' },
+          b: { key: 'b' },
+        }
+      };
+      projectConfig.createProjectConfig.returns(configObj);
+      var result = projectConfig.tryCreatingProjectConfig({
+        datafile: { foo: 'bar' },
+        errorHandler: stubErrorHandler,
+        jsonSchemaValidator: stubJsonSchemaValidator,
+        logger: stubLogger,
+        skipJSONValidation: false,
+      });
+      assert.deepEqual(result, configObj);
+    });
+
+    it('returns null and calls handleError when validateDatafile throws', function() {
+      configValidator.validateDatafile.throws();
+      stubJsonSchemaValidator.validate.returns(true);
+      var result = projectConfig.tryCreatingProjectConfig({
+        datafile: { foo: 'bar' },
+        errorHandler: stubErrorHandler,
+        jsonSchemaValidator: stubJsonSchemaValidator,
+        logger: stubLogger,
+        skipJSONValidation: false,
+      });
+      assert.strictEqual(result, null);
+      sinon.assert.calledOnce(stubErrorHandler.handleError);
+    });
+
+    it('returns null and calls handleError when jsonSchemaValidator.validate throws', function() {
+      configValidator.validateDatafile.returns(true);
+      stubJsonSchemaValidator.validate.throws();
+      var result = projectConfig.tryCreatingProjectConfig({
+        datafile: { foo: 'bar' },
+        errorHandler: stubErrorHandler,
+        jsonSchemaValidator: stubJsonSchemaValidator,
+        logger: stubLogger,
+        skipJSONValidation: false,
+      });
+      assert.strictEqual(result, null);
+      sinon.assert.calledOnce(stubErrorHandler.handleError);
+    });
+
+    it('returns null when jsonSchemaValidator.validate returns false', function() {
+      configValidator.validateDatafile.returns(true);
+      stubJsonSchemaValidator.validate.returns(false);
+      var result = projectConfig.tryCreatingProjectConfig({
+        datafile: { foo: 'bar' },
+        errorHandler: stubErrorHandler,
+        jsonSchemaValidator: stubJsonSchemaValidator,
+        logger: stubLogger,
+        skipJSONValidation: false,
+      });
+      assert.strictEqual(result, null);
+    });
+
+    it('does not call jsonSchemaValidator.validate when skipJSONValidation is true', function() {
+      projectConfig.tryCreatingProjectConfig({
+        datafile: { foo: 'bar' },
+        errorHandler: stubErrorHandler,
+        jsonSchemaValidator: stubJsonSchemaValidator,
+        logger: stubLogger,
+        skipJSONValidation: true,
+      });
+      sinon.assert.notCalled(stubJsonSchemaValidator.validate);
+    });
+
+    it('skips json validation when jsonSchemaValidator is not provided', function() {
+      configValidator.validateDatafile.returns(true);
+      var configObj = {
+        foo: 'bar',
+        experimentKeyMap: {
+          a: { key: 'a' },
+          b: { key: 'b' },
+        }
+      };
+      projectConfig.createProjectConfig.returns(configObj);
+      var result = projectConfig.tryCreatingProjectConfig({
+        datafile: { foo: 'bar' },
+        errorHandler: stubErrorHandler,
+        logger: stubLogger,
+      });
+      assert.deepEqual(result, configObj);
+      sinon.assert.notCalled(stubErrorHandler.handleError);
+    });
+  });
 });