Merge branch 'main' into improve/dictionary

Author: Hiroshiba

Diff for: .env.production

@@ -10,5 +10,5 @@ VITE_DEFAULT_ENGINE_INFOS=`[
     }
 ]`
 VITE_OFFICIAL_WEBSITE_URL=https://voicevox.hiroshiba.jp/
-VITE_LATEST_UPDATE_INFOS_URL=https://raw.githubusercontent.com/VOICEVOX/voicevox_blog/master/src/data/updateInfos.json
+VITE_LATEST_UPDATE_INFOS_URL=https://voicevox.hiroshiba.jp/updateInfos.json
 VITE_GTM_CONTAINER_ID=GTM-DUMMY

Diff for: .env.test

@@ -1,14 +1,16 @@
+# テスト用の.envファイル。モックを使う。
+
 VITE_APP_NAME=voicevox
 VITE_DEFAULT_ENGINE_INFOS=`[
     {
-        "uuid": "074fc39e-678b-4c13-8916-ffca8d505d1d",
-        "name": "VOICEVOX Engine",
-        "executionEnabled": true,
-        "executionFilePath": "../voicevox_engine/run.exe",
+        "name": "Mock Engine",
+        "uuid": "00000000-0000-0000-0000-000000000000",
+        "executionEnabled": false,
+        "executionFilePath": "dummy/path",
         "executionArgs": [],
-        "host": "http://127.0.0.1:50021"
+        "host": "mock://mock"
     }
 ]`
 VITE_OFFICIAL_WEBSITE_URL=https://voicevox.hiroshiba.jp/
-VITE_LATEST_UPDATE_INFOS_URL=https://raw.githubusercontent.com/VOICEVOX/voicevox_blog/master/src/data/updateInfos.json
+VITE_LATEST_UPDATE_INFOS_URL=https://voicevox.hiroshiba.jp/updateInfos.json
 VITE_GTM_CONTAINER_ID=GTM-DUMMY

Diff for: .github/actions/download-engine/action.yml

