クラウド Mac で iOS AsyncStream のバッファと終了契約をテストする

クラウド Mac で iOS AsyncStream のバッファと終了契約をテストする

クラウド Mac で iOS AsyncStream のバッファと終了契約をテストする

iOS の画面で AsyncStream を使って進捗イベントを受け取っていると、操作頻度が低いときは問題なくても、連続して操作すると途中の状態が抜け落ちることがあります。画面を離れた後も、内部のリスナーが動き続ける場合もあります。まずは待ち時間を増やすのではなく、VPSPull のクラウド Mac でイベントの生成と消費の順序を固定し、バッファ、終了、クリーンアップの契約をそれぞれ検証しましょう。リモートデスクトップで何度もクリックするより、問題を切り分けやすくなります。

破棄してよいイベントを先に決める

進捗率は通常、最新の状態だけ分かれば十分ですが、支払いの確認やファイルの引き渡し記録は、むやみに失ってよいものではありません。まず、ストリームについて三つの条件を明文化します。どの値を必ず届けるのか、イベントが滞留したときにどう扱うのか、誰がプロデューサーを停止するのか。業務上の判断をデフォルトのバッファリングポリシーに任せないことが重要です。

unbounded は未消費の要素を保持しますが、生成が続くとメモリ使用量が増え続ける可能性があります。bufferingNewest(2) は最新の二つの要素を保持し、bufferingOldest(2) は消費待ちの要素のうち最も古い二つを保持します。ここでの容量は要素数であり、バイト数ではありません。大きなオブジェクトなら、少数でも多くのメモリを占有する可能性があります。

バッファに上限があることと、バックプレッシャーが働くことは別です。AsyncStream の yield は、コンシューマーがバッファに空きを作るまで待ちません。イベントを欠落なく届ける必要があるなら、確認応答、レート制限、永続化などの仕組みを別途用意する必要があります。

まずはコンシューマーを一つに絞ってテストします。複数のタスクで同じストリームを消費しても、「すべての購読者がすべてのイベントを受け取る」ブロードキャストモデルとして扱うことはできません。

スケジューリングの偶然に依存しないフィクスチャを作る

Swift ツールチェーンを準備済みのターミナルで、次を実行します。

mkdir StreamContract
cd StreamContract
swift package init --type library --name StreamContract
swift --version

生成されたテストファイルの内容を、以下の XCTest テストに置き換えます。ファイルの配置先は Tests/StreamContractTests/StreamContractTests.swift です。テンプレートがほかにもテストファイルを生成している場合は、そのサンプルテストを先に削除し、無関係な結果がレポートに混ざらないようにします。

import XCTest

final class StreamContractTests: XCTestCase {
    func testNewestBufferDrainsAfterFinish() async {
        let pair = AsyncStream<Int>.makeStream(
            bufferingPolicy: .bufferingNewest(2)
        )

        pair.continuation.yield(1)
        pair.continuation.yield(2)

        switch pair.continuation.yield(3) {
        case .dropped(let value):
            XCTAssertEqual(value, 1)
        default:
            XCTFail("Expected the oldest buffered value to be dropped")
        }

        pair.continuation.finish()

        var iterator = pair.stream.makeAsyncIterator()
        let first = await iterator.next()
        let second = await iterator.next()
        let end = await iterator.next()

        XCTAssertEqual(first, 2)
        XCTAssertEqual(second, 3)
        XCTAssertNil(end)

        switch pair.continuation.yield(4) {
        case .terminated:
            break
        default:
            XCTFail("Expected a terminated stream")
        }
    }
}

続いて swift test を実行します。このテストは生成を先に、消費を後に行うことで、バッファを確実にあふれさせます。スリープを挟んでスケジューリングの順序を推測する必要はありません。ツールチェーンに makeStream がない場合は、まず Swift のバージョンを確認するか、初期化クロージャーで continuation を取得する方式に変更します。「互換性を持たせる」ために、バッファあふれのアサーションを削除してはいけません。

消費結果だけでなく、破棄された値も検証する

最終的に 2、3 を受け取ったことだけを検証しても不十分です。誤った実装が 1 を明示的に除外し、たまたま同じ結果になる可能性があるためです。yield が返す .dropped の値を確認して初めて、バッファリングポリシーの段階で要素が破棄されたと判断できます。

