# バッチ設計書 27-e2e-prettier

## 概要

本ドキュメントは、BabelプロジェクトにおけるPrettierコードフォーマッタとのE2Eテストバッチ（e2e-prettier）の設計仕様を記載する。

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

このバッチは、Prettierリポジトリをクローンし、Babelの最新パッケージで型チェックとフォーマットテストを実行することで、コードフォーマッタとの互換性を検証する。

**業務上の目的・背景**：Prettierは、JavaScript/TypeScriptコードの標準的なフォーマッタであり、Babelパーサーを内部で使用している。PrettierがBabelの最新バージョンと互換性を持つことは、開発者の日常的なワークフローに直接影響する重要な要素である。本バッチは、Prettierリポジトリをクローンし、@babel/parserの型定義チェックとフォーマットテストを実行することで、パーサーAPIの互換性を検証する。

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

**主要な処理内容**：
1. Prettierリポジトリをクローン（depth=1）
2. Babel依存関係をバンプ
3. ローカルVerdaccioレジストリを起動
4. 依存関係をインストール
5. Babel 8互換性調整（AST構造の変更対応）
6. @babel/parserの型チェック実行
7. JavaScript/TypeScript/Flowのフォーマットテスト実行

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

**影響範囲**：一時ディレクトリ（/tmp/prettier）、テスト結果。本番環境やnpmレジストリには影響しない。

## バッチ種別

E2Eテスト / ツール統合テスト

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

- e2e-publishジョブが成功していること
- matrix.projectがprettierの場合に実行

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| verdaccio-workspace.tar | tar | 公開済みBabelパッケージのアーカイブ |
| prettier/prettier | Git | Prettierリポジトリ（最新コミット） |
| verdaccio-config.yml | YAML | Verdaccioレジストリ設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| テスト結果 | 標準出力 | 型チェック・フォーマットテスト結果 |
| 一時ディレクトリ | ディレクトリ | /tmp/prettier |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | テスト実行ログ |
| 出力先 | 標準出力 |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. Prettierリポジトリクローン
   └─ git clone --depth=1 https://github.com/prettier/prettier /tmp/prettier
2. Babel依存関係バンプ
   └─ node bump-babel-dependencies.js
3. 環境情報出力
   └─ node -v, yarn --version
4. Verdaccio起動
   └─ startLocalRegistry
5. 依存関係インストール
   └─ yarn install --no-immutable
6. パッケージ情報確認
   └─ yarn info
7. Babel 8互換性調整
   └─ sedで複数のファイルを修正（AST構造変更対応）
8. import-assertionsテスト削除
   └─ rm tests/format/js/import-assertions/format.test.js
9. 型チェック実行
   └─ yarn lint:typecheck
10. pre-check関数モック化
    └─ create-print-pre-check-function.jsを空実装に置換
11. フォーマットテスト実行
    └─ yarn test "tests/format/(jsx?|misc|typescript|flow|flow-repo)/" --update-snapshot
12. クリーンアップ
    └─ cleanup
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Prettierリポジトリクローン]
    B --> C[Babel依存関係バンプ]
    C --> D[環境情報出力]
    D --> E[Verdaccio起動]
    E --> F[yarn install --no-immutable]
    F --> G[Babel 8互換性調整]
    G --> H[import-assertionsテスト削除]
    H --> I[yarn lint:typecheck]
    I --> J{型チェック成功?}
    J -->|Yes| K[pre-check関数モック化]
    J -->|No| L[エラーログ出力]
    K --> M[yarn test フォーマットテスト]
    M --> N{テスト成功?}
    N -->|Yes| O[クリーンアップ]
    N -->|No| L
    L --> O
    O --> P[バッチ終了]
```

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

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

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

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ERR_CLONE | クローンエラー | Prettierリポジトリクローン失敗 | ネットワーク接続を確認 |
| ERR_YARN | 依存関係エラー | yarn install失敗 | package.jsonと依存関係を確認 |
| ERR_VERDACCIO | レジストリエラー | Verdaccio起動失敗 | ポート4873の使用状況を確認 |
| ERR_TYPECHECK | 型チェックエラー | lint:typecheck失敗 | @babel/parser型定義を確認 |
| ERR_TEST | テストエラー | フォーマットテスト失敗 | テストログとAST構造を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. GitHub Actionsのログを確認し、エラー発生箇所を特定
2. Babel 8のAST構造変更がPrettierのvisitor-keysと互換性があるか確認
3. @babel/parserの型定義変更を確認
4. 必要に応じてsed互換性調整を更新

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 型チェック + フォーマットテスト |
| 目標処理時間 | 20分以内 |
| メモリ使用量上限 | GitHub Actions標準ランナーの制限内 |

## 排他制御

- 同一ワークフロー・同一refに対する重複実行はキャンセル

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 環境ログ | バッチ開始時 | Node.js、yarnバージョン |
| 進捗ログ | 処理中 | 各コマンドの実行内容（set -xによるトレース） |
| 型チェックログ | 型チェック中 | TypeScript出力 |
| テストログ | テスト中 | Jest/Vitestテスト出力 |
| 終了ログ | バッチ終了時 | "Exiting without error." |
| エラーログ | エラー発生時 | エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ実行時間 | 60分 | GitHub Actions |
| ジョブ失敗 | 失敗時 | プルリクエストステータス |

## 備考

- Babel 8互換性調整が多数必要：
  - ts-expect-error削除（json.js）
  - TupleExpression、RecordExpression削除（visitor-keys.evaluate.js）
  - TSImportType、ExportAllDeclaration、ImportDeclaration、TSDeclareMethodコメントアウト
  - import-assertionsテスト削除
- create-print-pre-check-function.jsを空実装に置換（https://github.com/babel/babel/pull/14892）
- --update-snapshotでスナップショットを更新しながらテスト実行
- テスト対象: jsx、js、misc、typescript、flow、flow-repo
