[FIX] Streamline log-level flags, allow overwrite with env variable

The Yargs defaulting of the log-level argument let to an unwanted
enforcing of log-level "info", which could not be overwritten using the
UI5_LOG_LVL environment variable.

If a user does not specify any log-level related flags, no log level
should be set by the CLI.

Author: RandomByte

lib/cli/base.js

@@ -13,18 +13,24 @@ export default function(cli) {
 		"This option will disable resolution of node package dependencies.",
 			type: "string"
 		})
-		.option("verbose", {
-			describe: "Enable verbose logging.",
-			type: "boolean"
-		})
 		.option("loglevel", {
 			alias: "log-level",
-			describe: "Set the logging level (error|warn|info|verbose|silly).",
+			describe: "Set the logging level (silent|error|warn|info|perf|verbose|silly).",
 			default: "info",
 			type: "string"
 		})
-		.option("x-perf", {
-			describe: "Outputs performance measurements",
+		.option("verbose", {
+			describe: "Enable verbose logging.",
+			default: false,
+			type: "boolean"
+		})
+		.option("silent", {
+			describe: "Disable all log output.",
+			default: false,
+			type: "boolean"
+		})
+		.option("perf", {
+			describe: "Enable performance measurements and related logging.",
 			default: false,
 			type: "boolean"
 		})

lib/cli/commands/tree.js

@@ -22,7 +22,7 @@ tree.builder = function(cli) {
 tree.handler = async function(argv) {
 	let startTime;
 	let elapsedTime;
-	if (argv.xPerf) {
+	if (argv.perf) {
 		startTime = process.hrtime();
 	}
 	const {graphFromStaticFile, graphFromPackageDependencies} = await import("@ui5/project/graph");
@@ -39,7 +39,7 @@ tree.handler = async function(argv) {
 		});
 	}
 
-	if (argv.xPerf) {
+	if (argv.perf) {
 		elapsedTime = await getElapsedTime(startTime);
 	}
 
@@ -93,7 +93,7 @@ tree.handler = async function(argv) {
 	} else {
 		console.log(chalk.italic(`None`));
 	}
-	if (argv.xPerf) {
+	if (argv.perf) {
 		console.log("");
 		console.log(chalk.blue(
 			`Dependency graph generation took ${chalk.bold(elapsedTime)}`));

lib/cli/middlewares/logger.js

@@ -1,4 +1,4 @@
-import {setLogLevel, getLogger} from "@ui5/logger";
+import {setLogLevel, isLogLevelEnabled, getLogger} from "@ui5/logger";
 import ConsoleWriter from "@ui5/logger/writers/Console";
 import {getVersion} from "../version.js";
 /**
@@ -7,13 +7,26 @@ import {getVersion} from "../version.js";
  * @param {object} argv logger arguments
  */
 export async function initLogger(argv) {
-	ConsoleWriter.init();
-
-	if (argv.loglevel) {
+	if (argv.loglevel && argv.loglevel !== "info") {
+		// argv.loglevel defaults to "info", which is anyways already the Logger's default
+		// Therefore do not explicitly set it again in order to allow overwriting the log level
+		// using the UI5_LOG_LVL environment variable
 		setLogLevel(argv.loglevel);
 	}
+	if (argv.perf) {
+		setLogLevel("perf");
+	}
 	if (argv.verbose) {
 		setLogLevel("verbose");
+	}
+	if (argv.silent) {
+		// Silent should overrule any other log-level related CLI flags
+		setLogLevel("silent");
+	}
+
+	// Initialize writer
+	ConsoleWriter.init();
+	if (isLogLevelEnabled("verbose")) {
 		const log = getLogger("cli:middlewares:base");
 		log.verbose(`using @ui5/cli version ${getVersion()}`);
 		log.verbose(`using node version ${process.version}`);

test/lib/cli/commands/build.js

@@ -9,8 +9,8 @@ function getDefaultArgv() {
 		"loglevel": "info",
 		"log-level": "info",
 		"logLevel": "info",
-		"x-perf": false,
-		"xPerf": false,
+		"perf": false,
+		"silent": false,
 		"include-all-dependencies": false,
 		"all": false,
 		"a": false,

test/lib/cli/commands/serve.js

@@ -10,8 +10,8 @@ function getDefaultArgv() {
 		"loglevel": "info",
 		"log-level": "info",
 		"logLevel": "info",
-		"x-perf": false,
-		"xPerf": false,
+		"perf": false,
+		"silent": false,
 		"h2": false,
 		"simple-index": false,
 		"simpleIndex": false,

test/lib/cli/commands/tree.js

@@ -10,8 +10,8 @@ function getDefaultArgv() {
 		"loglevel": "info",
 		"log-level": "info",
 		"logLevel": "info",
-		"x-perf": false,
-		"xPerf": false,
+		"perf": false,
+		"silent": false,
 		"$0": "ui5"
 	};
 }
@@ -225,7 +225,7 @@ test.serial("ui5 tree --x-perf", async (t) => {
 		});
 	});
 
-	argv.xPerf = true;
+	argv.perf = true;
 
 	sinon.stub(process, "hrtime")
 		.withArgs().returns([0, 0])

test/lib/cli/middlewares/logger.js

@@ -6,27 +6,69 @@ import stripAnsi from "strip-ansi";
 test.beforeEach(async (t) => {
 	t.context.verboseLogStub = sinon.stub();
 	t.context.setLogLevelStub = sinon.stub();
+	t.context.isLogLevelEnabledStub = sinon.stub().returns(true);
+	t.context.getVersionStub = sinon.stub().returns("1.0.0");
 	t.context.logger = await esmock("../../../../lib/cli/middlewares/logger.js", {
+		"../../../../lib/cli/version.js": {
+			getVersion: t.context.getVersionStub
+		},
 		"@ui5/logger": {
 			getLogger: () => ({
 				verbose: t.context.verboseLogStub,
 			}),
 			setLogLevel: t.context.setLogLevelStub,
+			isLogLevelEnabled: t.context.isLogLevelEnabledStub,
 		}
 	});
 });
 
 test.serial("init logger", async (t) => {
-	const {logger, setLogLevelStub} = t.context;
+	const {logger, setLogLevelStub, isLogLevelEnabledStub, verboseLogStub, getVersionStub} = t.context;
 	await logger.initLogger({});
 	t.is(setLogLevelStub.callCount, 0, "setLevel has not been called");
+	t.is(isLogLevelEnabledStub.callCount, 1, "isLogLevelEnabled has been called once");
+	t.is(isLogLevelEnabledStub.firstCall.firstArg, "verbose",
+		"isLogLevelEnabled has been called with expected argument");
+	t.is(getVersionStub.callCount, 1, "getVersion has been called once");
+	t.is(verboseLogStub.callCount, 2, "log.verbose has been called twice");
+	t.is(verboseLogStub.firstCall.firstArg, "using @ui5/cli version 1.0.0",
+		"log.verbose has been called with expected argument on first call");
+	t.is(verboseLogStub.secondCall.firstArg, `using node version ${process.version}`,
+		"log.verbose has been called with expected argument on second call");
 });
 
 test.serial("With log-level flag", async (t) => {
 	const {logger, setLogLevelStub} = t.context;
 	await logger.initLogger({loglevel: "silly"});
 	t.is(setLogLevelStub.callCount, 1, "setLevel has been called once");
-	t.is(setLogLevelStub.getCall(0).args[0], "silly", "sets log level to verbose");
+	t.is(setLogLevelStub.getCall(0).args[0], "silly", "sets log level to silly");
+});
+
+test.serial("With default log-level flag", async (t) => {
+	const {logger, setLogLevelStub} = t.context;
+	await logger.initLogger({loglevel: "info"});
+	t.is(setLogLevelStub.callCount, 0, "setLevel has not been called");
+});
+
+test.serial("With verbose flag", async (t) => {
+	const {logger, setLogLevelStub} = t.context;
+	await logger.initLogger({verbose: true});
+	t.is(setLogLevelStub.callCount, 1, "setLevel has been called once");
+	t.is(setLogLevelStub.getCall(0).args[0], "verbose", "sets log level to verbose");
+});
+
+test.serial("With perf flag", async (t) => {
+	const {logger, setLogLevelStub} = t.context;
+	await logger.initLogger({perf: true});
+	t.is(setLogLevelStub.callCount, 1, "setLevel has been called once");
+	t.is(setLogLevelStub.getCall(0).args[0], "perf", "sets log level to perf");
+});
+
+test.serial("With silent flag", async (t) => {
+	const {logger, setLogLevelStub} = t.context;
+	await logger.initLogger({silent: true});
+	t.is(setLogLevelStub.callCount, 1, "setLevel has been called once");
+	t.is(setLogLevelStub.getCall(0).args[0], "silent", "sets log level to silent");
 });
 
 test.serial("With log-level and verbose flag", async (t) => {
@@ -37,6 +79,16 @@ test.serial("With log-level and verbose flag", async (t) => {
 	t.is(setLogLevelStub.getCall(1).args[0], "verbose", "sets log level to verbose");
 });
 
+test.serial("With log-level, verbose, perf and silent flag", async (t) => {
+	const {logger, setLogLevelStub} = t.context;
+	await logger.initLogger({loglevel: "silly", verbose: true, perf: true, silent: true});
+	t.is(setLogLevelStub.callCount, 4, "setLevel has been called four times");
+	t.is(setLogLevelStub.getCall(0).args[0], "silly", "sets log level to verbose");
+	t.is(setLogLevelStub.getCall(1).args[0], "perf", "sets log level to perf");
+	t.is(setLogLevelStub.getCall(2).args[0], "verbose", "Third sets log level to verbose");
+	t.is(setLogLevelStub.getCall(3).args[0], "silent", "sets log level to silent");
+});
+
 import path from "node:path";
 import {execa} from "execa";
 import {fileURLToPath} from "node:url";