CR-E3: Self-Healing PR コメント メタ情報強化 - 完了レポート

1. 実装日時

2025年12月10日（初回実装） 2025年12月11日（テスト修正・完了）

2. 目的・ゴール

Self-Healing 実行結果の PR コメントに、実行時間・成功率・使用モデル・変更規模・run_id などのメタ情報ブロックを標準化して追加し、「NexusCore がどの程度 Self-Healing を実現しているか」を外部から即座に判断できる状態を作る。

3. 実装ステップの要約

3.1 diff 行数収集の拡張

  • _estimate_diff_lines_separated() 関数を追加し、追加行数と削除行数を分けて収集
  • _collect_run_metrics() を拡張し、added_lines、removed_lines、start_time、end_time、duration_seconds を追加

3.2 メタ情報ブロック生成関数の追加

  • format_metadata_block() 関数を新規作成
  • Run ID、PR 番号、コミット SHA、実行時間、使用モデル、変更規模、成功率を含む標準化されたメタ情報ブロックを生成

3.3 PR コメント組み立ての拡張

  • build_pr_comment() にメタ情報ブロックを追加（E-5 のカード形式の前に配置）
  • PRCommentContext に commit_sha フィールドを追加

3.4 GitHub Webhook 連携の更新

  • format_pr_comment() に commit_sha パラメータを追加
  • github_webhook.py と github_webhook_handler.py で commit_sha を取得して渡すように修正

3.5 テスト追加

  • tests/integration/test_github_pr_comment_metadata.py を新規作成
  • _estimate_diff_lines_separated()、format_metadata_block()、_collect_run_metrics()、build_pr_comment() のテストを追加
  • pytest.mock.patch を unittest.mock.patch に修正（2025年12月11日）

4. 変更ファイル一覧

新規作成:

  • tests/integration/test_github_pr_comment_metadata.py

変更:

  • src/nexuscore/integration/github_pr_comment.py
    • _estimate_diff_lines_separated() 追加（追加行数と削除行数を分けて収集）
    • _collect_run_metrics() 拡張（added_lines, removed_lines, start_time, end_time, duration_seconds 追加）
    • format_metadata_block() 追加（標準化されたメタ情報ブロック生成）
    • format_diff_summary_block() 関数定義の修正（docstring が関数定義になっていた問題を修正）
    • build_pr_comment() にメタ情報ブロック追加（E-5 カード形式の前に配置）
    • PRCommentContext に commit_sha フィールド追加
    • typing インポートに Any, List を追加
  • src/nexuscore/api/github_self_healing_webhook.py
    • format_pr_comment() に commit_sha パラメータ追加
  • src/nexuscore/api/routes/github_webhook.py
    • format_pr_comment() 呼び出し時に commit_sha を渡すように修正
  • src/nexuscore/api/github_webhook_handler.py
    • format_pr_comment() 呼び出し時に commit_sha を渡すように修正
  • src/nexuscore/api/fastapi_app.py
    • Flask アプリケーションコンテキストを全リクエストで確実に push するように修正（DB 初期化警告の解消）

5. 動作確認結果

5.1 実装完了確認

  • ✅ _estimate_diff_lines_separated() で追加行数と削除行数を分けて収集
  • ✅ _collect_run_metrics() でメタ情報を収集
  • ✅ format_metadata_block() でメタ情報ブロックを生成
  • ✅ build_pr_comment() にメタ情報ブロックが含まれる
  • ✅ GitHub Webhook から commit_sha を取得して渡す

5.2 テスト

実行コマンド:

pytest tests/integration/test_github_pr_comment_metadata.py -v

テスト結果 (2025年12月11日):

============================= test session starts ==============================
platform linux -- Python 3.12.3, pytest-7.4.4, pluggy-1.6.0
collected 9 items

tests/integration/test_github_pr_comment_metadata.py::TestEstimateDiffLinesSeparated::test_empty_diff PASSED [ 11%]
tests/integration/test_github_pr_comment_metadata.py::TestEstimateDiffLinesSeparated::test_simple_additions PASSED [ 22%]
tests/integration/test_github_pr_comment_metadata.py::TestEstimateDiffLinesSeparated::test_simple_deletions PASSED [ 33%]
tests/integration/test_github_pr_comment_metadata.py::TestEstimateDiffLinesSeparated::test_mixed_changes PASSED [ 44%]
tests/integration/test_github_pr_comment_metadata.py::TestFormatMetadataBlock::test_basic_metadata_block PASSED [ 55%]
tests/integration/test_github_pr_comment_metadata.py::TestFormatMetadataBlock::test_metadata_block_without_optional_fields PASSED [ 66%]
tests/integration/test_github_pr_comment_metadata.py::TestFormatMetadataBlock::test_metadata_block_duration_formatting PASSED [ 77%]
tests/integration/test_github_pr_comment_metadata.py::TestCollectRunMetrics::test_collect_run_metrics_includes_added_removed_lines PASSED [ 88%]
tests/integration/test_github_pr_comment_metadata.py::TestBuildPrCommentWithMetadata::test_build_pr_comment_includes_metadata_block PASSED [100%]

============================== 9 passed in 0.28s ===============================

テストカバレッジ:

  • ✅ _estimate_diff_lines_separated(): 4テスト（空diff、追加のみ、削除のみ、混在）
  • ✅ format_metadata_block(): 3テスト（基本、オプショナルフィールドなし、経過時間フォーマット）
  • ✅ _collect_run_metrics(): 1テスト（追加行数・削除行数の収集確認）
  • ✅ build_pr_comment(): 1テスト（メタ情報ブロックの含まれ方確認）

修正内容:

  • pytest.mock.patch を unittest.mock.patch に修正（pytest.mock は存在しないため）

6. 設計上の改善点

  • メタ情報の標準化: PR コメントに含まれるメタ情報が標準化され、機械的に parse 可能な構造になった
  • 後方互換性の維持: 既存の E-5 カード形式のサマリーは維持され、メタ情報ブロックが追加された
  • 拡張性: format_metadata_block() 関数により、メタ情報のフォーマット変更が容易になった
  • トレーサビリティ: run_id、PR 番号、コミット SHA により、PR コメントから実行履歴を追跡可能

7. 既知の制約・注意事項

  • 成功率計算は _compute_recent_success_rate() に依存し、DB が利用できない場合は “N/A” を表示
  • 実行時間の詳細（start_time, end_time）は Run モデルに started_at と finished_at が設定されている場合のみ取得可能
  • 使用モデルは details から取得を優先し、なければ ExecutionLog から集計

8. 次のステップ

  • E-4（差分サマリー）の PR コメント統合時に、本 CR で導入したメタ情報ブロックと統合
  • Observability ダッシュボードから run_id 経由で PR コメントビューに飛べるようにする構想の前提になる

関連ドキュメント

This site uses Just the Docs, a documentation theme for Jekyll.