refactor(core): Store PID of core binary in a dedicated PID file instead of app settings

Author: Ayideyia

frontend/src/App.vue

@@ -90,7 +90,7 @@ envStore.setupEnv().then(async () => {
   await sleep(Math.max(0, 1000 - duration))
 
   loading.value = false
-  kernelApiStore.updateKernelState()
+  kernelApiStore.updateCoreState()
 })
 </script>
 

frontend/src/components/TitleBar.vue

@@ -91,7 +91,7 @@ onUnmounted(() => window.removeEventListener('resize', onResize))
         @dblclick="WindowToggleMaximise"
         :class="isDarwin ? 'justify-center py-4 text-12' : 'text-14'"
         :style="{
-          color: appSettingsStore.app.kernel.running ? 'var(--primary-color)' : 'var(--color)',
+          color: kernelApiStore.running ? 'var(--primary-color)' : 'var(--color)',
         }"
         class="font-bold w-full h-full flex items-center"
       >

frontend/src/constant/kernel.ts

@@ -11,6 +11,7 @@ import { useEnvStore } from '@/stores'
 
 export const CoreStopOutputKeyword = 'start initial compatible provider default'
 export const CoreWorkingDirectory = 'data/mihomo'
+export const CorePidFilePath = CoreWorkingDirectory + '/pid.txt'
 export const CoreConfigFilePath = CoreWorkingDirectory + '/config.yaml'
 export const CoreCacheFilePath = CoreWorkingDirectory + '/cache.db'
 

frontend/src/hooks/useCoreBranch.ts

