# バッチ設計書 9-build:demo

## 概要

本ドキュメントは、Decap CMSプロジェクトにおけるbuild:demoバッチのバッチ設計書である。package.jsonのscripts.build:demoで定義された、全パッケージをビルド後にデモサイトを構築するバッチ処理について記述する。

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

本バッチは、Decap CMSの全パッケージをビルドした後、decap-cmsパッケージのdist出力をdev-test/dist/にコピーすることでE2Eテスト用のデモサイトを構築するバッチである。`npm run build && ncp packages/decap-cms/dist dev-test/dist/`コマンドにより、ビルドとファイルコピーを順次実行する。

**業務上の目的・背景**：Decap CMSのE2Eテストを実行するためには、実際に動作するデモサイトが必要である。本バッチは、全パッケージのビルド成果物からデモサイトを構築し、dev-test/ディレクトリにE2Eテストで使用する静的サイトを配置する。これにより、http-serverで配信可能なテスト環境が構築され、CypressによるブラウザベースのE2Eテストが可能になる。

**バッチの実行タイミング**：E2Eテスト（No.2、No.13、No.14）の前段処理として実行される。手動実行（npm run build:demo）も可能である。

**主要な処理内容**：
1. npm run build（全パッケージのESM+UMDビルド、No.7の処理全体）
2. ncp packages/decap-cms/dist dev-test/dist/（decap-cmsのdist出力をdev-testにコピー）

**前後の処理との関連**：No.7（build）を内部で呼び出す。後続処理としてNo.2（Node CI - E2Eテスト）、No.13（test:e2e）、No.14（test:e2e:ci）がデモサイトを使用する。http-server（test:e2e:serve）でdev-testディレクトリを配信してE2Eテストを実行する。

**影響範囲**：dev-test/dist/ディレクトリにdecap-cmsパッケージのビルド成果物がコピーされる。E2Eテストの実行環境に直接影響する。

## バッチ種別

ビルド（デモサイト構築 - E2Eテスト環境準備）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動またはE2Eテストの前段として呼び出し） |
| 実行時刻 | 該当なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | npm run build:demo（手動）/ CI/CDワークフロー内ステップ |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js実行環境 | Node.js（22.x以上推奨）がインストールされていること |
| npm依存関係 | npm ciまたはnpm installが完了していること（ncpを含む） |
| dev-testディレクトリ | プロジェクトルートにdev-test/ディレクトリが存在すること |

### 実行可否判定

特別な実行可否判定ロジックは存在しない。npm run build:demoコマンドの実行により即座に処理が開始される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| NODE_ENV | 環境変数 | No | development | ビルドモードの制御（production/development） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/src/ | TypeScript/JavaScript | 全パッケージのソースコード |
| packages/decap-cms/dist/ | JavaScript/CSS | ビルド後のdecap-cmsパッケージ成果物 |
| dev-test/ | HTML/CSS/JS | デモサイトのベーステンプレート |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| dev-test/dist/ | JavaScript/CSS | decap-cmsパッケージのビルド成果物コピー |
| packages/*/dist/ | JavaScript | 全パッケージのビルド成果物（buildの出力） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | packages/decap-cms/dist/配下の全ファイル |
| 出力先 | dev-test/dist/ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. npm run build
   ├─ npm run build:esm（全パッケージのESMビルド）
   └─ nx run-many -t build（全パッケージのUMDビルド）
2. ncp packages/decap-cms/dist dev-test/dist/
   └─ decap-cmsパッケージのdist出力をdev-test/dist/に再帰的コピー
```

### フローチャート

```mermaid
flowchart TD
    A[npm run build:demo] --> B[npm run build]
    B --> C[npm run build:esm: ESMビルド]
    C --> D[nx run-many -t build: UMDビルド]
    D --> E{ビルド成功?}
    E -->|失敗| F[ビルドエラー]
    E -->|成功| G[ncp: packages/decap-cms/dist -> dev-test/dist/]
    G --> H{コピー成功?}
    H -->|成功| I[デモサイト構築完了]
    H -->|失敗| J[コピーエラー]
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | 該当なし | 該当なし | 該当なし |

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ビルドエラー | npm run buildが失敗した場合 | No.7（build）のエラー処理に従う |
| - | コピーエラー | ncpがファイルコピーに失敗した場合 | packages/decap-cms/distの存在を確認する |
| - | ソースディレクトリ不在 | packages/decap-cms/distが存在しない場合 | npm run buildが正常に完了しているか確認する |

### リトライ仕様

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

### 障害時対応

ビルド失敗時は以下の手順で対応する：
1. ビルドエラーの場合はNo.7（build）の障害時対応に従う
2. ncpのコピーエラーの場合はpackages/decap-cms/dist/の存在とファイル権限を確認する
3. npm run cleanでクリーンな状態にしてから再実行する

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイルシステム操作のみ） |
| コミットタイミング | 該当なし |
| ロールバック条件 | npm run cleanで全ビルド成果物およびdev-test/distを削除可能 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 全パッケージのビルド + 1パッケージのdistコピー |
| 目標処理時間 | 明示的な上限なし（通常5-15分程度、ビルド時間依存） |
| メモリ使用量上限 | 明示的な上限なし |

## 排他制御

明示的な排他制御は設定されていない。dev-test/dist/ディレクトリへの書き込みは上書きコピーのため、同時実行時にはファイル競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ビルドログ | npm run build実行中 | No.7（build）と同じビルドログ |
| コピーログ | ncpコマンド実行時 | ncpはデフォルトでは詳細ログを出力しない |
| エラーログ | エラー発生時 | ビルドエラーまたはコピーエラーの詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルド成功/失敗 | 失敗時 | コンソール出力 / CI/CDログ |

## 備考

- ncpはNode.js用の再帰的ファイルコピーユーティリティであり、devDependenciesに含まれる
- dev-test/ディレクトリにはデモサイトのHTMLテンプレートやスタイルが含まれている
- コピー元はdecap-cmsパッケージのdist出力のみであり、他のパッケージのdistはコピーされない（UMDバンドルにバンドル済み）
- E2Eテスト実行時にはhttp-serverでdev-test/ディレクトリがポート8080で配信される
- cleanスクリプトにdev-test/distが含まれているため、クリーンアップ時にデモサイトの成果物も削除される
