feat: Convert logger module to TS (#658)

yavorona · web-flow · commit d9f8e245fb84 · 2021-04-26T10:13:40.000-07:00
* Convert to TS

* Address comments

* Remove empty function

* Import single instead of * in tests

* Update year

* Clean up
diff --git a/packages/optimizely-sdk/lib/core/bucketer/index.tests.js b/packages/optimizely-sdk/lib/core/bucketer/index.tests.js
@@ -24,7 +24,7 @@ import {
   LOG_MESSAGES,
   LOG_LEVEL,
 } from '../../utils/enums';
-import logger from '../../plugins/logger';
+import { createLogger } from '../../plugins/logger';
 import projectConfig from '../project_config';
 import { getTestProjectConfig } from '../../tests/test_data';
 
@@ -34,7 +34,7 @@ describe('lib/core/bucketer', function() {
   describe('APIs', function() {
     describe('bucket', function() {
       var configObj;
-      var createdLogger = logger.createLogger({ logLevel: LOG_LEVEL.INFO });
+      var createdLogger = createLogger({ logLevel: LOG_LEVEL.INFO });
       var bucketerParams;
 
       beforeEach(function() {
@@ -360,7 +360,7 @@ describe('lib/core/bucketer', function() {
 
     describe('testBucketWithBucketingId', function() {
       var bucketerParams;
-      var createdLogger = logger.createLogger({
+      var createdLogger = createLogger({
         logLevel: LOG_LEVEL.INFO,
         logToConsole: false,
       });
diff --git a/packages/optimizely-sdk/lib/core/decision_service/index.tests.js b/packages/optimizely-sdk/lib/core/decision_service/index.tests.js
@@ -24,7 +24,7 @@ import {
   LOG_LEVEL,
   DECISION_SOURCES,
 } from '../../utils/enums';
-import logger from '../../plugins/logger';
+import { createLogger }  from '../../plugins/logger';
 import Optimizely from '../../optimizely';
 import projectConfig from '../project_config';
 import AudienceEvaluator from '../audience_evaluator';
@@ -43,7 +43,7 @@ describe('lib/core/decision_service', function() {
   describe('APIs', function() {
     var configObj = projectConfig.createProjectConfig(cloneDeep(testData));
     var decisionServiceInstance;
-    var mockLogger = logger.createLogger({ logLevel: LOG_LEVEL.INFO });
+    var mockLogger = createLogger({ logLevel: LOG_LEVEL.INFO });
     var bucketerStub;
 
     beforeEach(function() {
@@ -946,7 +946,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(cloneDeep(testData));
-    var createdLogger = logger.createLogger({
+    var createdLogger = createLogger({
       logLevel: LOG_LEVEL.DEBUG,
       logToConsole: false,
     });
@@ -1064,7 +1064,7 @@ describe('lib/core/decision_service', function() {
   describe('_getBucketingId', function() {
     var configObj;
     var decisionService;
-    var mockLogger = logger.createLogger({ logLevel: LOG_LEVEL.INFO });
+    var mockLogger = createLogger({ logLevel: LOG_LEVEL.INFO });
     var userId = 'testUser1';
     var userAttributesWithBucketingId = {
       browser_type: 'firefox',
@@ -1113,7 +1113,7 @@ describe('lib/core/decision_service', function() {
       var configObj;
       var decisionServiceInstance;
       var sandbox;
-      var mockLogger = logger.createLogger({ logLevel: LOG_LEVEL.INFO });
+      var mockLogger = createLogger({ logLevel: LOG_LEVEL.INFO });
       var fakeDecisionResponseWithArgs;
       var fakeDecisionResponse = {
         result: null,
@@ -2105,7 +2105,7 @@ describe('lib/core/decision_service', function() {
         configObj = projectConfig.createProjectConfig(cloneDeep(testDataWithFeatures));
         feature = configObj.featureKeyMap.test_feature;
         decisionService = DecisionService.createDecisionService({
-          logger: logger.createLogger({ logLevel: LOG_LEVEL.INFO }),
+          logger: createLogger({ logLevel: LOG_LEVEL.INFO }),
         });
         __buildBucketerParamsSpy = sinon.spy(decisionService, '__buildBucketerParams');
       });
diff --git a/packages/optimizely-sdk/lib/core/notification_center/index.tests.js b/packages/optimizely-sdk/lib/core/notification_center/index.tests.js
@@ -18,14 +18,14 @@ import { assert } from 'chai';
 
 import { createNotificationCenter } from './';
 import * as enums from '../../utils/enums';
-import logger from '../../plugins/logger';
+import { createLogger } from '../../plugins/logger';
 import errorHandler from '../../plugins/error_handler';
 
 var LOG_LEVEL = enums.LOG_LEVEL;
 
 describe('lib/core/notification_center', function() {
   describe('APIs', function() {
-    var mockLogger = logger.createLogger({ logLevel: LOG_LEVEL.INFO });
+    var mockLogger = createLogger({ logLevel: LOG_LEVEL.INFO });
     var mockErrorHandler = errorHandler.handleError;
     var mockLoggerStub;
     var mockErrorHandlerStub;
diff --git a/packages/optimizely-sdk/lib/core/project_config/index.tests.js b/packages/optimizely-sdk/lib/core/project_config/index.tests.js
@@ -26,7 +26,7 @@ import {
   FEATURE_VARIABLE_TYPES,
   LOG_LEVEL,
 } from '../../utils/enums';
-import loggerPlugin from '../../plugins/logger';
+import * as loggerPlugin from '../../plugins/logger';
 import testDatafile from '../../tests/test_data';
 import configValidator from '../../utils/config_validator';
 
diff --git a/packages/optimizely-sdk/lib/index.browser.ts b/packages/optimizely-sdk/lib/index.browser.ts
@@ -26,7 +26,7 @@ import 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';
-import loggerPlugin from './plugins/logger';
+import * as loggerPlugin from './plugins/logger';
 import Optimizely from './optimizely';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 import { SDKOptions, OptimizelyDecideOption } from './shared_types';
diff --git a/packages/optimizely-sdk/lib/index.browser.umdtests.js b/packages/optimizely-sdk/lib/index.browser.umdtests.js
@@ -18,7 +18,7 @@ import sinon from 'sinon';
 
 import configValidator from './utils/config_validator';
 import * as enums from './utils/enums';
-import logger from './plugins/logger';
+import * as logger from './plugins/logger';
 import Optimizely from './optimizely';
 import testData from './tests/test_data';
 import packageJSON from '../package.json';
diff --git a/packages/optimizely-sdk/lib/index.node.tests.js b/packages/optimizely-sdk/lib/index.node.tests.js
@@ -20,7 +20,7 @@ import eventProcessor from './core/event_processor';
 import * as enums from './utils/enums';
 import Optimizely from './optimizely';
 import testData from './tests/test_data';
-import loggerPlugin from './plugins/logger';
+import * as loggerPlugin from './plugins/logger';
 import optimizelyFactory from './index.node';
 import configValidator from './utils/config_validator';
 
diff --git a/packages/optimizely-sdk/lib/index.node.ts b/packages/optimizely-sdk/lib/index.node.ts
@@ -23,7 +23,7 @@ import {
 } from '@optimizely/js-sdk-logging';
 import Optimizely from './optimizely';
 import * as enums from './utils/enums';
-import loggerPlugin from './plugins/logger';
+import * as loggerPlugin from './plugins/logger';
 import configValidator from './utils/config_validator';
 import defaultErrorHandler from './plugins/error_handler';
 import defaultEventDispatcher from './plugins/event_dispatcher/index.node';
diff --git a/packages/optimizely-sdk/lib/index.react_native.ts b/packages/optimizely-sdk/lib/index.react_native.ts
@@ -25,7 +25,7 @@ import * as enums from './utils/enums';
 import Optimizely from './optimizely';
 import configValidator from './utils/config_validator';
 import defaultErrorHandler from './plugins/error_handler';
-import loggerPlugin from './plugins/logger/index.react_native';
+import * as loggerPlugin from './plugins/logger/index.react_native';
 import defaultEventDispatcher from './plugins/event_dispatcher/index.browser';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 import { SDKOptions, OptimizelyDecideOption } from './shared_types';
diff --git a/packages/optimizely-sdk/lib/optimizely/index.tests.js b/packages/optimizely-sdk/lib/optimizely/index.tests.js
@@ -30,7 +30,7 @@ import * as enums from '../utils/enums';
 import eventDispatcher from '../plugins/event_dispatcher/index.node';
 import errorHandler from '../plugins/error_handler';
 import fns from '../utils/fns';
-import logger from '../plugins/logger';
+import * as logger from '../plugins/logger';
 import * as decisionService from '../core/decision_service';
 import * as jsonSchemaValidator from '../utils/json_schema_validator';
 import * as projectConfig from '../core/project_config';
diff --git a/packages/optimizely-sdk/lib/plugins/logger/enums.js b/packages/optimizely-sdk/lib/plugins/logger/enums.js
diff --git a/packages/optimizely-sdk/lib/plugins/logger/index.react_native.ts b/packages/optimizely-sdk/lib/plugins/logger/index.react_native.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2019-2020, Optimizely
+ * Copyright 2019-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,9 @@
  */
 import { LogLevel } from '@optimizely/js-sdk-logging';
 import { sprintf } from '@optimizely/js-sdk-utils';
+import { NoOpLogger } from './index';
 
-function getLogLevelName(level) {
+function getLogLevelName(level: number): string {
   switch (level) {
     case LogLevel.INFO:
       return 'INFO';
@@ -31,38 +32,29 @@ function getLogLevelName(level) {
   }
 }
 
-function ReactNativeLogger() {}
-
-ReactNativeLogger.prototype.log = function(level, message) {
-  var formattedMessage = sprintf('[OPTIMIZELY] - %s %s %s', getLogLevelName(level), new Date().toISOString(), message);
-  switch (level) {
-    case LogLevel.INFO:
-      console.info(formattedMessage);
-      break;
-    case LogLevel.ERROR:
-    case LogLevel.WARNING:
-      console.warn(formattedMessage);
-      break;
-    case LogLevel.DEBUG:
-    case LogLevel.NOTSET:
-      console.log(formattedMessage);
-      break;
+class ReactNativeLogger {
+  log(level: number, message: string): void {
+    const formattedMessage = sprintf('[OPTIMIZELY] - %s %s %s', getLogLevelName(level), new Date().toISOString(), message);
+    switch (level) {
+      case LogLevel.INFO:
+        console.info(formattedMessage);
+        break;
+      case LogLevel.ERROR:
+      case LogLevel.WARNING:
+        console.warn(formattedMessage);
+        break;
+      case LogLevel.DEBUG:
+      case LogLevel.NOTSET:
+        console.log(formattedMessage);
+        break;
+    }
   }
-};
-
-function NoOpLogger() {}
-
-NoOpLogger.prototype.log = function() {};
+}
 
-export var createLogger = function() {
+export function createLogger(): ReactNativeLogger {
   return new ReactNativeLogger();
 }
 
-export var createNoOpLogger = function() {
+export function createNoOpLogger(): NoOpLogger {
   return new NoOpLogger();
 }
-
-export default {
-  createLogger,
-  createNoOpLogger,
-};
diff --git a/packages/optimizely-sdk/lib/plugins/logger/index.ts b/packages/optimizely-sdk/lib/plugins/logger/index.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2017, 2020, Optimizely
+ * Copyright 2016-2017, 2020-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,21 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ConsoleLogHandler } from '@optimizely/js-sdk-logging';
+import { ConsoleLogHandler, LogLevel } from '@optimizely/js-sdk-logging';
 
-function NoOpLogger() {}
+type ConsoleLogHandlerConfig = {
+  logLevel?: LogLevel | string;
+  logToConsole?: boolean;
+  prefix?: string;
+}
 
-NoOpLogger.prototype.log = function() {};
+export class NoOpLogger {
+  log(): void { }
+}
 
-export var createLogger = function(opts) {
+export function createLogger(opts?: ConsoleLogHandlerConfig): ConsoleLogHandler {  
   return new ConsoleLogHandler(opts);
-};
+}
 
-export var createNoOpLogger = function() {
+export function createNoOpLogger(): NoOpLogger {
   return new NoOpLogger();
-};
-
-export default {
-  createLogger,
-  createNoOpLogger,
-};
+}
