[#367] Use internal LogLevel constants

Author: feelform

lib/agent-builder.js

@@ -7,7 +7,7 @@
 'use strict'
 
 const { LogBuilder } = require('./utils/log/log-builder')
-const log = require('./utils/log/logger')
+const logger = require('./utils/log/logger')
 const dataSenderFactory = require('./client/data-sender-factory')
 const stringMetaService = require('./context/string-meta-service')
 const apiMetaService = require('./context/api-meta-service')
@@ -120,9 +120,9 @@ class AgentBuilder {
         if (!this.config) {
             this.config = getConfig()
         }
-        log.setRootLogger(LogBuilder.createDefaultLogBuilder().setConfig(this.config).build())
+        logger.setRootLogger(LogBuilder.createDefaultLogBuilder().setConfig(this.config).build())
 
-        const agent = new Agent(this.agentInfo, this.config, log)
+        const agent = new Agent(this.agentInfo, this.config, logger)
         if (!this.dataSender) {
             this.dataSender = dataSenderFactory.create(this.config, this.agentInfo)
         }

lib/utils/log/index.js

@@ -6,11 +6,11 @@
 
 'use strict'
 
-const LogBuilder = require('./log-builder')
+const { LogBuilder, LogLevel } = require('./log-builder')
 const logger = require('./logger')
 
 module.exports = {
     LogBuilder,
-    LogLevel: LogBuilder.LogLevel,
+    LogLevel,
     logger
 }

lib/utils/log/log-builder.js

@@ -6,7 +6,31 @@
 
 'use strict'
 
-const levels = require('loglevel').levels
+class LogLevel {
+    static get TRACE() {
+        return 0
+    }
+
+    static get DEBUG() {
+        return 1
+    }
+
+    static get INFO() {
+        return 2
+    }
+
+    static get WARN() {
+        return 3
+    }
+
+    static get ERROR() {
+        return 4
+    }
+
+    static get SILENT() {
+        return 5
+    }
+}
 
 class Log {
     constructor(name, level) {
@@ -35,7 +59,7 @@ class LogBuilder {
 
     constructor(name) {
         this.name = name
-        this.level = levels.WARN
+        this.level = LogLevel.WARN
         this.appenders = []
     }
 
@@ -62,35 +86,35 @@ class LogBuilder {
     }
 
     valueOfLoggingLevel(stringLogLevel) {
-        if (!stringLogLevel) {
+        if (typeof stringLogLevel !== 'string') {
             return null
         }
 
-        return levels[stringLogLevel]
+        return LogLevel[stringLogLevel.toUpperCase()]
     }
 
     logLevelDebug() {
-        this.level = levels.DEBUG
+        this.level = LogLevel.DEBUG
         return this
     }
 
     logLevelInfo() {
-        this.level = levels.INFO
+        this.level = LogLevel.INFO
         return this
     }
 
     logLevelWarn() {
-        this.level = levels.WARN
+        this.level = LogLevel.WARN
         return this
     }
 
     logLevelError() {
-        this.level = levels.ERROR
+        this.level = LogLevel.ERROR
         return this
     }
 
     logLevelSilent() {
-        this.level = levels.SILENT
+        this.level = LogLevel.SILENT
         return this
     }
 
@@ -112,7 +136,9 @@ class LogBuilder {
             return this
         }
 
-        this.appenders.push({ ...appender }) // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#spread_in_object_literals
+        const newAppender = { ...appender } // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#spread_in_object_literals
+        Object.setPrototypeOf(newAppender, Object.getPrototypeOf(appender))
+        this.appenders.push(newAppender)
         return this
     }
 
@@ -127,5 +153,6 @@ class LogBuilder {
 }
 
 module.exports = {
-    LogBuilder
+    LogBuilder,
+    LogLevel
 }

lib/utils/log/logger.js

@@ -7,7 +7,7 @@
 'use strict'
 
 const loglevel = require('loglevel')
-const { LogBuilder } = require('./log-builder')
+const { LogBuilder, LogLevel: Level } = require('./log-builder')
 
 class Logging {
   constructor(loglevel, log) {
@@ -28,7 +28,7 @@ class Logging {
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
-      if (appender.loggingLevel <= this.loglevel.levels.DEBUG) {
+      if (appender.loggingLevel <= Level.DEBUG) {
         appender.debug(message)
       }
     })
@@ -51,7 +51,7 @@ class Logging {
 
 
   isDebug() {
-    return this.loglevel.getLevel() === loglevel.levels.DEBUG
+    return this.loglevel.getLevel() === Level.DEBUG
   }
 
   info() {
@@ -61,14 +61,14 @@ class Logging {
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
-      if (appender.loggingLevel <= this.loglevel.levels.INFO) {
+      if (appender.loggingLevel <= Level.INFO) {
         appender.info(message)
       }
     })
   }
 
   isInfo() {
-    return this.loglevel.getLevel() === this.loglevel.levels.INFO
+    return this.loglevel.getLevel() === Level.INFO
   }
 
   warn() {
@@ -78,7 +78,7 @@ class Logging {
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
-      if (appender.loggingLevel <= this.loglevel.levels.WARN) {
+      if (appender.loggingLevel <= Level.WARN) {
         appender.warn(message)
       }
     })
@@ -91,7 +91,7 @@ class Logging {
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
-      if (appender.loggingLevel <= this.loglevel.levels.ERROR) {
+      if (appender.loggingLevel <= Level.ERROR) {
         appender.error(message)
       }
     })

lib/utils/log/types.d.ts

@@ -4,17 +4,20 @@
  * Apache License v2.0
  */
 
-export declare enum LogLevel {
-    TRACE = 0,
-    DEBUG = 1,
-    INFO = 2,
-    WARN = 3,
-    ERROR = 4,
-    SILENT = 5
+export declare class LogLevel {
+    static readonly TRACE: 0;
+    static readonly DEBUG: 1;
+    static readonly INFO: 2;
+    static readonly WARN: 3;
+    static readonly ERROR: 4;
+    static readonly SILENT: 5;
 }
 
+export declare type LogLevelNumbers = 0 | 1 | 2 | 3 | 4 | 5;
+
 export declare interface Appender {
-    loggingLevel: LogLevel | number;
+    name: string;
+    loggingLevel: LogLevelNumbers | number;
     debug(message: string): void;
     info(message: string): void;
     warn(message: string): void;
@@ -38,14 +41,25 @@ export declare class LogBuilder {
 }
 
 export declare class Log {
-    constructor(name: string, level: LogLevel | number);
+    constructor(name: string, level: LogLevelNumbers | number);
 
     getName(): string;
-    getLevel(): LogLevel | number;
+    getLevel(): LogLevelNumbers | number;
     getAppenders(): Array<Appender>;
 }
 
-export declare class Logger {
+export declare interface Logging {
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+
+    isDebug(): boolean;
+    isInfo(): boolean;
+}
+
+export declare class Logger implements Logging {
+
     debug(...args: any[]): void;
     info(...args: any[]): void;
     warn(...args: any[]): void;
@@ -56,3 +70,18 @@ export declare class Logger {
 
     getLogger(log: Log): Logger;
 }
+
+export declare class ChildLogger implements Logging {
+    name: string;
+
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+
+    isDebug(): boolean;
+    isInfo(): boolean;
+}
+
+export declare const logger: Logger;
+

test/utils/log/logger.test.js

@@ -8,10 +8,10 @@
 
 const test = require('tape')
 const log = require('../../../lib/utils/log/logger')
-const { LogBuilder } = require('../../../lib/utils/log/log-builder')
-const levels = require('loglevel').levels
+const { LogBuilder, LogLevel } = require('../../../lib/utils/log/log-builder')
+const levels = LogLevel
 
-test.skip('isDebug', (t) => {
+test('isDebug', (t) => {
     t.plan(4)
     t.equal(log.isDebug(), false, 'debug null')
 
@@ -23,26 +23,26 @@ test.skip('isDebug', (t) => {
     t.equal(testLog2.isInfo(), false, 'same name logger is not info false')
 })
 
-test.skip('isInfo', (t) => {
+test('isInfo', (t) => {
     t.plan(2)
     const testLog = log.getLogger(new LogBuilder('test1').logLevelInfo().build())
     t.equal(testLog.isInfo(), true, 'info')
     t.equal(testLog.isDebug(), false, 'debug false')
 })
 
-test.skip('warn log', (t) => {
+test('warn log', (t) => {
     t.plan(1)
     const testLog = log.getLogger(new LogBuilder('test2').logLevelWarn().build())
     t.equal(testLog.loglevel.getLevel(), testLog.loglevel.levels.WARN, 'warn log level')
 })
 
-test.skip('error log', (t) => {
+test('error log', (t) => {
     t.plan(1)
     const testLog = log.getLogger(new LogBuilder('test3').logLevelError().build())
     t.equal(testLog.loglevel.getLevel(), testLog.loglevel.levels.ERROR, 'error log level')
 })
 
-test.skip('appenders', (t) => {
+test('appenders', (t) => {
     t.plan(2)
     const testLog = log.getLogger(new LogBuilder('test4').logLevelDebug().build())
     t.equal(testLog.appenders.length, 0, 'appenders length')
@@ -59,7 +59,7 @@ test.skip('appenders', (t) => {
     t.equal(testLog2.appenders.length, 1, 'appenders length with valid appender')
 })
 
-test.skip('addAppender validation', (t) => {
+test('addAppender validation', (t) => {
     t.plan(8)
 
     const validAppender = {
@@ -133,7 +133,7 @@ test.skip('addAppender validation', (t) => {
     t.equal(mixedLog.appenders.length, 1, 'Only valid appenders should be added in mixed scenario')
 })
 
-test.skip('formatMessage', (t) => {
+test('formatMessage', (t) => {
     t.plan(4)
     const testLog = log.getLogger(new LogBuilder('test10').logLevelDebug().build())
 
@@ -153,7 +153,7 @@ test.skip('formatMessage', (t) => {
     t.ok(message4.includes('[Object object]'), 'Circular references should be handled gracefully')
 })
 
-test.skip('appender message forwarding', (t) => {
+test('appender message forwarding', (t) => {
     t.plan(7)
 
     let capturedMessages = []
@@ -233,7 +233,7 @@ test.skip('appender message forwarding', (t) => {
     t.equal(capturedMessages.length, 0, 'SILENT level should process no messages')
 })
 
-test.skip('guard clause - no appenders', (t) => {
+test('guard clause - no appenders', (t) => {
     t.plan(4)
 
     const testLog = log.getLogger(new LogBuilder('test12').logLevelDebug().build())
@@ -310,7 +310,7 @@ test.skip('guard clause - no appenders', (t) => {
     t.equal(silentCallCount, 0, 'appender methods should never be called at SILENT level')
 })
 
-test.skip('per-appender loggingLevel configuration', (t) => {
+test('per-appender loggingLevel configuration', (t) => {
     t.plan(6)
 
     const warnAppenderMessages = []