# バッチ設計書 9-verifyOldTs.mjs

## 概要

本ドキュメントは、Jestモノレポにおける古い TypeScript バージョン互換性検証バッチ `verifyOldTs.mjs` の設計仕様を記載したものです。このバッチは TypeScript 5.4 との互換性を検証し、古いバージョンの TypeScript でも Jest の型定義が正常にコンパイルできることを確認します。

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

**業務上の目的・背景**：Jest は広く使用されるテストフレームワークであり、様々なバージョンの TypeScript を使用するプロジェクトで利用されます。最新の TypeScript 機能を使用した型定義が、古いバージョンの TypeScript でもコンパイル可能であることを保証することは、後方互換性の観点から重要です。本バッチは、TypeScript 5.4 で Jest をインポートするテストを実行し、互換性を検証します。

**バッチの実行タイミング**：開発者が `yarn verify-old-ts` コマンドを実行した際に随時実行されます。CI/CD パイプラインでは、リリース前の検証として実行されます。型定義に変更を加えた場合に必ず実行すべきです。

**主要な処理内容**：
1. ルートの tsconfig.json を読み込み、ベース設定を取得
2. 一時ディレクトリを作成
3. `.yarnrc.yml` に node-modules リンカーを設定
4. `yarn init --yes` でプロジェクトを初期化
5. TypeScript 5.4 と @tsconfig パッケージをインストール
6. tsconfig.json を設定（esModuleInterop: false, module: commonjs, moduleResolution: node）
7. Jest をインポートするテストファイル（`index.ts`）を作成
8. `yarn tsc --project .` でコンパイルを実行
9. 一時ディレクトリをクリーンアップ

**前後の処理との関連**：`yarn build:ts` および `yarn bundle:ts` による型定義ファイルのビルドが完了していることが前提です。

**影響範囲**：Jest パッケージの型定義の後方互換性を検証します。テスト自体は一時ディレクトリで実行されるため、リポジトリには影響しません。

## バッチ種別

検証処理 / 互換性テスト / TypeScript 互換性

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者操作時）/ CI/CD |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `yarn verify-old-ts` コマンド実行 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| 依存関係インストール済み | `yarn install` が完了していること |
| 型定義ビルド完了 | `yarn build:ts` および `yarn bundle:ts` が完了していること |
| 一時ディレクトリ作成可能 | tempy によるディレクトリ作成が可能であること |

### 実行可否判定

- packages/jest ディレクトリが存在すること
- tsconfig.json が読み込み可能であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| tsconfig.json | JSON | ルートの TypeScript 設定（extends の取得） |
| package.json | JSON | ルートの依存関係（@tsconfig パッケージ名の取得） |
| packages/jest | - | ビルド済み Jest パッケージ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | コンパイル結果 |
| 一時ディレクトリ | 各種 | テスト環境（実行後削除） |

### 出力ファイル仕様

一時ディレクトリ内に以下のファイルを生成（終了時に削除）：

| ファイル名 | 内容 |
|-----------|------|
| .yarnrc.yml | Yarn 設定（node-modules リンカー） |
| package.json | テストプロジェクト定義 |
| tsconfig.json | TypeScript 設定 |
| index.ts | Jest インポートテスト |

## 処理フロー

### 処理シーケンス

```
1. 設定情報取得
   ├─ package.json から @tsconfig パッケージ名を取得
   └─ tsconfig.json から extends 設定を取得
2. 一時ディレクトリ作成
   └─ tempy.directory() で一時ディレクトリを生成
3. 環境セットアップ
   ├─ .yarnrc.yml（nodeLinker: node-modules）
   ├─ yarn init --yes
   └─ yarn add typescript@~5.4, @tsconfig パッケージ
4. テストファイル生成
   ├─ tsconfig.json（esModuleInterop: false, module: commonjs, moduleResolution: node, noEmit: true）
   └─ index.ts（import jest = require('{jestディレクトリ}');）
5. コンパイル実行
   └─ yarn tsc --project .
6. クリーンアップ
   └─ fs.rmSync で一時ディレクトリを削除
7. 結果出力
   └─ 成功メッセージを出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[package.json から @tsconfig 取得]
    B --> C[tsconfig.json から extends 取得]
    C --> D[一時ディレクトリ作成]
    D --> E[.yarnrc.yml 生成]
    E --> F[yarn init --yes 実行]
    F --> G[yarn add typescript@~5.4 実行]
    G --> H[tsconfig.json 生成]
    H --> I[index.ts 生成]
    I --> J[yarn tsc --project . 実行]
    J --> K{コンパイル成功?}
    K -->|はい| L[成功メッセージ出力]
    K -->|いいえ| M[エラー発生]
    L --> N[一時ディレクトリ削除]
    M --> N
    N --> O[バッチ終了]
```

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

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

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

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

データベース操作は発生しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| execa Error | yarn add 失敗 | TypeScript パッケージのインストールに失敗 | ネットワーク接続を確認 |
| execa Error | tsc 失敗 | TypeScript コンパイルに失敗 | 型定義の互換性を確認 |
| JSON Error | 設定読み込み失敗 | tsconfig.json の形式エラー | 設定ファイルを確認 |

### リトライ仕様

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

### 障害時対応

1. コンパイルエラーメッセージを確認
2. Jest の型定義が TypeScript 5.4 でサポートされていない機能を使用していないか確認
3. tsconfig.json の設定を確認
4. 一時ディレクトリが残っている場合は手動で削除

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回（1つのテストファイル） |
| 目標処理時間 | 数十秒〜数分（パッケージインストール含む） |
| メモリ使用量上限 | TypeScript コンパイラに依存 |

## 排他制御

- 同時実行可能（一時ディレクトリは独立）
- npm レジストリへのアクセスが発生するため、ネットワーク負荷に注意

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | `Running smoketest using TypeScript@5.4` |
| 成功ログ | コンパイル成功時 | `Successfully compiled Jest with TypeScript 5.4` |
| 完了ログ | 正常終了時 | `Successfully ran smoketest` |
| 処理ログ | yarn/tsc 実行時 | コマンドの標準出力（stdio: 'inherit'） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非0 | CI/CDパイプライン |

## 備考

### テスト対象の TypeScript バージョン

現在は TypeScript 5.4（`~5.4`）を対象としています。

### tsconfig.json 設定

```json
{
  "extends": "@tsconfig/...",
  "compilerOptions": {
    "esModuleInterop": false,
    "module": "commonjs",
    "moduleResolution": "node",
    "noEmit": true
  }
}
```

### テストファイル内容

```typescript
import jest = require('{packages/jest ディレクトリへの絶対パス}');
```

### 注意事項

- `nodeLinker: node-modules` を使用（PnP は使用しない）
- `noEmit: true` でコンパイルのみ実行（出力なし）
- finally ブロックで一時ディレクトリを確実に削除
- テスト失敗時も一時ディレクトリは削除される
- @tsconfig パッケージは devDependencies から自動検出
