requestDataがFileパケット応答に対してresolveしない

[9c5s]

概要

requestData(ArtworkData, layer) が Request パケットを送信後、応答が File (MessageType=204) パケットで返ってくるが、pending request のマッチングが機能せず Promise が永久にハングする。

再現手順

1. TCNASDP認証を有効にして接続
2. await client.requestData(TCNetDataPacketType.ArtworkData, layer) を実行
3. Promise が resolve/reject されず永久にハングする

原因

requestData は pending request を dataType-layer キーで登録し、受信パケットとマッチングする。しかし Artwork の応答は File (MessageType=204) パケットで返ってくるため、Data (MessageType=200) パケットを期待するマッチングロジックに合致しない。

応答データは data イベントとして発火するが、pending request は消費されないまま残り、requestTimeout も発火しない。

期待動作

File (204) パケットの応答も pending request とマッチングし、Promise が正しく resolve される。または requestTimeout が確実に発火して reject される。

ワークアラウンド

tcnet-viewer 側では requestData を fire-and-forget にし、data イベントハンドラで Artwork データを処理している。

[coderabbitai]

Coding Plan

Summary

• receiveUnicast内でFile(204)パケットがpending requestとマッチングしない根本原因を特定し修正する
• layer値のエンコーディングがData(200)とFile(204)パケット間で一貫していることを保証する
• タイムアウト機構が確実に動作することを確認し、Promiseがハングする状態を防止する
• 回帰防止のためFile(204)パケット応答に対するrequestDataの統合テストを追加する

Design Choices

Design Choice 1: File (204)パケットの`layer`値の解釈について

Options Considered:

1. TCNetFilePacketにDataPacketと同じlayer変換ロジックを明示的に追加する
2. receiveUnicast内でFile/Data両方に対して統一的なlayer値正規化を行う

Chosen Option: 2

Rationale: receiveUnicast内で統一的に処理することで、既存の継承構造を変更せず、変換ロジックを一箇所に集約できる

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: File (204)パケットのpending requestマッチング修正

このフェーズでは、receiveUnicast内のパケット処理ロジックを調査・修正し、File(204)パケットがData(200)パケットと同様にpending requestと正しくマッチングされることを保証する。

Task 1: receiveUnicastのパケット処理ロジック調査と修正

receiveUnicast内でFile(204)パケットがpending requestとマッチングしない原因を特定し修正する。

• src/tcnet.tsのreceiveUnicastメソッドを調査し、File/Dataパケット間でlayer値のエンコーディングが一貫しているか確認する
• dataPacket.layerの値がpending requestのキー生成時と同じ0-based形式になることを保証する
• 必要に応じて、キー生成前にlayer値を正規化するロジックを追加する

Task 2: タイムアウト機構の動作確認と修正

pending requestがマッチングしない場合でもタイムアウトが確実に発火することを確認する。

• src/tcnet.tsのrequestDataで設定されるタイムアウトが、pending requestがマッチングしない場合にも発火することを確認する
• タイムアウトが発火しない条件（誤ってクリアされている等）がないか確認し、必要に応じて修正する

🤖 Prompt for AI agents

このフェーズでは`src/tcnet.ts`のpending
requestマッチングロジックを修正し、File(204)パケットがData(200)パケットと同様に正しくマッチングされるようにする。

**Task 1.1: receiveUnicastのパケット処理ロジック調査と修正**
- `src/tcnet.ts`の`receiveUnicast`メソッドを調査する
- File(204)パケットとData(200)パケット間で`layer`値のエンコーディングが一貫しているか確認する
- `dataPacket.layer`の値がpending requestのキー生成時と同じ0-based形式になっているかを検証する
-
必要に応じて、キー生成前にlayer値を正規化するロジックを`receiveUnicast`内に追加する（File/Data両方に対して統一的に処理すること）

**Task 1.2: タイムアウト機構の動作確認と修正**
- `src/tcnet.ts`の`requestData`メソッドで設定されるタイムアウトを調査する
- pending requestがマッチングしない場合でもタイムアウトが確実に発火することを確認する
- タイムアウトが発火しない条件（例：誤ってクリアされている等）がないか確認し、必要に応じて修正する

Phase 2: テストカバレッジの追加

このフェーズでは、File(204)パケット応答に対するrequestDataのPromise解決を検証するテストを追加し、回帰を防止する。

Task 1: requestDataとFile(204)パケットの統合テスト追加

requestDataがFile(204)パケット応答で正しくPromiseをresolveすることを検証するテストを追加する。

