# バッチ設計書 15-runtime-interop-prepare

## 概要

本ドキュメントは、@babel/runtimeの統合テストを準備するCI/CDバッチ「runtime-interop-prepare」の設計を定義するものである。

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

runtime-interop-prepareバッチは、@babel/runtimeパッケージが様々なバンドラーやNode.jsバージョンで正しく動作することを検証するためのテスト準備を行うCI/CDジョブである。絶対パス参照テストの生成、バンドラーテストの実行、Node.js最新版でのテスト実行を行う。

**業務上の目的・背景**：@babel/runtimeは、Babelがトランスパイルしたコードが依存するヘルパー関数を提供するパッケージである。このパッケージは様々なモジュール形式（ESM/CJS）、バンドラー（Webpack、Rollup）、Node.jsバージョンで使用されるため、それぞれの環境での互換性を検証する必要がある。特に、絶対パス参照（absoluteRuntime）オプションを使用する場合の動作確認が重要である。

**バッチの実行タイミング**：GitHub Actions上でpushおよびpull_requestイベント発生時に自動実行される。buildジョブの完了後に実行される依存関係がある。

**主要な処理内容**：
1. リポジトリのチェックアウト
2. Node.js最新版のセットアップ
3. 古いNode.jsバージョンでのセルフリファレンスサポート設定
4. 依存関係のインストール
5. ビルドアーティファクトのダウンロード
6. absoluteRuntimeテストファイルの生成
7. バンドラーテスト（Webpack 3/4/5、Rollup）の実行
8. Node.js最新版でのランタイムテスト実行

**前後の処理との関連**：本バッチはbuildジョブの成果物を入力として使用する。後続のruntime-interopジョブが本バッチの成功を前提条件として実行される。

**影響範囲**：本バッチはテスト準備と実行のみを行い、ソースコードやデータの変更は行わない。テスト失敗時はCI全体が失敗となり、PRのマージがブロックされる。

## バッチ種別

テスト実行 / 統合テスト準備

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動（随時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | GitHub Actions（push/pull_request） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| build完了 | Babelのビルドアーティファクトが生成済みであること |
| babel-artifact存在 | ビルド成果物がダウンロード可能であること |

### 実行可否判定

buildジョブが成功した場合のみ実行される（needs: build）。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| YARN_ENABLE_IMMUTABLE_INSTALLS | boolean | No | false | ロックファイル更新を許可 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| babel-artifact | GitHub Actions Artifact | Babelビルド成果物 |
| test/runtime-integration/src/ | JavaScript | テストソースファイル |
| test/runtime-integration/webpack-*/ | JavaScript | Webpackテスト設定 |
| test/runtime-integration/rollup/ | JavaScript | Rollupテスト設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | テスト結果・エラー詳細 |
| test/runtime-integration/src/absolute/ | JavaScript | 生成された絶対パス参照テストファイル |
| GitHub Actions Log | ログ | ジョブ実行ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | main-cjs.cjs, main-esm.mjs（absoluteディレクトリ内） |
| 出力先 | test/runtime-integration/src/absolute/ |
| 文字コード | UTF-8 |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. リポジトリチェックアウト
   └─ actions/checkout@v4を使用
2. Node.js環境セットアップ
   └─ Node.js 25.6.1をセットアップ、Yarnキャッシュを有効化
3. セルフリファレンスサポート設定
   └─ packages/package.jsonを作成してワークスペース設定を追加
4. 依存関係インストール
   └─ yarn installを実行（YARN_ENABLE_IMMUTABLE_INSTALLS=false）
5. ビルドアーティファクトダウンロード
   └─ babel-artifactをダウンロードして展開
6. absoluteRuntimeテスト生成
   └─ yarn test:runtime:generate-absolute-runtimeを実行
7. バンドラーテスト実行
   └─ yarn test:runtime:bundlersを実行
8. Node.js最新版テスト実行
   └─ node test/runtime-integration/node.cjsを実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[リポジトリチェックアウト]
    B --> C[Node.js環境セットアップ]
    C --> D[セルフリファレンス設定]
    D --> E[yarn install]
    E --> F[babel-artifact ダウンロード]
    F --> G[absoluteRuntime テスト生成]
    G --> H[バンドラーテスト実行]
    H --> I{バンドラーテスト成功?}
    I -->|成功| J[Node.js テスト実行]
    I -->|失敗| M[失敗終了]
    J --> K{Node.js テスト成功?}
    K -->|成功| L[成功終了]
    K -->|失敗| M
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| BUNDLER_ERROR | バンドラーエラー | Webpack/Rollupビルド失敗 | バンドラー設定を確認 |
| MODULE_NOT_FOUND | モジュールエラー | ランタイムモジュールが見つからない | ビルドアーティファクトを確認 |
| ARTIFACT_NOT_FOUND | 入力エラー | babel-artifactが見つからない | buildジョブを確認 |
| ASSERTION_ERROR | テストエラー | ランタイム動作の期待値不一致 | expectedファイルと出力を比較 |

### リトライ仕様

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

### 障害時対応

1. GitHub Actionsのログを確認し、失敗したテスト（バンドラー/Node.js）を特定する
2. ローカル環境で該当のテストを実行して再現確認する
3. バンドラーエラーの場合、webpack.config.jsやrollup.config.jsを確認する
4. 期待値不一致の場合、`OVERWRITE=true`で期待値ファイルを更新するか、実装を修正する

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | バンドラー4種類 x 2（通常/absolute） + Node.jsテスト |
| 目標処理時間 | 15分以内 |
| メモリ使用量上限 | 4GB（GitHub Actionsランナーのデフォルト） |

## 排他制御

同一ブランチに対する同時実行は、GitHub Actionsのconcurrencyグループ設定により制御される。新しい実行が開始されると、進行中の古い実行はキャンセルされる。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | ジョブ名、Node.jsバージョン |
| 生成ログ | テストファイル生成時 | 生成ファイル名 |
| バンドラーログ | バンドラーテスト時 | バンドラー名、ビルド結果 |
| テストログ | テスト実行時 | テスト種別（ESM/CJS）、OK/FAILED |
| エラーログ | エラー発生時 | スタックトレース、期待値vs実際値 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 20分超過 | GitHub Actions UI |
| テスト失敗率 | 1件以上 | GitHub Actions UI |

## 備考

- セルフリファレンスサポート設定は、古いNode.jsバージョンでpackage.jsonのexportsフィールドを正しく解決するために必要
- `YARN_ENABLE_IMMUTABLE_INSTALLS=false`は、packages/package.jsonの動的生成によるロックファイル更新を許可するため
- バンドラーテストはWebpack 3、4、5およびRollupを対象とする
- absoluteRuntimeテストは、@babel/runtimeを絶対パスで参照する際の動作を検証する
- generate-absolute-runtime.cjsは、テストファイル内のパッケージ参照を絶対パスに置き換える
