# バッチ設計書 24-test:integrations

## 概要

本ドキュメントは、CoffeeScriptプロジェクトにおけるCakefile `test:integrations` タスクの設計仕様を記載したものである。このタスクは、CoffeeScriptモジュールが他のライブラリや環境と正常に統合できることを検証する。特に、Webpackでのバンドル互換性をテストする。

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

このバッチは、CoffeeScriptコンパイラが外部ツールと正常に連携できることを検証する統合テストである。主にWebpackを使用したバンドル処理をテストし、生成されたバンドルでテストスイートが正常に実行できることを確認する。

**業務上の目的・背景**：CoffeeScriptは単独で使用されるだけでなく、Webpack、Browserify、Rollupなどのモジュールバンドラーと組み合わせて使用されることが多い。これらのツールと正しく連携できることを保証することで、エンドユーザーの開発体験を向上させる。特にWebpackは現代のJavaScriptエコシステムで広く使用されているため、その互換性は重要である。また、ブラウザ環境で実行されるバンドルにはNode.jsモジュールが含まれないことを検証し、クライアントサイドでの動作を保証する。

**バッチの実行タイミング**：`release`タスクの一部として自動実行される。また、開発者がWebpack統合を確認したい場合に手動で実行される。新しい依存関係の追加や、package.jsonの`browser`フィールド変更時に特に重要となる。

**主要な処理内容**：
1. Node.jsバージョンチェック（v10.13.0以上が必要）
2. 一時ディレクトリの取得
3. Webpackモジュールの読み込み
4. Webpack設定オブジェクトの作成
5. CoffeeScriptモジュールのバンドル処理
6. ビルド結果のエラーチェック
7. バンドルされたコンパイラの読み込み
8. テストスイートの実行
9. 一時ファイルのクリーンアップ

**前後の処理との関連**：このタスクを実行する前に、`build`タスクでCoffeeScriptコンパイラがビルドされている必要がある。また、`npm install`で依存パッケージ（特にwebpack）がインストールされている必要がある。`release`タスクでは、他のテスト（`test:browser:node`、`test:browser`）と共に実行される。

**影響範囲**：テスト実行のみで、ソースコードへの恒久的な変更は行わない。一時ディレクトリに`coffeescript.js`ファイルが生成されるが、テスト完了後に削除される。テスト失敗時はプロセスがエラーコード1で終了する。

## バッチ種別

品質検証 / 統合テスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動または自動） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動実行 / 他タスクからの呼び出し（release） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.js v10.13.0以上がインストールされていること |
| Webpack | devDependencyとしてwebpackがインストールされていること |
| ビルド済みコンパイラ | `lib/coffeescript/`にビルドされたコンパイラが存在すること |
| テストファイル | `test/`ディレクトリにテストファイルが存在すること |
| 書き込み可能な一時ディレクトリ | os.tmpdir()にファイルを書き込める権限があること |

### 実行可否判定

Node.jsバージョンが10.13.0未満の場合、タスクは早期リターンし、何も実行せずに終了する。これはWebpack 5が要求する最小Node.jsバージョンに基づいている。

