refactor(cli): organize logging configuration

As a result the responsibility of managing the initial
configuration for logging has been moved outside the
DefaultServient.

Author: relu91

packages/cli/src/cli-default-servient.ts

@@ -28,6 +28,7 @@ import { FileClientFactory } from "@node-wot/binding-file";
 import { ThingModelHelpers } from "@thingweb/thing-model";
 import { createContext, Script } from "vm";
 import { CompilerFunction } from "./compiler-function";
+import { LogLevel, setLogLevel } from "./utils/set-log-level";
 
 const { debug, error, info } = createLoggers("cli", "cli-default-servient");
 
@@ -77,9 +78,6 @@ export default class DefaultServient extends Servient {
         coap: {
             port: 5683,
         },
-        log: {
-            level: "info",
-        },
     };
 
     private uncaughtListeners: Array<NodeJS.UncaughtExceptionListener> = [];
@@ -103,9 +101,6 @@ export default class DefaultServient extends Servient {
             this.config.servient.clientOnly = true;
         }
 
-        // set log level before any output
-        this.setLogLevel(this.config.log.level);
-
         // load credentials from config
         this.addCredentials(this.config.credentials);
 
@@ -249,7 +244,10 @@ export default class DefaultServient extends Servient {
             actions: {
                 setLogLevel: {
                     description: "Set log level",
-                    input: { oneOf: [{ type: "string" }, { type: "number" }] },
+                    input: {
+                        type: "string",
+                        enum: ["debug", "info", "warn", "error"],
+                    },
                     output: { type: "string" },
                 },
                 shutdown: {
@@ -268,16 +266,10 @@ export default class DefaultServient extends Servient {
             },
         });
 
-        servientProducedThing.setActionHandler("setLogLevel", async (level) => {
-            const ll = await Helpers.parseInteractionOutput(level);
-            if (typeof ll === "number") {
-                this.setLogLevel(ll as number);
-            } else if (typeof ll === "string") {
-                this.setLogLevel(ll as string);
-            } else {
-                // try to convert it to strings
-                this.setLogLevel(ll + "");
-            }
+        servientProducedThing.setActionHandler("setLogLevel", async (payload) => {
+            const level = (await Helpers.parseInteractionOutput(payload)) as LogLevel;
+            setLogLevel(level);
+            this.logLevel = level;
             return `Log level set to '${this.logLevel}'`;
         });
         servientProducedThing.setActionHandler("shutdown", async () => {
@@ -310,60 +302,4 @@ export default class DefaultServient extends Servient {
             process.removeListener("uncaughtException", listener);
         });
     }
-
-    // Save default loggers (needed when changing log levels)
-    private readonly loggers: any = {
-        warn: console.warn,
-        info: console.info,
-        debug: console.debug,
-    };
-
-    private setLogLevel(logLevel: string | number): void {
-        if (logLevel === "error" || logLevel === 0) {
-            console.warn = () => {
-                /* nothing */
-            };
-            console.info = () => {
-                /* nothing */
-            };
-            console.debug = () => {
-                /* nothing */
-            };
-
-            this.logLevel = "error";
-        } else if (logLevel === "warn" || logLevel === "warning" || logLevel === 1) {
-            console.warn = this.loggers.warn;
-            console.info = () => {
-                /* nothing */
-            };
-            console.debug = () => {
-                /* nothing */
-            };
-
-            this.logLevel = "warn";
-        } else if (logLevel === "info" || logLevel === 2) {
-            console.warn = this.loggers.warn;
-            console.info = this.loggers.info;
-            console.debug = () => {
-                /* nothing */
-            };
-
-            this.logLevel = "info";
-        } else if (logLevel === "debug" || logLevel === 3) {
-            console.warn = this.loggers.warn;
-            console.info = this.loggers.info;
-            console.debug = this.loggers.debug;
-
-            this.logLevel = "debug";
-        } else {
-            // Fallback to default ("info")
-            console.warn = this.loggers.warn;
-            console.info = this.loggers.info;
-            console.debug = () => {
-                /* nothing */
-            };
-
-            this.logLevel = "info";
-        }
-    }
 }

packages/cli/src/cli.ts

@@ -18,7 +18,7 @@ import DefaultServient, { ScriptOptions } from "./cli-default-servient";
 
 // tools
 import * as path from "path";
-import { Command, Argument } from "commander";
+import { Command, Argument, Option } from "commander";
 import Ajv, { ValidateFunction } from "ajv";
 import ConfigSchema from "./wot-servient-schema.conf.json";
 import { version } from "@node-wot/core/package.json";
@@ -27,8 +27,8 @@ import { buildConfig } from "./config-builder";
 import { loadCompiler, loadEnvVariables } from "./utils";
 import { runScripts } from "./script-runner";
 import { readdir } from "fs/promises";
-import * as logger from "debug";
 import { parseConfigFile, parseConfigParams, parseIp } from "./parsers";
+import { setLogLevel } from "./utils/set-log-level";
 
 const { error, info, warn, debug } = createLoggers("cli", "cli");
 
@@ -120,6 +120,12 @@ program
     .option("-ib, --inspect-brk [host]:[port]", "activate inspector on host:port (default: 127.0.0.1:9229)", parseIp)
     .option("-c, --client-only", "do not start any servers (enables multiple instances without port conflicts)")
     .option("-cp, --compiler <module>", "load module as a compiler")
+    .addOption(
+        new Option(
+            "-ll, --logLevel <string>",
+            "choose the desired log level. WARNING: if DEBUG env variable is specified this option gets overridden."
+        ).choices(["debug", "info", "warn", "error"])
+    )
     .option("-f, --config-file <file>", "load configuration from specified file", (value, previous) =>
         parseConfigFile(value, previous, schemaValidator)
     )
@@ -138,11 +144,11 @@ program.addArgument(
 );
 
 program.action(async function (_, options, cmd) {
+    // Allow user to personalized the env
     if (process.env.DEBUG == null) {
         // by default enable error logs and warnings
-        // user can override it using DEBUG env
-        logger.enable("node-wot:**:error");
-        logger.enable("node-wot:**:warn");
+        // user can override using command line option
+        setLogLevel(options.logLevel ?? "warn");
     }
 
     const args = cmd.args;
@@ -156,6 +162,8 @@ program.action(async function (_, options, cmd) {
 
     try {
         const config = await buildConfig(options, defaultFilePath, env);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        setLogLevel((config.log as any).level ?? options.logLevel ?? "warn");
         servient = new DefaultServient(options.clientOnly, config);
     } catch (err) {
         if ((err as NodeJS.ErrnoException)?.code !== "ENOENT" || options.configFile != null) {

packages/cli/src/utils/set-log-level.ts

@@ -0,0 +1,35 @@
+/********************************************************************************
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the W3C Software Notice and
+ * Document License (2015-05-13) which is available at
+ * https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
+ ********************************************************************************/
+import { createLoggers } from "@node-wot/core";
+import * as logger from "debug";
+
+export type LogLevel = keyof ReturnType<typeof createLoggers>;
+export function setLogLevel(level: LogLevel): void {
+    logger.disable();
+    switch (level) {
+        case "debug":
+            logger.enable("node-wot:*");
+            break;
+        case "info":
+            logger.enable("node-wot:**:error,node-wot:**:warn,node-wot:**:info");
+            break;
+        case "warn":
+            logger.enable("node-wot:**:error,node-wot:**:warn");
+            break;
+        case "error":
+            logger.enable("node-wot:**:error");
+            break;
+    }
+}