[#381] make logger state immutable and inject default logger

Author: feelform

index.js

@@ -14,11 +14,12 @@ const logger = require('./lib/utils/log/logger')
 
 const config = new ConfigBuilder().build()
 setConfig(config)
-logger.setRootLogger(LogBuilder.createDefaultLogBuilder().setConfig(config).build())
 
 const agentInfo = AgentInfo.make(config)
+const defaultLogger = logger.getLogger(LogBuilder.createDefaultLogBuilder().setConfig(config).build())
 const agent = new AgentBuilder(agentInfo)
                 .setConfig(config)
+                .setLogger(defaultLogger)
                 .build()
 agent.start()
 module.exports = agent

lib/agent-builder.js

@@ -95,6 +95,11 @@ class AgentBuilder {
         return this
     }
 
+    setLogger(logger) {
+        this.logger = logger
+        return this
+    }
+
     addService(service) {
         this.services.push(service)
         return this
@@ -120,7 +125,7 @@ class AgentBuilder {
             this.config = getConfig()
         }
 
-        const agent = new Agent(this.agentInfo, this.config, logger)
+        const agent = new Agent(this.agentInfo, this.config, this.logger ?? logger.getLogger())
         if (!this.dataSender) {
             this.dataSender = dataSenderFactory.create(this.config, this.agentInfo)
         }

lib/utils/log/log-builder.js

@@ -36,7 +36,6 @@ class Log {
     constructor(name, level) {
         this.name = name
         this.level = level
-        this.appenders = []
     }
 
     getName() {
@@ -50,6 +49,20 @@ class Log {
     getAppenders() {
         return this.appenders
     }
+
+    createdWithConfig() {
+        return true
+    }
+}
+
+class NoConfigLog extends Log {
+    constructor(name, level) {
+        super(name, level)
+    }
+
+    createdWithConfig() {
+        return false
+    }
 }
 
 class LogBuilder {
@@ -73,9 +86,9 @@ class LogBuilder {
 
     build() {
         if (!this.config) {
-            const log = new Log(this.name, this.level)
-            log.appenders = this.appenders
-            return log
+            const noConfigLog = new NoConfigLog(this.name, this.level)
+            noConfigLog.appenders = this.appenders
+            return noConfigLog
         }
 
         const level = this.valueOfLoggingLevel(this.config.loggerLevels[this.name]) ?? this.level
@@ -158,6 +171,10 @@ class LogBuilder {
         this.config = config
         return this
     }
+
+    getName() {
+        return this.name
+    }
 }
 
 module.exports = {

lib/utils/log/logger.js

@@ -9,22 +9,85 @@
 const loglevel = require('loglevel')
 const { LogBuilder, LogLevel: Level, Log } = require('./log-builder')
 
-class Logging {
+
+class Logger {
+  constructor() {
+    this.loggers = new Map()
+    this.defaultLoggerName = LogBuilder.createDefaultLogBuilder().getName()
+    this.loggers.set(this.defaultLoggerName, new ChildLogger(loglevel, LogBuilder.createDefaultLogBuilder().build()))
+  }
+
+  getLogger(log) {
+    if (!log) {
+      return this.loggers.get(this.defaultLoggerName)
+    }
+
+    if (typeof log === 'string') {
+      return this.loggers.get(log) ?? this.loggers.get(this.defaultLoggerName)
+    }
+
+    if (!(log instanceof Log)) {
+      return this.loggers.get(this.defaultLoggerName)
+    }
+
+    const logName = log.getName()
+    if (!this.loggers.has(logName)) {
+      const logger = new ChildLogger(loglevel.getLogger(logName), log)
+      this.loggers.set(logName, logger)
+      return logger
+    }
+
+    if (log.createdWithConfig()) {
+      const logger = this.loggers.get(logName)
+      logger.loglevel.setLevel(log.getLevel())
+      logger.appenders = log.getAppenders()
+    }
+    return this.loggers.get(logName)
+  }
+
+  debug() {
+    const logger = this.getLogger()
+    logger.debug.apply(logger, arguments)
+  }
+
+  isDebug() {
+    const logger = this.getLogger()
+    return logger.isDebug()
+  }
+
+  info() {
+    const logger = this.getLogger()
+    logger.info.apply(logger, arguments)
+  }
+
+  isInfo() {
+    const logger = this.getLogger()
+    return logger.isInfo()
+  }
+
+  warn() {
+    const logger = this.getLogger()
+    logger.warn.apply(logger, arguments)
+  }
+
+  error() {
+    const logger = this.getLogger()
+    logger.error.apply(logger, arguments)
+  }
+}
+
+class ChildLogger {
   constructor(loglevel, log) {
     this.loglevel = loglevel
-    if (log) {
-      this.loglevel.setLevel(log.getLevel())
-      this.appenders = log.getAppenders()
-    } else {
-      this.appenders = []
-    }
+    this.loglevel.setLevel(log.getLevel())
+    this.appenders = log.getAppenders()
     this.name = log.getName()
   }
 
   debug() {
     this.loglevel.debug.apply(null, arguments)
 
-    if (this.appenders.length < 1) return
+    if (!this.hasAppenders()) return
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
@@ -57,7 +120,7 @@ class Logging {
   info() {
     this.loglevel.info.apply(null, arguments)
 
-    if (this.appenders.length < 1) return
+    if (!this.hasAppenders()) return
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
@@ -74,7 +137,7 @@ class Logging {
   warn() {
     this.loglevel.warn.apply(null, arguments)
 
-    if (this.appenders.length < 1) return
+    if (!this.hasAppenders()) return
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
@@ -87,7 +150,7 @@ class Logging {
   error() {
     this.loglevel.error.apply(null, arguments)
 
-    if (this.appenders.length < 1) return
+    if (!this.hasAppenders()) return
 
     const message = this.formatMessage(arguments)
     this.appenders.forEach(appender => {
@@ -96,40 +159,9 @@ class Logging {
       }
     })
   }
-}
-
-class Logger extends Logging {
-  constructor() {
-    super(loglevel, LogBuilder.createDefaultLogBuilder().build())
-    this.loggers = new Map()
-  }
 
-  getLogger(log) {
-    if (!(log instanceof Log) && typeof log !== 'string') {
-      return this
-    }
-
-    if (typeof log === 'string' && !this.loggers.has(log)) {
-      return this
-    }
-
-    const logName = log.getName?.() ?? (typeof log === 'string' ? log : LogBuilder.createDefaultLogBuilder().build().getName())
-    if (!this.loggers.has(logName)) {
-      this.loggers.set(logName, new ChildLogger(this.loglevel.getLogger(logName), log))
-    }
-    return this.loggers.get(logName)
-  }
-
-  setRootLogger(log) {
-    this.loglevel.setLevel(log.getLevel())
-    this.appenders = log.getAppenders()
-  }
-}
-
-class ChildLogger extends Logging {
-  constructor(loglevel, log) {
-    super(loglevel, log)
-    this.name = log.getName()
+  hasAppenders() {
+    return Array.isArray(this.appenders) && this.appenders.length > 0
   }
 }
 

lib/utils/log/types.d.ts

@@ -64,7 +64,6 @@ export declare class Logger implements Logging {
     isInfo(): boolean;
 
     getLogger(log: Log): Logger;
-    setRootLogger(log: Log): void;
 }
 
 export declare class ChildLogger implements Logging {