# バッチ設計書 6-docker-start

## 概要

本ドキュメントは、Docker環境用の起動スクリプト「docker-start」の設計仕様を記載したものです。

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

このバッチは、Dockerコンテナ内でActual Budget開発環境を起動するためのシェルスクリプトです。依存関係のインストール状態を確認し、必要に応じてyarnで依存関係をインストールしてからアプリケーションを起動します。

**業務上の目的・背景**：Docker開発環境において、コンテナが初めて起動される際やnode_modulesがマウントされていない場合に、依存関係を自動的にインストールする必要があります。このスクリプトにより、開発者はコンテナ起動後すぐに開発を開始でき、手動でのyarnインストール作業が不要になります。特にボリュームマウントを使用した開発環境では、ホストとコンテナ間でnode_modulesの状態が異なる場合があるため、この自動チェックは重要です。

**バッチの実行タイミング**：Dockerコンテナ起動時に自動実行されます。docker-compose.ymlのcommandまたはCMDで指定されます。

**主要な処理内容**：
1. node_modulesディレクトリの存在確認
2. ディレクトリが存在しないか空の場合、yarnで依存関係をインストール
3. BROWSER=0環境変数を設定してブラウザ自動起動を抑制
4. yarn start:browserでアプリケーションを起動

**前後の処理との関連**：Dockerコンテナのエントリーポイントとして動作します。コンテナビルド後の最初の起動時に依存関係をインストールし、以降の起動ではキャッシュされたnode_modulesを使用します。

**影響範囲**：コンテナ内のnode_modulesディレクトリ、アプリケーションプロセス

## バッチ種別

ビルド・デプロイ / 環境構築

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | コンテナ起動時 |
| 実行時刻 | コンテナ起動時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | Docker コンテナ起動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Dockerコンテナ内 | Dockerコンテナ環境で実行されること |
| プロジェクトルート | カレントディレクトリがプロジェクトルートであること |
| yarn利用可能 | yarnコマンドが利用可能であること |

### 実行可否判定

常に実行可能。node_modulesの状態に応じて依存関係インストールをスキップまたは実行します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| node_modules | ディレクトリ | 依存関係インストール先 |
| package.json | JSON | 依存関係定義 |
| yarn.lock | ファイル | 依存関係バージョンロック |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| node_modules | ディレクトリ | インストールされた依存関係 |
| 標準出力 | テキスト | yarn/アプリケーションログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | node_modules/* |
| 出力先 | プロジェクトルート |
| 文字コード | 該当なし |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. node_modulesディレクトリ確認
   └─ [ ! -d "node_modules" ] で存在確認
2. ディレクトリ内容確認
   └─ [ "$(ls -A node_modules)" = "" ] で空かどうか確認
3. 条件分岐
   ├─ 存在しないまたは空の場合: yarn実行
   └─ 存在して内容がある場合: スキップ
4. アプリケーション起動
   └─ BROWSER=0 yarn start:browser
```

### フローチャート

```mermaid
flowchart TD
    A[コンテナ起動] --> B{node_modules存在?}
    B -->|No| C[yarn実行]
    B -->|Yes| D{node_modules空?}
    D -->|Yes| C
    D -->|No| E[yarn スキップ]
    C --> F[yarn start:browser]
    E --> F
    F --> G[アプリケーション稼働]
```

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

該当なし。このスクリプトはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | yarn-error | 依存関係インストール失敗 | ネットワーク接続、package.jsonを確認 |
| - | start-error | アプリケーション起動失敗 | ログを確認、ポート競合を確認 |

### リトライ仕様

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

### 障害時対応

1. yarn失敗時：ネットワーク接続を確認、npm registryの可用性を確認
2. 起動失敗時：ポート5006が使用中でないか確認
3. 権限エラー時：コンテナのユーザー権限を確認

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

該当なし。

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回（コンテナ起動時） |
| 目標処理時間 | 初回: 数分（依存関係インストール）、2回目以降: 数秒 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同一コンテナ内では単一プロセスとして実行されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| インストールログ | yarn実行時 | 依存関係インストール進捗 |
| 起動ログ | アプリケーション起動時 | サーバー起動メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| コンテナ状態 | 異常終了 | Dockerオーケストレーター |

## 備考

- 実行場所: Dockerコンテナ内
- シェルスクリプト（/bin/sh）として実行
- BROWSER=0環境変数により、開発サーバー起動時のブラウザ自動起動を抑制
- yarn start:browserは`npm-run-all --parallel`で複数のビルド・監視プロセスを起動
- プロジェクトルートの`bin/docker-start`に配置
- docker-compose.ymlのcommandとして指定されることを想定
