ngx_mruby v2.7.7
更新前に確認する挙動の変更
Section titled “更新前に確認する挙動の変更”クラスがinspectかbacktraceを再定義している例外の、error.logの行(#803)
Section titled “クラスがinspectかbacktraceを再定義している例外の、error.logの行(#803)”- 変更前:Rubyのコードが出した例外のクラスが
inspectをRubyで再定義していると、再定義したメソッドが何をしても、ngx_mrubyはその例外の行をerror.logに書きませんでした。ngx_mrubyは、例外がmrubyの状態に残ったままこのメソッドを呼んでいました。この状態では、同梱のmrubyはメソッドを最後まで実行せず、残っている例外のまま処理を進めます。そのため、メソッドが返すはずのStringも、メソッド自身が出す例外も、ngx_mrubyには届きませんでした。--with-debugのビルドでは、Rubyで再定義したbacktraceも同じように扱われ、ngx_mrubyはdebugのレベルでbacktrace must be Array. mrb_type=18を書き、フレームを書きませんでした。mruby_setのハンドラからNginx.redirectで移ったlocationのcontentハンドラでは、再定義したinspectが何をしても、また--with-debugのビルドでは再定義したbacktraceが何をしても、StringやArrayを返す場合も含めて、リクエストが終わりませんでした。残っている例外が、間にあるnginxの関数を飛び越えて、mruby_setのハンドラまで伝わったからです。mruby_setのハンドラは、その例外をもう一度ログに書きました。再定義したinspectの場合は、ここでも例外の行は書かれませんでした。再定義したbacktraceの場合は、例外の行がもう一度書かれ、フレームは書かれませんでした。その後、nginxは500の代わりに、移った先のlocationの静的ファイルから404を返しました。接続は、クライアントが待つのをあきらめるまで開いたままでした。 - 変更後:ngx_mrubyは、残っている例外を退避してから
inspectとbacktraceを呼び、これらのメソッドが出した例外をログの処理の中で止めます。inspectがStringを返すと、行にはそのStringが入ります。これは、inspectを再定義していないクラスの例外と同じ扱いです。inspectが例外を出すと、行には#<Class> (inspect raised Class)が入ります。前のClassは例外のクラス、後のClassはinspectが出した例外のクラスです。inspectがString以外を返すと、行には#<Class> (inspect did not return a String)が入ります。--with-debugのビルドでは、再定義したbacktraceの結果のうちStringの要素を1行ずつ書き、それ以外の要素は飛ばします。例外を出すか、Arrayを返さないbacktraceは、これまでどおりdebugのレベルで書きます。別のmrubyの呼び出しの中でも、nginxの直下と同じように、リクエストは500で終わり、workerは次のリクエストに進みます。 - 変更の理由:
- 不具合:
inspectとbacktraceは、例外が残ったまま呼ばれていました。そのため、Rubyで書いたメソッドは結果を返せませんでした。別のmrubyの呼び出しの中では、メソッドが何をしても、残っている例外がログの処理を抜け、リクエストが終わりませんでした。nextでは、同じ呼び出しを#796と#799で直しています。このプルリクエストは、その直しを2.xに入れます。 - 前の挙動を残せなかった理由:例外がログの処理を抜けて、リクエストを処理しているnginxの関数を飛び越えると、リクエストとその接続が開いたまま残ります。例外の行が書かれないと、運用者はエラーが起きたことをログから知ることができません。Stringを返せない
inspectの代わりにクラス名を書く行は、3.xが同じ例外に書く行と同じです。これで、2.xと3.xは同じ行を書きます。 - ドキュメントが示していた挙動:ドキュメントは、クラスが
inspectかbacktraceを再定義している例外について、何も書いていませんでした。
- 不具合:
- 影響の範囲:
inspectかbacktraceをRubyで再定義したクラスの例外を出す、すべての種類のハンドラのスクリプトです。HTTPとstreamのハンドラに加えて、nginxが設定を読むときと、workerの開始と終了のときに動くコードも含みます。これらを再定義していないクラスの例外は、これまでと1バイトも変わらない行になります。 - 必要な対応:ありません。ただし、このような例外の行を
error.logから読み取っている場合は、その行が書かれるようになり、再定義したinspectのテキストかクラス名が入ることに注意してください。
Requestのセッター、Nginx::Async::HTTP.sub_request、Nginx::Headers_in/out#[]=へのStringでない引数
Section titled “Requestのセッター、Nginx::Async::HTTP.sub_request、Nginx::Headers_in/out#[]=へのStringでない引数”アドバイザリ:GHSA-cjxv-4q9m-62pf
- 変更前:
Nginx::Request#uri=、#args=、#method=、#protocol=、#request_line=、#unparsed_uri=、#content_type=(1つのマクロを共有)、Nginx::Async::HTTP.sub_request(リクエストのpath)、Nginx::Headers_in#[]=とNginx::Headers_out#[]=(ヘッダ名と各値)は、引数がStringかどうかを確かめず、Stringでない引数をStringとして読んでいました。 - 変更後:これらのメソッドは、Stringでない引数に対して
TypeErrorを出します。Nginx.rputs、Nginx.echo、Nginx.redirect、Nginx::Filter#body=、Nginx::Varのセッターと同じ扱いです(#775)。nilの引数はこれまでの意味を保ちます。セッターはメンバーを変えずに戻り、Headers#[]=はヘッダを削除します。 - 変更の理由:
- 不具合:これらのメソッドは、引数の型を確かめずにStringとして読んでいました。詳細は、上にリンクしたアドバイザリが示します。
- 前の挙動を残せなかった理由:Stringでない値にはStringとしての内容がないため、Stringとして読んでも定まった結果になりません。
- ドキュメントが示していた挙動:これらのメソッドのドキュメントは、Stringの引数を説明しています。
- 影響の範囲:これらのメソッドのいずれかに、Stringでないかもしれない値を渡すスクリプトです。Stringだけを渡すスクリプト(リテラル、式展開した文字列、変換済みの値)は影響を受けません。
- 必要な対応:スクリプトがStringでない値をこれらのメソッドに渡しうる場合は、
.to_sなどで変換するか、TypeErrorを処理してください。
ありません。
不具合の修正
Section titled “不具合の修正”- 例外のクラスがRubyで
inspectを再定義しているか、--with-debugのビルドでbacktraceを再定義していて、mruby_setのハンドラからNginx.redirectで移ったlocationのcontentハンドラでその例外が出たとき、メソッドが何をしても、nginxはリクエストを500で終えるようになりました。これまでは、例外がmruby_setのハンドラまで伝わり、nginxは404を返し、接続はクライアントが待つのをあきらめるまで開いたままでした(#803)。 --with-debugのビルドで、再定義したbacktraceの結果のうちString以外の要素を、3.xと同じように飛ばすようになりました。これまでのコードは、型を確かめずに、すべての要素をStringとして読んでいました(#803)。Nginx::Upstream#server=とstreamのNginx::Stream::Connection#upstream_server=は、nginxのcycleのpoolが解放されるときに、peerごとのストアをリセットするようになりました。これにより、master_process offでの再読み込みの後の新しいcycleが、前のcycleのストアを再利用しなくなります(GHSA-pmjr-f94r-j47g)。
ビルドとテストの変更
Section titled “ビルドとテストの変更”- 新しいテストのケースとして、
test/t/cases/exception_log_script_methods.rbと、ポート18091のtest/conf/conf.d/94-exception-log-script-methods.confのサーバー、ポート12383と12389のtest/conf/conf.d/stream/52-exception-log-script-methods.confのstreamのサーバーを加えました(#803)。 - 新しいテストのケースとして、
test/t/cases/type_unchecked_reads.rbと、ポート18192のtest/conf/conf.d/95-type-unchecked-reads.confにあるサーバーを加えました。
アップグレード
Section titled “アップグレード”- ディレクティブの追加、名前の変更、削除はありません。2.7.6と同じ方法でこのリリースのモジュールをビルドし、バイナリか動的モジュールを置き換えてください。
アップグレードの前に、次の点を確かめてください。各行は、項目の「必要な対応」です。
inspectかbacktraceを再定義したクラスの例外の行をerror.logから読み取っているツール:このような例外の行が書かれるようになり、再定義したinspectのテキストかクラス名が入ります。- Requestのセッター、
Nginx::Async::HTTP.sub_request、Nginx::Headers_in/out#[]=にStringでないかもしれない値を渡すスクリプト:.to_sなどで変換するか、これらのメソッドがStringでない引数に対して出すTypeErrorを処理してください。