```
Node.js major < 10 → 早期リターン
Node.js major = 10 && minor < 13 → 早期リターン
それ以外 → 実行継続
```

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | Cakefileタスクとして定義されており、追加パラメータは受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| ./ (プロジェクトルート) | CoffeeScriptモジュール | Webpackのエントリーポイント |
| lib/coffeescript/ | JavaScript | ビルド済みCoffeeScriptコンパイラモジュール |
| test/*.coffee | CoffeeScript | テストファイル |
| package.json | JSON | モジュール定義（browserフィールドを含む） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 一時ディレクトリ/coffeescript.js | JavaScript | Webpackでバンドルされたコンパイラ（テスト後削除） |
| 標準出力 | テキスト | テスト結果サマリー |
| 標準エラー出力 | テキスト | Webpackエラー・警告メッセージ |
| プロセス終了コード | 数値 | 成功時: 0、失敗時: 1 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | coffeescript.js |
| 出力先 | os.tmpdir()（システム一時ディレクトリ） |
| 文字コード | UTF-8 |
| 備考 | テスト完了後にfs.unlinkSyncで削除 |

## 処理フロー

### 処理シーケンス

```
1. Node.jsバージョンチェック
   └─ process.versions.nodeからバージョン取得
   └─ major < 10 または (major = 10 && minor < 13) で早期リターン

2. 環境準備
   └─ os.tmpdir()で一時ディレクトリパス取得
   └─ webpackモジュールのrequire

3. Webpack設定の構築
   └─ entry: './' (プロジェクトルート)
   └─ optimization.minimize: off (テスト失敗回避)
   └─ output.path: 一時ディレクトリ
   └─ output.filename: 'coffeescript.js'
   └─ output.library: 'CoffeeScript'
   └─ output.libraryTarget: 'commonjs2'

4. Webpackバンドル実行
   └─ webpack(config, callback)形式で非同期実行
   └─ コールバックでエラーと統計情報を受け取り

5. ビルド結果チェック
   └─ errが存在 → エラー出力してexit 1
   └─ stats.hasErrors() → エラー出力してexit 1
   └─ stats.hasWarnings() → 警告出力（続行）

6. バンドルされたコンパイラのテスト
   └─ requireでバンドルを読み込み
   └─ CoffeeScriptオブジェクトを抽出
   └─ global.testingBrowser = yesを設定
   └─ runTests(CoffeeScript)を実行

7. クリーンアップ
   └─ fs.unlinkSyncで一時ファイルを削除
   └─ テスト失敗時はexit 1
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Node.js >= 10.13.0?}
    B -->|いいえ| C[早期リターン]
    B -->|はい| D[一時ディレクトリ取得]
    D --> E[webpack require]
    E --> F[Webpack設定構築]
    F --> G[Webpackバンドル実行]
    G --> H{ビルドエラー?}
    H -->|あり| I[エラー出力]
    I --> J[exit code 1]
    H -->|なし| K{ビルド警告?}
    K -->|あり| L[警告出力]
    K -->|なし| M[バンドル読み込み]
    L --> M
    M --> N[global.testingBrowser = yes]
    N --> O[runTests実行]
    O --> P[一時ファイル削除]
    P --> Q{テスト成功?}
    Q -->|成功| R[バッチ終了]
    Q -->|失敗| J
    C --> R
```

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

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

データベース操作は行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Webpackビルドエラー | モジュール解決失敗、構文エラー等 | エラーメッセージを確認し、モジュール設定を修正 |
| - | Webpack警告 | 非推奨機能の使用、パフォーマンス警告等 | 警告内容を確認し、必要に応じて対応 |
| - | テスト失敗 | テストケースのアサーションが失敗 | 失敗したテストケースを特定し修正 |
| - | ファイルアクセスエラー | 一時ディレクトリへの書き込み権限なし | 一時ディレクトリの権限を確認 |

### リトライ仕様

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

### 障害時対応

Webpackビルドエラー時は、エラースタックとエラー詳細が標準エラー出力に出力される。統計情報にエラーが含まれる場合は、各エラーがループで出力される。警告についても同様に出力されるが、警告の場合は処理を継続する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のWebpackバンドル + テストスイート実行 |
| 目標処理時間 | 数分以内（Webpackバンドル含む） |
| メモリ使用量上限 | Webpackの標準使用量（数百MB程度） |

## 排他制御

同時実行に対する排他制御は行わない。一時ファイルのパスは固定されているため、同時に複数のプロセスを実行すると競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | - |
| 進捗ログ | なし | - |
| 終了ログ | テスト完了時 | "passed X tests in Y seconds" |
| エラーログ | ビルドエラー時 | エラースタック、エラー詳細 |
| 警告ログ | ビルド警告時 | 警告内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプライン |
| 処理時間 | プロジェクト設定による | CI/CDパイプライン |

## 備考

- Webpack 5はNode.js 10.13.0以上を要求するため、それ未満のバージョンではこのテストはスキップされる
- `optimization.minimize: off`を設定している理由は、Webpackの圧縮処理がCoffeeScriptモジュールのテスト失敗を引き起こすため
- `libraryTarget: 'commonjs2'`により、バンドルされたモジュールはNode.jsのrequireで読み込み可能
- `package.json`の`browser`フィールドにより、Webpackはブラウザ向けのエントリーポイント（レガシーコンパイラ）を使用する
- このテストにより、Node.js固有のモジュール（fs、path等）がブラウザ向けバンドルに含まれないことを間接的に検証できる
- devDependencyとしてwebpack `~5.72.0`が指定されている