• tests/artwork.test.tsに、requestData(ArtworkData, layer)のPromiseが実際にresolveされることを明示的に検証するテストを追加する
• マルチパケットシナリオ（複数のFile(204)パケット）でPromiseが正しくresolveされることをテストする
• 既存のcreateFilePacketBufferヘルパーを活用してテストパケットを生成する

Task 2: タイムアウト動作のテスト追加

pending requestがマッチングしない場合にタイムアウトでPromiseがrejectされることを検証するテストを追加する。

• tests/ディレクトリに、不正なlayer値を持つパケットを送信した場合にrequestDataがタイムアウトでrejectされることを検証するテストを追加する
• タイムアウト時間を短く設定したテスト用設定を使用して、テスト実行時間を短縮する

🤖 Prompt for AI agents

このフェーズでは、File(204)パケット応答に対する`requestData`のPromise解決を検証するテストを追加し、回帰を防止する。

**Task 2.1: requestDataとFile(204)パケットの統合テスト追加**
- `tests/artwork.test.ts`にテストを追加する
- `requestData(ArtworkData, layer)`のPromiseが実際にresolveされることを明示的に検証するテストケースを実装する
- マルチパケットシナリオ（複数のFile(204)パケット）でPromiseが正しくresolveされることも検証する
- `tests/helpers.ts`の`TestTCNetClient`および`simulateUnicast`を使用してパケット受信をシミュレートする
- 既存の`createFilePacketBuffer`ヘルパーを活用してテストパケットを生成する

**Task 2.2: タイムアウト動作のテスト追加**
- `tests/`ディレクトリに新しいテストを追加する
- 不正なlayer値を持つパケットを送信した場合に、`requestData`がタイムアウトでrejectされることを検証する
- タイムアウト時間を短く設定したテスト用設定を使用して、テスト実行時間を短縮する

Research

TCNetClientはsrc/tcnet.tsでUDPパケットの送受信を管理する。requestDataメソッドはdataType-layerキーでpending requestを登録し、receiveUnicastで受信パケットとマッチングする。File(204)パケットはTCNetFilePacketクラス(src/network.ts)で処理され、TCNetDataPacketを継承している。マルチパケット応答はMultiPacketAssembler(src/multi-packet.ts)で組み立てられる。テストはtests/helpers.tsのTestTCNetClientを使用し、simulateUnicastでパケット受信をシミュレートする。

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

このフェーズでは`src/tcnet.ts`のpending
requestマッチングロジックを修正し、File(204)パケットがData(200)パケットと同様に正しくマッチングされるようにする。

**Task 1.1: receiveUnicastのパケット処理ロジック調査と修正**
- `src/tcnet.ts`の`receiveUnicast`メソッドを調査する
- File(204)パケットとData(200)パケット間で`layer`値のエンコーディングが一貫しているか確認する
- `dataPacket.layer`の値がpending requestのキー生成時と同じ0-based形式になっているかを検証する
-
必要に応じて、キー生成前にlayer値を正規化するロジックを`receiveUnicast`内に追加する（File/Data両方に対して統一的に処理すること）

**Task 1.2: タイムアウト機構の動作確認と修正**
- `src/tcnet.ts`の`requestData`メソッドで設定されるタイムアウトを調査する
- pending requestがマッチングしない場合でもタイムアウトが確実に発火することを確認する
- タイムアウトが発火しない条件（例：誤ってクリアされている等）がないか確認し、必要に応じて修正する
===============================================================================

Task: 2

このフェーズでは、File(204)パケット応答に対する`requestData`のPromise解決を検証するテストを追加し、回帰を防止する。

**Task 2.1: requestDataとFile(204)パケットの統合テスト追加**
- `tests/artwork.test.ts`にテストを追加する
- `requestData(ArtworkData, layer)`のPromiseが実際にresolveされることを明示的に検証するテストケースを実装する
- マルチパケットシナリオ（複数のFile(204)パケット）でPromiseが正しくresolveされることも検証する
- `tests/helpers.ts`の`TestTCNetClient`および`simulateUnicast`を使用してパケット受信をシミュレートする
- 既存の`createFilePacketBuffer`ヘルパーを活用してテストパケットを生成する

**Task 2.2: タイムアウト動作のテスト追加**
- `tests/`ディレクトリに新しいテストを追加する
- 不正なlayer値を持つパケットを送信した場合に、`requestData`がタイムアウトでrejectされることを検証する
- タイムアウト時間を短く設定したテスト用設定を使用して、テスト実行時間を短縮する

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[9c5s]

receiveUnicast (tcnet.ts L734-736) でTCNetFilePacketを判定しhandleFileChunkPacketへ分岐する処理を実装済み。fileChunks蓄積→fileCollectionTimeout完了→resolve/rejectの仕組みが動作している