決済コードレビュー
決済コードの中で実際に金銭的損害を引き起こすバグを見つけ、それぞれを金額に換算して説明します。誰が二重に請求されるのか、どの予約が失われるのか、誰が自分の振込を承認できるのか、明確に示します。
ワークフロー
-
範囲を特定する。 お金を作成、移動、承認、計上、または調整するコード(コントローラー、サービス、リスナー、エンティティ、マイグレーション)を見つけます。使用しているスタック(Spring Boot、Kafka、JPA、Kotlin)をメモします。
-
スキャナーを実行する。 このスキルのフォルダから、プロジェクトまたは変更されたファイルに対してスキャナーを実行します。
python scripts/scan.py <path-to-code> # マークダウンテーブル出力 python scripts/scan.py <path-to-code> --format json # さらに処理する場合Python 3.10以上が必要で、他に依存関係はありません。デフォルトではテストソースをスキップします(
--include-testsで含めることができます)。ソーステキストをヒューリスティックに読み取るため、出力はリード(ヒント)のリストです。 -
すべてのヒントをコードを読んで検証する。 各リードについて、ファイルを開いて以下を確認します。
amountという名前のdoubleが実際にはパーセンテージや比率である場合、PAY001ではありません。- コンシューマーや承認メソッドは、重複チェックやフォーアイズチェックがスキャナーの追跡範囲(3呼び出し)より深くに存在する場合、問題ありません。その場所を追跡し、どこにあるかを示します。
- 偽陽性を排除し、理由を一言で説明して、読者が残りの結果を信頼できるようにします。
-
手動チェックリストを実行する。 references/checklist.md に従います。各スキャナールールについて悪い例と良い例を説明し、スキャナーでは検出できない項目(残高の競合、冪等性キーのスコープ、リトライとタイムアウトのセマンティクス、ステートマシン、調整、移動中のお金、監査、データ保護)を列挙します。レビュー対象のコードに必要な深さまで実施します。
-
レポートを作成する。 以下の形式で記述します。金銭的影響が最も大きいものから先頭にします。
レポート形式
## 決済レビュー: <サービス名またはPR>
**判定:** <一言:マージしても安全 / 修正後にマージ / 再設計が必要>
| # | 深刻度 | 場所 | 問題 | 金銭的影響 |
|---|---|---|---|---|
| 1 | 高 | `TransferController.java:24` | POST /transfers に冪等性キーがない | クライアントのタイムアウト後のリトライで2回目の振込が作成される |
### 1. <タイトル>
**なぜ重要か:** <具体的に何が問題か、金額の例を交えて>
**修正方法:** <最小限の正しい変更と、短いコードスニペット>
### 確認済みで問題なし
- <正しいと確認した項目とその場所。レビューの正直さを保つ>
### 対象外
- <確認できなかった項目。例:このリポジトリにないデータベース制約>
レビューのルール
- 深刻度は金額に基づく。 高 = お金が失われる、重複する、または間違った人によって移動される可能性がある。中 = 障害時や負荷時に発生する可能性がある。低 = 衛生上の問題。
- すべての発見に対して
ファイル:行で該当行を引用する。 確認していないスキャナーリードを報告してはなりません。 - 最も安全な最小限の修正を優先する。 例えば、一意制約と
Idempotency-Keyヘッダーであれば、全体の書き換えは避けます。正しい修正が構造的なもの(トランザクショナルアウトボックス)である場合は、その旨を明確に述べます。 - 準拠を主張しない。 このレビューはPCI DSSやSOX監査ではありません。質問された場合はその旨を伝えます。
- データベースも確認する。 これらの保証の多くは制約(
UNIQUE、CHECK、トリガー)に属します。リポジトリ内にあるマイグレーション(Flyway、Liquibase)も確認します。