refactor(cli): improve configuration building and keep it sync with json schema

Author: relu91

package-lock.json

@@ -14,7 +14,7 @@
         }
     },
     "scripts": {
-        "build": "tsc -b && npm run build -w packages/browser-bundle",
+        "build": "npm run build:json -w packages/cli && tsc -b && npm run build -w packages/browser-bundle",
         "pretest": "npm run build",
         "start": "cd packages/cli && npm run start",
         "debug": "cd packages/cli && npm run debug",

package.json

@@ -0,0 +1 @@
+src/generated

packages/cli/.gitignore

@@ -0,0 +1,7 @@
+import { defineConfig, globalIgnores } from "eslint/config";
+import baseConfig from "../../eslint.config.mjs";
+
+export default defineConfig([
+    baseConfig,
+    globalIgnores(["src/generated/**.ts", "./import-json.js"])
+])

packages/cli/eslint.config.mjs

@@ -0,0 +1,11 @@
+const { readFileSync, writeFileSync } = require("fs");
+
+const schema = readFileSync("./src/wot-servient-schema.conf.json", "utf8");
+const package = readFileSync("./package.json", "utf8");
+const { version } = JSON.parse(package);
+
+writeFileSync(
+    "./src/generated/wot-servient-schema.conf.ts",
+    `const schema = ${schema.trimEnd()} as const \nexport default schema;`
+);
+writeFileSync("./src/generated/version.ts", `const version = "${version}" as const \nexport default version;`);

packages/cli/import-json.js

@@ -33,7 +33,8 @@
         "lodash": "^4.17.21"
     },
     "scripts": {
-        "build": "tsc -b",
+        "build:json": "node import-json.js",
+        "build": "npm run build:json && tsc -b",
         "start": "ts-node src/cli.ts",
         "debug": "node -r ts-node/register --inspect-brk=9229 src/cli.ts",
         "lint": "eslint .",
@@ -47,6 +48,7 @@
     "homepage": "https://github.com/eclipse-thingweb/node-wot/tree/master/packages/cli#readme",
     "keywords": [],
     "devDependencies": {
-        "@types/lodash": "^4.14.199"
+        "@types/lodash": "^4.14.199",
+        "json-schema-to-ts": "^3.1.1"
     }
 }

