build: Introduce TypeScript into optimizely-sdk build (#504)

Summary:

Add TypeScript into the build for optimizely-sdk. The goal is to enable future development with TS and incremental conversion of modules from JS to TS.

- Uses the same TS version as subpackages (datafile-manager, event-processor, etc.)
- Uses rollup-plugin-typescript2 to add TS compilation step to rollup build
- tsconfig.json for optimizely-sdk is based on the share root tsconfig.json, with appropriate overrides
- Lint implementation is updated for TS compatibility, based on React SDK's
- Mocha test suite is updated for TS compatibility: types installed, command updated to use ts-node, based on official - Mocha TS example
- Configuration for Karma-based tests is updated to use ts-loader
- Converted string_value_validator and several other smaller modules as examples and litmus tests of the build changes

Test plan:

Manual testing using local build and linked Node app
Existing tests must pass - there are no intended functional changes
Inspected and compared build output from master branch, and this branch

Co-authored-by: Polina Nguen <[email protected]>

Author: mjc1283

packages/optimizely-sdk/.eslintrc.js

@@ -4,7 +4,10 @@ module.exports = {
     commonjs: true,
     node: true,
   },
-  extends: 'eslint:recommended',
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
   globals: {
     Atomics: 'readonly',
     SharedArrayBuffer: 'readonly',
@@ -14,7 +17,18 @@ module.exports = {
     ecmaVersion: 6,
     sourceType: 'module',
   },
+  overrides: [
+    {
+      'files': ['*.ts'],
+      'rules': {
+        '@typescript-eslint/explicit-module-boundary-types': ['error']
+      }
+    }
+  ],
   rules: {
     'no-prototype-builtins': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    'no-shadow': 'error',
   },
 };

packages/optimizely-sdk/karma.base.conf.js

@@ -24,6 +24,18 @@ module.exports = {
 
   webpack: {
     mode: 'production',
+    module: {
+      rules: [
+        {
+          test: /\.[tj]s$/,
+          use: 'ts-loader',
+          exclude: /node_modules/,
+        },
+      ],
+    },
+    resolve: {
+      extensions: ['.ts', '.js'],
+    },
   },
 
   //browserStack setup

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

@@ -20,7 +20,7 @@ import enums from '../../utils/enums';
 import fns from '../../utils/fns';
 import projectConfig from '../project_config';
 import AudienceEvaluator from '../audience_evaluator';
-import stringValidator from '../../utils/string_value_validator';
+import * as stringValidator from '../../utils/string_value_validator';
 
 var MODULE_NAME = 'DECISION_SERVICE';
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;

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

@@ -32,7 +32,7 @@ import AudienceEvaluator from '../audience_evaluator';
 import errorHandler from '../../plugins/error_handler';
 import eventBuilder from '../../core/event_builder/index.js';
 import eventDispatcher from '../../plugins/event_dispatcher/index.node';
-import jsonSchemaValidator from '../../utils/json_schema_validator';
+import * as jsonSchemaValidator from '../../utils/json_schema_validator';
 import {
   getTestProjectConfig,
   getTestProjectConfigWithFeatures,

packages/optimizely-sdk/lib/core/event_builder/event_helpers.js

@@ -17,8 +17,8 @@ import { getLogger } from '@optimizely/js-sdk-logging';
 
 import fns from '../../utils/fns';
 import projectConfig from '../project_config';
-import eventTagUtils from '../../utils/event_tag_utils';
-import attributesValidator from'../../utils/attributes_validator';
+import * as eventTagUtils from '../../utils/event_tag_utils';
+import * as attributesValidator from'../../utils/attributes_validator';
 
 var logger = getLogger('EVENT_BUILDER');
 
@@ -106,6 +106,14 @@ export var buildConversionEvent = function(config) {
   var eventTags = config.eventTags;
   var eventId = projectConfig.getEventId(configObj, eventKey);
 
+  let revenue = null;
+  let eventValue = null;
+
+  if (eventTags) {
+    revenue = eventTagUtils.getRevenueValue(eventTags, logger);
+    eventValue = eventTagUtils.getEventValue(eventTags, logger);
+  }
+
   return {
     type: 'conversion',
     timestamp: fns.currentTimestamp(),
@@ -131,8 +139,8 @@ export var buildConversionEvent = function(config) {
       key: eventKey,
     },
 
-    revenue: eventTagUtils.getRevenueValue(eventTags, logger),
-    value: eventTagUtils.getEventValue(eventTags, logger),
+    revenue: revenue,
+    value: eventValue,
     tags: eventTags,
   };
 };

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

@@ -16,8 +16,8 @@
 import fns from '../../utils/fns';
 import enums from '../../utils/enums';
 import projectConfig from '../project_config';
-import eventTagUtils from '../../utils/event_tag_utils';
-import attributeValidator from '../../utils/attributes_validator';
+import * as eventTagUtils from '../../utils/event_tag_utils';
+import * as attributeValidator from '../../utils/attributes_validator';
 
 var ACTIVATE_EVENT_KEY = 'campaign_activated';
 var CUSTOM_ATTRIBUTE_FEATURE_TYPE = 'custom';

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

@@ -25,7 +25,7 @@ import { ERROR_MESSAGES, LOG_MESSAGES } from '../../utils/enums';
 import testData from '../../tests/test_data';
 import * as optimizelyConfig from '../optimizely_config/index';
 import projectConfigManager from './project_config_manager';
-import jsonSchemaValidator from '../../utils/json_schema_validator';
+import * as jsonSchemaValidator from '../../utils/json_schema_validator';
 
 describe('lib/core/project_config/project_config_manager', function() {
   var globalStubErrorHandler;

packages/optimizely-sdk/lib/core/project_config/project_config_schema.js renamed to packages/optimizely-sdk/lib/core/project_config/project_config_schema.ts

@@ -17,7 +17,9 @@
 /**
  * Project Config JSON Schema file used to validate the project json datafile
  */
-export var schema = {
+ import { JSONSchema4 } from 'json-schema';
+
+ var schemaDefinition = {
   $schema: 'http://json-schema.org/draft-04/schema#',
   type: 'object',
   properties: {
@@ -276,4 +278,6 @@ export var schema = {
   },
 };
 
-export default schema;
+const schema = schemaDefinition as JSONSchema4
+
+export default schema

packages/optimizely-sdk/lib/index.d.ts

@@ -39,6 +39,8 @@ declare module '@optimizely/optimizely-sdk' {
 
   // The options object given to Optimizely.createInstance.
   export interface Config {
+    // TODO[OASIS-6649]: Don't use object type
+    // eslint-disable-next-line  @typescript-eslint/ban-types
     datafile?: object | string;
     datafileOptions?: DatafileOptions;
     errorHandler?: ErrorHandler;
@@ -50,6 +52,8 @@ declare module '@optimizely/optimizely-sdk' {
       | enums.LOG_LEVEL.INFO
       | enums.LOG_LEVEL.NOTSET
       | enums.LOG_LEVEL.WARNING;
+    // TODO[OASIS-6649]: Don't use object type
+    // eslint-disable-next-line  @typescript-eslint/ban-types
     jsonSchemaValidator?: object;
     userProfileService?: UserProfileService | null;
     eventBatchSize?: number;
@@ -115,6 +119,8 @@ declare module '@optimizely/optimizely-sdk' {
     // HTTP method with which to send the event.
     httpVerb: 'POST';
     // Value to send in the request body, JSON-serialized.
+    // TODO[OASIS-6649]: Don't use any type
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     params: any;
   }
 
@@ -159,6 +165,8 @@ declare module '@optimizely/optimizely-sdk' {
   }
 
   export type UserAttributes = {
+    // TODO[OASIS-6649]: Don't use any type
+    // eslint-disable-next-line  @typescript-eslint/no-explicit-any
     [name: string]: any;
   };
 
@@ -183,6 +191,8 @@ declare module '@optimizely/optimizely-sdk' {
       endOfRange: number;
     }>;
     audienceIds: string[];
+    // TODO[OASIS-6649]: Don't use object type
+    // eslint-disable-next-line  @typescript-eslint/ban-types
     forcedVariations: object;
   }
 

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

@@ -22,11 +22,11 @@ import decisionService from '../core/decision_service';
 import enums from '../utils/enums';
 import { getImpressionEvent, getConversionEvent } from '../core/event_builder/index.js';
 import { buildConversionEvent, buildImpressionEvent } from '../core/event_builder/event_helpers';
-import eventTagsValidator from '../utils/event_tags_validator';
+import * as eventTagsValidator from '../utils/event_tags_validator';
 import notificationCenter from '../core/notification_center';
 import projectConfig from '../core/project_config';
-import userProfileServiceValidator from '../utils/user_profile_service_validator';
-import stringValidator from '../utils/string_value_validator';
+import * as userProfileServiceValidator from '../utils/user_profile_service_validator';
+import * as stringValidator from '../utils/string_value_validator';
 import projectConfigManager from '../core/project_config/project_config_manager';
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;