fix(cli): non-interactive-safe prompts + singular context alias (#4439)

* fix(cli): non-interactive-safe prompts + singular `context` alias

Two CLI-polish follow-ups (the third — an async-warn refactor for #2807 — is moot:
#4373 replaced the Gemini remote-URL drop+warn with fileData pass-through, so no
async warn remains).

1) createPrompt (io.mjs) — the shared interactive helper used rl.question with no
   EOF guard, so a non-interactive stdin (pipe, CI, `< /dev/null`) left the await
   pending and Node warned about an 'unsettled top-level await' while the command
   hung. ask/askSecret now resolve on the readline `close` event (fired on EOF)
   with the default / empty string. A genuinely piped line still arrives via the
   question callback first, so `echo value | omniroute …` keeps working — only the
   no-input EOF case falls back. This fixes every command that prompts, centrally
   (mirrors the contexts `confirm()` fix from #4397).

2) `contexts` gains a singular `context` alias — the connect output and older docs
   said `omniroute context current`; the alias keeps that muscle-memory working.

Tests: cli-io.test.ts (ask default/empty + askSecret resolve on EOF, no hang) and a
cli-contexts.test.ts case asserting the `context` alias is registered. 11/11.

* test(cli): mock .alias() in the fake program for the contexts subcommand test

The existing 'registers a current subcommand' test uses a minimal fake commander
program; registerContexts now calls .alias("context"), so the fake needs an alias()
stub (returns this) or the chain throws. Add it. (Self-introduced by the alias in
this branch; my 4 new tests already pass in CI.)
This commit is contained in:
Diego Rodrigues de Sa e Souza
2026-06-20 19:49:45 -03:00
committed by GitHub
parent 95e6522720
commit 9052c5a783
5 changed files with 101 additions and 4 deletions

View File

@@ -34,6 +34,7 @@ function maskKey(k) {
export function registerContexts(program) {
const ctx = program
.command("contexts")
.alias("context") // singular alias — docs/connect output historically said `context current`
.description(t("config.contexts.description") || "Manage server contexts/profiles");
ctx

View File

@@ -6,20 +6,43 @@ export function createPrompt() {
output: process.stdout,
});
// Non-interactive stdin (pipe, CI, EOF via `< /dev/null`) cannot answer an
// interactive prompt. Without a guard, `rl.question` never fires its callback —
// the await stays pending and Node warns about an "unsettled top-level await" at
// exit. Resolving on the readline `close` event (which fires on stdin EOF)
// returns the default/empty instead of hanging. A genuinely piped line still
// arrives via the question callback first, so `echo value | omniroute …` keeps
// working — only the no-input EOF case falls back.
function ask(question, defaultValue = "") {
const suffix = defaultValue ? ` (${defaultValue})` : "";
return new Promise((resolve) => {
let settled = false;
const done = (v) => {
if (!settled) {
settled = true;
resolve(v);
}
};
rl.once("close", () => done(defaultValue));
rl.question(`${question}${suffix}: `, (answer) => {
const trimmed = answer.trim();
resolve(trimmed || defaultValue);
done(trimmed || defaultValue);
});
});
}
function askSecret(question) {
return new Promise((resolve) => {
let prompted = false;
let settled = false;
const saved = rl._writeToOutput.bind(rl);
const done = (v) => {
if (!settled) {
settled = true;
rl._writeToOutput = saved;
resolve(v);
}
};
let prompted = false;
rl._writeToOutput = function (str) {
if (!prompted) {
rl.output.write(str);
@@ -29,9 +52,9 @@ export function createPrompt() {
// Suppress character echo; allow only newlines through
if (str === "\r\n" || str === "\n" || str === "\r") rl.output.write("\n");
};
rl.once("close", () => done("")); // non-interactive EOF → empty secret, no hang
rl.question(`${question}: `, (answer) => {
rl._writeToOutput = saved;
resolve(answer.trim());
done(answer.trim());
});
});
}

View File

@@ -92,3 +92,40 @@ test("confirm() declines cleanly on non-interactive stdin (no hung await)", asyn
else delete (process.stdin as { isTTY?: boolean }).isTTY;
}
});
test("registerContexts registers the singular `context` alias", async () => {
// The connect output and older docs say `omniroute context current` (singular);
// the command is `contexts`. An alias keeps the singular muscle-memory working.
const { registerContexts } = await import("../../bin/cli/commands/contexts.mjs");
let aliasName: string | undefined;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const fakeCtx: any = {
command() {
return this;
},
alias(a: string) {
aliasName = a;
return this;
},
description() {
return this;
},
requiredOption() {
return this;
},
option() {
return this;
},
action() {
return this;
},
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const fakeProgram: any = {
command() {
return fakeCtx;
},
};
registerContexts(fakeProgram);
assert.equal(aliasName, "context");
});

33
tests/unit/cli-io.test.ts Normal file
View File

@@ -0,0 +1,33 @@
import test from "node:test";
import assert from "node:assert/strict";
// Regression: the shared interactive prompt helper (createPrompt) used rl.question
// without an EOF guard, so a non-interactive stdin (pipe, CI, `< /dev/null`) left
// the promise pending — Node then warned about an "unsettled top-level await" at
// exit and the command hung. ask/askSecret now resolve on the readline `close`
// event (fired on EOF) with the default / empty string instead of hanging. close()
// here simulates that EOF/non-interactive close.
test("createPrompt.ask resolves the default on EOF (non-interactive, no hang)", async () => {
const { createPrompt } = await import("../../bin/cli/io.mjs");
const p = createPrompt();
const pending = p.ask("Name", "fallback");
p.close();
assert.equal(await pending, "fallback");
});
test("createPrompt.ask resolves empty when there is no default on EOF", async () => {
const { createPrompt } = await import("../../bin/cli/io.mjs");
const p = createPrompt();
const pending = p.ask("Name");
p.close();
assert.equal(await pending, "");
});
test("createPrompt.askSecret resolves empty on EOF (no hang)", async () => {
const { createPrompt } = await import("../../bin/cli/io.mjs");
const p = createPrompt();
const pending = p.askSecret("Secret");
p.close();
assert.equal(await pending, "");
});

View File

@@ -220,6 +220,9 @@ test("commands/contexts.mjs registers a `current` subcommand", async () => {
sub.push(name.split(" ")[0]);
return this;
},
alias() {
return this;
},
description() {
return this;
},