@@ -85,6 +85,13 @@ runs:
         mkdir -p $DEST
         mv $TEMPDIR/tmp-extract/$TARGET/* $DEST
 
+        # 実行ファイルのパーミッションを変更
+        if [ "${{ runner.os }}" = "Windows" ]; then
+          chmod +x $DEST/run.exe
+        else
+          chmod +x $DEST/run
+        fi
+
         echo "::group::ll $DEST"
         ls -al $DEST
         echo "::endgroup::"

Diff for: .github/actions/setup-environment/action.yml

@@ -33,13 +33,5 @@ runs:
         restore-keys: |
           ${{ env.cache-version }}-${{ runner.os }}--electron-builder-cache-
 
-    - name: Cache external dependencies
-      uses: actions/cache@v4
-      with:
-        path: ./build/vendored
-        key: ${{ env.cache-version }}-${{ runner.os }}--vendored-${{ hashFiles('build/*.js') }}
-        restore-keys: |
-          ${{ env.cache-version }}-${{ runner.os }}--vendored-
-
     - shell: bash
       run: npm ci

Diff for: .github/workflows/build.yml

@@ -26,8 +26,8 @@ on:
         default: false
 
 env:
-  VOICEVOX_ENGINE_VERSION: 0.22.0
-  VOICEVOX_RESOURCE_VERSION: 0.22.0
+  VOICEVOX_ENGINE_VERSION: 0.22.2
+  VOICEVOX_RESOURCE_VERSION: 0.22.2
   VOICEVOX_EDITOR_VERSION:
     |- # releaseタグ名か、workflow_dispatchでのバージョン名か、999.999.999-developが入る
     ${{ github.event.release.tag_name || github.event.inputs.version || '999.999.999-develop' }}

Diff for: .github/workflows/merge_gatekeeper.yml

@@ -0,0 +1,30 @@
+name: "Merge Gatekeeper"
+
+# auto mergeとmerge queue用のチェッカー。
+# Approve数が足りているか、すべてのテストが通っているかを確認します。
+# 詳細： https://github.com/VOICEVOX/merge-gatekeeper
+
+on:
+  pull_request_target:
+    types: [auto_merge_enabled]
+  merge_group:
+    types: [checks_requested]
+
+jobs:
+  merge_gatekeeper:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: voicevox/merge-gatekeeper@main
+        with:
+          token: ${{ secrets.GATEKEEPER_TOKEN }}
+          required_score: 2
+          score_rules: |
+            #maintainer: 2
+            #reviewer: 1
+      - uses: upsidr/merge-gatekeeper@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          self: merge_gatekeeper
+          # https://github.com/upsidr/merge-gatekeeper/issues/71#issuecomment-1660607977
+          ref: ${{ github.event.pull_request && github.event.pull_request.head.sha || github.ref }}
+          timeout: 18000 # 5 hours

Diff for: .github/workflows/test.yml

@@ -98,20 +98,6 @@ jobs:
           dest: ${{ github.workspace }}/voicevox_engine
           target: ${{ matrix.voicevox_engine_asset_name }}
 
-      - name: Setup
-        run: |
-          # run.exe
-          chmod +x ${{ steps.download-engine.outputs.run_path }}
-
-          # .env
-          sed -i -e 's|"074fc39e-678b-4c13-8916-ffca8d505d1d"|"208cf94d-43d2-4cf5-abc0-9783cac36d29"|' .env.test
-          sed -i -e 's|"../voicevox_engine/run.exe"|"${{ steps.download-engine.outputs.run_path }}"|' .env.test
-          # GitHub Actions 環境だとたまに50021が封じられていることがあるので、ランダムなポートを使うようにする
-          PORT=$(node -r net -e "server=net.createServer();server.listen(0,()=>{console.log(server.address().port);server.close()})")
-          sed -i -e 's|"host": "http://127.0.0.1:50021"|"host": "http://127.0.0.1:'$PORT'"|' .env.test
-          sed -i -e 's|"executionArgs": \[\],|"executionArgs": ["--port='$PORT'"],|' .env.test
-          cp .env.test .env
-
       - name: Run npm run test:browser-e2e
         run: |
           if [ -n "${{ runner.debug }}" ]; then
@@ -125,6 +111,14 @@ jobs:
 
       - name: Run npm run test:electron-e2e
         run: |
+          # .env
+          cp tests/env/.env.test-electron .env
+          sed -i -e 's|"path/to/engine"|"${{ steps.download-engine.outputs.run_path }}"|' .env
+          # GitHub Actions 環境だとたまに50021が封じられていることがあるので、ランダムなポートを使うようにする
+          PORT=$(node -r net -e "server=net.createServer();server.listen(0,()=>{console.log(server.address().port);server.close()})")
+          sed -i -e 's|random_port|'$PORT'|' .env
+          cat .env # ログ用
+
           if [ -n "${{ runner.debug }}" ]; then
             export DEBUG="pw:browser*"
           fi
@@ -134,6 +128,8 @@ jobs:
             npm run test:electron-e2e
           fi
 
+          rm .env
+
       - name: Run npm run test:storybook-vrt
         run: |
           if [ -n "${{ runner.debug }}" ]; then

Diff for: openapi.json

@@ -57,6 +57,7 @@
     "glob": "11.0.0",
     "hotkeys-js": "3.13.6",
     "immer": "9.0.21",
+    "kuromoji": "github:VOICEVOX/kuromoji.js#0.0.1",
     "markdown-it": "13.0.2",
     "move-file": "3.0.0",
     "multistream": "4.1.0",

Diff for: package-lock.json

@@ -1,35 +1,22 @@
-import type { PlaywrightTestConfig, Project } from "@playwright/test";
-import { z } from "zod";
+/**
+ * e2eテストと .env の設計：
+ * - デフォルトで .env.test を読み込む。
+ *   モックエンジンが使われる。
+ * - Electronテストはテストファイル内で様々な .env を読み込む。
+ *   テスト条件によって用意したい環境が異なるため。
+ */
 
+import type { PlaywrightTestConfig, Project } from "@playwright/test";
 import dotenv from "dotenv";
