サードパーティがエンジンへのアクセス情報を得るための設定書き出し機能

src/background.ts

@@ -44,6 +44,7 @@ import EngineManager from "./background/engineManager";
 import VvppManager, { isVvppFile } from "./background/vvppManager";
 import configMigration014 from "./background/configMigration014";
 import { failure, success } from "./type/result";
+import { RuntimeInfoManager } from "./shared/RuntimeInfoManager";
 import { ipcMainHandle, ipcMainSend } from "@/electron/ipc";
 import { getConfigManager } from "@/background/electronConfig";
 
@@ -145,6 +146,11 @@ if (!fs.existsSync(vvppEngineDir)) {
   fs.mkdirSync(vvppEngineDir);
 }
 
+const runtimeInfoManager = new RuntimeInfoManager(
+  path.join(app.getPath("userData"), "runtime-info.json"),
+  app.getVersion()
+);
+
 const onEngineProcessError = (engineInfo: EngineInfo, error: Error) => {
   const engineId = engineInfo.uuid;
   log.error(`ENGINE ${engineId} ERROR: ${error}`);
@@ -167,6 +173,7 @@ const engineManager = new EngineManager({
   defaultEngineDir: appDirPath,
   vvppEngineDir,
   onEngineProcessError,
+  runtimeInfoManager,
 });
 const vvppManager = new VvppManager({ vvppEngineDir });
 

src/background/engineManager.ts

@@ -25,6 +25,7 @@ import {
 } from "@/type/preload";
 import { AltPortInfos } from "@/store/type";
 import { BaseConfigManager } from "@/shared/ConfigManager";
+import { RuntimeInfoManager } from "@/shared/RuntimeInfoManager";
 
 type EngineProcessContainer = {
   willQuitEngine: boolean;
@@ -60,6 +61,7 @@ export class EngineManager {
   defaultEngineDir: string;
   vvppEngineDir: string;
   onEngineProcessError: (engineInfo: EngineInfo, error: Error) => void;
+  runtimeInfoManager: RuntimeInfoManager;
 
   defaultEngineInfos: EngineInfo[] = [];
   additionalEngineInfos: EngineInfo[] = [];
@@ -72,17 +74,19 @@ export class EngineManager {
     defaultEngineDir,
     vvppEngineDir,
     onEngineProcessError,
+    runtimeInfoManager,
   }: {
     configManager: BaseConfigManager;
     defaultEngineDir: string;
     vvppEngineDir: string;
     onEngineProcessError: (engineInfo: EngineInfo, error: Error) => void;
+    runtimeInfoManager: RuntimeInfoManager;
   }) {
     this.configManager = configManager;
     this.defaultEngineDir = defaultEngineDir;
     this.vvppEngineDir = vvppEngineDir;
     this.onEngineProcessError = onEngineProcessError;
-
+    this.runtimeInfoManager = runtimeInfoManager;
     this.engineProcessContainers = {};
   }
 
@@ -210,6 +214,8 @@ export class EngineManager {
       log.info(`ENGINE ${engineInfo.uuid}: Start launching`);
       await this.runEngine(engineInfo.uuid);
     }
+    this.runtimeInfoManager.setEngineInfos(engineInfos);
+    await this.runtimeInfoManager.exportFile();
   }
 
   /**
@@ -469,6 +475,8 @@ export class EngineManager {
         );
 
         this.runEngine(engineId);
+        this.runtimeInfoManager.setEngineInfos(this.fetchEngineInfos());
+        this.runtimeInfoManager.exportFile();
         resolve();
         return;
       }
@@ -482,6 +490,8 @@ export class EngineManager {
         log.info(`ENGINE ${engineId}: Process killed. Restarting process...`);
 
         this.runEngine(engineId);
+        this.runtimeInfoManager.setEngineInfos(this.fetchEngineInfos());
+        this.runtimeInfoManager.exportFile();
         resolve();
       };
 

src/shared/RuntimeInfoManager.ts

@@ -0,0 +1,136 @@
+import fs from "fs";
+import AsyncLock from "async-lock";
+import log from "electron-log/main";
+import { EngineId, EngineInfo } from "@/type/preload";
+
+/**
+ * サードパーティ向けランタイム情報のエクスポート情報クラス
+ */
+export class RuntimeInfoManager {
+  private runtimeInfoPath: string;
+  private appVersion: string;
+
+  constructor(userDataPath: string, appVersion: string) {
+    this.runtimeInfoPath = userDataPath;
+    this.appVersion = appVersion;
+  }
+
+  /**
+   * サードパーティ向けランタイム情報のファイルパスを取得する
+   */
+  public getRuntimeInfoPath(): string {
+    return this.runtimeInfoPath;
+  }
+
+  /**
+   * ファイルロック用のインスタンス
+   */
+  private lock = new AsyncLock({
+    timeout: 1000,
+  });
+  private lockKey = "write";
+
+  /**
+   * サードパーティ向けランタイム情報のフォーマットバージョン
+   * Note: 破壊的変更があった場合に数字を上げること
+   */
+  private fileFormatVersion = 1;
+
+  /**
+   * エンジン情報（書き出し用に記憶）
+   */
+  private engineInfos: EngineInfo[] = [];
+
+  /**
+   * エンジン情報を登録する
+   */
+  public setEngineInfos(engineInfos: EngineInfo[]) {
+    this.engineInfos = engineInfos;
+  }
+
+  /**
+   * サードパーティ向けの設定ファイルを書き出す
+   */
+  public async exportFile() {
+    await this.lock.acquire(this.lockKey, async () => {
+      log.info(
+        `Runtime information file has been updated. : ${this.runtimeInfoPath}`
+      );
+
+      const outputInfoData = new OutputInfoDataFor3rdParty(
+        this.appVersion,
+        this.fileFormatVersion
+      );
+
+      // ファイルに書き出すデータをつくる
+      try {
+        await fs.promises.writeFile(
+          this.runtimeInfoPath,
+          JSON.stringify(outputInfoData.getOutputInfoData(this.engineInfos))
+        );
+      } catch (e) {
+        // ディスクの空き容量がない、他ツールからのファイルロック時をトラップ。
+        // サードパーティ向けなのでVOICEVOX側には通知せず、エラー記録して継続
+        log.error(`Failed to write file : ${e}`);
+      }
+    });
+  }
+}
+
+/**
+ * サードパーティ向けエンジン情報のレコード定義
+ * Note:変更時はRuntimeInfoManager.fileFormatVersionも変更すること
+ */
+export interface EngineInfoRecordFor3rdParty {
+  uuid: EngineId;
+  url: string;
+  name: string;
+}
+
+/**
+ * サードパーティ向けランタイム情報のレコード定義
+ * Note:変更時はRuntimeInfoManager.fileFormatVersionも変更すること
+ */
+export interface RuntimeInfoFormatFor3rdParty {
+  formatVersion: number;
+  appVersion: string;
+  engineInfos: EngineInfoRecordFor3rdParty[];
+}
+
+/**
+ * サードパーティ向けランタイム情報のエクスポートフォーマットクラス
+ */
+export class OutputInfoDataFor3rdParty {
+  private appVersion: string;
+  private fileFormatVersion: number;
+
+  constructor(appVersion: string, fileFormatVersion: number) {
+    this.appVersion = appVersion;
+    this.fileFormatVersion = fileFormatVersion;
+  }
+
+  /**
+   * サードパーティ向けに提供するデータを取得
+   */
+  public getOutputInfoData(
+    engineInfos: EngineInfo[]
+  ): RuntimeInfoFormatFor3rdParty {
+    const engineInfoList: EngineInfoRecordFor3rdParty[] = engineInfos.map(
+      (engineInfo) => {
+        return {
+          uuid: engineInfo.uuid,
+          url: engineInfo.host,
+          name: engineInfo.name,
+        };
+      }
+    );
+
+    const engineInfoFormatFor3rdParty: RuntimeInfoFormatFor3rdParty = {
+      formatVersion: this.fileFormatVersion,
+      appVersion: this.appVersion,
+      engineInfos: engineInfoList,
+    };
+
+    return engineInfoFormatFor3rdParty;
+  }
+}