fix(FEC-10524): get logger from playkit and set to ui and provider (#360

)

Issue: we bundling a few js-logger on Kaltura player.
Solution: get logger from playkit and set it to UI and provider.

package.json

@@ -57,7 +57,6 @@
     "@playkit-js/playkit-js-hls": "1.21.1",
     "@playkit-js/playkit-js-ui": "0.59.1",
     "hls.js": "^0.14.9",
-    "js-logger": "^1.6.0",
     "playkit-js-providers": "https://github.com/kaltura/playkit-js-providers.git#v2.22.1",
     "proxy-polyfill": "^0.3.0",
     "shaka-player": "^3.0.4"

src/common/cast/base-remote-player.js

@@ -1,9 +1,8 @@
 // @flow
 /* eslint no-unused-vars: 0 */
 import {IRemotePlayer} from './remote-player';
-import {EventManager, FakeEventTarget, TextStyle, Track, Utils} from '@playkit-js/playkit-js';
+import {EventManager, FakeEventTarget, TextStyle, Track, Utils, getLogger} from '@playkit-js/playkit-js';
 import {RemoteControl} from './remote-control';
-import getLogger from '../utils/logger';
 import {RemoteSession} from './remote-session';
 
 /**
@@ -49,20 +48,20 @@ class BaseRemotePlayer extends FakeEventTarget implements IRemotePlayer {
     return true;
   }
 
+  static _logger: any;
   _remoteControl: RemoteControl;
   _playerConfig: Object;
   _castConfig: Object;
-  _logger: any;
   _eventManager: EventManager;
 
   constructor(name: string, castConfig: Object, remoteControl: RemoteControl) {
     super();
     this._playerConfig = {};
-    this._logger = getLogger(name);
+    BaseRemotePlayer._logger = getLogger(name);
     this._remoteControl = remoteControl;
     this._castConfig = Utils.Object.mergeDeep({}, this.constructor.defaultConfig, castConfig);
     this._eventManager = new EventManager();
-    this._logger.debug(`Initialized`);
+    BaseRemotePlayer._logger.debug(`Initialized`);
   }
 
   /**

src/common/cast/remote-control.js

@@ -3,18 +3,16 @@
 import {KalturaPlayer} from '../../kaltura-player';
 import {PlayerSnapshot} from './player-snapshot';
 import {CastEventType} from './cast-event-type';
-import {EventType as CoreEventType, FakeEvent, loadPlayer, TrackType, Utils} from '@playkit-js/playkit-js';
+import {EventType as CoreEventType, FakeEvent, loadPlayer, TrackType, Utils, getLogger} from '@playkit-js/playkit-js';
 import {RemoteAvailablePayload, RemoteConnectedPayload, RemoteDisconnectedPayload} from './remote-payload';
 import {UIWrapper} from '../ui-wrapper';
-import getLogger from '../utils/logger';
-
-const logger: any = getLogger('RemoteControl');
 
 /**
  * @class RemoteControl
  * @param {KalturaPlayer} player - The Kaltura player.
  */
 class RemoteControl {
+  static _logger: any = getLogger('RemoteControl');
   /**
    * Gets the player snapshot.
    * @returns {PlayerSnapshot} - player snapshot.
@@ -89,12 +87,12 @@ class RemoteControl {
 }
 
 function onRemoteDeviceConnecting(): void {
-  logger.debug('onRemoteDeviceConnecting');
+  RemoteControl._logger.debug('onRemoteDeviceConnecting');
   this.dispatchEvent(new FakeEvent(CastEventType.CAST_SESSION_STARTING));
 }
 
 function onRemoteDeviceConnected(payload: RemoteConnectedPayload): void {
-  logger.debug('onRemoteDeviceConnected', payload);
+  RemoteControl._logger.debug('onRemoteDeviceConnected', payload);
   const {player, ui, session} = payload;
   // After remote player is connected, clean all listeners and bounce the remote player events forward
   this._eventManager.removeAll();
@@ -124,12 +122,12 @@ function onRemoteDeviceConnected(payload: RemoteConnectedPayload): void {
 }
 
 function onRemoteDeviceDisconnecting(): void {
-  logger.debug('onRemoteDeviceDisconnecting');
+  RemoteControl._logger.debug('onRemoteDeviceDisconnecting');
   this.dispatchEvent(new FakeEvent(CastEventType.CAST_SESSION_ENDING));
 }
 
 function onRemoteDeviceDisconnected(payload: RemoteDisconnectedPayload): void {
-  logger.debug('onRemoteDeviceDisconnected', payload);
+  RemoteControl._logger.debug('onRemoteDeviceDisconnected', payload);
   const {player, snapshot} = payload;
   if (this._remotePlayer && this._remotePlayer === player) {
     // After remote player is disconnected, clean all listeners and bounce the remote player events forward
@@ -169,7 +167,7 @@ function onRemoteDeviceDisconnected(payload: RemoteDisconnectedPayload): void {
 }
 
 function onRemoteDeviceAvailable(payload: RemoteAvailablePayload): void {
-  logger.debug('onRemoteDeviceAvailable', payload);
+  RemoteControl._logger.debug('onRemoteDeviceAvailable', payload);
   const {player, available} = payload;
   this.dispatchEvent(
     new FakeEvent(CastEventType.CAST_AVAILABLE, {
@@ -180,18 +178,18 @@ function onRemoteDeviceAvailable(payload: RemoteAvailablePayload): void {
 }
 
 function onRemoteDeviceConnectFailed(): void {
-  logger.debug('onRemoteDeviceConnectFailed');
+  RemoteControl._logger.debug('onRemoteDeviceConnectFailed');
   this.dispatchEvent(new FakeEvent(CastEventType.CAST_SESSION_START_FAILED));
 }
 
 function getPlayerSnapshot(): PlayerSnapshot {
   const snapshot = new PlayerSnapshot(this);
-  logger.debug('getPlayerSnapshot', snapshot);
+  RemoteControl._logger.debug('getPlayerSnapshot', snapshot);
   return snapshot;
 }
 
 function getUIWrapper(): UIWrapper {
-  logger.debug('getUIWrapper');
+  RemoteControl._logger.debug('getUIWrapper');
   return this._uiWrapper;
 }
 

src/common/cast/remote-player-manager.js

@@ -1,7 +1,7 @@
 // @flow
 import {RemoteControl} from './remote-control';
 import {BaseRemotePlayer} from './base-remote-player';
-import getLogger from '../utils/logger';
+import {getLogger} from '@playkit-js/playkit-js';
 
 class RemotePlayerManager {
   static _logger: any = getLogger('RemotePlayerManager');

src/common/controllers/ads-controller.js

@@ -1,9 +1,8 @@
 //@flow
 import {KalturaPlayer as Player} from '../../kaltura-player';
-import getLogger from '../utils/logger';
 import {Ad} from '../ads';
 import {AdBreak} from '../ads';
-import {Error, EventManager, AdEventType, FakeEvent, FakeEventTarget, Html5EventType, CustomEventType} from '@playkit-js/playkit-js';
+import {Error, EventManager, AdEventType, FakeEvent, FakeEventTarget, Html5EventType, CustomEventType, getLogger} from '@playkit-js/playkit-js';
 
 declare type RunTimeAdBreakObject = KPAdBreakObject & {
   played: boolean

src/common/playlist/playlist-manager.js

@@ -1,8 +1,7 @@
 // @flow
 import {KalturaPlayer} from '../../kaltura-player';
-import {FakeEvent, Utils, EventManager} from '@playkit-js/playkit-js';
+import {FakeEvent, Utils, EventManager, getLogger} from '@playkit-js/playkit-js';
 import {PlaylistEventType} from './playlist-event-type';
-import getLogger from '../utils/logger';
 import {Playlist} from './playlist';
 import {PlaylistItem} from './playlist-item';
 import {addKalturaPoster} from 'poster';
@@ -13,7 +12,7 @@ import {addKalturaPoster} from 'poster';
  * @param {KPOptionsObject} options - The player config object
  */
 class PlaylistManager {
-  _logger: any = getLogger('PlaylistManager');
+  static _logger: any = getLogger('PlaylistManager');
   _player: KalturaPlayer;
   _eventManager: EventManager;
   _playlist: Playlist;
@@ -91,7 +90,7 @@ class PlaylistManager {
    * @memberof PlaylistManager
    */
   playNext(): void {
-    this._logger.debug('playNext');
+    PlaylistManager._logger.debug('playNext');
     const next = this._playlist.getNext(true);
     if (next.item) {
       this._setItem(next.item, next.index);
@@ -105,7 +104,7 @@ class PlaylistManager {
    * @memberof PlaylistManager
    */
   playPrev(): void {
-    this._logger.debug('playPrev');
+    PlaylistManager._logger.debug('playPrev');
     const prev = this._playlist.prev;
     if (prev.item) {
       this._setItem(prev.item, prev.index);
@@ -120,7 +119,7 @@ class PlaylistManager {
    * @memberof PlaylistManager
    */
   playItem(index: number): void {
-    this._logger.debug(`playItem(${index})`);
+    PlaylistManager._logger.debug(`playItem(${index})`);
     const item = this._playlist.items[index];
     if (item) {
       this._setItem(item, index);
@@ -254,7 +253,7 @@ class PlaylistManager {
   }
 
   _setItem(activeItem: PlaylistItem, index: number): Promise<*> {
-    this._logger.debug(`Playing item number ${index}`, activeItem);
+    PlaylistManager._logger.debug(`Playing item number ${index}`, activeItem);
     const playback: Object = {loop: false};
     if (this._playlist.current.item) {
       // from the second item onwards

src/common/plugins/base-plugin.js

@@ -1,13 +1,13 @@
 //@flow
-import getLogger from '../utils/logger';
-import {Error, EventManager, FakeEvent, Utils} from '@playkit-js/playkit-js';
+import {Error, EventManager, FakeEvent, Utils, getLogger} from '@playkit-js/playkit-js';
 
 /** The BasePlugin responsible to implement the plugin interface.
  * Contains several default implementations.
  * Other plugins should extend this class.
  * @classdesc
  */
 export class BasePlugin implements IPlugin {
+  logger: any;
   /**
    * The runtime configuration of the plugin.
    * @member
@@ -22,7 +22,6 @@ export class BasePlugin implements IPlugin {
    * The logger of the plugin.
    * @member
    */
-  logger: any;
   /**
    * Reference to the actual player.
    * @member

src/common/plugins/plugin-manager.js

@@ -1,19 +1,18 @@
 //@flow
 import {BasePlugin} from '.';
-import getLogger from '../utils/logger';
-import {Error} from '@playkit-js/playkit-js';
+import {Error, getLogger} from '@playkit-js/playkit-js';
 
 /**
  * The logger of the PluginManager class.
  * @private
  * @const
  */
-const logger = getLogger('PluginManager');
 
 /** The PluginManager responsible for register plugins definitions and store plugins instances.
  * @classdesc
  */
 export class PluginManager {
+  static _logger = getLogger('PluginManager');
   /**
    * The registry of the plugins.
    * Maps plugin's name to his class.
@@ -49,15 +48,17 @@ export class PluginManager {
    */
   static register(name: string, handler: Function): boolean {
     if (typeof handler !== 'function' || handler.prototype instanceof BasePlugin === false) {
-      logger.error(`Plugin <${name}> registration failed, either plugin is not an instance of BasePlugin or plugin handler is not a function`);
+      PluginManager._logger.error(
+        `Plugin <${name}> registration failed, either plugin is not an instance of BasePlugin or plugin handler is not a function`
+      );
       return false;
     }
     if (!PluginManager._registry.has(name)) {
       PluginManager._registry.set(name, handler);
-      logger.debug(`Plugin <${name}> has been registered successfully`);
+      PluginManager._logger.debug(`Plugin <${name}> has been registered successfully`);
       return true;
     }
-    logger.debug(`Plugin <${name}> is already registered, do not register again`);
+    PluginManager._logger.debug(`Plugin <${name}> is already registered, do not register again`);
     return false;
   }
 
@@ -71,7 +72,7 @@ export class PluginManager {
   static unRegister(name: string): void {
     if (PluginManager._registry.has(name)) {
       PluginManager._registry.delete(name);
-      logger.debug(`Unregistered <${name}> plugin.`);
+      PluginManager._logger.debug(`Unregistered <${name}> plugin.`);
     }
   }
 
@@ -85,7 +86,7 @@ export class PluginManager {
    */
   load(name: string, player: Object, config: Object = {}): boolean {
     if (!PluginManager._registry.has(name)) {
-      logger.warn(`Plugin <${name}> loading failed, plugin is not registered`);
+      PluginManager._logger.warn(`Plugin <${name}> loading failed, plugin is not registered`);
       throw new Error(Error.Severity.RECOVERABLE, Error.Category.PLAYER, Error.Code.RUNTIME_ERROR_NOT_REGISTERED_PLUGIN, name);
     }
     let pluginClass = PluginManager._registry.get(name);
@@ -101,10 +102,10 @@ export class PluginManager {
         throw new Error(Error.Severity.RECOVERABLE, Error.Category.PLAYER, Error.Code.PLUGIN_LOAD_FAILED, e);
       }
       this._isDisabledPluginMap.set(name, false);
-      logger.debug(`Plugin <${name}> has been loaded`);
+      PluginManager._logger.debug(`Plugin <${name}> has been loaded`);
       return true;
     }
-    logger.debug(`Plugin <${name}> isn't loaded, isValid()=${isValidPlugin.toString()}, disabled=${isDisablePlugin.toString()}`);
+    PluginManager._logger.debug(`Plugin <${name}> isn't loaded, isValid()=${isValidPlugin.toString()}, disabled=${isDisablePlugin.toString()}`);
     return false;
   }
 

src/common/polyfills/performance-now.js

@@ -1,6 +1,6 @@
 // @flow
 import PolyfillManager from './polyfill-manager';
-import getLogger from '../utils/logger';
+import {getLogger} from '@playkit-js/playkit-js';
 
 export default class PerformanceNowPolyfill {
   static id: string = 'performance.now';

src/common/polyfills/polyfill-manager.js

@@ -1,5 +1,5 @@
 // @flow
-import getLogger from '../utils/logger';
+import {getLogger} from '@playkit-js/playkit-js';
 
 if (!window._babelPolyfill) {
   require('@babel/polyfill');

src/common/polyfills/prepend.js

@@ -1,6 +1,6 @@
 // @flow
 import PolyfillManager from './polyfill-manager';
-import getLogger from '../utils/logger';
+import {getLogger} from '@playkit-js/playkit-js';
 
 export default class PrependPolyfill {
   static id: string = 'prepend';

src/common/storage/storage-manager.js

@@ -1,7 +1,6 @@
 // @flow
 import StorageWrapper from './storage-wrapper';
-import getLogger from '../utils/logger';
-import {EventManager, Utils} from '@playkit-js/playkit-js';
+import {EventManager, Utils, getLogger} from '@playkit-js/playkit-js';
 
 export default class StorageManager {
   static StorageKeys: {[key: string]: string} = {
@@ -97,9 +96,9 @@ export default class StorageManager {
     const storageSize = StorageWrapper.size;
     const hasStorage = storageSize !== 0;
     if (hasStorage) {
-      this._logger.debug('Storage found with size of ', storageSize);
+      StorageManager._logger.debug('Storage found with size of ', storageSize);
     } else {
-      this._logger.debug('No storage found');
+      StorageManager._logger.debug('No storage found');
     }
     return hasStorage;
   }
@@ -113,7 +112,7 @@ export default class StorageManager {
   static getStorageConfig(): Object {
     const values = StorageManager._getExistingValues();
     const storageConfig = StorageManager._buildStorageConfig(values);
-    this._logger.debug('Gets storage config', storageConfig);
+    StorageManager._logger.debug('Gets storage config', storageConfig);
     return storageConfig;
   }
 

src/common/storage/storage-wrapper.js

@@ -1,5 +1,5 @@
 // @flow
-import getLogger from '../utils/logger';
+import {getLogger} from '@playkit-js/playkit-js';
 
 const STORAGE_PREFIX = __NAME__ + '_';
 

src/common/ui-wrapper.js

@@ -1,17 +1,16 @@
 // @flow
 import {UIManager} from '@playkit-js/playkit-js-ui';
-import {Env, Utils} from '@playkit-js/playkit-js';
+import {Env, Utils, getLogger} from '@playkit-js/playkit-js';
 import {DEFAULT_THUMBS_SLICES, DEFAULT_THUMBS_WIDTH, getThumbSlicesUrl} from './utils/thumbs';
 import {KalturaPlayer} from '../kaltura-player';
-import getLogger from './utils/logger';
 
 /**
  * The logger of the UIWrapper class.
  * @private
  * @const
  */
-const logger = getLogger('UIWrapper');
 class UIWrapper {
+  static _logger = getLogger('UIWrapper');
   _uiManager: UIManager;
   _disabled: boolean = false;
 
@@ -80,10 +79,10 @@ class UIWrapper {
     if (config.css) {
       Utils.Dom.loadStyleSheetAsync(config.css).then(
         () => {
-          logger.debug(`external css was loaded successfully`);
+          UIWrapper._logger.debug(`external css was loaded successfully`);
         },
         () => {
-          logger.error(`external css failed to load`);
+          UIWrapper._logger.error(`external css failed to load`);
         }
       );
     }