次にテストを複製し、bufferingOldest(2) に変更します。三回目の yield は 3 が破棄されたことを報告し、消費結果は 1、2 になるはずです。これらの期待値は、それぞれ独立した名前を持つテストとして定義します。テスト内部で実際の出力に合わせて正解を変えてはいけません。

境界条件も一つ追加します。容量がゼロで、待機中のコンシューマーがいない場合、yield した要素は破棄されます。容量ゼロは同期的な受け渡しを保証するものではありません。先にコンシューマーを起動するテストでは、「すでに待機している」ことを示す同期シグナルが必要です。そうしないと、タスクのスケジューリングによって結果が変わります。

実際のオブジェクトを扱う場合は、イベントを一意に識別できる安定した番号を記録すれば十分です。ペイロード全体をログに書き出す必要はありません。データが大きい場合でも、番号、破棄回数、バッファリングポリシーを記録しておけば分析できます。

finish、キャンセル、途中退出を分けて検証する

finish() は新しい要素を受け付けなくなることを意味します。すでにバッファにある要素を即座に破棄するわけではありません。上のテストでは、まず 2、3 を読み切り、その後の next が nil を返すことを意図的に検証しています。終了後の yield は .terminated を返すはずです。

キャンセルのテストには、別のフィクスチャを用意します。消費タスクを next で待機させ、そのタスクをキャンセルしてから、タスクの終了を待ちます。スレッドセーフなカウンターまたはテストの expectation で onTermination を記録し、終了理由がキャンセルであることと、内部のリスナーが停止したことを確認します。有限のタイムアウトはテストのハングを防ぐためのものであり、業務上の動作が正しいことの証拠にはなりません。

途中退出には明示的な所有者が必要

ループ内の break は、ループを抜けるだけです。ストリームや continuation をほかのオブジェクトが保持している場合、それだけでリスナーが解放されたとは判断できません。アダプターに明示的な stop を用意し、画面またはサービスの所有者から呼び出したうえで、登録解除の回数を確認します。

onTermination は並行実行コンテキストから呼ばれる可能性があります。クリーンアップ用クロージャーがキャプチャする状態は、並行アクセスに対応していなければなりません。メインスレッドからしかアクセスできない UI オブジェクトを直接変更してはいけません。また、内部ロックを保持したまま finish を呼び出し、終了コールバックで同じロックを取得する構成も避けてください。

待ち時間を増やさず、失敗マトリクスで検証を締めくくる

最終的には、少なくとも四種類の検証を残します。最新優先のバッファが古い値を破棄すること、最古優先のバッファが新しい値を拒否すること、正常終了時にバッファを読み切ること、キャンセル後に生成が停止することです。それぞれで値、終了状態、クリーンアップ回数を確認し、「テストは通るのにリソースは動き続けている」という状態を防ぎます。

さらに、偽のリスナーで停止時の競合を再現します。stop の後にもう一度コールバックを発生させても、アダプターは安全に無視するか、terminated を受け取る必要があり、業務イベントを重複して届けてはいけません。stop を連続して呼び出した場合も冪等性を保ち、同じリスナーハンドルの登録解除を繰り返さないようにします。

変更を提出するときは、ツールチェーンのバージョン、テストコマンド、失敗したテストケース名も一緒に保存します。順序を固定したテストは安定しているのに実際の画面ではイベントが欠落するなら、次に調べるのはイベントソースのアダプターとコンシューマーの処理速度です。フィクスチャ自体が不安定なら、まず同期方法を修正します。スリープを長くして競合を隠してはいけません。

よくある質問

bufferingNewest は生成側を待機させますか?

いいえ。バッファが満杯になると古い要素を破棄し、yield がその値を通知しますが、消費側を待ちません。有界かつ無損失の転送には別途確認応答や流量制御が必要です。

ループを break すればリスナーはすぐ解放されますか?

必ずしもそうではありません。ストリームと continuation が保持され続ける可能性があります。所有者が明示的に停止し、キャンセル、手動停止、正常終了をそれぞれ検証してください。

専用 Mac でワークフローを検証

モデル、ノード、利用期間を確認してから、まずは1日単位でお試しください。実際の利用可否はコントロールパネルに表示される最新状況をご確認ください。