refactor!: re-implement initialization code

notwindstone · notwindstone · commit 31baba4af664 · 2025-11-13T17:14:09.000+03:00
diff --git a/docs/README.md b/docs/README.md
@@ -292,7 +292,7 @@
 
 <div align="center">
 
-<img width="128" height="128" align="center" src="../src-tauri/icons/128x128.png" alt="Favicon">
+<img width="128" height="128" align="center" src="../src-tauri/icons/128x128.png" alt="Tendou Arisu's halo recreation (Blue Archive)">
 
 <h1>
 <a style="color:#a1fee4" href="https://github.com/kaede-basement/kaede">Kaede</a>
diff --git a/src/App.vue b/src/App.vue
@@ -28,6 +28,9 @@ const LogViewer = defineAsyncComponent(
 const ExtensionLoader = defineAsyncComponent(
   () => import("@/components/general/extensions/ExtensionLoader.vue"),
 );
+const DevelopmentMode = defineAsyncComponent(
+  () => import("@/components/general/development-mode/DevelopmentMode.vue"),
+);
 
 /**
  * Contains all global application states.
@@ -115,6 +118,7 @@ onBeforeMount(async () => {
           <LogViewer v-if="globalStates.logs.show" />
         </Transition>
 
+        <DevelopmentMode v-if="globalStates.development.enabled" />
         <NonBundledClasses />
       </Layout>
     </template>
diff --git a/src/components/general/development-mode/DevelopmentMode.vue b/src/components/general/development-mode/DevelopmentMode.vue
@@ -0,0 +1,28 @@
+<script setup lang="ts">
+import { inject, onUnmounted, watchEffect } from "vue";
+
+import { GlobalStatesContextKey } from "@/constants/application.ts";
+import { DevelopmentModeHelpers } from "@/lib/development-mode-helpers";
+import type { ContextGlobalStatesType } from "@/types/application/global-states.type.ts";
+
+const globalStates = inject<ContextGlobalStatesType>(GlobalStatesContextKey);
+
+watchEffect(() => {
+  if (globalStates?.development?.enableDebugMode) {
+    DevelopmentModeHelpers.enableDebugMode();
+
+    return;
+  }
+
+  DevelopmentModeHelpers.disableDebugMode();
+});
+
+onUnmounted(() => {
+  DevelopmentModeHelpers.disableDebugMode();
+});
+</script>
+
+<template>
+  <NativeReloadKeyBinds v-if="globalStates?.development?.enableNativeReloadKeyBinds" />
+  <FpsCounter v-if="globalStates?.development?.showFPS" />
+</template>
diff --git a/src/components/home/Home.vue b/src/components/home/Home.vue
@@ -2,6 +2,7 @@
 import Image from "@/components/general/base/Image.vue";
 import MaterialRipple from "@/components/general/base/MaterialRipple.vue";
 import PageWrapper from "@/components/general/layout/PageWrapper.vue";
+import GlobalStateHelpers from "@/lib/global-state-helpers";
 </script>
 
 <template>
@@ -36,7 +37,7 @@ import PageWrapper from "@/components/general/layout/PageWrapper.vue";
           >
             <Image
               id="__"
-              class-names="rounded-md size-12 transition-none p-1"
+              class-names="rounded-md size-12 p-1"
               src="https://media.forgecdn.net/avatars/thumbnails/286/772/64/64/637305737753885398.png"
               alt="Fabulously optimized"
             />
@@ -68,7 +69,11 @@ import PageWrapper from "@/components/general/layout/PageWrapper.vue";
           </button>
         </div>
         <div class="flex flex-nowrap gap-1 p-2">
-          <button class="relative w-fit rounded-l-md rounded-r-sm bg-white px-4 py-2 text-black">
+          <button @click="() => GlobalStateHelpers.change('development', {
+            ...GlobalStateHelpers.get().development,
+            'enabled'        : true,
+            'enableDebugMode': !GlobalStateHelpers.get().development.enableDebugMode,
+          })" class="relative w-fit rounded-l-md rounded-r-sm bg-white px-4 py-2 text-black">
             <span class="block">
               Launch
             </span>
diff --git a/src/constants/ascii-art.ts b/src/constants/ascii-art.ts
@@ -2,20 +2,20 @@ import { arch, platform, version } from "@tauri-apps/plugin-os";
 
 import { ApplicationName } from "@/constants/application.ts";
 
-export function getASCIIArt(portable: boolean): string {
+export function getASCIIArt(portable: boolean, debug: boolean): string {
   return (
     "\n    __                  __   " +
     "  me@" + ApplicationName.toLowerCase() +
     "\n   / /______ ____  ____/ /__ " +
-    "  os     " + platform() + " " + version() +
+    "  os    " + platform() + " " + version() +
     "\n  / //_/ __ `/ _ \\/ __  / _ \\" +
-    "  arch   " + arch() +
+    "  arch  " + arch() +
     "\n / ,< / /_/ /  __/ /_/ /  __/" +
-    "  mode   " + (portable ? "portable" : "non-portable") +
+    "  mode  " + (portable ? "portable" : "non-portable") +
     "\n/_/|_|\\__,_/\\___/\\__,_/\\___/ " +
-    "  online " + (
-      (navigator?.onLine ?? "unknown") ? "yes" : "no"
+    "  debug " + (
+      debug ? "yes" : "no"
     ) +
     "\n                             "
   );
-}
+}
diff --git a/src/constants/hooks.ts b/src/constants/hooks.ts
@@ -6,10 +6,11 @@ export const HookMappings = {
   "logs"            : "onLogsChange",
   "sidebarItems"    : "onSidebarItemsChange",
   "contextMenuItems": "onContextMenuItemsChange",
+  "development"     : "onDevelopmentChange",
 } as const;
 export const HookMappingKeys = Object.keys(HookMappings) as Array<keyof typeof HookMappings>;
 
 export const HookResponseStatus = {
   "Stop"    : "stop",
   "Continue": "continue",
-} as const;
+} as const;
diff --git a/src/declarations.ts b/src/declarations.ts
@@ -175,10 +175,18 @@ declare global {
           >;
           "after": HookReturnType<GlobalStatesType["contextMenuItems"], "nothing">;
         };
+        "onDevelopmentChange": {
+          "before": HookReturnType<
+            GlobalStatesType["development"],
+            GlobalStatesType["development"],
+            "non-promise"
+          >;
+          "after": HookReturnType<GlobalStatesType["development"], "nothing">;
+        };
       };
     };
   }
 }
 
 /* Export the Kaede namespace type */
-export type KaedeNamespaceType = Window["__KAEDE__"];
+export type KaedeNamespaceType = Window["__KAEDE__"];
diff --git a/src/lib/configs/index.ts b/src/lib/configs/index.ts
@@ -1,9 +1,11 @@
 import { getConfigFile } from "@/lib/configs/scopes/get-config-file.ts";
 import { getDefaultConfig } from "@/lib/configs/scopes/get-default-config.ts";
+import { getSafeConfigFile } from "@/lib/configs/scopes/get-safe-config-file.ts";
 import { initializeConfigFile } from "@/lib/configs/scopes/initialize-config-file.ts";
 
 export default {
   "get"       : getConfigFile,
   "getDefault": getDefaultConfig,
+  "getSafe"   : getSafeConfigFile,
   "initialize": initializeConfigFile,
-} as const;
+} as const;
diff --git a/src/lib/configs/scopes/get-config-file.ts b/src/lib/configs/scopes/get-config-file.ts
@@ -10,14 +10,19 @@ import { log } from "@/lib/logging/scopes/log.ts";
 import Schemas from "@/lib/schemas";
 import type { ConfigType } from "@/types/application/config.type.ts";
 
