# バッチ設計書 42-run-tracing-config.sh

## 概要

本ドキュメントは、clojure-lspプロジェクトの`run-tracing-config.sh`シェルスクリプトの設計を記述したものです。このスクリプトは、GraalVM native-imageエージェントを使用してトレーシング設定（リフレクション、JNI、リソースなどの設定ファイル）を生成するためのユーティリティです。

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

このスクリプトは、GraalVMのnative-imageビルドに必要なトレーシング設定ファイルを生成します。Clojureアプリケーションをネイティブイメージとしてコンパイルする際、リフレクションやJNI呼び出しなどの動的な機能を使用する箇所を事前に特定する必要があります。このスクリプトは、native-image-agentを使用してアプリケーションを実行し、必要な設定を自動収集します。

**業務上の目的・背景**：GraalVMのnative-imageは、Javaアプリケーションをネイティブ実行ファイルにコンパイルする技術です。しかし、Clojureのような動的言語では、リフレクションやリソースアクセスが多用されるため、これらを事前にGraalVMに伝える必要があります。このスクリプトは、native-image-agentを使用してアプリケーションを実行し、どのクラスがリフレクションで使用されるか、どのリソースがアクセスされるかを自動的に収集します。収集された設定は`graalvm/`ディレクトリに出力され、ネイティブイメージビルド時に使用されます。

**バッチの実行タイミング**：ネイティブイメージのビルド設定を更新する必要がある場合に手動で実行します。具体的には、新しいライブラリの追加、リフレクションを使用する新機能の追加、またはGraalVMバージョンのアップグレード時に実行されます。

**主要な処理内容**：
1. Clojureプロジェクトをプロダクション用JARとしてビルド
2. GraalVM Dockerイメージを起動
3. native-image-agentを有効にしてJARを実行
4. 収集されたトレーシング設定をgraalvm/ディレクトリにマージ出力

**前後の処理との関連**：このスクリプトは`cli-prod-jar`タスクに依存します。生成された設定ファイルは、`native-cli`タスクでネイティブイメージをビルドする際に使用されます。通常、設定生成後はgitリポジトリにコミットし、CIでのネイティブビルドに使用します。

**影響範囲**：`cli/graalvm/`ディレクトリ内の設定ファイル（reflect-config.json、resource-config.json、jni-config.jsonなど）が更新されます。これらの変更はネイティブイメージのビルド結果に直接影響します。

## バッチ種別

ユーティリティ / ビルド設定生成 / シェルスクリプト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | なし（手動実行） |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動（`./cli/graalvm/run-tracing-config.sh`コマンド） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Docker環境 | Dockerがインストールされ、起動していること |
| Clojure環境 | `clojure`コマンドが利用可能であること |
| JARビルド | `clojure-lsp.jar`がビルドされること（スクリプト内で自動ビルド） |
| 作業ディレクトリ | `cli/graalvm/`ディレクトリから実行すること |

### 実行可否判定

特別な判定ロジックはありません。JARビルドが成功し、Dockerが利用可能であれば実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | このスクリプトはパラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| clojure-lsp.jar | JAR | ビルドされたclojure-lspアプリケーション |
| graalvm/ | ディレクトリ | 既存のトレーシング設定（マージ対象） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| graalvm/reflect-config.json | JSON | リフレクション設定 |
| graalvm/resource-config.json | JSON | リソースアクセス設定 |
| graalvm/jni-config.json | JSON | JNI設定 |
| graalvm/proxy-config.json | JSON | 動的プロキシ設定 |
| graalvm/serialization-config.json | JSON | シリアライゼーション設定 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | *-config.json（各種設定ファイル） |
| 出力先 | graalvm/ |
| 文字コード | UTF-8 |
| 形式 | JSON |

## 処理フロー

### 処理シーケンス

```
1. JARビルド
   └─ clojure -X:cli-prod-jarを実行してclojure-lsp.jarを生成
2. JAR確認
   └─ カレントディレクトリのclojure-lsp.jarを参照
3. Dockerコンテナ起動
   └─ GraalVM CEイメージ（springci/graalvm-ce:20.2-dev-java11）を使用
   └─ カレントディレクトリを/clojure-lspにマウント
4. native-image-agentで実行
   └─ -agentlib:native-image-agent=config-merge-dir=/clojure-lsp/graalvmオプション
   └─ JARを実行してトレーシング情報を収集
5. 設定ファイル出力
   └─ 収集された情報をgraalvm/ディレクトリの既存設定にマージ
6. コンテナ終了
   └─ --rmフラグにより自動削除
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[clojure -X:cli-prod-jar実行]
    B --> C{JARビルド成功?}
    C -->|成功| D[clojure-lsp.jarを確認]
    C -->|失敗| E[エラー終了]
    D --> F[GraalVM Dockerコンテナ起動]
    F --> G[native-image-agentで実行]
    G --> H[トレーシング情報収集]
    H --> I[graalvm/に設定をマージ出力]
    I --> J[コンテナ削除]
    J --> K[スクリプト終了]
    E --> K
```

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

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

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

該当なし（データベース操作なし）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ビルドエラー | clojure -X:cli-prod-jarが失敗 | deps.ednと依存関係を確認 |
| - | JARファイルなし | clojure-lsp.jarが見つからない | ビルドを再実行 |
| - | Dockerエラー | Dockerデーモンが起動していない | Dockerを起動 |
| - | イメージ取得エラー | GraalVMイメージのダウンロード失敗 | ネットワーク接続を確認 |

### リトライ仕様

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

### 障害時対応

1. ビルドエラーの場合：`deps.edn`の設定を確認し、依存関係を解決してから再実行
2. Dockerエラーの場合：Docker Desktopまたはdockerdを起動してから再実行
3. イメージ取得エラーの場合：`docker pull springci/graalvm-ce:20.2-dev-java11`を手動で実行してから再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（データベース操作なし） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回のトレーシング実行 |
| 目標処理時間 | JARビルドに1-3分、トレーシング実行に数分（アプリケーションの実行内容に依存） |
| メモリ使用量上限 | Dockerコンテナに依存 |

## 排他制御

同時実行は想定していません。複数のプロセスが同じgraalvm/ディレクトリに書き込むと、設定ファイルが破損する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | JARビルド時 | Clojureビルドの出力 |
| 進捗ログ | Dockerコンテナ実行時 | Java実行の出力 |
| 進捗ログ | native-image-agent | トレーシング情報収集の進捗 |
| エラーログ | エラー発生時 | 各コマンドのエラー出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

このスクリプトはローカル開発用ユーティリティのため、監視・アラートは設定されていません。

## 備考

- 使用するDockerイメージ：`springci/graalvm-ce:20.2-dev-java11`
- native-image-agentオプション：`-agentlib:native-image-agent=config-merge-dir=/clojure-lsp/graalvm`
- `config-merge-dir`オプションにより、既存の設定にマージされる（上書きではない）
- 対話モード（`-i`フラグ）で実行されるため、標準入力が必要な場合に対応可能
- `--rm`フラグによりコンテナ終了時に自動削除
- このスクリプトは`cli/graalvm/`ディレクトリに配置されている
- 生成された設定ファイルは`native-cli`タスクで使用される
- GraalVMのバージョンは20.2-dev（Java 11）を使用しており、プロジェクトの要件に応じて更新が必要な場合がある
