# バッチ設計書 22-e2e-babel

## 概要

本ドキュメントは、BabelプロジェクトにおけるBabel自体のE2Eテストバッチ（e2e-babel）の設計仕様を記載する。

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

このバッチは、ローカルVerdaccioレジストリに公開されたBabelパッケージを使用して、Babel自身のビルドとテストを実行する。

**業務上の目的・背景**：Babelの開発において、新しいバージョンのパッケージが既存のBabelビルドシステムと互換性があることを確認することは極めて重要である。本バッチは、開発中のBabelパッケージをローカルレジストリから取得し、Babel自身をビルド・テストすることで、セルフホスティングの互換性を検証する。これにより、Babelの品質を維持し、リリース前に互換性問題を検出できる。

**バッチの実行タイミング**：GitHub Actionsワークフローにおいて、e2e-publishジョブ完了後に自動実行される。mainブランチへのpushまたはプルリクエスト発生時にトリガーされる。

**主要な処理内容**：
1. ローカルVerdaccioレジストリを起動
2. トップレベルpackage.jsonの@babel/*依存関係をローカルレジストリ版にバンプ
3. 依存関係をインストール（YARN_ENABLE_IMMUTABLE_INSTALLS=false）
4. make -j test-ciでフルビルドとテストを実行
5. クリーンアップ処理

**前後の処理との関連**：e2e-publishバッチで作成されたverdaccio-workspaceアーティファクトに依存する。本バッチは他のE2Eテスト（create-react-app、vue-cli等）と並列実行される。

**影響範囲**：Babelモノレポ内のビルド成果物、テスト結果。本番環境やnpmレジストリには影響しない。

## バッチ種別

E2Eテスト / 統合テスト / セルフホスティング検証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動（push/プルリクエスト時） |
| 実行時刻 | 随時（e2e-publish完了後） |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | GitHub Actions（needs: e2e-publish） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| e2e-publishジョブ完了 | verdaccio-workspaceアーティファクトが利用可能であること |
| Node.js環境 | Node.js最新版がインストールされていること |
| Yarn | Yarnパッケージマネージャが利用可能であること |
| ネットワーク | ローカルVerdaccioレジストリへのアクセスが可能であること |

### 実行可否判定

- e2e-publishジョブが成功していること（needs: e2e-publish）
- verdaccio-workspaceアーティファクトがダウンロード可能であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| matrix.project | string | Yes | babel | テスト対象プロジェクト名 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| verdaccio-workspace.tar | tar | 公開済みBabelパッケージのアーカイブ |
| package.json | JSON | プロジェクトルートのパッケージ設定 |
| verdaccio-config.yml | YAML | Verdaccioレジストリ設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ビルド成果物 | JavaScript | Babelのコンパイル済みパッケージ |
| テスト結果 | 標準出力 | Jestテスト実行結果 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 各パッケージのlib/ディレクトリ |
| 出力先 | packages/*/lib/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. Yarnキャッシュディレクトリ取得
   └─ yarn cache dir / yarn config get cacheFolder
2. Babelキャッシュクリア
   └─ キャッシュディレクトリから*babel*を削除
3. verdaccio-workspaceアーティファクトダウンロード
   └─ GitHub Actionsのdownload-artifactアクション
4. アーカイブ展開
   └─ tar -C /tmp -xf /tmp/verdaccio-workspace.tar
5. Verdaccio起動
   └─ ローカルレジストリを起動
6. 依存関係バンプ
   └─ bump-babel-dependencies.jsでトップレベルのみバンプ
7. 依存関係インストール
   └─ YARN_ENABLE_IMMUTABLE_INSTALLS=false
8. ビルド・テスト実行
   └─ make -j test-ci
9. クリーンアップ
   └─ Verdaccio停止
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Yarnキャッシュディレクトリ取得]
    B --> C[Babelキャッシュクリア]
    C --> D[アーティファクトダウンロード]
    D --> E[tarアーカイブ展開]
    E --> F[Verdaccio起動]
    F --> G[依存関係バンプ]
    G --> H[yarn install]
    H --> I[make -j test-ci]
    I --> J{テスト成功?}
    J -->|Yes| K[クリーンアップ]
    J -->|No| L[エラーログ出力]
    L --> K
    K --> M[バッチ終了]
```

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

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

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

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ERR_ARTIFACT | アーティファクト取得エラー | verdaccio-workspaceダウンロード失敗 | e2e-publishジョブの成功を確認 |
| ERR_VERDACCIO | レジストリエラー | Verdaccio起動失敗 | ポート4873の使用状況を確認 |
| ERR_BUILD | ビルドエラー | make buildが失敗 | ビルドログを確認 |
| ERR_TEST | テストエラー | Jestテストが失敗 | テストログを確認、失敗テストを特定 |
| ERR_YARN | 依存関係エラー | yarn installが失敗 | package.jsonと依存関係を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（GitHub Actions側で再実行可能） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. GitHub Actionsのログを確認し、エラー発生箇所を特定
2. ビルドエラーの場合、ローカル環境で再現確認
3. テストエラーの場合、失敗テストを特定して原因調査
4. 必要に応じてワークフローを手動で再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイルベース処理） |
| コミットタイミング | - |
| ロールバック条件 | エラー発生時はcleanup関数でクリーンアップ |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約150パッケージのビルド・テスト |
| 目標処理時間 | 30分以内 |
| メモリ使用量上限 | GitHub Actions標準ランナーの制限内 |

## 排他制御

- 同一ワークフロー・同一refに対する重複実行はキャンセル（concurrency設定）
- make -jによる並列ビルド

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | スクリプト実行開始 |
| 進捗ログ | 処理中 | 各コマンドの実行内容（set -xによるトレース） |
| ビルドログ | ビルド中 | make出力 |
| テストログ | テスト中 | Jest出力 |
| 終了ログ | バッチ終了時 | "Exiting without error." |
| エラーログ | エラー発生時 | "ERROR! An error was encountered executing line X" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ実行時間 | 60分 | GitHub Actions（自動タイムアウト） |
| ジョブ失敗 | 失敗時 | プルリクエストステータス |
| テスト失敗数 | 1件以上 | プルリクエストステータス |

## 備考

- workspace:プロトコルを使用するワークスペース内パッケージは、モノレポ内のバージョンを使用するため、トップレベルのpackage.jsonのみバンプが必要
- YARN_ENABLE_IMMUTABLE_INSTALLS=falseにより、yarn.lockの変更を許可
- fail-fast: falseにより、1つのマトリクスジョブが失敗しても他のジョブは継続実行
