perf: upgrade for new lavateinn

Author: supersonictw

.env.default

@@ -1,8 +1,9 @@
-# node env ('production' or 'development')
-NODE_ENV="development"
-
 # general
-TRUST_PROXY="loopback" # as known as trust proxy of express.js ('loopback', 'linklocal', 'uniquelocal' or ip addresses, empty to disable)
+NODE_ENV="development" # node environment ('development', 'production')
+RUNTIME_ENV="native" # runtime environment ('native' or 'container')
+
+# protocol
+TRUST_PROXY="_disabled_" # as known as trust proxy of express.js ('loopback', 'linklocal', 'uniquelocal' or ip addresses, empty or '_disabled_' to disable)
 ENABLED_PROTOCOLS="http" # enable protocols ('http', 'https' or both)
 ENABLED_REDIRECT_HTTP_HTTPS="no" # redirect http to https ('yes' or 'no')
 
@@ -13,12 +14,14 @@ INSTANCE_URL="http://localhost:3000" # the url of the instance
 # logging
 LOGGING_LEVEL="info" # as known as logging level of winston ('error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly')
 LOGGING_CONSOLE="yes" # logging into console ('yes' or 'no')
-LOGGING_FILE_PATH="data/lavateinn.log" # logging into file (empty to disable)
-LOGGING_HTTP_URL="http://localhost:3000/v1/logs" # logging into http (empty to disable)
+LOGGING_FILE_PATH="data/lavateinn.log" # logging into file (empty or '_disabled_' to disable)
+LOGGING_HTTP_URL="_disabled_" # logging into http (empty or '_disabled_' to disable)
 
 # database
 SEQUELIZE_URL="sqlite:data/lavateinn.db" # sequelize url
 AMPQ_URL="amqp://localhost" # amqp url
+REDIS_URL="redis://localhost:6379" # redis url
+REDIS_NAMESPACE="lavateinn" # the redis namespace of the application
 
 # http
 HTTP_PORT="3000"

src/config.mjs

