Skip to content

Commit f9e9e71

Browse files
takemi-ohamaclaude
andcommitted
docs(issues): devbase list TUI化 設計書(i29) 追加 + issues/ を git 追跡対象化
- issues/i29_list-tui-simple-term-menu.md: simple-term-menu 導入による devbase list 対話選択の TUI 化(矢印移動 / [1-9] ジャンプ / `/` 検索)設計 - .gitignore から issues/ 除外を解除し、既存 issue/PLAN 文書をまとめて追跡対象化 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent b0a7fdb commit f9e9e71

9 files changed

Lines changed: 1295 additions & 1 deletion

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,4 @@ plugins/*/
1111
projects/*
1212
!projects/.gitkeep
1313
.env.sources.yml
14-
issues/
1514
.cache/

issues/PLAN03-1.md

Lines changed: 339 additions & 0 deletions
Large diffs are not rendered by default.

issues/PLAN04_plugin-repo-persistence.md

Lines changed: 400 additions & 0 deletions
Large diffs are not rendered by default.

issues/PLAN06_project-subcommand.md

Lines changed: 256 additions & 0 deletions
Large diffs are not rendered by default.

issues/i04.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# 開発AIエージェント向け指示書
2+
3+
* このドキュメントは開発AIエージェント向けの指示書です。
4+
* チャットで「docs/cmd01.mdのx番を実行してください」と言われたらこのファイルを読み、見出しに書いてある番号の内容を実行してください。
5+
* aiからのレポートはこのファイルに書き込むのではなく、issues/にファイルを作って出力してください
6+
7+
# 1. pluginsの .git保持
8+
* 現在、devbase plugin installでは、対象となるpluginをplugins/ディレクトリに格納しています。
9+
* しかし、これではgitリポジトリの情報(.git)を引き継がないため、プラグインの修正や機能追加が非常にやりづらいです。
10+
* そこで、devbase plugin repo add https://github.com/devbasex/devbase-samples.git でリポジトリを登録した際、repos/ディレクトリにgit cloneする仕様に変更して下さい
11+
* devbase plugin install はこのリポジトリからprojectsフォルダにシンボリックリンクを張ることになります
12+
* 必然的にpluginsディレクトリは廃止となるはずです
13+
* シンボリックリンクなので、プラグインの変更commit/pushは、repos/のリポジトリをそのままcommit/pushするだけになります。
14+
* ただし、.envなどの機密情報や.docker-compose.scale.ymlなどの一時ファイルは厳密に.gitignoreする必要があります。
15+
* planを作成してissues/に保存してください。

issues/i05.md

Whitespace-only changes.

issues/i06.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# i06: `devbase project` サブコマンド導入 — プロジェクト名指定起動 + 一覧選択
2+
3+
## 背景
4+
5+
現在 `devbase up` は CWD のディレクトリ名 (または `COMPOSE_PROJECT_NAME`) でプロジェクトを特定する。
6+
そのため、プロジェクトを起動するには毎回 `cd projects/<name>` してから `devbase up` する必要がある。
7+
8+
また `devbase container up` というコマンド名は Docker コンテナの操作という実装詳細を露出しており、
9+
ユーザが意図する「プロジェクトを立ち上げる」という操作とずれている。
10+
11+
## 提案
12+
13+
### 1. `devbase project up <project_name>` でプロジェクト起動
14+
15+
```bash
16+
# 現状: cd が必要
17+
cd projects/adminer
18+
devbase up
19+
20+
# 新方式: どこからでもプロジェクト名で起動
21+
devbase project up adminer
22+
```
23+
24+
- `projects/` ディレクトリ内のシンボリックリンク名をプロジェクト名として解決する
25+
- 引数省略時は現状と同じく CWD ベースにフォールバック
26+
27+
### 2. `devbase project list` でプロジェクト一覧 + 選択式起動
28+
29+
```bash
30+
devbase project list
31+
# → プロジェクト一覧を表示
32+
33+
devbase project list --interactive
34+
# → 一覧から選択して起動 (inquirer / simple_term_menu 等)
35+
```
36+
37+
表示例:
38+
```
39+
NAME PLUGIN STATUS
40+
adminer adminer running
41+
carmo carmo-web stopped
42+
carmo.takemi personal stopped (※ PLAN04 衝突 suffix)
43+
```
44+
45+
### 3. コマンド体系のリネーム
46+
47+
| 現状 | 新方式 | 備考 |
48+
|---|---|---|
49+
| `devbase container up` | `devbase project up [name]` | プロジェクト名引数を追加 |
50+
| `devbase container down` | `devbase project down [name]` | 同上 |
51+
| `devbase container ps` | `devbase project ps` / `devbase project list` | 一覧と統合 |
52+
| `devbase container login` | `devbase project login [name]` | 同上 |
53+
| `devbase container logs` | `devbase project logs [name]` | 同上 |
54+
| `devbase container scale` | `devbase project scale [name]` | 同上 |
55+
| `devbase container build` | `devbase project build [name]` | 同上 |
56+
| `devbase up [name]` (ショートカット) | `devbase project up [name]` のシノニム | 引数なし時は CWD フォールバック |
57+
| `devbase list` (ショートカット) | `devbase project list` のシノニム | |
58+
| `devbase container` (エイリアス `ct`) | 非推奨化 → 将来削除 | 移行期間中はエイリアスとして残す |
59+
60+
## シノニム (トップレベルショートカット)
61+
62+
トップレベルコマンドは `devbase project *` のシノニムとして同じ引数を受け入れる:
63+
64+
| ショートカット | 実体 |
65+
|---|---|
66+
| `devbase up [name]` | `devbase project up [name]` |
67+
| `devbase down [name]` | `devbase project down [name]` |
68+
| `devbase list` | `devbase project list` |
69+
| `devbase ps` | `devbase project ps` |
70+
| `devbase login [name]` | `devbase project login [name]` |
71+
| `devbase build [name]` | `devbase project build [name]` |
72+
| `devbase scale [name] N` | `devbase project scale [name] N` |
73+
74+
## 後方互換性
75+
76+
- `devbase container *` は非推奨 warning を出しつつ `devbase project *` に委譲
77+
- 移行期間 (1〜2 リリース) 後に `container` サブコマンドを削除
78+
79+
## 依存
80+
81+
- PLAN04 (repos/ 永続クローン) の同名衝突 suffix が `project list` の表示に影響するため、PLAN04 完了後が望ましい
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# i28: Docker コンテナのゾンビプロセス蓄積を `init: true` 注入で解消する
2+
3+
## 関連リンク
4+
5+
- Issue: https://github.com/devbasex/devbase/issues/28
6+
- 関連 issue: https://github.com/devbasex/ai-plugins/issues/21
7+
8+
## 概要
9+
10+
`generate_scaled_compose()` が生成する各サービスに `init: true``setdefault` で注入し、
11+
docker がコンテナ PID 1 に tini を挿入するようにする。これにより orphan プロセスが自動 reap され、
12+
ゾンビ (`<defunct>`) の蓄積が解消される。
13+
14+
## 問題・背景
15+
16+
- devbase コンテナの PID 1 は entrypoint の `tail -f /dev/null` であり、SIGCHLD を受けても orphan を reap しない。
17+
- このため `nohup ... & disown` で起動・終了したプロセスがゾンビ化して蓄積する。
18+
- 特に `ndf:cross-review` skill は codex/gemini CLI を `nohup & disown` で起動し `monitor.py` で監視するため、
19+
以下の二次被害が出る:
20+
1. ゾンビに対しても `kill -0` が成功し、`monitor.py` が「実行中」と誤判定 → hard timeout (420s) まで待たされる
21+
2. PID 1 が reap しないためコンテナ再起動まで蓄積し続ける
22+
- Docker Compose の `init: true` は 20KB の軽量 init (tini) を PID 1 として挿入し、シグナル転送 + ゾンビ reap を行う。
23+
`PR_SET_CHILD_SUBREAPER` より単純で確実。
24+
25+
### 注入箇所が `generate_scaled_compose()` で十分な根拠
26+
27+
`devbase up` (`cmd_up`) は **常に** `generate_scaled_compose()` を呼び、生成した
28+
`.docker-compose.scale.yml` **単独**`docker compose up` する (`lib/devbase/commands/container.py:175,179`)。
29+
scale=1 でも同経路を通るため、ここへの注入で全 `devbase up` ケースを網羅できる。
30+
ベース `compose.yml` テンプレート側の変更は不要。
31+
32+
## 修正対象
33+
34+
- `lib/devbase/volume/compose.py``generate_scaled_compose()` の 2 つのサービス生成ループ
35+
- `tests/volume/test_compose.py` (新規) — `init` 注入のユニットテスト
36+
- `tests/volume/__init__.py` (新規) — テストパッケージ初期化
37+
38+
## タスク分解
39+
40+
### Task 1: dev インスタンスへの `init` 注入
41+
42+
- **対象ファイル:** `lib/devbase/volume/compose.py`
43+
- **変更内容:** dev インスタンス複製ループ (`for i in range(1, scale + 1)` 内) で
44+
`service.setdefault('init', True)` を追加する。`setdefault` のため、ユーザーが明示的に
45+
`init: false` を指定していれば尊重して上書きしない。
46+
47+
### Task 2: non-dev サービスへの `init` 注入
48+
49+
- **対象ファイル:** `lib/devbase/volume/compose.py`
50+
- **変更内容:** non-dev サービス複製ループ (`for service_name, service_config in services.items()` 内) で
51+
`copied.setdefault('init', True)` を追加する。mysql / valkey 等にも tini を挿入し安全側に倒す。
52+
53+
### Task 3: ユニットテスト追加
54+
55+
- **対象ファイル:** `tests/volume/test_compose.py` (新規), `tests/volume/__init__.py` (新規)
56+
- **変更内容:** 一時 `compose.yml` を用意して `generate_scaled_compose()` を呼び、生成された
57+
`.docker-compose.scale.yml` を読み戻して以下を検証する:
58+
- dev-1 (および scale>1 の各 dev-i) に `init: true` が付く
59+
- non-dev サービス (例: mysql) に `init: true` が付く
60+
- 明示的に `init: false` を指定したサービスは `false` のまま (setdefault の尊重)
61+
62+
## 影響範囲
63+
64+
- `devbase up` / `devbase scale` 経由で生成される全コンテナ。挙動は「PID 1 が tini になる」のみで、
65+
entrypoint (`tail -f /dev/null`) は tini の子プロセスとして従来どおり動作する。後方互換。
66+
- `init: false` を明示指定済みのプロジェクトには影響しない。
67+
68+
## テスト計画
69+
70+
- [ ] `pytest tests/volume/test_compose.py` が通る (init 注入 / false 尊重)
71+
- [ ] 既存テストにリグレッションがない (`pytest tests/`)
72+
- [ ] (手動) `devbase up && devbase login``ps -p 1 -o comm=``tini` を返す
73+
- [ ] (手動) `nohup sleep 1 & disown; sleep 3; ps aux | grep 'Z.*defunct'` がゾンビを出さない
74+
75+
## PR 計画 (単一 PR)
76+
77+
| 項目 ||
78+
|---|---|
79+
| 種別 | 単一 PR (release ブランチ不要) |
80+
| branch 名 | `fix/i28-docker-init-zombie-reap` |
81+
| base | `main` |
82+
| 根拠 | 変更は 1 実装ファイル + テストのみ・結合度低・依存タスクなし (差分 ~60 行) |
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# `devbase list` 対話選択の TUI 化 設計書
2+
3+
- 日付: 2026-06-07
4+
- 対象: `devbase list` / `devbase project list --interactive` の対話選択 UI
5+
- 関連: PR #39 (対話選択をデフォルト化), PR #40 (status 集計修正)
6+
7+
## 1. 目的 / 背景
8+
9+
現在 `devbase list`(デフォルトで対話モード)は stdlib `input()` ベースで、
10+
`[1] name (plugin, status)` の番号一覧を表示し番号入力で 1 件選択 → `project up` を起動する。
11+
矢印キーによる行移動がなく、視認性・操作性が低い。
12+
13+
本変更では、CLI 用の著名ライブラリ **simple-term-menu** を導入し、以下を実現する。
14+
15+
- ↑↓ 矢印キーによる行移動
16+
- 番号(先頭 9 件のショートカット)による該当行への即ジャンプ&選択
17+
- `/` によるインクリメンタル検索(38 件規模での実用的な絞り込み)
18+
19+
「自作せず著名ライブラリを使う」というユーザ方針に従う。
20+
(現コードのコメントにある「`simple_term_menu` 等の外部依存を増やさず」という旧方針を本変更で転換する。)
21+
22+
## 2. 対象環境 / 制約
23+
24+
- macOS / Linux のみ対応(Windows ネイティブ端末は対象外)。
25+
simple-term-menu は Unix 系専用であり本制約と一致する。
26+
- 実行経路: `bin/devbase``uv run --project "$DEVBASE_ROOT" python -m devbase.cli`
27+
依存は `pyproject.toml` + `uv.lock` 管理で `.venv` に解決されるため、追加のブートストラップは不要。
28+
- プロジェクト数は実運用で数十件(現状 38 件)。多桁番号の任意行直接ジャンプは
29+
どの著名ライブラリもネイティブ非対応であり、`[1-9]` ショートカット + `/` 検索で代替する。
30+
31+
## 3. 変更範囲
32+
33+
- `pyproject.toml`: `dependencies``simple-term-menu>=1.6` を追加。`uv lock``uv.lock` 更新。
34+
- `lib/devbase/commands/project.py`: `_interactive_select_and_up` を TUI 化。
35+
- `list_projects` / `_print_table` / `cmd_project_list` のディスパッチ・非 TTY 判定は現状維持。
36+
- `tests/cli/test_project_list.py`: 主経路を TUI ラッパ注入に更新 + 追加ケース。
37+
38+
`commands/status.py` 等の状態集計ロジックには手を入れない。
39+
40+
## 4. 詳細設計
41+
42+
### 4.1 関数構成
43+
44+
`commands/project.py` に以下を導入する。
45+
46+
- `_build_menu_entries(rows) -> tuple[list[str], list[str]]`
47+
桁揃えした表示文字列リストと、それに対応する name リストを返す純粋関数。
48+
先頭 9 件には simple-term-menu のショートカット記法 `[1]``[9]` を付与する。
49+
STATUS は色付け(4.3 参照)。テスト容易性のため副作用なし。
50+
- `_show_menu(rows) -> int | None`
51+
`TerminalMenu` を構築し `show()` の結果(選択 index / 中止時 None)を返す薄いラッパ。
52+
テストはこの関数を monkeypatch して選択を注入する(TerminalMenu 自体は起動しない)。
53+
- `_fallback_select(rows) -> int | None`
54+
現行 `input()` 番号入力ロジックを関数として温存。選択 index / 中止 None を返す。
55+
- `_interactive_select_and_up(rows) -> int`
56+
上記を統合。simple-term-menu の import 可否で経路分岐し、選択 index から
57+
`cmd_project up <name>` を起動(現状と同じ委譲)。
58+
59+
### 4.2 TerminalMenu の挙動
60+
61+
- 各行: `NAME PLUGIN STATUS`(桁揃え)。先頭 9 件は `[n]` ショートカット付き。
62+
- 設定:
63+
- `cycle_cursor=True`(端で循環)
64+
- `clear_screen=False`(スクロールバックを汚さない)
65+
- 検索キー `/``show_search_hint=True`
66+
- `status_bar` に操作ヒント(矢印 / 番号 / `/` 検索 / Enter / ESC)
67+
- キー操作:
68+
- ↑↓: 行移動
69+
- `1``9`: 該当行へジャンプ(先頭 9 件)
70+
- `/`: 名前のインクリメンタル検索
71+
- Enter: 確定 → `cmd_project up <name>`
72+
- ESC / `q`: 中止(`show()` が None を返す → 戻り値 0)
73+
74+
### 4.3 STATUS 色付け
75+
76+
- `running (N containers)` 系 = 緑、`stopped` = 灰、`unknown` = 既定色、で視認性を上げる。
77+
- リスク: simple-term-menu はメニュー項目内の ANSI エスケープで表示幅計算や
78+
ハイライトバーがずれる場合がある。
79+
- 方針: **実装時に実機(Unix TTY)で検証**し、
80+
- 桁揃え・ハイライト・検索が破綻しない → 色付きで採用
81+
- 破綻する → STATUS はプレーンに自動デグレード(機能優先・色は諦める)
82+
- 色付けの有無に関わらず矢印 / 番号 / 検索の核機能を最優先で保証する。
83+
- 非 TTY フォールバックの `_print_table` は従来どおりプレーン(パイプ安全)。
84+
85+
### 4.4 フォールバック / 堅牢性
86+
87+
- 非 TTY(stdin/stdout いずれかが非 TTY): 既存 `isatty` ガードで `_print_table` 表示(現状維持)。
88+
- `import simple_term_menu` 失敗時: `logger.warning` の上で `_fallback_select`(現行 input 方式)へ。
89+
→ simple-term-menu 未同期環境でも従来どおり番号入力で選択可能。
90+
- 非対話(EOFError)/ Ctrl+C / 空入力 / 範囲外: 現行と同じ中止・再入力挙動を維持。
91+
92+
## 5. テスト設計
93+
94+
`tests/cli/test_project_list.py` を更新する。
95+
96+
- 主経路(TUI):
97+
- `_show_menu` を monkeypatch して index を返す → `cmd_project up <name>` が正しい name で呼ばれる。
98+
- `_show_menu` が None → 中止(戻り値 0、`cmd_project` 未呼出)。
99+
- `_build_menu_entries`: 先頭 9 件に `[1-9]` 付与 / 10 件目以降は無印 / name 対応が一致。
100+
- フォールバック経路:
101+
- `import simple_term_menu` を失敗させ(`monkeypatch` で ImportError 注入)、
102+
`builtins.input` 経由で選択 → `cmd_project up` 起動(既存 input テストをこちらに移設)。
103+
- 非 TTY: 既存の table フォールバックテストを維持。
104+
105+
色付けの ANSI 有無はユニットテストでは検証しづらいため、`_build_menu_entries`
106+
「色付け関数を差し替え可能」または「name 抽出は色と独立」に設計し、テストは name/index の
107+
対応とショートカット付与に集中する。色の見た目は実機検証(手動)で確認する。
108+
109+
## 6. 受け入れ基準
110+
111+
- `devbase list`(TTY)で矢印上下移動・`[1-9]` ジャンプ・`/` 検索・Enter で `up` 起動ができる。
112+
- ESC / `q` で何も起動せず終了(戻り値 0)。
113+
- 非 TTY(`devbase list | cat` 等)で従来どおりプレーンなテーブルが出る。
114+
- simple-term-menu 不在でも番号入力で選択できる(フォールバック)。
115+
- 既存・追加テストが green。
116+
117+
## 7. 非対象(YAGNI)
118+
119+
- 複数選択 / 一括 up。
120+
- Windows ネイティブ対応。
121+
- 多桁番号の任意行直接ジャンプ(`/` 検索で代替)。
122+
- preview pane(将来拡張余地として残すが本変更では実装しない)。

0 commit comments

Comments
 (0)