diff --git a/docs/development/current/main/phase-21.7-naming-ssot-checklist.md b/docs/development/current/main/phase-21.7-naming-ssot-checklist.md index 825e1e86..d7dc91ac 100644 --- a/docs/development/current/main/phase-21.7-naming-ssot-checklist.md +++ b/docs/development/current/main/phase-21.7-naming-ssot-checklist.md @@ -13,9 +13,10 @@ | Phase 1: 基盤整備 | ✅ 完了 | 96c1345e | 3時間 | StaticMethodId SSOT 確立、13テスト全PASS | | Phase 2: VM 統一 | ✅ 完了 | 1b413da5 | 2時間 | arity バグ根治、Hotfix 卒業 | | **Phase 3: 全体統一** | ✅ 完了 | TBD | 2時間 | Builder 側統一、素手split根絶 | -| Phase 4: ドキュメント | ⏸️ 待機 | - | - | 再発防止、開発者体験向上 | +| Phase 4: ドキュメント | ✅ 完了 | TBD | 1時間 | 再発防止、開発者体験向上 | -**累計工数**: 9時間 / 15-20時間(進捗率: 45-60%) +**累計工数**: 10時間 / 15-20時間(進捗率: 50-67%) +**Phase 21.7++ 全フェーズ完了!** 🎊 --- @@ -419,7 +420,7 @@ ### タスク -- [ ] **4.1: Phase 21.7 README 更新** +- [x] **4.1: Phase 21.7 README 更新** ✅ 完了 (2025-11-22) - ファイル: `docs/development/roadmap/phases/phase-21.7-normalization/README.md` - 追記内容: ```markdown @@ -449,7 +450,7 @@ - `NYASH_DEBUG_USING=1`: using 解決詳細 ``` -- [ ] **4.2: トラブルシューティングガイド作成** +- [x] **4.2: トラブルシューティングガイド作成** ✅ 完了 (2025-11-22) - ファイル: `docs/development/troubleshooting/using-resolution.md` (新規) - 内容: ```markdown diff --git a/docs/development/roadmap/phases/phase-21.7-normalization/README.md b/docs/development/roadmap/phases/phase-21.7-normalization/README.md index f1a369a9..2a44463c 100644 --- a/docs/development/roadmap/phases/phase-21.7-normalization/README.md +++ b/docs/development/roadmap/phases/phase-21.7-normalization/README.md @@ -40,20 +40,63 @@ Rollout Plan Rollback - Disable HAKO_MIR_BUILDER_METHODIZE. Revert to Global("Box.method") resolution path (current 21.6 behavior). -Current notes (Phase 25.x bring-up) -- NamingBox / static 名 SSOT - - `src/mir/naming.rs` に NamingBox を実装済み。`Main.main` / `main._nop` などの揺れを `"Main.main/0"` 形式に正規化する経路は Rust VM/LLVM/JSON bridge から既に利用中。 - - VM 側は `normalize_static_global_name` を通して static box 名を一元化するよう更新済み。 +## Phase 21.7++ 実装完了 (2025-11-22) -- 既知のギャップ - - static box 内のローカル呼び出し(例: `Main.main` → `me._nop()`)が Global 呼び出しのまま落ちるケースを確認済み。NamingBox で `main`→`Main` 正規化は済んでいるが、「Method 化+receiver 付与」が未完了。 - - MeCallPolicy / method_call_handlers 周りで、static box method に対しても一律で receiver(`me`)を先頭に追加してしまうパスがあり、arity 不一致や miss-call の温床になり得る。 +### Global 名の SSOT ルール -- このフェーズでやること(具体タスク) - 1. `src/mir/builder/method_call_handlers.rs` / MeCallPolicy で「static box method かどうか」を判定し、static のときは receiver を追加しない(args はそのまま Global 互換で流す)ガードを入れる。 - 2. methodization ロジック(HAKO_MIR_BUILDER_METHODIZE=1 有効時)で、static box 呼びを `ensure_static_box_instance(Box)` 経由の Method 呼び出しに寄せる: - - Global("Main._nop/0") → Method{ receiver = ensure_static_box_instance("Main"), box="Main", method="_nop", arity=0 }。 - 3. 最小テストを追加: - - `.hako` 側 minimal: `static box Main { static method _nop() { return 0 } }` を呼ぶケース。 - - Rust 側: `mir_stage1_static_main_nop_resolves_and_execs`(仮)で、MIR verify + VM 実行が methodization ON/OFF の両方で安定することを確認。 - 4. docs: 本ファイルに「static box 正規化の完了条件」と「NamingBox / ensure_static_box_instance / MeCallPolicy の責務分担」を 1 ページにまとめ、Phase 21.7 の完了ラインを明文化する。 +#### 原則 +- Global 関数名は **`Box.method/N`** が SSOT +- VM/LLVM で `Box.method` を受け取ったら、arity は `args.len()` から補完 +- すべての名前解決は `NamingBox::StaticMethodId` 経由 + +#### 実装箇所 + +**NamingBox**: `src/mir/naming.rs` +- `StaticMethodId::parse()`: 名前のパース("Box.method/N" or "Box.method") +- `StaticMethodId::format()`: 正規化された名前生成 +- `StaticMethodId::with_arity()`: arity 補完 +- 13 テストケースで検証済み(src/tests/namingbox_static_method_id.rs) + +**VM**: `src/backend/mir_interpreter/handlers/calls/global.rs` +- `StaticMethodId` で名前解決 +- arity 無し → `args.len()` で補完 +- "Did you mean?" エラーメッセージ実装 + +**UnifiedCallEmitter**: `src/mir/builder/calls/unified_emitter.rs` +- Methodization で `StaticMethodId` 使用 +- TypeRegistry と連携して static box method 判定 +- 素手 split 根絶 + +**Rewrite Known**: `src/mir/builder/rewrite/known.rs` +- split_once → StaticMethodId::parse() に統一 + +#### デバッグ環境変数 +- `NYASH_DEBUG_FUNCTION_LOOKUP=1`: VM 関数ルックアップ詳細(box/method/arity 表示) +- `NYASH_DEBUG_USING=1`: using 解決詳細 +- `NYASH_METHODIZE_TRACE=1`: Global→Method 変換ログ + +#### 実装フェーズ(全完了) +- ✅ **Phase 0: 観測ライン** (commit 63012932) - Silent Failure 根絶 +- ✅ **Phase 1: 基盤整備** (commit 96c1345e) - StaticMethodId SSOT 確立 +- ✅ **Phase 2: VM 統一** (commit 1b413da5) - arity バグ根治 +- ✅ **Phase 3: 全体統一** (commit c8ad1dae) - Builder 側統一、素手 split 根絶 + +#### 技術的成果 +- Silent Failure 根絶(デバッグ時間: 時間→分) +- arity バグ根治(Hotfix 卒業) +- 素手 split 根絶(全箇所を SSOT 経由に統一) +- 型安全化(構造化表現で誤用防止) +- テスト完全通過(349 passed, 退行なし) + +--- + +## 旧ノート(Phase 25.x bring-up 時点) + +### NamingBox / static 名 SSOT +- `src/mir/naming.rs` に NamingBox を実装済み。`Main.main` / `main._nop` などの揺れを `"Main.main/0"` 形式に正規化する経路は Rust VM/LLVM/JSON bridge から既に利用中。 +- VM 側は `normalize_static_global_name` を通して static box 名を一元化するよう更新済み。 +- **Phase 21.7++ で完全 SSOT 化完了**(2025-11-22) + +### 既知のギャップ(解決済み) +- ~~static box 内のローカル呼び出し(例: `Main.main` → `me._nop()`)が Global 呼び出しのまま落ちるケースを確認済み。~~ → Phase 2 で解決 +- ~~MeCallPolicy / method_call_handlers 周りで、static box method に対しても一律で receiver(`me`)を先頭に追加してしまうパスがあり、arity 不一致や miss-call の温床になり得る。~~ → Phase 3 で解決 diff --git a/docs/development/troubleshooting/using-resolution.md b/docs/development/troubleshooting/using-resolution.md new file mode 100644 index 00000000..0b97632f --- /dev/null +++ b/docs/development/troubleshooting/using-resolution.md @@ -0,0 +1,253 @@ +# Using 解決トラブルシューティング + +**作成日**: 2025-11-22 +**対象**: Phase 21.7++ NamingBox SSOT 統一化後のトラブルシューティング + +--- + +## エラーパターン別対処法 + +### 1. `[using] Module not found: 'ModuleName'` + +**原因**: +- nyash.toml に alias が定義されていない +- TOML parse エラーで alias が読み込めていない +- タイポ(モジュール名の綴り間違い) + +**対処法**: + +1. **TOML ファイルを確認** + ```bash + cat nyash.toml | grep "ModuleName" + ``` + +2. **TOML parse エラーを確認** + - Phase 0 で実装した即座表示機能により、TOML エラーは起動時に表示されます + - エラーメッセージに修正方法が含まれています + +3. **詳細ログで確認** + ```bash + NYASH_DEBUG_USING=1 ./target/release/nyash program.hako + ``` + +4. **"Did you mean?" 提案を確認** + - Phase 0.3 で実装された機能により、類似モジュール名が自動提案されます + - 提案に正しい綴りが含まれているか確認 + +**修正例**: +```toml +# nyash.toml +[using.aliases] +StringUtils = "lang/src/shared/common/string_helpers.hako" # ← 追加 +``` + +--- + +### 2. `Function not found: Box.method/N` + +**原因**: +- arity(引数の数)が一致していない +- 関数名の綴り間違い +- 関数が定義されていない + +**対処法**: + +1. **"Did you mean?" 提案を確認** + - Phase 0.2 で実装された機能により、類似関数名が自動提案されます + ``` + Function not found: StringUtils.starts_with/1 + + 💡 Did you mean: + - StringUtils.starts_with/2 + - StringUtils.starts_with/3 + ``` + +2. **デバッグログで詳細確認** + ```bash + NYASH_DEBUG_FUNCTION_LOOKUP=1 ./target/release/nyash program.hako + ``` + + 出力例: + ``` + [DEBUG/vm] Looking up function: 'StringUtils.starts_with' + [DEBUG/vm] Parsed: box='StringUtils', method='starts_with', arity=None + [DEBUG/vm] canonical: 'StringUtils.starts_with/2' + [DEBUG/vm] ✅ 'StringUtils.starts_with/2' found + ``` + +3. **arity を確認** + - 関数定義と呼び出しの引数の数が一致しているか確認 + - Phase 2 で実装された自動補完により、arity なし呼び出しは自動補完されます + +**修正例**: +```nyash +// 誤: arity が一致しない +StringUtils.starts_with("hello") // arity 1 → "starts_with/1" を探す + +// 正: arity が一致 +StringUtils.starts_with("hello", "he") // arity 2 → "starts_with/2" を探す +``` + +--- + +### 3. `VM Runtime Error: arity mismatch` + +**原因**: +- MIR Builder 側と VM 側で arity の扱いが不一致 +- methodization で receiver が二重に追加された +- static box method で receiver が誤って追加された + +**対処法**: + +1. **Methodization トレースログを確認** + ```bash + NYASH_METHODIZE_TRACE=1 ./target/release/nyash program.hako + ``` + + 出力例: + ``` + [methodize] Global(Calculator.add/2) → Method{Calculator.add, recv=%5} + ``` + +2. **StaticMethodId パース結果を確認** + - Phase 2/3 で実装された構造化表現により、パース結果が明示的に表示されます + +3. **Methodization を無効化して確認** + ```bash + HAKO_MIR_BUILDER_METHODIZE=0 ./target/release/nyash program.hako + ``` + +**Phase 21.7++ での修正**: +- Phase 3 で known.rs と unified_emitter.rs の receiver 追加ロジックを修正済み +- static box method では receiver を追加しないようガード実装済み + +--- + +### 4. Silent Failure(エラーが表示されない) + +**原因**: +- Phase 0 以前のバージョンを使用している +- エラーメッセージが stderr に出力されているが見逃している + +**対処法**: + +1. **Phase 0 実装済みか確認** + ```bash + git log --oneline | grep "Phase 0" + ``` + + Phase 0 commit (63012932) 以降であれば、Silent Failure は根絶されています + +2. **詳細診断モードで実行** + ```bash + NYASH_CLI_VERBOSE=1 ./target/release/nyash program.hako 2>&1 | tee debug.log + ``` + +3. **すべてのデバッグフラグを有効化** + ```bash + NYASH_DEBUG_FUNCTION_LOOKUP=1 \ + NYASH_DEBUG_USING=1 \ + NYASH_METHODIZE_TRACE=1 \ + NYASH_CLI_VERBOSE=1 \ + ./target/release/nyash program.hako + ``` + +**Phase 21.7++ での修正**: +- ✅ TOML parse エラー即座表示(pipeline.rs) +- ✅ 関数ルックアップ「Did you mean?」提案(global.rs) +- ✅ using not found 詳細化(strip.rs) + +--- + +## デバッグフローチャート + +``` +エラー発生 + ↓ +1. エラーメッセージを確認 + ├─ "Did you mean?" 提案あり → 提案に従う + ├─ "Module not found" → nyash.toml 確認 + └─ "Function not found" → 以下へ + ↓ +2. デバッグログ有効化 + NYASH_DEBUG_FUNCTION_LOOKUP=1 実行 + ↓ +3. パース結果を確認 + box/method/arity が正しいか確認 + ↓ +4. 関数定義を確認 + 定義されている関数名と arity を確認 + ↓ +5. Methodization を確認 + NYASH_METHODIZE_TRACE=1 で変換ログ確認 + ↓ +6. それでも解決しない場合 + - Issue 報告(GitHub) + - チームに相談 +``` + +--- + +## よくある質問 + +### Q1: `StringUtils.starts_with` は動くが `StringUtils.starts_with/2` で呼ぶとエラーになる + +**A1**: Phase 2 実装により、arity なし呼び出しは自動補完されます。明示的に arity を指定する必要はありません。 + +```nyash +// ✅ 推奨: arity なし(自動補完) +StringUtils.starts_with("hello", "he") + +// ✅ 動作するが冗長 +// MIR レベルでは "StringUtils.starts_with/2" になる +``` + +### Q2: `main._nop/0` が `Main._nop/0` に normalize される理由は? + +**A2**: NamingBox の canonical_box_name() により、`main` → `Main` に正規化されます(src/mir/naming.rs:22-27)。 + +これは static box 名の一貫性を保つための仕様です。 + +### Q3: Methodization ON/OFF でどう動作が変わる? + +**A3**: + +**Methodization OFF** (HAKO_MIR_BUILDER_METHODIZE=0): +``` +Global("Calculator.add/2") → VM が Global 関数として実行 +``` + +**Methodization ON** (既定): +``` +Global("Calculator.add/2") + → NewBox(Calculator) → Method{Calculator.add, recv=singleton} + → VM が Method として実行 +``` + +どちらも最終的な動作は同じですが、MIR の表現が異なります。 + +### Q4: Phase 21.7++ で何が変わった? + +**A4**: 主な変更点: + +| 項目 | Phase 0-3 前 | Phase 0-3 後 | +|------|-------------|-------------| +| エラー表示 | Silent Failure 多数 | 即座表示 + 提案 | +| 名前パース | ad-hoc(素手 split) | SSOT(StaticMethodId) | +| arity 補完 | Hotfix(文字列操作) | 正式実装(構造化) | +| デバッグ | 難しい | 環境変数で詳細表示 | + +--- + +## 関連ドキュメント + +- **Phase 21.7 README**: [docs/development/roadmap/phases/phase-21.7-normalization/README.md](../roadmap/phases/phase-21.7-normalization/README.md) +- **Phase 21.7++ チェックリスト**: [docs/development/current/main/phase-21.7-naming-ssot-checklist.md](../current/main/phase-21.7-naming-ssot-checklist.md) +- **NamingBox 実装**: [src/mir/naming.rs](../../src/mir/naming.rs) +- **StaticMethodId テスト**: [src/tests/namingbox_static_method_id.rs](../../src/tests/namingbox_static_method_id.rs) + +--- + +## 更新履歴 + +- 2025-11-22: Phase 21.7++ Phase 4 完了時に作成