walover-line-harness-gui 0.1.0

package/src/server/pty.js

@@ -0,0 +1,343 @@
+/**
+ * 擬似端末（PTY）で子プロセスを起動する。
+ *
+ * 本家 CLI は実 TTY を要求するのでパイプでは起動できない。Node に PTY を作る
+ * 標準 API は無いため、外から用意する。
+ *
+ * ## 二段構え
+ *
+ * | | |
+ * |---|---|
+ * | 主 | `node-pty`。**Windows（ConPTY）と macOS / Linux の両方**を1つの経路で賄える |
+ * | 予備 | 同梱の {@link ./pty-relay.py}。Python 標準ライブラリの `pty` を使う。**Unix 専用** |
+ *
+ * ## npm が install script を止めても node-pty は使える
+ *
+ * npm 11 以降、依存パッケージの install script は既定でブロックされる。
+ * node-pty はそこでネイティブバイナリを用意するので、
+ * 素朴に見ると `npx` 配布では壊れる。実際 `posix_spawnp failed.` で落ちた。
+ *
+ * だが原因はバイナリの不在ではなかった。
+ *
+ * - node-pty の読み込みは `prebuilds/<platform>-<arch>/` への
+ *   フォールバックを**元から持っている**（`lib/utils.js`）
+ * - prebuild は tarball に同梱されている（darwin / win32 の x64・arm64）
+ * - macOS / Linux だけ、`spawn-helper` に**実行権限が付かない**のが原因だった
+ *   （post-install が chmod する役目を担っていて、それが走らないため）
+ *
+ * → 起動前にこちらで実行権限を付ければ動く。Windows は ConPTY を使い
+ *   `spawn-helper` を必要としないので、そもそもこの問題が起きない。
+ */
+
+import { spawn, spawnSync } from "node:child_process";
+import { createRequire } from "node:module";
+import { StringDecoder } from "node:string_decoder";
+import { chmodSync, statSync } from "node:fs";
+import { delimiter, dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const HERE = dirname(fileURLToPath(import.meta.url));
+const RELAY = join(HERE, "pty-relay.py");
+const require = createRequire(import.meta.url);
+
+/** clack が枠を折り返さないよう十分に広く取る（プロンプト文言の照合が壊れるため） */
+export const PTY_COLS = 200;
+export const PTY_ROWS = 50;
+
+const IS_WINDOWS = process.platform === "win32";
+
+// ── node-pty ────────────────────────────────────────────────────────
+
+/** @type {{ module: unknown }|null} 読み込み結果。失敗も含めて一度だけ判定する */
+let nodePty;
+
+/**
+ * `spawn-helper` に実行権限を付ける。
+ *
+ * npm が post-install を止めると、prebuild の spawn-helper が 0644 のままになり、
+ * 起動時に `posix_spawnp failed.` になる。ここで補う。
+ */
+function fixSpawnHelper() {
+  if (IS_WINDOWS) return; // ConPTY は spawn-helper を使わない
+
+  try {
+    const root = dirname(dirname(require.resolve("node-pty")));
+    const helper = join(root, "prebuilds", `${process.platform}-${process.arch}`, "spawn-helper");
+    const mode = statSync(helper).mode;
+    if ((mode & 0o111) === 0) chmodSync(helper, 0o755);
+  } catch {
+    // prebuild を使っていない（自前ビルド済み）場合などは、そのままで問題ない
+  }
+}
+
+/**
+ * `LH_PTY_BACKEND` で方式を固定できる。
+ *
+ * 参加者の環境で片方だけが動かないときに、切り分けるための逃げ道。
+ * `node-pty` / `python` / `none` を受け付ける。
+ */
+const forcedBackend = () => process.env.LH_PTY_BACKEND;
+
+/** @returns {any|null} */
+export function loadNodePty() {
+  const forced = forcedBackend();
+  if (forced && forced !== "node-pty") return null;
+  if (nodePty !== undefined) return nodePty.module;
+
+  try {
+    fixSpawnHelper();
+    nodePty = { module: require("node-pty") };
+  } catch {
+    nodePty = { module: null };
+  }
+  return nodePty.module;
+}
+
+// ── Python リレー（Unix のみ）────────────────────────────────────────
+
+const PYTHON_CANDIDATES = [
+  "python3",
+  "/usr/bin/python3",
+  "/opt/homebrew/bin/python3",
+  "/usr/local/bin/python3",
+];
+
+/**
+ * PTY を作れる python3 を探す。**Windows では使わない。**
+ *
+ * `LH_PTY_PYTHON` が指定されているときは**それだけを見る**。
+ * 指定したものが動かないのに黙って別のものに落ちると、
+ * どれで動いているのか分からなくなる。
+ *
+ * @returns {string|null}
+ */
+export function findPython() {
+  if (IS_WINDOWS) return null;
+  const forced = forcedBackend();
+  if (forced && forced !== "python") return null;
+
+  const candidates = process.env.LH_PTY_PYTHON
+    ? [process.env.LH_PTY_PYTHON]
+    : PYTHON_CANDIDATES;
+
+  for (const candidate of candidates) {
+    const probe = spawnSync(candidate, ["-c", "import pty, termios, fcntl, select"], {
+      stdio: "ignore",
+    });
+    if (probe.status === 0) return candidate;
+  }
+  return null;
+}
+
+/**
+ * いま使える方式。画面の起動前チェックに出す。
+ * @returns {"node-pty"|"python"|null}
+ */
+export function ptyBackend() {
+  if (loadNodePty()) return "node-pty";
+  if (findPython()) return "python";
+  return null;
+}
+
+export class PtyUnavailableError extends Error {
+  constructor() {
+    const help = IS_WINDOWS
+      ? ["Windows では node-pty が必要です。", "いったん終了して、もう一度お試しください。"]
+      : [
+          "macOS では Xcode Command Line Tools を入れると python3 が使えるようになります:",
+          "  xcode-select --install",
+        ];
+
+    super(
+      [
+        "擬似端末（PTY）を用意できませんでした。",
+        "",
+        "本家 CLI は実際の端末を要求するため、PTY 無しでは起動できません。",
+        ...help,
+      ].join("\n"),
+    );
+    this.name = "PtyUnavailableError";
+  }
+}
+
+// ── 起動 ────────────────────────────────────────────────────────────
+
+/**
+ * 子に渡す環境。
+ * @param {Record<string,string>} extra
+ */
+function childEnv(extra) {
+  return {
+    ...process.env,
+    // 本家 CLI を、このサーバーを動かしているのと同じ Node で動かす。
+    // Apple Silicon で x86_64 の Node に落ちると依存インストールが SIGILL で死ぬため、
+    // 「起動に使った Node」をそのまま引き継ぐのが確実。
+    // 区切り文字は OS で違う（Windows は ";"）ので path.delimiter を使う
+    PATH: `${dirname(process.execPath)}${delimiter}${process.env.PATH ?? ""}`,
+    // clack の記号（◆ │ └ ● ○）を確定させる。
+    // Windows の clack は TERM=xterm-256color を unicode 対応と見なすので、
+    // ここを渡さないと ASCII 代替記号になり、プロンプトの照合が崩れる
+    TERM: "xterm-256color",
+    LH_PTY_COLS: String(PTY_COLS),
+    LH_PTY_ROWS: String(PTY_ROWS),
+    ...extra,
+  };
+}
+
+/**
+ * Windows での起動の仕方。
+ *
+ * `npx` / `npm` の実体は `npx.cmd` というバッチファイルで、
+ * **`CreateProcess` はバッチファイルを直接実行できない**
+ * （node-pty の ConPTY 経路は commandLine を組んで CreateProcess に渡す）。
+ * `cmd.exe /c` を噛ませる必要がある。
+ *
+ * @param {string} command
+ * @param {string[]} args
+ * @returns {{ command: string, args: string[] }}
+ */
+function resolveLaunch(command, args) {
+  if (!IS_WINDOWS) return { command, args };
+  if (command !== "npx" && command !== "npm") return { command, args };
+
+  // /d = AutoRun をスキップ、/s = 引用符の扱いを素直にする
+  const shell = process.env.ComSpec || "cmd.exe";
+  return { command: shell, args: ["/d", "/s", "/c", command, ...args] };
+}
+
+/**
+ * @typedef {object} PtyHandle
+ * @property {(data: string) => void} write   子の stdin（PTY）へ書く
+ * @property {(signal?: NodeJS.Signals) => void} kill
+ * @property {number|null} pid
+ * @property {"node-pty"|"python"} backend
+ */
+
+/**
+ * @param {object} options
+ * @param {string} options.command
+ * @param {string[]} options.args
+ * @param {string} [options.cwd]
+ * @param {Record<string,string>} [options.env]  親の環境に足す分
+ * @param {(chunk: string) => void} options.onData
+ * @param {(info: { code: number|null, signal: NodeJS.Signals|null }) => void} options.onExit
+ * @param {(err: Error) => void} [options.onError]
+ * @returns {PtyHandle}
+ */
+export function spawnPty(options) {
+  const pty = loadNodePty();
+  if (pty) return spawnWithNodePty(pty, options);
+
+  const python = findPython();
+  if (python) return spawnWithRelay(python, options);
+
+  throw new PtyUnavailableError();
+}
+
+function spawnWithNodePty(pty, { command, args, cwd, env = {}, onData, onExit, onError }) {
+  const launch = resolveLaunch(command, args);
+  let child;
+  try {
+    child = pty.spawn(launch.command, launch.args, {
+      name: "xterm-256color",
+      cols: PTY_COLS,
+      rows: PTY_ROWS,
+      cwd,
+      env: childEnv(env),
+    });
+  } catch (err) {
+    onError?.(err instanceof Error ? err : new Error(String(err)));
+    throw err;
+  }
+
+  // 終了済みの相手に write / kill を送らない。
+  // Windows（ConPTY）では、終わったあとに kill を投げるとヒープ破損で
+  // プロセスごと落ちることがある（CI で exitCode 3221226356 を確認）。
+  // 例外を握るだけでは防げないので、送る前に止める。
+  let exited = false;
+
+  child.onData((chunk) => onData(chunk));
+  child.onExit(({ exitCode, signal }) => {
+    exited = true;
+    onExit({ code: exitCode ?? null, signal: signal ? String(signal) : null });
+  });
+
+  return {
+    backend: "node-pty",
+    pid: child.pid ?? null,
+    write(data) {
+      if (exited) return;
+      try {
+        child.write(data);
+      } catch {
+        /* 競合して終わった */
+      }
+    },
+    kill(signal = "SIGTERM") {
+      if (exited) return;
+      exited = true;
+      try {
+        child.kill(IS_WINDOWS ? undefined : signal);
+      } catch {
+        /* 競合して終わった */
+      }
+    },
+  };
+}
+
+function spawnWithRelay(python, { command, args, cwd, env = {}, onData, onExit, onError }) {
+  // リレーは Unix 専用なので、ここで Windows の分岐は要らない
+  const child = spawn(python, [RELAY, command, ...args], {
+    cwd,
+    stdio: ["pipe", "pipe", "pipe"],
+    env: childEnv(env),
+  });
+
+  // PTY からは UTF-8 が chunk 境界で割れて届く。文字単位に組み直してから渡す
+  const decoder = new StringDecoder("utf8");
+  child.stdout.on("data", (buf) => {
+    const text = decoder.write(buf);
+    if (text) onData(text);
+  });
+
+  // リレー自体の異常だけがここに来る（子の出力は PTY 側に出る）
+  child.stderr.on("data", (buf) => {
+    const text = buf.toString("utf8").trim();
+    if (text) onError?.(new Error(`pty-relay: ${text}`));
+  });
+
+  child.on("error", (err) => onError?.(err));
+
+  // "exit" は stdout にまだ中身が残っていても先に来る。
+  // ここで後始末をすると本家の最後の数行を取りこぼすので、
+  // 終了コードだけ控えて、実際の通知は "close" まで待つ。
+  /** @type {{ code: number|null, signal: NodeJS.Signals|null }} */
+  let status = { code: null, signal: null };
+  child.on("exit", (code, signal) => {
+    status = { code, signal };
+  });
+  let exited = false;
+  child.on("close", () => {
+    exited = true;
+    const rest = decoder.end();
+    if (rest) onData(rest);
+    onExit(status);
+  });
+
+  return {
+    backend: "python",
+    pid: child.pid ?? null,
+    write(data) {
+      if (exited) return;
+      if (child.stdin.writable) child.stdin.write(data, "utf8");
+    },
+    kill(signal = "SIGTERM") {
+      if (exited) return;
+      try {
+        child.kill(signal);
+      } catch {
+        /* 競合して終わった */
+      }
+    },
+  };
+}

package/src/server/redact.js

@@ -0,0 +1,54 @@
+/**
+ * 伏字化。
+ *
+ * 本家 CLI は `p.password` を使っておらず、チャネルシークレットもアクセストークンも
+ * `p.text` で受け取る。つまり**入力した値がそのまま端末にエコーされる**（実測済み）。
+ * 子プロセスの出力をそのまま画面に流すと、シークレットがブラウザに出る。
+ *
+ * ここを通していない文字列を、画面・API 応答・ログに出さないこと。
+ */
+
+export const MASK = "••••••••";
+
+/**
+ * 既知のシークレット値を伏字に置き換える。
+ *
+ * 長いものから順に置換する（短い値が長い値の一部だった場合に取りこぼさないため）。
+ *
+ * @param {string} text
+ * @param {Iterable<string>} secrets
+ */
+export function redactText(text, secrets) {
+  let out = text;
+  const values = [...secrets]
+    .filter((v) => typeof v === "string" && v.length >= 4)
+    .sort((a, b) => b.length - a.length);
+
+  for (const value of values) {
+    out = out.split(value).join(MASK);
+  }
+  return out;
+}
+
+/**
+ * @param {string[]} lines
+ * @param {Iterable<string>} secrets
+ */
+export function redactLines(lines, secrets) {
+  const values = [...secrets];
+  return lines.map((line) => redactText(line, values));
+}
+
+/**
+ * 入力途中の行を丸ごと伏せる。
+ *
+ * エコーは1文字ずつ届くため、確定前の行にはシークレットの**先頭数文字**が出る。
+ * 完全一致の置換では拾えないので、シークレットを入力中の値行は中身を見ずに潰す。
+ *
+ * @param {string} line   `│  ` を含む値行
+ */
+export function maskValueLine(line) {
+  const m = /^(\s*[\u2502|][ \t]*)(\S.*)$/u.exec(line);
+  if (!m) return line;
+  return `${m[1]}${MASK}`;
+}