feat: introduce environment variable type-checking

Author: virtual-designer

src/framework/typescript/app/Application.ts

@@ -51,7 +51,8 @@ class Application {
 
     public constructor(
         public readonly rootPath: string,
-        public readonly projectRootPath: string
+        public readonly projectRootPath: string,
+        public readonly version: string
     ) {
         this.container = Container.getInstance();
     }

src/framework/typescript/commands/Context.ts

@@ -18,6 +18,7 @@
  */
 
 import type { GuildConfig } from "@main/schemas/GuildConfigSchema";
+import type { SystemConfig } from "@main/schemas/SystemConfigSchema";
 import type {
     ChatInputCommandInteraction,
     ContextMenuCommandInteraction,
@@ -109,6 +110,10 @@ abstract class Context<T extends CommandMessage = CommandMessage> {
         return Application.current().service("configManager").config[this.guildId];
     }
 
+    public get systemConfig(): SystemConfig {
+        return Application.current().service("configManager").systemConfig;
+    }
+
     public abstract get userId(): Snowflake;
     public abstract get user(): User;
 

src/framework/typescript/env/Environment.ts

@@ -0,0 +1,36 @@
+import type { ZodSchema, z } from "zod";
+
+class Environment {
+    public static isProduction(): boolean {
+        return process.env.NODE_ENV === "production" || process.env.NODE_ENV === "prod";
+    }
+
+    public static isDevelopment(): boolean {
+        return process.env.NODE_ENV === "development" || process.env.NODE_ENV === "dev";
+    }
+
+    public static isTest(): boolean {
+        return process.env.NODE_ENV === "test";
+    }
+
+    public static isBun(): boolean {
+        return !!process.isBun;
+    }
+
+    public static variables(): NodeJS.ProcessEnv {
+        return process.env;
+    }
+
+    /**
+     * Parse environment variables using a Zod schema.
+     *
+     * @param schema The Zod schema to use.
+     * @returns The parsed environment variables.
+     * @throws {z.ZodError} If the environment variables do not match the schema.
+     */
+    public static parseVariables<T extends ZodSchema>(schema: T): z.infer<T> {
+        return schema.parse(this.variables());
+    }
+}
+
+export default Environment;

src/main/typescript/core/DiscordKernel.ts

@@ -21,6 +21,7 @@ import type { AnyConstructor } from "@framework/container/Container";
 import Container from "@framework/container/Container";
 import Kernel from "@framework/core/Kernel";
 import { Logger } from "@framework/log/Logger";
+import { createAxiosClient } from "@main/utils/axios";
 import metadata from "@root/package.json";
 import axios from "axios";
 import { spawn } from "child_process";
@@ -159,6 +160,8 @@ class DiscordKernel extends Kernel {
                 key: binding.key
             });
         }
