🌿

Composer Scriptsのタイムアウトを回避する方法

に公開

はじめに

ComposerのScriptsという便利な機能を使うことで任意のコマンドを実行できる。

https://getcomposer.org/doc/articles/scripts.md

ただ、少し時間がかかるコマンドを実行した場合、ある程度時間が経過するとタイムアウトが発生します。

下記は極端な例ではあるが、sleepコマンドで10分止めています。

{
    "scripts": {
        "sleep": [
            "echo 'これから10分待ちます'; sleep 10m; echo '10分経過しました';"
        ]
    }
}
$ composer sleep
これから10分待ちます
The following exception is caused by a process timeout
Check https://getcomposer.org/doc/06-config.md#process-timeout for details

In Process.php line 1205:

  The process "echo 'これから10分待ちます'; sleep 10m; echo '10分経過しました';" exceeded the timeout of 300 seconds.  


sleep [--dev] [--no-dev] [--] [<args>...]

このタイムアウトを回避する方法を調べると、Composerの公式ドキュメントで複数の方法が書かれていたのでメモとして残しておきます。

https://getcomposer.org/doc/articles/scripts.md#managing-the-process-timeout

環境

  • PHP 8.5.5
  • Composer 2.9.7

タイムアウトを回避する

公式ドキュメントにはいくつかの方法が書かれています。

  • 静的ヘルパーの利用
  • composerの設定で変更
  • 環境変数を使用
  • run-scriptコマンドのオプション指定

静的ヘルパーの利用

Composer\Config::disableProcessTimeoutをタイムアウトを無効にしたいscriptsの最初に書きます。

{
    "scripts": {
        "sleep": [
            "Composer\\Config::disableProcessTimeout",
            "echo 'これから10分待ちます'; sleep 10m; echo '10分経過しました';"
        ]
    }
}

composerの設定で変更

静的ヘルパーはscriptsごとにタイムアウトを無効にしますが、composer.jsonのconfigに書くと全てのscriptsで無効化します。

{
    "config": {
        "process-timeout": 0
    }
}

環境変数を使用

COMPOSER_PROCESS_TIMEOUT=0をコマンド実行前に設定すればタイムアウトを無効にできます。

$ COMPOSER_PROCESS_TIMEOUT=0 composer sleep

run-scriptコマンドのオプション指定

run-scriptコマンドの--timeoutオプションに0を指定することでタイムアウトを無効にできます。

composer run-script --timeout=0 sleep

補足

静的ヘルパーはタイムアウトを無効化しますが、そのほかの設定は0では無効化になります。
また、0以外ではタイムアウトまでの時間を変更できます。

{
    "config": {
        "process-timeout": 60
    }
}

まとめ

タイムアウトは複数の方法で回避できることがわかりました。

どの方法を選ぶかは状況次第ですが、
全てのscriptsのタイムアウトを無効化したい時は設定を変更で対応し、個別に無効化したい時は静的ヘルパーを使うのが良さそうですね。

GitHubで編集を提案

Discussion