Skip to content
Merged
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

## [Unreleased]

### Fixed
- **Remote-SSH で入ったホストの tmux から、手元の PC の VS Code にエディタが開くようにしました(#523)。**
以前のクライアントが作った tmux のペインで、IPC ソケットを tmux のセッション環境から拾い直しても、起動されるのは
ペインの `PATH` の先頭にあるホストのデスクトップ版の `code` で、手元の PC には何も開いていませんでした。
拾い直したときは、セッション環境の `VSCODE_GIT_ASKPASS_NODE` からそのソケットと同じ VS Code サーバーの
`remote-cli` を求め、`PATH` の先頭に入れて起動します。見つからないときは理由と設定の案内を警告に出し、
これまでどおり起動します。**効かせるには `~/.tmux.conf` の `update-environment` に `VSCODE_GIT_ASKPASS_NODE` を
入れます**([環境変数ガイド](docs/user/environment-variables.md)の tmux の節の推奨設定に含まれています)。

## [4.2.0] - 2026-11-06

### Added
Expand Down
34 changes: 34 additions & 0 deletions docs/specifications/editor-open.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,35 @@ graph TD
`docker ps` の環境変数 `DOCKER_CONTEXT` と、`opener.open_editor` の `docker_context` の両方に使う
- 機密は `login` と同じく任意で注入する(`opener` の `docker compose ps` の補間のため)

### tmux で IPC ソケットを拾い直したときの起動

`up` の自動オープンと `open` に共通の、`opener.open_editor` の振る舞いである。tmux のペインのシェルの
`VSCODE_IPC_HOOK_CLI` が使えず、tmux のセッション環境から接続できるソケットを拾い直したとき
(`_prepare_ipc_env`)は、そのソケットと同じ VS Code サーバーの `remote-cli` を `PATH` の先頭に入れて起動する。
ペインの `PATH` の先頭がデスクトップ版の `code` だと、`VSCODE_IPC_HOOK_CLI` があってもホストの VS Code に向けて
開き、手元の PC に窓が開かないためである。

| 場面 | 起動に渡す環境 | ログ |
| --- | --- | --- |
| 拾い直し、SSH でない(手元のデスクトップ版の統合ターミナル) | `VSCODE_IPC_HOOK_CLI` だけ差し替え、`PATH` はペインのまま。`VSCODE_GIT_ASKPASS_NODE` を問い合わせない | info 1 行(拾い直し)だけ。`remote-cli` の warning は出さない |
| 拾い直し(SSH)、合う `remote-cli` がある | `VSCODE_IPC_HOOK_CLI` は拾い直したソケット。`PATH` は先頭が合う `remote-cli`、2 番目以降がペインの `PATH` の要素(並びも重複もそのまま。ペインに `PATH` が無ければ `remote-cli` だけ) | info 1 行(足したディレクトリ) |
| 拾い直し(SSH)、合う `remote-cli` が無い | `VSCODE_IPC_HOOK_CLI` だけ差し替え、`PATH` はペインのまま。起動は続ける | warning 1 行(見つからない理由と、`update-environment` に `VSCODE_GIT_ASKPASS_NODE` を入れる案内) |
| 拾い直していない | 変更なし。`VSCODE_GIT_ASKPASS_NODE` を問い合わせない | 変更なし |

- **合う `remote-cli` は、セッション環境の `VSCODE_GIT_ASKPASS_NODE` だけから求める。** 値は VS Code サーバーの
`node` の絶対パスで、その置かれたディレクトリの `bin/remote-cli` を使う。`~/.vscode-server` などのサーバーの
ディレクトリは探さない(版の違うサーバーが並び、拾い直したソケットのものを決められないため)。求めるのは
SSH 越し(Remote-SSH)のときだけで、手元のデスクトップ版では値が Electron のヘルパーを指し `remote-cli` が
無いため求めない。tmux への問い合わせは SSH 越しに拾い直したときに 1 回(`tmux show-environment VSCODE_GIT_ASKPASS_NODE`、上限 2 秒)だけ増える
- **足すのは、値が絶対パスで、求めたディレクトリに起動するエディタの名前の実行できる通常のファイルがあるときだけ。**
名前は `DEVBASE_EDITOR` の先頭の語の末尾の名前、無ければ `code`
- 見つからない理由は 4 つ: セッション環境に無い(tmux の失敗を含む)・消されている(`-VSCODE_GIT_ASKPASS_NODE`)・
絶対パスでない・求めたディレクトリに実行できるエディタが無い
- エディタの存在の確かめも、起動に渡す環境の `PATH` で行う(起動も同じ `PATH` で実行ファイルを探すため)。
起動するコマンドの先頭の語は書き換えない。`DEVBASE_EDITOR` が絶対パスなら、その実行ファイルが起動される
- `VSCODE_GIT_ASKPASS_NODE` は tmux の `update-environment` の既定に入っていない。利用者が
[環境変数ガイド](../user/environment-variables.md)の tmux の設定を入れたときだけセッション環境に入る

### 引数と終了コード

| 状況 | 終了コード | 出力 |
Expand Down Expand Up @@ -137,6 +166,7 @@ graph TD
| `DEVBASE_OPEN_INDEX` | `--open-index` を省いたときの番号。数でなければ 1。`up` と読み方を共有する |
| `DEVBASE_OPEN_EDITOR` / `project.yml` の `open_editor` | `open` では見ない |
| `DEVBASE_EDITOR` / `DEVBASE_EDITOR_SSH_HOST` / `DEVBASE_EDITOR_DOCKER_CONTEXT` / `DEVBASE_WORKSPACE` | `opener.open_editor` が従来どおり読む |
| tmux のセッション環境の `VSCODE_GIT_ASKPASS_NODE` | SSH 越しに IPC ソケットを拾い直したときだけ読み、合う `remote-cli` を求める。ペインのシェルの値は見ない |

永続データは持たない。

Expand Down Expand Up @@ -171,6 +201,10 @@ graph TD
- `project_open_candidates` の返す値・切り替え先の接続先へ問い合わせること・名前を解決できない/`docker ps` の失敗で
`None`(`tests/commands/test_container_open.py`)
- bash / zsh の補完(`tests/cli/test_completion.py`)
- tmux で拾い直したとき、合う `remote-cli` が `PATH` の先頭に入り起動する `code` がそれに解決されること、
ペインの要素の並びが保たれること、見つからない 4 つの理由で `PATH` が変わらず warning が 1 行出ること、
拾い直さないとき・SSH でないときに `VSCODE_GIT_ASKPASS_NODE` を問い合わせず warning も出さないこと(`tests/editor/test_opener.py`。tmux は
`subprocess.run` を差し替え、実の tmux サーバーに触れない)

実機(起動中のプロジェクト、非 TTY)では、`open` / `open --open-index <動いていない番号>` /
`open --context <存在しない context>` / `open --open 2` / `project open --open-index 2` の終了コードが上の表の
Expand Down
6 changes: 5 additions & 1 deletion docs/user/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,10 @@ devbase は**実際にソケットへ接続できるかを確認**してから V

死んでいた場合、**tmux 内なら `tmux show-environment` を見に行きます**。`update-environment`(後述)を設定していれば、tmux のセッション環境は attach のたびに更新されるので、**ペインのシェルが古くても tmux 側には生きた値が入っています**。拾えた場合はその値を使い、起動する `code` にも渡します(変数を差し替えないと `code` 自身が古いソケットへ繋ぎに行って失敗するため)。

拾い直したときは、そのソケットと同じ VS Code サーバーの `remote-cli`(`<サーバーのディレクトリ>/bin/remote-cli`)を、起動に渡す `PATH` の先頭に入れます。ペインのシェルの `PATH` の先頭がホストのデスクトップ版の `code`(`/usr/local/bin/code` など)だと、`VSCODE_IPC_HOOK_CLI` があってもホストの VS Code に向けて開き、手元の PC に窓が開かないためです。サーバーのディレクトリは、tmux のセッション環境の `VSCODE_GIT_ASKPASS_NODE`(VS Code サーバーの `node` の絶対パス)の置かれた場所から求めます。`~/.vscode-server` の下を探すことはしません(版の違うサーバーが並び、拾い直したソケットのものを決められないため)。ペインの `PATH` のほかの要素は、並びを変えずに残します。

`VSCODE_GIT_ASKPASS_NODE` は tmux の `update-environment` の既定に入っていないため、**後述の設定を入れていないと合う `remote-cli` は見つかりません**。見つからないとき(セッション環境に無い・消されている・絶対パスでない・求めた場所に実行できるエディタ(`DEVBASE_EDITOR` の先頭の語の名前。無ければ `code`)が無い)は、理由と後述の設定の案内を警告で出し、`PATH` を変えずにこれまでどおり起動します。

SSH 越しかどうかの判定も、tmux 内ではセッション環境の `SSH_CONNECTION` を見ます。SSH から立てた tmux サーバーに手元の端末から attach し直すと、ペインのシェルには `SSH_CONNECTION` が残りますが、セッション環境は `-SSH_CONNECTION`(いまのクライアントは SSH でない)に更新されます。`SSH_CONNECTION` は tmux の `update-environment` に既定で入っているので、設定は要りません。セッション環境から分からないとき(tmux 外・tmux の失敗)は、ペインのシェルの `SSH_CONNECTION` / `SSH_CLIENT` / `SSH_TTY` で判定します。

セッション環境から分かるいまのクライアントの SSH 状態が、ペインのシェルの SSH 状態(`SSH_*` の有無)と食い違うときは、向きによらず、ペインのシェルに残る `VSCODE_IPC_HOOK_CLI` はペインを作った以前のクライアントのものとみなし、そのウィンドウが開いたままで接続できても使いません。SSH から立てた tmux に手元から attach し直したときは、ホスト上のコンテナを開く URI がリモートのクライアントへ届いて開けず、手元で立てた tmux に Remote-SSH から attach し直したときは、SSH 先を経由する URI が Remote-SSH の接続を持たない手元の VS Code へ届いて開けないためです。tmux のセッション環境にいまのクライアントの生きた値が入っていれば、そちらを使います。入っていなければ IPC 無しとして扱い、SSH なら手元で実行するコマンドを示し、手元なら手元の `code` を起動します。食い違わないとき・セッション環境から分からないときは、ペインの値をこれまでどおり使います。死んだソケットを指す `VSCODE_IPC_HOOK_CLI` も、起動する `code` に渡しません。`VSCODE_IPC_HOOK_CLI` を外すときは、`PATH` から Remote-SSH などの `remote-cli`(`~/.vscode-server/bin/<commit>/bin/remote-cli`・`~/.cursor-server/...` など)を除いて手元の `code` を探します。`remote-cli` の `code` は `VSCODE_IPC_HOOK_CLI` が無いと何も開かずに終わるためです。手元の `code` が見つからなければ、起動せずにスキップします。
Expand All @@ -584,7 +588,7 @@ SSH 越しかどうかの判定も、tmux 内ではセッション環境の `SSH
set -ga update-environment " VSCODE_IPC_HOOK_CLI VSCODE_GIT_IPC_HANDLE VSCODE_GIT_ASKPASS_NODE VSCODE_GIT_ASKPASS_MAIN VSCODE_GIT_ASKPASS_EXTRA_ARGS VSCODE_NONCE GIT_ASKPASS BROWSER TERM_PROGRAM"
```

これで **attach のたびに**接続してきたクライアントの値でセッション環境が更新されます。**`devbase up` にはこの設定だけで十分**です(devbase がセッション環境を直接読むため)。
これで **attach のたびに**接続してきたクライアントの値でセッション環境が更新されます。**`devbase up` にはこの設定だけで十分**です(devbase がセッション環境を直接読むため)。`VSCODE_IPC_HOOK_CLI` と `VSCODE_GIT_ASKPASS_NODE` の 2 つは、Remote-SSH で入ったホストの tmux から手元の VS Code に開くために要ります(後者は合う `remote-cli` を求めるため)。

ただし更新されるのはセッション環境であり、**すでに起動しているペインのシェル**には波及しません。`code` を手で叩く、git の askpass を使うなど **devbase 以外**でも追随させたい場合は、シェルの rc(`~/.bash_profile` 等)にプロンプトフックを置きます。なお **rc を書き換えても、すでに動いているシェルには反映されません**(起動時に一度読むだけのため)。そのペインで直ちに効かせたいときは `source ~/.bash_profile` するか、開き直してください。

Expand Down
Loading
Loading