+
+        createAxiosClient(application);
     }
 
     public getClient() {

src/main/typescript/env/env.ts

@@ -0,0 +1,5 @@
+import Environment from "@framework/env/Environment";
+import type { EnvironmentVariableRecord } from "@main/schemas/EnvironmentVariableSchema";
+import { EnvironmentVariableSchema } from "@main/schemas/EnvironmentVariableSchema";
+
+export const env: EnvironmentVariableRecord = Environment.parseVariables(EnvironmentVariableSchema);

src/main/typescript/index.ts

@@ -21,12 +21,21 @@ import "module-alias/register";
 import "reflect-metadata";
 
 import Application from "@framework/app/Application";
+import { version } from "@root/package.json";
 import path from "path";
 import DiscordKernel from "./core/DiscordKernel";
 
 async function main() {
     Application.setupGlobals();
-    const application = new Application(path.resolve(__dirname), path.resolve(__dirname, "../../.."));
+
+    const rootDirectoryPath = path.resolve(__dirname);
+    const projectRootDirectoryPath = path.resolve(__dirname, "../../..");
+    const application = new Application(
+        rootDirectoryPath,
+        projectRootDirectoryPath,
+        process.env.SUDOBOT_VERSION ?? version
+    );
+
     await application.run(new DiscordKernel());
 }
 

src/main/typescript/schemas/EnvironmentVariableSchema.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+
+export const EnvironmentVariableSchema = z.object({
+    TOKEN: z.string(),
+    CLIENT_ID: z.string(),
+    CLIENT_SECRET: z.string(),
+    DB_URL: z.string(),
+    JWT_SECRET: z.string(),
+    JWT_ISSUER: z.string().default("SudoBot"),
+    HOME_GUILD_ID: z.string(),
+    SUDO_ENV: z.enum(["dev", "prod"]).optional(),
+    NODE_ENV: z.enum(["dev", "prod", "development", "production", "test"]).default("production"),
+    DEBUG: z.enum(["1", "0"]).optional(),
+    BASE_SERVER_URL: z.string().optional(),
+    DISCORD_OAUTH2_REDIRECT_URI: z.string().optional(),
+    DISCORD_OAUTH2_RP_REDIRECT_URI: z.string().optional(),
+    FRONTEND_URL: z.string().optional(),
+    SUDO_PREFIX: z.string().optional(),
+    ERROR_WEBHOOK_URL: z.string().optional(),
+    BACKUP_CHANNEL_ID: z.string().optional(),
+    FRONTEND_AUTH_KEY: z.string().optional(),
+    CREDENTIAL_SERVER: z.string().optional(),
+    PRIVATE_BOT_MODE: z.literal("true").optional(),
+    EXTENSIONS_DIRECTORY: z.string().optional(),
+    NO_GENERATE_CONFIG_SCHEMA: z.string().optional(),
+    NSFWJS_MODEL_URL: z.string().optional(),
+    NSFWJS_MODEL_IMAGE_SIZE: z.string().optional(),
+    BACKUP_STORAGE: z.string().optional(),
+    SUPPRESS_LOGS: z.string().optional(),
+    CAT_API_TOKEN: z.string().optional(),
+    DOG_API_TOKEN: z.string().optional(),
+    HTTP_USER_AGENT: z
+        .string()
+        .optional()
+        .nullable()
+        .transform(value => (value === "null" ? null : value))
+});
+
+export type EnvironmentVariableRecord = z.infer<typeof EnvironmentVariableSchema>;

src/main/typescript/types/global/env.d.ts

@@ -17,40 +17,10 @@
  * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
  */
 
-namespace NodeJS {
-    interface ProcessEnv {
-        TOKEN: string;
-        CLIENT_ID: string;
-        HOME_GUILD_ID: string;
-        DB_URL: string;
-        JWT_SECRET: string;
-        ENV?: "dev" | "prod";
-        SUDO_ENV?: "dev" | "prod";
-        NODE_ENV?: "dev" | "prod" | "development" | "production";
-        DEBUG?: "1" | "0";
-        CLIENT_SECRET: string;
-        BASE_SERVER_URL: string;
-        DISCORD_OAUTH2_REDIRECT_URI: string;
-        DISCORD_OAUTH2_RP_REDIRECT_URI: string;
-        FRONTEND_URL: string;
-        SUDO_PREFIX?: string;
-        ERROR_WEKHOOK_URL?: string;
-        BACKUP_CHANNEL_ID?: string;
-        JWT_ISSUER: string;
-        JWT_SECRET: string;
-        FRONTEND_AUTH_KEY: string;
-        CREDENTIAL_SERVER?: string;
-        PRIVATE_BOT_MODE?: string;
-        GEMINI_API_KEY?: string;
-        GEMINI_API_MODEL_CODE?: string;
-        OPENAI_API_KEY?: string;
-        OPENAI_MODEL_ID?: string;
-        EXTENSIONS_DIRECTORY?: string;
-        OPENAI_MODERATION?: string;
-        NO_GENERATE_CONFIG_SCHEMA?: string;
-        NSFWJS_MODEL_URL?: string;
-        NSFWJS_MODEL_IMAGE_SIZE?: string;
-        BACKUP_STORAGE?: string;
-        SUPPRESS_LOGS?: string;
+import type { EnvironmentVariableRecord } from "@main/schemas/EnvironmentVariableSchema";
+
+declare global {
+    namespace NodeJS {
+        interface ProcessEnv extends EnvironmentVariableRecord {}
     }
 }

src/main/typescript/utils/axios.ts

@@ -0,0 +1,24 @@
+import type Application from "@framework/app/Application";
+import { env } from "@main/env/env";
+import type { AxiosInstance } from "axios";
+import axios from "axios";
+
+let _axiosClient: AxiosInstance;
+
+export const createAxiosClient = (application: Application) => {
+    const configUserAgent =
+        env.HTTP_USER_AGENT === null
+            ? undefined
+            : env.HTTP_USER_AGENT ?? `SudoBot/${application.version}`;
+
+    _axiosClient = axios.create({
+        headers: {
+            "Accept-Encoding": process.isBun ? "gzip" : undefined,
+            "User-Agent": configUserAgent
+        }
+    });
+
+    return _axiosClient;
+};
+
+export const getAxiosClient = () => _axiosClient;