@@ -55,8 +55,8 @@ export const useCoreBranch = (isAlpha = false) => {
   const kernelApiStore = useKernelApiStore()
 
   const restartable = computed(() => {
-    const { running, branch } = appSettings.app.kernel
-    if (!running) return false
+    const { branch } = appSettings.app.kernel
+    if (!kernelApiStore.running) return false
     return localVersion.value && downloadCompleted.value && (branch === Branch.Alpha) === isAlpha
   })
 
@@ -181,9 +181,9 @@ export const useCoreBranch = (isAlpha = false) => {
   }
 
   const restartCore = async () => {
-    if (!appSettings.app.kernel.running) return
+    if (!kernelApiStore.running) return
     try {
-      await kernelApiStore.restartKernel()
+      await kernelApiStore.restartCore()
       downloadCompleted.value = false
       message.success('common.success')
     } catch (error: any) {
@@ -209,10 +209,10 @@ export const useCoreBranch = (isAlpha = false) => {
 
     const doRollback = () => MoveFile(CoreBakFilePath, CoreFilePath)
 
-    const { running, branch } = appSettings.app.kernel
-    const isCurrentRunning = running && (branch === Branch.Alpha) === isAlpha
+    const { branch } = appSettings.app.kernel
+    const isCurrentRunning = kernelApiStore.running && (branch === Branch.Alpha) === isAlpha
     if (isCurrentRunning) {
-      await kernelApiStore.restartKernel(doRollback)
+      await kernelApiStore.restartCore(doRollback)
     } else {
       await doRollback()
     }

frontend/src/stores/appSettings.ts

@@ -64,8 +64,6 @@ export const useAppSettingsStore = defineStore('app-settings', () => {
     kernel: {
       branch: Branch.Main,
       profile: '',
-      pid: 0,
-      running: false,
       autoClose: true,
       unAvailable: true,
       cardMode: true,
@@ -125,6 +123,13 @@ export const useAppSettingsStore = defineStore('app-settings', () => {
     if (!app.value.kernel.cardColumns) {
       app.value.kernel.cardColumns = DefaultCardColumns
     }
+    // @ts-expect-error(Deprecated)
+    if (app.value.kernel.running !== undefined) {
+      // @ts-expect-error(Deprecated)
+      delete app.value.kernel.running
+      // @ts-expect-error(Deprecated)
+      delete app.value.kernel.pid
+    }
 
     firstOpen = !!data
 
@@ -201,13 +206,7 @@ export const useAppSettingsStore = defineStore('app-settings', () => {
   )
 
   watch(
-    [
-      themeMode,
-      () => app.value.color,
-      () => app.value.lang,
-      () => app.value.kernel.running,
-      () => app.value.addPluginToMenu,
-    ],
+    [themeMode, () => app.value.color, () => app.value.lang, () => app.value.addPluginToMenu],
     updateTrayMenus,
   )
 

frontend/src/stores/kernelApi.ts

@@ -2,8 +2,8 @@ import { defineStore } from 'pinia'
 import { computed, ref, watch } from 'vue'
 
 import { getConfigs, setConfigs, getProxies, getProviders, Api } from '@/api/kernel'
-import { ProcessInfo, KillProcess, ExecBackground } from '@/bridge'
-import { CoreStopOutputKeyword, CoreWorkingDirectory } from '@/constant'
+import { ProcessInfo, KillProcess, ExecBackground, ReadFile, WriteFile, RemoveFile } from '@/bridge'
+import { CorePidFilePath, CoreStopOutputKeyword, CoreWorkingDirectory } from '@/constant'
 import { Branch } from '@/enums/app'
 import {
   useAppSettingsStore,
@@ -14,7 +14,6 @@ import {
 } from '@/stores'
 import {
   generateConfigFile,
-  ignoredError,
   updateTrayMenus,
   getKernelFileName,
   WebSockets,
@@ -203,75 +202,95 @@ export const useKernelApiStore = defineStore('kernelApi', () => {
   }
 
   /* Bridge API */
+  const corePid = ref(-1)
+  const running = ref(false)
   const loading = ref(false)
-  const statusLoading = ref(true)
+  const coreStateLoading = ref(true)
   let isCoreStartedByThisInstance = false
-  let doneCoreStopped: (value: unknown) => void
+  let coreStoppedResolver: (value: unknown) => void
   let coreStoppedPromise: Promise<unknown>
-  let doneFirstCoreUpdate: (value: unknown) => void
-  const firstCoreUpdatePromise = new Promise((r) => (doneFirstCoreUpdate = r))
 
-  const isKernelRunning = async (pid: number) => {
-    return pid && (await ProcessInfo(pid)).startsWith('mihomo')
-  }
-
-  const updateKernelState = async () => {
-    appSettingsStore.app.kernel.running = !!(await ignoredError(
-      isKernelRunning,
-      appSettingsStore.app.kernel.pid,
-    ))
+  const updateCoreState = async () => {
+    corePid.value = Number(await ReadFile(CorePidFilePath).catch(() => -1))
+    const processName = corePid.value === -1 ? '' : await ProcessInfo(corePid.value).catch(() => '')
+    running.value = processName.startsWith('mihomo')
 
-    if (!appSettingsStore.app.kernel.running) {
-      appSettingsStore.app.kernel.pid = 0
-    }
+    coreStateLoading.value = false
 
-    statusLoading.value = false
-
-    if (appSettingsStore.app.kernel.running) {
+    if (running.value) {
+      initCoreWebsockets()
+      longLivedWS.setup?.()
       await Promise.all([refreshConfig(), refreshProviderProxies()])
       await envStore.updateSystemProxyStatus()
     } else if (appSettingsStore.app.autoStartKernel) {
-      await startKernel()
+      await startCore()
     }
+  }
 
-    doneFirstCoreUpdate(null)
+  const runCoreProcess = (coreFilePath: string, args: string[], env: Recordable) => {
+    return new Promise<number>((resolve) => {
+      const pid = ExecBackground(
+        coreFilePath,
+        args,
+        (out) => {
+          logsStore.recordKernelLog(out)
+          if (out.toLowerCase().includes(CoreStopOutputKeyword)) {
+            resolve(pid)
+          }
+        },
+        () => {
+          onCoreStopped()
+          resolve(0)
+        },
+        { StopOutputKeyword: CoreStopOutputKeyword, Env: env },
+      )
+    })
   }
 
   const onCoreStarted = async (pid: number) => {
-    loading.value = false
-    appSettingsStore.app.kernel.pid = pid
-    appSettingsStore.app.kernel.running = true
+    await WriteFile(CorePidFilePath, String(pid))
 
+    corePid.value = pid
+    loading.value = false
+    running.value = true
     isCoreStartedByThisInstance = true
-    coreStoppedPromise = new Promise((r) => (doneCoreStopped = r))
+    coreStoppedPromise = new Promise((r) => (coreStoppedResolver = r))
+
     await Promise.all([refreshConfig(), refreshProviderProxies()])
 
     if (appSettingsStore.app.autoSetSystemProxy) {
       await envStore.setSystemProxy().catch((err) => message.error(err))
     }
     await pluginsStore.onCoreStartedTrigger()
+
+    initCoreWebsockets()
+    longLivedWS.setup?.()
   }
 
   const onCoreStopped = async () => {
+    await RemoveFile(CorePidFilePath)
+
+    corePid.value = -1
     loading.value = false
-    appSettingsStore.app.kernel.pid = 0
-    appSettingsStore.app.kernel.running = false
+    running.value = false
 
     if (appSettingsStore.app.autoSetSystemProxy) {
       await envStore.clearSystemProxy()
     }
     await pluginsStore.onCoreStoppedTrigger()
 
-    isCoreStartedByThisInstance && doneCoreStopped(null)
+    isCoreStartedByThisInstance && coreStoppedResolver(null)
+
+    destroyCoreWebsockets()
   }
 
-  const startKernel = async () => {
+  const startCore = async () => {
+    if (running.value) throw 'The core is already running'
+
     const { profile: profileID, branch } = appSettingsStore.app.kernel
     const profile = profilesStore.getProfileById(profileID)
     if (!profile) throw 'Choose a profile first'
 
-    await stopKernel()
-
     const isAlpha = branch === Branch.Alpha
     const fileName = getKernelFileName(isAlpha)
     const kernelFilePath = CoreWorkingDirectory + '/' + fileName
@@ -282,43 +301,32 @@ export const useKernelApiStore = defineStore('kernelApi', () => {
       await generateConfigFile(profile, (config) =>
         pluginsStore.onBeforeCoreStartTrigger(config, profile),
       )
-      const pid = await ExecBackground(
+      const pid = await runCoreProcess(
         kernelFilePath,
         getKernelRuntimeArgs(isAlpha),
-        (out) => {
-          logsStore.recordKernelLog(out)
-          if (out.toLowerCase().includes(CoreStopOutputKeyword)) {
-            onCoreStarted(pid)
-          }
-        },
-        onCoreStopped,
-        {
-          StopOutputKeyword: CoreStopOutputKeyword,
-          Env: getKernelRuntimeEnv(isAlpha),
-        },
+        getKernelRuntimeEnv(isAlpha),
       )
+      pid && (await onCoreStarted(pid))
     } catch (error) {
       loading.value = false
       throw error
     }
   }
 
-  const stopKernel = async () => {
-    const { pid } = appSettingsStore.app.kernel
-    const running = await ignoredError(isKernelRunning, pid)
-    if (running) {
-      await pluginsStore.onBeforeCoreStopTrigger()
-      await KillProcess(pid)
-      await (isCoreStartedByThisInstance ? coreStoppedPromise : onCoreStopped())
-    }
+  const stopCore = async () => {
+    if (!running.value) throw 'The core is not running'
+
+    await pluginsStore.onBeforeCoreStopTrigger()
+    await KillProcess(corePid.value)
+    await (isCoreStartedByThisInstance ? coreStoppedPromise : onCoreStopped())
 
     logsStore.clearKernelLog()
   }
 
-  const restartKernel = async (cleanupTask?: () => Promise<any>) => {
-    await stopKernel()
+  const restartCore = async (cleanupTask?: () => Promise<any>) => {
+    await stopCore()
     await cleanupTask?.()
-    await startKernel()
+    await startCore()
   }
 
   const getProxyPort = ():
@@ -364,28 +372,17 @@ export const useKernelApiStore = defineStore('kernelApi', () => {
     return source.concat([proxySignature, unAvailable, sortByDelay]).join('')
   })
 
-  watch(watchSources, updateTrayMenus)
-
-  watch(
-    () => appSettingsStore.app.kernel.running,
-    async (v) => {
-      await firstCoreUpdatePromise
-      if (v) {
-        initCoreWebsockets()
-        longLivedWS.setup?.()
-      } else {
-        destroyCoreWebsockets()
-      }
-    },
-  )
+  watch([watchSources, running], updateTrayMenus)
 
   return {
-    startKernel,
-    stopKernel,
-    restartKernel,
-    updateKernelState,
+    startCore,
+    stopCore,
+    restartCore,
+    updateCoreState,
+    pid: corePid,
+    running,
     loading,
-    statusLoading,
+    coreStateLoading,
     config,
     proxies,
     providers,
@@ -398,5 +395,19 @@ export const useKernelApiStore = defineStore('kernelApi', () => {
     onMemory: createCoreWSHandlerRegister(websocketHandlers.memory),
     onTraffic: createCoreWSHandlerRegister(websocketHandlers.traffic),
     onConnections: createCoreWSHandlerRegister(websocketHandlers.connections),
+
+    // Deprecated
+    startKernel: () => {
+      console.warn('[Deprecated] "startKernel" is deprecated. Please use "startCore" instead.')
+      startCore()
+    },
+    stopKernel: () => {
+      console.warn('[Deprecated] "stopKernel" is deprecated. Please use "stopCore" instead.')
+      stopCore()
+    },
+    restartKernel: (...args: any[]) => {
+      console.warn('[Deprecated] "restartKernel" is deprecated. Please use "restartCore" instead.')
+      restartCore(...args)
+    },
   }
 })

frontend/src/types/app.d.ts

@@ -64,8 +64,6 @@ type AppSettings = {
   kernel: {
     branch: Branch
     profile: string
-    pid: number
-    running: boolean
     autoClose: boolean
     unAvailable: boolean
     cardMode: boolean

frontend/src/utils/command.ts

@@ -56,18 +56,18 @@ export const getCommands = () => {
       children: [
         {
           label: 'tray.startKernel',
-          cmd: 'Start Kernel',
-          handler: kernelStore.startKernel,
+          cmd: 'Start Core',
+          handler: kernelStore.startCore,
         },
         {
           label: 'tray.stopKernel',
-          cmd: 'Stop Kernel',
-          handler: kernelStore.stopKernel,
+          cmd: 'Stop Core',
+          handler: kernelStore.stopCore,
         },
         {
           label: 'tray.restartKernel',
-          cmd: 'Restart Kernel',
-          handler: kernelStore.restartKernel,
+          cmd: 'Restart Core',
+          handler: kernelStore.restartCore,
         },
         {
           label: 'tray.enableTunMode',