refactor: .envのデフォルトエンジン情報を読み出す部分を共通化する (#2334)

src/backend/browser/contract.ts

@@ -1,8 +1,7 @@
-import { type EngineInfo, envEngineInfoSchema } from "@/type/preload";
+import { loadEnvEngineInfos } from "@/domain/defaultEngine/envEngineInfo";
+import { type EngineInfo } from "@/type/preload";
 
-const baseEngineInfo = envEngineInfoSchema
-  .array()
-  .parse(JSON.parse(import.meta.env.VITE_DEFAULT_ENGINE_INFOS))[0];
+const baseEngineInfo = loadEnvEngineInfos()[0];
 
 export const defaultEngine: EngineInfo = (() => {
   const { protocol, hostname, port, pathname } = new URL(baseEngineInfo.host);

src/backend/common/ConfigManager.ts

@@ -3,7 +3,6 @@ import AsyncLock from "async-lock";
 import {
   AcceptTermsStatus,
   ConfigType,
-  EngineId,
   configSchema,
   DefaultStyleId,
   defaultHotkeySettings,
@@ -12,9 +11,9 @@ import {
   HotkeyCombination,
   VoiceId,
   PresetKey,
-  envEngineInfoSchema,
 } from "@/type/preload";
 import { ensureNotNullish } from "@/helpers/errorHelper";
+import { loadEnvEngineInfos } from "@/domain/defaultEngine/envEngineInfo";
 
 const lockKey = "save";
 
@@ -40,11 +39,7 @@ const migrations: [string, (store: Record<string, unknown>) => unknown][] = [
       if (import.meta.env.VITE_DEFAULT_ENGINE_INFOS == undefined) {
         throw new Error("VITE_DEFAULT_ENGINE_INFOS == undefined");
       }
-      const engineId = EngineId(
-        envEngineInfoSchema
-          .array()
-          .parse(JSON.parse(import.meta.env.VITE_DEFAULT_ENGINE_INFOS))[0].uuid,
-      );
+      const engineId = loadEnvEngineInfos()[0].uuid;
       if (engineId == undefined)
         throw new Error("VITE_DEFAULT_ENGINE_INFOS[0].uuid == undefined");
       const prevDefaultStyleIds = config.defaultStyleIds as DefaultStyleId[];

src/backend/electron/manager/engineInfoManager.ts

@@ -12,21 +12,17 @@ import {
   MinimumEngineManifestType,
   EngineId,
   minimumEngineManifestSchema,
-  envEngineInfoSchema,
 } from "@/type/preload";
 import { AltPortInfos } from "@/store/type";
 import { BaseConfigManager } from "@/backend/common/ConfigManager";
+import { loadEnvEngineInfos } from "@/domain/defaultEngine/envEngineInfo";
 
 /**
  * デフォルトエンジンの情報を取得する
  */
 function fetchDefaultEngineInfos(defaultEngineDir: string): EngineInfo[] {
   // TODO: envから直接ではなく、envに書いたengine_manifest.jsonから情報を得るようにする
-  const defaultEngineInfosEnv =
-    import.meta.env.VITE_DEFAULT_ENGINE_INFOS ?? "[]";
-
-  const envSchema = envEngineInfoSchema.array();
-  const engines = envSchema.parse(JSON.parse(defaultEngineInfosEnv));
+  const engines = loadEnvEngineInfos();
 
   return engines.map((engineInfo) => {
     const { protocol, hostname, port, pathname } = new URL(engineInfo.host);

src/domain/defaultEngine/envEngineInfo.ts

@@ -0,0 +1,30 @@
+/**
+ * デフォルトエンジンの .env 関連のモジュール
+ */
+
+import { z } from "zod";
+
+import { engineIdSchema } from "@/type/preload";
+
+/** .envに書くデフォルトエンジン情報のスキーマ */
+export const envEngineInfoSchema = z.object({
+  uuid: engineIdSchema,
+  host: z.string(),
+  name: z.string(),
+  executionEnabled: z.boolean(),
+  executionFilePath: z.string(),
+  executionArgs: z.array(z.string()),
+  path: z.string().optional(),
+});
+export type EnvEngineInfoType = z.infer<typeof envEngineInfoSchema>;
+
+/** .envからデフォルトエンジン情報を読み込む */
+export function loadEnvEngineInfos(): EnvEngineInfoType[] {
+  const defaultEngineInfosEnv =
+    import.meta.env.VITE_DEFAULT_ENGINE_INFOS ?? "[]";
+
+  // FIXME: 「.envを書き換えてください」というログを出したい
+  // NOTE: domainディレクトリなのでログを出す方法がなく、Errorオプションのcauseを用いてもelectron-logがcauseのログを出してくれない
+  const envSchema = envEngineInfoSchema.array();
+  return envSchema.parse(JSON.parse(defaultEngineInfosEnv));
+}

src/domain/defaultEngine.ts → src/domain/defaultEngine/latetDefaultEngine.ts

@@ -1,5 +1,5 @@
 /**
- * デフォルトエンジン関連のモジュール
+ * デフォルトエンジンの最新情報関連のモジュール
  */
 
 import { z } from "zod";

src/type/preload.ts

@@ -681,17 +681,6 @@ export const configSchema = z
   .merge(rootMiscSettingSchema);
 export type ConfigType = z.infer<typeof configSchema>;
 
-export const envEngineInfoSchema = z.object({
-  uuid: engineIdSchema,
-  host: z.string(),
-  name: z.string(),
-  executionEnabled: z.boolean(),
-  executionFilePath: z.string(),
-  executionArgs: z.array(z.string()),
-  path: z.string().optional(),
-});
-export type EnvEngineInfoType = z.infer<typeof envEngineInfoSchema>;
-
 // workaround. SystemError(https://nodejs.org/api/errors.html#class-systemerror)が2022/05/19時点ではNodeJSの型定義に記述されていないためこれを追加しています。
 export class SystemError extends Error {
   code?: string | undefined;

tests/unit/domain/defaultEngine/defaultEngine.node.spec.ts

@@ -2,7 +2,7 @@
 
 import path from "path";
 import fs from "fs";
-import { fetchDefaultEngineInfos } from "@/domain/defaultEngine";
+import { fetchDefaultEngineInfos } from "@/domain/defaultEngine/latetDefaultEngine";
 
 const currentDir = "tests/unit/domain/defaultEngine";