-dotenv.config({ override: true });
+
+dotenv.config({ path: ".env.test", override: true });
 
 let project: Project;
 let webServers: PlaywrightTestConfig["webServer"];
 const isElectron = process.env.VITE_TARGET === "electron";
 const isBrowser = process.env.VITE_TARGET === "browser";
 const isStorybook = process.env.TARGET === "storybook";
 
-// エンジンの起動が必要
-const defaultEngineInfosEnv = process.env.VITE_DEFAULT_ENGINE_INFOS ?? "[]";
-const envSchema = z // FIXME: electron起動時のものと共通化したい
-  .object({
-    host: z.string(),
-    executionFilePath: z.string(),
-    executionArgs: z.array(z.string()),
-    executionEnabled: z.boolean(),
-  })
-  .passthrough()
-  .array();
-const engineInfos = envSchema.parse(JSON.parse(defaultEngineInfosEnv));
-
-const engineServers = engineInfos
-  .filter((info) => info.executionEnabled)
-  .map((info) => ({
-    command: `${info.executionFilePath} ${info.executionArgs.join(" ")}`,
-    url: `${info.host}/version`,
-    reuseExistingServer: !process.env.CI,
-  }));
 const viteServer = {
   command: "vite --mode test --port 7357",
   port: 7357,
@@ -46,7 +33,7 @@ if (isElectron) {
   webServers = [viteServer];
 } else if (isBrowser) {
   project = { name: "browser", testDir: "./tests/e2e/browser" };
-  webServers = [viteServer, ...engineServers];
+  webServers = [viteServer];
 } else if (isStorybook) {
   project = { name: "storybook", testDir: "./tests/e2e/storybook" };
   webServers = [storybookServer];

Diff for: package.json

@@ -9,7 +9,7 @@
 Windows／Mac／Linux 搭載の PC に対応しています。
 
 ※Windows：Windows 10・Windows 11  
-※Mac：macOS 12(Monterey)以降  
+※Mac：macOS 13(Ventura)以降  
 ※Linux：Ubuntu 20.04・Ubuntu 22.04
 
 #### GPU 版

Diff for: playwright.config.ts

@@ -1,4 +1,19 @@
 [
+  {
+    "version": "0.22.3",
+    "descriptions": ["キャラクター「ぞん子」を追加"],
+    "contributors": []
+  },
+  {
+    "version": "0.22.2",
+    "descriptions": ["キャラクター「中部つるぎ」を追加"],
+    "contributors": []
+  },
+  {
+    "version": "0.22.1",
+    "descriptions": ["バグ修正"],
+    "contributors": ["Hiroshiba", "sevenc-nanashi"]
+  },
   {
     "version": "0.22.0",
     "descriptions": [

Diff for: public/qAndA.md

@@ -5,6 +5,7 @@ import { BaseConfigManager, Metadata } from "@/backend/common/ConfigManager";
 import { ConfigType, EngineId, engineSettingSchema } from "@/type/preload";
 import { ensureNotNullish } from "@/helpers/errorHelper";
 import { UnreachableError } from "@/type/utility";
+import { isMac } from "@/helpers/platform";
 
 const dbName = `${import.meta.env.VITE_APP_NAME}-web`;
 const settingStoreKey = "config";
@@ -20,7 +21,7 @@ const defaultEngineId = EngineId(defaultEngine.uuid);
 export async function getConfigManager() {
   await configManagerLock.acquire("configManager", async () => {
     if (!configManager) {
-      configManager = new BrowserConfigManager();
+      configManager = new BrowserConfigManager({ isMac });
       await configManager.initialize();
     }
   });

Diff for: public/updateInfos.json

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { uuid4 } from "@/helpers/random";
+
+const fakePathSchema = z
+  .string()
+  .regex(/^<browser-dummy-[0-9a-f]+>-.+$/)
+  .brand("FakePath");
+export type FakePath = z.infer<typeof fakePathSchema>;
+
+export const isFakePath = (path: string): path is FakePath => {
+  return fakePathSchema.safeParse(path).success;
+};
+
+export const createFakePath = (name: string): FakePath => {
+  return fakePathSchema.parse(`<browser-dummy-${uuid4()}>-${name}`);
+};