walover-line-harness-gui 0.1.0

package/src/server/runner.js

@@ -0,0 +1,607 @@
+/**
+ * 本家 CLI を PTY で走らせ、**プロンプト契約に一致したときだけ**応答する。
+ *
+ * 設計の芯はひとつだけ:
+ *
+ * > 文言が一致しなければ、何も送らずに止める。
+ *
+ * 順番でマッチさせると、本家にプロンプトが1つ増えただけで値が1つずつズレる。
+ * その最悪形はチャネルシークレットがプロジェクト名の欄に入ることで、
+ * 値は画面にエコーされ、Worker 名として Cloudflare に残る。
+ * 機能不全ではなく情報漏洩なので、迷ったら止める側に倒す。
+ */
+
+import { EventEmitter } from "node:events";
+import { homedir } from "node:os";
+
+import { Terminal } from "./terminal.js";
+import { detectPrompt } from "./prompt-detector.js";
+import { matchPrompt, SECRET_FIELDS, CONTRACT_CLI_VERSION } from "./prompt-contract.js";
+import { spawnPty } from "./pty.js";
+import { redactLines, redactText, maskValueLine } from "./redact.js";
+import { parseCompletion, completionSteps } from "./completion.js";
+
+const KEY_ENTER = "\r";
+const KEY_DOWN = "\x1b[B";
+const KEY_UP = "\x1b[A";
+
+/** 画面が落ち着くまでの待ち時間。clack は1文字ごとに描き直すため、まとめてから判定する */
+const QUIET_MS = 80;
+
+/**
+ * 落ち着くのを待つ上限。
+ *
+ * 出力が途切れないと「落ち着いたら評価する」は永久に走らない。実測では
+ * **60ms 間隔で出力が続くと2秒間で評価回数 0**（`npm install` や
+ * `wrangler deploy` の出力はこれよりずっと速い）。その間、画面は完全に止まる。
+ * 進捗が見えないと参加者は「固まった」と思って中断するので、上限で必ず出す。
+ */
+const MAX_WAIT_MS = 250;
+
+/**
+ * 同じ枠が出たまま何も進まないときに、諦めて人に委ねるまでの時間。
+ *
+ * 枠の識別に画面上の絶対行番号を使っているため、**再描画の位置が動く端末**では
+ * 「同じ枠が描き直された」ことを見分けられない場面がある
+ * （Windows の ConPTY で、選択肢の移動確認と入力エラーの検出が該当）。
+ *
+ * 見分けられないと、こちらは待ち続け、本家も入力を待ち続けて画面が止まる。
+ * 黙って固まるくらいなら、止まったことを伝えて人に委ねる。
+ */
+const STUCK_MS = 45000;
+
+/**
+ * @typedef {"idle"|"running"|"waiting"|"halted"|"finished"} RunStatus
+ */
+
+export class SetupRun extends EventEmitter {
+  /**
+   * @param {object} [options]
+   * @param {string} [options.cliSpec]  起動する npm パッケージ指定
+   * @param {string} [options.cwd]
+   * @param {number} [options.quietMs]
+   * @param {number} [options.maxWaitMs]
+   * @param {number} [options.stuckMs]
+   * @param {{ command: string, args: string[] }} [options.commandOverride]  テスト用
+   */
+  constructor(options = {}) {
+    super();
+    // 既定は**契約を照合した版**に合わせる。@latest にすると、本家が
+    // プロンプトを変えた瞬間に全員が「未知のプロンプト」で止まる。
+    // 新しい版が出ていることの検知と警告は #5 で行う。
+    this.cliSpec = options.cliSpec ?? `create-line-harness@${CONTRACT_CLI_VERSION}`;
+    this.cwd = options.cwd ?? homedir();
+    this.quietMs = options.quietMs ?? QUIET_MS;
+    this.maxWaitMs = options.maxWaitMs ?? MAX_WAIT_MS;
+    this.commandOverride = options.commandOverride ?? null;
+
+    this.term = new Terminal();
+    /** @type {RunStatus} */
+    this.status = "idle";
+    /** @type {import("./pty.js").PtyHandle|null} */
+    this.pty = null;
+    /** @type {{ code: number|null, signal: NodeJS.Signals|null }|null} */
+    this.exit = null;
+    /** 中継まわりの直近の異常。走行は止めない @type {string|null} */
+    this.lastError = null;
+    /**
+     * 完了画面から取り出した値。**API Key を含むのでメモリ上のみ。**
+     * `state()` には載せず、専用の口からだけ渡す
+     * @type {import("./completion.js").Completion|null}
+     */
+    this.completion = null;
+
+    /**
+     * 参加者がフォームに入れた値。**メモリ上のみ。**ここから外に出すのは
+     * 「入力済みかどうか」だけで、値そのものは API 応答にも画面にも出さない。
+     * @type {Record<string, string|boolean>}
+     */
+    this.answers = Object.create(null);
+
+    /** いま人の判断を待っているプロンプト @type {object|null} */
+    this.pending = null;
+    /** フェイルクローズで止まった理由 @type {object|null} */
+    this.halt = null;
+
+    /** 直近に検出した枠 @type {import("./prompt-detector.js").DetectedPrompt|null} */
+    this.detected = null;
+    /** 直近に検出した枠の絶対行番号。画面が流れても位置を見失わないため @type {number|null} */
+    this.detectedFrameId = null;
+    /** 直近に検出した枠に一致した契約 @type {import("./prompt-contract.js").PromptSpec|null} */
+    this.spec = null;
+
+    /** 応答済みの枠（絶対行番号）。同じ枠に二度送らないための印 @type {Set<number>} */
+    this.answeredFrames = new Set();
+    /** 契約ごとの応答回数。フォーム由来の再出現は「拒否された」とみなす @type {Map<string, number>} */
+    this.answeredCounts = new Map();
+    /** select の確認待ち @type {{ frameId: number, target: number, labels: string[] }|null} */
+    this.pendingSelect = null;
+
+    this.timer = null;
+    this.forced = null;
+    /** 最後に何かが進んだ時刻。止まっているかの判定に使う */
+    this.progressedAt = Date.now();
+    this.stuckMs = options.stuckMs ?? STUCK_MS;
+  }
+
+  // ── 入力値 ─────────────────────────────────────────────────────────
+
+  /**
+   * フォームの値を渡す。**ディスクにも API 応答にも出さない。**
+   * @param {Record<string, string|boolean>} values
+   */
+  setAnswers(values) {
+    for (const [key, value] of Object.entries(values)) {
+      this.answers[key] = value;
+    }
+    // 値が埋まったことで待ちが解ける場合がある
+    if (this.status === "waiting" && this.pending?.reason === "missing-value") {
+      this.#schedule();
+    }
+  }
+
+  /** 値そのものは返さない。入力済みかどうかだけ */
+  filledFields() {
+    return Object.entries(this.answers)
+      .filter(([, v]) => v !== undefined && v !== "")
+      .map(([k]) => k);
+  }
+
+  /** メモリ上のシークレット値。伏字化にだけ使う（外に出さない） */
+  #secretValues() {
+    const values = Object.entries(this.answers)
+      .filter(([k, v]) => SECRET_FIELDS.has(k) && typeof v === "string" && v.length > 0)
+      .map(([, v]) => /** @type {string} */ (v));
+
+    // 本家が完了画面に出す API Key も伏せる。
+    // 「再表示できない」値なので、端末表示から写させるのではなく
+    // 専用の欄でコピーさせる（completionForDisplay）
+    if (this.completion?.apiKey) values.push(this.completion.apiKey);
+    return values;
+  }
+
+  // ── 起動と終了 ─────────────────────────────────────────────────────
+
+  start() {
+    if (this.status !== "idle") throw new Error("すでに起動しています");
+
+    const { command, args } = this.commandOverride ?? {
+      command: "npx",
+      args: ["--yes", this.cliSpec, "setup"],
+    };
+
+    this.status = "running";
+    this.pty = spawnPty({
+      command,
+      args,
+      cwd: this.cwd,
+      onData: (chunk) => this.#onData(chunk),
+      onExit: (info) => this.#onExit(info),
+      // EventEmitter の "error" を listener 無しで emit すると
+      // プロセスごと落ちる。中継の stderr は診断情報にすぎないので、
+      // 記録するだけにして走行は止めない
+      onError: (err) => {
+        this.lastError = err instanceof Error ? err.message : String(err);
+        this.emit("pty-error", err);
+      },
+    });
+    this.emit("update", this.state());
+    return this;
+  }
+
+  stop() {
+    this.pty?.kill("SIGTERM");
+  }
+
+  /** 終了時にメモリ上のシークレットを破棄する */
+  dispose() {
+    this.stop();
+    if (this.timer) clearTimeout(this.timer);
+    if (this.forced) clearTimeout(this.forced);
+    for (const key of Object.keys(this.answers)) {
+      this.answers[key] = "";
+      delete this.answers[key];
+    }
+    this.term = new Terminal();
+    this.detected = null;
+    this.detectedFrameId = null;
+    this.spec = null;
+    this.completion = null;
+  }
+
+  #onExit(info) {
+    this.exit = info;
+    this.status = "finished";
+    // 仕上げの手作業に使う値を取り出す。読めなければ端末表示のままにする
+    this.completion = parseCompletion(this.term.snapshot(), {
+      // 画面から読めなくても、フォームに入っていた値で補える
+      liffId: typeof this.answers.liffId === "string" ? this.answers.liffId : undefined,
+    });
+    this.pending = null;
+    this.pendingSelect = null;
+    this.emit("update", this.state());
+    this.emit("exit", info);
+  }
+
+  #onData(chunk) {
+    this.term.write(chunk);
+    this.#schedule();
+  }
+
+  #schedule() {
+    if (this.timer) clearTimeout(this.timer);
+    this.timer = setTimeout(() => this.#fire(), this.quietMs);
+
+    // 出力が途切れないと上のタイマーは毎回引き直されて永久に発火しない。
+    // 別に上限のタイマーを立てて、必ず一定間隔で画面を出す
+    this.forced ??= setTimeout(() => this.#fire(), this.maxWaitMs);
+  }
+
+  #fire() {
+    if (this.timer) clearTimeout(this.timer);
+    if (this.forced) clearTimeout(this.forced);
+    this.timer = null;
+    this.forced = null;
+
+    try {
+      this.#evaluate();
+    } catch (err) {
+      this.#haltWith("internal-error", "内部エラーで自動応答を止めました", String(err));
+    }
+    this.emit("update", this.state());
+  }
+
+  // ── 判定 ───────────────────────────────────────────────────────────
+
+  #frameId(detected) {
+    return this.term.discarded + detected.startLine;
+  }
+
+  #evaluate() {
+    if (this.status === "halted" || this.status === "finished") return;
+
+    const lines = this.term.snapshot();
+    const detected = detectPrompt(lines);
+    this.detected = detected;
+    this.detectedFrameId = detected ? this.#frameId(detected) : null;
+
+    if (!detected || !detected.complete) {
+      // プロンプトが出ていない = 本家が作業中
+      this.spec = null;
+      this.pending = null;
+      if (this.status !== "running") this.status = "running";
+      return;
+    }
+
+    const frameId = this.#frameId(detected);
+
+    // 同じ枠が出たまま何も進んでいないなら、諦めて人に委ねる。
+    // 黙って固まると、参加者は何が起きているのか分からない
+    if (this.status === "running" && Date.now() - this.progressedAt > this.stuckMs) {
+      this.#haltWith(
+        "stuck",
+        "画面が進まなくなりました",
+        "この端末では自動で答えられない場面のようです。下の画面を見て、必要な入力を自分で送ってください。",
+        detected,
+      );
+      return;
+    }
+
+    // select の移動後の確認待ち
+    if (this.pendingSelect) {
+      this.#confirmSelect(detected, frameId);
+      return;
+    }
+
+    // 本家が入力を弾いた場合。値が合っていないので自動では直せない。
+    //
+    // `▲` は clack の log.warn と共用なので、画面の見た目だけでは
+    // 「入力エラー」と「ただの警告ログ」を区別できない。
+    // 入力エラーは**自分が答えた枠がその場で描き直される**形でしか起きないので、
+    // 応答済みの枠かどうかで判断する。
+    if (detected.state === "error") {
+      if (this.answeredFrames.has(frameId)) {
+        this.#haltWith(
+          "input-error",
+          "本家 CLI が入力を受け付けませんでした",
+          detected.errorText ?? "",
+          detected,
+        );
+      }
+      // 答えていない枠の ▲ は警告ログ。応答対象ではない
+      return;
+    }
+
+    // 同じ枠には二度送らない（エコーで枠が描き直されるため）
+    if (this.answeredFrames.has(frameId)) return;
+
+    const matches = matchPrompt(detected);
+
+    if (matches.length === 0) {
+      this.#haltWith(
+        "unknown-prompt",
+        "知らないプロンプトが出たので自動応答を止めました",
+        "本家 CLI のバージョンが変わった可能性があります。画面を見て手で答えてください。",
+        detected,
+      );
+      return;
+    }
+    if (matches.length > 1) {
+      this.#haltWith(
+        "ambiguous-prompt",
+        "プロンプトを一意に特定できませんでした",
+        `候補: ${matches.map((m) => m.id).join(", ")}`,
+        detected,
+      );
+      return;
+    }
+
+    const spec = matches[0];
+    this.spec = spec;
+
+    if (spec.answer === "human") {
+      this.#waitForHuman(spec, detected, "human");
+      return;
+    }
+
+    const value = this.answers[/** @type {string} */ (spec.field)];
+    if (value === undefined || value === "") {
+      this.#waitForHuman(spec, detected, "missing-value");
+      return;
+    }
+
+    // フォーム由来のプロンプトが二度出た = 本家が前の値を受け付けなかった
+    // （workers.dev サブドメインの重複など）。同じ値を送り直しても直らない
+    if ((this.answeredCounts.get(spec.id) ?? 0) > 0) {
+      this.#haltWith(
+        "repeat-prompt",
+        "同じ入力をもう一度求められました",
+        "前に送った値が受け付けられなかったようです。値を見直してください。",
+        detected,
+      );
+      return;
+    }
+
+    this.#send(spec, detected, frameId, value);
+  }
+
+  #waitForHuman(spec, detected, reason) {
+    this.progressedAt = Date.now();
+    this.status = "waiting";
+    const secrets = this.#secretValues();
+    this.pending = {
+      promptId: spec.id,
+      reason,
+      // 画面の見出し。本家の文言は端末前提なので、そのままは出さない
+      label: spec.askLabel ?? spec.formLabel ?? spec.message,
+      // 本家が実際に出している文言。下の端末表示と突き合わせられるように残す
+      message: spec.message,
+      kind: spec.kind,
+      note: spec.note ?? null,
+      field: spec.field ?? null,
+      // 選択肢は本家が動的に作る場合がある（Cloudflare アカウント一覧など）
+      options: detected.optionLabels?.map((l) => redactText(l, secrets)) ?? null,
+      activeIndex: detected.activeIndex ?? null,
+      frameId: this.#frameId(detected),
+    };
+  }
+
+  #haltWith(reason, message, detail, detected = null) {
+    // detail と prompt は**本家の出力そのもの**。画面と同じく伏字を通してから外に出す。
+    // ここは screen() を経由しないので、通し忘れるとそのまま API 応答に出る
+    const secrets = this.#secretValues();
+    const safe = (text) => (typeof text === "string" ? redactText(text, secrets) : text);
+
+    this.status = "halted";
+    this.pending = null;
+    this.pendingSelect = null;
+    this.halt = {
+      reason,
+      message,
+      detail: safe(detail),
+      prompt: detected
+        ? {
+            message: safe(detected.message),
+            kind: detected.kind,
+            options: detected.optionLabels?.map(safe) ?? null,
+          }
+        : null,
+    };
+    this.emit("halt", this.halt);
+  }
+
+  // ── 応答 ───────────────────────────────────────────────────────────
+
+  #send(spec, detected, frameId, value) {
+    if (spec.kind === "text") {
+      this.#markAnswered(spec, frameId);
+      this.pty?.write(`${String(value)}${KEY_ENTER}`);
+      this.status = "running";
+      this.pending = null;
+      return;
+    }
+
+    if (spec.kind === "confirm") {
+      this.#markAnswered(spec, frameId);
+      // clack の confirm は y / n の1打鍵でその場で確定する（実装確認済み）
+      this.pty?.write(value ? "y" : "n");
+      this.status = "running";
+      this.pending = null;
+      return;
+    }
+
+    // select は契約上すべて human。ここには来ない
+    this.#haltWith(
+      "unsupported-auto-answer",
+      "この形式は自動応答の対象ではありません",
+      `kind=${spec.kind}`,
+      detected,
+    );
+  }
+
+  #markAnswered(spec, frameId) {
+    this.progressedAt = Date.now();
+    this.answeredFrames.add(frameId);
+    this.answeredCounts.set(spec.id, (this.answeredCounts.get(spec.id) ?? 0) + 1);
+  }
+
+  /**
+   * 人が決めたことを送る。
+   *
+   * @param {object} answer
+   * @param {string} answer.promptId          いま待っているプロンプトと一致しなければ拒否する
+   * @param {number} [answer.optionIndex]     select のとき
+   * @param {boolean} [answer.confirm]        confirm のとき
+   * @param {string} [answer.text]            text のとき（空文字 = Enter だけ）
+   */
+  answerHuman(answer) {
+    this.progressedAt = Date.now();
+    if (this.status !== "waiting" || !this.pending) {
+      throw new Error("いま人の入力を待っていません");
+    }
+    if (answer.promptId !== this.pending.promptId) {
+      // 画面が進んだあとに古い応答が届いた場合。取り違えるくらいなら捨てる
+      throw new Error("待っているプロンプトと一致しません");
+    }
+
+    const { kind, frameId } = this.pending;
+
+    if (kind === "select") {
+      const target = answer.optionIndex;
+      const labels = this.pending.options ?? [];
+      if (typeof target !== "number" || target < 0 || target >= labels.length) {
+        throw new Error("選択肢の指定が不正です");
+      }
+      const from = this.pending.activeIndex ?? 0;
+      const diff = target - from;
+      const key = diff >= 0 ? KEY_DOWN : KEY_UP;
+      // まず移動だけして、狙った選択肢に印が付いたことを画面で確かめてから Enter を送る
+      this.pendingSelect = { frameId, target, labels };
+      this.status = "running";
+      this.pending = null;
+      if (diff !== 0) this.pty?.write(key.repeat(Math.abs(diff)));
+      else this.#schedule();
+      return;
+    }
+
+    if (kind === "confirm") {
+      this.answeredFrames.add(frameId);
+      this.pty?.write(answer.confirm ? "y" : "n");
+    } else {
+      this.answeredFrames.add(frameId);
+      this.pty?.write(`${answer.text ?? ""}${KEY_ENTER}`);
+    }
+
+    this.status = "running";
+    this.pending = null;
+  }
+
+  /**
+   * select は「移動 → 画面で確認 → Enter」の順で送る。
+   * 印が狙った位置に無ければ Enter を送らずに止める。
+   */
+  #confirmSelect(detected, frameId) {
+    const target = this.pendingSelect;
+    if (!target) return;
+
+    if (frameId !== target.frameId || detected.kind !== "select") {
+      this.pendingSelect = null;
+      this.#haltWith(
+        "select-verify-failed",
+        "選択肢の画面が変わったので Enter を送りませんでした",
+        "もう一度やり直してください。",
+        detected,
+      );
+      return;
+    }
+
+    const labels = detected.optionLabels ?? [];
+    const sameLabels =
+      labels.length === target.labels.length && target.labels.every((l, i) => labels[i] === l);
+
+    if (!sameLabels || detected.activeIndex !== target.target) {
+      this.pendingSelect = null;
+      this.#haltWith(
+        "select-verify-failed",
+        "狙った選択肢に印が付いていないので Enter を送りませんでした",
+        `期待: ${target.target} / 実際: ${detected.activeIndex}`,
+        detected,
+      );
+      return;
+    }
+
+    this.pendingSelect = null;
+    this.answeredFrames.add(frameId);
+    this.pty?.write(KEY_ENTER);
+    this.status = "running";
+  }
+
+  /**
+   * 止まっているときだけ、人が打った文字をそのまま送る。
+   *
+   * 自動応答の代わりではなく、**画面を見た人が判断して打つ**ための逃げ道。
+   * ここに保持しているシークレットを混ぜてはならない。
+   *
+   * @param {string} text
+   */
+  answerManually(text) {
+    if (this.status !== "halted") throw new Error("止まっているときだけ手入力できます");
+    this.pty?.write(`${text}${KEY_ENTER}`);
+    this.halt = null;
+    this.status = "running";
+    // 手入力した枠にはもう触らない
+    if (this.detected) this.answeredFrames.add(this.#frameId(this.detected));
+  }
+
+  // ── 外に出す形 ─────────────────────────────────────────────────────
+
+  /**
+   * 画面。**必ず伏字を通したもの**を返す。
+   * @param {number} [limit] 末尾から何行返すか。省略時は全部
+   */
+  screen(limit) {
+    const secrets = this.#secretValues();
+    const lines = redactLines(this.term.snapshot(), secrets);
+
+    // 入力途中はエコーが1文字ずつ届くので、完全一致の置換では拾えない。
+    // シークレットを入力中の値行は中身を見ずに潰す。
+    //
+    // 位置は絶対行番号で持っておき、いまの画面に読み替える。
+    // 相対位置のまま覚えると、行数の上限で画面が流れたときに
+    // 伏字が別の行に当たり、入力途中の値がそのまま出てしまう。
+    if (this.detectedFrameId !== null && this.spec?.secret) {
+      const i = this.detectedFrameId - this.term.discarded + 1;
+      if (i >= 0 && lines[i] !== undefined) lines[i] = maskValueLine(lines[i]);
+    }
+    return limit === undefined ? lines : lines.slice(Math.max(0, lines.length - limit));
+  }
+
+  /**
+   * 仕上げの手作業に使う値。**API Key を含む。**
+   *
+   * 参加者はこの値を控えないと二度と手に入らないので、渡さないわけにいかない。
+   * そのぶん、載せる口をここ1つに絞る（`state()` には出さない）。
+   */
+  completionForDisplay() {
+    if (!this.completion) return null;
+    return {
+      steps: completionSteps(this.completion),
+      apiKey: this.completion.apiKey,
+      adminUrl: this.completion.adminUrl,
+    };
+  }
+
+  /** **値を含まない**状態。API 応答はこれを使う */
+  state() {
+    return {
+      status: this.status,
+      pending: this.pending,
+      halt: this.halt,
+      exit: this.exit,
+      lastError: this.lastError,
+      // 値は載せない。取り出せたかどうかだけ
+      hasCompletion: this.completion !== null,
+      filledFields: this.filledFields(),
+    };
+  }
+}