# バッチ設計書 13-javascript:install

## 概要

本ドキュメントは、Railsフレームワークに含まれるRakeタスク `javascript:install` の設計仕様を記載したものです。このタスクはプロジェクトのJavaScript依存関係をインストールするタスクです。

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

このバッチは、Railsプロジェクトで使用するすべてのJavaScript依存関係をインストールします。プロジェクトで使用されているパッケージマネージャー（npm、yarn、pnpm、bun）を自動検出し、適切なインストールコマンドを実行します。

**業務上の目的・背景**：現代のRailsアプリケーションでは、Webpackerやimportmap、esbuild、Vite等のJavaScriptビルドツールを使用することが一般的です。これらのツールや関連ライブラリをインストールするために、JavaScriptパッケージマネージャーによる依存関係のインストールが必要です。このタスクは、開発環境のセットアップやCI/CDパイプラインでの依存関係インストールを標準化し、プロジェクト固有のパッケージマネージャーを自動検出することで、開発者の作業を簡素化します。

**バッチの実行タイミング**：プロジェクトの初期セットアップ時、新しいJavaScript依存関係の追加後、CI/CDパイプラインでのビルド前に実行されます。手動実行またはスクリプトからの呼び出しで使用されます。

**主要な処理内容**：
1. NODE_ENV環境変数の設定（未設定の場合はRails.envに基づいて決定）
2. プロジェクトのルートディレクトリでパッケージマネージャーを自動検出
3. 検出されたパッケージマネージャーに対応するインストールコマンドを実行
4. エラー発生時は適切なエラーメッセージを表示して終了

**前後の処理との関連**：このタスクは `yarn:install` タスクの実体として機能します。`yarn:install`は`javascript:install`へのエイリアスです。アセットパイプラインのビルド前に実行されることが一般的です。

**影響範囲**：node_modulesディレクトリへのJavaScriptパッケージのインストール、package.jsonに基づく依存関係の解決を行います。

## バッチ種別

環境構築 / 依存関係インストール

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行またはCI/CD） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bin/rails javascript:install）またはCI/CDスクリプト |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション | 有効なRailsプロジェクト内で実行すること |
| package.json | プロジェクトルートにpackage.jsonが存在すること |
| パッケージマネージャー | npm、yarn、pnpm、bunのいずれかがインストールされていること |
| Node.js | Node.jsがインストールされPATHに含まれていること |

### 実行可否判定

パッケージマネージャーが検出可能で、実行可能であれば処理を続行します。検出されたパッケージマネージャーが見つからない場合はエラー終了します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| NODE_ENV | String | No | Rails.envに基づく | JavaScriptビルド環境（test/development/production） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| package.json | JSON | JavaScript依存関係定義ファイル |
| ロックファイル | 各形式 | yarn.lock / package-lock.json / pnpm-lock.yaml / bun.lockb |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| node_modules/ | ディレクトリ | インストールされたJavaScriptパッケージ |
| 標準出力（STDOUT） | テキスト | インストール進捗・結果 |
| 標準エラー出力（STDERR） | テキスト | エラーメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| 出力先 | node_modules/ |
| 形式 | パッケージマネージャー固有の形式 |

## 処理フロー

### 処理シーケンス

```
1. NODE_ENV環境変数の決定
   └─ 未設定の場合、Rails.envがtest/development/productionならそれを使用
   └─ それ以外の場合は"production"を設定
2. パッケージマネージャーの検出
   └─ JsPackageManager.detect(Rails.root)を呼び出し
   └─ ロックファイルの存在に基づいて検出（bun > pnpm > npm > yarn）
3. インストールコマンドの取得
   └─ 検出されたパッケージマネージャーに対応するコマンドを取得
4. インストールコマンドの実行
   └─ NODE_ENV環境変数を設定してsystem()で実行
5. 結果の確認
   └─ 正常終了またはエラー終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{NODE_ENV設定済み?}
    B -->|いいえ| C{Rails.envは有効な値?}
    B -->|はい| D[NODE_ENV使用]
    C -->|はい| E[Rails.envをNODE_ENVに設定]
    C -->|いいえ| F[productionをNODE_ENVに設定]
    D --> G[パッケージマネージャー検出]
    E --> G
    F --> G
    G --> H{bun.lockb/bun.lock存在?}
    H -->|はい| I[bun使用]
    H -->|いいえ| J{pnpm-lock.yaml存在?}
    J -->|はい| K[pnpm使用]
    J -->|いいえ| L{package-lock.json存在?}
    L -->|はい| M[npm使用]
    L -->|いいえ| N[yarn使用]
    I --> O[インストールコマンド実行]
    K --> O
    M --> O
    N --> O
    O --> P{実行成功?}
    P -->|はい| Q[バッチ正常終了]
    P -->|いいえ| R[エラーメッセージ表示]
    R --> S[exit 1]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| exit 1 | Errno::ENOENT | パッケージマネージャーが見つからない | 該当するパッケージマネージャーをインストール |
| exit 1 | 実行エラー | インストールコマンドが失敗 | エラーメッセージを確認し原因を解決 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認
2. パッケージマネージャーがインストールされているか確認
3. Node.jsがインストールされPATHに含まれているか確認
4. package.jsonの構文エラーがないか確認
5. ネットワーク接続を確認（パッケージのダウンロードに必要）

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 依存パッケージ数に依存 |
| 目標処理時間 | 依存パッケージ数とネットワーク速度に依存 |
| メモリ使用量上限 | パッケージマネージャーの制限に依存 |

## 排他制御

node_modulesディレクトリへの書き込みは同時実行を避けるべきです。ロックファイルによってパッケージマネージャーが排他制御を行います。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理中 | インストール進捗 |
| 標準エラー出力 | エラー発生時 | パッケージマネージャー名とエラー内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDシステム |

## 備考

- パッケージマネージャーの検出優先順位: bun > pnpm > npm > yarn（デフォルト）
- 各パッケージマネージャーのインストールコマンド:
  - bun: `bun install --frozen-lockfile`
  - pnpm: `pnpm install --frozen-lockfile`
  - npm: `npm ci`
  - yarn: `yarn install --immutable`
- `--frozen-lockfile`や`--immutable`オプションにより、ロックファイルとの整合性が保証されます
- `yarn:install`タスクはこのタスクへのエイリアスです
