# バッチ設計書 1-build.mjs

## 概要

本ドキュメントは、Jestモノレポにおけるパッケージビルドバッチ `build.mjs` の設計仕様を記載したものです。このバッチはWebpackを使用して各パッケージのTypeScriptソースコードをJavaScriptにバンドルし、ESM対応の.mjsエントリファイルも自動生成します。

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

**業務上の目的・背景**：Jestは55以上のパッケージから構成されるモノレポ構造を採用しており、各パッケージのTypeScriptソースコードを本番環境で利用可能なJavaScriptファイルに変換する必要があります。このバッチは、開発者がソースコードを変更した後、npmパッケージとして配布可能な形式にビルドするために不可欠な処理です。Webpackによる依存関係の解決とBabelによるトランスパイルを組み合わせることで、一貫性のあるビルド成果物を生成します。

**バッチの実行タイミング**：開発者が `yarn build:js` コマンドを実行した際に随時実行されます。CI/CDパイプラインでは、プルリクエストのマージ前検証やリリース準備時に自動実行されます。開発時には約5秒で完了するため、頻繁なイテレーションが可能です。

**主要な処理内容**：
1. `buildUtils.mjs` から共有設定とビルド構成を取得
2. 各パッケージの `src/index.ts` をエントリポイントとしてWebpackコンパイラを初期化
3. Webpackバンドル処理を実行し、CommonJS形式の `build/index.js` を生成
4. ビルド成功後、各パッケージのエクスポートを解析しESM用の `.mjs` エントリファイルを自動生成
5. 型のみのパッケージ（babel-preset-jest、@jest/environment等）はスキップ

**前後の処理との関連**：このバッチは `yarn install` によるnode_modulesの準備が前提となります。後続処理として `buildTs.mjs` によるTypeScript定義ファイルのビルド、`bundleTs.mjs` による型定義のバンドル処理があります。開発時は `watch.mjs` と組み合わせて自動再ビルドを実現できます。

**影響範囲**：全55パッケージの `packages/*/build/` ディレクトリ配下にビルド成果物が出力されます。テスト実行やE2Eテストは、このビルド成果物に対して行われるため、ビルドが失敗するとテストも実行できません。

## バッチ種別

ビルド処理 / トランスパイル / バンドル処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| 依存関係インストール済み | `yarn install` が完了していること |
| パッケージ構造 | `packages/*/src/index.ts` が存在すること |

### 実行可否判定

- `packages/` ディレクトリ配下に `package.json` を持つサブディレクトリが存在するかを確認
- 各パッケージの `src/index.ts` が存在しない場合、そのパッケージはスキップされる
- `typeOnlyPackages` に含まれるパッケージは .mjs 生成をスキップ

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/src/index.ts | TypeScript | 各パッケージのエントリポイント |
| packages/*/package.json | JSON | パッケージメタデータ（main, types, exports等） |
| babel.config.js | JavaScript | Babelトランスパイル設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| packages/*/build/index.js | JavaScript (CommonJS) | メインエントリポイント |
| packages/*/build/index.mjs | JavaScript (ESM) | ESMエントリポイント |
| packages/*/build/*.js | JavaScript (CommonJS) | 追加エントリポイント（worker等） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | `[name].js`（Webpack output.filename設定） |
| 出力先 | `packages/*/build/` |
| 文字コード | UTF-8 |
| モジュール形式 | CommonJS（.js）/ ESModule（.mjs） |

## 処理フロー

### 処理シーケンス

```
1. ビルド設定の生成
   └─ createBuildConfigs()でパッケージ一覧とWebpack設定を取得
2. Webpackコンパイラの初期化
   └─ 全パッケージの設定を配列として渡しマルチコンパイラを生成
3. Webpackバンドル実行
   └─ compiler.run()を呼び出しバンドル処理を実行
4. ビルド結果の検証
   └─ stats.hasErrors()でエラーチェック、エラー時は詳細を出力して例外送出
5. エントリポイント存在確認
   └─ 各パッケージのpkg.mainで指定されたファイルの存在を検証
6. ESMエントリファイル生成
   └─ CommonJSモジュールのエクスポートを解析し.mjsファイルを生成
7. 完了通知
   └─ コンソールに成功メッセージを出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[createBuildConfigs実行]
    B --> C[Webpackコンパイラ初期化]
    C --> D[compiler.run実行]
    D --> E{ビルドエラー?}
    E -->|あり| F[エラー詳細出力]
    F --> G[例外送出]
    E -->|なし| H[各パッケージのループ]
    H --> I{mainファイル存在?}
    I -->|なし| J[アサーションエラー]
    I -->|あり| K{typeOnlyPackage?}
    K -->|はい| L[スキップ]
    K -->|いいえ| M[エクスポート解析]
    M --> N[.mjsファイル生成]
    N --> O[次のパッケージ]
    L --> O
    O --> H
    H --> P[成功メッセージ出力]
    P --> Q[バッチ終了]
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| AssertionError | ビルドエラー | Webpackビルド中にエラーまたは警告が発生 | エラーメッセージを確認しソースコードを修正 |
| AssertionError | ファイル不在 | pkg.mainで指定されたファイルが存在しない | package.jsonのmainフィールドを確認 |
| Error | エクスポート不在 | パッケージにエクスポートが存在しない | src/index.tsにexport文を追加 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージからエラー原因を特定
2. ソースコードの構文エラーやimportエラーを修正
3. `yarn build-clean` でビルドキャッシュをクリア後、再度 `yarn build:js` を実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 約55パッケージ |
| 目標処理時間 | 約5秒 |
| メモリ使用量上限 | Node.jsデフォルトヒープサイズ |

## 排他制御

- 同時実行は推奨されない（ファイルシステムへの同時書き込みが発生する可能性）
- watchモード実行中は本バッチを実行しないこと

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | `Bundling packages` |
| エラーログ | ビルドエラー時 | `error: [エラーメッセージ]` |
| 警告ログ | ビルド警告時 | `warning: [警告メッセージ]` |
| 終了ログ | バッチ正常終了時 | `DONE` |
| 終了ログ | バッチ異常終了時 | `BOOM` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 60秒超過 | CI/CDパイプライン |
| 終了コード | 非0 | CI/CDパイプライン |

## 備考

- 本バッチは `yarn build` の一部として実行される（`yarn build:js`）
- フルビルド（`yarn build`）は3-5分かかるが、本バッチ単体は約5秒で完了
- 開発時は `yarn watch` による自動再ビルドの利用を推奨
