整理: エンジンマニフェストをAPI向けと内部向けで分離

build_util/make_docs.py

@@ -50,7 +50,7 @@ def generate_api_docs_html(schema: str) -> str:
     engine_manifest = load_manifest(engine_manifest_path())
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

run.py

@@ -332,7 +332,7 @@ def main() -> None:
 
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

test/benchmark/engine_preparation.py

@@ -29,7 +29,7 @@ def _generate_engine_fake_server(root_dir: Path) -> TestClient:
     engine_manifest = load_manifest(engine_manifest_path())
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

test/e2e/conftest.py

@@ -48,7 +48,7 @@ def app_params(tmp_path: Path) -> dict[str, Any]:
     engine_manifest = load_manifest(engine_manifest_path())
     library_manager = LibraryManager(
         get_save_dir() / "installed_libraries",
-        engine_manifest.supported_vvlib_manifest_version,
+        None,
         engine_manifest.brand_name,
         engine_manifest.name,
         engine_manifest.uuid,

test/unit/test_engine_manifest.py

@@ -0,0 +1,18 @@
+"""エンジンマニフェストのテスト"""
+
+from pathlib import Path
+
+from voicevox_engine.engine_manifest import ManifestWrapper
+
+
+def test_ManifestWrapper_init() -> None:
+    """`ManifestWrapper.from_file()` でインスタンスが生成される。"""
+    ManifestWrapper.from_file(Path("engine_manifest.json"))
+    assert True
+
+
+def test_ManifestWrapper_relative_path() -> None:
+    """`ManifestWrapper.root` を用いて相対パスが解決できる。"""
+    wrapper = ManifestWrapper.from_file(Path("engine_manifest.json"))
+    tos_path = wrapper.root / wrapper.terms_of_service
+    assert tos_path.exists()

voicevox_engine/app/application.py

@@ -20,7 +20,7 @@
 from voicevox_engine.app.routers.user_dict import generate_user_dict_router
 from voicevox_engine.cancellable_engine import CancellableEngine
 from voicevox_engine.core.core_initializer import CoreManager
-from voicevox_engine.engine_manifest import EngineManifest
+from voicevox_engine.engine_manifest import ManifestWrapper
 from voicevox_engine.library.library_manager import LibraryManager
 from voicevox_engine.metas.MetasStore import MetasStore
 from voicevox_engine.preset.preset_manager import PresetManager
@@ -37,7 +37,7 @@ def generate_app(
     setting_loader: SettingHandler,
     preset_manager: PresetManager,
     user_dict: UserDictionary,
-    engine_manifest: EngineManifest,
+    engine_manifest: ManifestWrapper,
     library_manager: LibraryManager,
     cancellable_engine: CancellableEngine | None = None,
     speaker_info_dir: Path | None = None,
@@ -73,7 +73,7 @@ def generate_app(
     app.include_router(
         generate_speaker_router(core_manager, metas_store, speaker_info_dir)
     )
-    if engine_manifest.supported_features.manage_library:
+    if engine_manifest.supported_features.manage_library.value:
         app.include_router(generate_library_router(library_manager))
     app.include_router(generate_user_dict_router(user_dict))
     app.include_router(generate_engine_info_router(core_manager, engine_manifest))
@@ -83,7 +83,7 @@ def generate_app(
     app.include_router(generate_portal_page_router(engine_manifest.name))
 
     app = configure_openapi_schema(
-        app, engine_manifest.supported_features.manage_library
+        app, engine_manifest.supported_features.manage_library.value
     )
 
     return app

voicevox_engine/app/routers/engine_info.py

@@ -9,7 +9,11 @@
 from voicevox_engine import __version__
 from voicevox_engine.core.core_adapter import DeviceSupport
 from voicevox_engine.core.core_initializer import CoreManager
-from voicevox_engine.engine_manifest import EngineManifest
+from voicevox_engine.engine_manifest import (
+    EngineManifest,
+    ManifestWrapper,
+    generate_engine_manifest,
+)
 
 
 class SupportedDevicesInfo(BaseModel):
@@ -32,7 +36,7 @@ def generate_from(cls, device_support: DeviceSupport) -> Self:
 
 
 def generate_engine_info_router(
-    core_manager: CoreManager, engine_manifest_data: EngineManifest
+    core_manager: CoreManager, engine_manifest_data: ManifestWrapper
 ) -> APIRouter:
     """エンジン情報 API Router を生成する"""
     router = APIRouter(tags=["その他"])
@@ -60,6 +64,6 @@ def supported_devices(
     @router.get("/engine_manifest")
     async def engine_manifest() -> EngineManifest:
         """エンジンマニフェストを取得します。"""
-        return engine_manifest_data
+        return generate_engine_manifest(engine_manifest_data)
 
     return router

voicevox_engine/engine_manifest.py

@@ -8,7 +8,7 @@
 import json
 from base64 import b64encode
 from pathlib import Path
-from typing import TypeAlias
+from typing import Self, TypeAlias
 
 from pydantic import BaseModel, Field
 from pydantic.json_schema import SkipJsonSchema
@@ -57,6 +57,18 @@ class EngineManifestJson(BaseModel):
     supported_features: SupportedFeaturesJson
 
 
+class ManifestWrapper(EngineManifestJson):
+    # エンジンマニフェストの親ディレクトリのパス。マニフェストの `.icon` 等はここをルートとする相対パスで記述されている。
+    root: Path
+
+    @classmethod
+    def from_file(cls, manifest_path: Path) -> Self:
+        """指定ファイルからインスタンスを生成する。"""
+        manifest = EngineManifestJson.model_validate_json(manifest_path.read_bytes())
+        manifest_root = manifest_path.parent
+        return cls(root=manifest_root, **manifest.model_dump())
+
+
 class UpdateInfo(BaseModel):
     """
     エンジンのアップデート情報
@@ -131,13 +143,16 @@ class EngineManifest(BaseModel):
     supported_features: SupportedFeatures = Field(title="エンジンが持つ機能")
 
 
-def load_manifest(manifest_path: Path) -> EngineManifest:
+def load_manifest(manifest_path: Path) -> ManifestWrapper:
     """エンジンマニフェストを指定ファイルから読み込む。"""
+    return ManifestWrapper.from_file(manifest_path)
+
+
+def generate_engine_manifest(manifest_wrapper: ManifestWrapper) -> EngineManifest:
+    """API 向けのエンジンマニフェストを生成する。"""
+    root_dir = manifest_wrapper.root
+    manifest = manifest_wrapper.model_dump()
 
-    root_dir = manifest_path.parent
-    manifest = EngineManifestJson.model_validate_json(
-        manifest_path.read_bytes()
-    ).model_dump()
     return EngineManifest(
         manifest_version=manifest["manifest_version"],
         name=manifest["name"],