packages/cli/package.json

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 /********************************************************************************
  * Copyright (c) 2018 Contributors to the Eclipse Foundation
  *
@@ -29,89 +28,34 @@ import { ThingModelHelpers } from "@thingweb/thing-model";
 import { createContext, Script } from "vm";
 import { CompilerFunction } from "./compiler-function";
 import { LogLevel, setLogLevel } from "./utils/set-log-level";
+import { ConfigurationAfterDefaults } from "./configuration";
 
 const { debug, error, info } = createLoggers("cli", "cli-default-servient");
 
-// Helper function needed for `mergeConfigs` function
-function isObject(item: unknown) {
-    return item != null && typeof item === "object" && !Array.isArray(item);
-}
-
-/**
- * Helper function merging default parameters into a custom config file.
- *
- * @param {object} target - an object containing default config parameters
- * @param {object} source - an object containing custom config parameters
- *
- * @return {object} The new config file containing both custom and default parameters
- */
-function mergeConfigs(target: any, source: any): any {
-    const output = Object.assign({}, target);
-    Object.keys(source).forEach((key) => {
-        if (!(key in target)) {
-            Object.assign(output, { [key]: source[key] });
-        } else {
-            if (isObject(target[key]) && isObject(source[key])) {
-                output[key] = mergeConfigs(target[key], source[key]);
-            } else {
-                Object.assign(output, { [key]: source[key] });
-            }
-        }
-    });
-    return output;
-}
 export interface ScriptOptions {
     argv?: Array<string>;
     compiler?: CompilerFunction;
     env?: Record<string, string>;
 }
 export default class DefaultServient extends Servient {
-    private static readonly defaultConfig = {
-        servient: {
-            clientOnly: false,
-            scriptAction: false,
-        },
-        http: {
-            port: 8080,
-            allowSelfSigned: false,
-        },
-        coap: {
-            port: 5683,
-        },
-    };
-
     private uncaughtListeners: Array<NodeJS.UncaughtExceptionListener> = [];
     private runtime: typeof WoT | undefined;
-    public readonly config: any;
+    public readonly config: ConfigurationAfterDefaults;
     // current log level
     public logLevel = "info";
 
-    public constructor(clientOnly: boolean, config?: any) {
+    public constructor(config: ConfigurationAfterDefaults) {
         super();
 
-        // init config
-        this.config =
-            typeof config === "object"
-                ? mergeConfigs(DefaultServient.defaultConfig, config)
-                : DefaultServient.defaultConfig;
-
-        // apply flags
-        if (clientOnly) {
-            this.config.servient ??= {};
-            this.config.servient.clientOnly = true;
-        }
+        this.config = config;
 
         // load credentials from config
         this.addCredentials(this.config.credentials);
 
-        // remove secrets from original for displaying config (already added)
-        if (this.config.credentials != null) {
-            delete this.config.credentials;
-        }
-
         // display
         debug("DefaultServient configured with");
-        debug(`${this.config}`);
+        // remove secrets from original for displaying config
+        debug(`%O`, { ...this.config, credentials: null });
 
         // apply config
         if (typeof this.config.servient.staticAddress === "string") {

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

@@ -20,21 +20,22 @@ import DefaultServient, { ScriptOptions } from "./cli-default-servient";
 import * as path from "path";
 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";
+import ConfigSchema from "./generated/wot-servient-schema.conf";
+import version from "./generated/version";
 import { createLoggers } from "@node-wot/core";
-import { buildConfig } from "./config-builder";
 import { loadCompiler, loadEnvVariables } from "./utils";
 import { runScripts } from "./script-runner";
 import { readdir } from "fs/promises";
 import { parseConfigFile, parseConfigParams, parseIp } from "./parsers";
 import { setLogLevel } from "./utils/set-log-level";
+import { buildConfig, buildConfigFromFile, Configuration, defaultConfiguration } from "./configuration";
+import { cloneDeep } from "lodash";
 
 const { error, info, warn, debug } = createLoggers("cli", "cli");
 
 const program = new Command();
-const ajv = new Ajv({ strict: true });
-const schemaValidator = ajv.compile(ConfigSchema) as ValidateFunction;
+const ajv = new Ajv({ strict: true, allErrors: true });
+const schemaValidator = ajv.compile(ConfigSchema) as ValidateFunction<Configuration>;
 const defaultFile = "wot-servient.conf.json";
 const baseDir = ".";
 
@@ -127,7 +128,7 @@ program
         ).choices(["debug", "info", "warn", "error"])
     )
     .option("-f, --config-file <file>", "load configuration from specified file", (value, previous) =>
-        parseConfigFile(value, previous, schemaValidator)
+        parseConfigFile(value, previous)
     )
     .option(
         "-p, --config-params <param...>",
@@ -148,6 +149,7 @@ program.action(async function (_, options, cmd) {
     if (process.env.DEBUG == null) {
         // by default enable error logs and warnings
         // user can override using command line option
+        // or later by config file.
         setLogLevel(options.logLevel ?? "warn");
     }
 
@@ -161,18 +163,21 @@ program.action(async function (_, options, cmd) {
     debug("command line environment variables", args);
 
     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);
+        const config = await buildConfigFromFile(options, defaultFilePath, env, schemaValidator);
+        setLogLevel(options.logLevel ?? config.logLevel);
+        config.servient.clientOnly = options.clientOnly ?? config.servient.clientOnly;
+        servient = new DefaultServient(config);
     } catch (err) {
         if ((err as NodeJS.ErrnoException)?.code !== "ENOENT" || options.configFile != null) {
-            error("WoT-Servient config file error. %O", err);
+            error("WoT-Servient configuration file error:\n%O\nClose.", err);
             process.exit((err as NodeJS.ErrnoException).errno ?? 1);
         }
 
         warn(`WoT-Servient using defaults as %s does not exist`, defaultFile);
-        servient = new DefaultServient(options.clientOnly);
+
+        const config = await buildConfig(options, cloneDeep(defaultConfiguration), env, schemaValidator);
+        config.servient.clientOnly = options.clientOnly ?? config.servient.clientOnly;
+        servient = new DefaultServient(config);
     }
 
     await servient.start();