# バッチ設計書 14-sync-flow-tests

## 概要

本ドキュメントは、Prettierプロジェクトにおける `sync-flow-tests.cjs` バッチの設計仕様を定義します。このバッチは、外部のFlowリポジトリからテストファイルをPrettierのテストディレクトリに同期するスクリプトです。

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

このバッチは、Flowパーサーの互換性テストを維持するために、Flowの公式テストスイートをPrettierのテストディレクトリにコピーします。構文エラーを含むファイルはスキップし、有効なFlowファイルのみを同期します。

**業務上の目的・背景**：PrettierはFlow言語のフォーマットをサポートしています。Flowの公式テストスイートを利用することで、Flowパーサーの互換性を包括的にテストできます。外部リポジトリから定期的にテストを同期することで、Flowの最新機能への対応状況を確認できます。

**バッチの実行タイミング**：Flow言語の新バージョンリリース時、またはPrettierのFlowパーサーを更新する際に手動で実行します。

**主要な処理内容**：
1. 外部Flowテストディレクトリからテストファイルを検索
2. flow-parserで各ファイルをパースし、構文エラーのあるファイルをスキップ
3. 既存のテストディレクトリを削除
4. 有効なファイルをPrettierのテストディレクトリにコピー
5. 各ディレクトリにformat.test.jsスペックファイルを生成
6. スキップされたファイルの一覧を出力

**前後の処理との関連**：同期後、開発者は `jest -u` を実行してスナップショットを更新し、git diffで変更を確認する必要があります。

**影響範囲**：`tests/format/flow/flow-repo/` ディレクトリ以下のすべてのファイルが更新されます。

## バッチ種別

テスト同期 / データ連携

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（Flow更新時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js実行環境が利用可能であること |
| 同期元ディレクトリ | 外部Flowテストディレクトリが存在すること |
| 依存パッケージ | flow-parser, fast-globがインストール済みであること |

### 実行可否判定

同期元ディレクトリが指定され、JavaScriptファイルが存在する場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| syncDir | string | Yes | なし | 同期元Flowテストディレクトリのパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 外部Flowテストディレクトリ | JavaScriptファイル群 | Flowの公式テストファイル |
| 既存format.test.jsファイル | JavaScript | 既存のテストスペックファイル（内容を保持） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| tests/format/flow/flow-repo/ | ディレクトリ | 同期されたFlowテストファイル群 |
| format.test.js | JavaScript | 各ディレクトリのテストスペックファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元ファイル名を維持 |
| 出力先 | tests/format/flow/flow-repo/{相対パス} |
| 文字コード | UTF-8 |
| スペックファイル内容 | `runFormatTest(import.meta);` |

## 処理フロー

### 処理シーケンス

```
1. コマンドライン引数の検証
   └─ syncDirが指定されていることを確認

2. 既存スペックファイルの内容を保存
   └─ 既存のformat.test.jsファイルの内容を読み込み

3. 同期元ファイルの検索
   └─ fast-globで**/*.jsパターンでファイルを検索

4. 既存テストディレクトリの削除
   └─ tests/format/flow/flow-repo/を削除

5. 各ファイルの処理
   └─ flow-parserでパース
   └─ 構文エラーがあればスキップリストに追加
   └─ エラーがなければコピー
   └─ スペックファイルを生成（既存内容を優先）

6. 結果の出力
   └─ スキップされたファイル一覧を表示
   └─ 次のステップ（jest -u等）を案内
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{引数チェック}
    B -->|なし| C[エラーメッセージ出力]
    C --> D[終了コード1で終了]
    B -->|あり| E[既存スペックファイル読み込み]
    E --> F[同期元ファイル検索]
    F --> G{ファイルあり?}
    G -->|なし| H[エラー出力]
    H --> D
    G -->|あり| I[既存ディレクトリ削除]
    I --> J[各ファイルをループ]
    J --> K[flow-parserでパース]
    K --> L{構文エラー?}
    L -->|あり| M[スキップリストに追加]
    L -->|なし| N[ファイルコピー]
    N --> O[スペックファイル生成]
    M --> P{次のファイル?}
    O --> P
    P -->|あり| J
    P -->|なし| Q[スキップファイル一覧表示]
    Q --> R[次ステップ案内]
    R --> S[正常終了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 引数エラー | syncDirが指定されていない | 引数を指定して再実行 |
| 1 | ファイルなしエラー | 同期元にJSファイルがない | 正しいディレクトリを指定 |

### リトライ仕様

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

### 障害時対応

1. 引数エラー：正しいFlowテストディレクトリパスを指定
2. ファイルなしエラー：ディレクトリパスを確認し、JSファイルが存在することを確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ファイル単位 |
| コミットタイミング | 各ファイル書き込み時 |
| ロールバック条件 | なし（部分的な同期も許容） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千ファイル |
| 目標処理時間 | 数分以内 |
| メモリ使用量上限 | 制限なし |

## 排他制御

同時実行は推奨されません。同一ディレクトリへの並列書き込みが発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| スキップログ | 処理完了時 | 構文エラーでスキップされたファイル一覧 |
| 完了ログ | 処理完了時 | 次のステップの案内 |
| エラーログ | エラー発生時 | エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | 開発者への通知 |

## 備考

- CommonJS形式（.cjs）で実装されています
- flow-parserの設定は `/src/language-js/parse/flow.js` と同期を保つ必要があります
- パース時に有効化されているオプション：enums, match, components, esproposal_decorators, pattern_matching, records
- 同期後は以下の手順を実行する必要があります：
  1. 必要に応じてformat.test.jsファイルを調整
  2. `jest -u`でスナップショットを作成
  3. `git diff`で変更を確認
  4. 新しいスナップショットが適切かレビュー
