Merge pull request #93 from CyberSource/support-for-external-logger-configuration

External Logger support changes

Author: gnongsie

generator/cybersource-javascript-template/index.mustache

@@ -98,6 +98,6 @@
   exports.LogConfiguration = require('./authentication/logging/LogConfiguration.js');
   exports.SensitiveDataTags = require('./authentication/logging/SensitiveDataTags.js');
   exports.SensitiveDataMasker = require('./authentication/logging/SensitiveDataMasker.js');
-
+  exports.ExternalLoggerWrapper = require('./authentication/logging/ExternalLoggerWrapper.js');
   return exports;<={{ }}=>
 }));

src/authentication/core/MerchantConfig.js

@@ -526,7 +526,9 @@ MerchantConfig.prototype.defaultPropValues = function defaultPropValues() {
 
         return merchantMap.toObject();
     }
-    logger.clear();
+    if(!this.logConfiguration.isExternalLoggerSet){
+        logger.clear();
+    }
 }
 
 module.exports = MerchantConfig;

src/authentication/logging/ExternalLoggerWrapper.js

@@ -0,0 +1,22 @@
+'use strict'
+
+class ExternalLoggerWrapper{
+
+    extLogger;
+
+    constructor(externalLogger) {
+        this.extLogger = externalLogger;
+    }
+
+    getLogger(){
+        return this.extLogger;
+    }
+
+    isLoggerEmpty(){
+        if(this.extLogger === undefined)
+            return false;
+        return true;
+    }
+}
+
+module.exports = ExternalLoggerWrapper;

src/authentication/logging/LogConfiguration.js

@@ -1,6 +1,8 @@
 'use strict';
 
 var Constants = require('../util/Constants');
