feat: 差分アップデートを追加

.env.production

@@ -1,4 +1,4 @@
-VITE_APP_NAME=voicevox
+VITE_APP_NAME=voicevox-test
 VITE_DEFAULT_ENGINE_INFOS=`[
     {
         "uuid": "074fc39e-678b-4c13-8916-ffca8d505d1d",

build/funcs.nsh

@@ -39,38 +39,45 @@
   Push $0 ; Stack $0
   Push $1 ;       $1 $0
 
-  ; electron-builder のスクリプトに基づいたハッシュ値と対象ファイル名の取得
-  ; https://github.com/electron-userland/electron-builder/blob/28cb86bdcb6dd0b10e75a69ccd34ece6cca1d204/packages/app-builder-lib/templates/nsis/include/installer.nsh#L17-L70
-  !ifdef APP_64_NAME
-    !ifdef APP_32_NAME
-      !ifdef APP_ARM64_NAME
-        ${if} ${IsNativeARM64}
-          StrCpy $0 "${APP_ARM64_NAME}"
-          StrCpy $1 "${APP_ARM64_HASH}"
-        ${elseif} ${IsNativeAMD64}
-          StrCpy $0 "${APP_64_NAME}"
-          StrCpy $1 "${APP_64_HASH}"
-        ${else}
-          StrCpy $0 "${APP_32_NAME}"
-          StrCpy $1 "${APP_32_HASH}"
-        ${endif}
+  ${StdUtils.GetParameter} $0 "package-file" ""
+  ; 引数でパッケージのパスが指定されている場合はそれを優先する（electron-updater用）
+  ${If} $0 != ""
+    ; ハッシュチェックは省略する（electron-updater がすでに行っているため）
+    StrCpy $1 "__DANGEROUS_SKIP_HASH_CHECK__"
+  ${Else}
+    ; electron-builder のスクリプトに基づいたハッシュ値と対象ファイル名の取得
+    ; https://github.com/electron-userland/electron-builder/blob/28cb86bdcb6dd0b10e75a69ccd34ece6cca1d204/packages/app-builder-lib/templates/nsis/include/installer.nsh#L17-L70
+    !ifdef APP_64_NAME
+      !ifdef APP_32_NAME
+        !ifdef APP_ARM64_NAME
+          ${if} ${IsNativeARM64}
+            StrCpy $0 "${APP_ARM64_NAME}"
+            StrCpy $1 "${APP_ARM64_HASH}"
+          ${elseif} ${IsNativeAMD64}
+            StrCpy $0 "${APP_64_NAME}"
+            StrCpy $1 "${APP_64_HASH}"
+          ${else}
+            StrCpy $0 "${APP_32_NAME}"
+            StrCpy $1 "${APP_32_HASH}"
+          ${endif}
+        !else
+          ${if} ${RunningX64}
+            StrCpy $0 "${APP_64_NAME}"
+            StrCpy $1 "${APP_64_HASH}"
+          ${else}
+            StrCpy $0 "${APP_32_NAME}"
+            StrCpy $1 "${APP_32_HASH}"
+          ${endif}
+        !endif
       !else
-        ${if} ${RunningX64}
-          StrCpy $0 "${APP_64_NAME}"
-          StrCpy $1 "${APP_64_HASH}"
-        ${else}
-          StrCpy $0 "${APP_32_NAME}"
-          StrCpy $1 "${APP_32_HASH}"
-        ${endif}
+        StrCpy $0 "${APP_64_NAME}"
+        StrCpy $1 "${APP_64_HASH}"
       !endif
     !else
-      StrCpy $0 "${APP_64_NAME}"
-      StrCpy $1 "${APP_64_HASH}"
+      StrCpy $0 "${APP_32_NAME}"
+      StrCpy $1 "${APP_32_HASH}"
     !endif
-  !else
-    StrCpy $0 "${APP_32_NAME}"
-    StrCpy $1 "${APP_32_HASH}"
-  !endif
+  ${EndIf}
 
                       ; Stack $1 $0
   Exch $1             ;       <ResultHash> $0
@@ -225,11 +232,17 @@
   Exch 2             ;       <Hash> $1 $0
   Exch $2            ;       $2 $1 $0
 
-  ${StdUtils.HashFile} $0 "$1" "$0"
-  ${If} $0 == $2
+  ${If} $2 == "__DANGEROUS_SKIP_HASH_CHECK__"
+    ; ハッシュチェックをスキップする。
+    ; electron-updater などの、すでにハッシュが検証済みのものを使う場合にのみ使用すること。
     StrCpy $0 "OK"
   ${Else}
-    StrCpy $0 "Failed"
+    ${StdUtils.HashFile} $0 "$1" "$0"
+    ${If} $0 == $2
+      StrCpy $0 "OK"
+    ${Else}
+      StrCpy $0 "Failed"
+    ${EndIf}
   ${EndIf}
 
                   ; Stack $2 $1 $0

build/installer.nsh

@@ -300,8 +300,17 @@ verifyPartedFile_finish${UniqueID}:
 !macro verifyArchive Result
   Push $0 ; Stack $0
   Push $1 ;       $1 $0
+  Push $2 ;       $2 $1 $0
+
+  ${StdUtils.ValidPathSpec} $2 $archiveName
+  ${If} $2 == "ok"
+    ; アーカイブ名が有効なパスであるならそのまま使う
+    StrCpy $0 $archiveName
+  ${Else}
+    ; そうでないなら $EXEDIR からフルパスを作成する
+    StrCpy $0 "$EXEDIR\$archiveName"
+  ${EndIf}
 
-  StrCpy $0 "$EXEDIR\$archiveName"
   ${IfNot} ${FileExists} $0
     StrCpy $0 "File not found"
   ${Else}
@@ -315,7 +324,8 @@ verifyPartedFile_finish${UniqueID}:
     ${EndIf}
   ${EndIf}
 
-                  ; Stack $1 $0
+                  ; Stack $2 $1 $0
+  Pop $2          ;       $1 $0
   Pop $1          ;       $0
   Exch $0         ;       <Result>
   Pop "${Result}" ;       -empty-
@@ -485,6 +495,7 @@ verifyPartedFile_finish${UniqueID}:
     ; 正しいハッシュ値を持った 7z ファイルがあるか検証する
     ${verifyArchive} $0
   ${EndIf}
+
   ${If} $0 == "OK"
 
     StrCpy $additionalProcess "None"
@@ -770,34 +781,6 @@ Function readyPageLeave
   ${EndIf}
   readyPageLeave_finish:
 FunctionEnd
-
-; README を表示するためのオプションを流用して、
-; セットアップ完了画面にファイル削除のチェックボックスを追加する
-Function deleteArchive
-  Delete "$EXEDIR\$archiveName"
-FunctionEnd
-!define MUI_FINISHPAGE_SHOWREADME
-!define MUI_FINISHPAGE_SHOWREADME_TEXT "使い終わったダウンロード済みファイルを削除する"
-!define MUI_FINISHPAGE_SHOWREADME_NOTCHECKED
-!define MUI_FINISHPAGE_SHOWREADME_FUNCTION deleteArchive
-
-!macroend
-
-!macro customHeader
-  ; インストール成功後に%LOCALAPPDATA%\voicevox-updater\を削除する
-  Function .onInstSuccess
-    ; https://github.com/electron-userland/electron-builder/blob/f717e0ea67cec7c5c298889efee7df724838491a/packages/app-builder-lib/templates/nsis/include/installer.nsh#L77
-    ${if} $installMode == "all"
-      SetShellVarContext current
-    ${endif}
-    Push $R0
-    ${GetParent} "$LOCALAPPDATA\${APP_PACKAGE_STORE_FILE}" $R0
-    RMDir /r "$R0"
-    Pop $R0
-    ${if} $installMode == "all"
-      SetShellVarContext all
-    ${endif}
-  FunctionEnd
 !macroend
 
 ; "%VITE_APP_NAME%"が空の状態でビルドすると他のソフトのファイルを消してしまうためビルドエラーにする。

dev-app-update.yml

@@ -0,0 +1,4 @@
+provider: generic
+url: http://localhost:3000
+useMultipleRangeRequest: false
+updaterCacheDirName: voicevox-updater

electron-builder.config.cjs

@@ -130,9 +130,9 @@ const builderOptions = {
     allowToChangeInstallationDirectory: true,
   },
   publish: {
-    provider: "github",
-    repo: "voicevox",
-    vPrefixedTagName: false,
+    provider: "generic",
+    url: "http://localhost:3000",
+    useMultipleRangeRequest: false,
   },
   linux: {
     artifactName: LINUX_ARTIFACT_NAME !== "" ? LINUX_ARTIFACT_NAME : undefined,

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "voicevox",
-  "version": "999.999.999",
+  "name": "voicevox-test",
+  "version": "0.24.8",
   "author": "Hiroshiba Kazuyuki",
   "private": true,
   "main": "./dist/main.js",
@@ -59,6 +59,7 @@
     "async-lock": "1.4.1",
     "dayjs": "1.11.13",
     "electron-log": "5.4.1",
+    "electron-updater": "6.6.2",
     "electron-window-state": "5.0.3",
     "encoding-japanese": "2.2.0",
     "fast-array-diff": "1.1.0",

src/backend/browser/sandbox.ts

@@ -244,4 +244,7 @@ export const api: Sandbox = {
   getPathForFile(/* file: File */) {
     throw new Error(`Not supported on Browser version: getPathForFile`);
   },
+  updateApp(/* version: string */) {
+    throw new Error(`Not supported on Browser version: updateApp`);
+  },
 };

src/backend/electron/ipcMainHandle.ts

@@ -9,6 +9,7 @@ import { IpcMainHandle } from "./ipc";
 import { getEngineInfoManager } from "./manager/engineInfoManager";
 import { getEngineProcessManager } from "./manager/engineProcessManager";
 import { getWindowManager } from "./manager/windowManager";
+import { getUpdateManager } from "./manager/updateManager";
 import { AssetTextFileNames } from "@/type/staticResources";
 import { failure, success } from "@/type/result";
 import {
@@ -354,5 +355,9 @@ export function getIpcMainHandle(params: {
         return failure(a.code, a);
       }
     },
+
+    UPDATE_APP: async (_, obj) => {
+      await getUpdateManager().updateApp(obj.version);
+    },
   };
 }

src/backend/electron/main.ts

@@ -1,7 +1,4 @@
-"use strict";
-
 import path from "path";
-
 import fs from "fs";
 import { pathToFileURL } from "url";
 import { app, dialog, Menu, net, protocol, shell } from "electron";

src/backend/electron/manager/updateManager.ts

@@ -0,0 +1,55 @@
+import { autoUpdater as electronUpdater } from "electron-updater";
+import { DisplayableError } from "@/helpers/errorHelper";
+import { createLogger } from "@/helpers/log";
+
+const log = createLogger("AutoUpdateManager");
+
+// ログの設定
+electronUpdater.logger = createLogger("electron-updater");
+// 手動でアップデートをダウンロードするために自動ダウンロードを無効化
+electronUpdater.autoDownload = false;
+// アプリ終了時に自動的にインストールする挙動を無効化
+electronUpdater.autoInstallOnAppQuit = false;
+// 開発版でもアップデートを有効化する
+electronUpdater.forceDevUpdateConfig = true;
+
+electronUpdater.on("error", (error) => {
+  log.error("AutoUpdater error:", error);
+});
+
+electronUpdater.on("update-downloaded", (info) => {
+  log.info("Update downloaded:", info);
+});
+
+export class UpdateManager {
+  constructor() {}
+  async updateApp(version: string) {
+    const latest = await electronUpdater.checkForUpdates();
+    if (latest == null || latest.updateInfo == null) {
+      log.error("Assertion failed: Latest update info is null");
+      throw new DisplayableError(
+        `アップデートサーバーからの情報が取得できませんでした。時間をおいてからもう一度やり直してください。`,
+      );
+    }
+    if (latest.updateInfo.version !== version) {
+      log.error(
+        `Assertion failed: Server's latest: ${latest?.updateInfo.version}, Current: ${version}`,
+      );
+      throw new DisplayableError(
+        `アップデートサーバーのバージョンが現在のバージョンと異なります。時間をおいてからもう一度やり直してください。`,
+      );
+    }
+
+    await electronUpdater.downloadUpdate();
+    log.info("Quitting and installing update...");
+    electronUpdater.quitAndInstall();
+  }
+}
+
+let managerInstance: UpdateManager | null = null;
+export function getUpdateManager(): UpdateManager {
+  if (managerInstance == null) {
+    managerInstance = new UpdateManager();
+  }
+  return managerInstance;
+}

src/backend/electron/renderer/preload.ts

@@ -222,6 +222,10 @@ const api: Sandbox = {
   getPathForFile: async (file) => {
     return webUtils.getPathForFile(file);
   },
+
+  updateApp: async (obj) => {
+    return await ipcRendererInvokeProxy.UPDATE_APP(obj);
+  },
 };
 
 const wrapApi = (baseApi: Sandbox): SandboxWithTransferableResult => {