# バッチ設計書 8-pod

## 概要

本ドキュメントは、clojure-lspのpodコマンド（Babashka POD実行機能）のバッチ設計を記載する。

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

clojure-lspをBabashka POD（Portable Dynamically-loadable module）として実行し、Babashkaスクリプトからclojure-lspのAPIを直接呼び出せるようにする機能を提供する。Bencode/Transitプロトコルを使用した標準入出力ベースの通信により、Babashkaプロセスとclojure-lspプロセス間でデータをやり取りする。

**業務上の目的・背景**：Babashkaは高速起動のClojureスクリプティング環境として広く使用されている。本機能により、Babashkaスクリプトからclojure-lspの解析機能（clean-ns、diagnostics、format、rename、dump等）を利用でき、CIスクリプトやビルドツールからの自動化が容易になる。

**バッチの実行タイミング**：環境変数BABASHKA_POD=trueが設定された状態でclojure-lspを実行すると自動的にPODモードで起動する。

**主要な処理内容**：
1. 環境変数BABASHKA_POD=trueの検出
2. PODプロトコルの初期化（Bencode通信）
3. describeリクエストへの応答（利用可能なAPI一覧の提供）
4. invokeリクエストの処理（API関数の実行と結果返却）
5. Transit形式でのデータシリアライズ/デシリアライズ

**前後の処理との関連**：Babashkaプロセスから起動され、親プロセスからのリクエストを処理する。

**影響範囲**：Babashkaスクリプトからclojure-lspのAPIを呼び出し、プロジェクトファイルを操作する可能性がある。

## バッチ種別

プロセス間通信 / API提供処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（Babashkaから呼び出し） |
| 実行時刻 | 該当なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | BABASHKA_POD=true環境変数 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| 環境変数 | BABASHKA_POD=trueが設定されていること |
| Babashka | 親プロセスとしてBabashkaが実行されていること |

### 実行可否判定

環境変数BABASHKA_POD="true"が設定されている場合、自動的にPODモードで起動する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| BABASHKA_POD | 環境変数 | Yes | - | "true"に設定するとPODモード起動 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 標準入力 | Bencode | Babashkaからのリクエスト |
| 各リクエストペイロード | Transit+JSON | API呼び出しの引数 |

### PODリクエスト形式

| オペレーション | 説明 |
|-------------|------|
| describe | 利用可能なAPI一覧を返却 |
| invoke | 指定されたAPI関数を実行 |

### 利用可能なAPI

| API名 | 説明 |
|------|------|
| clojure-lsp.api/analyze-project-and-deps! | プロジェクトと依存関係を解析 |
| clojure-lsp.api/analyze-project-only! | プロジェクトのみを解析 |
| clojure-lsp.api/clean-ns! | ns形式を整理 |
| clojure-lsp.api/diagnostics | 診断情報を検出 |
| clojure-lsp.api/format! | コードをフォーマット |
| clojure-lsp.api/rename! | シンボルをリネーム |
| clojure-lsp.api/dump | プロジェクトデータをダンプ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | Bencode | Babashkaへのレスポンス |
| レスポンスペイロード | Transit+JSON | API実行結果 |
| 標準エラー出力 | テキスト | ログ、エラーメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 該当なし（標準入出力のみ） |
| 出力先 | 標準出力 |
| 文字コード | UTF-8 |
| 区切り文字 | Bencode形式 |

## 処理フロー

### 処理シーケンス

```
1. 環境変数チェック
   └─ BABASHKA_POD=trueの検出
2. PODモード起動
   └─ pod/run-pod関数の実行
3. メインループ開始
   └─ stdin（Bencode）からのリクエスト読み込み
4. リクエスト解析
   └─ オペレーション（describe/invoke）の判定
5. オペレーション実行
   └─ describe: API一覧を返却
   └─ invoke: 指定API関数を実行
6. レスポンス送信
   └─ stdout（Bencode）にレスポンス書き込み
7. ループ継続
   └─ 次のリクエストを待機
8. EOF検出で終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{BABASHKA_POD=true?}
    B -->|No| C[通常モード起動]
    B -->|Yes| D[PODモード起動]
    D --> E[メインループ]
    E --> F{リクエスト読み込み}
    F -->|EOF| G[終了]
    F -->|リクエストあり| H{オペレーション判定}
    H -->|describe| I[API一覧を返却]
    H -->|invoke| J[API関数を実行]
    H -->|unknown| K[エラー返却]
    I --> L[レスポンス送信]
    J --> L
    K --> L
    L --> E
    G --> M[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | 外部DBは使用しない |

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

本バッチは外部データベースを使用しない。呼び出されるAPIに応じて、内部的にAtom（db*）を使用してプロジェクト解析結果を管理する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 不明なオペレーション | describe/invoke以外のop | エラーメッセージを返却 |
| - | 不明なAPI | 存在しないvar名でinvoke | "Var not found"エラー |
| - | API実行エラー | API関数内で例外発生 | ex-message/ex-dataを返却 |

### リトライ仕様

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

### 障害時対応

PODプロセスがクラッシュした場合、Babashkaプロセス側でエラーとして検出される。標準エラー出力にエラーログが出力される。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各APIリクエスト単位 |
| コミットタイミング | 各API実行完了時 |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | リクエスト数に依存 |
| 目標処理時間 | 各API呼び出しに依存 |
| メモリ使用量上限 | JVMヒープに依存 |

## 排他制御

単一のPODプロセスは順次リクエストを処理する。複数の同時リクエストは内部的にシリアライズされる。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 例外発生時 | 例外情報（stderr） |

## 監視・アラート

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

## 備考

- Bencodeはバイナリシリアライゼーション形式で、Babashka PODプロトコルの標準
- Transit+JSONはClojureデータ構造をJSON形式でシリアライズする形式
- java.io.Fileのカスタムハンドラを登録してファイルパス情報を正しくシリアライズ
- describeレスポンスには-reg-transit-handlersコードが含まれ、Babashka側でTransitハンドラを登録
- :message-fnは返却時に除外される（関数はシリアライズ不可のため）
- 全ての標準出力はstderrにリダイレクトされる（PODプロトコルでstdoutはBencode専用）
