feat: Convert config_validator to TS (#556)

* Convert config_validator to TS

* Import whole config_validator module

* Try to Remove stubbing of configValidate

* Change to default export object

* Change  export functions as const

Author: yavorona

packages/optimizely-sdk/lib/index.browser.js

@@ -24,7 +24,7 @@ import {
 import { LocalStoragePendingEventsDispatcher } from '@optimizely/js-sdk-event-processor';
 
 import { assign } from './utils/fns';
-import configValidator from './utils/config_validator';
+import * as configValidator from './utils/config_validator';
 import defaultErrorHandler from './plugins/error_handler';
 import defaultEventDispatcher from './plugins/event_dispatcher/index.browser';
 import * as enums from './utils/enums';

packages/optimizely-sdk/lib/utils/config_validator/index.js renamed to packages/optimizely-sdk/lib/utils/config_validator/index.ts

@@ -20,68 +20,67 @@ import {
   DATAFILE_VERSIONS,
 } from '../enums';
 
-var MODULE_NAME = 'CONFIG_VALIDATOR';
-var SUPPORTED_VERSIONS = [DATAFILE_VERSIONS.V2, DATAFILE_VERSIONS.V3, DATAFILE_VERSIONS.V4];
+const MODULE_NAME = 'CONFIG_VALIDATOR';
+const SUPPORTED_VERSIONS = [DATAFILE_VERSIONS.V2, DATAFILE_VERSIONS.V3, DATAFILE_VERSIONS.V4];
 
 /**
  * Validates the given config options
- * @param  {Object} config
- * @param  {Object} config.errorHandler
- * @param  {Object} config.eventDispatcher
- * @param  {Object} config.logger
- * @return {Boolean} True if the config options are valid
+ * @param  {unknown} config
+ * @param  {object}  config.errorHandler
+ * @param  {object}  config.eventDispatcher
+ * @param  {object}  config.logger
+ * @return {boolean} true if the config options are valid
  * @throws If any of the config options are not valid
  */
-export var validate = function(config) {
-  if (config.errorHandler && typeof config.errorHandler.handleError !== 'function') {
-    throw new Error(sprintf(ERROR_MESSAGES.INVALID_ERROR_HANDLER, MODULE_NAME));
-  }
-
-  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));
+export const validate = function(config: unknown): boolean {
+  if (typeof config === 'object' && config !== null) {
+    if (config['errorHandler'] && typeof config['errorHandler'].handleError !== 'function') {
+      throw new Error(sprintf(ERROR_MESSAGES.INVALID_ERROR_HANDLER, MODULE_NAME));
+    }
+    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));
+    }
+    return true;
   }
-
-  return true;
-};
+  throw new Error(sprintf(ERROR_MESSAGES.INVALID_CONFIG, MODULE_NAME));
+}
 
 /**
  * Validates the datafile
  * @param {string}  datafile
- * @return {Boolean} True if the datafile is valid
+ * @return {boolean} true if the datafile is valid
  * @throws If the datafile is not valid for any of the following reasons:
  - The datafile string is undefined
  - The datafile string cannot be parsed as a JSON object
  - The datafile version is not supported
  */
-export var validateDatafile = function(datafile) {
+export const validateDatafile = function(datafile: unknown): boolean {
   if (!datafile) {
     throw new Error(sprintf(ERROR_MESSAGES.NO_DATAFILE_SPECIFIED, MODULE_NAME));
   }
-
-  if (typeof datafile === 'string' || datafile instanceof String) {
+  if (typeof datafile === 'string') {
     // Attempt to parse the datafile string
     try {
       datafile = JSON.parse(datafile);
     } catch (ex) {
       throw new Error(sprintf(ERROR_MESSAGES.INVALID_DATAFILE_MALFORMED, MODULE_NAME));
     }
   }
-
-  if (SUPPORTED_VERSIONS.indexOf(datafile.version) === -1) {
-    throw new Error(sprintf(ERROR_MESSAGES.INVALID_DATAFILE_VERSION, MODULE_NAME, datafile.version));
+  if (typeof datafile === 'object' && !Array.isArray(datafile) && datafile !== null) {
+    if (SUPPORTED_VERSIONS.indexOf(datafile['version']) === -1) {
+      throw new Error(sprintf(ERROR_MESSAGES.INVALID_DATAFILE_VERSION, MODULE_NAME, datafile['version']));
+    }
   }
-
   return true;
-};
+}
 
 /**
  * Provides utility methods for validating that the configuration options are valid
  */
 export default {
   validate: validate,
   validateDatafile: validateDatafile,
-};
+}

packages/optimizely-sdk/lib/utils/enums/index.ts

@@ -37,6 +37,7 @@ export const ERROR_MESSAGES = {
   INVALID_BUCKETING_ID: '%s: Unable to generate hash for bucketing ID %s: %s',
   INVALID_DATAFILE: '%s: Datafile is invalid - property %s: %s',
   INVALID_DATAFILE_MALFORMED: '%s: Datafile is invalid because it is malformed.',
+  INVALID_CONFIG: '%s: Provided Optimizely config is in an invalid format.',
   INVALID_JSON: '%s: JSON object is not valid.',
   INVALID_ERROR_HANDLER: '%s: Provided "errorHandler" is in an invalid format.',
   INVALID_EVENT_DISPATCHER: '%s: Provided "eventDispatcher" is in an invalid format.',