[失敗談][C#] あえて async/await しないでドヤ顔してたら本番環境で ObjectDisposedException

C# プログラミングにおける、自分としてはとても恥ずかしい、大失敗ネタ。

とある要件から、以下のようなシグネチャを持つメソッドを実装していた。

ValueTask<Value> ReadValueAsync(Stream stream);

そこへ、さらに追加要望が発生し、上記メソッドとほぼ同じ動作とするが、Stream ではなく、ファイルへのパス名文字列を受け付けるバージョンが必要となった。

メソッドシグネチャとしては以下のような感じ。

ValueTask<Value> ReadValueAsync(string path);

そこで、パス文字列を受け取るオーバーロード版は、Stream を受け取るオリジナル版を呼び出すだけの実装とすることにした。

つまり、パス文字列受け取る版は、Stream 受け取る版に対する、すっごく薄いラッパーという訳である。

「すっごく薄いラッパー」ということで、パス文字列受け取る版は、Stream 受け取る版の戻り値を、何か加工することもなく、ただただそのまますぐに戻り値として返却して終了すればいいや、と考えた。

そのような思考経路から、「いちいち async/await する必要もなかろう」と考えて、以下の様に、パス文字列受け取る版を実装した。

ValueTask<Value> ReadValueAsync(string path) {

    using var stream = File.OpenRead(path);

    return ReadValueFromAsync(stream);

}

賢明な諸兄においては既に「あー、これはダメなやつ」とお気づきかと思うが、上記コードは間違った実装である。

どういうことか念のため以下に解説する。

非同期処理の完了を await せずに Dispose してた

まず「using」によって、「File.OpenRead()」で開かれた Stream は「ReadValueAsync(string path)」メソッドを抜けるタイミングで破棄 (Dispose) される。

いっぽうで、その Stream は「ReadValueAsync(Stream stream)」の中で非同期的に使われ続ける。

ただし、上記実装だと、「ReadValueAsync(Stream stream)」の仕事 (ValueTask) がすべて完了するのを待たずに (つまり await せずに) 、そのまま「ReadValueAsync(string path)」の呼び出し元へ返してしまう。

つまり、
「ReadValueAsync(Stream stream) がまだ仕事中 (非同期処理) なのに、ReadValueAsync(Stream stream) がまだ使っている・引数に渡した Stream を、(呼び出し元が) 破棄 (Dispose) してしまう」
という作りになっていたのだ。

しかし実装当時、な、なんと、自分はそのことに気づかずに
「ふふーん、何でもかんでも脳死で async/await したりしないもんね」
とドヤ顔していたのだ 。
(なんと恥ずかしい)

デバッグビルドや単体テスト実行時は発覚せず

そしてさらに悪いこと (?) は重なる。

上記問題のあるコードだが、なんと、デバッグビルドやそれに基づく単体テストの実行上は、例外など発生せずにこちらの期待どおりに正常実行されてしまったのである。

もっとも、正常実行されてしまったことはランタイムの仕様・仕組み上、なんら問題のあることではない。

とりわけ非同期処理が絡むような今回のようなケースではなおさら、その時々の論理コア数やCPU使用率をはじめとした様々な外部要因も複雑に絡み合い、潜在的な問題を抱えてるコードが一見正常動作してしまうことは、現在の C# プログラミング上、避けられないことであろう。

さておき、そんな事情で、いよいよ本番リリース前のテストを実行していたところ、めでたく下記例外に遭遇してしまった。

System.ObjectDisposedException: Safe handle has been closed.

Object name: 'SafeHandle'.

幸い、程なく問題を特定することができ、前述の問題に気づいて「うわーしまった...」と思いつつ、ちゃんと async/await して解決。

async ValueTask<Value> ReadValueAsync(string path) {

    using var stream = File.OpenRead(path);

    await return ReadValueFromAsync(stream);

}

おわりに

C# で async/await 構文が公式にリリースされたのは 2012 年の C# 5.0 であるとのこと (出典下記)。

それから既に 10 年前後経っていて、自分の async/await 構文との付き合いもほぼ同じ程度の年数、経験を積んでいるはずである。

それでもなお、こんな初歩的 ? なミスをやらかしてしまった。

ひたすら反省。