enableLog flag not working

[balman]

Summary

The enableLog configuration option is disregarded and log files are generated even when the value is false.

Expected Behavior

Specifying enableLog: false when creating a new API client should suppress log files from being written to. An example would be as follows:

const cybersourceRestApi = require('cybersource-rest-client')
const merchantConfig = {
  authenticationType: 'http_signature',
  runEnvironment: 'cybersource.environment.SANDBOX',
  merchantID: 'XXXXXXX',
  merchantKeyId: 'XXXXXXXXX',
  merchantsecretKey: 'XXXXXXXXXXXXXX',
  enableLog: false // this should result in logs from the CyberSource REST client being suppressed
}

const paymentsApi = new cybersourceRestApi.PaymentsApi(merchantConfig)

Actual Behavior

When enableLog: false is specified, the CyberSource REST client still writes logs to the filesystem.

Other Comments

It looks like there was a switch to using the winston-daily-rotate-file package recently, and the enableLog option from the CyberSource client is being passed to this transport as part of a silent option. However, it looks like there is no reference to a silent option in the documentation for this package and so it may not be a valid option for this transport.

[doginthehat]

Yeah same issue

[doginthehat]

@balman I was able to go around the issue by patching the logger on the fly with my own.

I copied src/authentication/logging/Logger.js from cybersource-rest-client package to my own local copy (patch_logger.js)

Then did this to replace the logger on the fly:

const cybersourceRestApi = require('cybersource-rest-client');
const logger = require('./patch_logger.js');
cybersourceRestApi.Logger.getLogger = logger.getLogger

Then you can tweak patch_logger accordingly to make it work.

Note: silent is an option at the logger level itself, not the transporter. However, setting silent in the logger but still keeping DailyRotateFile still triggers some minor logging to file.

I ended up with this solution:

const winston = require("winston");
const { format } = require("winston");
const { combine, timestamp, label, printf } = format;
require("winston-daily-rotate-file");

const loggingFormat = printf(({ level, message, label, timestamp }) => {
	return `[${timestamp}] [${level.toUpperCase()}] [${label}] : ${message}`;
});

exports.getLogger = function (
	merchantConfig,
	loggerCategory = "UnknownCategoryLogger"
) {
	var appTransports = createTransportFromConfig(merchantConfig);

	var loggingLevel = merchantConfig.getLoggingLevel();
	var enableLog = merchantConfig.getEnableLog();
	return winston.loggers.get(loggerCategory, {
		level: loggingLevel,
		silent: !enableLog,
		format: combine(
			label({ label: loggerCategory }),
			timestamp(),
			loggingFormat
		),
		transports: appTransports,
	});
};

function createTransportFromConfig(mConfig) {
	var transports = [];

	var loggingLevel = mConfig.getLoggingLevel();
	var maxLogFiles = mConfig.getMaxLogFiles();
	var logFileName = mConfig.getLogFileName();
	var logDirectory = mConfig.getLogDirectory();
	var enableLog = mConfig.getEnableLog();

	transports.push(
		enableLog
			? new winston.transports.DailyRotateFile({
					level: loggingLevel,
					filename: logFileName + "-%DATE%.log",
					datePattern: "YYYY-MM-DD",
					zippedArchive: true,
					dirname: logDirectory,
					maxFiles: maxLogFiles,
					silent: !enableLog,
			  })
			: new winston.transports.Console({
					format: winston.format.simple({}),
			  })
	);

	return transports;
}

[balman]

@doginthehat Thanks for sharing! This looks like a promising interim solution.

[YegorMedvedev]

The same is here... @balman any progress with the issue?

[robertop87]

The same behavior here.

In my case it's critical because I'm deploying in a serverless infrastructure, which means only read access to file system.

Here is my error (related to flag not working)
Error: EROFS: read-only file system, mkdir 'log/'

@balman is there any progress to solve this?

[doginthehat]

@robertop87 We had the same problem. We were able to go around by patching the logger as per previous comment.

It's really disappointing to see how little care Cybersource is giving to this node client, we've had so many issues. 🙄

[merugus]

Hi there,

I have used "cybersource-rest-client": "^0.0.36" and made EnableLog = false; EnableMasking = false; to resolve the issue.

-Srini

[adityaDataScientist]

@robertop87 @doginthehat are you able to resolve this issue? Actually, I am also getting the same error while creating the lambda function. Could you please let me know how I can resolve this?

[rsachan8]

@adityaDataScientist you need to disable logging using "enableLog" flag in your client configuration.
You can refer this sample : https://github.com/CyberSource/cybersource-rest-samples-node/blob/master/Data/Configuration.js#L27

[samhithal]

Please refer to this sample : https://github.com/CyberSource/cybersource-rest-samples-node/blob/master/Data/Configuration.js#L27 @robertop87 @doginthehat @balman

Please let us know if still see the issue.