-export async function getConfigFile(portableStatus?: boolean): Promise<ConfigType> {
+export async function getConfigFile(passedBaseDirectory?: string): Promise<ConfigType> {
   const hooksArray = window[ApplicationNamespace].hooks.getConfigFile.before;
+  let baseDirectory: string | undefined = passedBaseDirectory;
 
-  log.debug("Checking if launcher is in portable version");
-  const portable = portableStatus ?? await General.checkIsPortable();
+  if (!baseDirectory) {
+    log.debug("No base directory was passed");
+    log.debug("Checking if launcher is in portable version");
+    const portable = await General.checkIsPortable();
+
+    log.debug("Getting base directory");
+    baseDirectory = await General.getBaseDirectory(portable);
+  }
 
-  log.debug("Getting base directory");
-  const baseDirectory = await General.getBaseDirectory(portable);
   const configFileDirectory = await join(baseDirectory, FileStructure.Config.Name);
 
   log.debug(log.templates.hooks.iterate.start(
diff --git a/src/lib/configs/scopes/get-default-config.ts b/src/lib/configs/scopes/get-default-config.ts
@@ -32,5 +32,9 @@ export async function getDefaultConfig(): Promise<ConfigType> {
     "locale"               : "en",
     "minecraftWindowHeight": 480,
     "minecraftWindowWidth" : 854,
+    "development"          : {
+      "enableDebugMode": true,
+    },
+    "showBeforeInitialization": false,
   };
 }
diff --git a/src/lib/configs/scopes/get-safe-config-file.ts b/src/lib/configs/scopes/get-safe-config-file.ts
@@ -0,0 +1,17 @@
+import Configs from "@/lib/configs";
+import Errors from "@/lib/errors";
+import { log } from "@/lib/logging/scopes/log.ts";
+import type { ConfigType } from "@/types/application/config.type.ts";
+
+export async function getSafeConfigFile(baseDirectory?: string): Promise<ConfigType> {
+  try {
+    log.info("Getting a config file");
+
+    return Configs.get(baseDirectory);
+  } catch (error: unknown) {
+    log.error("Failed to get a config file:", Errors.prettify(error));
+    log.info("Getting a default config");
+
+    return Configs.getDefault();
+  }
+}
diff --git a/src/lib/development-mode-helpers/index.ts b/src/lib/development-mode-helpers/index.ts
@@ -0,0 +1,7 @@
+import { disableDebugMode } from "@/lib/development-mode-helpers/scopes/disable-debug-mode.ts";
+import { enableDebugMode } from "@/lib/development-mode-helpers/scopes/enable-debug-mode.ts";
+
+export const DevelopmentModeHelpers = {
+  disableDebugMode,
+  enableDebugMode,
+} as const;
diff --git a/src/lib/development-mode-helpers/scopes/disable-debug-mode.ts b/src/lib/development-mode-helpers/scopes/disable-debug-mode.ts
@@ -0,0 +1,6 @@
+import { log } from "@/lib/logging/scopes/log.ts";
+
+export function disableDebugMode(): void {
+  log.debug = log["__debug-undefined"];
+  log.info("Debug mode disabled");
+}
diff --git a/src/lib/development-mode-helpers/scopes/enable-debug-mode.ts b/src/lib/development-mode-helpers/scopes/enable-debug-mode.ts
@@ -0,0 +1,6 @@
+import { log } from "@/lib/logging/scopes/log.ts";
+
+export function enableDebugMode(): void {
+  log.debug = log["__debug-defined"];
+  log.info("Debug mode enabled");
+}
diff --git a/src/lib/general/scopes/initialize-launcher.ts b/src/lib/general/scopes/initialize-launcher.ts
@@ -1,33 +1,19 @@
 import { getCurrentWebviewWindow } from "@tauri-apps/api/webviewWindow";
 
-import Configs from "@/lib/configs";
-import Errors from "@/lib/errors";
 import { log } from "@/lib/logging/scopes/log.ts";
 import type { ConfigType } from "@/types/application/config.type.ts";
 
-export async function initializeLauncher(portable: boolean): Promise<void> {
-  let config: ConfigType;
-
-  try {
-    log.debug("Getting a config file");
-    config = await Configs.get(portable);
-  } catch (error: unknown) {
-    log.error("Failed to get a config file:", Errors.prettify(error));
-    log.debug("Getting default config");
-    config = await Configs.getDefault();
+export async function initializeLauncher(
+  config: ConfigType,
+): Promise<void> {
+  if (!config.showBeforeInitialization) {
+    /*
+     * Webview window is still hidden, so make it visible now
+     * Because frontend is already loaded by this time
+     */
+    log.debug("Making current webview window visible");
+    await getCurrentWebviewWindow().show();
   }
 
-  log.debug(
-    "Config contents:",
-    "\n" + JSON.stringify(config, null, 2),
-  );
-
-  /*
-   * Webview window was hidden by default, so make it visible now
-   * Because frontend is already loaded by this time
-   */
-  log.debug("Making current webview window visible");
-  await getCurrentWebviewWindow().show();
-
   log.info("Launcher successfully started");
 }
diff --git a/src/lib/global-state-helpers/scopes/get-config-global-states.ts b/src/lib/global-state-helpers/scopes/get-config-global-states.ts
@@ -101,5 +101,11 @@ export async function getConfigGlobalStates(
       },
     ],
     "contextMenuItems": [...ContextMenuItems],
+    "development"     : {
+      "enabled"                   : false,
+      "showFPS"                   : false,
+      "enableDebugMode"           : false,
+      "enableNativeReloadKeyBinds": false,
+    },
   };
 }
diff --git a/src/lib/global-state-helpers/scopes/get-default-global-states.ts b/src/lib/global-state-helpers/scopes/get-default-global-states.ts
@@ -58,5 +58,11 @@ export function getDefaultGlobalStates(): GlobalStatesType {
       },
     ],
     "contextMenuItems": [...ContextMenuItems],
+    "development"     : {
+      "enabled"                   : false,
+      "showFPS"                   : false,
+      "enableDebugMode"           : false,
+      "enableNativeReloadKeyBinds": false,
+    },
   };
 }
