# バッチ設計書 17-prepare-test-for-legacy-nodejs

## 概要

本ドキュメントは、Prettierプロジェクトにおける `prepare-test-for-legacy-nodejs.js` バッチの設計仕様を定義します。このバッチは、レガシーNode.js（v14, v16）でテストを実行するために、jest関連の依存関係を互換性のあるバージョンに調整するスクリプトです。

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

このバッチは、CI/CD環境で古いバージョンのNode.jsでのテスト実行を可能にするため、package.jsonのresolutionsフィールドを更新してjest関連パッケージを特定のバージョンに固定します。

**業務上の目的・背景**：Prettierは複数のNode.jsバージョンをサポートしています。最新のjestバージョンは古いNode.jsをサポートしていないため、レガシーNode.jsでテストを実行する際には、互換性のある古いjestバージョンを使用する必要があります。このスクリプトは、その依存関係の調整を自動化します。

**バッチの実行タイミング**：レガシーNode.jsでのCIテスト実行前に実行します。GitHub ActionsなどのCI環境で、Node.js 14または16のテストジョブで使用されます。

**主要な処理内容**：
1. コマンドライン引数からNode.jsバージョンを取得
2. Node.jsバージョンに応じた互換jestバージョンを決定
3. package.jsonを読み込む
4. resolutionsフィールドにjest関連パッケージのバージョン固定を追加
5. 更新したpackage.jsonを書き込む

**前後の処理との関連**：このバッチ実行後、`yarn install`を再実行して依存関係を更新する必要があります。その後、通常のテストコマンドを実行できます。

**影響範囲**：`package.json`のresolutionsフィールドが更新されます。これにより、yarn installで解決される依存関係のバージョンが変更されます。

## バッチ種別

テスト準備 / 環境設定

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（CIテスト実行時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | CIパイプライン / 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js実行環境が利用可能であること |
| package.json | プロジェクトルートにpackage.jsonが存在すること |

### 実行可否判定

--node-version引数が14または16の場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --node-version | number | Yes | なし | ターゲットNode.jsバージョン（14または16） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| package.json | JSON | プロジェクトの依存関係定義ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| package.json | JSON | 更新されたresolutionsを含むファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | package.json |
| 出力先 | プロジェクトルート |
| 文字コード | UTF-8 |
| インデント | 2スペース |

## 処理フロー

### 処理シーケンス

```
1. コマンドライン引数の解析
   └─ --node-versionオプションの値を取得
   └─ 14または16以外の場合はエラー

2. jestバージョンの決定
   └─ Node.js 14の場合: jest@30.0.0-alpha.2
   └─ Node.js 16の場合: jest@30.0.0-alpha.7

3. package.jsonの読み込み
   └─ プロジェクトルートから読み込み
   └─ JSONとしてパース

4. resolutionsの更新
   └─ jest関連の全パッケージに対してバージョンを設定
   └─ 既存のresolutionsを保持しつつ追加

5. package.jsonの書き込み
   └─ 2スペースインデントでJSONを整形
   └─ ファイルに書き込み
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{--node-version引数}
    B -->|なし| C[エラー: 引数が必要]
    B -->|あり| D{バージョン確認}
    D -->|14| E[jestVersion = 30.0.0-alpha.2]
    D -->|16| F[jestVersion = 30.0.0-alpha.7]
    D -->|その他| G[エラー: 予期しないバージョン]
    E --> H[package.json読み込み]
    F --> H
    H --> I[resolutions更新]
    I --> J[package.json書き込み]
    J --> K[バッチ終了]
    C --> L[異常終了]
    G --> L
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 引数エラー | --node-version引数がない | 引数を指定して再実行 |
| - | バージョンエラー | Node.jsバージョンが14, 16以外 | 正しいバージョンを指定 |

### リトライ仕様

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

### 障害時対応

1. 引数エラーの場合：`--node-version 14`または`--node-version 16`を指定
2. バージョンエラーの場合：サポートされているNode.jsバージョンを確認

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

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

## パフォーマンス要件

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

## 排他制御

同時実行の制限はありませんが、package.jsonへの同時書き込みを避ける必要があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | ログ出力は実装されていません |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 実行エラー | 発生時 | CIパイプラインの失敗通知 |

## 備考

- ES Modules形式で実装されています
- 対象となるjest関連パッケージは38個あります（詳細はソースコードのjestDependencies配列を参照）
- Node.js 14では`jest@30.0.0-alpha.2`が最後のサポートバージョンです
- Node.js 16では`jest@30.0.0-alpha.7`が最後のサポートバージョンです
- 実行後は`yarn install`を再実行して依存関係を更新する必要があります
- 以下のパッケージが対象外となっています（コメントアウト）：
  - @jest/types
  - jest-docblock