@@ -14,7 +14,12 @@ export function runLoader() {
     const dotenvPathInstance = new URL("../.env", import.meta.url);
 
     const isDotenvExists = existsSync(dotenvPathInstance);
-    const isAppConfigured = get("APP_CONFIGURED") === "1";
+
+    // Check the application configured or not,
+    // '1' means it won't check the .env file exists.
+    // It can't be set by any .env file, because it'll check
+    // the system environment variables directly before loading the .env files.
+    const isAppConfigured = process.env["APP_CONFIGURED"] === "1";
 
     if (!isDotenvExists && !isAppConfigured) {
         console.error(
@@ -42,7 +47,7 @@ export function runLoader() {
  * @returns {string} The NODE_ENV value.
  */
 export function getNodeEnv() {
-    return getFallback("NODE_ENV", "development");
+    return get("NODE_ENV");
 }
 
 /**
@@ -51,7 +56,7 @@ export function getNodeEnv() {
  * @returns {string} The RUNTIME_ENV value.
  */
 export function getRuntimeEnv() {
-    return getFallback("RUNTIME_ENV", "native");
+    return get("RUNTIME_ENV");
 }
 
 /**
@@ -60,7 +65,7 @@ export function getRuntimeEnv() {
  * @returns {string} The INSTANCE_MODE value.
  */
 export function getInstanceMode() {
-    return getFallback("INSTANCE_MODE", "single");
+    return get("INSTANCE_MODE");
 }
 
 /**
@@ -82,13 +87,17 @@ export function isCluster() {
 }
 
 /**
- * Shortcut to get config value.
+ * Get the value from config or with an error thrown.
  * @module src/config
  * @param {string} key - The config key.
  * @returns {string} The config value.
+ * @throws {Error} If value is undefined, throw an error.
  */
 export function get(key) {
     const value = process.env[key];
+    if (value === undefined) {
+        throw new Error(`config key ${key} is undefined`);
+    }
     if (value === "_disabled_") {
         return "";
     }
@@ -102,7 +111,7 @@ export function get(key) {
  * @returns {boolean} The boolean value.
  */
 export function getEnabled(key) {
-    return getMust(key) === "yes";
+    return get(key) === "yes";
 }
 
 /**
@@ -113,34 +122,8 @@ export function getEnabled(key) {
  * @returns {string[]} The array value.
  */
 export function getSplited(key, separator = ",") {
-    return getMust(key).
+    return get(key).
         split(separator).
         filter((i) => i).
         map((i) => i.trim());
 }
-
-/**
- * Get the value from config with error thrown.
- * @module src/config
- * @param {string} key - The config key.
- * @returns {string} The expected value.
- * @throws {Error} If value is undefined, throw an error.
- */
-export function getMust(key) {
-    const value = get(key);
-    if (value === undefined) {
-        throw new Error(`config key ${key} is undefined`);
-    }
-    return value;
-}
-
-/**
- * Get the value from config with fallback.
- * @module src/config
- * @param {string} key - The config key.
- * @param {string} fallback - The fallback value.
- * @returns {string} The expected value.
- */
-export function getFallback(key, fallback) {
-    return get(key) || fallback;
-}

src/execute.mjs

@@ -3,7 +3,7 @@
 
 // Import modules
 import {
-    getMust,
+    get,
     getSplited,
 } from "./config.mjs";
 
@@ -37,8 +37,8 @@ import {
  */
 function setupHttpProtocol(app) {
     const protocol = "http";
-    const hostname = getMust("HTTP_HOSTNAME");
-    const port = parseInt(getMust("HTTP_PORT"));
+    const hostname = get("HTTP_HOSTNAME");
+    const port = parseInt(get("HTTP_PORT"));
 
     const httpServer = http.createServer({}, app);
     httpServer.listen(port, hostname);
@@ -54,12 +54,12 @@ function setupHttpProtocol(app) {
  */
 async function setupHttpsProtocol(app) {
     const protocol = "https";
-    const hostname = getMust("HTTPS_HOSTNAME");
-    const port = parseInt(getMust("HTTPS_PORT"));
+    const hostname = get("HTTPS_HOSTNAME");
+    const port = parseInt(get("HTTPS_PORT"));
 
     const [key, cert] = await Promise.all([
-        readFile(getMust("HTTPS_KEY_PATH")),
-        readFile(getMust("HTTPS_CERT_PATH")),
+        readFile(get("HTTPS_KEY_PATH")),
+        readFile(get("HTTPS_CERT_PATH")),
     ]);
 
     const httpsServer = https.createServer({key, cert}, app);

src/init/const.mjs

@@ -7,7 +7,7 @@ export const APP_NAME = "earendel";
 export const APP_DESCRIPTION = "Simple cache server for DevOps.";
 
 export const APP_VERSION = "latest"; // SemVer
-export const LAV_VERSION = "2025.01.29"; // CalVer, UTC +8
+export const LAV_VERSION = "2025.01.30"; // CalVer, UTC +8
 
 export const APP_AUTHOR_NAME = "Star Inc.";
 export const APP_AUTHOR_URL = "https://starinc.xyz";

src/init/instance.mjs

@@ -21,25 +21,20 @@ import {
 
 import {
     isCluster,
-    getMust,
+    get,
 } from "../config.mjs";
 
 // Define instance id
 export const instanceId = `${APP_NAME}#${nanoid()}`;
 
 // Define instance http url (aka. canonical url)
-export const instanceUrl = getMust("INSTANCE_URL");
+export const instanceUrl = get("INSTANCE_URL");
 
 // Define instance role (single, primary or worker)
 export const instanceRole = isCluster() ? (
     cluster.isPrimary ? "primary" : "worker"
 ) : "single";
 
-// Earendel only can be allowed to use "single" mode
-if (instanceRole !== "single") {
-    throw new Error("earendel only can be allowed to use \"single\" mode");
-}
-
 // Define instance context
 export const instanceContext = new Map();
 

src/init/logger.mjs

@@ -5,13 +5,13 @@
 
 // Import modules
 import winston from "winston";
-import {getMust, getEnabled} from "../config.mjs";
+import {get, getEnabled} from "../config.mjs";
 
 // Read configuration
-const loggingLevel = getMust("LOGGING_LEVEL");
+const loggingLevel = get("LOGGING_LEVEL");
 const isLoggingConsole = getEnabled("LOGGING_CONSOLE");
-const loggingFilePath = getMust("LOGGING_FILE_PATH");
-const loggingHttpUrl = getMust("LOGGING_HTTP_URL");
+const loggingFilePath = get("LOGGING_FILE_PATH");
+const loggingHttpUrl = get("LOGGING_HTTP_URL");
 
 // Define logging configuration
 const useLoggingConsole = () => isLoggingConsole &&

src/middleware/cors.mjs

@@ -4,11 +4,11 @@
 // Cross-Origin Resource Sharing
 
 // Import modules
-import {getMust} from "../config.mjs";
+import {get} from "../config.mjs";
 import cors from "cors";
 
 // Read configuration
-const origin = getMust("CORS_ORIGIN");
+const origin = get("CORS_ORIGIN");
 
 // Export (function)
 export default cors({origin});

src/middleware/origin.mjs

@@ -5,7 +5,7 @@
 // if not, interrupt it.
 
 // Import modules
-import {getMust} from "../config.mjs";
+import {get} from "../config.mjs";
 import {express, StatusCodes} from "../init/express.mjs";
 import {useLogger} from "../init/logger.mjs";
 
@@ -34,7 +34,7 @@ export default function middlewareOrigin(req, res, next) {
 
     // Get actual and expected URLs
     const actualUrl = req.header("origin");
-    const expectedUrl = getMust("CORS_ORIGIN");
+    const expectedUrl = get("CORS_ORIGIN");
 
     // Origin match
     if (actualUrl === expectedUrl) {