feat: expose logger API (#36)

set to ERROR level by default
expose API to set and get log level and get log level enums
expose convenience method to set logger level via global window param window.PLAYKIT_LOG_LEVEL
update to JS-Logger V1.4

src/k-provider/multi-request-builder.js

@@ -1,11 +1,11 @@
 //@flow
 import RequestBuilder from './request-builder'
 import ServiceResult from './base-service-result'
-import Logger from "../util/logger";
+import getLogger from "../util/logger";
 /**
  * @constant
  */
-const logger = Logger.get("OvpProvider");
+const logger = getLogger("OvpProvider");
 
 /**
  * Multi Request builder

src/k-provider/ovp/ovp-provider.js

@@ -1,5 +1,5 @@
 //@flow
-import Logger from '../../util/logger'
+import getLogger, {setLogLevel, getLogLevel, LogLevel} from '../../util/logger'
 import ProviderParser from './provider-parser'
 import DataLoaderManager from './loaders/data-loader-manager'
 import MediaEntryLoader from './loaders/media-entry-loader'
@@ -8,10 +8,11 @@ import UiConfigLoader from './loaders/ui-config-loader'
 import Configuration from './config'
 import MediaEntry from '../../entities/media-entry'
 import MediaSources from '../../entities/media-sources'
+
 /**
  * @constant
  */
-const logger = Logger.get("OvpProvider");
+const logger = getLogger("OvpProvider");
 
 type playerConfig = {
   id: string,
@@ -74,12 +75,16 @@ export class OvpProvider {
    * @param {number} partnerID The partner ID
    * @param {string} [ks=""]  The provider ks (has empty string as default value)
    * @param {Object} [config]  The provider config(optional)
+   * @param {string} [logLevel]  The provider log level(optional)
    */
-  constructor(pVersion: string, partnerID: number, ks: string = "", config?: Object) {
+  constructor(pVersion: string, partnerID: number, ks: string = "", config?: Object, logLevel?: string) {
     this._pVersion = pVersion;
     this.partnerID = partnerID;
     this.ks = ks;
     this._isAnonymous = !this.ks;
+    if (logLevel && this.LogLevel[logLevel]) {
+      setLogLevel(this.LogLevel[logLevel]);
+    }
     Configuration.set(config);
   }
 
@@ -184,6 +189,33 @@ export class OvpProvider {
     return !!entryId || !!uiConfId;
   }
 
+  /**
+   * Get the log levels
+   * @returns {Object} - The log levels of the player.
+   * @public
+   */
+  get LogLevel(): { [level: string]: Object } {
+    return LogLevel;
+  }
+
+  /**
+   * get the current log level
+   * @param {?string} name - the logger name
+   * @returns {Object} - the log level
+   */
+  getLogLevel(name?: string): Object {
+    return getLogLevel(name);
+  }
+
+  /**
+   * sets the logger level
+   * @param {Object} level - the log level
+   * @param {?string} name - the logger name
+   * @returns {void}
+   */
+  setLogLevel(level: Object, name?: string) {
+    setLogLevel(level, name);
+  }
 }
 
 export default OvpProvider;

src/k-provider/ovp/provider-parser.js

@@ -5,7 +5,7 @@ import KalturaMetadataListResponse from './response-types/kaltura-metadata-list-
 import PlaySourceUrlBuilder from "./play-source-url-builder"
 import XmlParser from '../xml-parser'
 import {MediaEntryTypes, EntryTypes, MediaTypes, DrmScheme} from '../enums'
-import Logger from '../../util/logger'
+import getLogger from '../../util/logger'
 import Configuration from './config'
 import {MediaFormats} from '../../entities/media-format'
 import MediaEntry from '../../entities/media-entry'
@@ -17,7 +17,7 @@ const config = Configuration.get();
 /**
  * @constant
  */
-const logger = Logger.get("OvpProvider");
+const logger = getLogger("OvpProvider");
 
 /**
  * @constant

src/util/logger.js

@@ -1,21 +1,7 @@
 //@flow
 import * as JsLogger from 'js-logger';
 
-class LoggerFactory {
-  constructor(options?: Object) {
-    JsLogger.useDefaults(options || {});
-  }
-
-  get(name?: string) {
-    if (!name) {
-      return JsLogger;
-    }
-    return JsLogger.get(name);
-  }
-}
-
-let Logger = new LoggerFactory({defaultLevel: JsLogger.DEBUG});
-const LOG_LEVEL: { [level: string]: Object } = {
+const LogLevel: { [level: string]: Object } = {
   "DEBUG": JsLogger.DEBUG,
   "INFO": JsLogger.INFO,
   "TIME": JsLogger.TIME,
@@ -24,7 +10,41 @@ const LOG_LEVEL: { [level: string]: Object } = {
   "OFF": JsLogger.OFF
 };
 
-export default Logger;
-export {LOG_LEVEL};
+JsLogger.useDefaults({defaultLevel: JsLogger.ERROR});
 
+/**
+ * get a logger
+ * @param {?string} name - the logger name
+ * @returns {Object} - the logger class
+ */
+function getLogger(name?: string): Object {
+  if (!name) {
+    return JsLogger;
+  }
+  return JsLogger.get(name);
+}
+
+/**
+ * get the log level
+ * @param {?string} name - the logger name
+ * @returns {Object} - the log level
+ */
+function getLogLevel(name?: string): Object {
+  return getLogger(name).getLevel();
+}
+
+``
+
+/**
+ * sets the logger level
+ * @param {Object} level - the log level
+ * @param {?string} name - the logger name
+ * @returns {void}
+ */
+function setLogLevel(level: Object, name?: string): void {
+
+  getLogger(name).setLevel(level);
+}
 
+export default getLogger;
+export {LogLevel, getLogLevel, setLogLevel};

test/src/k-provider/ovp/ovp-provider.spec.js

@@ -233,3 +233,19 @@ describe('OvpProvider.partnerId:1068292', function () {
   });
 });
 
+describe('logger', () => {
+  it('should return the current log level', () => {
+    const provider = new OvpProvider("xyz", "xyz");
+    const currentLogLevel = provider.getLogLevel();
+    currentLogLevel.should.equal(provider.LogLevel.ERROR);
+  });
+
+  it('should enable setting the current log level', () => {
+    const provider = new OvpProvider("xyz", "xyz");
+    let currentLogLevel = provider.getLogLevel();
+    currentLogLevel.should.equal(provider.LogLevel.ERROR);
+    provider.setLogLevel(provider.LogLevel.WARN);
+    currentLogLevel = provider.getLogLevel();
+    currentLogLevel.should.equal(provider.LogLevel.WARN);
+  });
+});

yarn.lock

@@ -2753,8 +2753,8 @@ jodid25519@^1.0.0:
     jsbn "~0.1.0"
 
 js-logger@^1.3.0:
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/js-logger/-/js-logger-1.3.0.tgz#de1a1143242710f7ce4da20408348a2a93ebf34d"
+  version "1.4.1"
+  resolved "https://registry.yarnpkg.com/js-logger/-/js-logger-1.4.1.tgz#f0230dc5e84e120f213d6e5a6b767a913d290335"
 
 js-tokens@^3.0.0:
   version "3.0.1"