# バッチ設計書 3-yarn-validate

## 概要

本ドキュメントは、GitHub Actions CI/CDパイプラインにおけるYarn依存関係検証バッチの設計仕様を定義する。

### 本バッチの処理概要

Yarnの依存関係と制約を検証し、プロジェクトの依存関係の健全性を保証するバッチ処理である。制約違反、重複依存関係、循環依存を検出する。

**業務上の目的・背景**：Babelプロジェクトは多数のパッケージで構成されるモノレポである。依存関係の不整合や循環参照は、ビルドの失敗や予期せぬランタイムエラーの原因となる。本バッチは早期に問題を検出し、コードベースの品質を維持することを目的とする。Yarnの制約機能を活用して、パッケージ間のバージョン整合性を保証する。

**バッチの実行タイミング**：リポジトリへのpush時およびプルリクエスト作成時に自動実行される。prepare-yarn-cacheジョブの完了後に実行される。

**主要な処理内容**：
1. リポジトリのチェックアウトとNode.jsセットアップ
2. yarn constraintsコマンドで制約チェック実行
3. yarn dedupe --checkで重複依存関係チェック
4. yarn release-tool check-cyclesで循環依存チェック

**前後の処理との関連**：prepare-yarn-cacheジョブに依存する。本バッチは独立した検証処理であり、後続のビルドやテストジョブには直接影響しないが、問題検出時はワークフロー全体が失敗となる。

**影響範囲**：依存関係設定ファイル（package.json、yarn.lock）の検証、CI/CDパイプラインの成功/失敗判定。

## バッチ種別

検証処理 / CI/CD

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベント駆動） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | push / pull_request イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| prepare-yarn-cache | キャッシュ準備ジョブが正常完了していること |
| yarn.lock | 依存関係定義ファイルが存在すること |
| yarn.config.cjs | Yarn制約定義ファイルが存在すること |

### 実行可否判定

GitHub Actionsのneeds設定に基づき、prepare-yarn-cacheジョブの正常完了後に自動実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| N/A | N/A | N/A | N/A | 環境変数・パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| yarn.lock | YAML | 依存関係のロックファイル |
| package.json | JSON | プロジェクト設定（各パッケージ） |
| yarn.config.cjs | JavaScript | Yarn制約定義ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 検証結果ログ |
| GitHub Actions | ステータス | 成功/失敗ステータス |

### 出力ファイル仕様

本バッチはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. Checkout code
   └─ actions/checkout@v4でリポジトリをチェックアウト
2. Use Node.js latest
   └─ actions/setup-node@v4でNode.js 25.6.1をセットアップ
3. Check for unmet constraints
   └─ yarn constraintsコマンドを実行
   └─ 失敗時は"yarn constraints --fix"で修正可能
4. Check for duplicate dependencies
   └─ yarn dedupe --checkコマンドを実行
   └─ 失敗時は"yarn dedupe"で修正可能
5. Check for dependency cycles
   └─ yarn install実行（依存関係解決）
   └─ yarn release-tool check-cyclesコマンドを実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[actions/checkout: リポジトリ取得]
    B --> C[actions/setup-node: Node.js セットアップ]
    C --> D[yarn constraints 実行]
    D --> E{制約チェック成功?}
    E -->|失敗| F[バッチ失敗終了]
    E -->|成功| G[yarn dedupe --check 実行]
    G --> H{重複チェック成功?}
    H -->|失敗| F
    H -->|成功| I[yarn install]
    I --> J[yarn release-tool check-cycles]
    J --> K{循環チェック成功?}
    K -->|失敗| F
    K -->|成功| L[バッチ正常終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

本バッチではデータベース操作は行わない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

### テーブル別操作詳細

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| CONSTRAINT_ERROR | 制約違反 | yarn constraints失敗時 | yarn constraints --fixで自動修正 |
| DUPLICATE_ERROR | 重複依存 | yarn dedupe --check失敗時 | yarn dedupeで重複解消 |
| CYCLE_ERROR | 循環依存 | check-cycles失敗時 | 依存関係を見直し循環を解消 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（検証エラーはリトライ不要） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. GitHub Actionsのジョブログを確認
2. エラー種別に応じた修正コマンドを実行：
   - 制約違反：`yarn constraints --fix`
   - 重複依存：`yarn dedupe`
   - 循環依存：パッケージ構造の見直し
3. 修正後、再度プッシュしてCI実行

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（検証のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約200パッケージの検証 |
| 目標処理時間 | 3分以内 |
| メモリ使用量上限 | ubuntu-latestランナーのデフォルト |

## 排他制御

concurrency設定により、同一ワークフロー・同一リファレンスの実行は1つに制限される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ジョブ開始時 | GitHub Actions自動出力 |
| 制約ログ | constraints実行時 | 制約違反の詳細 |
| 重複ログ | dedupe実行時 | 重複パッケージの詳細 |
| 循環ログ | check-cycles実行時 | 循環依存の詳細 |
| 終了ログ | ジョブ終了時 | 成功/失敗ステータス |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ成功率 | 100% | GitHubステータスチェック |
| 検証エラー | 1件以上 | プルリクエストステータス |

## 備考

- yarn release-toolはBabelプロジェクト固有のツールで、パッケージ間の循環依存を検出する
- 検証に失敗した場合、マージがブロックされるためプロジェクトの品質が維持される
- コメントに記載の通り、check-cyclesの前にyarn installが必要な場合がある（lockfile更新エラー回避）
