feat: Text Data (Type=128) パケットの実装

[9c5s]

概要

Text Data (Type=128) パケットの送受信を実装する。

仕様 (TCNET V3.5.1B)

• サイズ: 42 + DataSize バイト / ブロードキャスト or ユニキャスト
• ASCII形式のテキストデータ転送

パケット構造

Byte	Size	Type	説明
24	1	UInt8	Step
25	1	-	RESERVED
26	4	UInt32LE	Data Size
30	12	-	RESERVED
42	DataSize	ASCII	Text Data

実装タスク

• TCNetTextDataPacket クラスの実装 (read/write)
• TCNetPackets[128] へのマッピング登録
• テスト

[coderabbitai]

Coding Plan

Summary

• 既存のTCNetRequestPacketをモデルとした送受信両対応パケットクラスを実装
• 可変長データはdataSizeフィールドで長さを管理し、length()で動的計算
• 既存のASCII文字列処理パターン（null終端処理含む）を踏襲
• 既存テストパターンに従った包括的なテストを作成

Design Choices

Design Choice 1: 可変長パケットの`length()`メソッドの実装方針

Options Considered:

1. 常に-1を返し、長さ検証をスキップする（TCNetDataPacketBigWaveFormのパターン）
2. textDataフィールドの長さから動的に計算する（42 + textData.length）

Chosen Option: 2

Rationale: オプション2: sendPacket()がlength()を呼び出してバッファを確保するため、送信時に正確なサイズを返す必要がある。42 + Buffer.from(this.textData ?? "", "ascii").lengthで動的計算する。

💡 User Tips

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

Implementation Steps

Phase 1: TCNetTextDataPacketクラスの実装とマッピング登録

Text Data (Type=128) パケットを処理するクラスを実装し、パケットディスパッチャーに登録する。

Task 1: TCNetTextDataPacketクラスの作成

src/network.tsに新規パケットクラスを追加し、仕様に従ったバイナリ読み書きを実装する。

• TCNetPacketを継承したTCNetTextDataPacketクラスをsrc/network.tsに追加
• フィールド定義: step: number, dataSize: number, textData: string
• read()メソッド: オフセット24からStep(UInt8)、26からDataSize(UInt32LE)、42からTextData(ASCII)を読み取り。TextDataはdataSizeバイト分をslice().toString("ascii")で取得し、null文字を除去
• write()メソッド: 各フィールドを仕様通りのオフセットに書き込み。TextDataはbuffer.write()でASCII書き込み、長さアサーションを追加
• length()メソッド: 42 + Buffer.from(this.textData ?? "", "ascii").lengthを返却
• type()メソッド: TCNetMessageType.Text (128)を返却

Task 2: TCNetPacketsマッピングへの登録

新規クラスをパケットディスパッチャーに登録する。

• src/network.tsのTCNetPacketsオブジェクトで[TCNetMessageType.Text]: nullを[TCNetMessageType.Text]: TCNetTextDataPacketに変更
• コメント「未実装」を削除

🤖 Prompt for AI agents

`src/network.ts`に`TCNetTextDataPacket`クラスを新規追加し、`TCNetPackets`マッピングに登録するフェーズ。既存の`TCNetRequestPacket`をモデルとして、送受信両対応の可変長パケットクラスを実装することが目標。

**クラス作成（`src/network.ts`）**
- `TCNetPacket`を継承した`TCNetTextDataPacket`クラスを追加
- 以下のフィールドを定義:
  - `step: number`
  - `dataSize: number`
  - `textData: string`
- `read()`メソッドを実装:
  - オフセット24からStep（UInt8）を読み取り
  - オフセット26からDataSize（UInt32LE）を読み取り
-
オフセット42から`dataSize`バイト分をASCIIで読み取り（`slice().toString("ascii")`）、null文字を除去してTextDataに格納
- `write()`メソッドを実装:
  - 各フィールドを仕様通りのオフセットに書き込み
  - TextDataは`buffer.write()`でASCII書き込み
  - 長さアサーションを追加
- `length()`メソッド: `42 + Buffer.from(this.textData ?? "", "ascii").length`を返却
- `type()`メソッド: `TCNetMessageType.Text`（128）を返却

**マッピング登録（`src/network.ts`）**
- `TCNetPackets`オブジェクト内の`[TCNetMessageType.Text]:
null`を`[TCNetMessageType.Text]: TCNetTextDataPacket`に変更
- コメント「未実装」を削除

Phase 2: テストの実装

既存のテストパターンに従い、パケットの読み書きを検証するテストを作成する。

TCNetTextDataPacketのテスト作成

tests/packet-parsers.test.tsに新規テストスイートを追加する。

