feat: add evaluateArgsThatAreFunctions option

log4js-node · Mar 16, 2022 · aeb9404 · aeb9404
1 parent 58cfdc3
commit aeb9404
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/lib/categories.js b/lib/categories.js
@@ -140,6 +140,7 @@ configuration.addListener((config) => {
 });
 
 const setup = (config) => {
+  const { evaluateArgsThatAreFunctions: globalEvaluateArgsThatAreFunctions = false } = config;
   categories.clear();
 
   const categoryNames = Object.keys(config.categories);
@@ -149,12 +150,17 @@ const setup = (config) => {
     category.appenders.forEach((appender) => {
       categoryAppenders.push(appenders.get(appender));
       debug(`Creating category ${name}`);
+      const {
+        level, enableCallStack = false,
+        evaluateArgsThatAreFunctions = globalEvaluateArgsThatAreFunctions
+      } = category;
       categories.set(
         name,
         {
           appenders: categoryAppenders,
-          level: levels.getLevel(category.level),
-          enableCallStack: category.enableCallStack || false
+          level: levels.getLevel(level),
+          enableCallStack,
+          evaluateArgsThatAreFunctions
         }
       );
     });
@@ -203,12 +209,22 @@ const setEnableCallStackForCategory = (category, useCallStack) => {
   configForCategory(category).enableCallStack = useCallStack;
 };
 
+const getEvaluateArgsThatAreFunctionsForCategory = (category) => {
+  return configForCategory(category).evaluateArgsThatAreFunctions === true;
+};
+const setEvaluateArgsThatAreFunctionsForCategory = (category, evaluateArgsThatAreFunctions) => {
+  configForCategory(category).evaluateArgsThatAreFunctions = evaluateArgsThatAreFunctions;
+};
+
 module.exports = categories;
 module.exports = Object.assign(module.exports, {
   appendersForCategory,
   getLevelForCategory,
   setLevelForCategory,
   getEnableCallStackForCategory,
   setEnableCallStackForCategory,
+  getEvaluateArgsThatAreFunctionsForCategory,
+  setEvaluateArgsThatAreFunctionsForCategory,
   init,
 });
+
diff --git a/lib/logger.js b/lib/logger.js
@@ -79,6 +79,14 @@ class Logger {
     categories.setEnableCallStackForCategory(this.category, bool === true);
   }
 
+  get evaluateArgsThatAreFunctions() {
+    return categories.getEvaluateArgsThatAreFunctionsForCategory(this.category);
+  }
+
+  set evaluateArgsThatAreFunctions(bool) {
+    categories.setEvaluateArgsThatAreFunctionsForCategory(this.category, bool === true);
+  }
+
   log(level, ...args) {
     let logLevel = levels.getLevel(level);
     if (!logLevel) {
@@ -96,6 +104,9 @@ class Logger {
 
   _log(level, data) {
     debug(`sending log data (${level}) to appenders`);
+    if (this.evaluateArgsThatAreFunctions) {
+      data = data.map((e) => typeof e === 'function' ? e() : e);
+    }
     const loggingEvent = new LoggingEvent(
       this.category,
       level,