Move utils into src/util; move env utils from main.ts to src/utils/env.ts .

Author: junhaoliao

components/log-viewer-webui/server/src/DbManager.ts

@@ -25,7 +25,7 @@ import {
     StreamFileMongoDocument,
     StreamFilesCollection,
 } from "./typings/DbManager.js";
-import {sleep} from "./utils.js";
+import {sleep} from "./utils/time.js";
 
 
 /**

components/log-viewer-webui/server/src/main.ts

@@ -1,106 +1,12 @@
 import process from "node:process";
 
-import {config as dotenvConfig} from "dotenv";
-import {
-    FastifyLoggerOptions,
-    PinoLoggerOptions,
-} from "fastify/types/logger.js";
-
 import app from "./app.js";
+import {
+    ENV_TO_LOGGER,
+    parseEnvVars,
+} from "./utils/env.js";
 
 
-type NodeEnv = "development" | "production" | "test";
-
-const KNOWN_NODE_ENVS = new Set<NodeEnv>([
-    "development",
-    "production",
-    "test",
-]);
-
-const NODE_ENV_DEFAULT: NodeEnv = "development";
-
-/**
- * Maps known Node.js environments to Fastify logger configuration options.
- */
-const ENV_TO_LOGGER
-: Record<NodeEnv, boolean | FastifyLoggerOptions & PinoLoggerOptions> = Object.freeze({
-    development: {
-        transport: {
-            target: "pino-pretty",
-        },
-    },
-    production: true,
-    test: false,
-});
-
-/**
- * Validates whether the given string corresponds to a known Node.js environment.
- *
- * @param value
- * @return True if the `value` is a known Node.js environment; otherwise, false.
- */
-const isKnownNodeEnv = (value: string): value is NodeEnv => {
-    return KNOWN_NODE_ENVS.has(value as NodeEnv);
-};
-
-interface EnvVars {
-    NODE_ENV: NodeEnv;
-
-    HOST: string;
-    PORT: string;
-
-    CLP_DB_USER: string;
-    CLP_DB_PASS: string;
-}
-
-/**
- * Parses environment variables into config values for the application.
- *
- * @return
- * @throws {Error} if any required environment variable is undefined.
- */
-const parseEnvVars = (): EnvVars => {
-    dotenvConfig({
-        path: [
-            ".env.local",
-            ".env",
-        ],
-    });
-
-
-    const {
-        NODE_ENV, CLP_DB_USER, CLP_DB_PASS, HOST, PORT,
-    } = process.env;
-    const mandatoryEnvVars = {
-        CLP_DB_USER, CLP_DB_PASS, HOST, PORT,
-    } as EnvVars;
-
-
-    // Check for mandatory environment variables
-    for (const [key, value] of Object.entries(mandatoryEnvVars)) {
-        if ("undefined" === typeof value) {
-            throw new Error(`Environment variable ${key} must be defined.`);
-        }
-    }
-
-    // Sanitize other environment variables
-    const sanitizedEnvVars = {
-        NODE_ENV: NODE_ENV_DEFAULT as NodeEnv,
-    };
-
-    if ("undefined" === typeof NODE_ENV || false === isKnownNodeEnv(NODE_ENV)) {
-        console.log("NODE_ENV is not set, or the configured value is not known." +
-            `Using default: ${NODE_ENV_DEFAULT}`);
-    } else {
-        sanitizedEnvVars.NODE_ENV = NODE_ENV;
-    }
-
-    return {
-        ...mandatoryEnvVars,
-        ...sanitizedEnvVars,
-    };
-};
-
 /**
  * Sets up and runs the server.
  */

components/log-viewer-webui/server/src/utils/env.ts

@@ -0,0 +1,106 @@
+import process from "node:process";
+
+import {config as dotenvConfig} from "dotenv";
+import {
+    FastifyLoggerOptions,
+    PinoLoggerOptions,
+} from "fastify/types/logger.js";
+
+
+type NodeEnv = "development" | "production" | "test";
+
+const KNOWN_NODE_ENVS = new Set<NodeEnv>([
+    "development",
+    "production",
+    "test",
+]);
+
+const NODE_ENV_DEFAULT: NodeEnv = "development";
+
+/**
+ * Maps known Node.js environments to Fastify logger configuration options.
+ */
+const ENV_TO_LOGGER
+: Record<NodeEnv, boolean | FastifyLoggerOptions & PinoLoggerOptions> = Object.freeze({
+    development: {
+        transport: {
+            target: "pino-pretty",
+        },
+    },
+    production: true,
+    test: false,
+});
+
+/**
+ * Validates whether the given string corresponds to a known Node.js environment.
+ *
+ * @param value
+ * @return True if the `value` is a known Node.js environment; otherwise, false.
+ */
+const isKnownNodeEnv = (value: string): value is NodeEnv => {
+    return KNOWN_NODE_ENVS.has(value as NodeEnv);
+};
+
+interface EnvVars {
+    NODE_ENV: NodeEnv;
+
+    HOST: string;
+    PORT: string;
+
+    CLP_DB_USER: string;
+    CLP_DB_PASS: string;
+}
+
+/**
+ * Parses environment variables into config values for the application.
+ *
+ * @return
+ * @throws {Error} if any required environment variable is undefined.
+ */
+const parseEnvVars = (): EnvVars => {
+    dotenvConfig({
+        path: [
+            ".env.local",
+            ".env",
+        ],
+    });
+
+
+    const {
+        NODE_ENV, CLP_DB_USER, CLP_DB_PASS, HOST, PORT,
+    } = process.env;
+    const mandatoryEnvVars = {
+        CLP_DB_USER, CLP_DB_PASS, HOST, PORT,
+    } as EnvVars;
+
+
+    // Check for mandatory environment variables
+    for (const [key, value] of Object.entries(mandatoryEnvVars)) {
+        if ("undefined" === typeof value) {
+            throw new Error(`Environment variable ${key} must be defined.`);
+        }
+    }
+
+    // Sanitize other environment variables
+    const sanitizedEnvVars = {
+        NODE_ENV: NODE_ENV_DEFAULT as NodeEnv,
+    };
+
+    if ("undefined" === typeof NODE_ENV || false === isKnownNodeEnv(NODE_ENV)) {
+        console.log("NODE_ENV is not set, or the configured value is not known." +
+            `Using default: ${NODE_ENV_DEFAULT}`);
+    } else {
+        sanitizedEnvVars.NODE_ENV = NODE_ENV;
+    }
+
+    return {
+        ...mandatoryEnvVars,
+        ...sanitizedEnvVars,
+    };
+};
+
+export type {NodeEnv};
+export {
+    ENV_TO_LOGGER,
+    parseEnvVars,
+};