diff --git a/src/lib/globals/scopes/declare-window.ts b/src/lib/globals/scopes/declare-window.ts
@@ -83,6 +83,10 @@ export function declareWindow(): void {
         "before": [],
         "after" : [],
       },
+      "onDevelopmentChange": {
+        "before": [],
+        "after" : [],
+      },
     },
   };
-}
+}
diff --git a/src/lib/logging/scopes/log.ts b/src/lib/logging/scopes/log.ts
@@ -1,16 +1,31 @@
 import { debug, error, info, warn } from "@tauri-apps/plugin-log";
 
 import { capitalize } from "@/lib/general/scopes/capitalize.ts";
+import type { LogMethodType } from "@/types/application/log-method.type.ts";
 
 /*
  * We do not care about promises here
  * Yeah, that can possibly lead to racing conditions...
  */
 export const log = {
-  "debug": (...input: string[]): void => {
+
+  /*
+   * 'log#debug' will point to the '__debug-defined' when debug mode is enabled
+   */
+  "__debug-defined": (...input: string[]): void => {
     debug(input.join(" "));
   },
-  "info": (...input: string[]): void => {
+
+  /*
+   * 'log#debug' will point to the '__debug-undefined' when debug mode is disabled
+   */
+  "__debug-undefined": ((): void => {}) as LogMethodType,
+
+  /*
+   * Actual logging methods
+   */
+  "debug": ((): void => {}) as LogMethodType,
+  "info" : (...input: string[]): void => {
     info(input.join(" "));
   },
   "warn": (...input: string[]): void => {
@@ -19,6 +34,10 @@ export const log = {
   "error": (...input: string[]): void => {
     error(input.join(" "));
   },
+
+  /*
+   * Some log messages have the same structure
+   */
   "templates": {
     "hooks": {
       "iterate": {
diff --git a/src/lib/logging/scopes/prepare-log-file.ts b/src/lib/logging/scopes/prepare-log-file.ts
@@ -10,7 +10,6 @@ import {
 } from "@tauri-apps/plugin-fs";
 
 import { ApplicationName } from "@/constants/application.ts";
-import General from "@/lib/general";
 
 function getNumberFromLogFilename(filename: string): number {
   // 'kaede-0.log' -> 'kaede-0'
@@ -35,8 +34,7 @@ function getNumberFromLogFilename(filename: string): number {
  *
  * else just write into 'latest.log' without other manipulations
  */
-export async function prepareLogFile(portable: boolean): Promise<void> {
-  const baseDirectory = await General.getBaseDirectory(portable);
+export async function prepareLogFile(baseDirectory: string): Promise<void> {
   const logsDirectory = await join(baseDirectory, "logs");
 
   // We are assuming that 'latest.log' doesn't exist
@@ -94,4 +92,4 @@ export async function prepareLogFile(portable: boolean): Promise<void> {
   await copyFile(latestLogPath, renamedLogPath);
   // Clear the 'latest.log' file
   await writeTextFile(latestLogPath, "");
-}
+}
diff --git a/src/lib/schemas/scopes/config.schema.ts b/src/lib/schemas/scopes/config.schema.ts
diff --git a/src/main.ts b/src/main.ts
diff --git a/src/types/application/global-states.type.ts b/src/types/application/global-states.type.ts
diff --git a/src/types/application/log-method.type.ts b/src/types/application/log-method.type.ts
