Merge pull request #739 from Iterable/jwt/MOB-12298-new-improve-logger

[MOB-12298] Improve the logger

Author: lposen

src/__tests__/IterableInApp.test.ts

@@ -1,7 +1,5 @@
 import { NativeEventEmitter } from 'react-native';
 
-import { IterableLogger } from '../core';
-
 import { MockRNIterableAPI } from '../__mocks__/MockRNIterableAPI';
 
 import {
@@ -21,7 +19,6 @@ import {
 describe('Iterable In App', () => {
   beforeEach(() => {
     jest.clearAllMocks();
-    Iterable.logger = new IterableLogger(new IterableConfig());
   });
 
   test('trackInAppOpen_params_methodCalledWithParams', () => {
@@ -202,9 +199,11 @@ describe('Iterable In App', () => {
     // WHEN the simulated local queue is set to the in-app messages
     MockRNIterableAPI.setMessages(messages);
     // THEN Iterable.inAppManager.getMessages returns the list of in-app messages
-    return await Iterable.inAppManager?.getMessages().then((messagesObtained) => {
-      expect(messagesObtained).toEqual(messages);
-    });
+    return await Iterable.inAppManager
+      ?.getMessages()
+      .then((messagesObtained) => {
+        expect(messagesObtained).toEqual(messages);
+      });
   });
 
   test('showMessage_messageAndConsume_returnsClickedUrl', async () => {
@@ -222,9 +221,11 @@ describe('Iterable In App', () => {
     // WHEN the simulated clicked url is set to the clicked url
     MockRNIterableAPI.setClickedUrl(clickedUrl);
     // THEN Iterable,inAppManager.showMessage returns the simulated clicked url
-    return await Iterable.inAppManager?.showMessage(message, consume).then((url) => {
-      expect(url).toEqual(clickedUrl);
-    });
+    return await Iterable.inAppManager
+      ?.showMessage(message, consume)
+      .then((url) => {
+        expect(url).toEqual(clickedUrl);
+      });
   });
 
   test('removeMessage_params_methodCalledWithParams', () => {

src/core/classes/Iterable.test.ts

@@ -2,41 +2,32 @@ import { NativeEventEmitter, Platform } from 'react-native';
 
 import { MockLinking } from '../../__mocks__/MockLinking';
 import { MockRNIterableAPI } from '../../__mocks__/MockRNIterableAPI';
-import { IterableLogger } from '..';
 // import from the same location that consumers import from
 import {
   Iterable,
   IterableAction,
   IterableActionContext,
   IterableActionSource,
   IterableAttributionInfo,
+  IterableAuthResponse,
   IterableCommerceItem,
   IterableConfig,
   IterableDataRegion,
   IterableEventName,
-  IterableLogLevel,
-  IterableInAppMessage,
   IterableInAppCloseSource,
   IterableInAppDeleteSource,
   IterableInAppLocation,
+  IterableInAppMessage,
+  IterableInAppShowResponse,
   IterableInAppTrigger,
   IterableInAppTriggerType,
-  IterableAuthResponse,
-  IterableInAppShowResponse,
+  IterableLogLevel,
 } from '../..';
 import { TestHelper } from '../../__tests__/TestHelper';
 
-const getDefaultConfig = () => {
-  const config = new IterableConfig();
-  config.logReactNativeSdkCalls = false;
-  return config;
-};
-
 describe('Iterable', () => {
   beforeEach(() => {
     jest.clearAllMocks();
-    const config = getDefaultConfig();
-    Iterable.logger = new IterableLogger(config);
   });
 
   afterEach(() => {
@@ -265,7 +256,7 @@ describe('Iterable', () => {
       expect(config.customActionHandler).toBe(undefined);
       expect(config.inAppHandler).toBe(undefined);
       expect(config.authHandler).toBe(undefined);
-      expect(config.logLevel).toBe(IterableLogLevel.info);
+      expect(config.logLevel).toBe(IterableLogLevel.debug);
       expect(config.logReactNativeSdkCalls).toBe(true);
       expect(config.expiringAuthTokenRefreshPeriod).toBe(60.0);
       expect(config.allowedProtocols).toEqual([]);
@@ -281,7 +272,7 @@ describe('Iterable', () => {
       expect(configDict.customActionHandlerPresent).toBe(false);
       expect(configDict.inAppHandlerPresent).toBe(false);
       expect(configDict.authHandlerPresent).toBe(false);
-      expect(configDict.logLevel).toBe(IterableLogLevel.info);
+      expect(configDict.logLevel).toBe(IterableLogLevel.debug);
       expect(configDict.expiringAuthTokenRefreshPeriod).toBe(60.0);
       expect(configDict.allowedProtocols).toEqual([]);
       expect(configDict.androidSdkUseInMemoryStorageForInApps).toBe(false);

src/core/classes/Iterable.ts

@@ -42,12 +42,6 @@ const RNEventEmitter = new NativeEventEmitter(RNIterableAPI);
  */
 /* eslint-enable tsdoc/syntax */
 export class Iterable {
-  /**
-   * Logger for the Iterable SDK
-   * Log level is set with {@link IterableLogLevel}
-   */
-  static logger: IterableLogger = new IterableLogger(new IterableConfig());
-
   /**
    * Current configuration of the Iterable SDK
    */
@@ -121,9 +115,7 @@ export class Iterable {
     config: IterableConfig = new IterableConfig()
   ): Promise<boolean> {
     Iterable.savedConfig = config;
-    Iterable.logger = new IterableLogger(Iterable.savedConfig);
-
-    this.setupEventHandlers();
+    this.setupIterable(config);
 
     const version = this.getVersionFromPackageJson();
 
@@ -141,10 +133,7 @@ export class Iterable {
     config: IterableConfig = new IterableConfig(),
     apiEndPoint: string
   ): Promise<boolean> {
-    Iterable.savedConfig = config;
-    Iterable.logger = new IterableLogger(Iterable.savedConfig);
-
-    this.setupEventHandlers();
+    this.setupIterable(config);
 
     const version = this.getVersionFromPackageJson();
 
@@ -155,6 +144,22 @@ export class Iterable {
     });
   }
 
+  /**
+   * @internal
+   * Does basic setup of the Iterable SDK.
+   * @param config - The configuration object for the Iterable SDK
+   */
+  private static setupIterable(config: IterableConfig = new IterableConfig()) {
+    if (config) {
+      Iterable.savedConfig = config;
+
+      IterableLogger.setLoggingEnabled(config.logReactNativeSdkCalls ?? true);
+      IterableLogger.setLogLevel(config.logLevel);
+    }
+
+    this.setupEventHandlers();
+  }
+
   /**
    * Associate the current user with the passed in email parameter.
    *
@@ -502,7 +507,7 @@ export class Iterable {
     items: IterableCommerceItem[],
     dataFields?: unknown
   ) {
-    Iterable?.logger?.log('trackPurchase');
+    IterableLogger?.log('trackPurchase');
 
     IterableApi.trackPurchase({ total, items, dataFields });
   }
@@ -531,7 +536,7 @@ export class Iterable {
     location: IterableInAppLocation
   ) {
     if (!message?.messageId) {
-      Iterable?.logger?.log(
+      IterableLogger?.log(
         `Skipping trackInAppOpen because message ID is required, but received ${message}.`
       );
       return;
@@ -968,9 +973,7 @@ export class Iterable {
                     (promiseResult as IterableAuthResponse).failureCallback?.();
                   }
                 } else {
-                  Iterable?.logger?.log(
-                    'No callback received from native layer'
-                  );
+                  IterableLogger?.log('No callback received from native layer');
                 }
               }, 1000);
               // Use unref() to prevent the timeout from keeping the process alive
@@ -979,12 +982,12 @@ export class Iterable {
               //If promise only returns string
               Iterable.authManager.passAlongAuthToken(promiseResult as string);
             } else {
-              Iterable?.logger?.log(
+              IterableLogger?.log(
                 'Unexpected promise returned. Auth token expects promise of String or AuthResponse type.'
               );
             }
           })
-          .catch((e) => Iterable?.logger?.log(e));
+          .catch((e) => IterableLogger?.log(e));
       });
 
       RNEventEmitter.addListener(
@@ -1018,7 +1021,7 @@ export class Iterable {
             }
           })
           .catch((reason) => {
-            Iterable?.logger?.log('could not open url: ' + reason);
+            IterableLogger?.log('could not open url: ' + reason);
           });
       }
     }