• 既存のwriteValidHeader()とcreateHeader()ヘルパーを使用
• パーステスト: 既知のバイト値を含むバッファを作成し、read()後にフィールド値を検証。Step、DataSize、TextDataの各値が正しく読み取られることを確認
• ラウンドトリップテスト: フィールドに値を設定してwrite()を呼び出し、新しいパケットでread()して値が一致することを確認
• length()テスト: 空文字列、短いテキスト、長いテキストで正しいサイズ（42 + textData長）を返すことを確認
• type()テスト: TCNetMessageType.Text (128)を返すことを確認
• エッジケース: 空のTextData（DataSize=0）の処理を検証

🤖 Prompt for AI agents

`tests/packet-parsers.test.ts`に`TCNetTextDataPacket`の新規テストスイートを追加するフェーズ。既存のテストパターンおよびヘルパー関数を踏襲し、パケットの読み書きを包括的に検証することが目標。

**テストスイートの追加（`tests/packet-parsers.test.ts`）**
- 既存の`writeValidHeader()`と`createHeader()`ヘルパーを使用する
- 以下のテストケースを実装:
- **パーステスト**:
既知のバイト値を含むバッファを作成し、`read()`後にStep・DataSize・TextDataの各値が正しく読み取られることを検証
  - **ラウンドトリップテスト**: フィールドに値を設定して`write()`を呼び出し、新しいパケットで`read()`して値が一致することを確認
  - **`length()`テスト**: 空文字列・短いテキスト・長いテキストのそれぞれで正しいサイズ（42 + textData長）が返ることを確認
  - **`type()`テスト**: `TCNetMessageType.Text`（128）が返ることを確認
  - **エッジケース**: 空のTextData（DataSize=0）の処理を検証

Research

このコードベースはTCNetプロトコルのTypeScript実装である。src/network.tsに全パケットクラスが定義され、TCNetPacket基底クラスを継承してread()/write()/length()/type()メソッドを実装するパターンに従う。TCNetPacketsマッピングでメッセージタイプと実装クラスを紐付けている。TCNetMessageType.Text = 128は既に定義済みだが、実装クラスはnull（未実装）となっている。送受信可能なパケットの参考実装としてTCNetRequestPacketがある。

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

`src/network.ts`に`TCNetTextDataPacket`クラスを新規追加し、`TCNetPackets`マッピングに登録するフェーズ。既存の`TCNetRequestPacket`をモデルとして、送受信両対応の可変長パケットクラスを実装することが目標。

**クラス作成（`src/network.ts`）**
- `TCNetPacket`を継承した`TCNetTextDataPacket`クラスを追加
- 以下のフィールドを定義:
  - `step: number`
  - `dataSize: number`
  - `textData: string`
- `read()`メソッドを実装:
  - オフセット24からStep（UInt8）を読み取り
  - オフセット26からDataSize（UInt32LE）を読み取り
-
オフセット42から`dataSize`バイト分をASCIIで読み取り（`slice().toString("ascii")`）、null文字を除去してTextDataに格納
- `write()`メソッドを実装:
  - 各フィールドを仕様通りのオフセットに書き込み
  - TextDataは`buffer.write()`でASCII書き込み
  - 長さアサーションを追加
- `length()`メソッド: `42 + Buffer.from(this.textData ?? "", "ascii").length`を返却
- `type()`メソッド: `TCNetMessageType.Text`（128）を返却

**マッピング登録（`src/network.ts`）**
- `TCNetPackets`オブジェクト内の`[TCNetMessageType.Text]:
null`を`[TCNetMessageType.Text]: TCNetTextDataPacket`に変更
- コメント「未実装」を削除
===============================================================================

Task: 2

`tests/packet-parsers.test.ts`に`TCNetTextDataPacket`の新規テストスイートを追加するフェーズ。既存のテストパターンおよびヘルパー関数を踏襲し、パケットの読み書きを包括的に検証することが目標。

**テストスイートの追加（`tests/packet-parsers.test.ts`）**
- 既存の`writeValidHeader()`と`createHeader()`ヘルパーを使用する
- 以下のテストケースを実装:
- **パーステスト**:
既知のバイト値を含むバッファを作成し、`read()`後にStep・DataSize・TextDataの各値が正しく読み取られることを検証
  - **ラウンドトリップテスト**: フィールドに値を設定して`write()`を呼び出し、新しいパケットで`read()`して値が一致することを確認
  - **`length()`テスト**: 空文字列・短いテキスト・長いテキストのそれぞれで正しいサイズ（42 + textData長）が返ることを確認
  - **`type()`テスト**: `TCNetMessageType.Text`（128）が返ることを確認
  - **エッジケース**: 空のTextData（DataSize=0）の処理を検証

💡 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]

調査結果: Text Data は実装しない

Bridgeバイナリ解析でTCNet関連ルーチン一覧に cmdOfferTCNetText が存在しないことを確認。Bridge-ShowKontrol間の41万パケットキャプチャでもType=128は0件。Control (#52) と同様の死仕様。

[9c5s]

死仕様のため実装しない。