# バッチ設計書 5-size-report.js

## 概要

本ドキュメントは、Vue.jsプロジェクトのビルドサイズ比較レポート生成スクリプト `scripts/size-report.js` の設計仕様を定義するバッチ設計書である。

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

本バッチは、現在と以前のビルドサイズデータを比較し、バンドルファイルごとのサイズ差分およびAPI使用パターンごとのサイズ差分をMarkdownテーブル形式のレポートとして標準出力に生成するスクリプトである。

**業務上の目的・背景**：Vue.jsフレームワークのバンドルサイズは、エンドユーザーのアプリケーションパフォーマンスに直接影響する重要な指標である。コード変更がバンドルサイズに与える影響を可視化し、意図しないサイズ増加を検知するために、ビルド前後のサイズ比較レポートが必要である。本バッチはCI/CDパイプライン内でPRコメントとして投稿されるサイズレポートの内容を生成する。

**バッチの実行タイミング**：CI/CDパイプライン（`size-report.yml`ワークフロー）から呼び出される。`size-data.yml`ワークフローでサイズデータが計測された後に実行され、前回データとの差分レポートを生成する。

**主要な処理内容**：
1. `temp/size`（現在のビルドデータ）と`temp/size-prev`（前回のビルドデータ）ディレクトリからJSONファイルを読み込み
2. バンドルファイルごとのサイズ（min, gzip, brotli）を比較し、差分を計算
3. API使用パターン（`_usages.json`）ごとのサイズを比較し、差分を計算
4. Markdownテーブル形式のレポートを生成して標準出力に出力

**前後の処理との関連**：入力データは `scripts/build.js`（--sizeオプション）および `scripts/usage-size.js` によって生成される。出力されたMarkdownレポートは `size-report.yml` ワークフローによりPRコメントとして投稿される。

**影響範囲**：標準出力にMarkdownテキストが出力されるのみで、ファイルシステムへの書き込みは行わない。

## バッチ種別

レポート生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | PR作成時・push時（CI/CD内） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | size-report.ymlワークフローからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js実行環境 | Node.jsがインストールされていること |
| 現在のサイズデータ | `temp/size/` ディレクトリにビルドサイズJSONファイルが存在すること |
| markdown-table | 依存パッケージがインストール済みであること |
| pretty-bytes | 依存パッケージがインストール済みであること |

### 実行可否判定

`temp/size/` ディレクトリが存在し、サイズデータJSONファイルが読み込み可能であれば実行可能。`temp/size-prev/` が存在しない場合は差分なしのレポートが生成される。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| temp/size/*.json | JSON | 現在のバンドルファイルサイズデータ（file, size, gzip, brotli） |
| temp/size/_usages.json | JSON | 現在のAPI使用パターンサイズデータ |
| temp/size-prev/*.json | JSON | 前回のバンドルファイルサイズデータ（オプション） |
| temp/size-prev/_usages.json | JSON | 前回のAPI使用パターンサイズデータ（オプション） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | Markdown | サイズ比較レポート（Bundlesテーブル + Usagesテーブル） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | -（標準出力のみ） |
| 出力先 | stdout |
| 文字コード | UTF-8 |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. Bundlesセクションの生成（renderFiles）
   1.1 temp/sizeとtemp/size-prevディレクトリのファイル一覧を取得
       └─ アンダースコア始まり・.txt拡張子のファイルを除外
   1.2 現在と前回のファイルリストを統合
   1.3 各ファイルのJSONデータを読み込み
   1.4 サイズ差分を計算（size, gzip, brotli）
       └─ 削除されたファイルは取り消し線で表示
       └─ 差分がある場合は太字で差分値を表示
   1.5 Markdownテーブルを生成
2. Usagesセクションの生成（renderUsages）
   2.1 _usages.jsonからAPI使用パターンデータを読み込み
   2.2 各使用パターンのサイズ差分を計算
   2.3 Markdownテーブルを生成
3. レポート出力
   └─ process.stdout.writeでMarkdownレポート全体を出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Bundlesセクション生成]
    B --> C[temp/sizeファイル一覧取得]
    C --> D{temp/size-prev存在?}
    D -->|Yes| E[前回ファイル一覧取得]
    D -->|No| F[前回データなし]
    E --> G[ファイルリスト統合]
    F --> G
    G --> H[各ファイルのサイズ差分計算]
    H --> I[Bundlesテーブル生成]
    I --> J[Usagesセクション生成]
    J --> K[_usages.json読み込み]
    K --> L[使用パターンサイズ差分計算]
    L --> M[Usagesテーブル生成]
    M --> N[Markdownレポート出力]
    N --> O[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ディレクトリ読み取りエラー | temp/sizeディレクトリが存在しない | build.js --sizeを事前に実行してサイズデータを生成 |
| - | JSON読み込みエラー | サイズデータJSONの形式が不正 | 対象のJSONファイルを再生成 |

### リトライ仕様

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

### 障害時対応

入力データが不完全な場合はレポートが不完全になるが、エラーは発生しない設計。存在しないファイルはundefinedとして処理される。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | - |
| コミットタイミング | - |
| ロールバック条件 | 読み取り専用のため不要 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | バンドルファイル数（約10〜30ファイル）+ 使用パターン数（約5パターン） |
| 目標処理時間 | 1秒未満（ファイルI/OとMarkdown生成のみ） |
| メモリ使用量上限 | 明示的な制限なし |

## 排他制御

読み取り専用の処理のため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| レポート出力 | 処理完了時 | Markdownテーブル形式のサイズ比較レポート |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | CI/CDワークフロー内で処理されるため個別の監視は不要 |

## 備考

- レポートの出力形式は `## Size Report` をヘッダーとし、`### Bundles` と `### Usages` の2セクションで構成される
- ファイルが削除された場合（前回にはあるが今回にはない）は、ファイル名が取り消し線（`~~fileName~~`）で表示される
- サイズ差分が0の場合は差分表示が省略される
- `_` で始まるファイルと `.txt` 拡張子のファイルはフィルタリングされる
- `prettyBytes` ライブラリで人間可読なバイトサイズに変換される
- `markdownTable` ライブラリでMarkdownテーブルを生成する
