Merge pull request #271 from SuperViz/chore/logger-config

chore(debug-config): remove default logger and implement logger by namespace

src/common/utils/index.ts

@@ -1,5 +1,5 @@
 import doRequest from './do-request';
-import logger from './logger';
+import { Logger } from './logger';
 import { Observer } from './observer';
 
-export { logger, doRequest, Observer };
+export { Logger, doRequest, Observer };

src/common/utils/logger.test.ts

@@ -1,43 +1,33 @@
 import debug from 'debug';
 
-import { Debug } from './logger';
+import { Logger } from './logger';
 
 jest.mock('debug');
 
-describe('Debug', () => {
-  let debugInstance: Debug;
+describe('Logger', () => {
+  let debugInstance: Logger;
   let mockDebug: jest.MockedFunction<debug.Debugger>;
 
   beforeEach(() => {
     mockDebug = jest.fn() as unknown as jest.MockedFunction<debug.Debugger>;
     (debug as jest.MockedFunction<typeof debug>).mockReturnValue(mockDebug);
-    debugInstance = new Debug('@superviz/sdk');
+    debugInstance = new Logger('@superviz/sdk');
   });
 
   afterEach(() => {
     jest.restoreAllMocks();
   });
 
-  it('should create a new instance of Debug', () => {
+  test('should create a new instance of Debug', () => {
     expect(debugInstance).toBeDefined();
   });
 
-  it('should call debug with the correct scope on initialization', () => {
+  test('should call debug with the correct scope on initialization', () => {
     expect(debug).toHaveBeenCalledWith('@superviz/sdk');
   });
 
-  it('should call debug with the correct arguments on log', () => {
+  test('should call debug with the correct arguments on log', () => {
     debugInstance.log('test-message', 123, { foo: 'bar' });
     expect(mockDebug).toHaveBeenCalledWith('test-message', 123, { foo: 'bar' });
   });
-
-  it('should call debug.enable with the correct prefix on enable', () => {
-    debugInstance.enable('test-prefix');
-    expect(debug.enable).toHaveBeenCalledWith('test-prefix');
-  });
-
-  it('should call debug.disable on disable', () => {
-    debugInstance.disable();
-    expect(debug.disable).toHaveBeenCalled();
-  });
 });

src/common/utils/logger.ts

@@ -2,25 +2,14 @@ import debug from 'debug';
 
 export type Message = string | Error | number | Object;
 
-export class Debug {
+export class Logger {
   private debug: debug.Debugger;
 
   constructor(scope: string) {
-    this.disable();
     this.debug = debug(scope);
   }
 
   log(formatter: Message, ...args: Array<Message>) {
     this.debug(formatter, ...args);
   }
-
-  enable(prefix: string = '*') {
-    debug.enable(prefix);
-  }
-
-  disable() {
-    debug.disable();
-  }
 }
-
-export default new Debug('@superviz/sdk');

src/common/utils/observer.ts

@@ -1,21 +1,21 @@
 import throttle from 'lodash/throttle';
 
-import { Debug } from './logger';
+import { Logger } from './logger';
 
 export type OberverOptions = {
   throttleTime?: number;
-  logger?: Debug;
+  logger?: Logger;
 };
 
 export class Observer {
-  private logger: Debug;
+  private logger: Logger;
   private callbacks: Function[];
   private throttle: number;
 
   constructor(options: OberverOptions = {}) {
     const { logger, throttleTime } = options;
 
-    this.logger = logger ?? new Debug('@superviz/sdk/observer-helper');
+    this.logger = logger ?? new Logger('@superviz/sdk/observer-helper');
     this.throttle = throttleTime;
     this.callbacks = [];
 

src/index.test.ts

@@ -1,4 +1,5 @@
-import { logger } from './common/utils';
+import debug from 'debug';
+
 import ApiService from './services/api';
 import RemoteConfigService from './services/remote-config-service';
 import { ColorsVariables } from './services/video-conference-manager/types';
@@ -71,14 +72,6 @@ const COLOR_VARIABLES_MOCK = {
   'sv-gray-200': '57 54 62',
 };
 
-jest.mock('./common/utils', () => ({
-  __esModule: true,
-  logger: {
-    enable: jest.fn(),
-    disable: jest.fn(),
-    log: jest.fn(),
-  },
-}));
 jest.mock('./services/api');
 jest.mock('./services/auth-service', () => ({
   __esModule: true,
@@ -258,12 +251,14 @@ describe('initialization success', () => {
   });
 
   test('should initialize with debug mode', async () => {
+    debug.enable = jest.fn();
+
     const instance = await sdk.init(UNIT_TEST_API_KEY, {
       ...SIMPLE_INITIALIZATION_MOCK,
       debug: true,
     });
 
-    expect(logger.enable).toBeCalled();
+    expect(debug.enable).toBeCalled();
     expect(instance).toBeDefined();
     expect(instance).toBe(COMMUNICATOR_INSTANCE_MOCK);
   });

src/index.ts

@@ -1,3 +1,5 @@
+import debug from 'debug';
+
 import {
   MeetingEvent,
   RealtimeEvent,
@@ -8,7 +10,6 @@ import {
 } from './common/types/events.types';
 import { Participant, Group, Avatar, ParticipantType } from './common/types/participant.types';
 import { SuperVizSdkOptions, DevicesOptions } from './common/types/sdk-options.types';
-import { logger } from './common/utils';
 import ApiService from './services/api';
 import AuthService from './services/auth-service';
 import { BrowserService } from './services/browser';
@@ -98,7 +99,9 @@ const init = async (apiKey: string, options: SuperVizSdkOptions): Promise<SuperV
   validateOptions(options);
 
   if (options.debug) {
-    logger.enable('@superviz/*');
+    debug.enable('*');
+  } else {
+    debug.disable();
   }
 
   const { apiUrl, conferenceLayerUrl } = await RemoteConfigService.getRemoteConfig(
@@ -120,12 +123,14 @@ const init = async (apiKey: string, options: SuperVizSdkOptions): Promise<SuperV
 
   const { ablyKey } = environment;
   return Communicator(
-    Object.assign({}, options, { apiKey,
+    Object.assign({}, options, {
+      apiKey,
       ablyKey,
       conferenceLayerUrl,
       apiUrl,
       waterMark,
-      layoutPosition }),
+      layoutPosition,
+    }),
   );
 };
 

src/services/communicator/index.ts

@@ -12,7 +12,7 @@ import {
   TranscriptionEvent,
 } from '../../common/types/events.types';
 import { Participant, Group } from '../../common/types/participant.types';
-import { Observer, logger } from '../../common/utils';
+import { Observer, Logger } from '../../common/utils';
 import { BrowserService } from '../browser';
 import { ConnectionService } from '../connection-status';
 import { IntegrationManager } from '../integration';
@@ -26,6 +26,7 @@ import { VideoFrameState, VideoManagerOptions } from '../video-conference-manage
 import { SuperVizSdk, CommunicatorOptions, PluginOptions, ParticipandToFrame } from './types';
 
 class Communicator {
+  private readonly logger: Logger;
   private readonly realtime: AblyRealtimeService;
   private readonly connectionService: ConnectionService;
   private readonly browserService: BrowserService;
@@ -74,6 +75,7 @@ class Communicator {
     this.group = group;
     this.participant = participant;
 
+    this.logger = new Logger('@superviz/sdk/communicator');
     this.realtime = new AblyRealtimeService(apiUrl, ablyKey);
     this.browserService = new BrowserService();
 
@@ -234,7 +236,7 @@ class Communicator {
    */
   public subscribe = (type: string, listener: Function): void => {
     if (!this.observers[type]) {
-      this.observers[type] = new Observer({ logger });
+      this.observers[type] = new Observer({ logger: this.logger });
     }
 
     this.observers[type].subscribe(listener);
@@ -670,7 +672,7 @@ class Communicator {
    * @returns {void}
    */
   private onMeetingStateUpdate = (newState: MeetingState): void => {
-    logger.log('MEETING STATE', newState);
+    this.logger.log('MEETING STATE', newState);
     this.publish(MeetingEvent.MEETING_STATE_UPDATE, newState);
   };
 

src/services/connection-status/index.ts

@@ -1,16 +1,20 @@
 import { MeetingConnectionStatus } from '../../common/types/events.types';
-import { Observer, logger } from '../../common/utils';
+import { Logger, Observer } from '../../common/utils';
 
 import { DefaultConnectionService, WindowConnectionStatus } from './types';
 
 export class ConnectionService implements DefaultConnectionService {
-  connectionStatus: MeetingConnectionStatus;
-  oldConnectionStatus: MeetingConnectionStatus;
+  private readonly logger: Logger;
 
-  connectionStatusObserver = new Observer({ logger });
+  public connectionStatus: MeetingConnectionStatus;
+  public oldConnectionStatus: MeetingConnectionStatus;
+  public connectionStatusObserver: Observer;
 
   constructor() {
+    this.logger = new Logger('@superviz/sdk/connection-service');
+
     this.connectionStatus = MeetingConnectionStatus.NOT_AVAILABLE;
+    this.connectionStatusObserver = new Observer({ logger: this.logger });
   }
 
   /**
@@ -44,7 +48,7 @@ export class ConnectionService implements DefaultConnectionService {
     this.connectionStatus = newStatus;
     this.connectionStatusObserver.publish(newStatus);
 
-    logger.log('CONNECTION STATUS CHANGE', newStatus);
+    this.logger.log('CONNECTION STATUS CHANGE', newStatus);
   };
 
   /**

src/services/message-bridge/index.test.ts

@@ -1,5 +1,5 @@
 import { MOCK_OBSERVER_HELPER } from '../../../__mocks__/observer-helper.mock';
-import { Debug } from '../../common/utils/logger';
+import { Logger } from '../../common/utils/logger';
 
 import { MessageBridge } from '.';
 
@@ -15,7 +15,7 @@ describe('MessageBridge', () => {
 
     MessageBridgeInstance = new MessageBridge({
       contentWindow: window,
-      logger: new Debug('@superviz/message-bridge'),
+      logger: new Logger('@superviz/message-bridge'),
       sourceBlockList: ['https://google.com'],
     });
   });
@@ -163,7 +163,7 @@ describe('MessageBridge', () => {
     expect(() => {
       const instance = new MessageBridge({
         contentWindow: window,
-        logger: new Debug('@superviz/message-bridge'),
+        logger: new Logger('@superviz/message-bridge'),
       });
     }).toThrowError();
   });

src/services/message-bridge/index.ts

@@ -1,10 +1,10 @@
 import { Observer } from '../../common/utils';
-import { Debug } from '../../common/utils/logger';
+import { Logger } from '../../common/utils/logger';
 
 import { Message, MessageBridgeOptions } from './types';
 
 export class MessageBridge {
-  private logger: Debug;
+  private logger: Logger;
   private allowedOrigins: string;
   private contentWindow: Window;
   private domains: Array<string>;

src/services/message-bridge/types.ts

@@ -4,11 +4,11 @@ import {
   MeetingEvent,
   RealtimeEvent,
 } from '../../common/types/events.types';
-import { Debug } from '../../common/utils/logger';
+import { Logger } from '../../common/utils/logger';
 
 export interface MessageBridgeOptions {
   contentWindow: Window;
-  logger: Debug;
+  logger: Logger;
   domains?: Array<string>;
   allowedOrigins?: string;
   sourceBlockList?: Array<string>;