+const ExternalLoggerWrapper = require('../logging/ExternalLoggerWrapper');
+const ApiException = require('../util/ApiException');
 
 class LogConfiguration {
     enableLog;
@@ -10,6 +12,8 @@ class LogConfiguration {
     loggingLevel;
     maxLogFiles;
     enableMasking;
+    hasExternalLogger;
+    externalLogger;
 
     constructor(logConfig) {
         this.setLogEnable(logConfig.enableLog);
@@ -19,6 +23,8 @@ class LogConfiguration {
         this.setLoggingLevel(logConfig.loggingLevel);
         this.setMaxLogFiles(logConfig.maxLogFiles);
         this.setMaskingEnabled(logConfig.enableMasking);
+        this.setHasExternalLogger(logConfig.hasExternalLogger);
+        this.setExternalLogger(logConfig.externalLogger);
     }
 
     isLogEnabled() {
@@ -43,6 +49,22 @@ class LogConfiguration {
         this.enableMasking = enableMaskingValue;
     }
 
+    setHasExternalLogger(hasExternalLogger){
+        this.hasExternalLogger = hasExternalLogger;
+    }
+
+    isExternalLoggerSet(){
+        return this.hasExternalLogger;
+    }
+
+    setExternalLogger(externalLogger){
+        this.externalLogger = externalLogger;
+    }
+
+    getExternalLogger(){
+        return this.externalLogger;
+    }
+
     getLogDirectory () {
         return this.logDirectory;
     }
@@ -64,7 +86,7 @@ class LogConfiguration {
     setLogFileName (logFileNameValue) {
         this.logFileName = logFileNameValue;
     }
-    
+
     getLogFileMaxSize () {
         return this.logFileMaxSize;
     }
@@ -90,7 +112,7 @@ class LogConfiguration {
     getMaxLogFiles () {
         return this.maxLogFiles;
     }
-    
+
     /**
      * @param {any} maxLogFilesValue
      */
@@ -99,6 +121,19 @@ class LogConfiguration {
     }
 
     getDefaultLoggingProperties(warningMessage) {
+
+        if(typeof (this.hasExternalLogger) === "boolean" && this.hasExternalLogger === true){
+            this.hasExternalLogger = true;
+        } else {
+            this.hasExternalLogger = false;
+        }
+
+        if((typeof (this.externalLogger) === "object" && !(this.externalLogger instanceof ExternalLoggerWrapper))
+            || this.externalLogger === undefined || !(this.externalLogger.isLoggerEmpty())){
+            ApiException.LoggerException("No valid external logger object found. Turning off external logger flag.")
+            this.hasExternalLogger = false;
+        }
+
         if (typeof (this.enableLog) === "boolean" && this.enableLog === true) {
             this.enableLog = true;
         } else {

src/authentication/logging/Logger.js

@@ -3,6 +3,7 @@ const { format } = require('winston');
 const DataMasker = require('./SensitiveDataMasker');
 const { combine, timestamp, label, printf } = format;
 require('winston-daily-rotate-file');
+const ExternalLoggerWrapper = require('../logging/ExternalLoggerWrapper');
 
 const maskedLoggingFormat = printf(({ level, message, label, timestamp }) => {
   return `[${timestamp}] [${level.toUpperCase()}] [${label}] : ${DataMasker.maskSensitiveData(message)}`;
@@ -13,6 +14,13 @@ const unmaskedLoggingFormat = printf(({ level, message, label, timestamp }) => {
 });
 
 exports.getLogger = function (merchantConfig, loggerCategory = 'UnknownCategoryLogger') {
+
+  if(merchantConfig.getLogConfiguration().isExternalLoggerSet() && merchantConfig.getLogConfiguration().getExternalLogger()
+      && merchantConfig.getLogConfiguration().getExternalLogger().getLogger()
+      && merchantConfig.getLogConfiguration().getExternalLogger() instanceof ExternalLoggerWrapper){
+    let logger = merchantConfig.getLogConfiguration().getExternalLogger().getLogger();
+    return logger;
+  }
   var enableLog = merchantConfig.getLogConfiguration().isLogEnabled();
   var enableMasking = merchantConfig.getLogConfiguration().isMaskingEnabled();
   var loggerCategoryRandomiser = Math.floor((Math.random() * 1000) + 1);
@@ -26,19 +34,19 @@ exports.getLogger = function (merchantConfig, loggerCategory = 'UnknownCategoryL
     newLogger = winston.loggers.get(loggerCategory + loggerCategoryRandomiser, {
       level: loggingLevel,
       format: combine(
-        label({ label: loggerCategory }),
-        timestamp(),
-        enableMasking ? maskedLoggingFormat : unmaskedLoggingFormat
+          label({ label: loggerCategory }),
+          timestamp(),
+          enableMasking ? maskedLoggingFormat : unmaskedLoggingFormat
       ),
       transports: appTransports
     });
   } else {
     newLogger = winston.loggers.get(loggerCategory + loggerCategoryRandomiser, {
       level: loggingLevel,
       format: combine(
-        label({ label: loggerCategory }),
-        timestamp(),
-        enableMasking ? maskedLoggingFormat : unmaskedLoggingFormat
+          label({ label: loggerCategory }),
+          timestamp(),
+          enableMasking ? maskedLoggingFormat : unmaskedLoggingFormat
       ),
       transports: [new winston.transports.Console({
         silent: !enableLog

src/authentication/util/ApiException.js

@@ -12,4 +12,9 @@ exports.ApiException = function (message, logger) {
 exports.AuthException = function (message) {
     var err = new Error(message);
     throw err;
+}
+
+exports.LoggerException = function (message) {
+    var err = new Error(message);
+    console.log(err);
 }

src/index.js

@@ -3972,6 +3972,6 @@
   exports.LogConfiguration = require('./authentication/logging/LogConfiguration.js');
   exports.SensitiveDataTags = require('./authentication/logging/SensitiveDataTags.js');
   exports.SensitiveDataMasker = require('./authentication/logging/SensitiveDataMasker.js');
-
+  exports.ExternalLoggerWrapper = require('./authentication/logging/ExternalLoggerWrapper.js');
   return exports;
 }));