mirrors/nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus synced 2026-07-17 13:32:21 +00:00
Code Issues Releases Wiki Activity

Avoid outputting garbage sequences in Nomulus CLI (#3156)

Browse Source 
Lazy-initialize the terminal and LineReader in ShellCommand to prevent JLine from eagerly probing terminal capabilities during JCommander command-line startup.

During CLI startup, JCommander instantiates every command (including ShellCommand) to build the CLI's command map. Eager instantiation of the LineReader inside the ShellCommand constructor causes JLine to query the terminal cursor via Device Status Report (DSR) escape sequences. Standard commands (e.g. list_tlds) do not consume stdin, leaving these probing responses (such as ^[[71;1R and 1;1R) in the buffer to be leaked as garbage characters to standard output.

This change defers terminal and LineReader initialization until the shell's run() method is actually executed, while preserving the original constructor for unit tests.

BUG=http://b/534855218
This commit is contained in:
Weimin Yu
2026-07-15 12:42:18 -04:00
committed by GitHub
parent 54e605fa27
commit 542084eb70
1 changed files with 26 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/src/main/java/google/registry/tools/ShellCommand.java
+26 -8
View File
@@ -91,10 +91,11 @@ public class ShellCommand implements Command {
* flags aren't available in the constructor, so we have to do it in the {@link #run} function.
*/
private final CommandRunner originalRunner;
private final LineReader lineReader;
private final Clock clock;
private LineReader lineReader;
private Terminal terminal;
private JCommander jcommanderForCompletions;
private String prompt = null;
@Parameter(
@@ -118,21 +119,22 @@ public class ShellCommand implements Command {
""")
boolean encapsulateOutput = false;
ShellCommand(CommandRunner runner) throws IOException {
this(TerminalBuilder.terminal(), new SystemClock(), runner);
prompt = "nom > ";
lineReader.variable(LineReader.HISTORY_FILE, Path.of(USER_HOME.value(), HISTORY_FILE));
ShellCommand(CommandRunner runner) {
this.originalRunner = runner;
this.clock = new SystemClock();
this.prompt = "nom > ";
}
ShellCommand(Terminal terminal, Clock clock, CommandRunner runner) {
this.originalRunner = runner;
this.terminal = terminal;
this.lineReader = LineReaderBuilder.builder().terminal(terminal).build();
this.clock = clock;
}
private void setPrompt(RegistryToolEnvironment environment, boolean alert) {
// Do not set the prompt in tests.
if (lineReader.getTerminal() instanceof DumbTerminal) {
if (lineReader == null || lineReader.getTerminal() instanceof DumbTerminal) {
return;
}
prompt =
@@ -143,7 +145,10 @@ public class ShellCommand implements Command {
}
public ShellCommand buildCompletions(JCommander jcommander) {
((LineReaderImpl) lineReader).setCompleter(new JCommanderCompleter(jcommander));
this.jcommanderForCompletions = jcommander;
if (lineReader != null) {
((LineReaderImpl) lineReader).setCompleter(new JCommanderCompleter(jcommander));
}
return this;
}
@@ -209,6 +214,19 @@ public class ShellCommand implements Command {
/** Run the shell until the user presses "Ctrl-D". */
@Override
public void run() {
if (lineReader == null) {
try {
this.terminal = TerminalBuilder.terminal();
this.lineReader = LineReaderBuilder.builder().terminal(terminal).build();
lineReader.variable(LineReader.HISTORY_FILE, Path.of(USER_HOME.value(), HISTORY_FILE));
if (jcommanderForCompletions != null) {
((LineReaderImpl) lineReader)
.setCompleter(new JCommanderCompleter(jcommanderForCompletions));
}
} catch (IOException e) {
throw new RuntimeException("Failed to initialize terminal", e);
}
}
// Wrap standard output and error if requested. We have to do so here in run because the flags
// haven't been processed in the constructor.
CommandRunner runner =