VOICEVOX ENGINEの実行コマンドをrun.exeから./runに変更する

[aoirint]

内容

Linux用実行バイナリでも、VOICEVOXから相対パスにあるVOICEVOX ENGINEを実行できるようにします。

関連 Issue

ref #218

[Hiroshiba]

どんなwindows環境でも、exe拡張子を書かなくてもちゃんと動くものなのかが若干気になりました。

[aoirint]

どんなwindows環境でも、exe拡張子を書かなくてもちゃんと動くものなのか

たしかにそうですね。

一応、child_process.execFileの処理を追ってみました。

調査の結果としては、挙動がWindows（Win32 API）ではなく、Node.js（libuv）に依存するため、動きます。
しかしこのPRは、OS間でENGINEの実行コマンドを共通化できるメリットがありますが、
将来的に、ENGINEの実行ファイルの存在チェックがしにくくなるというデメリットがあるように思いました。

child_process.execFileの処理

Windowsでは、拡張子を指定せずにchild_process.execFileを呼び出したときの挙動は、Windows（Win32 API）ではなく、Node.jsが内部で使っているライブラリのlibuvの仕様に依存します。

libuvは、ファイル名に拡張子がない場合、ファイルの存在をチェックして、.comまたは.exeの拡張子を付加することを試みる仕様になっています。

• https://github.com/nodejs/node/blob/c61870c376e2f5b0dbaa939972c46745e21cdbdd/deps/uv/src/win/process.c#L285

補完される拡張子は、Win32 API CreateProcessWや環境変数 PATHEXTとは関係なく、libuvによって決まります。

環境変数PATHEXTについては、Node.js v0.xのときの議論がありました。このときから、Node.js内部でlibuvを使っていて、.exeを補完する仕様については変わっていないように思われます。

• child_process.spawn ignores PATHEXT on Windows nodejs/node-v0.x-archive#2318

一方で、libuvが内部で呼び出しているWin32 APIのCreateProcessWでは、ディレクトリパスを含むファイル名が指定されたとき、.exeは補完されない仕様のようです。

lpApplicationName
...
If the file name does not contain an extension, .exe is appended.
...
If the file name ends in a period (.) with no extension, or if the file name contains a path, .exe is not appended.

• https://docs.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-createprocessw#:~:text=If%20the%20file%20name%20does%20not%20contain%20an%20extension,%20.exe%20is%20appended.

調査の結果

結果として、コードは動きますが、
WindowsのCreateProcessWに合わせるならば.exeを明示した方がよい、
Node.jsのchild_process.execFile（libuv）に合わせるならば.exeを明示しなくてもよい、といった形でしょうか。

このPRは、OS間でENGINEの実行コマンドを共通化して、開発しやすくする意図のものです。

個人的には、このPRが加える変更とは反しますが、ENGINE_PATHを実行ファイルの場所を指定している、ととらえれば、.exeを省略しない方が自然ではある気がします。また実行せずに、ENGINEの実行ファイルの存在チェックができます。

将来的には、ENGINEのパスを.envとは別の設定（UI上）で指定できるようになったり、内部的にVOICEVOXのインストールとは別にENGINEをダウンロードする仕様になる可能性はあると思います。
そのときには拡張子を含むフルパスで扱い、実行とは別にファイルの存在チェックをする可能性もあると思うので、そちらに合わせるならば、.exeを省略せず、OSごとにファイル名を切り替える方がいいのかな、と思いました。

その場合、 #266 のような形でビルド時の環境変数またはyamlを使って .env.production ファイルを切り替えるか、ビルド時に .env.production を直接書き換える形になるのかなと思います。

child_process.execFileの処理の流れ

• child_process.execFile: https://github.com/nodejs/node/blob/8d83c470291d05f22010662380633bbddf0e7dcb/lib/child_process.js#L279
• child_process.spawn: https://github.com/nodejs/node/blob/8d83c470291d05f22010662380633bbddf0e7dcb/lib/child_process.js#L690
• child_process.ChildProcess: https://github.com/nodejs/node/blob/8d83c470291d05f22010662380633bbddf0e7dcb/lib/internal/child_process.js#L251
• process_wrap.ProcessWrap (Process): https://github.com/nodejs/node/blob/8d83c470291d05f22010662380633bbddf0e7dcb/src/process_wrap.cc
  • ProcessWrapとProcessの名前のマッピングをどこでしているかわからなかった
• uv_spawn (libuv): https://github.com/nodejs/node/blob/c61870c376e2f5b0dbaa939972c46745e21cdbdd/deps/uv/src/win/process.c#L936
• search_path (libuv): https://github.com/nodejs/node/blob/c61870c376e2f5b0dbaa939972c46745e21cdbdd/deps/uv/src/win/process.c#L340
• search_path (libuv): https://github.com/nodejs/node/blob/c61870c376e2f5b0dbaa939972c46745e21cdbdd/deps/uv/src/win/process.c#L340
• path_search_walk_ext (libuv): https://github.com/nodejs/node/blob/c61870c376e2f5b0dbaa939972c46745e21cdbdd/deps/uv/src/win/process.c#L255

[Hiroshiba]

調査ありがとうございます！！とても勉強になりました。

仰るとおり、ENGINE_PATHの名前を守るためにも、OSごとに何らかの方法で切り替えるのが良さそうだなと感じました。

そうですね・・・ちょっと実験的になってしまって申し訳ないのですが、 https://github.com/Hiroshiba/voicevox/pull/266 では実装をビルド時の仕様に合わせたので、こちらはビルド時のコマンドを実装に合わせてみる（コードはそのままに、Github Actions上でOSごとの.envを作るなどで対応する）というのはどうでしょう。
設定ファイルで行くか他の方法が良いかを決める今後の判断の所感も得られるかなと思っています。

[aoirint]

#266 では実装をビルド時の仕様に合わせたので、こちらはビルド時のコマンドを実装に合わせてみる
設定ファイルで行くか他の方法が良いかを決める今後の判断の所感も得られる

ひとまず、その方針でいいと思いました！

Linuxの自動ビルドのPRで対応すると思うので、このPRはCloseします。